Overview Package Class Deprecated Help

ressubscr
SubscriberHost

Defines a Residential Subscriber Host

public class SubscriberHost

Properties
accessInterfacePointer Reference to the access interface that the host is connected with.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Access Interface (/Subscriber Host Network Information)
acctMultiSessId Indicates the RADIUS accounting multi session id for this subscriber host. This is the accounting session id of the SLA profile instance on a normal mda or the accounting session id of the subscriber on a hsmda

type=string
access=read-only
default=
Displayed(tab/group)=Accounting Multi-Session ID (Details/Host Accounting)
acctSessionId Indicates the RADIUS accounting session id for this subscriber host.

type=string
access=read-only
default=
Displayed(tab/group)=Accounting Session ID (Details/Host Accounting)
addressOrigin Indicates the origin of the subscriber host address. This object is only applicable for L3 subscriber hosts. NOTE: From NFM-P 17.12+ GUI, Origin type has changed on Global and Local Policy. This is only changed on enum displayed name, not the enum value.
  • "DHCP" is changed to "Dynamic"
  • "LUDB" is changed to "Static".
On SR CLI:
  • SR 15.R1+ CLI, dhcp -> dynamic, ludb -> static
  • SR pre-15.R1 CLI, these 2 are still shown as dhcp and ludb.
This change does not affect OSSI script when creating/modifying rp.FromCriteria object, i.e. dhcp and ludb should still be used in ALL SR versions.

type=ressubscr.AddressOrigin
access=read-only
default=notApplicable
Displayed(tab/group)=Address Origin (Details)
diamSessionId Indicates the identifier of the Diameter session associated with this subscriber host.

type=string
access=read-only
default=
minimum=0
maximum=102
Displayed(tab/group)=Diameter Session ID (Details)
egrFilter Indicates if and how for this host the egress filter specified in the SLA-profile is overruled.

type=long
default=0
egrFilterIdString Indicates if and how for this host the egress filter specified in the SLA-profile is overruled.

type=string
default=
Displayed(tab/group)=Egress Filter (Details/Override Filters)
egrFilterPointer

type=Pointer
access=read-only
default=
egrQosPolOverride Indicates ID of QoS Egress Policy used by this host

type=long
access=read-only
default=0
minimum=0
maximum=4294967295
egrQosPolOvrString Indicates the ID of QoS Egress Policy as string.

type=string
access=read-only
default=
Displayed(tab/group)=Egress (Details/QoS Policy Overrides)
egressQGroupName Indicates the port access egress queue group used by this subscriber host

type=string
access=read-only
default=
Displayed(tab/group)=Egress Q-Group (Details/Egress QoS)
egressVPortName Indicates the port access egress virtual port used by this subscriber host

type=string
access=read-only
default=
Displayed(tab/group)=Egress Vport (Details/Egress QoS)
encapValue Encapsulation value used to identify this SAP on the access port specified by portId.

type=long
access=read-only
default=0
gtpLclBrkout Indicates if this host is a GTP (GPRS Tunnel Protocol) host with a local break-out.

type=boolean
access=read-only
default=false
Displayed(tab/group)=GTP Local Breakout (Details)
ingFilter Indicates if and how for this host the ingress filter specified in the SLA-profile is overruled

type=long
default=0
ingFilterIdString Indicates if and how for this host the ingress filter specified in the SLA-profile is overruled

type=string
default=
Displayed(tab/group)=Ingress Filter (Details/Override Filters)
ingFilterPointer

type=Pointer
access=read-only
default=
ingQosPolOverride Indicates the ID of QoS Ingress Policy used by this host.

type=long
access=read-only
default=0
minimum=0
maximum=4294967295
ingQosPolOvrString Indicates the ID of QoS Ingress Policy as string.

type=string
access=read-only
default=
Displayed(tab/group)=Ingress (Details/QoS Policy Overrides)
mld.MldHost-Set type=Children-Set
nat.L2AwHosts-Set type=Children-Set
oneTimeHttpRedirectFilter Indicates if and how for this host the one-time Http redirect filter specified in the SLA-profile is overruled

type=long
default=0
Displayed(tab/group)=One-Time HTTP Redirect Filter (Details/Override Filters)
oneTimeHttpRedirectFilterPointer

type=Pointer
access=read-only
default=
oneTimeHttpRedirectSource Indicates the source of One-Time HTTP redirection for this host

type=ressubscr.HttpRdrSource
access=read-only
Displayed(tab/group)=One-Time HTTP Redirect Source (Details/Override Filters)
oneTimeHttpRedirectState Indicates the state of One-Time HTTP redirection for this host

type=ressubscr.HttpRdrState
access=read-only
Displayed(tab/group)=One-Time HTTP Redirect Status (Details/Override Filters)
oneTimeHttpRedirectUrlOverride The value of oneTimeHttpRedirectUrlOverride indicates a possible override of the HTTP redirect URL for this host.

type=string
access=read-only
default=
minimum=0
maximum=255
Displayed(tab/group)=HTTP Redirect URL Override (Details/Override Filters)
portId Port ID of the access interface that the host is connected with.

type=long
access=read-only
default=0
remainLeaseTime Indicates the remaining lease time of the DHCP lease state.

type=long
access=read-only
default=0
Displayed(tab/group)=Remaining Lease Time (/Subscriber Host Connectivity Information)
ressubscr.DhcpLeaseState-Set type=Children-Set
ressubscr.SubSlaacHost-Set type=Children-Set
ressubscr.SubscriberHostCreditReset-Set type=Children-Set
ressubscr.SubscriberPccRuleEntry-Set type=Children-Set
ressubscr.SubscriberService-Set type=Children-Set
shcvOperState Indicates the state of the subscriber host connectivity check for this DHCP lease state.

type=ressubscr.ShcvOperState
access=read-only
default=undefined
Displayed(tab/group)=SHCV Operational State (/Subscriber Host Connectivity Information)
wlangw.WlanGwUe-Set type=Children-Set
wpp.WppDhcpLease-Set type=Children-Set
 
Overridden Properties
ipoeIndex Indicates the index of IPoE hosts. The value is equal to zero for other types of hosts.

access=read-only
macAddress The MAC address of this subscriber host

access=read-create
pppoeSessionId The PPPoE session id of this subscriber host is connected with. 0 is this is not a PPPoE based host

access=read-create
serviceId Service ID for service to which belongs the access interface that the host is connected with.

access=read-create
 
Properties inherited from ressubscr.SubscriberHostConfiguration
ancpString, appProfileString, categoryMapName, evalLeaseState, forwardingState, intermediateDestId, ipoeIndex, ipoeTriggerType, macAddress, pppSessionIndex, pppoeSessionId, retailerInterfaceId, retailerServiceId, secondSiteId, secondSiteIdAddrType, serviceId, spiGroupId, spiGroupType, subIdentPolicy, subscrAppProfileDisplayedName, subscrAppProfilePointer, subscrProfileDisplayedName, subscrProfilePointer, subscrProfileString, subscrSLAPointer, subscrSLAProfileDisplayedName, subscrSLAString
 
Properties inherited from ressubscr.AbstractSubscriberHost
hostEncapVal, hostPortId, ipAddress, ipAddressPrefixLength, ipAddressType, macAddress, pppoeSessionId, serviceId, siteId, siteIdAddressType, subscrHostOrigin, subscrIdent
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

findSlaProfileStringSuggestions

Method used to retrieve a L2TP session from NE.
Input Parameters:
aInHostInfo : generic.CommonManagedEntityConfigurationInformation -
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.SubscriberHost.findSlaProfileStringSuggestionsException

retrieveL2TPSession

Method used to retrieve a L2TP session from NE.
Input Parameters:
l2tpSessionRetrievalStruct : ressubscr.L2TPSessionRetrievalStruct -
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.SubscriberHost.retrieveL2TPSessionException

retrieveSAPHosts

Method used to query the NE for the currently active subscriber hosts for a specified SAP. Additionally, the L2 Aware Host information will be returned in the output when GTP Local Breakout is "true" for the host and when the MAC Address and IP Address are specified in the request.
Input Parameters:
aInServiceId : long - Service ID for the service that is used by the subscriber host.
aInPortId : long - The Port identification where the subscriber host is connected to.
aInEncapValue : long - Combined inner and outer encapsulation value for the Access Interface that is used by the subscriber host.
aInSiteId : string - Specifies the NE to which the host is connected with.
additionalStateInfo : boolean - Specifies if retrieval of connectivity info and lease state is also desired.
timeout : long - The number of milliseconds to wait before receiving the results. If no results are received in the given time, the method returns.
aInCrdtCtrlOperValues : boolean - (Optional) Specifies if retrieval of credit control operation values is also desired.
aInHostIpAddr : InetAddress - (Optional) Specifies Host IP address. This is optional field.
aInHostMacAddr : string - (Optional) Specifies Host MAC address. This is optional field. The field is only applied when aInHostIpAddress is specified.
retrieveQoSOvr : boolean - (Optional) Specifies if Sub SLAAC QoS Override should be retrieved,the default is "true". It won't be retrieved if ESM System preferences "retrieveQoSOvr" is false.
retrieveSlaacAddr : boolean - (Optional) Specifies if retrieval of subscriber SLAAC host addresses is also desired. This is an optional input parameter. The default value is true. The SLAAC Host Address retrieval will be performed only on "retrieveSlaacAddr" is true for the method and "retrieveSlaacHostAddr" is true for the ResidentialSubscriberManager.
retrieveBgpPeerInfo : boolean - (Optional) Specifies if Sub SLAAC BGP Peer Info should be retrieved,the default is "true". It won't be retrieved if ESM System preferences "retrieveBgpPeerInfo" is false.
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 the subscriber hosts retrieved from the node(CommonManagedEntityInformation).
Exceptions:
ressubscr.SubscriberHost.retrieveSAPHostsException -

retrieveSubscriberHosts

Method used to query the NE for the currently active subscriber hosts for a specified subscriber.
Input Parameters:
aInSubscrId : string - Subscriber Identifier for the Residential Subscriber.
aInSiteId : string - Specifies the NE to which the subscriber host is connected with. This is an optional input parameter. If specified as 0.0.0.0 all the NEs where the subscriber represented by aInSubscrId exists will be queried.
aInAdditionalStateInfo : boolean - Specifies if retrieval of connectivity info and lease state is also desired.
timeout : long - The number of milliseconds to wait before receiving the results. If no results are received in the given time, the method returns.
aInCrdtCtrlOperValues : boolean - (Optional) Specifies if retrieval of credit control operation values is also desired.
retrieveQoSOvr : boolean - (Optional) Specifies if Sub SLAAC QoS Override should be retrieved,the default is "true". It won't be retrieved if ESM System preferences "retrieveQoSOvr" is false.
retrieveSlaacAddr : boolean - (Optional) Specifies if retrieval of subscriber SLAAC host addresses is also desired. This is an optional input parameter. The default value is true. The SLAAC Host Address retrieval will be performed only on "retrieveSlaacAddr" is true for the method and "retrieveSlaacHostAddr" is true for the ResidentialSubscriberManager.
retrieveBgpPeerInfo : boolean - (Optional) Specifies if Sub SLAAC BGP Peer Info should be retrieved,the default is "true". It won't be retrieved if ESM System preferences "retrieveBgpPeerInfo" is false.
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 Subscriber Hosts (CommonManagedEntityInformation) that were retrieved from the node.
Exceptions:
ressubscr.SubscriberHost.retrieveSubscriberHostsException -
Methods inherited from ressubscr.SubscriberHostConfiguration
evalLeaseStatePerSap, evalLeaseStatePerSapId, updateMultipleSubscrHosts
 
Supported Network Elements
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7450 ESS
Product Specifics
7450 ESS 20.0
7450 ESS 21.0
7450 ESS 22.0
7450 ESS 23.0
7450 ESS 24.0
7450 ESS 25.0
7705 SAR Gen 2 25.0
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0