Used to terminate a configuration session and discard all uncommitted changes without system confirmations. You can use the abort command in any configuration mode.

Syntax

abort

Command Mode

CONFIG

VNFs

All

Command Usage

Use the abort command to terminate a configuration session and return to the operational mode from any configuration mode. This command causes all uncommitted configuration changes to be discarded. You are not prompted to commit the changes.

Examples

The following is an example:

aaa authentication users user test1 password test123 gid 100 homedir / ssh_keydir / uid 9340
admin@orchestrator[an-master](config-user-test1)# exit
admin@orchestrator[an-master](config)# abort
admin@orchestrator[an-master]#

Creates a new alerting rule.

The alerting rule allows automatic creation of internal and SNMP traps based on system conditions. The Prometheus monitoring application must be running for alerts to trigger properly. If all Prometheus servers are down, then the system does not generate alerts.

Syntax

alert rule name duration duration event-host-label event-host-label expression expression message message snmp-clear-message snmp-clear-message snmp-facility { application | hardware | networking | os | proc | virtualization } snmp-severity { alert | critical | debug | emergency | error | info | none | notice | warning }

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use the alert rule command to define monitoring rules for the system. When you create a new alert rule, the alert rule is exported to the Prometheus monitoring servers, which are monitoring the system on a 1-second interval. The Prometheus servers monitor the underlying expression defined in the alert rule and send alerts scheduling OAM node when they are triggered or when they are cleared. The OAM node tracks internally the status of all alerts and sends any SNMP traps if SNMP servers are defined.

Examples

The following example generates an alert when node_lode > 3:

alert rule test
 expression         "node_load5 > 3"
 event-host-label   instance
 message            "Node level exceeds 3"
 snmp-facility      application
 snmp-clear-message "Node level below 3"
!

Creates a new SNMPv2 destination.

Creation of a SNMPv2 destination causes the system to forward any triggered/cleared alerts to the SNMPv2 destination.

Syntax

alert snmp-v2-destination nms-address community community

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use the alert snmp-v2-destination to forward alerts from the system to an external SNMPv2 trap receiver. The traps are sent using the following algorithm:

• Sent once when the alert is cleared

• Sent once when the alert is firing

• Sent once if the OAM application is restarted and the alert is firing.

Examples

The following example sends all alerts to community “test” with address 10.10.10.10.

scheduler(config)# alert snmp-v2-destination 10.10.10.10 community test

Creates a new SNMPv3 destination.

Creation of a SNMPv3 destination causes the system to forward any triggered/cleared alerts to the SNMPv3 destination.

Syntax

alert snmp-v3-destination nms-address auth-password auth-password auth-proto auth-proto engine-id engine-id privacy-password privacy-password user user

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use the alert snmp-v3-destination to forward alerts from the system to an external SNMPv2 trap receiver. The traps are sent using the following algorithm:

• Sent once when the alert is cleared

• Sent once when the alert is firing

• Sent once if the OAM application is restarted and the alert is firing.

Examples

The following example sends all alerts to community “test” with address 10.10.10.10.

scheduler(config)# alert snmp-v3-destination 10.10.10.10 user test auth-proto SHA auth-password test engine-id 0x01020304 privacy-protocol AES privacy-password  test

Applies patches that are staged in the /data/orchestrator/patches/ directory of the master VM.

This command should only be used by the Cisco TAC and Engineering team to address specific problems and debug the application.

Syntax

apply patches

Command Parameters

Command Mode

OPERATIONAL

VNFs

All

Command Usage

This command should only be used at the recommendation of Cisco TAC and Engineering teams.

Used to configure same connection pool on IMSIAPN-MSISDNAPN database transactions.

Note	This command is applicable only for application client based sharding.

Syntax

binding cluster-binding-dbs imsiapn-msisdnapn

Command Mode

CONFIG

VNFs

DRA

Command Usage

Use this CLI to indicate to the application that IMSI APN bindings DB and MSISDN APN Bindings DB will use the same connection pool for DB transactions.

IMSI-APN connection settings for both read and write will apply to this combined pool.

In this mode change in MSISDN APN connection settings for read or write connection pools will have no effect.

Note	This is not recommended for small deployments. It is required for the deployments for which the database spans across 48 shards or more.

Examples

The following is an example:

admin@orchestrator(config)# binding cluster-binding-dbs imsiapn-msisdnapn

Adds additional binding db connections from the DRA to a DRA binding database.

Note	This command is applicable only for MongoDB based sharding.

Syntax

binding db-connection { ipv4 | ipv6 | imsiapn | msisdnapn| slf } address port

Command Parameters

Command Mode

CONFIG

VNFs

DRA

Command Usage

Use the binding db-connection command to instruct the application on how to connect to the remote binding database. In general, there should be configuration lines entered per binding database type in order to support high availability.

Examples

The following configuration defines two redundant connections per database.

binding db-connection ipv6 172.16.82.195 27017
!
binding db-connection ipv6 172.16.82.196 27017
!
binding db-connection ipv4 172.16.82.195 27017
!
binding db-connection ipv4 172.16.82.196 27017
!
binding db-connection imsiapn 172.16.82.195 27017
!
binding db-connection imsiapn 172.16.82.196 27017
!
binding db-connection msisdnapn 172.16.82.195 27017
!
binding db-connection msisdnapn 172.16.82.196 27017
!
binding db-connection slf 172.16.82.195 27017
!
binding db-connection slf 172.16.82.196 27017
!

Used to configure the write mongo connection settings. The connections are used for database create/update and delete of session and bindings.

Note	This command is applicable for MongoDB based and application client based sharding.

Syntax

binding db-connection-settings { drasession | imsiapn | ipv4 | ipv6 | msisdnapn | range | slf } acceptable-latency-difference-for-read connect-timeout connections-per-host max-wait-time socket-timeout

Note	For Policy DRA, supported values are drasession/imsiapn/ipv4/ipv6/msisdnapn. For recommended values, refer to Database Connection Settings section in the CPS vDRA Advanced Tuning Guide.

Command Parameters

Command Mode

CONFIG

VNFs

DRA

Command Usage

Use the binding db-connection-settings command to configure the write mongo connection settings.

Examples

The following is an example:

admin@orchestrator(config)# binding db-connection-settings ?
Possible completions:
  drasession  imsiapn  ipv4  ipv6  msisdnapn  range  slf

admin@orchestrator(config)# binding db-connection-settings drasession ?
Possible completions:
  acceptable-latency-difference  connect-timeout  connections-per-host  max-wait-time  socket-timeout  <cr>

admin@orchestrator(config-db-connection-settings- drasession)# acceptable-latency-difference ?
Possible completions:
  <int>[5]
admin@orchestrator(config-db-connection-settings- drasession)# connect-timeout ?
Possible completions:
  <int>[500]

admin@orchestrator(config-db-connection-settings- drasession)# connections-per-host ?
Possible completions:
  <int>[10]

admin@orchestrator(config-db-connection-settings- drasession)# max-wait-time ?
Possible completions:
  <int>[500]

admin@orchestrator(config-db-connection-settings- drasession )# socket-timeout ?
Possible completions:
  <int>[1000]

Used to configure maximum record limit on session and bindings.

Syntax

binding db-max-record-limit { all | drasession | imsiapn | ipv4 | ipv6 | msisdnapn | range | slf } <limit>

no binding db-max-record-limit drasession <limit>

Command Parameters

Command Mode

CONFIG

VNFs

DRA

Command Usage

Use the db-max-record-limit command to configure maximum record limit on session and bindings.

Examples

The following is an example:

admin@orchestrator[master-0m](config)# binding db-max-record-limit 
Possible completions:
  all  drasession  imsiapn  ipv4  ipv6  msisdnapn  range  slf

admin@orchestrator[master-0m](config)# binding db-max-record-limit all  1000
admin@orchestrator[master-0m](config)# binding db-max-record-limit drasession 1000
admin@orchestrator[master-0m](config)# binding db-max-record-limit imsiapn 1000
admin@orchestrator[master-0m](config)# binding db-max-record-limit ipv4 1000
admin@orchestrator[master-0m](config)# binding db-max-record-limit ipv6 1000
admin@orchestrator[master-0m](config)# binding db-max-record-limit msisdnapn 1000

Used to configure the read mongo connection parameters.

Note	This command is applicable only for application client based sharding.

Read connections are used for:

• Rx-AAR based binding look up

• Rest API binding query

• Reset of next evaluation time for both sessions and bindings

• Health checks

Syntax

binding db-read-connection-settings { drasession | imsiapn | ipv4 | ipv6 | msisdnapn | range | slf } acceptable-latency-difference-for-read connect-timeout-for-read connections-per-host-for-read max-wait-time-for-read socket-timeout-for-read

Note	For Policy DRA, supported values are drasession/imsiapn/ipv4/ipv6/msisdnapn. For recommended values, refer to Database Connection Settings section in the CPS vDRA Advanced Tuning Guide.

Command Parameters

Command Mode

CONFIG

VNFs

DRA

Command Usage

Use the binding db-read-connection-setting commands to configure the read mongo connection parameters. Applicable only for connection with client-sharded database cluster.

Examples

The following is an example for setting the connection-per-host for read connections with session-db to 5:

admin@orchestrator[master-0](config)# binding db-read-connection-settings drasession connections-per-host-for-read 5

Used to configure binding shard metadata database connections from DRA to a DRA shard metadata binding database.

Note	This command is applicable only for application client based sharding.

Syntax

binding shard-metadata-db-connection { all | drasession | imsiapn | ipv4 | ipv6 | loadmetrics | msisdnapn | range } <ip-address> <port> 

no binding shard-metadata-db-connection { drasession | imsiapn | ipv6 | loadmetrics | msisdnapn } <ip-address> <port>

Command Parameters

Command Mode

CONFIG

VNFs

DRA

Command Usage

Use the binding shard-metadata-db-connection command to instruct the application on how to connect to the remote shard metadata binding database. In general, there should be configuration lines entered per binding database type in order to support high availability.

Examples

The following configuration defines two redundant connections per database:

binding shard-metadata-db-connection drasession 172.16.82.195 27017
!
binding shard-metadata-db-connection drasession 172.16.82.196 27017
!
binding shard-metadata-db-connection ipv6 172.16.82.195 27017
!
binding shard-metadata-db-connection ipv6 172.16.82.196 27017
!
binding shard-metadata-db-connection ipv4 172.16.82.195 27017
!
binding shard-metadata-db-connection ipv4 172.16.82.196 27017
!
binding shard-metadata-db-connection imsiapn 172.16.82.195 27017
!
binding shard-metadata-db-connection imsiapn 172.16.82.196 27017
!
binding shard-metadata-db-connection msisdnapn 172.16.82.195 27017
!
binding shard-metadata-db-connection msisdnapn 172.16.82.196 27017
!
binding shard-metadata-db-connection loadmetrics 172.16.82.195 27017
!
binding shard-metadata-db-connection loadmetrics 172.16.82.196 27017
!

Used to configure CPU usage threshold value for read and write database operations.

Note	This command is applicable only for application client based sharding.

Important

The following commands need to be configured to monitor CPU usage of all the database VMs: binding shard-metadata-db-connection loadmetrics <ip-address> <port> For more information on binding shard-metadata-db-connection, refer to binding shard-metadata-db-connection.

Syntax

binding throttle-db-operation { range | read | write } max-cpu-usage <cpu_value>

no binding throttle-db-operation { range | read | write } max-cpu-usage

Command Parameters

Command Mode

CONFIG

VNFs

DRA

Command Usage

Use the binding throttle-db-operation command to configure the read and write CPU threshold value to throttle the read and write database operations.

Examples

The following configuration defines CPU threshold value for read and write database operations:

binding throttle-db-operation read max-cpu-usage 70
!
binding throttle-db-operation write max-cpu-usage 70
!

Used to clear uncommitted changes.

Syntax

clear

Command Mode

CONFIG

VNFs

All

Command Usage

Use the clear command to discard all the uncommited changes.

Examples

The following is an example:

clear
All configuration changes will be lost. Proceed? [yes, NO]

Used to compare the similar configurations.

Syntax

compare cfg <configuration path> to <configuration path>

Command Mode

CONFIG

VNFs

All

Command Usage

• To compare the similar configurations in configuration mode.

• Need to represent exact ideal configuration paths.

Examples

The following is an example:

compare cfg aaa authentication users user admin to aaa authentication users user oper
- password $1$ftGF2fQE$4P145tnwbouLSr8pbm4EW1;
+ password $1$sFadxrqz$Tp88/Go3jTNUuloSdPB9K.;
- ssh_keydir /var/confd/homes/oper/.ssh;
+ ssh_keydir /var/confd/homes/admin/.ssh;
- homedir /var/confd/homes/oper;
+ homedir /var/confd/homes/admin;

Used to list, save, delete, and restore the consul snapshot from the /data/orchestrator/config/snapshot/ directory.

Syntax

consul [list-snapshots | save-snapshot snapshot-name nameofsnapshot | restore-snapshot snapshot-name nameofsnapshot | delete-snapshot nameofsnapshot]

Command Parameters

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use the consul command to list, save, delete, and restore the consul snapshot in the /data/orchestrator/config/snapshot/ directory.

Examples

The following are the examples:

admin@orchestrator[ss-master-binding-0]# consul list-snapshots                     
Snapshot Name
********************************************************

19.5.5-20200105_131756.6477
19.5.8-20200214_025459.6674

********************************************************
admin@orchestrator[ss-master-binding-0]# consul save-snapshot snapshot-name snap1  
result Snapshot is created in /data/orchestrator/config/snapshot-consul/snap1
admin@orchestrator[ss-master-binding-0]# consul list-snapshots                   
Snapshot Name
********************************************************

19.5.5-20200105_131756.6477
19.5.8-20200214_025459.6674
snap1

********************************************************
admin@orchestrator[ss-master-binding-0]# consul save-snapshot snapshot-name snap2
result Snapshot is created in /data/orchestrator/config/snapshot-consul/snap2
admin@orchestrator[ss-master-binding-0]# consul list-snapshots                   
Snapshot Name
********************************************************

19.5.5-20200105_131756.6477
19.5.8-20200214_025459.6674
snap1
snap2

********************************************************
admin@orchestrator[ss-master-binding-0]# consul delete-snapshot snap2              
Snapshot is deleted
admin@orchestrator[ss-master-binding-0]# consul list-snapshots       
Snapshot Name
********************************************************

19.5.5-20200105_131756.6477
19.5.8-20200214_025459.6674
snap1

********************************************************
admin@orchestrator[ss-master-binding-0]# consul restore-snapshot ?
Possible completions:
  snapshot-name
admin@orchestrator[ss-master-binding-0]# consul restore-snapshot snapshot-name snap1
result Snapshot restore success.
admin@orchestrator[ss-master-binding-0]# consul list-snapshots                      
Snapshot Name
********************************************************

19.5.5-20200105_131756.6477
19.5.8-20200214_025459.6674
snap1

********************************************************
admin@orchestrator[ss-master-binding-0]# consul delete-snapshot snap1               
Snapshot is deleted
admin@orchestrator[ss-master-binding-0]# 

Adds additional control-plane entries between two disconnected CPS vDRA sites.

Syntax

control-plane relay name address address port port

Command Parameters

Command Mode

CONFIG

VNFs

DRA

Command Usage

Use the control-plane relay command to instruct the application how which links it should use to relay CPS vDRA control traffic. CPS vDRA control traffic is the traffic that describes the current endpoints within a site and the relay IPs for site to site communication. For a 2 site model there should be at least 4 entries defined in this definition (two for each site). For a 3 site model there should be at least 6 entries in this definition.

Examples

The following configuration adds a relay connection to siteA over address 10.10.10.10 port 6379.

scheduler(config)# control-plane relay siteA-1 address 10.10.10.10 port 6379

Used to configure IPC endpoint update interval.

Syntax

control-plane ipc-endpoint update-interval <time-in-milliseconds>

no control-plane ipc-endpoint update-interval

Command Parameters

Command Mode

CONFIG

VNFs

DRA

Command Usage

This command is used to configure the frequency for updating the IPC endpoints.

Examples

The following configuration adds an 200 milliseconds interval for updating the IPC endpoints.

scheduler(config)# control-plane ipc-endpoint update-interval 200

Note	For more information on the values to be configured, refer to Control Plane Tuning Configuration section in the CPS vDRA Advanced Tuning Guide.

Used to configure the control plane remote peer policy.

Syntax

control-plane remote-peer-policy global accept all

control-plane remote-peer-policy global accept diameter-applications [Gx | Gy | Rx | Sd | Sy]

Command Parameters

By default, DRA accepts all the applications from all the sites.

Command Mode

CONFIG

VNFs

DRA

Command Usage

This command is used to configure the control plane remote peer policy for the DRA system to accept peer connection information from other DRA systems. Policy can be configured to accept peer connection information for all Diameter application types or only specific Diameter application types. DRA system can route messages only to remote peers accepted by policy.

Examples

Example 1:

control-plane remote-peer-policy global accept diameter-applications Rx

Example 2:

control-plane remote-peer-policy global accept diameter-applications [ Gx Rx Gy ]

Example 3:

control-plane remote-peer-policy global accept all

Example 4:

no control-plane remote-peer-policy global accept diameter-applications [ Gx Rx Gy ]

Used to configure the mated system ID.

Syntax

control-plane remote-peer-policy mated-system id <system-id>

Command Parameters

Command Mode

CONFIG

VNFs

DRA

Command Usage

This command is used to configure the system ID of the mated DRA system. DRA system accepts peer information for all Diameter application types from the mated system.

Example

control-plane remote-peer-policy mated-system id system-02

Used to modify the value of peer status update interval and peer expiration duration.

Syntax

control-plane timers peer-status-update-interval <time-in-ms> peer-expiration-duration <duration-in-ms>

Command Parameters

Command Mode

CONFIG

VNFs

DRA

Command Usage

This command allows tuning the frequency at which director nodes send periodic status updates for peers connected to the nodes. The command also allows tuning the expiration time for peers maintained in topology when consecutive periodic status updates are not received for the peers.

Peer expiration duration should be equal to three times of peer status update interval.

For example, if peer-status-update-interval = 4000 ms then, peer-expiration-duration = 12000

To reflect the peer expiration duration change, application should be restarted in both director and worker nodes.

Example

control-plane timers peer-status-update-interval 4000 peer-expiration-duration 12000

Create a MongoDB database sharded cluster.

Syntax

database cluster name sharded-cluster-master {true|false} 

no database cluster name

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use the database cluster command and sub-commands to instruct the application to provision a database cluster for use in application database operations.

Examples

The following is an example of creating a “binding” sharded cluster that is being managed by the current VNF.

scheduler(config)# database cluster binding sharded-cluster-master true 

Add a MongoDB configuration server process to the named database cluster.

Note	This command is applicable only for MongoDB based sharding.

Syntax

database cluster db-name config-server name address address 

no database cluster db-name config-server name

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use the database cluster config-server to add a config-server to the system.

Examples

The following is an example of adding a new config server to the “binding” cluster.

scheduler(config)# database cluster binding config-server cfg-1 address 10.10.10.10

Set the initial seed configuration server for boot-strapping the MongoDB replica set initialization process.

Note	This command is applicable only for MongoDB based sharding.

Syntax

database cluster db-name config-server-seed name

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use the database cluster config-server-seed command to set the initial seed configuration server for boot-strapping the MongoDB replica set initialization process. This is required if a config server is set.

Examples

The following is an example of setting cfg-1 as the initial seed for a new config server to the “binding” cluster.

scheduler(config)# database cluster binding config-server-seed cfg-1

Used to add a MongoDB sharding configuration server process to the named database cluster.

Note	This command is applicable only for application client based sharding.

Syntax

database cluster db-name mutli-db-collections noOfShardsPerDB

no database cluster db-name multi-db-collections

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use the database cluster multi-db-cluster to create those number of shards per database.

Examples

The following is an example of enabling multi-db-collections to the “binding” cluster.

admin@orchestrator[master-hostname](config)# database cluster binding multi-db-collections 2

Add a new MongoDB router to the named DB cluster.

Note	This command is applicable only for MongoDB based sharding.

Syntax

database cluster db-name router name

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use the database cluster router command to add a router to named database cluster. Full initialization of database cluster requires at least one router to be defined and often for HA purposes multiple routers are required.

Examples

The following is an example of adding a router to the “binding” cluster.

scheduler(config)# database cluster binding router router-1 address 10.10.10.10 port 27017

Add a new MongoDB shard to the named database cluster.

Syntax

database cluster db-name shard name 

no database cluster db-name shard name

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use the database cluster shard command to add a new shard to the named database cluster. Full initialization of database cluster requires at least the definition of one shard and often for scaling purposes multiple shards are required.

Examples

The following is an example of adding a shard to the “binding” cluster.

database cluster binding shard shard-1

Add a new MongoDB shard to the named DB cluster.

Syntax

database cluster db-name shard shard-name shard-server name address address port port [arbiter {true|false}] [memory_allocation_percent percent] [priority priority] [voter {true|false}] [storage-engine {IN_MEMORY|MMAPv1|WT}]

no database cluster db-name shard shard-name server name

Note	When creating replica set, ensure that all ports are the same, i.e, the replica set should have same port for ARBITER, PRIMARY, and SECONDARY.

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use the database cluster shard server command to add a new server to named database cluster. Full initialization of database cluster requires at least the definition of one shard server and for HA at least 3 nodes are required.

Examples

The following is an example of adding a new shard to the “binding” cluster.

scheduler(config)# database cluster binding shard shard-1 shard-server server-1 storage-engine WT address 10.10.10.10 port 27017

Note	Ports to be used for all database operations must be in the range of 27017 to 27047. Ports outside the defined range are not supported since the application must limit the port mappings. The selected range is sufficient for 30 Mongo processes on a given node.

Set the initial seed shard server for boot-strapping the MongoDB replica set initialization process.

Syntax

database cluster db-name shard shard-name shard-server-seed name 

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use the database cluster shard-server-seed command to set the initial seed shard server for boot-strapping the MongoDB replica set initialization process. This is required if a shard is defined.

Note

To create or add a member to an existing replica set, you must also run the Mongo console-based commands as shown: mongo> rs.add("name") To remove a replica set or a shard in a sharded cluster case, remove the member from the Mongo console as shown: mongo> rs.remove("name") You must also navigate to the container and the VM on which the member resides and clear the data manually. The data path is the same as the one that is used when the replica-set member is created. Typically, the path is //mmapv1-tmpfs-2xxxx where 2xxxx is the port where the replica set member is started.

Examples

The following is an example of setting server-1 as the initial seed for a new shard called “shard-1” to the “binding” cluster.

scheduler(config)# database cluster binding shard shard-1 shard-server-seed server-1 

Adds a MongoDB sharding configuration server process to the named database cluster.

Note	This command is applicable only for application client based sharding.

Syntax

database cluster db-name sharding-db name address address

no database cluster db-name sharding-db name

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use the database cluster sharding-db to add a sharding config-server to the system.

Examples

The following is an example of adding new sharding database to “binding” cluster.

admin@orchestrator[master-hostname](config)# database cluster binding sharding-db shdb-1 address 10.10.10.10

Sets the initial seed configuration server for boot-strapping the MongoDB replica set initialization process.

Note	This command is applicable only for application client based sharding.

Syntax

database cluster db-name sharding-db-seed name

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use the database cluster sharding-db-seed command to set the initial seed configuration server for boot-strapping the MongoDB replica set initialization process. This is required if a sharding database is set.

Examples

The following is an example of setting shdb-1 as the initial seed for a new sharding database to the “binding” cluster.

admin@orchestrator[master-hostname](config)# database cluster binding sharding-db-seed shdb-1

Enable the zone-based sharding for IPv6. When zone-based sharding is enabled on IPv6 database, hash-based sharding can still be configured on other databases.

Syntax

database cluster <db name> ipv6-zone-sharding true/false

Command Parameters

Command Mode

CONFIG

VNFs

DRA

Command Usage

Use database cluster binding ipv6-zone-sharding to enable/disable zone sharding on IPv6 database.

Examples

The following is an example of enabling zone-based sharding for the IPv6 database in the cluster binding:

database cluster binding ipv6-zone-sharding true

Create zones for IPv6 shards based on IPv6 pools, so that the primary member of the replica set for an IPv6 address resides at the same physical location as the PGW assigning addresses from the IPv6 pool. This results in local writes (and reads) for the IPv6 binding database.

Note	It is possible to create multiple ranges for each zone. Configure the IPv6 ranges in short format only.

Syntax

database cluster <db name> ipv6-zones-range <zone-name> zone-range <range-name> start <pool starting address> end <pool ending address>

Command Parameters

Command Mode

CONFIG

VNFs

DRA Binding

Command Usage

This command creates a zone and also creates ranges for the zone.

Examples

The following is an example of creating a IPv6 zone with name pune for the cluster binding and a range of 2003:3051:0000:0001 to 2003:3051:0000:0500 for the zone:

database cluster binding ipv6-zones-range pune zone-range range1 start 2003:3051:0000:0001 end 2003:3051:0000:0500

Add shards to a zone.

Syntax

database cluster <db name> shard <shard name> zone-name <zone-name>

Command Parameters

Command Mode

CONFIG

VNFs

DRA Binding

Command Usage

Use the command to add the shard to a zone.

Examples

The following is an example of mapping the IPv6 zone with name pune with the shard shard-1 in the cluster binding:

database cluster binding shard shard-1 zone-name pune

Deletes the data belonging to given range and zone for all the bindings and sessions databases.

Syntax

database delete all-bindings-sessions <bindings-cluster-name> <sessions-cluster-name> <zone-name> <start-address> <end-address>

Command Parameters

Command Mode

OPERATIONAL

VNFs

Binding

Command Usage

Use the database delete all-bindings-sessions zone command to delete IPv6 bindings and all the associated bindings for the specified address range from the specified zone.

Examples

The following example deletes IPv6 bindings and all the associated bindings from a specific zone:

database delete all-bindings-sessions imsi-msisdn session-ipv6-AB pune 7507:9903:1808:8000 7507:9903:1808:8fff

The following example deletes IPv6 bindings and all the associated bindings from the default zone:

database delete all-bindings-sessions imsi-msisdn session-ipv6-AB default 7507:9903:1808:8000 7507:9903:1808:8fff

Deletes IPv6 bindings for the specified address range from the specified zone.

Syntax

database delete ipv6bindings <sessions-cluster-name> <zone-name> <start-address> <end-address>

Command Parameters

Command Mode

OPERATIONAL

VNFs

Binding

Command Usage

Use the database delete ipv6bindings command to delete IPv6 bindings for the specified address range from the specified zone.

Examples

The following example deletes IPv6 bindings from a specific zone:

database delete ipv6bindings session-ipv6-AB pune 7507:9903:1808:8000 7507:9903:1808:8fff

The following example deletes IPv6 bindings from the default zone:

database delete ipv6bindings session-ipv6-AB default 7507:9903:1808:8000 7507:9903:1808:8fff

To set the Redis authentication password.

Syntax

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use the database authentication command to set the Redis password which is used to access Redis data store.

Examples

The following is an example to set the Redis authentication password:

admin@orchestrator[master-0m]# db-authentication set-password database redis password
Value for 'password' (<string>): ***********
result SUCCESS

To display the encrypted redis password.

Syntax

db-authentication show-password database redis

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use the database authentication command to display the Redis password.

Examples

The following is an example to display the Redis authentication password:

admin@orchestrator[master-0m]# db-authentication show-password database redis
result
result PASSWORD : 72261348A44594381D2E84ADDD1E6D9A

To remove Redis authentication password.

Syntax

db-authentication remove-password database redis current-password password

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use the db-authentication command to remove Redis authentication password.

Examples

The following is an example to remove Redis authentication password:

admin@orchestrator[master-0m]# db-authentication remove-password database redis
Value for 'current-password' (<string>): *******
result SUCCESS

To display the encrypted MongoDB password.

Syntax

db-authentication show-password database mongo

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use the database authentication command to display the MongoDB password.

Examples

The following is an example:

scheduler# db-authentication show-password database mongo
result
adminuser: 3300901EA069E81CE29D4F77DE3C85FA

Used to create users (adminuser and backupuser) with credentials in the MongoDB.

Syntax

db-authentication set-password database mongo password <password>

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA and Binding

Command Usage

This command is used to create users (adminuser and backupuser) with credentials in the MongoDB.

Examples

The following is an example to create users with credentials:

admin@orchestrator[binding-master]# db-authentication set-password database mongo password
Value for 'password' (<string>): ******
result SUCCESS

Used to remove the users (admin user and backup user) and password from all the databases.

Syntax

db-authentication remove-password database mongo current-password <password>

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA and Binding

Command Usage

Use to remove users and password from the mongo databases. Before using this command the database should be in transition authentication state and after this command rolling restart is mandatory.

Examples

The following is an example to remove-password in mongo database:

admin@orchestrator[binding-master]# db-authentication remove-password database mongo
Value for 'current-password' (<string>): *******
result SUCCESS

Used to change the admin user password in all the databases.

Syntax

db-authentication change-password database mongo current-password <current pasword> new-password <New password> user adminuser

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA and Binding

Command Usage

This command change password of adminuser in all the MongoDB.

Examples

The following is an example to change-password in MongoDB:

admin@orchestrator[binding-master]# db-authentication change-password database mongo user adminuser
Value for 'current-password' (<string>): ******
Value for 'new-password' (<string>): ********
result SUCCESS

Used to synchronize the backup user password same as admin user password..

Syntax

db-authentication sync-password database mongo

Command Mode

OPERATIONAL

VNFs

DRA and Binding

Command Usage

This command is used to sync password in all the MongoDB.

Examples

The following is an example to synchronize the passwords:

admin@orchestrator[binding-master]# db-authentication sync-password database mongo
result
SUCCESS : Mongo password sync successful

Used to configure the transition authentication parameter. Rolling restart should be executed after this command.

Syntax

db-authentication enable-transition-auth database mongo

Command Mode

OPERATIONAL

VNFs

Binding

Command Usage

Use this command to configure the transition authentication parameter.

Examples

The following is an example to configure the transition authentication parameter:

admin@orchestrator[binding-master]# db-authentication enable-transition-auth database mongo

Used to remove the transition authentication parameter. Rolling restart should be done after this command.

Syntax

db-authentication disable-transition-auth database mongo

Command Mode

OPERATIONAL

VNFs

Binding

Command Usage

Use this command to remove the transition authentication parameter.

Examples

The following is an example to disable transition authorization in MongoDB:

admin@orchestrator[binding-master]# db-authentication disable-transition-auth database mongo

Used to restart all the database instances where primary members is followed by secondary members.

Syntax

db-authentication rolling-restart database mongo

Command Mode

OPERATIONAL

VNFs

Binding

Command Usage

Use this command to restart all the database instances where primary members will be followed by secondary members.

Examples

The following is an example to restart all the database instances:

admin@orchestrator[binding-master]# db-authentication rolling-restart database mongo

Used to restart multiple database instances in parallel without affecting the availability of DB cluster.

Syntax

db-authentication rolling-restart-parallel database mongo

Command Mode

OPERATIONAL

VNFs

Binding

Command Usage

Use db-authentication rolling-restart-parallel database mongo command to restart multiple database instances in parallel without affecting the availability of DB cluster.

Note

db-authentication rolling-restart-parallel database mongo command is dependent on show database parallel-upgrade-plan. If show database parallel-upgrade-plan does not provide any output, then do not use db-authentication rolling-restart-parallel database mongo. Instead use db-authentication rolling-restart database mongo command. Example: If show database parallel-upgrade-plan displays the following output: admin@orchestrator[an-dbmaster]# show database parallel-upgrade-plan BATCH MODULE HOST ADDRESS ------------------------------------------------------ 1 mongo-node-101 an-dbmaster 192.168.11.40 1 mongo-node-102 an-dbcontrol-0 192.168.11.41 1 mongo-node-103 an-dbcontrol-1 192.168.11.42 2 mongo-node-104 an-pers-db-0 192.168.11.43 3 mongo-node-105 an-pers-db-1 192.168.11.44 then, db-authentication rolling-restart-parallel database mongo combines 101, 102 and 103 in batch 1 and restarts all of them at the same time. After batch 1, node 104 from batch 2 is restarted followed by node 105 (from batch 3). So, all the nodes from same batch are restarted in parallel. However nodes from different batch are restarted in sequential manner. A batch_interval parameter can be added as follows: admin@orchestrator[an-master]# db-authentication rolling-restart-parallel batch_interval 8 database mongo where, batch_interval is an integer and accepts range between 8 to 60. By default, the value is 10. It represents the delay duration in seconds between processing of 2 subsequent batches. After executing this command, batch-wise status can be tracked using db-authentication rolling-restart-parallel-status database mongo command.

Examples

The following is an example to trigger a parallel restart for mongo-nodes.

db-authentication rolling-restart-parallel database mongo

Used to track the status of rolling-restart-parallel command.

Syntax

db-authentication rolling-restart-parallel-status database mongo

Command Mode

OPERATIONAL

VNFs

Binding

Command Usage

Use db-authentication rolling-restart-parallel-status database mongo command to track the status of rolling-restart-parallel command.

Examples

The following example shows which batch is completed out of total batches.

admin@orchestrator[an-dbmaster]# db-authentication rolling-restart-parallel-status database mongo         
result Still in progress...Batch 1 out of total 3 is completed at 2019-12-10T23:16:25.799
admin@orchestrator[an-dbmaster]# db-authentication rolling-restart-parallel-status database mongo
result Still in progress...Batch 2 out of total 3 is completed at 2019-12-10T23:16:37.656
admin@orchestrator[an-dbmaster]# db-authentication rolling-restart-parallel-status database mongo
result Parallel rolling restart completed!! Batch 3 out of total 3 got completed at 2019-12-10T23:16:49.844
admin@orchestrator[an-dbmaster]# db-authentication rolling-restart-parallel-status database mongo
result 
Parallel Rolling Restart: Not Scheduled/Completed/Just triggered
admin@orchestrator[an-dbmaster]#

Used to display the status of rolling restart as in-progress or completed.

Syntax

db-authentication rolling-restart-status database mongo

Command Mode

OPERATIONAL

VNFs

Binding

Command Usage

Use this command to display the status of rolling restart as in-progress or completed.

Examples

The following is an example to display the status of rolling restart:

admin@orchestrator[binding-master]# db-authentication rolling-restart-status database mongo
result
Rolling Restart: In Progress ...

Connects to an underlying admin database.

Syntax

No additional arguments.

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use the db connect admin command to connect to the underlying admin database. Once within this database, the user will have read / write access to the admin database via a mongodb CLI. The capabilities of the mongodb CLI are not described in this document.

Connects to an underlying binding database.

Syntax

db connect binding { ipv4 | ipv6 | imsi-apn | msisdn-apn | slf }

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use the db connect binding command to connect to the underlying binding database. Once within this database, the user will have read / write access to the binding database via the mongodb CLI. The capabilities of the mongodb CLI are not described in this document.

Connects to an underlying admin database.

Syntax

No additional arguments.

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use the db connect session command to connect to the underlying session database. Once within this database, the user will have read / write access to the session database via a mongodb CLI. The capabilities of the mongodb CLI are not described in this document.

Used to collect mongod logs from specified VMs based on the start and end timestamps.

You can also add the maximum storage capacity of logs to be allowed as input. Once the maximum capacity is reached, the log collection stops.

Note	The log collection is limited to 15 days. If you need logs beyond 15, you must login to VM directly to pull the logs.

Syntax

debug collect-db-logs-advanced collect <max-allowed-log-size-in-gb> <start-time> <end-time> [VM-names]

Command Parameters

Command Mode

Operational

VNFs

DRA Binding

Command Usage

Use this command to collect mongod logs from specified binding VNF VMs based on the start and end timestamps.

Output files from this command can be accessed using the following link:

https://<MasterVM>/orchestrator/downloads/debug/consolidated/consolidated-db-logs/

Examples

The following is an example:

debug collect-db-logs-advanced collect 4 2020-07-14T23:30:09 2020-07-15T04:15:20 VM-1 VM-2

Output file: consolidated-db-logs_<StartDate>_<EndDate>.tar.gz

Used to create a single consolidated log file of all MongoDB logs collected from different VMs based on start and end timestamps.

Before executing debug collect-db-logs-advanced scan command, you need to execute collect command which pulls all the logs from different VMs into tar.gz.

Note	This command allows you to input timestamps in maximum of 6 hours time interval. Currently, this command expects tar.gz file to be present in the respective storage location and creates consolidated-log-output in same place.

Syntax

debug collect-db-logs-advanced scan <start-time> <end-time> [VM-names]

Command Parameters

Command Mode

Operational

VNFs

DRA Binding

Command Usage

Use this command to scan the MongoDB logs collected from different binding VMs based on start and end timestamps.

Output files from this command can be accessed using the following link:

https://<MasterVM>/orchestrator/downloads/debug/consolidated/consolidated-db-logs/

Examples

The following is an example:

debug collect-db-logs-advanced scan 2020-07-14T23:30:09 2020-07-15T04:15:20 VM-1 VM-2

Output file: consolidated-logs-output

Gathers all running packet captures.

Syntax

debug packet-capture gather directory directory

Command Parameters

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use the debug packet-capture gather to gather all completed or currently running pcaps. This command is sent to all machines with active tcpdump commands and stops the given commands. After all commands are stopped, the command will gather the resultant pcap files and make them available at https://<master ip>/orchestrator/downloads/debug/<directory>.

Purges all existing pcap files.

Syntax

debug packet-capture purge

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use the debug packet-capture purge after all relevant packet captures have been downloaded from the application. The system does not automatically purge packet captures. You need to manage the amount of space used by the packet captures using this command.

Starts a packet capture on a given IP address and port.

Syntax

debug packet-capture start ip-address ip-address port port timer-seconds timer-seconds

Command Parameters

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use the debug packet-capture start command to start a tcp-dump on the given IP address and port within the CPS cluster. The packet capture will run for the given timer period and then shutdown automatically. The packet captures can be gathered using the debug packet-capture gather command.

Gather logs and debug information to support troubleshooting.

Syntax

debug tech

Command Parameters

None

Command Mode

OPERATIONAL – Not available via NETCONF/RESTCONF

VNFs

All

Command Usage

Use this command to gather logs and debug information to support troubleshooting.

The results of the command are available at https://<master ip>/orchestrator/downloads/debug/tech.

Examples

scheduler# debug tech

Connects to a docker service and launches a bash shell running on the system.

Syntax

docker connect container-id

Command Parameters

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use the docker connect to open a bash shell within a container. This command is primarily used for advanced debugging of the system. Once within a container, you can execute Linux commands and interact with the running container processes.

Used to support executing specific command on specific or all the containers.

Syntax

docker exec <container-name> <command>

Command Parameters

Command Mode

Operational

VNFs

All

Command Usage

Use docker exec <container-name> <command> to take container-name and command as an argument. Container-name can be prefix or full name. If the command is having space then it should be provided between double quotes.

Examples

The following example shows sample commands:

Example 1: Stop the db-monitor process in mongo-monitor containers.

docker exec mongo-mon “supervisorctl stop db-monitor”

Example 2: Get the supervisorctl status from all the containers.

docker exec all “supervisorctl status”

Used to remove mongo-s running containers from VMs.

Note	This command must be executed in Maintenance Window (MW).

Syntax

docker repair <prefix> <VM-1 VM-2 ... VM-n>

Command Parameters

Command Mode

Operational

VNFs

All

Command Usage

Use this command to remove the mongo-s containers from VMs to clear the high usage of tmpfs file system memory. In case if any mongo-s container fails to come up or mongod inside it doesn’t come up with healthy state then the entire repair operation is aborted.

Examples

The following example shows sample commands:

Example 1: Remove mongo-s container from a single VM with user prompt.

docker repair mongo-s control-binding-0
Are you sure to repair this mongo-s102 (y/n)? y
mongo-s102
Checking health status for mongo-s102.
Healthy Check Status for mongo-s102 = true

Example 2: Remove mongo-s container from multiple VMs with user prompt.

docker repair mongo-s control-binding-0 control-binding-1
Are you sure to repair this mongo-s102 (y/n)? y
mongo-s102
Checking health status for mongo-s102.
Healthy Check Status for mongo-s102 = true
Are you sure to repair this mongo-s103 (y/n)? y
mongo-s103
Checking health status for mongo-s103.
Healthy Check Status for mongo-s103 = true

Example3: Remove mongo-s container from multiple VMs without user prompt.

docker repair mongo-s --no-prompt control-binding-0 control-binding-1
mongo-s102
Checking health status for mongo-s102.
Healthy Check Status for mongo-s102 = true
mongo-s103
Checking health status for mongo-s103.
Healthy Check Status for mongo-s103 = true

Example 4: Remove all the mongo-s containers from the module-name with prefix mongo-s with user prompt.

docker repair mongo-s all mongo-node
Are you sure to repair this mongo-s101 (y/n)? y
mongo-s101
Checking health status for mongo-s101.
Healthy Check Status for mongo-s101 = true
Are you sure to repair this mongo-s102 (y/n)? y
mongo-s102
Checking health status for mongo-s102.
Healthy Check Status for mongo-s102 = true
Are you sure to repair this mongo-s103 (y/n)? y
mongo-s103
Checking health status for mongo-s103.
Healthy Check Status for mongo-s103 = true
Are you sure to repair this mongo-s104 (y/n)? y
mongo-s104
Checking health status for mongo-s104.
Healthy Check Status for mongo-s104 = true
Are you sure to repair this mongo-s105 (y/n)? y
mongo-s105
Checking health status for mongo-s105.
Healthy Check Status for mongo-s105 = true
Are you sure to repair this mongo-s106 (y/n)? y
mongo-s106
Checking health status for mongo-s106.
Healthy Check Status for mongo-s106 = true
Are you sure to repair this mongo-s107 (y/n)? y
mongo-s107
Checking health status for mongo-s107.
Healthy Check Status for mongo-s107 = true

Example 5: Remove all the mongo-s containers from the module-name with prefix mongo-s without user prompt.

docker repair mongo-s --no-prompt  all mongo-node
mongo-s101
Checking health status for mongo-s101.
Healthy Check Status for mongo-s101 = true
mongo-s102
Checking health status for mongo-s102.
Healthy Check Status for mongo-s102 = true
mongo-s103
Checking health status for mongo-s103.
Healthy Check Status for mongo-s103 = true
mongo-s104
Checking health status for mongo-s104.
Healthy Check Status for mongo-s104 = true
mongo-s105
Checking health status for mongo-s105.
Healthy Check Status for mongo-s105 = true
mongo-s106
Checking health status for mongo-s106.
Healthy Check Status for mongo-s106 = true
mongo-s107
Checking health status for mongo-s107.
Healthy Check Status for mongo-s107 = true

Restarts a docker service that is currently running.

Syntax

docker restart container-id container-id

Command Parameters

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use the docker restart to restart a running docker service. This command is primarily useful to restore a non-responsive service at the request of Cisco TAC or Cisco Engineering.

Starts Diameter application container.

Syntax

docker start <container-id>

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA

Stops Diameter application container.

Syntax

docker stop <container-id>

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

This command ensures the following tasks are completed before the container is stopped:

• the required DPR messages are sent out to all connected peers

• VIP moves to another director

Used to audit peer connections with the provided service name.

Syntax

dra-distributor balance connection <cluster-name> <service-name> audit

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

This command is used to audit the peer connections.

Example

admin@orchestrator[vpas-A-dra-master-0]# dra-distributor balance connection client Gx-PCRFA audit
=========================================================================
Total Directors                   8
Total Weight                      8
Total Active Connections          184
Connection Per Weight             23.0
=========================================================================

Real-Server                                           Weight  Active  Expected
                                                              Conn    Conn
172.16.XX.YY:3868 (diameter-endpoint-s104)            1       23      23.0
172.16.XX.YY:3868 (diameter-endpoint-s105)            1       23      23.0
172.16.XX.YY:3868 (diameter-endpoint-s106)            1       23      23.0
172.16.XX.YY:3868 (diameter-endpoint-s107)            1       23      23.0
172.16.XX.YY:3868 (diameter-endpoint-s108)            1       23      23.0
172.16.XX.YY:3868 (diameter-endpoint-s109)            1       23      23.0
172.16.XX.YY:3868 (diameter-endpoint-s110)            1       23      23.0
172.16.XX.YY:3868 (diameter-endpoint-s111)            1       23      23.0
=========================================================================

Connections are properly distributed

Used to audit per director's TPS with the provided service name.

Syntax

dra-distributor balance traffic <cluster-name> <service-name> <threshold> <margin> audit

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

This command is used to view per director's traffic to VIPs.

Example

admin@orchestrator[vpas-A-dra-master-0]# dra-distributor balance traffic client Sy-OCSA 100 122 audit
Peer disconnect is sensitive operation, so please re-authentication
Enter The Admin Role User Name [default:admin]:
Enter Password:
=========================================================

Real-Server Active Traffic
Conn
diameter-endpoint-s104(172.16.XX.YY) 1 1224 *
diameter-endpoint-s105(172.16.XX.YY) 1 1211 *
diameter-endpoint-s106(172.16.XX.YY) 1 1196 *
diameter-endpoint-s107(172.16.XX.YY) 1 1193 *
=========================================================================
Total Directors 4
Total Traffic 4824
Traffic Per Director 1206
=========================================================================
Traffic of all directors between 1084 and 1328
Traffic are properly distributed

Used to terminate a configuration session.

Syntax

end

Command Mode

CONFIG

VNFs

All

Command Usage

Use the end command to exit any configuration mode and return directly to operational mode. If you enter this command without committing the changes to the target configuration, you are prompted to do so:

Uncommitted changes found, commit them before exiting(yes/no/cancel)?[cancel]:

• Entering yes saves configuration changes to the running configuration file, exits the configuration session, and returns to the operational mode.

• If errors are found in the running configuration, the configuration session does not end. To view the errors, enter the show configuration (config) command with the failed keyword.

• Entering no exits the configuration session and returns to the operational mode without committing the configuration changes.

• Entering cancel leaves the CLI prompt in the current configuration session without exiting or committing the configuration changes.

Examples

The following is an example:

network dns host reladsdsdydra1.client.3gppnetwork.org local address X:X::X:X
admin@orchestrator[scheduler](config-host-reladsdsdydra1.client.3gppnetwork.org/local)# end
Uncommitted changes found, commit them? [yes/no/CANCEL]

Configures the gid mapping for various group roles.

Syntax

external-aaa pam gid-mapping <gid:int> <group name>

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use external-aaa pam gid-mapping to configure LDAP user gid mapping for various group roles such as, grafana-admin, policy-admin, policy-ro, and so on.

Based on the roles configured for the LDAP user gid, access permissions can be set accordingly.

Example

admin@orchestrator(config)# external-aaa pam gid-mapping 1000 policy-admin
admin@orchestrator(config-gid-mapping-1000/policy-admin)# commit
Commit complete.

You can display the status of configuration by running the following command:

Sample Output:

admin@orchestrator# show running-config external-aaa | tab
GID   GROUP
--------------------
1000  policy-admin

Registers a system license.

Syntax

license feature id encrypted-license encrypted-license

no license feature id

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use the license feature to add and remove licenses from the running system.

Used to load configuration from file or terminal.

Syntax

load { merge | replace | override } { <file> | terminal }

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use the load command to merge/replace/override from file or terminal.

Examples

The configuration file can contain replace: and delete: directives. The following is an example:

system {
parent-mo {
child-mo 1 {
attr 10;
}
child-mo 2 {
attr 5;
}
}
}

If you want to delete child-mo 2, you can create a configuration file containing either:

• replace:

  
  system {
  replace:
  parent-mo {
  child-mo 1 {
  attr 2;
  }
  }
  }

• delete:

system {
parent-mo {
delete:
child-mo 2 {
attr 5;
}
}
}

Sets the various log levels for application logging.

Syntax

logger set logger-name { trace | debug | info | warn | error | off }

Command Parameters

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use the logger set to enable various levels of application logging. The logger names are provided by Cisco per application and are not defined here.

Examples

The following is an example:

logger set com.broadhop debug

Clears a log level defined using the logger set command.

Syntax

logger clear logger-name

Command Parameters

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use the logger clear to reset the logging level for an application logger to the default level. The current set of logger levels can be found using the show logger level command.

Tails the cluster wide application log.

Syntax

monitor log application

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use the monitor log application to tail the consolidated-qns.log running on the cc-monitor docker services. If the cc-monitor docker services are not running, this command will fail.

Examples

The following is an example:

scheduler# monitor log application 
binding-s3.weave.local  2017-03-06 00:07:07,256 [LicenseManagerProxy] INFO  consolidated.sessions - TPS_COUNT:                            SESSION_COUNT:                            LICENSE_COUNT: 100000000
binding-s4.weave.local  2017-03-06 00:07:15,577 [LicenseManagerProxy] INFO  consolidated.sessions - TPS_COUNT:                            SESSION_COUNT:                            LICENSE_COUNT: 100000000
diameter-endpoint-s1.weave.local  2017-03-06 00:07:21,041 [LicenseManagerProxy] INFO  consolidated.sessions - TPS_COUNT:                            SESSION_COUNT: 

Tails a specific docker container using the monitor log container command.

Syntax

monitor log container container-id

Command Parameters

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use the monitor log container command to tail the docker container log. This will provide the output for all non-application messages for the given container.

Examples

The following is an example:

scheduler# monitor log container svn
<<< Started new transaction, based on original revision 94
     * editing path : __tmp_run_stage ... done.

------- Committed revision 94 >>>

<<< Started new transaction, based on original revision 95
     * editing path : __tmp_run_backup ... done.

Tails the cluster wide engine log using the monitor log engine command.

Syntax

monitor log engine

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use the monitor log engine to tail the consolidated-engine.log running on the cc-monitor docker services. If the cc-monitor docker services are not running this command will fail.

Specifies access restrictions for a user group.

Verify the users in the group before applying restrictions. To specify restrictions for any group, ensure that the admin user is not part of that group. By default, admin user is configured in a each group.

Syntax

nacm rule-list <rule-name> group <group-name> cmdrule <cmdrule-name> command <command to restrict> access-operations exec action deny

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

To delete the admin user from the read-only group, use the following command:

scheduler(config)#no nacm groups group crd-read-only user-name admin

For the configuration to take effect, log out of the CLI session and log in again after configuring any nacm rule-list.

Examples

Restrict crd-read-only group from config command:

scheduler(config)#nacm rule-list crdreadgrp group crd-read-only cmdrule denyconfig command config access-operations exec action deny 
scheduler(config-cmdrule-denyconfig)# commit

Restrict crd-read-only and policy-ro group from config command:

scheduler(config)#nacm rule-list readonly-restrict group [ crd-read-only policy-ro ] cmdrule cfg-restrict command config access-operations exec action deny
scheduler(config-cmdrule-cfg-restrict)#commit

Restrict crd-read-only and policy-ro group from docker command:

scheduler(config)#nacm rule-list readonly-restrict group [ crd-read-only policy-ro ] cmdrule docker-restrict command docker access-operations exec action deny
scheduler(config-cmdrule-docker-restrict)# commit

Restrict crd-read-only and policy-ro group from system stop command:

scheduler(config)#nacm rule-list readonly-restrict group [ crd-read-only policy-ro ] cmdrule sys-stop command "system stop" access-operations exec action deny
scheduler(config-cmdrule-sys-stop)# commit

Restrict crd-read-only and policy-ro group from system start command:

scheduler(config)#nacm rule-list readonly-restrict group [ crd-read-only policy-ro ] cmdrule sys-start command "system start" access-operations exec action deny
scheduler(config-cmdrule-sys-start)# commit

Restrict load override command for all the users including admin:

scheduler(config)#nacm rule-list readonly-restrict group [ * ] cmdrule load-override command "load override" access-operations exec action deny
scheduler(config-cmdrule-load-override)# commit

Adds a network DNS server for the cluster to use.

Syntax

network dns server address 

no network dns server address

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

The network DNS server command triggers the addition of a DNS server to the DNS resolution that the application utilizes. These servers are added in the order they appear in the configuration to the DNS resolution.

Examples

The following example adds a DNS server:

scheduler(config)# network dns server 10.10.10.10

Adds a network host to IP address mapping for the cluster to use.

Syntax

network dns host host domain address address 

no network dns host host domain

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

The network DNS host command triggers the addition of a host / domain mapping to a specific IP address. This is useful when the upstream DNS services do not have a host / domain name mapping or upstream DNS server is not available to the cluster.

Examples

The following example adds a DNS server:

scheduler(config)# network dns host test local address 10.10.10.10

Used to configure virtual floating IP address on various interfaces.

Syntax

network virtual-service name of floating ip floating-ip floating ip address mask net mask digits broadcast broadcast address interface interface-id virtual-router-id virtual router id tracking-service prefix of service to monitor for IP address diameter-endpoint host ip address of host to put the floating ip priority priority of host

exit

host ip address of host to put the floating ip priority priority of host

commit

end

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use the network virtual-service command to configure virtual floating IP address on various interfaces that is managed using keepalive and the VRRP protocol. This command should be used in conjunction with the network virtual-service host command to assign floating IPs to given hosts.

Note	To use within OpenStack, you must enable Protocol 112 on the security group – this is the VRRP protocol used by Keepalive. VRRP is configured as protocol number and not name. Hence, while configuring from dashboard, select protocol as 'Other' and in the text box below, enter 112 as protocol.

Examples

The following example creates a floating IP on two hosts:

Note	Enter the command manually.

IPv4 VIP config:

scheduler(config)# network virtual-service GxVip12 floating-ip 172.22.33.51 mask 24 broadcast 172.22.33.255 interface ens161 virtual-router-id 1 tracking-service diameter-endpoint host 172.22.33.43 priority 2
exit
host 172.22.33.44 priority 1
commit
end

IPv6 VIP config:

scheduler(config)# network virtual-service RxVip12 floating-ip 2003:2235::51 mask 64 interface ens192 virtual-router-id 2 tracking-service diameter-endpoint host 2003:2235::44 priority 2
exit
host 2003:2235::43 priority 1
commit
end

You can check the status of configuration on the scheduler by running the following command:

show running-config network

Sample Output:

network virtual-service GxVip12
 virtual-router-id 1
 floating-ip       172.22.33.51
 mask              24
 broadcast         172.22.33.255
 host 172.22.33.43
  priority 2
 !
 host 172.22.33.44
  priority 1
 !
!

Requirement

As a part of OpenStack configuration to have allowed-address-pairs configured on the VMs that are going to host the VIP.

Here is an example for ESC:

Under vm_group > interfaces > interface, you need to add the following configuration:

<allowed_address_pairs>
  <address>
    <ip_address>10.81.70.44</ip_address>
    <netmask>255.255.255.0</netmask>
  </address>
</allowed_address_pairs>

Note	The above mentioned configuration needs to be done on all the interfaces of all the VMs where you want a virtual IP.

Adds a new virtual-service floating IP address to the system.

Syntax

network virtual-service name host address priority priority 

no network virtual-service name host address

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use this command to add new hosts to a virtual service. The hosts added will be start a Keepalive process to manage the floating IP via the VRRP process.

Examples

The following example adds a floating IP on a host:

scheduler(config)# network virtual-service test host 10.84.100.136 priority 100

Creates an NTP server for the system to synchronize system clocks.

Syntax

ntp server name address address

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Examples

The following is an example:

scheduler(config)# ntp server server1 address 10.10.10.10

Used to copy running configuration into current configuration.

Syntax

revert

Command Mode

CONFIG

VNFs

All

Command Usage

Use the revert command to copy running configuration into the current configuration.

Examples

The following is an example:

admin@orchestrator[an-master](config)#revert

Used to rollback the running configuration to a previous configuration.

Syntax

rollback configuration <commit-id>

Command Mode

CONFIG

VNFs

All

Command Usage

• Each time the commit command is entered, a commit ID is assigned to the new configuration. You can revert the system to the configuration of a previous commit ID with the rollback configuration command.

• The system stores a limited number of old configurations. The number of old configurations to store is configured in the confd.conf file. If more configurations are stored than the configured number, then the oldest configuration is removed before creating a new one.

• The most recently committed configuration (the running configuration) is number 0, the next most recent 1, and so on.

• The files are called rollback0 - rollbackX, where X is the maximum number of saved committed configurations.

• Use show configuration commit list to display a list of the commit IDs available for rollback operations.

  
  show configuration commit list
  2018-10-15 09:58:21
  SNo. ID       User       Client      Time Stamp          Label       Comment
  ~~~~ ~~       ~~~~       ~~~~~~      ~~~~~~~~~~          ~~~~~       ~~~~~~~
  0    10012    admin      cli         2018-10-15 09:57:59
  

Examples

The following is an example:

rollback configuration 0

Creates a docker service that is external to the installed application.

Syntax

scheduling external-service name image image cap-add cap-add environment environment host-network { true | false } port-mapping port-mapping run-level run-level scalable { true | false } scheduling-slot scheduling-slot volume volume

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

The scheduling external-service instructs the scheduling application to run the defined docker image on the given scheduling slots based on the configuration defined. Once scheduled the external-service appears in the show scheduling status and the show docker service commands.

Calculates a vm-target for an external scaling system.

Syntax

scheduling vm-target name group-size group-size k k max max min min override override query query scale-up-threshold scale-up-threshold

no scheduling vm-target name

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

The scheduling vm-target instructs the system to calculate VM scaling targets which can be used by the system to add and remove scaling VMs as required. The following algorithm is used to calculate the VM target for a given “name”:

vm-target(name) = roundup ((query value) / (scale-up-threshold))*group-size+K

Displays the status of all alerts in the system. It displays either all alert statuses or alerts for a specific named alert.

Syntax

show alert status rule-name

Command Parameters

Command Mode

OPERATIONAL

VNFs

All

Examples

The following is an example:

scheduler# show scheduling status
                            OUT
                RUN	        OF
MODULE	INSTANCE LEVEL STATE	DATE
-------------------------------------------------------
consul	1	       50	  RUNNING false
admin-db	1	     75	RUNNING false
memcached-vip	1	100	RUNNING false
prometheus	1	   100	RUNNING false
prometheus	2	   100	RUNNING false
prometheus	3	   100	RUNNING false

Used to display information about the current configuration session changes.

Syntax

show configuration

Command Mode

CONFIG

VNFs

All

Command Usage

• To display the configuration changes compared to the running configuration if any.

• Possible to display the configuration changes based on configuration component.

Examples

The following is an example:

admin@orchestrator[an-master](config)# aaa authentication users user test1 password **** gid 100 homedir / ssh_keydir / uid 9340
admin@orchestrator[an-master](config-user-test1)#
admin@orchestrator[an-master](config)# show configuration
aaa authentication users user test1
 uid        9340
 gid        100
 password   $1$AWYdJW5S$g2wXilsJSumbCXPYgGzQW0
 ssh_keydir /
 homedir    /
!

Used to display the changes made to the running configuration by previous configuration commits, a configuration commit, or for a range of configuration commits.

Use the show configuration commit changes command to display the information about the current configuration session changes.

Syntax

show configuration commit changes

show configuration commit list

Command Mode

CONFIG

VNFs

All

Command Usage

• Each time a configuration is committed with the commit command, the configuration commit operation is assigned a commit ID. The show configuration commit changes command displays the configuration changes made since the specified commit.

• To display a list of the available commit IDs, enter the show configuration commit list command.

Examples

The following is an example:

show configuration commit changes
!
! Created by: admin
! Date: 2018-10-15 09:57:59
! Client: cli
!
aaa authentication users user anil
 uid        9340
 gid        100
 password   $1$7aB1WW0D$3ln7YEGkLeTjWHoK2cVOE/
 ssh_keydir /
 homedir    /
!

show configuration commit list
2018-10-15 11:20:39
SNo. ID       User       Client      Time Stamp          Label       Comment
~~~~ ~~       ~~~~       ~~~~~~      ~~~~~~~~~~          ~~~~~       ~~~~~~~
0    10012    admin      cli         2018-10-15 09:57:59

Used to display changes that are made by the rollback configuration command. To display the list of rollback commit IDs, use the show configuration rollback changes command.

Syntax

show configuration rollback changes

Command Mode

ALL

VNFs

All

Command Usage

Use show configuration rollback changes command to display changes that are made by the rollback configuration command.

Note	The most recent commits are retained by the system. As new commit IDs are added, the oldest commit IDs are discarded and are no longer available for rollback operations.

Examples

The following is an example:

show configuration rollback changes 0
no aaa authentication users user test1

Used to display the configured control plane remote peer policy.

Syntax

show control-plane remote-peer-policy

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

This command is used to display the current configured control plane remote peer policy in DRA.

Example

admin@orchestrator[vpas-A-dra-master-0]# show control-plane remote-peer-policy
Mated System: system-02
Accept remote peers for diameter applications : All
All Systems:
Accept remote peers for diameter applications :  Rx

show database status displays the currently configured database clusters members.

show database parallel-upgrade-plan is used to print the parallel upgrade plan appropriate for database shard layout across nodes. If parallel upgrade option is selected, all the nodes in a batch are upgraded in parallel.

show database parallel-upgrade-plan-details is used to print the parallel upgrade plan with details of shards and servers selected in each batch. Orchestrator ensures that the members of the same shard are scheduled in different batches to minimize the impact on the shards during parallel upgrade. You can use this command to review the plan and assess the impact of performing a parallel upgrade of DB cluster.

Syntax

show database status

show database parallel-upgrade-plan

show database parallel-upgrade-plan-details

Command Mode

OPERATIONAL

VNFs

All

Examples

The following is an example:

scheduler# show database status 
                                                     CLUSTER                            
ADDRESS       PORT   NAME    STATUS     TYPE         NAME  SHARD   REPLICA SET     
------------------------------------------------------------------------------------------
192.168.65.2  27018  shardA  PRIMARY    replica_set   test  shardA  rs-shardA       
192.168.65.2  27019  -       PRIMARY    config_server test  cfg     test-configsrv  
192.168.65.2  27017  -       CONNECTED  mongos        test  router-1 test-configsrv

To print the parallel upgrade plan appropriate for database shard layout across nodes.

admin@orchestrator[master-6]# show database parallel-upgrade-plan
BATCH  MODULE          HOST              ADDRESS
------------------------------------------------------------------------------
1      mongo-node-101  master-6          172.20.27.36
1      mongo-node-102  control-7         172.20.27.40
1      mongo-node-103  control-8         172.20.27.39
1      mongo-node-104  persistence-db-3  2003:3030:27c1:913:250:56ff:fea6:53
2      mongo-node-105  persistence-db-4  2003:3030:27c1:913:250:56ff:fea6:54

To print the parallel upgrade plan with details of shards and servers selected in each batch.

admin@orchestrator[master-6]# show database parallel-upgrade-plan-details
BATCH  MODULE          HOST              ADDRESS                              PORT   CLUSTER NAME     SHARD    SERVER           STATUS
-------------------------------------------------------------------------------------------------------------------------------------------
1      mongo-node-101  master-6          172.20.27.36                         27019  imsi-msisdn      shdb-3   imsi-msisdn      SECONDARY
1      mongo-node-102  control-7         172.20.27.40                         27019  session-ipv6-AB  shdb-3   session-ipv6-AB  SECONDARY
1      mongo-node-103  control-8         172.20.27.39                         27019  imsi-msisdn      shdb-2   imsi-msisdn      SECONDARY
1      mongo-node-104  persistence-db-3  2003:3030:27c1:913:250:56ff:fea6:53  27017  imsi-msisdn      shard-1  server-c         SECONDARY
1      mongo-node-104  persistence-db-3  2003:3030:27c1:913:250:56ff:fea6:53  27018  imsi-msisdn      shard-2  server-c         SECONDARY
1      mongo-node-104  persistence-db-3  2003:3030:27c1:913:250:56ff:fea6:53  27021  imsi-msisdn      shard-3  server-c         PRIMARY
1      mongo-node-104  persistence-db-3  2003:3030:27c1:913:250:56ff:fea6:53  27020  imsi-msisdn      shard-4  server-c         SECONDARY
1      mongo-node-104  persistence-db-3  2003:3030:27c1:913:250:56ff:fea6:53  27022  session-ipv6-AB  shard-5  server-c         SECONDARY
1      mongo-node-104  persistence-db-3  2003:3030:27c1:913:250:56ff:fea6:53  27023  session-ipv6-AB  shard-6  server-c         SECONDARY
1      mongo-node-104  persistence-db-3  2003:3030:27c1:913:250:56ff:fea6:53  27024  session-ipv6-AB  shard-7  server-c         PRIMARY
1      mongo-node-104  persistence-db-3  2003:3030:27c1:913:250:56ff:fea6:53  27025  session-ipv6-AB  shard-8  server-c         SECONDARY
2      mongo-node-105  persistence-db-4  2003:3030:27c1:913:250:56ff:fea6:54  27017  imsi-msisdn      shard-1  server-d         SECONDARY
2      mongo-node-105  persistence-db-4  2003:3030:27c1:913:250:56ff:fea6:54  27018  imsi-msisdn      shard-2  server-d         SECONDARY
2      mongo-node-105  persistence-db-4  2003:3030:27c1:913:250:56ff:fea6:54  27021  imsi-msisdn      shard-3  server-d         SECONDARY
2      mongo-node-105  persistence-db-4  2003:3030:27c1:913:250:56ff:fea6:54  27020  imsi-msisdn      shard-4  server-d         PRIMARY
2      mongo-node-105  persistence-db-4  2003:3030:27c1:913:250:56ff:fea6:54  27022  session-ipv6-AB  shard-5  server-d         SECONDARY
2      mongo-node-105  persistence-db-4  2003:3030:27c1:913:250:56ff:fea6:54  27023  session-ipv6-AB  shard-6  server-d         SECONDARY
2      mongo-node-105  persistence-db-4  2003:3030:27c1:913:250:56ff:fea6:54  27024  session-ipv6-AB  shard-7  server-d         SECONDARY
2      mongo-node-105  persistence-db-4  2003:3030:27c1:913:250:56ff:fea6:54  27025  session-ipv6-AB  shard-8  server-d         PRIMARY

Displays the status of the clusters docker engines.

Syntax

show docker engine

Command Mode

OPERATIONAL

VNFs

All

Examples

The following is an example:

scheduler# show docker engine 
                                   MISSED  
ID                      STATUS     PINGS   
-------------------------------------------
binding-73d3dc          CONNECTED  0       
binding-8a8d17          CONNECTED  0       
binding-c74547          CONNECTED  0       
binding-dabba5          CONNECTED  0       
control-0               CONNECTED  0       
control-1               CONNECTED  0       
control-2               CONNECTED  0       
diameter-endpoint-0     CONNECTED  0       
diameter-endpoint-1     CONNECTED  0       
diameter-endpoint-2     CONNECTED  0       
diameter-endpoint-3     CONNECTED  0       
master-0                CONNECTED  0       
session-shard-1-e079cf  CONNECTED  0       
session-shard-2-80941f  CONNECTED  0 

Displays the currently running docker services.

Syntax

show docker service

Command Mode

OPERATIONAL

VNFs

All

Examples

The following is an example:

scheduler# show docker service 
MODULE   INSTANCE  NAME           VERSION              ENGINE         CONTAINER ID       STATE   MESSAGE PENALTY BOX 
----------------------------------------------------------------------------------------------------------------------
admin-db    1     mongo-admin-a      3.4.0.0          control-0       mongo-admin-a     HEALTHY  false     -        
admin-db    1     mongo-admin-arb    3.4.0.0          master-0        mongo-admin-arb   HEALTHY  false     -        
admin-db    1     mongo-admin-b      3.4.0.0          control-1       mongo-admin-b     HEALTHY  false     -        
admin-db    1     mongo-admin-setup  12.9.9-2017      master-0        mongo-admin-setup HEALTHY  false     -        
                                 -03-03.123.797af71
binding     1     binding            12.9.9-dra.2017  binding-73d3dc  binding-s1        HEALTHY  false     -     
                                 -03-03.115.0f485ef   
binding     1     session-router     3.4.0.0          binding-73d3dc  session-router-s1 HEALTHY  false     -        
binding     2     binding            12.9.9-dra.2017  binding-8a8d17  binding-s2        HEALTHY  false
                                 -03-03.115.0f485ef    

Displays the output of ipvsadm (Virtual Server administration) from all distributor VMs.

Syntax

show dra-distributor [ daemon | list | rate | stats ]

Command Parameters

Command Mode

OPERATIONAL

VNFs

All

Examples

The following are examples:

show dra-distributor list
======================================================================================
			 dra-distributor stats for  vpas-A-dra-distributor-client-a
Prot LocalAddress:Port Scheduler Flags
  -> RemoteAddress:Port           Forward Weight ActiveConn InActConn
TCP  172.16.241.10:3868 wlc
  -> 172.16.241.3:3868            Route   1      6          0
  -> 172.16.241.4:3868            Route   1      7          0
  -> 172.16.241.5:3868            Route   1      6          0
  -> 172.16.241.6:3868            Route   1      6          0
TCP  172.16.241.74:3868 wlc
  -> 172.16.241.67:3868           Route   1      1          0
  -> 172.16.241.68:3868           Route   1      1          0
  -> 172.16.241.69:3868           Route   1      1          0
  -> 172.16.241.70:3868           Route   1      1          0
TCP  [2606:ae00:3001:8311:172:16:241:109]:3868 wlc
  -> [2606:ae00:3001:8311:172:16:241:102]:3868 Route   1      5          0
  -> [2606:ae00:3001:8311:172:16:241:103]:3868 Route   1      5          0
  -> [2606:ae00:3001:8311:172:16:241:104]:3868 Route   1      5          0
  -> [2606:ae00:3001:8311:172:16:241:105]:3868 Route   1      9          0
======================================================================================
			 dra-distributor stats for  vpas-A-dra-distributor-client-b
Prot LocalAddress:Port Scheduler Flags
  -> RemoteAddress:Port           Forward Weight ActiveConn InActConn
TCP  172.16.241.10:3868 wlc
  -> 172.16.241.3:3868            Route   1      6          0
  -> 172.16.241.4:3868            Route   1      7          0
  -> 172.16.241.5:3868            Route   1      6          0
  -> 172.16.241.6:3868            Route   1      6          0
TCP  172.16.241.74:3868 wlc
  -> 172.16.241.67:3868           Route   1      1          0
  -> 172.16.241.68:3868           Route   1      1          0
  -> 172.16.241.69:3868           Route   1      1          0
  -> 172.16.241.70:3868           Route   1      1          0
TCP  [2606:ae00:3001:8311:172:16:241:109]:3868 wlc
  -> [2606:ae00:3001:8311:172:16:241:102]:3868 Route   1      5          0
  -> [2606:ae00:3001:8311:172:16:241:103]:3868 Route   1      5          0
  -> [2606:ae00:3001:8311:172:16:241:104]:3868 Route   1      5          0
  -> [2606:ae00:3001:8311:172:16:241:105]:3868 Route   1      9          0
======================================================================================
			 dra-distributor stats for  vpas-A-dra-distributor-server-a
Prot LocalAddress:Port Scheduler Flags
  -> RemoteAddress:Port           Forward Weight ActiveConn InActConn
TCP  172.16.242.10:3868 wlc
  -> 172.16.242.3:3868            Route   1      3          0
  -> 172.16.242.4:3868            Route   1      3          0
  -> 172.16.242.5:3868            Route   1      3          0
  -> 172.16.242.6:3868            Route   1      3          0
TCP  172.16.242.138:3868 wlc
  -> 172.16.242.131:3868          Route   1      5          0
  -> 172.16.242.132:3868          Route   1      4          0
  -> 172.16.242.133:3868          Route   1      4          0
  -> 172.16.242.134:3868          Route   1      4          0
======================================================================================
			 dra-distributor stats for  vpas-A-dra-distributor-server-b
Prot LocalAddress:Port Scheduler Flags
  -> RemoteAddress:Port           Forward Weight ActiveConn InActConn
TCP  172.16.242.10:3868 wlc
  -> 172.16.242.3:3868            Route   1      3          0
  -> 172.16.242.4:3868            Route   1      3          0
  -> 172.16.242.5:3868            Route   1      3          0
  -> 172.16.242.6:3868            Route   1      3          0
TCP  172.16.242.138:3868 wlc
  -> 172.16.242.131:3868          Route   1      5          0
  -> 172.16.242.132:3868          Route   1      4          0
  -> 172.16.242.133:3868          Route   1      4          0
  -> 172.16.242.134:3868          Route   1      4          0

show dra-distributor daemon
======================================================================================
			 dra-distributor stats for  vpas-A-dra-distributor-client-a
backup sync daemon (mcast=ens160, syncid=201)
======================================================================================
			 dra-distributor stats for  vpas-A-dra-distributor-client-b
backup sync daemon (mcast=ens160, syncid=201)
======================================================================================
			 dra-distributor stats for  vpas-A-dra-distributor-server-a
backup sync daemon (mcast=ens160, syncid=202)
======================================================================================
			 dra-distributor stats for  vpas-A-dra-distributor-server-b
backup sync daemon (mcast=ens160, syncid=202)

show dra-distributor rate
======================================================================================
			 dra-distributor stats for  vpas-A-dra-distributor-client-a
Prot LocalAddress:Port                 CPS    InPPS   OutPPS    InBPS   OutBPS
  -> RemoteAddress:Port
TCP  172.16.241.10:3868                  0    35080        0 17784626        0
  -> 172.16.241.3:3868                   0     7753        0  3856300        0
  -> 172.16.241.4:3868                   0     9521        0  4867718        0
  -> 172.16.241.5:3868                   0     7249        0  3607296        0
  -> 172.16.241.6:3868                   0    10557        0  5453342        0
TCP  172.16.241.74:3868                  0     2896        0  1269265        0
  -> 172.16.241.67:3868                  0      740        0   317735        0
  -> 172.16.241.68:3868                  0      824        0   321847        0
  -> 172.16.241.69:3868                  0      550        0   309638        0
  -> 172.16.241.70:3868                  0      782        0   320007        0
TCP  [2606:ae00:3001:8311:172:16:241:109]:3868        0    18551        0 17887169        0
  -> [2606:ae00:3001:8311:172:16:241:102]:3868        0     3714        0  3581895        0
  -> [2606:ae00:3001:8311:172:16:241:103]:3868        0     4037        0  3878454        0
  -> [2606:ae00:3001:8311:172:16:241:104]:3868        0     4012        0  3877344        0
  -> [2606:ae00:3001:8311:172:16:241:105]:3868        0     6789        0  6549476        0
======================================================================================
			 dra-distributor stats for  vpas-A-dra-distributor-client-b
Prot LocalAddress:Port                 CPS    InPPS   OutPPS    InBPS   OutBPS
  -> RemoteAddress:Port
TCP  172.16.241.10:3868                  0        0        0        0        0
  -> 172.16.241.3:3868                   0        0        0        0        0
  -> 172.16.241.4:3868                   0        0        0        0        0
  -> 172.16.241.5:3868                   0        0        0        0        0
  -> 172.16.241.6:3868                   0        0        0        0        0
TCP  172.16.241.74:3868                  0        0        0        0        0
  -> 172.16.241.67:3868                  0        0        0        0        0
  -> 172.16.241.68:3868                  0        0        0        0        0
  -> 172.16.241.69:3868                  0        0        0        0        0
  -> 172.16.241.70:3868                  0        0        0        0        0
TCP  [2606:ae00:3001:8311:172:16:241:109]:3868        0        0        0        0        0
  -> [2606:ae00:3001:8311:172:16:241:102]:3868        0        0        0        0        0
  -> [2606:ae00:3001:8311:172:16:241:103]:3868        0        0        0        0        0
  -> [2606:ae00:3001:8311:172:16:241:104]:3868        0        0        0        0        0
  -> [2606:ae00:3001:8311:172:16:241:105]:3868        0        0        0        0        0
======================================================================================
			 dra-distributor stats for  vpas-A-dra-distributor-server-a
Prot LocalAddress:Port                 CPS    InPPS   OutPPS    InBPS   OutBPS
  -> RemoteAddress:Port
TCP  172.16.242.10:3868                  0    29969        0 19567201        0
  -> 172.16.242.3:3868                   0     7363        0  4884850        0
  -> 172.16.242.4:3868                   0     7435        0  4885241        0
  -> 172.16.242.5:3868                   0     7636        0  4911014        0
  -> 172.16.242.6:3868                   0     7534        0  4886099        0
TCP  172.16.242.138:3868                 0    24373        0  8103149        0
  -> 172.16.242.131:3868                 0     5940        0  1677292        0
  -> 172.16.242.132:3868                 0     8316        0  3543717        0
  -> 172.16.242.133:3868                 0     4823        0  1429692        0
  -> 172.16.242.134:3868                 0     5293        0  1452448        0
======================================================================================
			 dra-distributor stats for  vpas-A-dra-distributor-server-b
Prot LocalAddress:Port                 CPS    InPPS   OutPPS    InBPS   OutBPS
  -> RemoteAddress:Port
TCP  172.16.242.10:3868                  0        0        0        0        0
  -> 172.16.242.3:3868                   0        0        0        0        0
  -> 172.16.242.4:3868                   0        0        0        0        0
  -> 172.16.242.5:3868                   0        0        0        0        0
  -> 172.16.242.6:3868                   0        0        0        0        0
TCP  172.16.242.138:3868                 0        0        0        0        0
  -> 172.16.242.131:3868                 0        0        0        0        0
  -> 172.16.242.132:3868                 0        0        0        0        0
  -> 172.16.242.133:3868                 0        0        0        0        0
  -> 172.16.242.134:3868                 0        0        0        0        0

show dra-distributor stats
======================================================================================
			 dra-distributor stats for  vpas-A-dra-distributor-client-a
Prot LocalAddress:Port               Conns   InPkts  OutPkts  InBytes OutBytes
  -> RemoteAddress:Port
TCP  172.16.241.10:3868                  5  130888K        0   67428M        0
  -> 172.16.241.3:3868                   1 28763786        0   14532M        0
  -> 172.16.241.4:3868                   2 34872671        0   17887M        0
  -> 172.16.241.5:3868                   1 26758954        0   13554M        0
  -> 172.16.241.6:3868                   1 37715757        0   19818M        0
TCP  172.16.241.74:3868                  1  9892533        0    4791M        0
  -> 172.16.241.67:3868                  0  2535586        0    1206M        0
  -> 172.16.241.68:3868                  0  2627786        0    1208M        0
  -> 172.16.241.69:3868                  1  1940733        0    1058M        0
  -> 172.16.241.70:3868                  0  2578653        0    1208M        0
TCP  [2606:ae00:3001:8311:172:16:241:109]:3868        5 70270305        0   68098M        0
  -> [2606:ae00:3001:8311:172:16:241:102]:3868        0 14039247        0   13718M        0
  -> [2606:ae00:3001:8311:172:16:241:103]:3868        0 15233935        0   14707M        0
  -> [2606:ae00:3001:8311:172:16:241:104]:3868        0 15271681        0   14903M        0
  -> [2606:ae00:3001:8311:172:16:241:105]:3868        5 24425635        0   23490M        0
======================================================================================
			 dra-distributor stats for  vpas-A-dra-distributor-client-b
Prot LocalAddress:Port               Conns   InPkts  OutPkts  InBytes OutBytes
  -> RemoteAddress:Port
TCP  172.16.241.10:3868                 25    3046M        0    1577G        0
  -> 172.16.241.3:3868                   5  575759K        0     295G        0
  -> 172.16.241.4:3868                   5  568825K        0     288G        0
  -> 172.16.241.5:3868                   5  564563K        0     282G        0
  -> 172.16.241.6:3868                   5  534960K        0     273G        0
TCP  172.16.241.74:3868                  4  172396K        0   83111M        0
  -> 172.16.241.67:3868                  1 41803986        0   20709M        0
  -> 172.16.241.68:3868                  1 45090996        0   20883M        0
  -> 172.16.241.69:3868                  0       11        0    10472        0
  -> 172.16.241.70:3868                  1 41847316        0   20711M        0
TCP  [2606:ae00:3001:8311:172:16:241:109]:3868       24    1635M        0    1581G        0
  -> [2606:ae00:3001:8311:172:16:241:102]:3868        5  306946K        0     298G        0
  -> [2606:ae00:3001:8311:172:16:241:103]:3868        5  357153K        0     342G        0
  -> [2606:ae00:3001:8311:172:16:241:104]:3868        5  339724K        0     332G        0
  -> [2606:ae00:3001:8311:172:16:241:105]:3868        4  300748K        0     290G        0
======================================================================================
			 dra-distributor stats for  vpas-A-dra-distributor-server-a
Prot LocalAddress:Port               Conns   InPkts  OutPkts  InBytes OutBytes
  -> RemoteAddress:Port
TCP  172.16.242.10:3868                 38  401155K        0    3050G        0
  -> 172.16.242.3:3868                   7  782570K        0     508G        0
  -> 172.16.242.4:3868                   7  789557K        0     513G        0
  -> 172.16.242.5:3868                   7  979702K        0     623G        0
  -> 172.16.242.6:3868                   8    1166M        0     759G        0
TCP  172.16.242.138:3868                55    3724M        0    1230G        0
  -> 172.16.242.131:3868                11  579165K        0     159G        0
  -> 172.16.242.132:3868                12    1079M        0     418G        0
  -> 172.16.242.133:3868                11  843389K        0     306G        0
  -> 172.16.242.134:3868                10  557000K        0     156G        0
======================================================================================
			 dra-distributor stats for  vpas-A-dra-distributor-server-b
Prot LocalAddress:Port               Conns   InPkts  OutPkts  InBytes OutBytes
  -> RemoteAddress:Port
TCP  172.16.242.10:3868                  0        0        0        0        0
  -> 172.16.242.3:3868                   0      785        0  1149048        0
  -> 172.16.242.4:3868                   0      817        0    43388        0
  -> 172.16.242.5:3868                   0     1178        0  2029844        0
  -> 172.16.242.6:3868                   0     2069        0  2386744        0
TCP  172.16.242.138:3868                 0    10926        0  3854392        0
  -> 172.16.242.131:3868                 0     2648        0   994176        0
  -> 172.16.242.132:3868                 0     1358        0   537100        0
  -> 172.16.242.133:3868                 0     2271        0   995296        0
  -> 172.16.242.134:3868                 0     1440        0   618544        0

Syntax

show history

Command Mode

OPERATIONAL

VNFs

All

Examples

The following is an example:

scheduler# show history 
03-04 16:56:03 -- show docker service | include diameter
03-04 16:56:22 -- show docker service | include diameter | include diameter-endpoint-0
03-04 16:57:31 -- docker connect docker-host-info-s8
03-04 16:59:19 -- docker connect socket-forwarder-s1
03-04 17:01:02 -- ifconfig
03-04 17:01:22 -- docker connect socket-forwarder-s1
03-04 17:01:54 -- docker connect diameter-endpoint-s2
03-04 17:03:32 -- docker connect diameter-endpoint-s2
03-04 17:05:25 -- docker connect diameter-endpoint-s1

Displays the current license details installed on the system.

Syntax

show license details

Command Mode

OPERATIONAL

VNFs

All

Examples

The following is an example:

scheduler# show license details 
ID       DEFAULT  COUNT      EXPIRATION                 
--------------------------------------------------------
SP_CORE  true     100000000  2017-06-02T02:04:07+00:00 

Displays the application log in a viewer that enables you to scroll and search.

Syntax

show log application

Command Mode

OPERATIONAL

VNFs

DRA

Displays the engine log in a viewer that enables you to scroll and search.

Syntax

show log engine

Command Mode

OPERATIONAL

VNFs

DRA

Displays the current logger levels in the system that overrides the default logging.

Syntax

show logger level

Command Mode

OPERATIONAL

VNFs

All

Examples

The following is an example:

scheduler# show logger level 
Logger    Current Level
--------  ---------------
dra       warn

Displays the MongoDB members database status running on orchestrator, orchestrator-backup-a, and orchestrator-backup-b containers.

Syntax

show orchestrator-database-status

Command Parameters

None

Command Mode

Operational

VNFs

All

Examples

The following example also shows a sample output:

admin@orchestrator[an-dbmaster]# show orchestrator-database-status
ADDRESS                  PORT        STATUS
--------------------------------------------------
orchestrator             27017     PRIMARY
orchestrator-backup-a    27017     SECONDARY
orchestrator-backup-b    27017     SECONDARY

Note	In case any member is down or not able to retrieve its status, it is shown as NO_CONNECTION. For all other members, respective mongo status is displayed.

For example, if orchestrator-backup-a mongo member is down.

admin@orchestrator[an-dbmaster]# show orchestrator-database-status
ADDRESS                  PORT        STATUS
--------------------------------------------------
orchestrator             27017     PRIMARY
orchestrator-backup-a    27017     NO_CONNECTION
orchestrator-backup-b    27017     SECONDARY

Lists the patches that are in /data/orchestrator/patches directory.

Syntax

show patches

Command Mode

OPERATIONAL

VNFs

All

Command Usage

The show patches indicates the patch that is loaded in the given patch directory and not a patch that is applied to the system .

Displays the binding DB write connection settings.

Syntax

show running-config binding db-connection-settings

Command Mode

OPERATIONAL

VNFs

All

Examples

The following is an example:

scheduler# show running-config binding db-connection-settings | tab
                           MAX
BINDING  CONNECT  SOCKET   WAIT  CONNECTIONS
TYPE     TIMEOUT  TIMEOUT  TIME  PER HOST
----------------------------------------------
drasession       500      1000     500   10

Displays the binding DB read connection settings.

Syntax

show running-config binding db-read-connection-settings

Command Mode

OPERATIONAL

VNFs

All

Examples

The following is an example:

scheduler# show running-config binding db-connection-settings | tab
                              MAX
            CONNECT  SOCKET   WAIT                ACCEPTABLE
            TIMEOUT  TIMEOUT  TIME   CONNECTIONS  LATENCY
BINDING     FOR      FOR      FOR    PER HOST     DIFFERENCE
TYPE        READ     READ     READ   FOR READ     FOR READ
--------------------------------------------------------------
ipv6        500      1000     500    10           5
imsiapn     500      1000     500    10           5
msisdnapn   500      1000     500    10           5
drasession  500      1000     500    10           5

Displays the binding shard metadata database connection.

Syntax

show running-config binding shard-metadata-db-connection

Command Mode

OPERATIONAL

VNFs

All

Examples

The following is an example:

scheduler# show running-config binding shard-metadata-db-connection | tab
SHARD
METADATA
BINDING
TYPE        HOST           PORT
----------------------------------
ipv6        193.1.163.114  27019
ipv6        193.1.163.115  27019
ipv6        193.1.163.164  27019
ipv4        193.1.163.114  27019
ipv4        193.1.163.115  27019
ipv4        193.1.163.164  27019
imsiapn     193.1.163.116  27019
imsiapn     193.1.163.25   27019
imsiapn     193.1.163.63   27019
imsiapn     193.1.163.65   27019
imsiapn     93.1.163.165   27019
msisdnapn   193.1.163.116  27019
msisdnapn   193.1.163.25   27019
msisdnapn   193.1.163.63   27019
msisdnapn   193.1.163.65   27019
msisdnapn   93.1.163.165   27019
drasession  193.1.163.114  27019
drasession  193.1.163.115  27019
drasession  193.1.163.164  27019

Displays the effective scheduler running in the system.

Valid results are HA and AIO.

Syntax

show scheduling effective-scheduler

Command Mode

OPERATIONAL

VNFs

All

Examples

The following is an example:

scheduler# show scheduling effective-scheduler 
scheduling effective-scheduler HA

Displays the currently loaded modules.

Syntax

show scheduling status

Command Mode

OPERATIONAL

VNFs

All

Examples

The following is an example:

scheduler# show scheduling status 
                                                OUT    
                                RUN             OF     
MODULE                INSTANCE  LEVEL  STATE    DATE   
-------------------------------------------------------
consul                1         50     RUNNING  false  
admin-db              1         75     RUNNING  false  
memcached-vip         1         100    RUNNING  false  
prometheus            1         100    RUNNING  false  
prometheus            2         100    RUNNING  false  
prometheus            3         100    RUNNING  false  

Displays the results of the scheduling vm-target calculation.

Syntax

show scheduling vm-target

Command Mode

OPERATIONAL

VNFs

All

Parameter Description

Shows the current diagnostics.

Syntax

There are no arguments for this command.

Command Mode

OPERATIONAL

VNFs

All

Command Parameters

Examples

scheduler# show system diagnostics | tab
NODE        CHECK ID                  IDX  STATUS   MESSAGE                                                                                                                                                               
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
binding-s1  serfHealth                1    passing  Agent alive and reachable                                                                                                                                             
binding-s1  service:cisco-policy-api  1    passing  TCP connect localhost:8080: Success                                                                                                                                   
binding-s1  service:cisco-policy-app  1    passing  CLEARED: Session creation is allowed                                                                                                                                  
binding-s1  service:cisco-policy-app  2    passing  CLEARED: -Dcom.broadhop.developer.mode is disabled

Shows the history of system events.

Syntax

There are no arguments for this command.

Command Mode

OPERATIONAL

VNFs

All

Command Parameters

Examples

scheduler# show system history 
IDX  EVENT TIME                     MODULE         MESSAGE                                                  
------------------------------------------------------------------------------------------------------------
1    2017-02-04T02:04:02.469+00:00  system         System started                                           
2    2017-02-04T02:04:29.021+00:00  docker-engine  Adding docker engine session-shard-2-80941f              
3    2017-02-04T02:04:29.096+00:00  docker-engine  Adding docker engine diameter-endpoint-3                 
4    2017-02-04T02:04:29.187+00:00  docker-engine  Adding docker engine diameter-endpoint-2                 
5    2017-02-04T02:04:29.303+00:00  docker-engine  Adding docker engine binding-c74547                      
6    2017-02-04T02:04:29.375+00:00  docker-engine  Adding docker engine control-2                           
7    2017-02-04T02:04:29.503+00:00  docker-engine  Adding docker engine session-shard-1-e079cf              
8    2017-02-04T02:04:29.583+00:00  docker-engine  Adding docker engine control-1                           
9    2017-02-04T02:04:29.671+00:00  docker-engine  Adding docker engine control-0                           
10   2017-02-04T02:04:29.751+00:00  docker-engine  Adding docker engine binding-dabba5                      
11   2017-02-04T02:04:29.843+00:00  docker-engine  Adding docker engine binding-73d3dc                      
12   2017-02-04T02:04:29.981+00:00  docker-engine  Adding docker engine binding-8a8d17

Shows if the system secrets are unsealed.

This command returns true if the secrets are unsealed and false if they are still sealed. To open the system secrets, see system secrets unseal.

Syntax

There are no arguments for this command.

Command Mode

OPERATIONAL

VNFs

All

Examples

scheduler# show system secrets open                       
system secrets open true

Shows the current set secrets.

This command does not show the value of the secrets only the path and if the value is readable by the system.

Syntax

There are no arguments for this command.

Command Mode

OPERATIONAL

VNFs

All

Command Parameters

Examples

scheduler# show system secrets paths 
PATH  STATUS  
--------------
test  valid   

Shows the list of available software versions to upgrade or downgrade a system.

Syntax

There are no arguments for this command.

Command Mode

OPERATIONAL

VNFs

All

Examples

scheduler# show system software available-versions 
VERSION                            
-----------------------------------
12.9.9-dra.2017-03-03.115.0f485ef  

Shows the currently configured docker-repository.

Syntax

There are no arguments for this command.

Command Mode

OPERATIONAL

VNFs

All

Examples

scheduler# show system software docker-repository 
system software docker-repository registry:5000
 

Shows the currently installed software version.

Syntax

There are no arguments for this command.

Command Mode

OPERATIONAL

VNFs

All

Examples

scheduler# show system software version 
system software version 12.9.9-dra.2017-03-03.115.0f485ef

Displays the currently staged files in the /data/isos/staged-isos folder.

Syntax

show system software iso stage file

Command Parameters

None

Command Mode

OPERATIONAL

VNFs

All

Examples

The following example also shows a sample output:

scheduler# show system software iso stage file 
NAME                  CREATED                    SIZE MB  MD5 SUM                           
--------------------------------------------------------------------------------------------
cisco-policy-dra.iso  2017-05-17T12:35:58+00:00  1100.04  c636794475b76e84041901b0ca3dcac4  

Where:

• Name: The filename of the iso.

• Created: The date the file was created on the file system.

• Size MB: The size of the file in megabytes.

• MD5 Sum: The MD5 sum of the file.

Displays the currently active ISOs that are loaded on the system.

Syntax

show system software iso details

Command Parameters

None

Command Mode

OPERATIONAL

VNFs

All

Examples

The following example also shows a sample output:

CATEGORY  NAME     VERSION  QUALIFIER    CREATED  ACTIVE  MB      
------------------------------------------------------------------------
product cisco-policy-dra 12.9.9   dra.2017-05-   2017-05  true   1102.9 
                                    17.441.69    -17T13:
                                    68d89        4:15.708
                                                 +00:00 

Where:

• Category: The type of ISO. Either product or extras. Extras can be used to load external docker images for use by external services.

• Name: The product name of the ISO

• Version: The version of the ISO

• Qualifier: The qualifier of the ISO

• Created Date: The creation date of the ISO on the file system

• Active: Indicates if the registry is currently pointing to the ISO to download images.

• Size: The size of the ISO on the file system.

Shows 100% if the minimum set of containers are running for the system to operate.

A system status of 100% does not guarantee the following:

• The system is fully configured through the CLI or Policy Builder.

• All redundant VMs are UP. For example, a worker VM, and a distributor VM.

• Distributor VMs are UP.

To verify a system is healthy and all desired VMs are active, execute the following commands:

• show docker engine

• show system status

• show system diagnostics

• show docker service

• show alerts

Syntax

show system status

Command Parameters

None

Command Mode

OPERATIONAL

VNFs

All

Examples

The following example also shows a sample output:

scheduler# show system status

Shows if the system is currently configured with debug tools.

Syntax

show system status debug

Command Parameters

None

Command Mode

OPERATIONAL

VNFs

All

Examples

The following example also shows a sample output:

scheduler# show system status debug 
system status debug false

Where:

• Debug: Indicates if the system is configured to deploy containers with debug tools

Shows if the system is currently downgrading the installed software.

Syntax

There are no arguments for this command.

Command Mode

OPERATIONAL

VNFs

All

Examples

scheduler# show system status downgrade 
system status downgrade false

Shows if the system is currently running.

Syntax

There are no arguments for this command.

Command Mode

OPERATIONAL

VNFs

All

Examples

scheduler# show system status running
system status running true

Shows if the system is currently upgrading an installed software.

Syntax

There are no arguments for this command.

Command Mode

OPERATIONAL

VNFs

All

Examples

scheduler# show system status upgrade
system status upgrade false

Defines a new bulk statistics file that the system generates on a regular basis.

Syntax

statistics bulk file name header
 header query query format 
format no bulk file name

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use the bulk file command to define a bulk statistics file that supplements the default bulk statistics files created by the system. The format and queries are user defined.

Examples

The following example creates a bulk file on peer message rates:

statistics bulk file peer_tps
 query  "peer_message_total{remote_peer!=\"\"}"
 format ${app_id},${direction},${instance},${local_peer},
${remote_peer},${type},${current-value}
!

Modifies the timer that the system uses to generate the bulk statistics that are defined via the bulk file command.

Syntax

statistics bulk interval interval no bulk interval

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use the bulk interval command to control the timer length in triggering a new bulk statistics file.

Notes:

1. The generation of bulk statistics runs +/- 10 seconds of the interval.

2. The generation of bulk statistics is not synchronized to the minute.

3. The default interval, if not defined, is 300 seconds.

Examples

The following example creates a bulk file every 10 minutes:

scheduler(config)# bulk interval 600

Adds a statistics detail for the system to capture.

Syntax

statistics detail query category name query query format format scale scale

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

The statistics detail command triggers the application to monitor a given statistic and record it in memory and for reporting using the show statistics detail command. The values are refreshed every 10 seconds.

Examples

statistics detail query diameter success-message-tps
 query  "sum(rate(diameter_endpoint_request_total{result_code=\"2001\"}[10s])) by (app_id,message_type)"
 format "${app_id} ${message_type}"
!

Creates a probe that tests whether a host is up using ICMP ping.

Syntax

statistics icmp-ping address no statistics icmp-ping address

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use the statistic icmp-ping command to instruct the monitoring system to ping the given address using the ICMP protocol. The IP address must be reachable via the master, control-a, and control-b hosts.

Examples

The following example creates an ICMP ping test:

scheduler(config)# statistics icmp-ping 10.10.10.10

Adds a statistics summary for the system to capture.

Syntax

statistics summary query category name query query scale scale

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

The statistics summary command triggers the application to monitor a given statistic and record it in memory and for reporting using the show statistics summary command. The values are refreshed every 10 seconds.

The summary command does not support "group by" operations to show multiple lines from a single query.

Examples

statistics summary query diameter tps
 query "sum(rate(diameter_endpoint_request_total{result_code=\"2001\"}[10s]))"
!

Stops a downgrade that is in progress.

Syntax

There are no arguments for this command.

Command Mode

OPERATIONAL

VNFs

All

Command Usage

The system abort-downgrade command stops the current rolling downgrade of the system. This command is only available when the system is in the process of downgrading and is not available after the downgrade is complete. Once this command is issued, system upgrade command should be issued to revert this software to the previous version.

Stops an upgrade that is in progress.

Syntax

There are no arguments for this command.

Command Mode

OPERATIONAL

VNFs

All

Downgrades the system to a older software version.

Syntax

system downgrade version version [consul-downgrade [true/false] [snapshot_name]]

Command Mode

OPERATIONAL

VNFs

All

Command Parameters

consul-downgrade

During upgrade, it takes a snapshot of existing consul data which are yet to be upgraded and saves as <version-name> (to which you are upgrading) and upgrade proceeds normally. Post upgrade all consul servers/agents will be upgraded to newer version.

For example, if you are upgrading from 19.5.0.release to 20.x.0.release, snapshot name is 20.x.0.release.

If the value is set as true, following operations are carried out:

• Check if you have provided snapshot-name. If you have not provided the snapshot name, by default, it takes current version as snapshot. You can also provide the snapshot name. To list all the available snapshots, use consul list-snapshots command.

• If snapshot is present, then consul is restored with the snapshot and further downgrade proceeds normally.

• If snapshot is not present, then downgrade does not get started and an error is displayed.

• If you have provided the snapshot-name, then snapshot (if exists) in /data/orchestrator/config/snapshot/ is verified and consul is restored with the given snapshot and downgrade continues.

• In case of no snapshot, an error is displayed.

Note	Post rollback, consul data is of state before upgrade if consul downgrade is selected during ISO rollback. Hence, if changes are made to the consul config post upgrade, they are lost and you need to reapply the config changes.

Caution

You cannot restore newer version snapshot on an old consul server.

Example:

1. When upgrading to any new version (for example, from v1 to v2), it takes consul snapshot as /data/orchestrator/config/snapshot-consul/v2.

2. During downgrade (for example, from v2 to v1), provide snapshot name in system-downgrade command.

3. When upgrading to v3 from v2 (for example, consul version for v1 is 1.0.0, consul version for v2 is 1.5.3 and consul version for v3 is 1.5.3). Upgrade from v1 to v2, snapshot is store as v2; from v2 to v3, snapshot is stored as v3.

4. If you want to downgrade directly from v3 to v1 and you do not provide the snapshot name, by default, it takes the snapshot of v3 and consul version is 1.5.3. The downgrade fails. You must provide the snapshot name in system-downgrade command as v2.

Command Usage

The system downgrade command installs new software on the system using a rolling downgrade approach to minimize service interruption. Care must be taken to ensure that the system downgrade command is used when moving from a higher software version to a lower version of the software. The rolling downgrade upgrades the software modules in startup order. After the command is issued, the CLI disconnects while the CLI software is restarted. The CLI generally becomes available within 30 seconds. Once the CLI becomes available, the status of the upgrade can be monitored using the show scheduling status command.

Examples

system downgrade version 12.9.9-dra.2017-03-03.115.0f485ef  

Disables debug tools in deployed containers.

Syntax

system disable-debug

Command Parameters

None

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use the system disable-debug command to turn off debugging tools on newly launched containers.

Examples

The following example disables debug tools:

scheduler# system disable-debug

Disables external services that are currently running in the system.

Syntax

system disable-external-services

Command Parameters

None

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use the system disable-external-services to stop all services registered with the scheduling external-service command.

Examples

The following example disables external services:

scheduler# system disable-external-services

Enables debug tools in deployed containers.

Syntax

system enable-debug

Command Parameters

None

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use the system enable-debug command to turn on debugging tools on newly launched containers.

Examples

The following example enables debug tools:

scheduler# system enable-debug

Enable external registered services.

Syntax

system enable-external-services

Command Parameters

None

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use the system enable-external-services command to enable external services that are currently registered with the scheduling external-service command.

Examples

The following example enables external services:

scheduler# system enable-external-services

Adds a secret to the system.

Syntax

system add-secret path path secret secret

Command Mode

OPERATIONAL

VNFs

All

Command Parameters

Command Usage

The system add-secret command adds a secret to the system. This command is available only if the secrets are open. See show system secrets open.

Removes a secret from the system.

Syntax

system remove-secret path path

Command Mode

OPERATIONAL

VNFs

All

Command Parameters

Command Usage

The system remove-secret command removes a secret from the system. This command is available only if the secrets are open. See show system secrets open.

Overwrites the current passcode that is used to encrypt or decrypt the master key for the secrets.

Syntax

system secrets set-passcode passcode

Command Mode

OPERATIONAL

VNFs

All

Command Parameters

Command Usage

The system secrets command is used to change the passcode to unlock the secrets stored within the operational database. All secrets are encrypted using a randomly generated master-key that is encrypted/decrypted by the end-user provided passcode. If the passcode is lost, then the secrets currently stored are not recoverable. This command is available only if the secrets are open. See show system secrets open.

Unseals the secrets if a non-default passcode is used to seal the secrets.

Syntax

system secrets unseal passcode passcode

Command Mode

OPERATIONAL

VNFs

All

Command Parameters

Command Usage

The system secrets unseal command is used to unlock any stored secrets so that they can be shared with services that require a clear text secret or password. An example of this is a database connection password.

Remove all downloaded ISOs from the stage directory.

Syntax

system software iso stage clean

Command Parameters

None

Command Mode

OPERATIONAL

VNFs

All

Command Usage

The system software iso stage clean command removes all files that have been staged in the hosts /data/isos/staged-isos/ directory. This command should be run after an ISO file has been uploaded via the system software iso load command.

Examples

scheduler# system software iso stage clean

Downloads a software ISO to the stage directory on the host.

Syntax

system software iso stage pull URL

Command Parameters

Command Mode

OPERATIONAL - Not available via NETCONF/RESTCONF

VNFs

All

Command Usage

Invocation of the command downloads the given URL to the /data/isos/staged-isos/ directory. After invocation of this command, invocation of the show system software iso stage file command shows details of the downloaded file and the system software iso load command loads the file into the system.

Examples

The following example also shows a sample output:

scheduler# system software iso stage pull 
http://171.70.34.121/microservices/latest/cisco-policy-dra.iso
--2017-05-17 15:08:39--  http://171.70.34.121/microservices
/latest/cisco-policy-dra.iso
Connecting to 171.70.34.121:80... connected.
HTTP request sent, awaiting response... 200 OK
Length: 1153468416 (1.1G) [application/octet-stream]
Saving to: 'cisco-policy-dra.iso'

cisco-policy-dra.iso                              4%[=====>                                                                                                                                                        ]  45.85M  4.07MB/s    eta 4m 27s 

Activate an existing ISO.

Syntax

system software iso activate category [product|extras] name name version version qualifier qualifier 

Command Parameters

Command Mode

OPERATIONAL

VNFs

All

Command Usage

The system software iso activate command triggers the system to restart the local docker registry to point to the given ISO. This command should be run before upgrading or downgrading the software.

Examples

The following example loads and activates a product ISO:

scheduler# system software iso activate category product name cisco-policy-dra version 12.9.9 qualifier dra.2017-05-17.441.6968d89 

Deletes an existing ISO.

Syntax

system software iso delete category [product|extras] name name version version qualifier qualifier 

Command Parameters

Command Mode

OPERATIONAL

VNFs

All

Command Usage

The system software iso delete command triggers the system to remove the ISO. This command can only be run on non-active ISOs.

Examples

The following example deletes an ISO:

scheduler# system software iso delete category product name cisco-policy-dra version 12.9.9 qualifier dra.2017-05-17.441.6968d89

Load a new ISO into the system.

Syntax

system software iso load category [product|extras] file filename activate [true|false] 

Command Parameters

Command Mode

OPERATIONAL

VNFs

All

Command Usage

The system software iso load command triggers unpacking of the staged ISO into a permanent location on the host. This command is executed before a system upgrade command can be executed.

Examples

The following example loads and activates an ISO:

scheduler# system software iso load category product file cisco-policy-dra.iso activate true 

Starts all the services on a system that has been currently stopped.

Syntax

There are no arguments for this command.

Command Mode

OPERATIONAL

VNFs

All

Stops all the services on the system (excluding the CLI, NETCONF, and RESTCONF service).

Syntax

There are no arguments for this command.

Command Mode

OPERATIONAL

VNFs

All

Command Usage

The system stop commands performs a controlled shutdown of the system by stopping all the services in the reverse order of start-up.

Note	For ephemeral databases (such as session), all data is lost on a system stop command.

Upgrades the system to a new software version.

The option database-upgrade-parallel enables parallel upgrade of database nodes. This option is provided to reduce the upgrade time without impacting the availability of DB cluster.

Syntax

system upgrade version <version>

system upgrade version <version> database-upgrade-parallel <true/false>

Command Mode

OPERATIONAL

VNFs

All

Command Parameters