Overview Package Class Deprecated Help

igh
InterfaceGroupHandler

InterfaceGroupHandler(IGH) class represents the ECMP fate sharing group. A network element can contain up to 100 instances of InterfaceGroupHandler. At creation time ighId is mandatory attribute.

public class InterfaceGroupHandler

Properties
administrativeState The value of AdministrativeState specifies the administrative state of the Interface Group Handler.

type=netw.AdministrativeState
default=tmnxOutOfService
Displayed(tab/group)=Administrative State
chassisId The Index of Chassis containing Interface Group Handler object.

type=int
access=read-only
default=1
igh.IghMember-Set type=Children-Set
igh.IghProtocolCfg-Set type=Children-Set
ighId This property is the index of the Interface Group Handler object.

type=int
access=read-create
default=0
minimum=1
maximum=100
Displayed(tab/group)=IGH ID
siteId IP address of the Site containing this object.

type=string
access=read-only
default=0.0.0.0
maximum=50
Displayed(tab/group)=Site ID (/Site)
siteName Name of the Site containing this object.

type=string
access=read-only
default=
maximum=252
Displayed(tab/group)=Site Name (/Site)
threshold The value of Threshold specifies the minimum number of Interface Group Handler Members that have to be active before the Interface Group Handler can be brought operationally up.

type=long
default=1
minimum=1
maximum=8
Displayed(tab/group)=Minimum Active Link Threshold
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

configureIghMember

This API can be used to create IghMembers .
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.
ighMemConfigInfo : igh.IGHMemCreateInfo - IGH member creation parameters.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
ighMemDN : string - DN of successfully created IghMember
Exceptions:
igh.InterfaceGroupHandler.configureIghMemberException
Supported Network Elements
7450 ESS Supported until 23.3.R1
7750 SR Supported until 23.3.R1
  • Excluded chassis types: 7750-SRa4, 7750-SRa8, VSR, VSR-I, 7750 SR-1e, 7750 SR-2e, 7750 SR-3e, 7750-SR1 Fixed CFM, 7750 SR-14s, 7750 SR-7s, 7750 SR-1s, 7750 SR-2s