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 PCF 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 PCF license.
Configures the database parameter.
PCF
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 } } | 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 number of SPR shards.
Must be an integer.
Use this command to configure the database parameter.
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 global volume storage settings for DB.
Exec > Global Configuration
global-settings volume-storage-class [ default | local ] If the use-volume-claim is enabled, then specify the volume storage class.
Use this command to configure the volume storage class for database.
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.
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 } 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
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 logging utility.
Exec > Global Configuration
logging logger logger_utility Specify the logging utility name.
Must be a string.
Use this command to configure the logging utility.
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 Jaeger parameters.
Exec > Global Configuration
jaeger [ agent host host_name | port port_name ] | type tracing_type ] Specify the host address of the Jaeger agent.
Specify the port number of the Jaeger agent.
Specify the tracing type.
Must be one of the following:
OPENTRACING_JAEGER
DISABLED
Default Value: DISABLED.
Use this command to configure the Jaeger 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
activemq cluster-ip ip_address Specify the IP address of the cluster.
Must be an IP address.
Use this command to configure the ActiveMQ parameters.
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.
Displays the LDAP connections.
Exec
show ldap { connection-status { metric metric_type | value metric_value } | displaylevel depth_level } Specify the metric type.
Must be a string.
Specify the metric value.
Must be a string.
Specify the depth level of the LDAP connections.
Use this command to display the LDAP connection information.
show ldap connection-status Displays the LDAP connections for the SPR lookup.
Exec
show ldap connection-status { metric metric_type | value metric_value} Specify the metric type
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 either "false" or "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 either "false" or "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 either "false" or "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.
Must be an aes-cfb-128-encrypted string.
Use this command to enable search user for LDAP.
Configures the parameters for 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 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 to enable or disable redis IPC communication between ldap-ep to engine.
Must be either "false" or "true".
Default Value: false.
Specify if the subversion ingress is enabled.
Must be either "false" or "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 parameters for the Testing feature.
Configures the TLS/SSL testing parameters.
Exec > Global Configuration
tls-handshake Specify to enable or disable ALPN extenstion in HTTP2 TLS ClientHello handshake.
Must be either "false" or "true".
Default Value: false.
Specify to enable or disable TLS/SSL debug logs.
Must be either "false" or "true".
Default Value: false.
Specify to enable or disable Keystore certificate validation for client.
Must be either "false" or "true".
Default Value: false.
Use this command to configure the TLS/SSL testing parametes.
Configures the storage for preserving the Zing data.
Exec > Global Configuration
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 preserve the Zing data.
testing zing-memory [ datastore -Xmx8g | diameter -Xmx4g | engine -Xmx8g | ldap -Xmx4g ] Enables or disables the Zing feature for the engine.
Exec > Global Configuration
zing enable { false | true } Specity to enable or disable Zing Java Virtual Machine.
Must be either "false" or "true".
Default Value: false.
Use this command to enable or disable the Zing feature for the engine.
zing enable true 
Feedback