ressubscr
HostLockoutInfo

Information about a specific locked out host.



public class HostLockoutInfo

Properties
circuitId The circuit id of this locked out host.

type=string
access=read-create
default=
Mandatory on create
Displayed(tab/group)=Circuit ID

creationOrigin

type=svt.L2RouteOriginType
access=read-create
default=manual

currentLockTime The current lockout time for this host.

type=int
access=read-create
default=0
units=seconds
Displayed(tab/group)=Current Lock Time

elapsedLockTime The locktime elapsed for this host.

type=int
access=read-create
default=0
units=seconds
Displayed(tab/group)=Elapsed Lock Time

elapsedResetTime The elapsed reset time for this host.

type=int
access=read-create
default=0
units=seconds
Displayed(tab/group)=Elapsed Reset Time

hostId Index: ID of this locked out host.

type=long
access=read-create
Mandatory on create
Displayed(tab/group)=Host ID

macAddress The MAC address of this locked out host.

type=MacAddress
access=read-create
default=00-00-00-00-00-00
Displayed(tab/group)=MAC Address

nextLockTime The next lock time for this host.

type=int
access=read-create
default=0
units=seconds
Displayed(tab/group)=Next Lock Time

numLockouts The number of lockouts for this host.

type=int
access=read-create
default=10
Displayed(tab/group)=Number of Lockouts

portIdentifyingName

type=string
access=read-create
Mandatory on create

remoteId The remote id of this locked out host.

type=string
access=read-create
default=
Mandatory on create
Displayed(tab/group)=Remote ID

sapEncapValue Index: encap value for the SAP.

type=long
access=read-create
default=0
Displayed(tab/group)=Encap Value (/SAP)

sapPortId Index: ID of the SAP.

type=long
access=read-create
default=0
Displayed(tab/group)=Port ID (/SAP)

siteId

type=string
access=read-only
default=
maximum=64

  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

retrieveHostLockoutInfo

Method used to query a SAP for host lockout info.
Input Parameters:
aInSiteId : string - Specifies the NE to which the host is connected with.
aInSapPortId : long - The port identification of the port where the subscriber host is connected to.
aInSapEncapValue : long - Combined inner and outer encapsulation values for the Access Interface that is used by the subscriber host.
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : List (generic.CommonManagedEntityInformation) - List of CommonManagedEntityInformation.
Exceptions:
ressubscr.HostLockoutInfo.retrieveHostLockoutInfoException -
Supported Network Elements
7750 SR Supported from 10.0.R4
7450 ESS Supported from 10.0.R4
  • Required Capabilities: MixedMode