Overview Package Class Deprecated Help

ressubscr
ResidentialSubscriberInstance

DEPRECATED: 11.0 R1 - WARNING: Residential Subscriber Instance objects and related methods are subject to change.

The objects can be referenced through XML API but such usage might not be compatible with future releases.

Defines a Residential Subscriber Instance

public class ResidentialSubscriberInstance

Stats:
aapolicy.BsxAaSubAccountingStats aapolicy.BsxAaSubUsageMonitoringStats ancp.AncpSubMonitorStats isa.AaSubSumStats ressubscr.BsxSubCustRecAppGrpStats ressubscr.BsxSubCustRecAppGrpUsageMonStats ressubscr.BsxSubCustRecAppStats ressubscr.BsxSubCustRecAppUsageMonStats ressubscr.BsxSubCustRecChargingGrpUsageMonStats ressubscr.BsxSubCustRecProtStats ressubscr.BsxSubStudyAppStats ressubscr.BsxSubStudyProtStats ressubscr.HostTrackStats ressubscr.PerSLAEgrQosSchedStats ressubscr.PerSLAProfInstEgrPBondStats ressubscr.PerSLAProfInstEgrPStats ressubscr.PerSLAProfInstEgrPV4V6Stats ressubscr.PerSLAProfInstEgrQStats ressubscr.PerSLAProfInstEgrQV4V6Stats ressubscr.PerSLAProfInstIngPStats ressubscr.PerSLAProfInstIngPV4V6Stats ressubscr.PerSLAProfInstIngQStats ressubscr.PerSLAProfInstIngQV4V6Stats ressubscr.PerSLAProfInstStats ressubscr.SLAEgrQosSchedStats ressubscr.SLAProfInstEgrPBondStats ressubscr.SLAProfInstEgrPStats ressubscr.SLAProfInstEgrPV4V6Stats ressubscr.SLAProfInstEgrQStats ressubscr.SLAProfInstEgrQV4V6Stats ressubscr.SLAProfInstIngPStats ressubscr.SLAProfInstIngPV4V6Stats ressubscr.SLAProfInstIngQStats ressubscr.SLAProfInstIngQV4V6Stats ressubscr.SLAProfInstStats ressubscr.SubEgrQosArbiterStats ressubscr.SubEgrQosSchedStats ressubscr.SubIngQosArbiterStats ressubscr.SubIngQosSchedStats ressubscr.SubscriberEgrOverrideCounterStats ressubscr.SubscriberEgrOverrideCounterV4V6Stats ressubscr.SubscriberEgrPStats ressubscr.SubscriberEgrQStats ressubscr.SubscriberEgrQV4V6Stats ressubscr.SubscriberHsmdaStats ressubscr.SubscriberHsmdaV4V6Stats ressubscr.SubscriberIngPStats ressubscr.SubscriberIngPV4V6Stats ressubscr.SubscriberIngQStats ressubscr.SubscriberIngQV4V6Stats service.CompleteSubscriberEgressPacketOctets service.CompleteSubscriberEgressPacketOctetsOC service.CompleteSubscriberIngressPacketOctets service.CompleteSubscriberIngressPacketOctetsOC

Properties
aaGrpId Specifies the groupId of the application profile corresponding to appProfilePointer.

type=int
default=1
aaPartId Specifies the partitionId of the application profile corresponding to appProfilePointer.

type=int
default=0
activeLastChange Timestamp for the last detected change of the Residential Subscriber Instance.

type=Date
access=read-only
default=0
Displayed(tab/group)= Last Active State Change (/Residential Subscriber State)
ancp.AncpSubscriberLineRates-Set type=Children-Set
ancpString ASCII representation of DSLAM circuit ID

type=string
access=read-only
minimum=0
maximum=63
Displayed(tab/group)=ANCP String
appProfilePointer Application Profile name, not a reference to full name of the object.

type=string
access=read-only
default=
minimum=0
maximum=32
Displayed(tab/group)=Application Profile
arp.ArpHost-Set type=Children-Set
clear.ClearRequest-Set type=Children-Set
creationTime Timestamp for the creation of the Residential Subscriber Instance object.

type=Date
access=read-only
default=0
Displayed(tab/group)=Residential Subscriber Creation (/Residential Subscriber State)
egrAggRateLimit The value indicates the intended egress aggregate rate limit, regardless of its origin. The value -1 means maximum rate. A value of -2 specifies no override

type=int
access=read-only
default=-1
units=kbps
Displayed(tab/group)=Operational Egress Aggregate Rate Limit
egrAggRateLimitLow Specifies if the system has reset the requested egress aggregate rate limit to its reserved minimum value.

type=boolean
access=read-only
Displayed(tab/group)=Egress Aggregate Rate Limit Low
egrSecShaper The value indicates the interpretation of the intermediateDestId.

type=ressubscr.EgrSecShaperType
access=read-only
default=unused
Displayed(tab/group)=Egress Secondary Shaper
hsSecondaryShaper Specifies HS Secondary Shaper for the Subscriber

type=string
access=read-only
default=
Displayed(tab/group)=HS Secondary Shaper (/HS)
hsSubProfEgrAggRateLimit Specifies the maximum total rate of all egress HS queues for the subscriber. The value '-1' means that there is no limit.

type=int
access=read-only
default=-1
minimum=-1
maximum=100000000
Displayed(tab/group)=Egress Aggregated Rate Limit (/HS)
hsSubProfileSlaMode Specifies the Subscriber Profile SLA profile handling mode for this subscriber if on a HS board

type=subscrprofile.HsSlaMode
access=read-only
default=expanded
Displayed(tab/group)=SLA Mode (/HS)
igmp.IgmpHost-Set type=Children-Set
intermediateDestId which intermediate destination (for example a DSLAM) this host belongs

type=string
access=read-only
minimum=0
maximum=32
Displayed(tab/group)=Intermediate Destination ID
isActive

type=boolean
access=read-only
default=true
Displayed(tab/group)=Active (/Residential Subscriber State)
lastResyncTime Timestamp for the last resync time of the Residential Subscriber Instance object.

type=Date
access=read-only
default=0
Displayed(tab/group)= Last Resync Time (/Residential Subscriber State)
mld.MldHost-Set type=Children-Set
natPolicyPointer Reference to the NAT policy that is used for this subscriber

type=Pointer
access=read-only
default=
Displayed(tab/group)=NAT Policy
newSubscrIdent The new identifier for this subscriber

DEPRECATED: 20.2 R1- This parameter is no longer used by supported model releases.
type=string
minimum=1
maximum=32
overrides Map of overrides of default custom property values.

type=Map (Pointer to string)
radEgrAggRateLimit The value indicates the egress aggregate rate limit override received by RADIUS. The value -1 means maximum rate. A value of -2 specifies no override

type=int
access=read-only
default=-2
units=kbps
Displayed(tab/group)=RADIUS Egress Aggregate Rate Limit
ressubscr.DhcpLeaseState-Set type=Children-Set
ressubscr.HostTrackingInfoPerSubscriber-Set type=Children-Set
ressubscr.HostTrackingStatus-Set type=Children-Set
ressubscr.SlaProfileInstance-Set type=Children-Set
ressubscr.SubMcastCacStatus-Set type=Children-Set
ressubscr.SubscriberHost-Set type=Children-Set
ressubscr.SubscriberHostConfiguration-Set type=Children-Set
ressubscr.SubscriberHostCreditReset-Set type=Children-Set
ressubscr.SubscriberHostForceRenew-Set type=Children-Set
ressubscr.SubscriberQosOverride-Set type=Children-Set
ressubscr.SubscriberVirtualSubnet-Set type=Children-Set
siteId System IP address of the node where subscriber exists.

type=InetAddress
access=read-create
Mandatory on create
Displayed(tab/group)=Site ID (/Site)
siteIdAddressType

type=rtr.InetAddressType
access=read-create
Mandatory on create
siteName

type=string
access=read-only
default=
maximum=252
Displayed(tab/group)=Site Name (/Site)
subscrIdent Unique identifier for this subscriber

type=string
access=read-create
minimum=1
maximum=64
Mandatory on create
Displayed(tab/group)=Subscriber Identification
subscrProfilePointer Reference to the subscriber profile that is identified for this subscriber

type=Pointer
access=read-only
default=
Displayed(tab/group)=Subscriber Profile
subscribedAppProfile Subscribed Application Profile Name, if Application Profile Name is temporarily changed. Note that this property can be set to any string; it is NOT constrained by the set of provisioned application profiles.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Subscribed Application Profile
volStatsType Specifies what volume statistics are used for accounting in this residential subscriber instance. The value "default" configures the subscriber host octets reporting to be based on layer-2 stats including data layer overhead. The value "ip" configures the subscriber host octets reporting to include ip packet (layer 3).

DEPRECATED: 14.0 - Unused. Always return default
type=ressubscr.SubProfVolStatsType
access=read-only
default=default
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

clearSubscriberHostDhcp6LeaseState

Request clearing the Dynamic DHCPv6 lease state for the specified IPv6 address and optional prefix length. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager.
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.
clearDhcp6LeaseStateConfig : ressubscr.ClearDhcp6LeaseStateConfiguration - clearDhcp6LeaseStateConfig of subscriber dynamic host objects with desired serviceId and IPv6 address whose values are used to be cleared. The configuration objects must have set siteId, serviceId, subscrIdent and ipv6Address. ipv6AddressPrefixLength is optional.
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:
aOutResult : clear.RequestHandleStruct - A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.
Exceptions:
ressubscr.ResidentialSubscriberInstance.clearSubscriberHostDhcp6LeaseStateException

clearSubscriberHostLeaseState

Request clearing the Dynamic DHCP lease state for the specified IP address. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager.
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.
clearDhcpLeaseStateConfig : ressubscr.ClearDhcpLeaseStateConfiguration - clearDhcpLeaseStateConfig of subscriber dynamic host objects with desired serviceId and IP address whose values are used to be cleared. The configuration objects must have set subscrIdent, siteId, ipAddress, subscrIdent.
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:
aOutResult : clear.RequestHandleStruct - A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.

requestClearHostIgmpHostTracking

Request clearing of the IGMP Host Tracking information for a specific host of the Subscriber instance. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager.
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.
clearHostStruct : ressubscr.ClearHostStruct - Structure with parameters identifying the host for which the Host Tracking information should be cleared.. Setting of subscrIdent is NOT required.
aInOnlyStats : boolean - Whether to clear the IGMP Host Tracking statistics only (host tracking info is not cleared).
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:
aOutResult : clear.RequestHandleStruct - A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.

requestClearIgmpHostTracking

Request clearing of all IGMP Host Tracking information for this Subscriber instance. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager.
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.
aInOnlyStats : boolean - Whether to clear the IGMP Host Tracking statistics only (host tracking info is not cleared).
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:
aOutResult : clear.RequestHandleStruct - A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.

retrieveL2tpTunnels

Method used to retrieve L2TP tunnel endpoint information on LNS from LAC.
Input Parameters:
tunnelRetrievalStruct : ressubscr.L2TPTunnelRetrievalStruct -
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.ResidentialSubscriberInstance.retrieveL2tpTunnelsException

retrieveResidentialSubscriber

Method used to retrieve Residential Subscriber Instance information from the network
Input Parameters:
subscrIdent : string - Unique identification of subscriber instance.
siteId : string - The site ID of the NE to query.
timeout : long - (Optional) The number of milliseconds to wait before receiving the results. If no results are received in the given time, the method returns.
shallowRetrieval : boolean - (Optional) If it is true, not all of the properties are retrieved for quick response This is an optional input parameter. The default value 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 : generic.CommonManagedEntityInformation -
Exceptions:
ressubscr.ResidentialSubscriberInstance.retrieveResidentialSubscriberException

retrieveSubscriberVirtualSubnets

Method to retrieve Subscribe rVirtual Subnets.
Input Parameters:
aInRetrievingVirtualSubnetStruct : ressubscr.RetrievingVirtualSubnetStruct -
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:
resultList : List (generic.CommonManagedEntityInformation) -
Exceptions:
ressubscr.ResidentialSubscriberInstance.retrieveSubscriberVirtualSubnetsException
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 (all versions)
7705 SAR Gen 2 25.0
7750 SR (all versions)
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0