SevOne SDN Collector Set Collector Using 'launch configure' Option

An installer is added to the configure option of the launch script to easily configure both the settings.env and multi_site_config.json files. It provides the purpose of each parameter as well as its current value that will be overridden. Please execute the steps below.

$ ./launch configure --conf-path <directory path for settings.env/multi_site_config.json files (optional)>

• The installer validates all required parameters in settings.env and multi_site_config.json files.
• If any required parameter(s) are missing from the settings.env and/or multi_site_config.json files, the installer exits and provides a detailed message of the missing parameter and the file it is missing from. If all required parameters are set, the validation completes successfully and you will see the following message.
  Note: File <file_name> validated successfully
  
  where <file_name> can be settings.env, if the settings.env file was successfully validated or multi_site_config.json, if the multi_site_config.json file was successfully validated.

• Once the validation completes successfully, configure parameters in the settings.env file.
  Note: After entering the user details for SevOne NMS and ACI data source, the configuration script will verify the user credentials and authority (valid for APIC only).
  Note: PAS hostname or IP, administrator username, and administrator password are required parameters. Please assign valid values to these parameters.

  Example

  PAS hostname or IP [192.168.1.1] :

  where,
  

  Note: PAS hostname or IP is the prompt followed by its current value, 192.168.1.1, in this example.
  
  This prompt is directly mapped to SEVONE_API_HOST in settings.env file.

  settings.env file: List of prompts and their respective mappings

  Promt	Mapped Parameter	Information
  PAS hostname or IP	SEVONE_API_HOST	(required)
  PAS administrator username	SEVONE_API_USER	(required)
  PAS administrator password	SEVONE_API_PASSWORD	(required)
  PAS API use https	SEVONE_API_SECURITY	(optional)
  PAS API Collection port	SEVONE_API_COLLECTION_PORT	(optional)
  PAS API Config port	SEVONE_API_CONFIG_PORT	(optional)

  settings.env.sample file

  SEVONE_API_HOST=192.168.1.1
  SEVONE_TRANSPORT=api
  SEVONE_API_USER=admin
  SEVONE_API_PASSWORD=sevone
  SEVONE_API_CONFIG_VERSION=v2
  SEVONE_API_COLLECTION_VERSION=v2
  SEVONE_API_SECURITY=False
  SEVONE_API_COLLECTION_PORT=80
  SEVONE_API_CONFIG_PORT=80
  SEVONE_LOG_LEVEL=DEBUG
  SEVONE_PERSIST=sqlite
  SEVONE_LOG_FILE=/var/log/cisco-aci-agent-logs/cisco-aci-agent-uc.log
  SEVONE_API_READ_TIMEOUT=60
  DISTRIBUTE_ON_ALL_PEERS=False
  DISTRIBUTION_PEERS_LIST=Empty
  

• Now, configure the parameters in the multi_site_config.json file.
  
  Note: APIC/MSM hostname or IP, administrator username, administrator password, site name, device name prefix, and APIC version string are required parameters. Please assign valid values to these parameters.
  Note:

  multi_site_config.json file: List of prompts and their respective mappings

  Promt	Mapped Parameter	Information
  Collect information from multisite manager	is_multi_site_mode	(optional)
  Version of the ACI running on the APICs	apic_version_string (required parameter)	(required)

  If is_multi_site_mode is set to false, the user would want to provide the information for each site individually rather than have the collector read it from the Multisite Controller. In this case, the installer will first print the list of configured sites (if the sites were already configured manually in the settings file) and then warn the user that the information on these sites will be lost if the user decides to continue.

  Prompt	Mapped Parameter	Information
  Site Name	name	(required)
  APIC hostname or IP	ip	(required)
  APIC administrator username	username	(required)
  APIC administrator password	password	(required)
  Device Name Prefix	device_name_prefix	(required)
  Fault Configuration FileName	fault_configuration_filename	(optional)

  If is_multi_site_mode is set to true, you will get the following prompts to access the Cisco Multisite Controller.

  Prompt	Mapped Parameter	Information
  Multisite manager protocol	mso_protocol	(required)
  Multisite manager hostname or ip	mso_ip	(required)
  Multisite manager administrator username	mso_uid	(required)
  Multisite manager administrator password	mso_password	(required)
  Version of the ACI running on the APICs	apic_version_string	(required)

  Prompt	Mapped Parameter	Information
  Collect health and fault statistics for ACI physical devices	do_nodes	(optional)
  Collect traffic statistics for ACI physical devices	do_nodes_traffic	(optional)
  Collect health and fault statistics for ACI policy model	do_pod	(optional)
  Collect traffic statistics for ACI policy model	do_pod_traffic	(optional)
  Collect ACI faults and Create Alarms in the PAS	do_subscription	(optional)
  Collect data for topology report	do_topology	(optional)
  Collect health & fault statistics on ACI connected hypervisors and virtual machines	do_virt	(optional)
  Collect statistics on ACI connected hypervisors and virtual machines	do_virt_stats	(optional)
  Collect statistics on external switches visible to the ACI fabric	do_ext	(optional)
  Path of the folder to contain the collector logs	cisco_log_filepath	(optional)
  Collector log file name	cisco_log_filename	(optional)
  Minimum log level for collector logs. Accepted values are CRITICAL, ERROR, WARNING, INFO and DEBUG	cisco_log_level	(optional)
  No prefix in Spines, Leaves and APIC	no_prefix	(optional)
  Prefix for NMS alert summary	fault_prefix	(optional)

  
  multisiteconfig.json.sample file

  {
    "do_nodes": true,
    "do_nodes_traffic": true,
    "do_pod": true,
    "do_pod_traffic": true,
    "do_virt": false,
    "do_virt_stats": false,
    "do_ext": false,
    "do_subscription": true,
    "do_topology": true,
    "cisco_log_filepath": "/var/log/cisco-aci-agent-logs/",
    "cisco_log_filename": "cisco-aci-agent.log",
    "cisco_log_level": "INFO",
    "apic_version_string": "",
    "is_multi_site_mode": false,
    "mso_protocol": "https",
    "mso_ip": "192.168.1.1",
    "mso_uid": "user",
    "mso_password": "password",
    "sites": [
      {
        "name": "Site Name",
        "mso_protocol": "https",
        "mso_ip": "192.168.1.1",
        "mso_uid": "user",
        "mso_password": "password",
        "device_name_prefix": "Site Name",
        "fault_configuration_filename": ""
      }
    ],
    "poll_interval": 300,
    "max_wait_time": 300,
    "meta_topology_interval": 1500,
    "poller_threads": 5,
    "meta_threads": 10,
    "misc_threads": 10,
    "no_threads": false,
    "lb_round": true,
    "do_extended": true,
    "do_bytes": true,
    "do_packets": false,
    "do_meta": true,
    "do_widget": false,
    "skip_bad_nic": true,
    "skip_off_vm": true,
    "skip_tunnelif": true,
    "dn_order": true,
    "page_size": 10000,
    "apic_connection_timeout": 30,
    "sleep_time": 200,
    "read_timeout": 90,
    "subscribe_to": "FAULTS",
    "alert_timeout": 300,
    "key": "",
    "certificate": "",
    "create_missing_types": false,
    "merge_existing_devices": true,
    "dry_run": false,
    "dry_run_detailed": false,
    "dry_sim": false,
    "dump_filepath": "",
    "fallback": false,
    "sim_filepath": "",
    "sim_run": false
  }
  

  It is assumed that the admin credentials for each site APIC controlled by the Multisite Controller are identical to the credentials for the Multisite Controller. If the user updates any information for any sites controlled by the Multisite Controller, then the user may update the site's array manually after the completion of the launch configure. For example, if a site with hostname great.site.com has a password abc12345 and apic_version_string 4.0(2d) while the controller has a password abc123 and apic_version_string 3.2(2d), then it may be configured as below in the multi_site_config.json file.

  
  ....
  "apic_version_string" : "3.2(2d)",
  "mso_protocol" : "https",
  "mso_ip" : "x.mso.com",
  "mso_uid" : "admin",
  "mso_password" : "abc123",
  "sites" : [
    {
      "mso_protocol" : "https",
      "mso_ip" : "great.site.com",
      "mso_password" : "abc12345",
      "apic_version_string" : "4.0(2d)"
    }
   ]
  ...
  

  Internally, for each site, ip, uid, and password are prefixed with mso. The mso_ip in the site's array is used to look up the site name where the changes are to be made and hence it is a mandatory field.
• Post execution of the installer, the settings.env and multi_site_config.json files will be overwritten with the new settings provided by the user.
• The following parameters are not prompted as they need to be set manually.
  • dry_sim
  • create_missing_types
  • alert_timeout
  • fallback
  • skip_tunnelif
  • read_timeout
  • poll_interval
  • lb_round
  • sleep_time
  • skip_bad_nic
  • skip_off_vm
  • key
  • certificate
  • poller_threads
  • page_size
  • meta_threads
  • misc_threads
  • no_threads
  • max_wait_time
  • sim_run
  • dump_filepath
  • sim_filepath
  • merge_existing_devices
  • meta_topology_interval
  • fault_configuration_filename

Press the Ctrl-C to stop the execution of the installer. The installer will immediately exit and the settings files will maintain its values as before the installer was executed via the launch configure command.

If the multi_site_config.json file is a malformed JSON document, the execution of the installer results in an error and the installer exits immediately. The user must be careful to validate that the multi_site_config.json file is a valid JSON document before executing the installer.

Any of the above mentioned flags when specified again in this section will override that particular setting for the site. The following mapped parameters are the configuration for sites that are not part of the global configurations.