About the Service Orchestration cMGD CLI
Paragon Automation provides the service orchestration Containerized Management Daemon (cMGD) CLI that allows root users to perform certain tasks for service provisioning. Before accessing the service orchestration cMGD CLI, you must deploy your cluster and install Paragon Automation on the cluster. After you log in to the Paragon Shell CLI as the root user, you must exit the Paragon Shell CLI and access the service orchestration cMGD CLI.
Only a root user can access the service orchestration cMGD CLI and execute commands for service provisioning tasks.
Access the Service Orchestration cMGD CLI
Directories in the Service Orchestration cMGD
The service orchestration cMGD has default directories that contain the service design YANG files, log files, and so on. Table 1 lists some of the important directories in the service orchestration cMGD.
Directory |
Description |
---|---|
/data-models/projects |
Projects contain one or more related service designs based on which service orchestration can provision a service. Paragon Automation provides the following projects and related YANG models:
|
/foghorn/network/projects |
Contains the projects that you upload to the service
orchestration cMGD environment by using the |
/var/tmp/add_project.sh.log |
Contains the log file generated when you execute the
|
/var/tmp/order_sync_conf.json |
Contains the configurations (in JSON format) that you synchronize
from the order manager to the service orchestration cMGD
environment by using the |
Service Orchestration cMGD CLI Commands
Root users can use the commands listed in Table 2 to execute service provisioning tasks in Paragon Automation:
Command |
Description |
---|---|
set foghorn:core org-id |
Set the organization ID in the service orchestration cMGD environment. |
set service design default version |
Set the default version for a service design. |
set dag state failed |
Set a workflow run to failed state. |
show service order status |
View the status of all service orders generated for an organization. |
show service order as-json |
View all or a specific service order in the JSON format. |
show service order as-yaml |
View all or a specific service order in the YAML format. |
show service designs |
View the service design catalog installed for an organization. |
show device dependent configuration |
View the device-centric configurations for provisioning services, in the XML format. |
show insights configuration |
View the configurations related to Paragon Insights for monitoring the services that Paragon Automation intends to provision on a device. |
show configuration foghorn:customers |
View configurations for all the services provisioned for a customer. |
show service instance lock status |
See the lock status of a service instance. A service instance is locked when the instance is being uploaded, modified, or if the network administrator has locked it. |
show service instance lock token |
See the lock token for a service instance. Note:
Only superusers must execute this command to acquire the secure lock token stored in the Paragon Automation database. |
show service projects |
Shows the projects that are added to the service orchestration cMGD. |
show service order history |
Shows the history of all service orders. |
show airflow dags |
View all workflows generated for an organization. |
show airflow dag-runs |
View the workflow runs generated for a workflow. |
show paragon orgs |
View all the organizations created in Juniper Paragon Automation. |
request service project add |
Add new service designs and the related YANG models to Paragon Automation. |
request service order sync |
Synchronize a service order from the order manager and store it in the service orchestration cMGD. |
request network resources load |
Add network resource pools to the Paragon Automation database. |
request service order load |
Upload a service order to the service orchestration cMGD environment. |
request service order place |
Select placement options and create placement configurations for a service. |
request service order modify |
Execute the modify workflow for a service. |
request service order delete |
Execute the delete workflow for a service. |
request service order submit |
Activate the provisioning workflow for a service order. |
request service order provision |
Create and execute the workflow for a service order. |
request service design uninstall |
Uninstall a service design version from the Paragon Automation database. |
request service design install |
Install a service design version to the database. |
request create graphdb |
Create a database for an organization in the service orchestration cMGD. |
request service order set |
Sets the delete operation for a service order in the service orchestration cMGD. This command does not execute the delete workflow for the order. |
request service instance lock |
Set a lock for a service instance. |
request service instance unlock |
Unlock a locked service instance. |