Overview Package Class Deprecated Help

multichassis
MultiChassisIPSecGroup

This is a NFM-P only entity that represents the MC IPsec that spans between two peer routers. This object contains references to MC IPsec Tunnel Group Members which essentially represent the MC IPsec configurations on the two peer routers. Creating this object will result in NFM-P deploying a working MC IPsec configuration to both the participating routers. The creation will also automatically turn up the administrative states of the MC IPsec Group specifics in the peers if not already up. When creating this object both the peer routers that are participating in the MC IPsec has to be managed by NFM-P. Configuring the values for the Tunnel Group Identifiers will cause NFM-P to symmetrically deploy the changes to both the MC IPsec Group Members. Only symmetrically values for MC IPsec Group Identifiers configured in the MC IPsec Group Members will be reflected in this object.Any asymmetry in the values for the MC IPsec Group Identifiers in the two MC LAG Members can be corrected by setting the corresponding values in this object.

public class MultiChassisIPSecGroup

Properties
firstSiteAdministrativeState Specifies the admin state of this tunnel-group on the first node.

type=netw.AdministrativeState
default=tmnxInService
Displayed(tab/group)=Administrative State (/MC IPsec Tunnel Group on First Site)
firstSiteId Specifies the System ID of the first site of MC IPsec Tunnel Group.

type=InetAddress
access=read-create
default=0.0.0.0
Displayed(tab/group)=Site ID (/MC IPsec Tunnel Group on First Site)
firstSiteIpAddressType Specifies the IP address type of the first site of MC IPsec Tunnel Group.

type=rtr.InetAddressType
access=read-create
default=ipv4
firstSitePeerIpAddress Specifies the Peer IP address of the first site for MC IPsec Tunnel Group. The value of this attribute is equal to the source IP address of the second site, since they must match.

type=InetAddress
access=read-create
default=0.0.0.0
Displayed(tab/group)=Peer Address (/MC IPsec Tunnel Group on First Site)
firstSitePeerIpAddressType Specifies the Peer's IP address type of the first site for MC IPsec Tunnel Group.

type=rtr.InetAddressType
access=read-create
default=ipv4
firstSitePriority Specifies the priority of this tunnel-group on the first node.

type=long
default=100
minimum=0
maximum=255
Displayed(tab/group)=Priority (/MC IPsec Tunnel Group on First Site)
firstTunnelGroupId The identifier of the tunnel group.

type=int
access=read-create
default=0
minimum=1
maximum=64
firstTunnelGroupPointer A pointer pointing to the MC IPsec Tunnel Group on the first node. This pointer is used for navigating the node MC IPsec Tunnel Group and for alarm listing.

type=Pointer
access=read-only
default=
Displayed(tab/group)=First Peer Tunnel Group (/MC IPsec Tunnel Group on First Site)
firstTunnelGroupSyncTag The synchronization tag of the tunnel group on the first site peer.

type=string
access=read-only
minimum=1
maximum=32
Displayed(tab/group)=Synchronization Tag (/MC IPsec Tunnel Group on First Site)
secondSiteAdministrativeState Specifies the admin state of this tunnel-group on the second node.

type=netw.AdministrativeState
default=tmnxInService
Displayed(tab/group)=Administrative State (/MC IPsec Tunnel Group on Second Site)
secondSiteId Specifies the System ID of the second site of MC IPsec Tunnel Group.

type=InetAddress
access=read-create
default=0.0.0.0
Displayed(tab/group)=Site ID (/MC IPsec Tunnel Group on Second Site)
secondSiteIpAddressType Specifies the IP address type of the second site of MC IPsec Tunnel Group.

type=rtr.InetAddressType
access=read-create
default=ipv4
secondSitePeerIpAddress Specifies the Peer IP address of the second site for MC IPsec Tunnel Group. The value of this attribute is equal to the source IP address of the first site, since they must match.

type=InetAddress
access=read-create
default=0.0.0.0
Displayed(tab/group)=Peer Address (/MC IPsec Tunnel Group on Second Site)
secondSitePeerIpAddressType Specifies the Peer's IP address type of the second site for MC IPsec Tunnel Group.

type=rtr.InetAddressType
access=read-create
default=ipv4
secondSitePriority Specifies the priority of this tunnel-group on the second node.

type=long
default=100
minimum=0
maximum=255
Displayed(tab/group)=Priority (/MC IPsec Tunnel Group on Second Site)
secondTunnelGroupId The tunnel-group identifier of the peer for this tunnel-group

type=int
access=read-create
default=0
minimum=1
maximum=64
secondTunnelGroupPointer A pointer pointing to the MC IPsec Tunnel Group on the second node. This pointer is used for navigating the node MC IPsec Tunnel Group and for alarm listing.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Second Peer Tunnel Group (/MC IPsec Tunnel Group on Second Site)
secondTunnelGroupSyncTag The synchronization tag of the tunnel group on the second site peer.

type=string
access=read-only
minimum=1
maximum=32
Displayed(tab/group)=Synchronization Tag (/MC IPsec Tunnel Group on Second Site)
tunnelGroupSyncTag The synchronization tag of the tunnel group between MC peers.

type=string
default=
minimum=1
maximum=32
Displayed(tab/group)=Synchronization Tag
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

forceTagSync

To force the deployment of the synchronization tag down to the peers. Can be used when the tags are mismatched.
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.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false