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
                      — master-traffic-detection
                      — mc-complete-ue-sync
                      — mc-redirect
                      — mobile-gateway
                          — shutdown
                      — peer-connect
                      — slave-traffic-delay-timer
                      — traffic-detection
                      — traffic-detection-poll-timer

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.

Note: When enabled, the manual switchover command (admin redundancy mc-mobile-switchover) is also locked. An error is returned if a manual switchover is attempted while the mc-master-lock command is enabled.

WARNING: In an active/active case, the command must only be executed on one node. If executed on both nodes, the multi-chassis synchronization (MCS) fails and an alarm is issued.

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.; Values: 1 to 8
ip-address: Specifies the peer IP address for the manual switchover.; Values: ip-address | ipv6-address
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.; Values: 1 to 15
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.; Note: Incoming control messages are not served during the preparation phase defined by the max-preparation-time parameter.; Values: 0 (disabled) to 60; Default: 5

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.

Values:

ipv4-address – a.b.c.d
ipv6-address – x:x:x:x:x:x:x:x (eight 16-bit pieces) or x:x:x:x:x:x:d.d.d.d
where
x – [0..FFFF]H
d – [0..255]D

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.; Values: 1 to 2148278386 or a service name, up to 64 characters
interface-name: Specifies the interface name, up to 32 characters.; Default: none

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.; Values: 2 to 25

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.; Values: 5 to 500

master-traffic-detection

Syntax

master-traffic-detection {enable | disable}
no master-traffic-detection

Context

[Tree] configure redundancy multi-chassis peer mc-mobile master-traffic-detection

Description

This command enables or disables the mc-mobile active node to perform traffic detection before the switchover to standby.

The no form of this command reverts to the default.

Default

master-traffic-detection enable

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.; Values: 1 to 8
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

peer-connect

Syntax

peer-connect {enable | disable}
no peer-connect

Context

[Tree] configure redundancy multi-chassis peer mc-mobile peer-connect

Description

This command is configured when the ICR routing and the MC mobile are left configured on the primary node, and the secondary node is removed. For example, when the ICR is used only for ISSU and, after the ISSU process, the secondary node is removed.

Note: Enable this command during the normal ICR operation; that is, when both the primary and the secondary ICR nodes are deployed.

The no form of this command reverts to the default.

Default

peer-connect enable

slave-traffic-delay-timer

Syntax

slave-traffic-delay-timer delay-timer
no slave-traffic-delay-timer

Context

[Tree] configure redundancy multi-chassis peer mc-mobile slave-traffic-delay-timer

Description

This command configures a timer that is enabled when the multi-chassis synchronization (MCS) is detected as lost. The timer delays the start of traffic detection to prevent switchovers when the MCS link is restored before the timer expires. If MC redirection is enabled using the following command, the standby node continues to try and route any traffic over the MC redirect tunnel.

configure redundancy multi-chassis peer mc-mobile mc-redirect

The no form of this command disables the timer (the timer is set to 0 seconds).

Caution: Before executing the command, make sure that a switchover is not in progress.

Default

delay-timer 0

Parameters

delay-timer: Specifies the delay timer, in seconds.; Values: 0 to 60 where 0 means disabled; Default: 0

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 receives a PFCP packet and a GTP-C packet on S11 for 4G FWA, or an HTTP/2 packet on N11 for 5G SA FWA.
relaxed: Keyword to transition from standby to active only after the standby system has received a PFCP or IBCP packet.

traffic-detection-poll-timer

Syntax

traffic-detection-poll-timer seconds
no traffic-detection-poll-timer

Context

[Tree] configure redundancy multi-chassis peer mc-mobile traffic-detection-poll-timer

Description

This command configures the traffic detection poll timer.

The no form of this command reverts to the default value.

Note: Nokia recommends configuring the same value for the traffic detection poll timer in the primary and secondary gateways.

Default

traffic-detection-poll-timer 5

Parameters

seconds: Specifies the traffic detection poll timer, in seconds.; Values: 5 to 1200; Default: 5

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.

Values:

IPv4 address – a.b.c.d
IPv6 address – x:x:x:x:x:x:x:x (eight 16-bit pieces) or x:x:x:x:x:x:d.d.d.d
where
x – [0..FFFF]H
d – [0..255]D

mc-red-tcp-stats

Keyword to display TCP connection statistics for the multi-chassis redundancy.

statistics

Keyword to display statistics.