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.
Configures CPS licensing.
Exec > Global Configuration
cps-licence license_name encrypted-key encrypted_key Specify the encrypted key.
Must be a string.
Specify the feature name.
Must be a string.
Use this command to configure PCF license.
Configures database setup.
Exec > Global Configuration
db { balance shard count shard_count | global-settings { db-replica replica_count | timers { catchup-timeout-millis catchup_timeout_in_ms | election-timeout-millis election_timeout_in_ms | heartbeat-interval-millis heartbeat_interval_in_ms } } | spr shard-count shard_count} Use this command to configure the database setup.
Configures the Balance database.
Exec > Global Configuration
db 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 global DB settings.
Exec > Global Configuration
global-settings db-replica replica_count Specify the global DB replica count.
Must be an integer.
Default Value: 3.
Specify the volume storage class if use-volume-claims enabled is enabled.
Must be one of the following:
default
local
Default Value: default.
Use this command to configure the global DB settings.
Configures global MongoDB timers.
Exec > Global Configuration
db global-settings timers { catchup-timeout-millis catchup_timeout | election-timeout-millis election_timeout | heartbeat-interval-millis heartbeat_interval} Specify the global catchup timeout period, in milliseconds.
Must be an integer.
Default Value: 2000.
Specify the global election timeout period, in milliseconds.
Must be an integer.
Default Value: 2000.
Specify the global heartbeat interval period, in milliseconds.
Must be an integer.
Default Value: 300.
Use this command to configure the global MongoDB timers.
Configures the SPR database.
Exec > Global Configuration
db 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 }} Use this command to configure debug information.
Configures the logging parameters.
Exec > Global Configuration
default-level [ debug debug | error error | info info | off off | trace trace | warn warn ] Use this command to configure the logging parameters.
Configures the Splunk parameters.
Exec > Global Configuration
debug splunk { batch-count event_count | batch-interval-ms batch_interval | batch-size-bytes max_batch | hec-token splunk_hec | hec-url port_splunk} Use this command to configure the Splunk parameters.
Configures the tracing parameters.
Exec > Global Configuration
debug tracing [ jaegar agent agent udp [ host host_name port_number ] | type tracing_type ] Use this command to configure the tracing parameters.
Configures the control configuration for the application features.
Exec > Global Configuration
features { activemq cluster-ip cluster_ip_address | patching ingress-enabled { false | true }} Use this command configure the control configuration for the application features.
features { activemq cluster-ip 122.12.122.11 | patching ingress-enabled true } Configures the ActiveMQ parameters.
Exec > Global Configuration
features activemq cluster-ip ip_address Specify the IP address of the cluster.
Use this command to configure the ActiveMQ parameters.
Configures the Ingress API.
Exec > Global Configuration
features patching ingress-enabled { false | true} Specify to enable or disable patching ingress, not secured.
Must be one of the following:
false
true
Default Value: false.
Use this command to enable or disable Ingress API.
Displays the LDAP connections.
Exec
show ldap connection-status Specify the replica count.
Must be an integer.
Default Value: 1.
Specify to override Helm repository.
Use this command to view LDAP connection information.
show ldap connection-status Displays the LDAP connections for the SPR lookup.
Exec
show ldap connection-status server-set { metric metric_type | value metric_value { timestamp timestamp_value }} Specify the metric type
Must be a string.
Specify the LDAP server set name.
Must be a string.
Specify the metric value
Must be a string.
Use this command to display LDAP connections for the SPR lookup.
Configures the LDAP server set parameters.
Exec > Global Configuration
ldap server-set server_name [ add-child-on-parent-create-failure { false | true } | add-request-attribute attribute_name attribute_value | binds-per-second binds_count | connection connection_address port_number {auto-reconnect { false | true } | bind-timeout-ms bind_timeout_ms | connection-rule FASTEST/ROUND_ROBIN | priority priority_number | timeout-ms timeout } | ignore-ldap-error-result-codes result_code | initial-connections initial_connections | max-connections max_connections | max-failover-connection-age-ms max_failover_connections | missing-attribute-result-code attribute_code | number-consecutive-timeouts-for-bad-connection count_timeout | retry-count retry_count | retry-timer-ms retry_time | use-asynchronous-operations { false | true } ] Specify to enable or disable additions of child on parent creation failure.
Must be one of the following:
false
true
Default Value: true.
Specify the number of binds per second.
Must be of type decimal64, with 2 fraction digits.
Default Value: 0.20.
Specify to ignore LDAP error result codes.
Must be an integer.
Specify the initial connections.
Must be an integer.
Default Value: 1.
Specify the maximum number of connections.
Must be an integer.
Default Value: 10.
Specify the maximum failover connection age in milliseconds.
Must be an integer.
Default Value: 60000.
Specify missing attribute result code.
Must be an integer.
Default Value: 0.
Specify the number of consecutive timeouts for bad connection.
Must be an integer.
Default Value: -1.
Specify the retry count.
Must be an integer.
Default Value: 3.
Specify the retry timer timeout period in milliseconds.
Must be an integer.
Default Value: 50.
Specify the name of the LDAP server set.
Must be a string.
Specify to enable or disable using LDAP asynchronous operations.
Must be one of the following:
false
true
Default Value: true.
Use this command to configure LDAP server set parameters.
Configures the request attribute.
Exec > Global Configuration
add-request-attribute attribute_name attribute_value Specify the request attribute name.
Must be a string.
Specify the request attribute value.
Must be a string.
Use this command to configure the request attribute.
Configure the LDAP connection parameters.
Exec > Global Configuration
connection ldap_server_address port_number { auto-reconnect { false | true } | bind-timeout-ms bind_timeout | connection-rule connection_rule | priority priority_number | timeout-ms timeout} Specify to enable or disable auto reconnect to LDAP hosts.
Must be one of the following:
false
true
Default Value: true.
Specify the timeout period for bind calls to LDAP in milliseconds.
Must be an integer.
Default Value: 2000.
Specify the connection algorithm.
Must be one of the following:
FASTEST
ROUND_ROBIN
Default Value: ROUND_ROBIN.
Specify the port number of the LDAP server.
Must be an integer.
Specify the priority of the LDAP server set.
Must be an integer.
Default Value: 100.
Specify the timeout period for calls to LDAP in milliseconds.
Must be an integer.
Default Value: 200.
Specify the address of the LDAP server.
Must be a string.
Use this command to configure the LDAP connection parameters.
Configures the health check parameters.
Exec > Global Configuration
health-check { attributes attribute_string | dn health_check_dn | filter filter_string | interval-ms interval_value} Specify the health check attributes.
Must be a string.
Specify the health check DN.
Must be a string.
Specify the health check filter.
Must be a string.
Specify the health check interval in milliseconds.
Must be an integer.
Default Value: 5000.
Use this command to configure the health check parameters.
Enables search user for LDAP.
Exec > Global Configuration
search-user { [ dn user_dn ] [ password user_password ]} Specify the user DN.
Must be a string.
Specify the user password.
Use this command to enable search user for LDAP.
Configures the testing feature.
Exec > Global Configuration
testing { external-mongo-access { admin | balance | session | spr } | subversion-ingress-enabled | zing-compiler-options | zing-memory } { ip ip_address | port port_number} Specify to enable or disable code coverage reporting with jacoco.
Must be one of the following:
false
true
Default Value: false.
Specify to enable or disable development mode.
Must be one of the following:
false
true
Default Value: false.
Specify to enable or disable anti affinity rules for pod scheduling.
Must be one of the following:
false
true
Default Value: true.
Specify to enable or disable redis IPC communication between ldap-ep to engine.
Must be one of the following:
false
true
Default Value: false.
Specify if the subversion ingress is enabled.
Must be one of the following:
false
true
Default Value: false.
Specify the compiler options for Zing.
Must be one of the following:
C2
Falcon
Default Value: C2.
Use this command to configure the testing feature.
Configures the TLS/SSL testing configuration.
Exec > Global Configuration
tls-handshake Specify to enable or disable ALPN extenstion in HTTP2 TLS ClientHello handshake.
Must be one of the following:
false
true
Default Value: false.
Specify to enable or disable TLS/SSL debug logs.
Must be one of the following:
false
true
Default Value: false.
Specify to enable or disable Keystore certificate validation for client.
Must be one of the following:
false
true
Default Value: false.
Use this command to configure the TLS/SSL testing configuration.
Configures the storage for Zing data.
Exec > Global Configuration
testing zing-memory [ datastore datastore_zing_memory | diameter diameter_zing_memory | engine engine_zing_memory | ldap ldap_zing_memory ] Specify the datastore Zing memory. For example, -Xmx4g/-Xmx8g.
Must be a string.
Default Value: -Xmx8g.
Specify the Diameter Zing memory. For example, -Xmx4g/-Xmx8g.
Must be a string.
Default Value: -Xmx8g.
Specify the engine Zing memory. For example -Xmx4g/-Xmx8g.
Must be a string.
Default Value: -Xmx8g.
Specify the LDAP endpoint. For example, -Xmx4g/-Xmx8g.
Must be a string.
Default Value: -Xmx8g.
Use this command to configure the storage for Zing data.
Configures Zing for the engine.
Exec > Global Configuration
zing enable { false | true} Specity to enable or disable Zing Java Virtual Machine.
Must be one of the following:
false
true
Default Value: false.
Use this command to configure Zing for the engine.
zing enable true 
Feedback