redundancy command reference
redundancy hierarchy descriptions
This section provides the following redundancy hierarchy descriptions:
admin redundancy command hierarchy
admin
— redundancy
— cpm-switchover
— mc-master-lock
— mc-mobile-switchover
— mc-slave-lock
— mg-switchover
— group
clear redundancy command hierarchy
clear
— redundancy
— multi-chassis
— mc-mobile
configure redundancy command hierarchy
configure
— redundancy
— multi-chassis
— peer
— mc-mobile
— bfd-enable
— hold-on-neighbor-failure
— keep-alive-interval
— mc-complete-ue-sync
— mc-redirect
— mobile-gateway
— shutdown
— traffic-detection
show redundancy command hierarchy
show
— redundancy
— multi-chassis
— mc-mobile
redundancy command descriptions
This section provides the following redundancy command descriptions:
admin redundancy command descriptions
cpm-switchover
Syntax
- cpm-switchover [now]
Context
- [Tree] admin redundancy cpm-switchover
Description
This command triggers a controlled CPM switchover.
Parameters
- now
- Keyword to perform the CPM switchover without requesting confirmation.
mc-master-lock
Syntax
- [no] mc-master-lock
Context
- [Tree] admin redundancy mc-master-lock
Description
This command locks the gateway in the active operational role when ICR or geo-redundancy is deployed. The gateway remains in the active operational role regardless of any ICR active/standby election criteria that may occur.
The no form of this command unlocks and restores the use of normal ICR active/standby election criteria.
Default
no mc-master-lock
mc-mobile-switchover
Syntax
- mc-mobile-switchover mobile-gateway gw-id peer ip-address [{reboot | now}] [abort]
Context
- [Tree] admin redundancy mc-mobile-switchover
Description
This command issues a manual switchover to transition the active gateway to a standby role and its peer gateway to the active role. The manual switchover is not hitless, but synchronizes the complete charging information and state for each bearer, enabling the standby system to transition with minimal disruption and data loss.
Parameters
- gw-id
- Specifies the gateway ID.
- ip-address
- Specifies the peer IP address for the manual switchover.
- reboot
- Keyword to reboot the node after mc-mobile switchover.
- now
- Keyword to force the switchover without full reconciliation. If the ICR is in the up state, the
manual switchover can be performed even when the synchronization state
is not hot.WARNING: If the now keyword is specified, the switchover is executed, but the new active node may have incomplete UE records. In some cases this can be service impacting.
- abort
- Keyword to abort an in-progress mc-mobile switchover. This keyword can only be specified for an ongoing switchover that is in progress for at least five minutes. The user must respond to a confirmation request to proceed. If "yes" is specified, the system issues a disconnect to the standby system, makes it active, switches the active to the standby state, and activates the MC redirect tunnel.
mc-slave-lock
Syntax
- [no] mc-slave-lock
Context
- [Tree] admin redundancy mc-slave-lock
Description
This command locks the gateway in the standby operational role when ICR or geo-redundancy is deployed. The gateway remains in the standby operational role regardless of any ICR active/standby election criteria that may occur.
The no form of this command unlocks and restores the use of normal ICR active/standby election criteria.
Default
no mc-slave-lock
mg-switchover
Syntax
- mg-switchover
Context
- [Tree] admin redundancy mg-switchover
Description
Commands in this context perform a controlled SM-VM switchover.
group
Syntax
- group mg-group-id [now] [max-preparation-time max-preparation-time]
Context
- [Tree] admin redundancy mg-switchover group
Description
This command triggers an SM-VM controlled switchover.
Parameters
- mg-group-id
- Specifies the MG group ID for which to perform the controlled switchover.
- now
- Keyword to perform the controlled switchover without requesting confirmation.
- max-preparation-time
- Specifies the waiting time, in seconds, that the SM-VM uses to process all charging data before the standby SM-VM becomes active. When set to 0, the switchover proceeds without a maximum preparation time, until all charging data has been processed.
clear redundancy command descriptions
mc-mobile
Syntax
- mc-mobile [peer ipv4-address | ipv6-address] statistics
Context
- [Tree] clear redundancy multi-chassis mc-mobile
Description
This command clears mc-mobile related statistics.
Parameters
- ipv4-address | ipv6-address
- Specifies the IP address.
configure redundancy command descriptions
mc-mobile
Syntax
- [no] mc-mobile
Context
- [Tree] configure redundancy multi-chassis peer mc-mobile
Description
Commands in this context configure mc-mobile parameters.
The no form of this command removes the mc-mobile configuration.
Default
no mc-mobile
bfd-enable
Syntax
- bfd-enable [service service-id] interface interface-name
- no bfd-enable
Context
- [Tree] configure redundancy multi-chassis peer mc-mobile bfd-enable
Description
This command enables the use of bidirectional forwarding detection (BFD) to be associated with the peer. The mc-mobile redundancy protocol uses the BFD state to determine the health of its peer. The parameters for the BFD session are set via the BFD command under the IP interface configuration.
The no form of this command disables the use of BFD.
Default
no bfd-enable
Parameters
- service-id
- Specifies the service identifier string.
- interface-name
- Specifies the interface name, up to 32 characters.
hold-on-neighbor-failure
Syntax
- hold-on-neighbor-failure multiplier
- no hold-on-neighbor-failure
Context
- [Tree] configure redundancy multi-chassis peer mc-mobile hold-on-neighbor-failure
Description
This command configures the number of keep-alive intervals that may expire before the local node decides that the peer has failed. A peer failure is declared if no keep-alive responses are received after hold-on-neighbor-failure × keep-alive-interval.
The no form of this command reverts to the default.
Default
hold-on-neighbor-failure 3
Parameters
- multiplier
- Specifies the multiplier.
keep-alive-interval
Syntax
- keep-alive-interval interval
- no keep-alive-interval
Context
- [Tree] configure redundancy multi-chassis peer mc-mobile keep-alive-interval
Description
This command sets the interval to send keep-alive messages to the peer when the BFD is not enabled or is down.
The no form of this command reverts to the default.
Default
keep-alive-interval 10
Parameters
- interval
- Specifies the interval, in tenths of a second.
mc-complete-ue-sync
Syntax
- [no] mc-complete-ue-sync
Context
- [Tree] configure redundancy multi-chassis peer mc-mobile mc-complete-ue-sync
Description
This command enables data synchronization between the active and standby nodes in MC redundancy at the call flow level (synchronization in hot state) and the UE level (synchronization in reconcile state).
When enabled, the MC mobile synchronization goes immediately into the ICR hot state and the progress of the synchronization from the active to the standby node is completed for all UE records. This allows a switchover to take place at any time if an issue arises. If a failover occurs, the number of UEs synced so far all survive.
The no form of this command disables the data synchronization.
Default
no mc-complete-ue-sync
mc-redirect
Syntax
- [no] mc-redirect
Context
- [Tree] configure redundancy multi-chassis peer mc-mobile mc-redirect
Description
This command enables the use of the MC redirect.
The no form of this command disables the use of MC redirect.
Default
no mc-redirect
mobile-gateway
Syntax
- mobile-gateway gw-id role role
- no mobile-gateway gw-id
Context
- [Tree] configure redundancy multi-chassis peer mc-mobile mobile-gateway
Description
This command configures the administrative role of the node. If set to primary, the peer must be configured as secondary. If set to secondary, the peer must be configured as primary.
The no form of this command removes the configuration.
Parameters
- gw-id
- Specifies the gateway ID.
- role
- Specifies the administrative role of the node.
Values: primary | secondary
shutdown
Syntax
- shutdown
- no shutdown
Context
- [Tree] configure redundancy multi-chassis peer mc-mobile mobile-gateway shutdown
Description
This command administratively disables the entity. When disabled, an entity does not change, reset, or remove any configuration settings or statistics. Many entities must be explicitly enabled using the no shutdown command.
The operational state of the entity is disabled as well as the operational state of any entities contained within. Many objects must be shut down before they may be deleted.
Default
shutdown
traffic-detection
Syntax
- traffic-detection {strict | relaxed}
- no traffic-detection
Context
- [Tree] configure redundancy multi-chassis peer mc-mobile traffic-detection
Description
This command configures the traffic detection before an mc-mobile state change.
The no form of this command reverts to the default.
Default
traffic-detection relaxed
Parameters
- strict
- Keyword to transition from standby to active only after the standby system has received an uplink control packet, a downlink data packet, and an uplink data packet.
- relaxed
- Keyword to transition from standby to active only after the standby system has received a PFCP or IBCP packet.
show redundancy command descriptions
mc-mobile
Syntax
- mc-mobile peer ip-address
- mc-mobile [peer ip-address] mc-red-tcp-stats
- mc-mobile [peer ip-address] statistics
Context
- [Tree] show redundancy multi-chassis mc-mobile
Description
This command displays the synchronization state of the node with the specified IP address.
Parameters
- ip-address
- Specifies the IP address.
- mc-red-tcp-stats
- Keyword to display TCP connection statistics for the multi-chassis redundancy.
- statistics
- Keyword to display statistics.