The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Configures the cluster information.
Exec > Global Configuration
cluster { cluster-id cluster_id | system-id system_id } Specify the cluster ID.
Must be a string.
Default Value: "cluster-1".
Specify the system ID.
Must be a string.
Default Value: "system-1".
Use this command to configure cluster information.
Registers the cnAAA license.
Exec > Global Configuration
cps-licence license_name encrypted-key encrypted_key Specify the feature name.
Must be a string.
Specify the encrypted key.
Must be a string.
Use this command to registers the cnAAA license.
Configures the database parameter.
cnAAA
Security Administrator, Administrator
db { balance shard count number_of_shard | global-settings { db-replica number_of_replica | timers { catchup-timeout-millis catchup_timeout | election-timeout-millis election_timeout | heartbeat-interval-millis heartbeat_interval | db-user-name MongoDB_username
password PlainTextPassword | } } | spr shard-count number_of_spr_shards } Specify to abort commit. Specify the persist ID.
Must be an integer.
Specify the number of database replicas.
Must be an integer.
Specify the catchup timeout in milliseconds.
Must be an integer.
Specify the election timeout in milliseconds.
Must be an integer.
Specify the heartbeat interval in milliseconds.
Must be an integer.
Specify the MongoDB database username and password.
Specify the number of SPR shards.
Must be an integer.
Use this command to configure the database parameter.
Configures the backup settings for replica sets.
Exec > Global Configuration
db global-settings backup-settings backup-file-prefix backup-frequency backup-from-member exclude-dbs local-backup-path max-backup-time-seconds max-restore-time-seconds | purge-local-file scp-server } } Command Modes Exec > Global Configuration
Syntax Description
backup-file-prefix
Backup file title prefix
Must be a string.
Command Modes Exec > Global Configuration
backup-frequency { day Day_which _backup_need _to_execute | time-to-backup Backup_initiate_time,_HH:MM:SS} Command Modes Exec > Global Configuration
backup-from-member member { primary | primary-preferred | secondary | secondary-preferred} Backup shall be initiated from selected option.
Command Modes Exec > Global Configuration
Syntax Description
exclude-dbs
Must be a string.
List of dbs to be excluded being backed up.
Command Modes Exec > Global Configuration
Syntax Description
local-backup-path
Local backup file path, Default: /data/db
Must be a string.
Command Modes Exec > Global Configuration
Syntax Description
max-backup-time-seconds
Maximum time for each db to be backed up.
Must be an integer .
Default value 300
Command Modes Exec > Global Configuration
Syntax Description
max-restore-time-seconds
Maximum time for each db to be restored.
Must be an integer .
Default value 300
Command Modes Exec > Global Configuration
Syntax Description
purge-local-file
Deletes the locally created backup file after uploading to the backup server.
Type Boolean
Command Modes Exec > Global Configuration
Syntax Description
scp-server { host Ip_address | password password | port server_port | remote-backup-path file_path | user-name user_name} Backup server configuration parameters
Command Modes Exec > Global Configuration
Syntax Description
host
Server name or IP Address
Must be a String.
Command Modes Exec > Global Configuration
Syntax Description
password
Login password
Command Modes Exec > Global Configuration
Syntax Description
port
Server port
Must be type of unsigned int
Default value is 22
Command Modes Exec > Global Configuration
Syntax Description
remote-backup-path
Absolute file path in scp server to be restored
Must be a String.
Command Modes Exec > Global Configuration
Syntax Description
user-name
Login user name
Must be a String.
Command Modes Exec > Global Configuration
Syntax Description
user-name
Login user name
Must be a String.
Configures the Balance database.
Exec > Global Configuration
balance shard-count balance_db_shard_count Specify the Balance database's shard count.
Must be an integer.
Default Value: 1.
Use this command to configure the Balance database.
db balance shard-count 1 Configures the replica count for the global DB.
Exec > Global Configuration
global-settings db-replica replica_count Specify the global DB replica count.
Must be an integer.
Default Value: 3.
Use this command to configure the replica count for the global DB.
Command Modes Exec > Global Configuration
Syntax Description
Global DB replica count
Must be an integer.
Default value is 3.
Exec > Global Configuration
db global-settings db-tunings { concurrent-transactions-read | concurrent-transactions-write | oplog-size-mb | slowms | wired-tiger-cache-size-gb } Command Modes Exec > Global Configuration
Syntax Description
concurrent-transactions-read
Maximum number of concurrent read transactions allowed into the storage engine.
Must be an integer.
Default value is 16.
Command Modes Exec > Global Configuration
Syntax Description
concurrent-transactions-write
Maximum number of concurrent write transactions allowed into the storage engine.
Must be an integer.
Default value is 16.
Command Modes Exec > Global Configuration
Syntax Description
oplog-size-mb
OpLog Size(in MB) for data-bearing members.
Must be an integer from range 3072..5120.
Default value is 3072.
Command Modes Exec > Global Configuration
Syntax Description
slowms (in milliseconds)
(in milliseconds) Operations that run for longer than this threshold are considered slow.
Must be an integer.
Default value is 500.
Command Modes Exec > Global Configuration
Syntax Description
wired-tiger-cache-size-gb
Maximum size of the internal cache that WiredTiger uses for all data.
Must be an integer from range 1 .. 5.
Default value is 2.
Command Modes Exec > Global Configuration
Syntax Description
Uses Mongodb user name for authentication.
Must be a String.
Command Modes Exec > Global Configuration
Syntax Description
Enable-database-encryption.
Must be of type Boolean.
Default value is false.
Command Modes Exec > Global Configuration
Syntax Description
enable-tmpfs:
Must be of type Boolean.
Default value is false.
Command Modes Exec > Global Configuration
Syntax Description
password:
Mongodb password for authentication.
Command Modes Exec > Global Configuration
Syntax Description
resource { cpu | memory }
Pod resource configuration.
Command Modes Exec > Global Configuration
Syntax Description
cpu { limit cpu_limit_in_ millicores |request cpu_resource_request_in_millicores }
CPU resource requests and limit configuration.
Command Modes Exec > Global Configuration
Syntax Description
memory { limit memory_limit_in_mb | request memory_request_in_mb }
Memory resource requests and limit configuration.
Configures global MongoDB timers.
Exec > Global Configuration
global-settings timers { catchup-timeout-millis catchup_timeout | election-timeout-millis election_timeout | heartbeat-interval-millis heartbeat_interval } Exec > Global Configuration
Specify the global catchup timeout period, in milliseconds.
Must be an integer.
Default Value: 2000.
Exec > Global Configuration
connect-timeout-millis
MongoClient driver wait time for a connection to open before timing out.
Must be an integer.
Default Value: 2000.
Exec > Global Configuration
Specify the global election timeout period, in milliseconds.
Must be an integer.
Default Value: 2000.
Exec > Global Configuration
Specify the global heartbeat interval period, in milliseconds.
Must be an integer.
Default Value: 300.
Use this command to configure the global MongoDB timers.
Exec > Global Configuration
MongoClient driver wait time for server selection to succeed, before throwing an exception.
Must be an integer.
Default Value: 2000.
Exec > Global Configuration
MongoClient driver wait time to send or receive a request before timing out.
Must be an integer.
Default Value: 2000.
Exec > Global Configuration
volume-storage-class:
Volume storage class if use-volume-claims is enabled.
Values can be default or local.
Default value is default.
Command Mode
Exec > Global Configuration
Sample configuration
db scdb replica-name sdb-subscriber1
port 65001
interface vlan 2400
storage 5
resource cpu limit 6000
resource memory limit 112000
replica-set-label key smi.cisco.com/node-type
replica-set-label value oam
member-configuration member sdb-rs1-arbiter
host 10.192.1.24
arbiter true
site local
exit
member-configuration member sdb-rs1-s1-m1
host 10.192.1.22
arbiter false
priority 102
site local
exit
member-configuration member sdb-rs1-s1-m2 host 10.192.1.23 arbiter false priority 101 site local
exit
exitSpecify the name of the replica-set.
Must be a string.
Port
Specify the port for replica set. Must be an integer. Default Value: 27720.
db-path
Specify the data path for the replica set.
Must be a String. Default Value: /data/db.
Interface
Specify the Interface for Mongo.
Must be a String.
resource cpu limit
Specify the CPU resource limit in millicores.
Must be an integer.
Input range value: 100 to 1000000.
resource cpu request
Specify the CPU resource request in millicores.
Must be an integer.
Input range value: 100 to 1000000.
resource memory limit
Specify the CPU resource limit in megabytes.
Must be an integer.
Input range value: 100 to 200000.
This value specifies the storage size allocated to the replica set.
resource memory request
Specify the CPU resource request in megabytes.
Must be an integer.
Input range value: 100 to 200000.
replica-set-label key KEY_NAME value value
Specify the replica set pod node affinity label key value.
host
Mongo host (Enter IP Address).
Must be a String.
If role of member is arbiter, value shall be set to true.
Default Value: false.
Specify the member priority for this replica-set.
Must be an integer.
Member in local or remote cluster.
Default value: local
Exec
Syntax Description
db scdb execute backup-data
Initiate backup.
Exec
Syntax Description
db scdb execute restore-data
Restore data from backup.
Exec
Syntax Description
password encrypt-password plain-text <PlainTextPassword>
Encrypts a plain text password.
Exec
Syntax Description
password decrypt-password encrypted-text <EncryptedPassword>
Decrypts an encrypted password.
Exec
Syntax Description
show running-config
Display the current configuration.
Exec
Syntax Description
show system status
Display status of the system.
Exec
Syntax Description
show db scdb replica-set-status
Show replica set status.
Exec
Syntax Description
show helm charts
Display helm release details.
Show replica set status.
Exec
Syntax Description
nacm rule-list <rule-name> group <group-name> cmdrule <cmdrule-name> command <command to restrict> access-operations exec action deny
Specifies access restrictions for a user group.
Exec
Syntax Description
nacm rule-list <rule-name> group <group-name> cmdrule <cmdrule-name> command <command to restrict> access-operations exec action deny
Specifies access restrictions for a user group.
Configures the SPR database.
Exec > Global Configuration
spr shard-count shard_count Specify the SPR database's shard count.
Must be an integer.
Default Value: 1.
Use this command to configure the SPR database.
db spr shard-count 20 Configures the debug parameters.
debug { logging { default-level logging_level | logger logger_name } | tracing { jaeger agent udp { host host_address | port port_number } | type } } Specify the default level that must be logged.
Must be one of the following:
trace
debug
info
warn
error
off
Specify the logging utility name.
Must be a string.
Specify the tracing type.
Must be one of the following:
OPENTRACING_JAEGER
DISABLED
Default Value: DISABLED.
Specify the host address of the Jaeger agent.
Specify the port number of the Jaeger agent.
Use this command to configure debug information.
Configures the logging parameters.
Exec > Global Configuration
logging default-level [ debug | error | info | off | trace | warn] Specify the default level that must be logged.
Must be one of the following:
trace
debug
info
warn
error
off
Use this command to configure the logging parameters.
Configures the storage and rotation parameters for system logs.
Command ModesExec > Global Configuration
Syntaxdebug logging sizing { storage-size size_gb | ocs-log { max-index index_count | max-file-size size_mb } | bng-log { max-index index_count | max-file-size size_mb } | audit-log { max-index index_count | max-file-size size_mb } | api-log { maxfilesize size_mb | maxhistory hours | totalcapsize cap_gb } | app-log { maxfilesize size_mb | maxhistory minutes | totalcapsize cap_gb } | engine-log { maxfilesize size_mb | maxhistory minutes | totalcapsize cap_gb } }Specify the maximum log file size in MB.
Must be an integer. Range from 10 to 300. Default 200.
Specify the maximum number of files to retain after rotate.
Must be an integer. Default/minimum 15 and maximum is 21.
Specify the maximum number of files to retain after rotate.
Must be an integer. Default/minimum 15 and maximum is 21.
Specify the maximum log file size in MB.
Must be an integer. Range from 10 to 300. Default 200.
Specify the maximum number of files to retain after rotate.
Must be an integer. Default/minimum 15 and maximum is 21.
Specify the maximum log file size in MB.
Must be an integer. Range from 10 to 300. Default 200.
Specify the maximum log file size in MB.
Must be an integer. Range from 10 to 300. Default 200.
Specifies how long logs are retained before deletion (in hours).
Must be an integer. Range 1 to 72. Default 72.
Defines the total storage allocated for each log type (in GB).
Must be an integer. Range 1 to 1000. Default 300.
Specify the maximum log file size in MB.
Must be an integer. Range from 10 to 300. Default 200.
Specifies how long logs are retained before deletion (in minutes).
Must be an integer. Range 1 to 4320. Default 4320.
Defines the total storage allocated for each log type (in GB).
Must be an integer. Range 1 to 1000. Default 500.
Specify the maximum log file size in MB.
Must be an integer. Range from 10 to 300. Default 200.
Specifies how long logs are retained before deletion (in minutes).
Must be an integer. Range 1 to 4320. Default 4320.
Defines the total storage allocated for each log type (in GB).
Must be an integer. Range 1 to 1000. Default 300.
Use this command to configure the log rotation and storage sizing for various system components.
 Note |
Once the storage-size is configured, this config will not be allowed to remove or reduce size. |
Configures the Splunk parameters.
Exec > Global Configuration
splunk { batch-count event_count | batch-interval-ms batch_interval | batch-size-bytes max_batch | hec-token splunk_hec | hec-url port_splunk } Specify the maximum number of events to send per batch.
Must be an integer.
Default Value: 10.
Specify the interval at which to send batched events, in milliseconds.
Must be an integer.
Default Value: 10000.
Specify the maximum size of each batch of events, in bytes.
Must be an integer.
Default Value: 10240.
Specify the Splunk HEC token.
Must be a string.
Specify the protocol, hostname, and HTTP Event Collector port (8088 by default) of Splunk server.
Must be a string.
Use this command to configure the Splunk parameters.
Configures the tracing parameters.
Exec > Global Configuration
tracing [ jaegar agent agent udp [ host host_name | port port_number ] | type tracing_type ] Specify the Jaegar agen'st name
Specify the host name of the Jaegar agent.
Specify the port number of the Jaegar agent.
Specify the tracing type.
Must be one of the following:
OPENTRACING_JAEGER
DISABLED
Default Value: DISABLED.
Use this command to configure the tracing parameters.
Configures the backup options.
This table lists the mandatory options for backup-config:
|
Option |
Description |
|---|---|
|
|
Specifies the type of backup to perform (all, PB, CRD, Ops-center). |
|
|
CRD ingress details (e.g., |
|
|
Password for authentication of PB or CRD. |
|
|
PB ingress details (e.g., pb.pcf-pcf-engine-app-pcf-green.xx.xx.xx.xx.nip.io). |
|
|
Destination path for backup files on the SCP server. |
|
|
Host IP address of the SCP server. |
|
|
Username for the SCP server. |
|
|
Password for the SCP server user. |
|
|
SVN URL for Policy Builder export (e.g., |
|
|
Username for authentication of PB or CRD. |
|
|
Specifies the hour of the day when the backup operation should be executed (Values range from 00 to 23). |
|
|
Indicates the day of the week when the backup should occur (Values range from 1-7 and start with 1-Monday). |
Configures the control configuration for the application features.
Exec > Global Configuration
features { patching ingress-enabled { false | true } } Use this command configure the control configuration for the application features.
features { patching ingress-enabled true } Enables or disables the Ingress API.
Exec > Global Configuration
patching ingress-enabled { false | true } Specify to enable or disable patching ingress, not secured.
Must be either "false" or "true".
Default Value: false.
Use this command to enable or disable the Ingress API.
Configures the parameters for the Testing feature
Exec > Global Configuration
testing { external-mongo-access { admin | balance | session | spr } | subversion-ingress-enabled | compiler-options } { ip ip_address | port port_number } Specify to enable or disable code coverage reporting with jacoco.
Must be either "false" or "true".
Default Value: false.
Specify to enable or disable development mode.
Must be either "false" or "true".
Default Value: false.
Specify to enable or disable anti affinity rules for pod scheduling.
Must be either "false" or "true".
Default Value: true.
Specify if the subversion ingress is enabled.
Must be either "false" or "true".
Default Value: false.
Use this command to configure the parameters for the Testing feature.
Configuration to disable the optional pods:
Exec > Global Configuration
pods-management disable-pods <pod_name1> <pod_name2>Disables specified pod.
Exec
pcf-system about-system-info
This command displays the current system state, details the versions of all components, and lists the URLs for endpoints that are accessible from outside the system.
CPC VERSION
------------------------
CPC VERSION BUILD_2026.02.0.i55
CPC CORE COMPONENT VERSION
------------------------
pcf-beta-cncps-cnat-cps-infrastructure BUILD_2026.02.0.i55
pcf-beta-cncps-cps-radius-ep BUILD_2026.02.0.i55
pcf-beta-cncps-etcd-cluster BUILD_2026.02.0.i55
pcf-beta-cncps-network-query BUILD_2026.02.0.i55
pcf-beta-cncps-ngn-datastore BUILD_2026.02.0.i55
pcf-beta-cncps-ops-center BUILD_2026.02.0.i55
pcf-beta-cncps-pcf-config BUILD_2026.02.0.i55
pcf-beta-cncps-pcf-dashboard BUILD_2026.02.0.i55
pcf-beta-cncps-pcf-engine-app-production-rjio BUILD_2026.02.0.i55
pcf-beta-cncps-pcf-oam-app BUILD_2026.02.0.i55
pcf-beta-cncps-pcf-services BUILD_2026.02.0.i55
pcf-beta-cncps-unified-api-proxy-ep BUILD_2026.02.0.i55
CNDP VERSION
------------------------
cee-beta-cncps-cee-ops-center 2026.02.1.i05
ULB VERSION
------------------------
lbs-beta-ops-center BUILD_2025.04.0.i18
DATABASE VERSION
------------------------
CDL VERSION 2.2.0
MONGO VERSION v7.0.28
OS VERSION
------------------------
POD OS VERSION Ubuntu 22.04.5 LTS
NODE OS VERSION Ubuntu 24.04.4 LTS
CPC ENDPOINT URLs
------------------------
Grafana https://grafana.xx.xx.xxx.xx.nip.io
Control Center https://pcf.controlcenter.xx.xx.xxx.xx.nip.io
Policy Builder https://pb.pcf-beta-cncps-pcf-engine-app-production-rjio.xx.xx.xxx.xx.nip.io/pb
CPC Central https://pb.pcf-beta-cncps-pcf-engine-app-production-rjio.xx.xx.xxx.xx.nip.io
Feedback