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

Note	Alert message supports threshold label and the format for threshold label support in alert message is {{$threshold}}.

The show alert status output displays Stale alerts. Stale alerts get created when all prometheus instances are brought down and back up. When prometheus instances come up, they recognise only new alerts and will not recognise existing alerts in firing state. Hence the Update time for the alerts in firing state will not be updated and will end up as Stale Alerts.

Examples

Following example shows alert status with Stale alerts. The update time for these alerts does not have latest timestamp and is different in the other alerts.

alert status
NAME EVENT HOST STATUS MESSAGE
CREATE TIME RESOLVE TIME UPDATE TIME
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
IP_NOT_REACHABLE 192.168.10.10 resolved VM/VIP IP 192.168.10.10 is reachable.
2021-05-26T16:12:23.545+00:00 2021-05-26T16:12:28.543+00:00 2021-05-26T16:13:38.55+00:00
IP_NOT_REACHABLE 192.168.10.13 firing VM/VIP IP 192.168.10.13 is not reachable.
2021-05-27T10:32:08.542+00:00 - 2021-05-27T10:32:13.555+00:00
IP_NOT_REACHABLE 192.168.10.14 firing VM/VIP IP 192.168.10.14 is not reachable.
2021-05-27T10:32:08.546+00:00 - 2021-05-27T10:32:13.556+00:00
IP_NOT_REACHABLE 192.168.10.17 firing VM/VIP IP 192.168.10.17 is not reachable.
2021-05-27T10:32:13.556+00:00 - 2021-05-27T10:32:13.556+00:00
IP_NOT_REACHABLE 192.168.10.23 resolved VM/VIP IP 192.168.10.23 is reachable.
2021-05-26T16:12:23.55+00:00 2021-05-26T16:12:28.539+00:00 2021-05-26T16:13:38.537+00:00
IP_NOT_REACHABLE 192.168.10.25 resolved VM/VIP IP 192.168.10.25 is reachable.
2021-05-26T16:12:23.551+00:00 2021-05-26T16:12:28.54+00:00 2021-05-26T16:13:38.547+00:00

Syntax

alert clear-stale-alerts 

Command Parameters

None

Command Mode

CONFIG

VNFs

All

Command Usage

Use the following alert-clear-stale-alerts CLI command to clear stale alerts.

 
alert ?
Possible completions:
clear-all Clear all alerts
clear-stale-alerts Clear all stale alerts
rule
snmp-v2-destination
snmp-v3-destination
alert clear-stale-alerts
Stale Alerts removed

Examples

Following example shows alert status output after the removal of Stale alerts.

 show alert status
Name EVENT HOST STATUS MESSAGE
CREATE TIME RESOLVE TIME UPDATE TIME
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
IP_NOT_REACHABLE 192.168.10.10 resolved VM/VIP IP 192.168.10.10 is reachable.
2021-05-26T16:12:23.545+00:00 2021-05-26T16:12:28.543+00:00 2021-05-26T16:13:38.55+00:00
IP_NOT_REACHABLE 192.168.10.23 resolved VM/VIP IP 192.168.10.23 is reachable.
2021-05-26T16:12:23.55+00:00 2021-05-26T16:12:28.539+00:00 2021-05-26T16:13:38.537+00:00
IP_NOT_REACHABLE 192.168.10.25 resolved VM/VIP IP 192.168.10.25 is reachable.
2021-05-26T16:12:23.551+00:00 2021-05-26T16:12:28.54+00:00 2021-05-26T16:13:38.547+00:00

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

Used to create or remove API dedicated users using group details.

Syntax

api-user add group-details gid <GID> auth-type local/external write-enable true/false

api-user remove group-details gid <GID> auth-type local/external write-enable true/false

Command Parameters

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use this command to create or remove API dedicated users using group details.

Examples

Example 1: The following is an example to create an user:

api-user add group-details gid 100 auth-type external write-enable false

Exampe 2: The following is an example to remove the user:

api-user remove group-details gid 100 auth-type external write-enable false

Used to create or remove API dedicated user.

Syntax

api-user add user-details name <USER_NAME> auth-type local/external write-enable true/false

api-user remove user-details name <USER_NAME> auth-type local/external write-enable true/false

Command Parameters

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use this command to create or remove an API dedicated user.

Note	Set the write-enable to true to give the read-write API access and set as false to give the read API access.

Examples

Example 1: The following is an example to create an user:

api-user add user-details name test auth-type local write-enable true

Exampe 2: The following is an example to remove the user:

api-user remove user-details name test auth-type local write-enable true

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

Use the CLI command to set the flag (true or false) to enable or disable the aggregate status query for IMSI and MSISDN binding tables.

Syntax

binding imsi-msisdn enable aggregate query True|False

Command Parameters

Command Mode

CONFIG

VNFs

DRA

Command Usage

The CLI command set the flag value as true or false to enable or disable the aggregate status query for IMSI and MSISDN binding tables.

Examples

Following is an example to set the flag value:

admin@orchestrator[vpas-A1-master-0](config)# binding imsi-msisdn enable-aggregate-query
Possible completions:
  true  false

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 filter the RxB control plane messages, which is configured as a list of substring. It can hold upto five types of strings in the list.

Syntax

control-plane remote-peer-policy global filter-fqdn-with-string

control-plane remote-peer-policy global filter-fqdn-with-string [ str1 str2 str3 str4 str5 ]

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 RxB peer FQDNs as a list of substrings. The command usage does not allow more than five types of strings. Whenever the configuration is done, it replaces the existing configuration to limit the content of the list.

Note	Configure the part of FQDN as a substring.

Examples

Following is an example to configure the control plane remote peer policy for the RxB peer FQDN: site-b-server-calipers21-rxb.af.b-rx-b1-1 as a list of substrings:

control-plane remote-peer-policy global filter-fqdn-with-string [ rxb ]

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

Used to configure the control plane messages for DB VM CPU from Worker to Director.

Syntax

control-plane timers dynamic-peer-ratelimit dbcpu-status-update-interval <time-in-ms>

Command Parameters

Command Mode

CONFIG

VNFs

DRA

Command Usage

This command allows tuning the frequency at which worker nodes send periodic status updates for DRA DB VM CPU messages to the Director. As DB VM CPU is updated every 10 seconds and duplicate DB CPU VM status gets published, it is recommended to configure minimum update interval as 10 seconds or multiple of 10 seconds.

Example

control-plane timers dynamic-peer-ratelimit dbcpu-status-update-interval 20000

Used to map the external users to the CRD table group.

Syntax

crd access-restriction externaluser-tablegroup-mapping add-gid "table-group-name" "group-id"

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use this CLI command to map the external users to the CRD table group.

Examples

Example 1: The following is an example to assign a group ID to the CRD table group:

crd access-restriction externaluser-tablegroup-mapping add-gid “apm_tool” “100”

Example 2: The following is an example to remove a group ID from the CRD table group:

crd access-restriction externaluser-tablegroup-mapping remove-gid “apm_tool” “100”

Example 3: The following is an example to display the assigned CRD table group for a Group ID:

crd access-restriction externaluser-tablegroup-mapping show-tablegroup “100”

Example 4: The following is an example to display the assigned Group IDs for the CRD table group:

crd access-restriction externaluser-tablegroup-mapping show-gid “apm_tool”

Used to map the local users to the CRD table group.

Syntax

crd access-restriction localuser-tablegroup-mapping add-user "table-group-name" "table-name"

Command Parameters

Command Mode

CONFIG

VNFs

All

Command Usage

Use this CLI command to map the local users to the CRD table group.

Examples

Example 1: The following is an example to assign a user to the CRD table group:

crd access-restriction localuser-tablegroup-mapping add-user “apm_tool” “oper”

Example 2: The following is an example to remove a user from the CRD table group:

crd access-restriction localuser-tablegroup-mapping remove-user "apm-tool" “oper”

Example 3: The following is an example to display the assigned CRD table group for a user:

crd access-restriction localuser-tablegroup-mapping show-tablegroup “oper”

Example 4: The following is an example to display the assigned users for CRD table group:

crd access-restriction localuser-tablegroup-mapping show-users “apm_tool”

Used to create, remove and display the CRD table group.

Syntax

crd access-restriction table-group add-table "table-group-name" "table-name"

Note	As the running-config backup does not save the backup of the crd configuration, take the backup using the following command: show crd access-restriction table-groups | save /data/config/backup.txt command.

Command Parameters

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use this CLI command to create, remove and display the CRD table group or CRD table.

Examples

Example 1: The following is an example to create a CRD table group and add a table to the group:

crd access-restriction table-group add-table “amp_tool” “apn_mapping”

Example 2: The following is an example to remove a CRD table from CRD table group:

crd access-restriction table-group remove-table “amp_tool” “apn_mapping”

Example 3: The following is an example to display the added CRD table list from CRD table group:

crd access-restriction table-group show-tables “amp_tool”

Example 4: The following is an example to display the list of CRD table groups:

show crd-access-restriction table-groups

Example 5: The following is an example to display the list of all CRD tables:

show crd tables

Used to verify the discrepancy of ipv6 zones ranges configured on Mongo Database and Confd.

Syntax

database check-ipv6-zone-config Cluster Name

Command Parameters

Command Mode

Operational

VNFs

Binding

Command Usage

Use this database check-ipv6-zone-config command to find out the discrepancy of ipv6 zone ranges configured on Mongo Database and confd.

Examples

Example 1: If no discrepancy is found for the cluster:

admin@orchestrator[an-dbmaster]# database check-ipv6-zone-config binding
Shard_DB Primary IP is for binding is 192.168.11.41 and its port number 27030
Enter Mongo Admin password:
Starting  ipv6shardb zones Validation..
#### Verifying ipv6 zone discrepancy from CLI Running Config to Mongo database. ####
#### Verifying ipv6 zone discrepancy from Mongo Database to CLI Running Config. ####
IPV6 zone Config Shardb Validation Completed..

Example 2: If discrepancy is found for the cluster:

admin@orchestrator[an-dbmaster]# database check-ipv6-zone-config binding
Shard_DB Primary IP is for binding is 192.168.11.41 and its port number 27030
Enter Mongo Admin password:
Starting  ipv6shardb zones Validation..
#### Verifying ipv6 zone discrepancy from CLI Running Config to Mongo database. ####
**************************************************
FAILURE: IPV6 Zone ASGHAR and its Range ASGHAR_TEST for Start Value 2606:ae00:bd80:0000:0000:0000:0000:0010 and End Value 2606:ae00:bd80:0000:0000:0000:0000:0020 is InValid. Please check..
**************************************************
**************************************************
FAILURE: IPV6 Zone MEGAZONE2 and its Range MEGARANGE3 for Start Value 2606:ae00:90a0:0000 and End Value 2606:ae00:90af:ffff is InValid. Please check..
**************************************************
#### Verifying ipv6 zone discrepancy from Mongo Database to CLI Running Config. ####
**************************************************
FAILURE: IPV6 Zone ASGHAR and its Range ASGHAR_TEST for Start Value 2606:ae00:bd80:0000:0000:0000:0000:0030 and End Value 2606:ae00:bd80:0000:0000:0000:0000:0040 is InValid. Please check..
**************************************************
**************************************************
FAILURE: IPV6 Zone AA and its Range ASGHAR_AA for Start Value 2606:ae00:bd80:0000:0000:0000:0000:1111 and End Value 2606:ae00:bd80:0000:0000:0000:0000:1111 is InValid. Please check..
**************************************************
IPV6 zone Config Shardb Validation Completed..

Example 3: If zones were not configured for cluster but user tries to validate the zones:

admin@orchestrator[an-dbmaster]# database check-ipv6-zone-config imsi
FAILURE: imsi is not Configured..

Used to print all IPV6 zone range configuration entries present in Mongo shard db for the cluster.

Syntax

database clearzoneinfo dump clustername CLUSTER-NAME

Command Parameters

Command Mode

OPERATIONAL

VNFs

Binding

Command Usage

This command prints the IPV6 range configuration entries in the Mongo sharddb for the cluster.

Used to delete and re-add all the IPV6 range configuration entries in the Mongo sharddb for the cluster.

Syntax

database clearzoneinfo delete-all clustername CLUSTER-NAME

Command Parameters

Command Mode

OPERATIONAL

VNFs

Binding

Command Usage

This command deletes and re-adds all the IPV6 range configuration entries in the Mongo sharddb for the cluster.

Used to delete a single IPV6 zone range configuration entry in the Mongo sharddb for the cluster.

Syntax

database clearzoneinfo delete clustername CLUSTER-NAME zonename ZONE-NAME rangename RANGE-NAME

Command Parameters

Command Mode

OPERATIONAL

VNFs

Binding

Command Usage

This command deletes a single IPV6 zone range configuration entry in the Mongo sharddb for the cluster.

Used to update a single IPV6 zone range config entry in the Mongo sharddb for the cluster with the new starting and ending IPV6 addresses.

Syntax

database clearzoneinfo update clustername zonename rangename start START end END

Command Parameters

Command Mode

OPERATIONAL

VNFs

Binding

Command Usage

This command updates a single IPV6 zone range config entry in the Mongo sharddb for the cluster with the new starting and ending ipv6 addresses.

Used to delete all the range entries for a single IPV6 zone configuration in Mongo sharddb for the cluster.

Syntax

database clearzoneinfo delete-zone clustername binding zonename ZONE-NAME

Command Parameters

Command Mode

OPERATIONAL

VNFs

Binding

Command Usage

This command deletes all the range entries for a single IPV6 zone configuration in Mongo sharddb for the cluster.

Examples

The following is an example to delete all range entries in ZONE1 of IPV6 zone configuration.

admin@orchestrator[an-dbmaster]# show running-config database cluster binding ipv6-zones-range | tab
ZONE   RANGE
NAME   NAME    START                END
---------------------------------------------------------
ZONE1  RANGE1  2606:ae00:c780:1     2606:ae00:c789:ffff
       RANGE2  2606:ae00:c790:0000  2606:ae00:c79f:ffff

admin@orchestrator[an-dbmaster]# database clearzoneinfo delete-zone clustername binding zonename ZONE1
 2 documents deleted.
{'_id': 1, 'version': 137299, 'state': 'READY', 'zoneSharding': 'enabled', 'modifiedAt': datetime.datetime(2022, 11, 23, 10, 27, 34, 498000)}
admin@orchestrator[an-dbmaster]#

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

The following is the output for database cluster ipv6-zones-range command.

                     RANGE                                             
NAME      ZONE NAME  NAME    START                END                  
-----------------------------------------------------------------------
binding   pune       range1  2003:3051:0000:0001  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

Create zones for IPv6 shards based on IPv6 pools with ipv6 address validation. This allows the primary member of the replica set for an IPv6 address reside at the same physical location as the P-GW assigning addresses from the IPv6 pool. This results in local write (and read) for the IPv6 binding database.

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

The database ipv6-zones clustername CLI adds IPv6 validation whereas the database cluster db-name ipv6-zones-range CLI does not have IPv6 validation.

Note	You can create multiple ranges for each zone. Configure the IPv6 ranges only in the short format.

Syntax

database ipv6-zones clustername  CLUSTER-NAME zonename ZONE-NAME  
rangename RANGE-NAME  start pool-start-IPv6-addr  end pool-end-IPv6-addr 

Command Parameters

Command Mode

CONFIG

VNFs

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:

admin@orchestrator[site3-master-db-0](config)# 
database ipv6-zones clustername imsi zonename 
IMSIZONE2 rangename IMSIRANGE2 start 2606:ae00:bd80:0000:0000:0000:0000:0000 
end 2606:ae00:bd80:0000:0000:0000:0000:0010
result SUCCESS

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

Used to check and set the defaultWriteConcern (w:1) on the databases.

Syntax

database dwccheck

Command Mode

OPERATIONAL

VNFs

Binding

Command Usage

Use the database dwccheck command to check and set the defaultWriteConcern on the databases.

Examples

The following is an example to check and set the defaultWriteConcern on the databases.

admin@orchestrator[site2-binding-master-1]# database dwccheck
Press "set" to check and set dwc on primary members or
Press "check" to only check dwc on all members.
(set/check) << check
DWC check for shard databases for all members is in Progress......
DWC check for shard databases for all members is Completed
DWC check for shardingDb databases for all members is in Progress......
DWC check for shardingDb databases for all members is Completed
DWC check for orchestrator and mongo-admin-db databases for all members is in Progress......
DWC check for orchestrator and mongo-admin-db databases for all members is Completed
admin@orchestrator[site2-binding-master-1]# database dwccheck
Press "set" to check and set dwc on primary members or
Press "check" to only check dwc on all members.
(set/check) << set
This is going to check and set required DWC on orchestrator,mongo-admin-db,shards and shardingDb databases.
Press yes to continue
(yes/no) << yes
Please do not kill the terminal untill DWC check completes.Kindly check logs(Path:/var/log/broadhop/dwc.log) for more info
DWC check for shard databases is in Progress......
DWC check for shard databases is Completed
DWC check for shardingDb databases is in Progress......
DWC check for shardingDb databases is Completed
DWC check for orchestrator and mongo-admin-db databases is in Progress......
DWC check for orchestrator and mongo-admin-db databases is Completed
admin@orchestrator[site2-binding-master-1]#

Used to check and set fcv on databases.

Syntax

database fcvcheck

Command Parameters

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use the database fcvcheck command to check and set fcv on databases.

Examples

Binding VNF (set): The following is an example to set fcv on primary member.

Press "set" to check and set fcv on primary members or
Press "check" to only check fcv on all members.
(set/check) << set
This is going to check and set required FCV on orchestrator,mongo-admin-db,shards and shardingDb databases.
Press yes to continue
(yes/no) << yes
Please do not kill the terminal untill FCV check completes.Kindly check logs(Path:/var/log/broadhop/fcv.log) for more info
FCV check for shard databases is in Progress......
FCV check for shard databases is Completed
FCV check for shardingDb databases is in Progress......
FCV check for shardingDb databases is Completed
FCV check for orchestrator and mongo-admin-db databases is in Progress......
FCV check for orchestrator and mongo-admin-db databases is Completed

Binding VNF (check): The following is an example to check fcv on all members.

database fcvcheck

Press "set" to check and set fcv on primary members or
Press "check" to only check fcv on all members.
(set/check) << check
FCV check for shard databases for all members is in Progress......
FCV check for shard databases for all members is Completed
FCV check for shardingDb databases for all members is in Progress......
FCV check for shardingDb databases for all members is Completed
FCV check for orchestrator and mongo-admin-db databases for all members is in Progress......
FCV check for orchestrator and mongo-admin-db databases for all members is Completed

DRA VNF (set): The following is an example to set fcv on primary member.

database fcvcheck

Press "set" to check and set fcv on primary members or
Press "check" to only check fcv on all members.
(set/check) << set
This is going to check and set required FCV on orchestrator and mongo-admin-db databases.
Press yes to continue
(yes/no) << yes
Please do not kill the terminal untill FCV check completes.Kindly check logs(Path:/var/log/broadhop/fcv.log) for more info
FCV check for orchestrator and mongo-admin-db databases is in Progress......
FCV check for orchestrator and mongo-admin-db databases is Completed

DRA VNF (check): The following is an example to check fcv on all members.

database fcvcheck

Press "set" to check and set fcv on primary members or
Press "check" to only check fcv on all members.
(set/check) << check
FCV check for orchestrator and mongo-admin-db databases for all members is in Progress......
FCV check for orchestrator and mongo-admin-db databases for all members is Completed

Used to recover single/multiple/all shards and sharding database.

Attention

In HA deployment, CLI needs to be run on single site. Logs (/var/log/broadhop/shardrecovery.log) should be checked after executing CLI.

Syntax

database repair <clustername> <shardname>

database repair <clustername> <shardname1> <shardname2> <shardname3>

database repair <clustername> All

database repair <clustername> sharddb

Command Parameters

Command Mode

OPERATIONAL

VNFs

Binding

Command Usage

Use the database repair commands to recover single/multiple/all shards and sharding database.

Examples

The following is an example to recover shard1 in binding cluster.

The following is an example to recover shard1, shard2, shard3, and shard4 in binding cluster

database repair binding shard1 shard2 shard3 shard4

The following is an example to recover all shards in the binding cluster.

database repair All.

The following is an example to recover sharding database in the binding cluster

databse repair shard-db

Used to get the wire tiger concurrent read and write static transactions.

Syntax

database wiredTiger-Concurrent-Transactions get-transaction

Command Mode

Operational

VNFs

Binding

Command Usage

Use the command to get the wire tiger concurrent read and write static transactions.

Examples

Following is an example to get the wire tiger concurrent read and write static transactions.

admin@orchestrator[vpas-B1-bind-master-1]# database wiredTiger-Concurrent-Transactions get-transaction
CLUSTER WRITE READ
imsi-msisdn : 128 8
session-ipv6 : 128 128
 

If you configure from the dynamic mode, the values reflect in mongo without a restart action. When the mongo process the restart action, the dynamic values are removed. While the mongo process start, it takes the static configuration.

Syntax

database wiredTiger-Concurrent-Transactions set-transaction dynamic cluster Cluster Name  Write Value  Read Value

Command Parameters

Command Mode

Operational

VNFs

Binding

Command Usage

Use the command to set the wire tiger transactions for read and write values to the mongo clusters dynamically.

Examples

Following is an example to set the wire tiger transactions for read and write values to the mongo clusters.

admin@orchestrator[vpas-B1-bind-master-1]# database wiredTiger-concurrent-transactions set-transaction dynamic cluster imsi-msisdn write 9 read 9
Started checking cluster name
Starting script to set wiredTiger Concurrent Transactions to configure cluster imsi-msisdn writ :9 read: 9
Setting on Mongo Host and Port : 2606:ae00:3001:8311:172:16:244:8a:27020 imsi-msisdn
Setting on Mongo Host and Port : 2606:ae00:3001:8311:172:16:244:8c:27020 imsi-msisdn
Setting on Mongo Host and Port : 2606:ae00:3001:8311:172:16:244:2a:27020 imsi-msisdn
Setting on Mongo Host and Port : 2606:ae00:3001:8311:172:16:244:7c:27020 imsi-msisdn
Setting on Mongo Host and Port : 2606:ae00:3001:8311:172:16:244:7d:27020 imsi-msisdn
Setting on Mongo Host and Port : 2606:ae00:3001:8311:172:16:244:9c:27020 imsi-msisdn
Setting on Mongo Host and Port : 2606:ae00:3001:8311:172:16:244:9d:27020 imsi-msisdn
Setting on Mongo Host and Port : 2606:ae00:3001:8311:172:16:244:8b:27021 imsi-msisdn
Setting on Mongo Host and Port : 2606:ae00:3001:8311:172:16:244:2a:27021 imsi-msisdn
Setting on Mongo Host and Port : 2606:ae00:3001:8311:172:16:244:2b:27021 imsi-msisdn
Setting on Mongo Host and Port : 2606:ae00:3001:8311:172:16:244:7d:27021 imsi-msisdn
Setting on Mongo Host and Port : 2606:ae00:3001:8311:172:16:244:7c:27021 imsi-msisdn
Setting on Mongo Host and Port : 2606:ae00:3001:8311:172:16:244:9d:27021 imsi-msisdn
Setting on Mongo Host and Port : 2606:ae00:3001:8311:172:16:244:9c:27021 imsi-msisdn
Setting on Mongo Host and Port : 2606:ae00:3001:8311:172:16:244:8b:27022 imsi-msisdn
Setting on Mongo Host and Port : 2606:ae00:3001:8311:172:16:244:8c:27022 imsi-msisdn
Setting on Mongo Host and Port : 2606:ae00:3001:8311:172:16:244:2b:27022 imsi-msisdn

If the user configure from static, the values are stored in consul. When the mongo process the restart action, the values reflect in the mongo.

Syntax

database wiredTiger-Concurrent-Transactions set-transaction static cluster Cluster Name  Write Value  Read Value

Command Mode

Operational

VNFs

Binding

Command Usage

Use the command to set the wire tiger transactions for read and write values to the mongo clusters.

Examples

Following is an example to set the wire tiger transactions for read and write values to the mongo clusters.

admin@orchestrator[vpas-B1-bind-master-1]# database wiredTiger-Concurrent-Transactions set-transaction static cluster session-ipv6 write 200 read 8

Started checking cluster name

wiredTiger-Concurrent-Transactions configured to mongo. Changes will be applied after mongo restart.
 

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

Used to gather various logs to support troubleshooting.

Syntax

debug log collect  [ docker { all all | vmname  name   }  ] 
[ journalctl { all all | vmname  name   }  ] 
[ pb { all all | vmname  name   }  ] 
[ qns { all all | vmname  name   }  ] 
[ tech   ] 
[ top { all all | vmname  name   }  ] 
[ mongo { all all | vmname  name   }  ] 

Command Parameters

Command Mode

Operational

VNFs

DRA

Command Usage

Use this command to gather various logs to support troubleshooting.

debug log collect heapdump containername <name>

Considers diameter-endpoint container name as input and collects heapdump outputs.

Examples

The following is an example:

debug log collect heapdump containername diameter-endpoint-s104
Collection of heapdump completed

debug log collect threaddump containername <name>

Considers diameter-endpoint container name as input and collects a set of threadump outputs.

Examples

The following is an example:

debug log collect threaddump containername diameter-endpoint-s104
Collection of threaddump completed

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.

Syntax

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

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

This command checks the balancing and determines if connections need to be balanced. If the connections are unbalanced, it allows user to balance the 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 switch the JVM memory management from Zing to Zulu.

Prerequisite

You must place the cps.pem file on the orchestrator container under /data/keystore

Note	The dra jvm zulu enable command must be executed in the Maintenance Window (MW).

Syntax

dra jvm zulu enable jvm-memory   Memory Size in GB 
         dra jvm status   

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA VNF

Command Usage

Use this dra jvm command to switch between zulu and zing.

Examples

Login to the Orchestrator container CLI and run the below cmd’s to enable zulu.

Note	To enable Zulu, the recommended heap memory is 16GB and Heap Memory can be increase/decrease based on the requirement.

admin@orchestrator[dra1-sys04-master-0]# dra jvm zulu enable jvm-memory 16
Are you sure to enable Zulu JVM (y/n)?
Enabling Zulu service on binding-s108.
Success! Data written to: zing/enabled
Success! Data written to: jvm/memory
Enabling Zulu service on binding-s109.
Success! Data written to: zing/enabled
Success! Data written to: jvm/memory
Enabling Zulu service on diameter-endpoint-s104.
Success! Data written to: zing/enabled
Success! Data written to: jvm/memory
Enabling Zulu service on diameter-endpoint-s105.
Success! Data written to: zing/enabled
Success! Data written to: jvm/memory
Enabling of Zulu JVM will restart the App Service, 
Are you sure to proceed with App Service Restart (y/n)? 
Executing Zulu Tasks
Stopping app service on binding-s108.
app: stopped
Stopping app service on binding-s109.
app: stopped
Stopping and disabling Zing-memory Service on Worker 192.169.67.174 VM.
Created symlink /etc/systemd/system/zing-memory.service -> /dev/null.
Stopping and disabling Zing-memory Service on Worker 192.169.67.175 VM.
Created symlink /etc/systemd/system/zing-memory.service -> /dev/null.
Starting app service on binding-s108.
app: started
Starting app service on binding-s109.
app: started
Stopping app service on diameter-endpoint-s104.
app: stopped
Stopping app service on diameter-endpoint-s105.
app: stopped
Stopping and disabling Zing-memory Service on Director 192.169.67.176 VM.
mknod: /dev/zing_mm0: File exists
Stopping and disabling Zing-memory Service on Director 192.169.67.177 VM.
Created symlink /etc/systemd/system/zing-memory.service -> /dev/null.
Starting app service on diameter-endpoint-s104.
app: started
Starting app service on diameter-endpoint-s105.
app: started

[dra1-sys04-master-0]# dra jvm status
Zulu is enabled..
To Verify Manually login into any worker or director VM check the app process.

cps@dra1-sys04-director-1:~$ ps -aef | grep zulu
root      7643  7639 44 08:13 ?        00:02:45 /usr/lib/jvm/zulu-8-amd64/bin/java -Xms16g -Xmx16g -XX:MaxTenuringThreshold=4 -XX:+PrintGCDetails 
-XX:+PrintGCTimeStamps -XX:+PrintGCDateStamps -XX:+PrintGCApplicationStoppedTime 
-XX:+UnlockDiagnosticVMOptions -XX:+UnsyncloadClass -XX:+TieredCompilation 
-XX:+DisableExplicitGC -server -XX:+UseG1GC -XX:+UnlockExperimentalVMOptions 
-XX:G1NewSizePercent=5 -XX:G1MaxNewSizePercent=75 -XX:ConcGCThreads=8 
-XX:ParallelGCThreads=32 -XX:MaxGCPauseMillis=10000 
-XX:ParGCCardsPerStrideChunk=4096 -XX:+ParallelRefProcEnabled 
-XX:+AlwaysPreTouch -javaagent:/var/broadhop/jmx/jmxagent.jar 
-DnoMemcacheVip=true -DmemcacheIp=localhost:11211 -Dqns.app.type=diameter_endpoint 
-Dosgi.classloader.lock=classname -Dqns.config.dir=/etc/broadhop/ 
-Dqns.instancenum=1 -Dcom.broadhop.run.instanceId=diameter-endpoint-s104.weave.local-1 
-Dlogback.configurationFile=/etc/broadhop/logback.xml -Djmx.port=9045 
-Dorg.osgi.service.http.port=8080 -Dsnmp.port=1161 -DenableConsulServiceDiscovery=true
 -Dcom.broadhop.run.systemId=test-system -Dcom.broadhop.run.clusterId=test-cluster 
-Dcom.broadhop.config.url=http://svn/repos/run/ -Dcom.broadhop.repository.credentials=qns-svn/cisco123@svn
 -Dsession.db.init.1=mongo-session-a-s1 -Dsession.db.init.2=mongo-session-b-s1 
-Dsession.db.init.port=27017 -DdisableJms=true -DembeddedBrokerEnabled=false
-Dtarget.compressed.size=1024 -Denable.compression=true 
-Denable.dictionary.compression=true -DuseZlibCompression=true 
-DenableBestCompression=false -Dcom.broadhop.locking.autodiscovery=true 
-DlookasideThreshold=3 -DcompressDebits -Dnetworkguard.tcp.local.ipv6=false -DrefreshOnChange=true
-DenableRuntimePolling=true -DdefaultNasIp=127.0.0.1
 -Dua.version.2.0.compatible=true -DsessionPadding=1200 
-DnodeHeartBeatInterval=9000 -Dcom.mongodb.updaterIntervalMS=400
-Dcom.mongodb.updaterConnectTimeoutMS=600 -Dcom.mongodb.updaterSocketTimeoutMS=600
-DdbSocketTimeout=1000 -DdbSocketTimeout.balance=1000 -DdbConnectTimeout=1200 
-DdbConnectTimeout.balance=1200 -Dmongo.client.thread.maxWaitTime=1200 
-Dmongo.client.thread.maxWaitTime.balance=1200 -Dstatistics.step.interval=1
-Dmongo.connections.per.host=5 -Dmongo.connections.per.host.balance=10 
-Dmongo.threads.allowed.to.wait.for.connection=10 
-Dmongo.threads.allowed.to.wait.for.connection.balance=10 -DmaxLockAttempts=3 
-DretryMs=3 -DmessageSlaMs=1500 -DshardPingLoopLength=3 -DshardPingCycle=200 
-DshardPingerTimeoutMs=75 -Ddiameter.default.timeout.ms=2000 
-DmemcacheClientTimeout=200 -Dlocking.disable=true -Dcontrolcenter.disableAndsf=true 
-Ddra.nat.bind.if=eth0 -Dcom.broadhop.q.if=ethwe -DclusterLBIF=eth1 
-Djava.rmi.server.disableHttp=true -Dsun.rmi.transport.tcp.handshakeTimeout=90000 
-DrqDisableMsgTTL=true -Denable_tcp_nodelay=true -DenableQueueSystem=false 
-Ddra.app.mediation.enable=false -Dallow.crd.export.file.with.system.name.prefix=true 
-Dcrd.mongo.cache.refresh.interval.margin=15000 -Dcrd.next.reload.delay.time=120 
-DudpPrefix=qns -DudpEndPort=5000 -DqueueHeartbeatIntervalMs=25 
-Dzmq.send.hwm=1000 -Dzmq.recv.hwm=1000 -Djdiameter.dra=true 
-DdraDiameterEndpoint=true -DdraGeoRelay=true -Dosgi.framework.activeThreadType=normal 
-jar /var/qps/images/run/plugins/org.eclipse.equinox.launcher_1.1.0.v20100507.jar 
-console 9091 -clean -os linux -ws gtk -arch x86_64
cps      25269 15445  0 08:20 pts/0    00:00:00 grep --color=auto zulu

Used to switch the JVM memory management from Zing to Zulu.

Prerequisite

You must place the cps.pem file on the orchestrator container under /data/keystore

Note	The dra jvm zing enable command must be executed in the Maintenance Window (MW).

Syntax

dra jvm zing enable   
         dra jvm status   

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA VNF

Command Usage

Use this dra jvm command to switch between zing.

Examples

Note	To enable Zing passing heap memory is not required because this heap memory is handled by its own zing service.

# dra jvm zing enable
Are you sure to enable Zing JVM (y/n)? 
Enabling Zing service on binding-s108.
Success! Data written to: zing/enabled
Enabling Zing service on binding-s109.
Success! Data written to: zing/enabled
Enabling Zing service on diameter-endpoint-s104.
Success! Data written to: zing/enabled
Enabling Zing service on diameter-endpoint-s105.
Success! Data written to: zing/enabled
Enabling of Zing JVM will restart the App Service, 
Are you sure to proceed with App Service Restart (y/n)? 
Executing Zing Tasks
Stopping app service on binding-s108.
app: stopped
Stopping app service on binding-s109.
app: stopped
Starting and Enabling Zing-memory Service on Worker 192.169.67.174 VM.
Removed /etc/systemd/system/zing-memory.service.
Starting and Enabling Zing-memory Service on Worker 192.169.67.175 VM.
Removed /etc/systemd/system/zing-memory.service.
Starting app service on binding-s108.
app: started
Starting app service on binding-s109.
app: started
Stopping app service on diameter-endpoint-s104.
app: stopped
Stopping app service on diameter-endpoint-s105.
app: stopped
Starting and Enabling Zing-memory Service on Director 192.169.67.176 VM.
Removed /etc/systemd/system/zing-memory.service.
Starting and Enabling Zing-memory Service on Director 192.169.67.177 VM.
Removed /etc/systemd/system/zing-memory.service.
Starting app service on diameter-endpoint-s104.
app: started
Starting app service on diameter-endpoint-s105.
app: started

To Verify Manually login into any worker or director VM check the app process.

cps@dra1-sys04-director-1:~$ ps -aef | grep zing
root     11218 11217 19 07:36 ?        00:06:31 /opt/zing/zing-jdk8/bin/java -server -XX:+UseC2 -Xmx35248m -XX:ARTAPort=20000 -XX:+UseTickProfiler -XX:+PrintGCDateStamps 
-XX:+DisableExplicitGC -XX:CIMaxCompilerThreads=2 -XX:-DisplayVMOutput 
-XX:+LogVMOutput -javaagent:/var/broadhop/jmx/jmxagent.jar -DnoMemcacheVip=true 
-DmemcacheIp=localhost:11211 -Dqns.app.type=diameter_endpoint 
-Dosgi.classloader.lock=classname -Dqns.config.dir=/etc/broadhop/ -Dqns.instancenum=1 
-Dcom.broadhop.run.instanceId=diameter-endpoint-s104.weave.local-1 
-Dlogback.configurationFile=/etc/broadhop/logback.xml -Djmx.port=9045 
-Dorg.osgi.service.http.port=8080 -Dsnmp.port=1161 -DenableConsulServiceDiscovery=true 
-Dcom.broadhop.run.systemId=test-system -Dcom.broadhop.run.clusterId=test-cluster 
-Dcom.broadhop.config.url=http://svn/repos/run/ -Dcom.broadhop.repository.credentials=qns-svn/cisco123@svn 
-Dsession.db.init.1=mongo-session-a-s1 -Dsession.db.init.2=mongo-session-b-s1 
-Dsession.db.init.port=27017 -DdisableJms=true -DembeddedBrokerEnabled=false 
-Dtarget.compressed.size=1024 -Denable.compression=true 
-Denable.dictionary.compression=true -DuseZlibCompression=true 
-DenableBestCompression=false -Dcom.broadhop.locking.autodiscovery=true 
-DlookasideThreshold=3 -DcompressDebits -Dnetworkguard.tcp.local.ipv6=false 
-DrefreshOnChange=true -DenableRuntimePolling=true -DdefaultNasIp=127.0.0.1 
-Dua.version.2.0.compatible=true -DsessionPadding=1200 -DnodeHeartBeatInterval=9000 
-Dcom.mongodb.updaterIntervalMS=400 -Dcom.mongodb.updaterConnectTimeoutMS=600 
-Dcom.mongodb.updaterSocketTimeoutMS=600 -DdbSocketTimeout=1000 
-DdbSocketTimeout.balance=1000 -DdbConnectTimeout=1200 -DdbConnectTimeout.balance=1200 
-Dmongo.client.thread.maxWaitTime=1200 -Dmongo.client.thread.maxWaitTime.balance=1200 
-Dstatistics.step.interval=1 -Dmongo.connections.per.host=5 
-Dmongo.connections.per.host.balance=10 -Dmongo.threads.allowed.to.wait.for.connection=10 
-Dmongo.threads.allowed.to.wait.for.connection.balance=10 -DmaxLockAttempts=3 
-DretryMs=3 -DmessageSlaMs=1500 -DshardPingLoopLength=3 -DshardPingCycle=200 
-DshardPingerTimeoutMs=75 -Ddiameter.default.timeout.ms=2000 
-DmemcacheClientTimeout=200 -Dlocking.disable=true -Dcontrolcenter.disableAndsf=true
 -Ddra.nat.bind.if=eth0 -Dcom.broadhop.q.if=ethwe -DclusterLBIF=eth1 
-Djava.rmi.server.disableHttp=true -Dsun.rmi.transport.tcp.handshakeTimeout=90000 
-DrqDisableMsgTTL=true -Denable_tcp_nodelay=true -DenableQueueSystem=false 
-Ddra.app.mediation.enable=false -Dallow.crd.export.file.with.system.name.prefix=true 
-Dcrd.mongo.cache.refresh.interval.margin=15000 -Dcrd.next.reload.delay.time=120 
-DudpPrefix=qns -DudpEndPort=5000 -DqueueHeartbeatIntervalMs=25 
-Dzmq.send.hwm=1000 -Dzmq.recv.hwm=1000 -Djdiameter.dra=true 
-DdraDiameterEndpoint=true -DdraGeoRelay=true -Dosgi.framework.activeThreadType=normal 
-jar /var/qps/images/run/plugins/org.eclipse.equinox.launcher_1.1.0.v20100507.jar 
-console 9091 -clean -os linux -ws gtk -arch x86_64
cps      16965 15445  0 08:09 pts/0    00:00:00 grep --color=auto zing

To configure mongo db uri.

Syntax

dra subscriber-trace db-connection <ip> <port>

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use this CLI command to set new mongo db uri. By default, DRA uses mongo-admin-a:27017, mongo-admin-b:27017,mongo-admin-c:27017 to store all pcap, version, and trace keys.

Examples

The following is an example:

show running-config dra subscriber-trace
dra subscriber-trace db-connection 182.22.31.60.27017
!
admin@orchestrator[master-00]

To change pcap collection size in Megabytes.

Syntax

dra subscriber-trace db-pcap-collectection-max-size <size in MB>

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use this command to change the size of pcap_files collection. By default, the collection “pcap_files” is created with size 1024 MB. Since the collection “pcap_files” is created as capped collection, DRA automatically deletes oldest pcap entries from the collection and stores new pcap entries.

Examples

The following is an example:

show running-config dra subcriber-trace 
dra subscriber-trace db-pcap-collection-max-size 1024
!
admin@orchestrator[master-00]

To change activity collection size in megabytes.

Syntax

dra subscriber-monitor-activity db-activity-collection-max-size <size in MB>

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use this command to change the activity collection size in megabytes. By default, the collection to store subscriber activities is created with size 1024 MB.

Examples

The following is an example:

show running-config dra subcriber-monitor-activity 
dra subscriber-monitor-activity db-activity-collection-max-size 1024
!
admin@orchestrator[master-00]

To change mongo db uri:

Note	The monitor subscriber-activity CLI is used only to view live logs and is not used to store/stop monitor logging activity.

Syntax

dra subscriber-monitor-activity db-connection <ip> <port>

Command Mode

OPERATIONAL

VNFs

All

Command Usage

Use this CLI command to change mongo db uri. By default, DRA stores monitor activity keys and activity logs in mongo-admin-a:27017, mongo-admin-b:27017, mongo-admin-c:27017.

Examples

The following is an example:

show running-config subscriber-monitor-activity
dra subscriber-monitor-activity db-connection 182.22.31.60.27017
!
admin@orchestrator[master-00]

To configure common rate limit for all binding APIs.

Syntax

dra set-ratelimit binding-api  rate limit value 

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this CLI command to set the rate limit for all binding API queries, such as imsi imsi-apn, msisdn,msisdn-apn, or Ipv6.

Examples

The following is an example:

dra set-ratelimit binding-api 100.

To configure rate limit for imsi binding API queries.

Syntax

dra set-ratelimit binding-api-imsi  rate limit value 

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this CLI command to set rate limit only for imsi binding API queries.

Examples

The following is an example:

dra set-ratelimit binding-api-imsi 200.

To configure binding API with IMSI APN rate limit.

Syntax

dra set-ratelimit binding-api-imsi-apn  rate limit value 

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this CLI command to set rate limit only for imsi-apn binding API queries.

Examples

The following is an example:

dra set-ratelimit binding-api-imsi-apn 200.

To configure rate limit for topology related API queries.

Syntax

dra set-ratelimit topology-api  rate limit value 

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this CLI command to set rate limit for topology related API queries.

Examples

The following is an example:

dra set-ratelimit topology-api 150.

To configure rate limit for ipv6 binding API queries.

Syntax

dra set-ratelimit binding-api-ipv6  rate limit value 

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this CLI command to set rate limit only for ipv6 binding API queries.

Examples

The following is an example:

dra set-ratelimit binding-api-ipv6 100.

To configure rate limit for OAM-related API queries.

Syntax

dra set-ratelimit oam-api   rate limit value 

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this CLI command to set rate limit for OAM (svn/grafana/prometheus/pb/centralcustrefdata) related API queries.

Examples

The following is an example:

dra set-ratelimit oam-api 50

To configure rate limit for SLF-related API queries.

Syntax

dra set-ratelimit slf-api  rate limit value 

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this CLI command to set rate limit for SLF-related API queries..

Examples

The following is an example:

dra set-ratelimit slf-api 300

To configure rate limit for session related API queries.

Syntax

dra set-ratelimit session-api  rate limit value 

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this CLI command to set rate limit for session related API queries.

Examples

The following is an example:

dra set-ratelimit session-api 50

To configure rate limit only for msisdn binding API queries.

Syntax

dra set-ratelimit binding-api-msisdn  rate limit value 

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this CLI command to set rate limit only for msisdn binding API queries.

Examples

The following is an example:

dra set-ratelimit binding-api-msisdn 200

To configure rate limit only for msisdn-apn binding API queries.

Syntax

dra set-ratelimit binding-api-msisdn-apn   rate limit value 

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this CLI command to set rate limit only for msisdn-apn binding API queries.

Examples

The following is an example:

dra set-ratelimit binding-api-msisdn-apn 200.

Removes rate limit for all binding API queries.

Syntax

dra remove-ratelimit binding-api-imsi 

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this command to remove rate limit only for imsi binding API queries.

Removes rate limit only for imsi-apn binding API queries.

Syntax

dra remove-ratelimit binding-api-imsi-apn  

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this CLI command to remove rate limit only for imsi-apn binding API queries.

Removes rate limit for ipv6 binding API queries.

Syntax

dra remove-ratelimit binding-api-ipv6 

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this command to remove rate limit only for ipv6 binding API queries.

Removes rate limit for msisdn-apn binding API queries.

Syntax

dra remove-ratelimit binding-api-msisdn-apn 

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this command to remove rate limit only for msisdn-apn binding API queries.

Removes rate limit for msisdn binding API queries.

Syntax

dra remove-ratelimit binding-api-msisdn 

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this command to remove rate limit only for msisdn binding API queries.

To remove rate limit for all binding API queries.

Syntax

dra remove-ratelimit binding-api 

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this command to remove rate limit for all binding API queries (imsi/imsi-apn/msisdn/msisdn-apn/Ipv6), which was configured using option binding-api .

Examples

The following is an example to remove rate limit binding-api:

dra remove-ratelimit binding-api

Removes rate limit for rate limit for OAM related API queries.

Syntax

dra remove-ratelimit oam-api 

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this command to remove rate limit for OAM (svn/grafana/prometheus/pb/centralcustrefdata) related API queries.

Removes rate limit for session related API queries.

Syntax

dra remove-ratelimit session-api 

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this command to remove rate limit for session related API queries.

Removes rate limit for slf related API queries.

Syntax

dra remove-ratelimit slf-api 

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this command to remove rate limit for slf related API queries.

Used to display the configured rate limit for topology related API queries.

Syntax

dra show-ratelimit topology-api

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this command to view the configured rate limit for topology related API queries.

Examples

The following is an example:

dra show-ratelimit topology-api
dra/ratelimit/topology-api:150

Used to display the configured rate limit for imsi-apn binding API queries.

Syntax

dra show-ratelimit binding-api-imsi-apn

Command Mode

CONFIG

VNFs

DRA

Command Usage

Use this command to view the configured rate limit for imsi-apn binding API queries.

Examples

The following is an example:

dra show-ratelimit binding-api-imsi-apn
dra/ratelimit/binding-api-imsi-apn:200

Used to display the configured rate limit for imsi or imsi-apn binding API queries.

Syntax

dra show-ratelimit binding-api-imsi

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this command to view the configured rate limit for imsi or imsi-apn binding API queries.

Examples

The following is an example:

dra show-ratelimit binding-api-imsi
dra/ratelimit/binding-api-imsi:200
dra/ratelimit/binding-api-imsi-apn:200

Used to display the configured rate limit for msisdn-apn binding API queries.

Syntax

dra show-ratelimit binding-api-msisdn-apn

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this command to view the configured rate limit for msisdn-apn binding API queries.

Examples

The following is an example:

dra show-ratelimit binding-api-msisdn-apn
dra/ratelimit/binding-api-msisdn-apn:200

Used to display the configured rate limit for ipv6 binding API queries.

Syntax

dra show-ratelimit binding-api-ipv6

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this command to view the configured rate limit for ipv6 binding API queries.

Examples

The following is an example:

dra show-ratelimit binding-api-ipv6
dra/ratelimit/binding-api-ipv6:100

Used to display the configured rate limit for msisdn or msisdn-apn binding API queries.

Syntax

dra show-ratelimit binding-api-msisdn

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this command to view the configured rate limit for msisdn or msisdn-apn binding API queries.

Examples

The following is an example:

dra show-ratelimit binding-api-msisdn
dra/ratelimit/binding-api-msisdn:200
dra/ratelimit/binding-api-msisdn-apn:200

Used to display the configured rate limit of all binding API queries.

Syntax

dra show-ratelimit binding-api

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this command to view the configured rate limit of all binding API queries.

Examples

The following is an example:

dra show-ratelimit binding-api
dra/ratelimit/binding-api:100
dra/ratelimit/binding-api-imsi:200
dra/ratelimit/binding-api-imsi-apn:200
dra/ratelimit/binding-api-ipv6:100
dra/ratelimit/binding-api-msisdn:200
dra/ratelimit/binding-api-msisdn-apn:200

Used to display the configured rate limit for OAM-related API queries.

Syntax

dra show-ratelimit oam-api

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this command to view the configured rate limit for OAM (svn/grafana/prometheus/pb/centralcustrefdata) related API queries.

Examples

The following is an example:

dra show-ratelimit oam-api
dra/ratelimit/oam-api:50

Used to display the configured rate limit for session related API queries.

Syntax

dra show-ratelimit session-api

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this command to view the configured rate limit for session related API queries.

Examples

The following is an example:

dra show-ratelimit session-api
dra/ratelimit/session-api:50

Used to display the configured rate limit for SLF related API queries.

Syntax

dra show-ratelimit slf-api

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this command to view the configured rate limit for SLF related API queries.

Examples

The following is an example:

dra show-ratelimit slf-api
dra/ratelimit/slf-api:300

Used to display the configured rate limit for all ingress APIs.

Syntax

dra show-ratelimit

Command Mode

OPERATIONAL

VNFs

DRA

Command Usage

Use this command to view the configured rate limit for all ingress APIs.

Examples

The following is an example:

dra show-ratelimit
dra/ratelimit/binding-api:100
dra/ratelimit/binding-api-imsi:200
dra/ratelimit/binding-api-imsi-apn:200
dra/ratelimit/binding-api-ipv6:100
dra/ratelimit/binding-api-msisdn:200
dra/ratelimit/binding-api-msisdn-apn:200
dra/ratelimit/oam-api:50
dra/ratelimit/session-api:50
dra/ratelimit/slf-api:300
dra/ratelimit/topology-api:150

Used to import the TLS Certificates from Orchestrator to diameter-endpoint containers.

You can provide certificate and private files as an input for this CLI command and also provide the keystore password to encrypt the cert file. Back-end script converts the files into java-based file format called JKS with encryption, then it copies to the diameter-endpoint containers. This cmd supports only .pem file format certificates

Pre-requisites

• Ensure to place the cps.pem file on orchestrator container under /data/keystore

• Ensure to place the TLS Certificate files on Master VM under /data/orchestrator/pemKey

The new keystore file gets placed in a folder in the diameter container /etc/tls/certs/.

Syntax

dra-tls cert import  < Certificate file > < Private key file > 

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

Command Parameters

Command Mode

OPERATIONAL

VNFs

DRA VNF

Command Usage

This command allows you to load the tls certificates file into diameter-endpoint containers with encrypted format.

Example 1

Example 2

Used to configure the IPC send thread parameters.

Syntax

dra ipc-send-thread limit  thread-limit lock-sla-timeout   time-in-ms message-throttle-duration   duration-in- ms  timeout-sample-to-throttle   max-samples  

Command Parameters

Command Mode

CONFIG

VNFs

DRA

Command Usage

Use this command to tune the IPC send thread parameters to handle the slow network peers.

Examples

The following is an example of tuning IPC send thread parameters.

(config)# dra ipc-send-thread limit 50 lock-sla-timeout 250 message-throttle-duration 30000 timeout-sample-to-throttle 150

Note	For more information, see the IPC Queue Send Thread Tuning Configuration section in the CPS vDRA Advance Tuning Guide.

Used to configure the IPC send thread priority parameters.

Syntax

dra ipc-send-thread priority limit thread-limit priority lock-sla-timeout time-in-ms priority message-throttle-duration duration-in- ms priority timeout-sample-to-throttle max-samples   

Command Parameters

Command Mode

CONFIG

VNFs

DRA

Command Usage

Use this command to tune the IPC send thread priority parameters to handle the slow network peers.

Examples

The following is an example of tuning IPC send thread priority parameters with default values.

(config)# dra ipc-send-thread priority limit 5 priority lock-sla-timeout 200 priority message-throttle-duration 30000 priority timeout-sample-to-throttle 150

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

Configures the user name mapping for various roles.

Syntax

external-aaa pam username-mapping <USER-NAME> <ROLE>

Command Parameters

Command Mode

OPERATIONAL

VNFs

All

Command Usage

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

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

Example

external-aaa pam username-mapping anil 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.