Command Line Interface Reference, Modes I - Q, StarOS Release 21.17

Bias-Free Language

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.

Book Contents
Find Matches in This Book

Results

Updated:
December 20, 2019

Chapter: IPMS Client Configuration Mode Commands

IPMS Client Configuration Mode Commands


Important

This is a license enabled external application support. For more information on this product, refer to the IPMS Installation and Administration Guide.

Mode

The IPMS Client Configuration Mode is used to enable the Intelligent Packet Monitoring System (IPMS) client service on an Access Gateway and to set basic service-wide options in a context.

Exec > Global Configuration > Context Configuration > IPMS Configuration

configure > context context_name > ipms

Entering the above command sequence results in the following prompt: 

[context_name]host_name(config-ctx-ipms)#

Important

The commands or keywords/variables that are available are dependent on platform type, product version, and installed license(s).

end

Exits the current configuration mode and returns to the Exec mode.

Product

All

Privilege

Security Administrator, Administrator

Syntax

end

Usage Guidelines

Use this command to return to the Exec mode.

exit

Exits the current mode and returns to the parent configuration mode.

Product

All

Privilege

Security Administrator, Administrator

Syntax

exit

Usage Guidelines

Use this command to return to the parent configuration mode.

export keys

Enables the encryption key export in specific key exchange events to IPMS server from IPMS-enabled AGW.


Important

This is a license enabled customer specific command.

Product

IPMS

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > Context Configuration > IPMS Configuration

configure > context context_name > ipms

Entering the above command sequence results in the following prompt: 

[context_name]host_name(config-ctx-ipms)#

Syntax

no

Removes the configured source IP address from this context for IPMS client communication with IPMS server.

ikev2

Enables the security association (SA) key export for Internet Key Exchange (IKEv2) protocol to IPMS server.

Usage Guidelines

Monitor subscribers which have complaints of service availability or to monitor a test user for system verification.

Example

The following command assigns the IP address 10.2.3.4 to the IPMS client service in context to communicate with IPMS server. This is the IP address allocated for IPMS client service on chassis. 

source address 10.2.3.4

heartbeat

Configures the IPMS heartbeating between the IPMS-enabled AGW and the IPMS server.

Product

IPMS

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > Context Configuration > IPMS Configuration

configure > context context_name > ipms

Entering the above command sequence results in the following prompt: 

[context_name]host_name(config-ctx-ipms)#

Syntax

heartbeat period dur  [ permitted-failure no_of_failures ] 
[ no | default ] heartbeat

default

Configures the heartbeat period and permitted number of failures to the default values of 10 seconds and 1 failure respectively.

no

Disables/removes the configured heartbeat period and permitted number of failures.

period dur

Specifies the periodicity (in seconds) between heartbeat messages as an integer from 1 through 3600. Default: 10

permitted-failure no_of_failures

Specifies the number of errors/failures allowed before declaring an IPMS server as dead/unreachable as an integer from 1 through 10. Default: 1

Usage Guidelines

Use this command to configure the heartbeat message periodicity and permissible failure of heartbeat message response before declaring an IPMS server as dead or unreachable. When an IPMS server is declared down an SNMP trap is sent.

Example

Following command configures the heartbeat message periodicity to 5 second and number of failures allowed as 3 to determine an IPMS server as dead. 

heartbeat period 5 permitted-failure 3

server

Configures the IPMS server address and ports on which the IPMS client on an IPMS-enabled AGW communicates. This is the IP address and port range of the IPMS server.

Product

IPMS

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > Context Configuration > IPMS Configuration

configure > context context_name > ipms

Entering the above command sequence results in the following prompt: 

[context_name]host_name(config-ctx-ipms)#

Syntax

server address ip_address [ seconary ] [ start-port start_port [ end-port end_port ]][ secondary ]  
no server address ip_address

no

Removes the configured IPMS server IP address and port range from this context.

address ip_address

Specifies the IP address of the IPMS server to which the IPMS client service communicates in IPv4 dotted-decimal notation.

A maximum of 4 IPMS severs can be configured with this command in one context.

[ start-port start_port [ end-port end_port ]]

Default: 45001 source port

45005 end port

Specifies the range of UDP ports on which IPMS client communicates with the IPMS server.

start-port start_port : Specifies starting port number as an integer from 1 through 65535 that is less than end_port , if end-port is specified.

end-port end_port : Specifies is the end port number as an integer from 1 through 65535 that is more than start_port .

secondary

The secondary keyword is used to configure the specified server address as secondary IP address on the IPMS client interface.

Usage Guidelines

Use this command to configure/remove the IPMS servers. Up to 4 different IPMS servers can be configured with this command. UDP port number can also be configured with this command. IPMS client will search for this IP address to push the event and traffic logs.

Example

The following command configures IPMS server having IP address 10.2.3.4 in the IPMS client service export the event and traffic logs for intelligent packet monitoring functionality. It also specifies the UDP port range from 48000 to 48005 for communication. 

server address 10.2.3.4 start-port 48000 end-port 48005

source

Configures the source address of the IPMS client in this context to communicate with the IPMS server. This is the IP address for IPMS client on the chassis.

Product

IPMS

Privilege

Security Administrator, Administrator

Mode

Exec > Global Configuration > Context Configuration > IPMS Configuration

configure > context context_name > ipms

Entering the above command sequence results in the following prompt: 

[context_name]host_name(config-ctx-ipms)#

Syntax

source address ip_address

address ip_address

Specifies the IP address of the IPMS client on the AGW in this context. This is the address which is bound to the IPMS client service in this context.

ip_address is expressed in IPv4 dotted-decimal notation.

Usage Guidelines

Monitor subscribers which have complaints of service availability or to monitor a test user for system verification.

Example

The following command assigns the IP address 10.2.3.4 to the IPMS client service in context to communicate with IPMS server. This is the IP address allocated for IPMS client service on chassis. 

source address 10.2.3.4

Was this Document Helpful?

FeedbackFeedback

Contact Cisco