Mobile Policy Common Commands

cluster

Configures the cluster information.

Command Mode

Exec > Global Configuration

Syntax

cluster { cluster-id cluster_id | system-id system_id} 

cluster-id cluster_id

Specify the cluster ID.

Must be a string.

Default Value: cluster-1.

system-id system_id

Specify the system ID.

Must be a string.

Default Value: system-1.

Usage Guidelines

Use this command to configure cluster information.

cps-license

Configures CPS licensing.

Command Mode

Exec > Global Configuration

Syntax

cps-licence license_name encrypted-key encrypted_key 

encrypted-key key

Specify the encrypted key.

Must be a string.

feature-name feature_name

Specify the feature name.

Must be a string.

Usage Guidelines

Use this command to configure PCF license.

db

Configures database setup.

Command Mode

Exec > Global Configuration

Syntax

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} 

Usage Guidelines

Use this command to configure the database setup.

db balance

Configures the Balance database.

Command Mode

Exec > Global Configuration

Syntax

db balance shard-count balance_db_shard_count 

shard-count balance_db_shard_count

Specify the Balance database's shard count.

Must be an integer.

Default Value: 1.

Usage Guidelines

Use this command to configure the Balance database.

Example

The following command configures the Balance database's shard count to 1:
db balance shard-count 1 

db global-settings

Configures global DB settings.

Command Mode

Exec > Global Configuration

Syntax

global-settings db-replica replica_count 

db-replica replica_count

Specify the global DB replica count.

Must be an integer.

Default Value: 3.

volume-storage-class volume_storage_class

Specify the volume storage class if use-volume-claims enabled is enabled.

Must be one of the following:

  • default

  • local

Default Value: default.

Usage Guidelines

Use this command to configure the global DB settings.

db global-settings timers

Configures global MongoDB timers.

Command Mode

Exec > Global Configuration

Syntax

db global-settings timers { catchup-timeout-millis catchup_timeout | election-timeout-millis election_timeout | heartbeat-interval-millis heartbeat_interval} 

catchup-timeout-millis catchup_timeout

Specify the global catchup timeout period, in milliseconds.

Must be an integer.

Default Value: 2000.

election-timeout-millis election_timeout

Specify the global election timeout period, in milliseconds.

Must be an integer.

Default Value: 2000.

heartbeat-interval-millis heartbeat_interval

Specify the global heartbeat interval period, in milliseconds.

Must be an integer.

Default Value: 300.

Usage Guidelines

Use this command to configure the global MongoDB timers.

db spr

Configures the SPR database.

Command Mode

Exec > Global Configuration

Syntax

db spr shard-count shard_count 

shard-count shard_count

Specify the SPR database's shard count.

Must be an integer.

Default Value: 1.

Usage Guidelines

Use this command to configure the SPR database.

Example

The following command configures the SPR database's shard count to 20:
db spr shard-count 20 

debug

Configures the debug parameters.

Syntax

debug { logging { default-level logging_level | logger logger_name } | tracing { jaeger agent udp { host host_address | port port_number } | type }} 

Usage Guidelines

Use this command to configure debug information.

debug logging

Configures the logging parameters.

Command Mode

Exec > Global Configuration

Syntax

default-level [ debug debug | error error | info info | off off | trace trace | warn warn ] 

Usage Guidelines

Use this command to configure the logging parameters.

debug splunk

Configures the Splunk parameters.

Command Mode

Exec > Global Configuration

Syntax

debug splunk { batch-count event_count | batch-interval-ms batch_interval | batch-size-bytes max_batch | hec-token splunk_hec | hec-url port_splunk} 

Usage Guidelines

Use this command to configure the Splunk parameters.

debug tracing

Configures the tracing parameters.

Command Mode

Exec > Global Configuration

Syntax

debug tracing [ jaegar agent agent udp [ host host_name port_number  ] | type tracing_type ] 

Usage Guidelines

Use this command to configure the tracing parameters.

features

Configures the control configuration for the application features.

Command Mode

Exec > Global Configuration

Syntax

features { activemq cluster-ip cluster_ip_address | patching ingress-enabled { false | true }} 

Usage Guidelines

Use this command configure the control configuration for the application features.

Example

The following command configures the control configuration for the application feature:
features { activemq cluster-ip 122.12.122.11 | patching ingress-enabled true } 

features activemq

Configures the ActiveMQ parameters.

Command Mode

Exec > Global Configuration

Syntax

features activemq cluster-ip ip_address 

cluster-ip ip_address

Specify the IP address of the cluster.

Usage Guidelines

Use this command to configure the ActiveMQ parameters.

features patching

Configures the Ingress API.

Command Mode

Exec > Global Configuration

Syntax

features patching ingress-enabled { false | true} 

ingress-enabled { false | true}

Specify to enable or disable patching ingress, not secured.

Must be one of the following:

  • false

  • true

Default Value: false.

Usage Guidelines

Use this command to enable or disable Ingress API.

ldap

Displays the LDAP connections.

Command Mode

Exec

Syntax

show ldap connection-status 

replicas replica_count

Specify the replica count.

Must be an integer.

Default Value: 1.

repository helm_repository

Specify to override Helm repository.

Usage Guidelines

Use this command to view LDAP connection information.

Example

The following command displays the LDAP connections:
show ldap connection-status 

ldap connection-status

Displays the LDAP connections for the SPR lookup.

Command Mode

Exec

Syntax

show ldap connection-status server-set { metric metric_type | value metric_value { timestamp timestamp_value }} 

metric metric_type

Specify the metric type

Must be a string.

serverset server_set_name

Specify the LDAP server set name.

Must be a string.

value metric_value

Specify the metric value

Must be a string.

Usage Guidelines

Use this command to display LDAP connections for the SPR lookup.

ldap server-set

Configures the LDAP server set parameters.

Command Mode

Exec > Global Configuration

Syntax

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

add-child-on-parent-create-failure { 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.

binds-per-second binds_count

Specify the number of binds per second.

Must be of type decimal64, with 2 fraction digits.

Default Value: 0.20.

ignore-ldap-error-result-codes result_code

Specify to ignore LDAP error result codes.

Must be an integer.

initial-connections initial_connections

Specify the initial connections.

Must be an integer.

Default Value: 1.

max-connections max_connections

Specify the maximum number of connections.

Must be an integer.

Default Value: 10.

max-failover-connection-age-ms max_failover_connections

Specify the maximum failover connection age in milliseconds.

Must be an integer.

Default Value: 60000.

missing-attribute-result-code result_code

Specify missing attribute result code.

Must be an integer.

Default Value: 0.

number-consecutive-timeouts-for-bad-connection count_timeouts

Specify the number of consecutive timeouts for bad connection.

Must be an integer.

Default Value: -1.

retry-count retry_count

Specify the retry count.

Must be an integer.

Default Value: 3.

retry-timer-ms retry_timeout

Specify the retry timer timeout period in milliseconds.

Must be an integer.

Default Value: 50.

server-set server_name

Specify the name of the LDAP server set.

Must be a string.

use-asynchronous-operations { false | true}

Specify to enable or disable using LDAP asynchronous operations.

Must be one of the following:

  • false

  • true

Default Value: true.

Usage Guidelines

Use this command to configure LDAP server set parameters.

ldap server-set add-request-attribute

Configures the request attribute.

Command Mode

Exec > Global Configuration

Syntax

add-request-attribute attribute_name attribute_value 

attribute_name

Specify the request attribute name.

Must be a string.

attribute_value

Specify the request attribute value.

Must be a string.

Usage Guidelines

Use this command to configure the request attribute.

ldap server-set connection

Configure the LDAP connection parameters.

Command Mode

Exec > Global Configuration

Syntax

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} 

auto-reconnect { false | true}

Specify to enable or disable auto reconnect to LDAP hosts.

Must be one of the following:

  • false

  • true

Default Value: true.

bind-timeout-ms bind_timeout

Specify the timeout period for bind calls to LDAP in milliseconds.

Must be an integer.

Default Value: 2000.

connection-rule connection_algorithm

Specify the connection algorithm.

Must be one of the following:

  • FASTEST

  • ROUND_ROBIN

Default Value: ROUND_ROBIN.

connection port_number

Specify the port number of the LDAP server.

Must be an integer.

priority priority_number

Specify the priority of the LDAP server set.

Must be an integer.

Default Value: 100.

timeout-ms timeout

Specify the timeout period for calls to LDAP in milliseconds.

Must be an integer.

Default Value: 200.

ldap_server_address

Specify the address of the LDAP server.

Must be a string.

Usage Guidelines

Use this command to configure the LDAP connection parameters.

ldap server-set health-check

Configures the health check parameters.

Command Mode

Exec > Global Configuration

Syntax

health-check { attributes attribute_string | dn health_check_dn | filter filter_string | interval-ms interval_value} 

attributes health_check_attributes

Specify the health check attributes.

Must be a string.

dn health_check_dn

Specify the health check DN.

Must be a string.

filter health_check_filter

Specify the health check filter.

Must be a string.

interval-ms health_check_interval

Specify the health check interval in milliseconds.

Must be an integer.

Default Value: 5000.

Usage Guidelines

Use this command to configure the health check parameters.

ldap server-set search-user

Enables search user for LDAP.

Command Mode

Exec > Global Configuration

Syntax

search-user { [ dn user_dn ] [ password user_password ]} 

dn user_dn

Specify the user DN.

Must be a string.

password user_password

Specify the user password.

Usage Guidelines

Use this command to enable search user for LDAP.

testing

Configures the testing feature.

Command Mode

Exec > Global Configuration

Syntax

testing { external-mongo-access { admin | balance | session | spr } | subversion-ingress-enabled | zing-compiler-options | zing-memory } { ip ip_address | port port_number} 

code-coverage-enabled { false | true}

Specify to enable or disable code coverage reporting with jacoco.

Must be one of the following:

  • false

  • true

Default Value: false.

development-mode-enabled { false | true}

Specify to enable or disable development mode.

Must be one of the following:

  • false

  • true

Default Value: false.

enforce-affinity-rules { false | true}

Specify to enable or disable anti affinity rules for pod scheduling.

Must be one of the following:

  • false

  • true

Default Value: true.

ldap-grpc-enabled { false | 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.

subversion-ingress-enabled { false | true}

Specify if the subversion ingress is enabled.

Must be one of the following:

  • false

  • true

Default Value: false.

zing-compiler-options compiler_options

Specify the compiler options for Zing.

Must be one of the following:

  • C2

  • Falcon

Default Value: C2.

Usage Guidelines

Use this command to configure the testing feature.

testing tls-handshake

Configures the TLS/SSL testing configuration.

Command Mode

Exec > Global Configuration

Syntax

tls-handshake 

alpn-disabled { false | true}

Specify to enable or disable ALPN extenstion in HTTP2 TLS ClientHello handshake.

Must be one of the following:

  • false

  • true

Default Value: false.

debug-enabled { false | true}

Specify to enable or disable TLS/SSL debug logs.

Must be one of the following:

  • false

  • true

Default Value: false.

trust-all { false | true}

Specify to enable or disable Keystore certificate validation for client.

Must be one of the following:

  • false

  • true

Default Value: false.

Usage Guidelines

Use this command to configure the TLS/SSL testing configuration.

testing zing-memory

Configures the storage for Zing data.

Command Mode

Exec > Global Configuration

Syntax

testing zing-memory [ datastore datastore_zing_memory | diameter diameter_zing_memory | engine engine_zing_memory | ldap ldap_zing_memory ] 

datastore datastore_zing_memory

Specify the datastore Zing memory. For example, -Xmx4g/-Xmx8g.

Must be a string.

Default Value: -Xmx8g.

diameter diameter_zing_memory

Specify the Diameter Zing memory. For example, -Xmx4g/-Xmx8g.

Must be a string.

Default Value: -Xmx8g.

engine engine_zing_memory

Specify the engine Zing memory. For example -Xmx4g/-Xmx8g.

Must be a string.

Default Value: -Xmx8g.

ldap ldap_zing_memory

Specify the LDAP endpoint. For example, -Xmx4g/-Xmx8g.

Must be a string.

Default Value: -Xmx8g.

Usage Guidelines

Use this command to configure the storage for Zing data.

zing

Configures Zing for the engine.

Command Mode

Exec > Global Configuration

Syntax

zing enable { false | true} 

enable { false | true}

Specity to enable or disable Zing Java Virtual Machine.

Must be one of the following:

  • false

  • true

Default Value: false.

Usage Guidelines

Use this command to configure Zing for the engine.

Example

The following command configures Zing for the engine:
zing enable true