Overview Package Class Deprecated Help

multichassis
MultiChassisPeer

This is a NFM-P only entity that represents the Multi-Chassis Peer that spans between two peer routers. This object contains Multi-Chassis Per Members which essentially represent the Multi-Chassis Peer configurations on the two peer routers. Creating this object will result in NFM-P deploying a working MC Peer configuration to both the participating routers. It will also result in creation of the dependent Multi-Chassis Peer object on both routers if one doesn't already exist. The creation will also automatically turn up the administrative states of the related objects (Multi-Chassis Peer and Multi-Chassis LAG) if not already up. When creating this object both the routers that are participating in the Multi-Chassis Peer has to be managed by NFM-P.

public class MultiChassisPeer

Properties
enableMcIPSec Specifies whether enable MC IPsec on this multi-chassis peer. If enabled, then MC IPsec is enabled and one instance of McPeerIPsec is created on both entities of this multi-chassis peer. Otherwise they are both deleted.

type=boolean
default=false
Displayed(tab/group)=Enable MC IPsec (/MC IPsec)
firstMcIPSecPointer A pointer pointing to the MC IPsec on the first node.

type=Pointer
access=read-only
default=
Displayed(tab/group)=First Site MC IPsec (/MC IPsec)
firstSiteAuthenticationKey To clear the authentication key in the router use gen.forceSetProperties() method passing in an empty string for value.

type=string
default=
minimum=0
maximum=20
Displayed(tab/group)=Authentication Key (/First Element)
firstSiteSourceIpAddress

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Source Address (/First Element)
firstSiteSourceIpAddressType

type=rtr.InetAddressType
default=ipv4
firstSiteSourceIpOperAddress

type=InetAddress
access=read-only
default=0.0.0.0
firstSiteSourceIpOperAddressType

type=rtr.InetAddressType
access=read-only
default=ipv4
firstSiteWarmStandby Specifies if this first peer operates in warm standby mode.

type=boolean
default=false
Displayed(tab/group)=Warm Standby (/First Element)
igmp

type=boolean
default=false
Displayed(tab/group)=IGMP (Peer Synchronization/Peer Group Synchronization)
igmpFirstSiteRO rolled up from the sync object in one side

type=boolean
access=read-only
default=false
Displayed(tab/group)=IGMP (Peer Synchronization/NE Synchronization)
igmpSecondSiteRO rolled up from the sync object in one side

type=boolean
access=read-only
default=false
Displayed(tab/group)=IGMP Second Site (Peer Synchronization/NE Synchronization)
mcDhcpServer Specifies whether Local DHCP Server information should be synchronized on this multi-chassis peer

type=boolean
default=false
Displayed(tab/group)=MC Local DHCP Server (Peer Synchronization/Peer Group Synchronization)
mcDhcpServerFirstSiteRO Rolled up from the sync object in one side

type=boolean
access=read-only
default=false
Displayed(tab/group)=MC Local DHCP Server (Peer Synchronization/NE Synchronization)
mcDhcpServerSecondSiteRO rolled up from the sync object in one side

type=boolean
access=read-only
default=false
Displayed(tab/group)=MC Local DHCP Server Second Site (Peer Synchronization/NE Synchronization)
mcDiameterProxy Specifies if Diameter Proxy data is synchronized with the multi-chassis peer.

type=boolean
default=false
Displayed(tab/group)=Diameter Proxy (Peer Synchronization/Peer Group Synchronization)
mcDiameterProxyFirstSiteRO Rolled up from the sync object in one side

type=boolean
access=read-only
default=false
Displayed(tab/group)=Diameter Proxy (Peer Synchronization/NE Synchronization)
mcDiameterProxySecondSiteRO rolled up from the sync object in one side

type=boolean
access=read-only
default=false
Displayed(tab/group)=Diameter Proxy Second Site (Peer Synchronization/NE Synchronization)
mcIPSec Specifies whether ipsec information should be synchronized on this multi-chassis peer

type=boolean
default=false
Displayed(tab/group)=MC IPsec (Peer Synchronization/Peer Group Synchronization)
mcIPSecFirstSiteRO rolled up from the sync object in one side

type=boolean
access=read-only
default=false
Displayed(tab/group)=MC IPsec (Peer Synchronization/NE Synchronization)
mcIPSecSecondSiteRO rolled up from the sync object in one side

type=boolean
access=read-only
default=false
Displayed(tab/group)=MC IPsec Second Site (Peer Synchronization/NE Synchronization)
mcKeyChainName Meaningful only when a key chain is configured on the node.

type=Pointer
default=
Displayed(tab/group)=Sync Keychain (Peer Synchronization/Peer Group Synchronization)
mcKeyChainNameFirstSiteRO Meaningful only when a key chain is configured on the node.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Sync Keychain (Peer Synchronization/NE Synchronization)
mcKeyChainNameSecondSiteRO Meaningful only when a key chain is configured on the node.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Sync Keychain (Peer Synchronization/NE Synchronization)
mcL2tp Specifies if Layer Two Tunnel Protocol (L2TP) data is synchronized with the multi-chassis peer.

type=boolean
default=false
Displayed(tab/group)=L2TP (Peer Synchronization/Peer Group Synchronization)
mcL2tpFirstSiteRO Rolled up from the sync object in one side

type=boolean
access=read-only
default=false
Displayed(tab/group)=L2TP (Peer Synchronization/NE Synchronization)
mcL2tpSecondSiteRO rolled up from the sync object in one side

type=boolean
access=read-only
default=false
Displayed(tab/group)=L2TP Second Site (Peer Synchronization/NE Synchronization)
mcMld Specifies whether MLD information should be synchronized on this multi-chassis peer

type=boolean
default=false
Displayed(tab/group)=MLD (Peer Synchronization/Peer Group Synchronization)
mcMldFirstSiteRO Rolled up from the sync object in one side

type=boolean
access=read-only
default=false
Displayed(tab/group)=MLD (Peer Synchronization/NE Synchronization)
mcMldSecondSiteRO rolled up from the sync object in one side

type=boolean
access=read-only
default=false
Displayed(tab/group)=MLD (Peer Synchronization/NE Synchronization)
mcMobileOperStateFirstSiteRO rolled up from the mobile object in one side

type=multichassis.McMobileOperationalState
access=read-only
Displayed(tab/group)=Mobile Oper State (Operational States/First Element)
mcMobileOperStateSecondSiteRO rolled up from the mobile object in one side

type=multichassis.McMobileOperationalState
access=read-only
Displayed(tab/group)=Mobile Oper State (Operational States/Second Element)
mcPimSnooping Specifies whether PIM snooping information should be synchronized with the multi-chassis peer.

type=multichassis.PimSnoopingOption
default=0
Displayed(tab/group)=PIM Snooping (Peer Synchronization/Peer Group Synchronization)
mcPythonCache Specifies if Python cache data is synchronized with the multi-chassis peer.

type=boolean
default=false
Displayed(tab/group)=Python (Peer Synchronization/Peer Group Synchronization)
mcPythonCacheFirstSiteRO Rolled up from the sync object in one side

type=boolean
access=read-only
default=false
Displayed(tab/group)=Python (Peer Synchronization/NE Synchronization)
mcPythonCacheSecondSiteRO rolled up from the sync object in one side

type=boolean
access=read-only
default=false
Displayed(tab/group)=Python Second Site (Peer Synchronization/NE Synchronization)
mcRing Specifies whether mc-ring information should be synchronized with the multi-chassis peer.

type=boolean
default=false
Displayed(tab/group)=MC Ring (Peer Synchronization/Peer Group Synchronization)
mcRingFirstSiteRO rolled up from the sync object in one side

type=boolean
access=read-only
default=false
Displayed(tab/group)=MC Ring (Peer Synchronization/NE Synchronization)
mcRingSecondSiteRO rolled up from the sync object in one side

type=boolean
access=read-only
default=false
Displayed(tab/group)=MC Ring Second Site (Peer Synchronization/NE Synchronization)
mcSynchronizeApplication Indicates the type of client application using multi-chassis synchronization.

type=multichassis.McsClientApp
default=mcIpsec
Displayed(tab/group)=Synchronize Application (Peer Synchronization/Peer Group Synchronization)
mcSynchronizeApplicationFirstSiteRO Indicates the type of client application using multi-chassis synchronization.

type=multichassis.McsClientApp
access=read-only
default=mcIpsec
Displayed(tab/group)=Synchronize Application (Peer Synchronization/NE Synchronization)
mcSynchronizeApplicationSecondSiteRO Indicates the type of client application using multi-chassis synchronization.

type=multichassis.McsClientApp
access=read-only
default=mcIpsec
Displayed(tab/group)=Synchronize Application (Peer Synchronization/NE Synchronization)
mldSnooping Specifies whether MLD-snooping information should be synchronized with the multi-chassis peer.

type=boolean
default=false
Displayed(tab/group)=MLD Snooping (Peer Synchronization/Peer Group Synchronization)
mldSnoopingFirstSiteRO rolled up from the sync object in one side

type=boolean
access=read-only
default=false
Displayed(tab/group)=MLD Snooping (Peer Synchronization/NE Synchronization)
mldSnoopingSecondSiteRO rolled up from the sync object in one side

type=boolean
access=read-only
default=false
Displayed(tab/group)=MLD Snooping Second Site (Peer Synchronization/NE Synchronization)
pimSnoopingFirstSiteRO rolled up from the sync object in one side

type=multichassis.PimSnoopingOption
access=read-only
default=0
Displayed(tab/group)=PIM Snooping (Peer Synchronization/NE Synchronization)
pimSnoopingSecondSiteRO rolled up from the sync object in another side

type=multichassis.PimSnoopingOption
access=read-only
default=0
Displayed(tab/group)=PIM Snooping Second Site (Peer Synchronization/NE Synchronization)
remoteWarmStandbyFirstSiteRO Rolled up from the sync object in one side.

type=boolean
access=read-only
default=false
Displayed(tab/group)=Remote Warm Standby Connected (Operational States/First Element)
remoteWarmStandbySecondSiteRO Rolled up from the sync object in one side.

type=boolean
access=read-only
default=false
Displayed(tab/group)=Remote Warm Standby Connected (Operational States/Second Element)
ringsOperStateFirstSiteRO Indicates the operational state of this multi-chassis peer with respect to multi-chassis ring operation. If there are no multi chassis rings associated with this peer, the value of tmnxMcPeerRingOperState is 'unknown'.

type=multichassis.RingsOperState
access=read-only
default=unknown
Displayed(tab/group)=Ring Oper State (Operational States/First Element)
ringsOperStateSecondSiteRO Indicates the operational state of this multi-chassis peer with respect to multi-chassis ring operation. If there are no multi chassis rings associated with this peer, the value of tmnxMcPeerRingOperState is 'unknown'.

type=multichassis.RingsOperState
access=read-only
default=unknown
Displayed(tab/group)=Ring Oper State (Operational States/Second Element)
secondMcIPSecPointer A pointer pointing to the MC IPsec on the second node.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Second Site MC IPsec (/MC IPsec)
secondSiteAuthenticationKey To clear the authentication key in the router use gen.forceSetProperties() method passing in an empty string for value.

type=string
default=
minimum=0
maximum=20
Displayed(tab/group)=Authentication Key (/Second Element)
secondSiteSourceIpAddress

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Source Address (/Second Element)
secondSiteSourceIpAddressType

type=rtr.InetAddressType
default=ipv4
secondSiteSourceIpOperAddress

type=InetAddress
access=read-only
default=0.0.0.0
secondSiteSourceIpOperAddressType

type=rtr.InetAddressType
access=read-only
default=ipv4
secondSiteWarmStandby Specifies if this second peer operates in warm standby mode.

type=boolean
default=false
Displayed(tab/group)=Warm Standby (/Second Element)
srrp

type=boolean
default=false
Displayed(tab/group)=SRRP (Peer Synchronization/Peer Group Synchronization)
srrpFirstSiteRO rolled up from the sync object in one side

type=boolean
access=read-only
default=false
Displayed(tab/group)=SRRP (Peer Synchronization/NE Synchronization)
srrpSecondSiteRO rolled up from the sync object in one side

type=boolean
access=read-only
default=false
Displayed(tab/group)=SRRP Second Site (Peer Synchronization/NE Synchronization)
subscriberHostTracking Specifies whether subscriber host tracking information should be synchronized with the multi-chassis peer.

type=boolean
default=false
Displayed(tab/group)=Subscriber Host Tracking (Peer Synchronization/Peer Group Synchronization)
subscriberHostTrackingFirstSiteRO rolled up from the sync object in one side

type=boolean
access=read-only
default=false
Displayed(tab/group)=Subscriber Host Tracking (Peer Synchronization/NE Synchronization)
subscriberHostTrackingSecondSiteRO rolled up from the sync object in one side

type=boolean
access=read-only
default=false
Displayed(tab/group)=Subscriber Host Tracking Second Site (Peer Synchronization/NE Synchronization)
subscriberManagement

type=boolean
default=false
Displayed(tab/group)=Subscriber IPoE Management (Peer Synchronization/Peer Group Synchronization)
subscriberManagementFirstSiteRO rolled up from the sync object in one side for IPoE

type=boolean
access=read-only
default=false
Displayed(tab/group)=Subscriber IPoE Management (Peer Synchronization/NE Synchronization)
subscriberManagementPPPoE

type=boolean
default=false
Displayed(tab/group)=Subscriber PPPoE Management (Peer Synchronization/Peer Group Synchronization)
subscriberManagementPPPoEFirstSiteRO rolled up from the sync object in one side for PPPoE

type=boolean
access=read-only
default=false
Displayed(tab/group)=Subscriber PPPoE Management (Peer Synchronization/NE Synchronization)
subscriberManagementPPPoESecondSiteRO rolled up from the sync object in one side for PPPoE

type=boolean
access=read-only
default=false
Displayed(tab/group)=Subscriber PPPoE Management Second Site (Peer Synchronization/NE Synchronization)
subscriberManagementSecondSiteRO rolled up from the sync object in one side for IPoE

type=boolean
access=read-only
default=false
Displayed(tab/group)=Subscriber IPoE Management Second Site (Peer Synchronization/NE Synchronization)
  
Properties inherited from multichassis.AbstractMultiChassisPeer
commonSyncAdminState, completeConfiguration, firstPeerPointer, firstSiteAdministrativeState, firstSiteDescription, firstSiteId, firstSiteIpAddressType, firstSitePeerName, igmpSnooping, igmpSnoopingFirstSiteRO, igmpSnoopingSecondSiteRO, lagSummaryOperStateFirstSiteRO, lagSummaryOperStateSecondSiteRO, secondPeerPointer, secondSiteAdministrativeState, secondSiteDescription, secondSiteId, secondSiteIpAddressType, secondSitePeerName, syncAdminStateFirstSiteRO, syncAdminStateSecondSiteRO, syncOperStateFirstSiteRO, syncOperStateSecondSiteRO, syncStatusFirstSiteRO, syncStatusSecondSiteRO
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

getDependencyCount

Input Parameters:
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
count : int -
Exceptions:
multichassis.MultiChassisPeer.getDependencyCountException
Methods inherited from multichassis.AbstractMultiChassisPeer
findInstanceContainedPeers, pushDownPeerSyncSymmetricalConfig, resetPeerSyncProtocols