> IPMS Client Configuration Mode Commands
> The IPMS Client Configuration Mode is used to enable the IPMS client service on an Access Gateway and to set basic service wide options in a context.
> Important: This is a license enabled external application support. For more information on this product, refer to the IPMS Installation and Administration Guide.
> 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
> Change the mode back to the Exec mode.
> exit
> Exits the current mode and returns the CLI session to the previous parent mode.
> Product
> All
> Privilege
> Security Administrator, Administrator
> Syntax
> exit
> Usage
> Return to the parent CLI mode.
> export keys
> This command 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
> Syntax
> no
> Removes the configured source IP address from this context for IPMS client communication with IPMS server.
> ikev2
> This keyword enables the security association (SA) key export for Internet Key Exchange (IKEv2) protocol to IPMS server.
> Usage
> 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 1.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 1.2.3.4
> heartbeat
> This command configures the IPMS heartbeating between IPMS-enabled AGW and IPMS server.
> Product
> IPMS
> Privilege
> Security Administrator, Administrator
> Syntax
> heartbeat period dur [ permitted-failure no_of_failures ]
> [ no | default ] heartbeat
> default
> Configures the heartbeat period and permitted number of failure to default value of 10 seconds and 1 failure respectively.
> no
> Disables/removes the configured heartbeat period and permitted number of failure.
> period dur
> Default: 10
> Specifies the periodicity in seconds of heartbeat messages.
> dur is the duration in second between two heartbeat messages and must be an integer value from 1 through 3600.
> permitted-failure no_of_failures
> Default: 1
> Specifies the number of errors/failures allowed before declaring an IPMS server as dead/unreachable.
> no_of_failures is the number of errors/failure of hearbeat message response and must be an integer value from 1 through 10.
> Usage
> 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
> This command configures the IPMS server address and ports on which IPMS client on IPMS-enabled AGW communicates. This is the IP address and port range of IPMS server.
> Product
> IPMS
> Privilege
> Security Administrator, Administrator
> 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. This is the address which is used by IPMS client service to locate the IPMS server.
> A maximum of 4 IPMS severs can be configured with this command in one context.
> ip_address must be an IP v4 address in dotted decimal notation.
> [ 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 IPMS server.
> start-port start_port is the starting port number and must be an integer value in the range from 1 through 65535 but less than end_port, if end-port is specified.
> end-port end_port is the end port number and must be an integer value in the range from 1 through 65535 but 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
> 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 1.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 1.2.3.4 start-port 48000 end-port 48005
> source
> This command configures the source address of IPMS client in this context to communicate with IPMS server. This is the IP address for IPMS client on the chassis.
> Product
> IPMS
> Privilege
> Security Administrator, Administrator
> 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 must be an IP v4 address in dotted decimal notation.
> Usage
> 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 1.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 1.2.3.4

Cisco Systems Inc.
Tel: 408-526-4000
Fax: 408-527-0883