Configuring Global Collection Settings

21 Jun 2024
5 Minutes to read
Contributors

Configuring Global Collection Settings

Updated on 21 Jun 2024
5 Minutes to read
Contributors

Article summary

Did you find this summary helpful?

Thank you for your feedback

The global configuration of Metrics Collection sets up the connection to the export destination (the northbound system to which data will be exported). An example of an export destination is Skylight performance analytics: SLA portal.

The global configuration is done in the Server Configuration tab of the Collection page of Skylight orchestrator.

To access the global configuration, you select the Server Configuration tab (from the top menu).

In the Server Configuration tab:

You can decide whether to use the default Metrics Collection server (the current Skylight orchestrator appliance) or to use another Skylight orchestrator appliance.
You must select the export method (SFTP, SFTP with key, RSync or None) and then
configure the connection to the system to which data will be exported.
Alternatively, you can choose not to let Collection export the data. You might choose this option so that you can export the data to multiple destinations.
You set the period over which data is grouped before being written to CSV files and
exported.

To configure global settings for Metrics Collection

Access the Collection ▶ Server Configuration tab.
In the Server Configuration tab that displays, enter your settings. For more information about how to complete the fields, see the table below.
Click Apply to save your selections and set up the connection to the export destination.
(Optional) Click Test to verify the connection.
Click Close to return to the Server Configuration tab.

Server Configuration Tabs
Agent configuration

Parameter	Description
Use Skylight orchestrator as default server for Metrics Collection	Check this box to use the current Skylight orchestrator appliance as the default Metrics Collection server for all managed elements. If you uncheck this checkbox, you will be able to change the server when you are configuring reporting data collection for an individual element in the Device Configuration tab.
Enable export of performance sessions	Check this box to enable export of performance sessions.

Parameter

Description

Use Skylight orchestrator as default server for Metrics Collection

Check this box to use the current Skylight orchestrator appliance as the default Metrics Collection server for all managed elements.

If you uncheck this checkbox, you will be able to change the server when you are configuring reporting data collection for an individual element in the Device Configuration tab.

Enable export of performance sessions

Check this box to enable export of performance sessions.

General export settings

Parameter	Description
Export Method	Select a method for exporting data to the destination server. Five options are available in the drop-down list: SFTP options, see "Configuring Global Collection Settings" SFTP/Key Rsync The Rsync option allows you to export data to four destinations. For more information, see Export configuration 1, 2, 3 and 4 (below in this table). None If you select None, files will be stored in the Skylight orchestrator file system.
Grouping period (minutes)	To reduce the amount of traffic to the export destination, you can group the data from several collection periods before transferring the files. Enter the period (a value in minutes) over which you want to group data from multiple collection periods. Note: Grouping data in this way results in a certain delay.
Use gzip compression	Check this box if you want the CSV files to be compressed before they are transferred to the export destination. Note: This section is always checked when the rsync protocol is used.

Parameter

Description

Export Method

Select a method for exporting data to the destination server. Five options are available in the drop-down list:

SFTP options, see "Configuring Global Collection Settings"

SFTP/Key

Rsync The Rsync option allows you to export data to four destinations. For more information, see Export configuration 1, 2, 3 and 4 (below in this table).

None If you select None, files will be stored in the Skylight orchestrator file system.

Grouping period (minutes)

To reduce the amount of traffic to the export destination, you can group the data from several collection periods before transferring the files.

Enter the period (a value in minutes) over which you want to group data from multiple collection periods.

Note: Grouping data in this way results in a certain delay.

Use gzip compression

Check this box if you want the CSV files to be compressed before they are transferred to the export destination.

Note: This section is always checked when the rsync protocol is used.

Settings (displayed if SFTP or SFTP/Key is selected as Export method)

Parameter	Description
User	The user name used for connecting to the export destination.
Password	Password used for connecting to the export destination
Host	IP address of the export destination (typically an OSS like Skylight performance analytics: SLA portal).
Port	The port used to connect to export destination.
Directory	A directory on the export destination server where files will be stored. The directory must already exist on the server.
Private key details (button)	These items are only active if SFTP/Key is selected as the Export method. To enter the SSH key: Select the Private key details button. In the SSH key dialog box that displays, supply the SSH key by pasting the key into the Host SSH key field or by choosing a file. If the SSH key you are using requires a passphrase, enter it inthe Passphrase field.

Export configuration 1, 2, 3 and 4 (only displayed if Rsync is selected as Export method)

Parameter	Description
Enable destination	When Rsync is selected as the export method, you can transfer Metrics Collection data to multiple destinations (up to four), such as Skylight performance analytics: SLA portal. Check this box to enable the export destination for data exporting.
User	The username used to connect to the northbound host. Note: You are not prompted to supply a password here because it is assumed that the SSH keys have already been exchanged. For the procedure to configure SSH keys, see: Using Rsync with Skylight orchestrator
Host	The IP address of the export destination.
Port	The port used to connect to the export destination.
Remote Directory	A directory on the export destination server where data will be saved. The directory must already exist.
Create sub-directories	Check this box to create a subdirectory for each element. All files for a particular element will be stored together in a directory for more efficient file management. If you do not select this box, all data is saved to the remote directory (that you entered) in a flat structure without any subdirectories. Note: Skylight performance analytics: SLA portal expects a flat file structure.

Connection status message

Parameter	Description
Connection status message	After you have configured the export parameters and clicked Test, Skylight orchestrator validates the configuration. The results of the validation test are presented here. The following error messages may be displayed: Invalid provided Ip address - Means the provided IP was in the wrong format. Could not connect to the specified host - Means you cannot reach the host with the IP address. Could not authenticate with the provided credentials - Means you have entered wrong credentials. Applies to SFTP, SFTP/ Key mode. Error occurred while opening the chosen directory - Means you have specified an invalid directory. Invalid provided private key - Means the key you entered is in the wrong format. Applies to SFTP mode only. The configuration is not right. Cannot reach host- Applies to SFTP mode only.

Parameter

Description

Connection status message

After you have configured the export parameters and clicked Test, Skylight orchestrator validates the configuration. The results of the validation test are presented here. The following error messages may be displayed:

Invalid provided Ip address - Means the provided IP was in the wrong format.
Could not connect to the specified host - Means you cannot reach the host with the IP address.
Could not authenticate with the provided credentials - Means you have entered wrong credentials. Applies to SFTP, SFTP/ Key mode.
Error occurred while opening the chosen directory - Means you have specified an invalid directory.
Invalid provided private key - Means the key you entered is in the wrong format. Applies to SFTP mode only.
The configuration is not right. Cannot reach host- Applies to SFTP mode only.

© 2024 Cisco and/or its affiliates. All rights reserved.

For more information about trademarks, please visit: Cisco trademarks
For more information about legal terms, please visit: Cisco legal terms
For legal information about Accedian Skylight products, please visit: Accedian legal terms and tradmarks

Was this article helpful?

What's Next

Viewing Collection Agent Configuration