Overview Package Class Deprecated Help

ressubscr
SubscriberHostConfiguration

Defines the configuration of a Residential Subscriber Host

public class SubscriberHostConfiguration

Properties
ancpString ASCII representation of DSLAM circuit ID

type=string
default=
minimum=0
maximum=63
Displayed(tab/group)=ANCP String (/Subscriber / SLA Profile Aliases)
appProfileString Mapped string to the application profile assigned to this subscriber host.

type=string
default=
minimum=0
maximum=16
Displayed(tab/group)=Application Profile String (/Subscriber / SLA Profile Aliases)
categoryMapName Indicates the value of the category map name received from either the DHCP or the Radius server.

type=string
access=read-only
default=
Displayed(tab/group)=Category Map Name (/Subscriber / SLA Profile Aliases)
evalLeaseState Indicates a request to re-evaluate the lease state. It is not possible to simultaneously request for a lease-state re-evaluation, and modify any of the SubscrProfile or SlaProfile values

type=generic.TruthValue
default=false
forwardingState The value of tmnxSubHostInfoFwdingState indicates the forwarding state of this subscriber host. When the value is 'outOfService', host traffic is not forwarded. When it is 'inService', host traffic is forwarded.

type=netw.OperationalState
access=read-only
default=unknown
Displayed(tab/group)=Forwarding State (/Subscriber Host Information)
intermediateDestId which intermediate destination (for example a DSLAM) this host belongs

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Intermediate Destination ID (/Subscriber / SLA Profile Aliases)
ipoeIndex Indicates the index of IPoE hosts. The value is equal to zero for other types of hosts.

type=long
default=0
Displayed(tab/group)=IPoE Session ID (/Subscriber Host Information)
ipoeTriggerType Indicates if this host is created as a result of an rtr solicit message or as linking from a DHCP6 lease.

type=ressubscr.IPoETriggerType
access=read-only
default=notApplicable
Displayed(tab/group)=IPoE Trigger Type
pppSessionIndex Indicates the index of PPP hosts. The value is equal to zero for other types of hosts.

type=long
default=0
retailerInterfaceId The value of tmnxSubHostInfoRetailerIf indicates the interface index of the retailer VPRN interface to which this subscriber host belongs. When this object is non zero, the subscriber host belongs to a retailer VPRN.

type=long
access=read-only
default=0
Displayed(tab/group)=Retailer Interface ID (/Business Subscriber)
retailerServiceId The value of tmnxSubHostInfoRetailerSvcId indicates the service ID of the retailer VPRN service to which this subscriber host belongs. When this object is non zero, the subscriber host belongs to a retailer VPRN.

type=long
access=read-only
default=0
Displayed(tab/group)=Retailer Service ID (/Business Subscriber)
secondSiteId System IP address of the second node in the case of dual home.

type=InetAddress
default=0.0.0.0
secondSiteIdAddrType

type=rtr.InetAddressType
default=ipv4

valid enums=ipv4 (Where parent is one of (ressubscr.ResidentialSubscriberInstance))
spiGroupId Indicates the group identifier. If the value of spiGroupType is equal to 'perSap', the value of spiGroupId is always equal to one. If the value of spiGroupType is equal to 'perGroup', the value of spiGroupId is a group identifier specified by an AAA server. If the value of spiGroupType is equal to 'perSessionPpp', the value of spiGroupId is a PPP session identifier, as indicated by the object PPP ID. If the value of spiGroupType is equal to 'perSessionIpoe', the value of spiGroupId is an IPoE session identifier, as indicated by the object IPoE ID."

type=long
access=read-create
default=1
spiGroupType Indicates the meaning of the spiGroupId.

type=ressubscr.SpiGroupType
access=read-create
default=perSap
subIdentPolicy specifies the subscriber identification policy applicable on this SAP

type=Pointer
default=
subscrAppProfileDisplayedName Displayed name of the subscriber Application profile assigned to this subscriber host.

type=string
access=read-only
default=
subscrAppProfilePointer Application Profile name assigned to this subscriber host.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Application Profile (/Profiles Information)
subscrProfileDisplayedName Displayed name of the subscriber profile assigned to this subscriber host.

type=string
access=read-only
default=
subscrProfilePointer Reference to the subscriber profile assigned to this subscriber host.

type=Pointer
default=
Displayed(tab/group)=Subscriber Profile (/Profiles Information)
subscrProfileString Mapped string to the subscriber profile assigned to this subscriber host.

type=string
default=
minimum=0
maximum=16
Displayed(tab/group)=Subscriber Profile String (/Subscriber / SLA Profile Aliases)
subscrSLAPointer Reference to the SLA Profile assigned to this subscriber host.

type=Pointer
default=
Displayed(tab/group)=SLA Profile (/Profiles Information)
subscrSLAProfileDisplayedName Displayed name of the subscriber SLA profile assigned to this subscriber host.

type=string
access=read-only
default=
subscrSLAString Mapped string to the subscriber sla profile assigned to this subscriber host.

type=string
default=
minimum=0
maximum=16
Displayed(tab/group)=SLA Profile String (/Subscriber / SLA Profile Aliases)
 
Overridden Properties
macAddress The MAC address of this subscriber host

pppoeSessionId The PPPoE session id of this subscriber host is connected with. 0 is this is not a PPPoE based host

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

 
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

evalLeaseStatePerSap

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.
aInPerSapParams : ressubscr.EvalLeaseStatePerSapStruct -
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 : ressubscr.EvalLeaseStatePerSapReturnStruct - Resulting objects list.
Exceptions:
ressubscr.SubscriberHostConfiguration.evalLeaseStatePerSapException

evalLeaseStatePerSapId

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.
aInSapId : string - The SAP FDN
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 : ressubscr.EvalLeaseStatePerSapReturnStruct - Resulting objects list.
Exceptions:
ressubscr.SubscriberHostConfiguration.evalLeaseStatePerSapIdException

updateMultipleSubscrHosts

Method used to force to change properties of the SubscriberHost. These properties are: subscriber profile, sla profile and application profile. Method is also used to force re-evaluation of lease state. Either change of subscriber profile, sla profile, application profile or re-evaluation of lease state can be requested at one time. This method can be used when serviceId is not known for a SubscriberHost, but subscrIdent, siteId and ipAddress must be known.
Input Parameters:
configs : List (generic.CommonManagedEntityConfigurationInformation) - List of configuration objects with desired values to configure the subscriber hosts. The configuration objects must also have the subscrIdent, siteId, ipAddressType and ipAddress been set in the config list. The macAddress value should be specified with hyphens as separators between the octets, for example, 00-80-21-AB-CD-EF. For non-pppoe hosts, pppoeSessionId should be set to 0. If you are not using a second site, please do not use the secondSiteId property. If the method is being used to configure multiple hosts then each host must have a separate block within ressubscr.SubscriberHostConfiguration tags.
timeout : long - The number of milliseconds to wait before receiving the results. If no results are 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:
resultList : List (generic.CommonManagedEntityInformation) - Resulting objects list.
Exceptions:
ressubscr.SubscriberHostConfiguration.updateMultipleSubscrHostsException
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