Configuring Ciena Blue Planet Observer jobs
Using the Ciena Blue Planet Observer, you can define jobs that will gather and read all topology data from the Blue Planet MCP instance by REST API and generate a topology.
Before you begin
Important: The Ciena Blue Planet Observer supports MCP 4.0.
Ensure you have the Ciena Blue Planet details to hand, such as API username, API password, MCP URL, MCP certificate, truststore file and truststore password.
Enabling access to the URL routes
To access the URL routes for the topology Swagger documentation, see the Enabling access to URL routes topic.
About this task
The Ciena Blue Planet Observer has two jobs, the restapi load and WebSocket listen jobs.
- When a load job is run, it loads baseline topology data through Blue Planet MCP APIs: Network Elements (constructs), EquipmentHolder, Equipment, TPE (Terminating Point Encapsulation), and FRE (Forwarding Relationship Encapsulation).
- When a listening job is run, the observer listens to changes in resource's status from the BluePlanet MCP instance through a WebSocket connection.
You can also run these jobs (again) from the Observer UI, or schedule them to run at set times when configuring them.
Procedure
Define or edit the following parameters, then click Run job to save and run the job.
Encryption requirement: See the Configuring observer jobs security topic for more information.
Full Topology Upload job (through restapi)
By default, Load jobs are one-off, transient jobs that upload all of the requested topology data as soon as they are triggered.
| Parameter | Action | Details |
|---|---|---|
| Unique ID | Enter a unique name for the job | Required |
| SSL truststore file name | Specify the truststore file name. The observer generates the trust store file based on the file name provided. Tip: You can use the observer name as file name (<observer>.jks), for example VMVCenter.jks. |
Required. The supported format is JKS and the file is relative to $ASM_HOME/security. |
| SSL truststore file password | Specify the truststore password the observer will use to decrypt the HTTPS truststore file. Use a password that conforms to your internal security requirements. | Required |
| Data Center | The data center the MCP instance is running in | Required |
| Tenant Name | The tenant to use | Required |
| Blue Planet MCP server URL | Specify the MCP server endpoint including port and version (such as AUTH_URL) |
Required |
| Username | MCP API username | Required |
| Password | MCP API password. | Required |
| Blue Planet MCP certificate | Certificate name to load into the truststore | Optional |
| SSL Validation | Choose whether SSL validation is on or off. Turning off SSL validation will use HTTPS without host verification. | Optional |
| Connection timeout | Sets the connection and read timeout in milliseconds | Optional. Must be a value greater than 0 (zero), and the default is 5000 (5 seconds). |
| Access scope | Enter text to provide a scope for the resources. Access scope can help map alerts to resources when resources in different scopes share the same parameters, such as matchTokens. | Optional. Tip: You can define access scope for locations, project names, namespaces, etc. |
| Generate debug support file | Set this parameter to 'True' in order to capture the output of the next scheduled job run as a file. This file will be stored with an observer's log files and can be used to debug observer issues, for example at the request of your designated support team, or while using a test environment. For one-off jobs (that is, Load jobs), this parameter reverts to 'False' after the next completed run. To examine the output produced, you can load the generated debug file using the File Observer. | Optional |
| Observer job description | Enter additional information to describe the job | Optional |
| Job schedule | Specify when the job runs | Optional. Load jobs only. |
WebSocket Listen job parameters
A long-running job that monitors its source for updates and runs until it is explicitly stopped, or until the observer is stopped.
| Parameter | Action | Details |
|---|---|---|
| Unique ID | Enter a unique name for the job | Required |
| SSL truststore file name | Specify the truststore file name. The observer generates the trust store file based on the file name provided. Tip: You can use the observer name as file name (<observer>.jks), for example CienaBluePlanet.jks. |
Required. The supported format is JKS and the file is relative to $ASM_HOME/security. |
| SSL truststore file password | Specify the truststore password the observer will use to decrypt the HTTPS truststore file. Use a password that conforms to your internal security requirements. | Required |
| Data Center | The data center the MCP instance is running in | Required |
| Tenant Name | The tenant to use | Required |
| Blue Planet MCP server URL | The URL of the MCP server instance | Required |
| Username | MCP API username | Required |
| Password | MCP API password | Required |
| WebSocket URL | The MCP WebSocket URL to connect to | Required |
| WebSocket Topics Subscriptions | The MCP topics to subscribe to | Required |
| Blue Planet MCP Certificate | Certificate name to load into the truststore | Optional |
| SSL Validation | Choose whether SSL validation is on or off. Turning SSL validation off will use HTTPS without host verification. | Optional |
| Connection timeout | Sets the connection and read timeout in milliseconds | Optional. Must be a value greater than 0 (zero), and the default is 5000 (5 seconds). |
| Access scope | Enter text to provide a scope for the resources. Access scope can help map alerts to resources when resources in different scopes share the same parameters, such as matchTokens. | Optional. Tip: You can define access scope for locations, project names, namespaces, etc. |
| Generate debug support file | Set this parameter to 'True' in order to capture the output of the next scheduled job run as a file. This file will be stored with an observer's log files and can be used to debug observer issues, for example at the request of your designated support team, or while using a test environment. For one-off jobs (that is, Load jobs), this parameter reverts to 'False' after the next completed run. To examine the output produced, you can load the generated debug file using the File Observer. | Optional |
| Observer job description | Enter additional information to describe the job | Optional |
| Job schedule | Specify when the job runs | Optional. Load jobs only. |