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.

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

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 mongo connection settings.

Syntax

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

Command Parameters

Command Mode

CONFIG

VNFs

DRA

Command Usage

Use the binding db-connection-settings command to configure the 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:
  connect-timeout  connections-per-host  max-wait-time  socket-timeout  <cr>

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]

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

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.

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.

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

Add a new MongoDB router to the named DB cluster.

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 DB 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 

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 Binding

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

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.

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.

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.

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.

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

All

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.

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

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

Display the currently configured database clusters members.

Syntax

show database status

Command Parameters

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

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    

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

All

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

Syntax

show log engine

Command Mode

OPERATIONAL

VNFs

All

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

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 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 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 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

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 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

Usage Guidelines

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

Downgrades the system to a new software version.

Syntax

system downgrade version version

Command Mode

OPERATIONAL

VNFs

All

Command Parameters

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

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

Usage Guidelines

The system start command performs a controlled startup of the system by starting all the services in a rolling fashion taking into account various service dependencies.

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.

Syntax

system upgrade version version

Command Mode

OPERATIONAL

VNFs

All

Command Parameters

Command Usage

The system upgrade command installs new software on the system using a rolling upgrade approach to minimize service interruption. Care must be taken to ensure that upgrade command is used when moving from a lower software version to a higher version of the software. The rolling upgrade upgrades the software modules in reverse start-up order. After the command is issued, the CLI disconnects while the CLI software is restarted. The CLI generally become 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 upgrade version 12.9.9-dra.2017-03-03.115.0f485ef