.svg?sv=2022-11-02&spr=https&st=2024-11-02T16%3A28%3A22Z&se=2024-11-02T16%3A38%3A22Z&sr=c&sp=r&sig=XmKqJ2%2BFaZXrnR%2Bsob94D9xAQlcwPyq2PbDkDDrbEuc%3D){kind=logo}
Configuring Collection Agent for Individual Devices
- 13 Aug 2024
- 8 Minutes to read
- Contributors
- Print
- PDF
Configuring Collection Agent for Individual Devices
- Updated on 13 Aug 2024
- 8 Minutes to read
- Contributors
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
If you want to set up collection of metrics data separately for individual managed devices, you can do so in the Collection page.
In order to open a data stream for a device, such as a Provider Connectivity Assurance Sensor, the device must be equipped with a Metrics Collection agent. To know if a particular device has a Metrics Collection agent, see the user guide for that model of device.
Note: You can also set up collection of metrics data for multiple devices at once using a configuration job. For more information, see "Setting Up a PM Configuration Job for Metrics Collection".
To configure the settings for an individual device, you go into the Device Configuration tab of the Collection page. When you double-click a specific device in the list, the Agent profile configuration dialog opens and you can configure the settings for the device.
Settings Required to Collect, Stream and Export Data
It takes five settings to ensure that a particular type of agent data will be collected on a particular device, then streamed to Legacy orchestrator and finally exported to the destination system:
A. Enable agent must be checked (or set to true).
B. Enable streaming must be checked (or set to true).
C. Use same period determines whether the same time period will be used for collecting data of all types. Can be enabled or disabled.
D. Collection settings drop-down list (for the particular data type) must be set to
streaming. For example in the figure below, the PAA data type is set to streaming.
E. Period (sec) field (for the particular data type) must be set to an appropriate non-zero value.
Changing the Data Collection Settings for a Device
You can change the settings for collecting agent data for a single device as explained here.
Note: If you disable then re-enable streaming, the device will only transmit data for the periods from the moment streaming is re-enabled. It will not transmit all of the periods stored in memory.
Access the Collection ▶ Device Configuration tab.
The list of managed devices is displayed with the current settings used for data collection on each device.
Double-click the device that you want to configure. The Agent profile configuration
dialog for the device is displayed.Edit the parameters as required. For more information on specific parameters, see the following table.
Agent profile configuration (Collection ▶ Device Configuration)
Device configuration
| Parameter | Description |
|---|---|
| Enable agent | Enables or disables the Metrics Collection agent on the device.
|
| Enable streaming | Determines whether the Metrics Collection agent on the device is enabled for streaming agent data to Legacy orchestrator:
|
| Use same period | Determines whether the same time period will be used for collecting data of all types. If you want to use different time periods for different types of data, uncheck this box (select false). The Period fields for each of the different agent data types in the Collection settings section will be enabled. You will be able to select different periods for the different data types. |
| Use default server | Determines whether data will be streamed to the default Metrics Collection server (the current Legacy orchestrator server). If required, data can be streamed to another Legacy orchestrator server. This checkbox is only available if the current Legacy orchestrator has been deselected as the default Metrics Collection server in the global agent configuration. For more information, see "Configuring Global Collection Settings". Check this box (select true) to enable streaming to the default server (current Legacy orchestrator). Uncheck this box (select false) if you want to stream the data to a different Legacy orchestrator server. The Server IP field and Server port field will be enabled so that you can enter the IP address and port of another Legacy orchestrator to which you want data to be streamed. |
| Server IP | The IP address of the Legacy orchestrator server that will collect agent data. By default, Legacy orchestrator inserts its own IP address as the target IP for receiving agent data. This field is only enabled if the Use default checkbox is unchecked (set to false). You must provide the IP address of another Legacy orchestrator server. |
| Period (sec) | The data collection period. Entered as a value in seconds. If the Use same period checkbox is checked (true is selected), the same time period will be used for all data types. If you want to set different time periods for different data types, ensure that Use same period checkbox is unchecked (false is selected). All Period fields will be enabled and you can set each period separately. Enter a value from 1 to 3,600 seconds. Acceptable values depend on the model of the device. To determine acceptable values for a particular device, see the user manual for the device model. |
| Server port | The PM Collect port on the Legacy orchestrator server is the port used for metrics collection on Legacy orchestrator. Its value is typically set to 14,040. This field is only enabled if the Use default checkbox is unchecked. |
Collection settings
| Parameter | Description |
|---|---|
| Various types of Metrics Collection data | Use the drop-down menus to turn on collecting or streaming of a particular type of data. These are values that can be set and what they mean:
|
| Period (sec) | The data collection period. Entered as a value in seconds. If the Use same period checkbox is checked (true is selected), the same time period will be used for all data types. If you want to set different time periods for different data types, ensure that Use same period checkbox is unchecked (false is selected). All Period fields will be enabled and you can set each period separately. Enter a value from 1 to 3,600 seconds. Acceptable values depend on the model of the device. To determine acceptable values for a particular device, see the user manual for the device model. |
Enabling/Disabling the Metrics Collection Agent for a Device
CAUTION: You must NOT enable the Metrics Collection agent on devices that have the History feature configured. Before enabling the Metrics Collection agent for the device in Legacy orchestrator, you must disable the History feature on the device.
To enable data collection for a device
Access the Collection ▶ Device Configuration tab.
Double-click the device for which you want to enable data collection. The Agent profile configuration dialog is displayed.
Check the Enable agent box.
Check the Enable streaming box.
For each data type that you want to collect on the device, ensure that the appropriate option is selected from the drop-down list beside the name of the data type:
- collecting - The data will be collected on the device, but not streamed to Legacy orchestrator.
- streaming - The data will be collected on the device and streamed to Legacy orchestrator.
Complete the other settings as required. For more information on specific parameters, see the table "Agent profile configuration (Collection ▶ Device Configuration)".
Click Apply and Close.
To disable data collection for a device
Note: If you disable then re-enable streaming, the device will only transmit data for the periods from the moment streaming is re-enabled. It will not transmit all of the periods stored in memory.
Access the Collection ▶ Device Configuration tab.
Double-click the device for which you want to disable data collection.
Uncheck the Enable agent box.
Uncheck the Enable streaming checkbox.
Click Apply then Close.
Changing the Metrics Collection Server
Individual devices can be managed by multiple Legacy orchestrator systems. For a device that is managed by multiple Legacy orchestrator systems, one of those systems must be designated as the device's Metrics Collection server.
By default, the current Legacy orchestrator system is used as the Metrics Collection server for all the devices it manages. However, it is possible to change the Metrics Collection server for devices individually. This is configured through two dialogs:
- Server Configuration: This dialog configures data for the current Legacy orchestrator system.
- Agent Profile Configuration: This dialog configures the Metrics Collection server for an individual device.
To set the current Legacy orchestrator as the Metrics Collection server for all devices
This is a global setting for the Legacy orchestrator system on which you are currently working.
- Select Collection ▶ Server Configuration.
- To use the current Legacy orchestrator system as the Metrics Collection server for all managed devices, ensure the Use Legacy orchestrator as default server for metrics collection checkbox is checked. This is the default setting.
- To use a different Legacy orchestrator system as the Metrics Collection server on individual devices, you must uncheck Use Legacy orchestrator as default server for metrics collection. The current Legacy orchestrator system will still be used as the server on all managed devices.
Click Apply to change the parameters of the Legacy orchestrator system.
Click Close.
To change the Metrics Collection server for a device
You can change the server for an individual device as explained below.
Note: This procedure assumes that the agent setting of the current Legacy orchestrator has been set appropriately as explained in "▶ To set the current Legacy orchestrator as the Metrics Collection server for all devices" above.
Access the Collection ▶ Device Configuration tab.
Double-click the device whose configuration you want to change. The Agent profile configuration dialog is displayed.
To use the current Legacy orchestrator system as the Metrics Collection server for the device, ensure the Use default server checkbox is checked.
To use another Legacy orchestrator system as the Metrics Collection server for this device:
- Uncheck the Use default server checkbox.
- Enter the IP address of the other Legacy orchestrator system in the Server IP field.
- Click Apply to save the change, then click Close.
© 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?