Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel

...

borderColorgreen
bgColortransparent
borderWidth2

...

Back to CLI Configure Mode

Back to Address Context - CLI

Back to Zone - CLI

In this section:

Table of Contents
maxLevel2

 

Excerpt Include
CAC Management Using MTRM
CAC Management Using MTRM
nopaneltrue

This section describes the commands involved in configuring MTRM server and client connection ports.

Note

If configuring MTRM connection port on the Management interface, first configure the Management Logical IP using syntax below. Then insert that IP address in the ipAddressV4 or ipAddressV6 field of the MTRM connection port.

Code Block
languagenone
% set system logicalMgmtIpInterface <name> mgmtIpInterfaceGroupName <mgmtInterfaceGroupName> ipAddress <logicalIPAddress> 
% set system logicalMgmtIpInterface <name> state enabled

Include Page
IP_IGs_ServedBySeperateProcessors
IP_IGs_ServedBySeperateProcessors

Anchor
server
server
MTRM Conn Port (Server Role)

Command Syntax

The MTRM Conn Port CLI syntax is shown below for the Server and Client port roles selected using the portRole parameter.

Code Block
languagenone
% set addressContext <addressContext name> zone <zone name> mtrmConnPort <index> portRole server
	healthCheckIgnore <disable | enable>
	healthCheckInterval <1-150>
	healthCheckTimeout <1-120>
	ipAddressV4 <IP address>
	ipAddressV6 <IP address> 
	ipInterfaceGroupName <IPIG name> 
	mgmtInterfaceGroupName <MIG name>
	mode <inService | outOfService>
	portNumber <4000-4500>
	state <disabled | enabled>

% show addressContext <addressContext name> zone <zone name> mtrmConnPort

% delete addressContext <addressContext name> zone <zone name> mtrmConnPort <index>

Command Parameters

Caption
0Table
1Zone MTRM Conn Port Parameters
ParameterLength/RangeDescription
<index>1-128The Master Trunk Group Connection Port index.
healthCheckIgnoreN/A

Enable this flag to ignore the health check time-out.

  • disable (default)
  • enable
healthCheckInterval1-150

The MTRM health check interval, in seconds. A health check message is sent to the peer at the end of each interval. (default = 5)

healthCheckTimeout1-120The health check time-out duration, in seconds. The client connection closes if no response is received from the client during this time span. (default = 25)
ipaddressV4N/A

The IPv4 listen address of the MTRM Connection Port.

ipaddressV6N/A

The IPv6 listen address of the MTRM Connection Port.

ipInterfaceGroupNameN/AThe IP Interface Group name used by MTRM connection port.
mgmtInterfaceGroupNameN/A Specifies the MGMT interface group name used by this MTRM connection port.
modeN/A

 Specifies the operational mode for this MTRM connection port.

  • inService (default)
  • outOfService
portNumber 4000-4500 The MTRM listen port. (default = 4360)
portRoleN/A

MTRM connection port role:

  • client 
  • server 
stateN/A

 Specifies the administrative state of this MTRM connection port.

  • disabled (default)
  • enabled 

Anchor
client
client
MTRM Conn Port (Client Role)

Command Syntax

Code Block
languagenone
% set addressContext <addressContext name> zone <zone name> mtrmConnPort <index> portRole client
	forceSecondaryConnection <disabled | enabled>
	healthCheckIgnore <disable | enable>
	healthCheckInterval <1-150>
	healthCheckTimeout <1-120>
	ipAddressV4 <IP address>
	ipAddressV6 <IP address> 
	ipInterfaceGroupName <IPIG name> 
	mgmtInterfaceGroupName <MIG name>
	mode <inService | outOfService>
	primaryServerIPAddr <IPv4 or IPv6 address>
	primaryServerPortNumber <4000-4500>
	retryCount <3-20>
	secondaryIpAddress <IPv4 or IPv6 address> 
	secondaryPortNumber <4000-4500>
	serverReconnectInterval <1-150>
	state <disabled | enabled>

% show addressContext <addressContext name> zone <zone name> mtrmConnPort

% delete addressContext <addressContext name> zone <zone name> mtrmConnPort <index>

Command Parameters

ParameterLength/RangeDescription
<index>1-128The Master Trunk Group Connection Port index.
forceSecondaryConnectionN/A

Enable this flag to force the MTRM Connection Port from the primary to the secondary server for a geo-redundant client. If MTRM is connected to secondary server, the MTRM connection port remains connected to the secondary even if the primary is available.

  • disabled (default)
  • enabled
healthCheckIgnoreN/A

Enable this flag to ignore the health check time-out.

  • disable (default)
  • enable
healthCheckInterval1-150

The MTRM health check interval, in seconds. A health check message is sent to the peer at the end of each interval. (default = 5)

healthCheckTimeout1-120The health check time-out duration, in seconds. The client connection closes if no response is received from the server during this time span. (default = 25)
ipaddressV4N/A

The local IPV4 address.

ipaddressV6N/A

The local IPV6 address. 

ipInterfaceGroupNameN/AThe IP Interface Group name used by MTRM connection port.
mgmtInterfaceGroupNameN/A Specifies the MGMT interface group name used by this MTRM connection port.
modeN/A

 Specifies the operational mode for this MTRM connection port.

  • inService (default)
  • outOfService
portRoleN/A

MTRM connection port role:

  • client 
  • server

primaryServerIPAddr 

N/AThe IPv4 or IPv6 address of the primary server.
primaryServerPortNumber4000-4500The MTRM server port to connect to. (default = 4360)
retryCount3-20

The number of times to attempt a connection to the peer, after which the connection switches to the alternate server. (default = 5)

secondaryIpAddressN/AThe IPv4 or IPv6 address of the secondary server.
secondaryPortNumber4000-4500Port number of the MTRM secondary server. (default = 4360)
serverReconnectInterval1-150the amount of time in seconds after which the client tries to connect to the server.
stateN/A

 Specifies the administrative state of this MTRM connection port.

  • disabled (default)
  • enabled 

Resetting MTRM Connection Port and Statistics

Use the following commands to reset MTRM connection port and statistics.

Code Block
languagenone
% request addressContext default zone defaultSigZone mtrmConnPort <index>
	reset
	statReset
Caption
0Table
1MTRM Connection Port Reset Parameters
ParameterDescription
resetReset the Master Trunk Group Connection Port.
statReset

Reset the Master Trunk Group Connection Port statistics.

Viewing Results and Status

Use the following system-level CLI syntax to view MTRM Conn Port details, peer status and statistics:

Code Block
languagenone
> show table addressContext <addressContext name> zone <zone name> mtrmConnPort
> show status addressContext <addressContext name> zone <zone name> mtrmConnPortPeerStatus
> show status addressContext <addressContext name> zone <zone name> mtrmConnPortPeerStatistics