Overview Package Class Deprecated Help

ressubscr
ManagedSubscriberHost

Managed hosts are distinguished by the fact that they are created by the system upon various external triggers, rather than direct requests from client protocols such as PPP or DHCP.

public class ManagedSubscriberHost

Properties
creationOrigin

type=svt.L2RouteOriginType
access=read-create
default=manual
hostType Indicates the type of managed subscriber host.

type=ressubscr.ManagedSubscriberHostType
access=read-create
default=aaa
Displayed(tab/group)=Host Type
ipAddress Indicates the IP address of this host.

type=InetAddress
access=read-create
default=0.0.0.0
Displayed(tab/group)=IP Address
ipAddressType Indicates the address type of IP Address.

type=rtr.InetAddressType
access=read-create
default=ipv4
ipoeSessionIndex Indicates the identifier of the IPoE session associated with this host.

type=long
access=read-only
default=0
Displayed(tab/group)=IPoE Session Index
macAddress Indicates the MAC address of this host.

type=MacAddress
access=read-create
default=00-00-00-00-00-00
Displayed(tab/group)=MAC Address
prefixLength Indicates the prefix length of the IP Address.

type=long
access=read-only
default=0
minimum=0
maximum=128
Displayed(tab/group)=Prefix Length
serviceId

type=long
access=read-create
default=0
Displayed(tab/group)=Service ID
shcvChecks Indicates the number of host connectivity check requests for this host address.

type=long
access=read-only
default=0
Displayed(tab/group)=Checks (/Subscriber Host Connectivity Check)
shcvOperState Indicates the state of the subscriber host connectivity check for this host address.

type=ressubscr.ShcvOperState
access=read-only
default=unspecified
Displayed(tab/group)=Operational State (/Subscriber Host Connectivity Check)
shcvReplies Indicates the number of host connectivity replies for this host address."

type=long
access=read-only
default=0
Displayed(tab/group)=Replies (/Subscriber Host Connectivity Check)
shcvReplyTime Indicates the time of the last successful host connectivity check for this host address.

type=Date
access=read-only
default=0
Displayed(tab/group)=Reply Time (/Subscriber Host Connectivity Check)
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

retrieveManagedSubscriberHosts

Input Parameters:
retrieveManagedSubscriberHostsStruct : ressubscr.RetrieveManagedSubscriberHostsStruct - RetrievingSessionStruct of retrieving Managed Subscriber Hosts with desired siteId, hostType, serviceId, ipAddress, and macAddress. The retrievingSessionStruct must have set siteId, hostType, and serviceId.
timeout : long - (Optional) (Optional) The number of milliseconds to wait before receiving the results. If the results are not received in the given time, the method returns.
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) -
Exceptions:
ressubscr.ManagedSubscriberHost.retrieveManagedSubscriberHostsException
Supported Network Elements
7750 SR Supported from 14.0.R1
7450 ESS Supported from 14.0.R1