Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

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.

Note:

Only a root user can access the service orchestration cMGD CLI and execute commands for service provisioning tasks.

Access the Service Orchestration cMGD CLI

To access the service orchestration cMGD CLI:
  1. Log in to the Paragon Shell CLI as the root user.
  2. Type the following command to exit the Paragon Shell CLI:
  3. Type the following command to log in to the service orchestration cMGD CLI:

    You are now logged in to the service orchestration cMGD CLI.

  4. Type the cli command to enter the CLI mode.

    You can now use the CLI commands to execute service provisioning tasks. See Table 1 to view the commands you can use to navigate in 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.

Table 1: 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:

  • network-resource.tgz.
  • onboard.tgz
  • L3VPN.tgz
  • L2VPN.tgz
/foghorn/network/projects

Contains the projects that you upload to the service orchestration cMGD environment by using the request service project add command.
/var/tmp/add_project.sh.log

Contains the log file generated when you execute the request service project add command to add a project to the cMGD environment. The add_project.sh.log file is useful for debugging errors that occur while uploading a project.
/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 request service order sync command. The order_sync_conf.json file is useful for troubleshooting errors that occur while synchronizing.

Service Orchestration cMGD CLI Commands

Root users can use the commands listed in Table 2 to execute service provisioning tasks in Paragon Automation:

Table 2: Service Orchestration cMGD CLI Commands and Descriptions

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.

 
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.

 
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.

See Also