Setting Up a PM Configuration Job for Metrics Collection

Updated on 19 Sep 2024
6 Minutes to read
Contributors

Article summary

Did you find this summary helpful?

Thank you for your feedback

You can use a configuration job to set up the collection of performance metrics on managed elements.

Note: You can also set up the collection of metrics data manually for individual elements in Legacy orchestrator. For more information, see "Configuring Collection Agent for Individual Devices".

Configuring Global Parameters for Metrics Collection

Legacy orchestrator normally exports the performance metrics that it collects to an Operations Support System (only displayed if the Metrics Collection feature is activated). For more information, see "About the Metrics Collection Module".

Before setting up and executing a configuration job for collecting metrics data, you should ensure that the connection to the export destination has been configured in the Legacy orchestrator interface. See "Configuring Global Collection Settings".

Setting Up a PM Configuration Job for Metrics Collection

After you have ensured that the connection to the export destination system has been configured as required (see "Configuring Global Parameters for Metrics Collection"), you can set up your configuration job.

Setting the parameters for a configuration job that collects metrics data is essentially the same as setting the parameters for collecting metrics data from an individual device manually (see "Configuring Collection Agent for Individual Devices"). The main difference is how you select elements from which to collect data. As usual for a configuration job, you can select the elements in either of two ways:

Using an ME Reference file that lists the elements. This allows you to define the elements ahead of execution time; or
When you run a Configuration Job Executor, you can select elements by dragging
them into a list of target elements. Also as usual, you can run the configuration job immediately or you can schedule it to run at a specified time.

To set up a PM configuration job for collecting metrics data

Access the page Commission ▶ Jobs. The Jobs dialog is displayed.
Create a new job by clicking the Add job profile button or copy an existing job by selecting the Duplicate job profile button.
Enter a name for the configuration job.
If you are using an ME reference file to specify the elements, check the ME reference data set enabled checkbox and select the ME reference data set file.
Check the PM box in the left pane.
If you are using an ME reference file, the PM Data set section is displayed at the top of the Job Configuration page. Complete the section as follows:
If you want to use a dataset file to configure data collection, check the Collect data
set enable checkbox and select the file.
If you want to configure data collection by making selections in the** Job Configuration** page, do not check the Collect data set enable checkbox.
Complete the Agent configuration and Collection settings sections of the Job Configuration page as explained in the table after this procedure.
Click Apply, then click Close.
Click the Refresh button to refresh the user interface.

Parameters for PM (Metrics Collection) configuration job
Device configuration

Parameter	Description
Enable agent	Enables or disables the Metrics Collection agent on the device. Enabled (true): Enables Metrics Collection agent. Performance data can be collected. Disabled (false): Disables 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: Enabled (true): ): The device is prepared to stream its agent data to Legacy orchestrator. Disabled (false): The device will not stream its 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 element 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: off - Data will not be collected on the element. collecting - Data will be collected on the element but will not be streamed to the Metrics Collection server (usually Legacy orchestrator). If required, the data can be sent to another server by using a protocol. For more information, see the user manual for the element model. streaming - Data will be collected on the element and streamed to the Metrics Collection server (usually Legacy orchestrator). The following types of Metrics Collection data can be collected, streamed and exported: PAA Policy Regulator SOAM DMM SOAM PL SOAM SA SOAM SA metric SOAM SLM flowmeter TWAMP Port Shaper SFP System Health
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 element model.

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:

off - Data will not be collected on the element.
collecting - Data will be collected on the element but will not be streamed to the Metrics Collection server (usually Legacy orchestrator). If required, the data can be sent to another server by using a protocol. For more information, see the user manual for the element model.
streaming - Data will be collected on the element and streamed to the Metrics Collection server (usually Legacy orchestrator).

The following types of Metrics Collection data can be collected, streamed and exported:

PAA
Policy
Regulator
SOAM DMM
SOAM PL
SOAM SA
SOAM SA metric
SOAM SLM
flowmeter
TWAMP
Port
Shaper
SFP
System Health

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 element model.

© 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

Setting Up a Permission Group Configuration Job

Table of contents