Overview Package Class Deprecated Help

netw
MultiChassisIPSecDomain

public class MultiChassisIPSecDomain

Stats:
netw.MCIPSecDomainStats

Properties
activityState Indicates the result of the activity election between the local and remote multichassis IPsec entity. The activity state can be one of the following: discovery - no election during initial peer discovery interval notEligible - no election, and not eligible to be active eligible - no election, but eligible to be active standby - elected standby active - elected active unknown - domain adjacency peer is unreachable (not applicable to tunnel-groups or domains)"

type=netw.IPSecActivityState
access=read-only
Displayed(tab/group)=Activity State
administrativeState Specifies the Admin state of the domain.

type=netw.AdministrativeState
default=tmnxOutOfService
Displayed(tab/group)=Administrative State
currentActiveRtrId Indicates the router id of the current active chassis for this domain.

type=InetAddress
access=read-only
default=0.0.0.0
Displayed(tab/group)=Current Active Chassis Router Id
currentActiveRtrIdAddrType

type=rtr.InetAddressType
access=read-only
default=ipv4
designatedRole Specifies the designated role of the domain.

type=netw.IPSecDesignatedRole
default=standby
Displayed(tab/group)=Designated Role
domainId

type=int
access=read-create
minimum=1
maximum=255
Mandatory on create
Displayed(tab/group)=Domain Id
domainRtrId Indicates local router id of the domain.

type=InetAddress
access=read-only
default=0.0.0.0
Displayed(tab/group)=Domain Router Id
domainRtrIdAddrType

type=rtr.InetAddressType
access=read-only
default=ipv4
forceSwitchAction Specifies to perform activity switchover from the domain's current active router to one of its standby routers, optionally specified by forceSwitchActionTo

type=netw.McIPSecGroupForceActionType
default=notApplicable
forceSwitchActionTo Specifies the router id of the peer which will become active following a forced switch between this ipsec domain and its redundant peer. If the specified router id matches currentActiveRtrId when the switch is attempted, then no switch will occur.

type=InetAddress
default=0.0.0.0
forceSwitchActionToAddrType AddressType of forceSwitchActionTo.

type=rtr.InetAddressType
default=ipv4
oldActivityState Indicates the older activity election state of the ipsec-domain from which it transitioned to 'activityState'

type=netw.IPSecActivityState
access=read-only
default=unspecified
Displayed(tab/group)=Old Activity State
priority Specifies the priority of the domain.

type=int
default=100
minimum=0
maximum=255
Displayed(tab/group)=Priority
protectStatus Indicates the readiness of the ipsec domain to perform a forced switchover of activity from the current active chassis to the standby chassis. Note that even nominal protection status is not a guarantee that traffic will not be impacted.

type=int
access=read-only
Displayed(tab/group)=Protection Status
enums=
    1: nominal - Nominal
    2: notReady - Not Ready
revertive Specifies whether to allow revertive activity state after a designated active recovers from an ineligibility event. The object is only significant when the value of 'designatedRole' is 'active'

type=boolean
default=false
Displayed(tab/group)=Revertive
siteId

type=string
access=read-only
default=
maximum=64
stateChangeReason Indicates the reason for the state Change from oldActivityState to activityState.

type=string
access=read-only
Displayed(tab/group)=State Change Reason
tunnelGroup Specifies the tunnel-group id associated with the domain

type=int
default=0
minimum=0
maximum=64
Displayed(tab/group)=Tunnel Group
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

forceSwitchOver

Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName : string - the full name of the object.
peerSite : string -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Supported Network Elements
7750 SR Supported from 22.5.R1
  • Excluded chassis types: 7750-SRa4, 7750-SRa8
7705 SAR Gen 2
7705 SAR Hm Supported from 22.5.R1
7450 ESS Supported from 22.5.R1