| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| creditControlPlcy |
Indicates the credit control policy.
type=string access=read-only Displayed(tab/group)=Credit Control Policy |
| creditExpired |
Indicates whether credit has expired.
type=generic.TruthValue access=read-only Displayed(tab/group)=Credit Expired |
| creditNegotiating |
Indicates whether credit is being negotiated.
type=generic.TruthValue access=read-only Displayed(tab/group)=Credit Negotiating |
| creditReset |
Indicates a request to reset the credit.
type=generic.TruthValue default=false |
| creditTimeAvail |
Indicates the time based credit available.
type=long access=read-only default=0 Displayed(tab/group)=Credit Time Available |
| creditTimeThres |
Indicates the time based credit threshold.
type=long access=read-only default=0 Displayed(tab/group)=Credit Time Threshold |
| creditTimeUsed |
Indicates the time based credit used.
type=long access=read-only default=0 Displayed(tab/group)=Credit Time Used |
| creditVolumeAvail |
Indicates the volume based credit available.
type=long access=read-only default=0 Displayed(tab/group)=Credit Volume Available |
| creditVolumeAvailEgr |
Indicates the volume based credit available for egress packets.
type=long access=read-only default=0 Displayed(tab/group)=Egress Credit Volume Available |
| creditVolumeAvailIng |
Indicates the volume based credit available for ingress packets.
type=long access=read-only default=0 Displayed(tab/group)=Ingress Credit Volume Available |
| creditVolumeThres |
Indicates the volume based credit threshold.
type=long access=read-only default=0 Displayed(tab/group)=Credit Volume Threshold |
| creditVolumeUsed |
Indicates the volume based credit used.
type=long access=read-only default=0 Displayed(tab/group)=Credit Volume Used |
| creditVolumeUsedEgr |
Indicates the volume based credit used by egress packets.
type=long access=read-only default=0 Displayed(tab/group)=Egress Credit Volume Used |
| creditVolumeUsedIng |
Indicates the volume based credit used by ingress packets.
type=long access=read-only default=0 Displayed(tab/group)=Ingress Credit Volume Used |
| ctgryMapName |
Indicates the credit category map.
type=string access=read-only Displayed(tab/group)=Category Map Name |
| ctgryName |
Indicates the credit category.
type=string Displayed(tab/group)=Category Name |
| efhTimeCurrUnrep |
Indicates the used time based credit, that will be reported to the OCS,
while the EFH state is active for this diameter session.
type=long access=read-only default=0 Displayed(tab/group)=Current Time (/Extended Failure Handling (EFH) Unreported Credit) |
| efhTimeTotalUnrep |
Indicates the total used time based credit, that will be reported to the OCS,
of all the periods that the diameter session was in EFH mode.
type=long access=read-only default=0 Displayed(tab/group)=Total Time (/Extended Failure Handling (EFH) Unreported Credit) |
| efhVolumeCurrUnrep |
Indicates the used volume based credit, that is not yet reported to the OCS,
while the EFH state is active for this diameter session."
type=long access=read-only default=0 Displayed(tab/group)=Current Volume (/Extended Failure Handling (EFH) Unreported Credit) |
| efhVolumeTotalUnrep |
Indicates the total used volume based credit, that is not yet reported to the OCS,
of all the periods that the diameter session was in EFH mode.
type=long access=read-only default=0 Displayed(tab/group)=Total Volume (/Extended Failure Handling (EFH) Unreported Credit) |
| encapValue |
Encap value of the node to which the subscriber host is connected to.
type=long default=0 |
| ipAddress |
The IP address of this subscriber host
DEPRECATED: 12.0.R1 - property never used type=InetAddress default=0.0.0.0 |
| ipAddressType |
The IP address type for this subscriber host
DEPRECATED: 12.0.R1 - property never used type=rtr.InetAddressType default=ipv4 |
| macAddress |
The MAC address of the subscriber host.
DEPRECATED: 12.0.R1 - property never used type=MacAddress default=00-00-00-00-00-00 |
| outOfCreditAction |
Indicates what will happen when credit gets exhausted.
type=crdtctrl.ActionType access=read-only Displayed(tab/group)=Out Of Credit Action |
| ovrdHttpRdrUrl |
type=string access=read-only default= Displayed(tab/group)=Override HTTP Redirect URL |
| portId |
Port id of the node to which the subscriber host is connected to.
type=long default=0 |
| pppoeSessionId |
The PPPoE session id of this subscriber host is connected with. 0 is this is not a
PPPoE based host
DEPRECATED: 12.0.R1 - property never used type=long default=0 |
| quotaHoldingTime |
Indicates the time based credit threshold.
type=long access=read-only default=0 Displayed(tab/group)=Quota Holding Time |
| serviceId |
The service ID.
type=long default=0 |
| siteId |
System IP address of the node to which the subscriber host is connected to.
type=InetAddress default=0.0.0.0 |
| siteIdAddrType |
type=rtr.InetAddressType default=ipv4 |
| 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 default=1 |
| spiGroupType |
Indicates the meaning of the spiGroupId.
type=ressubscr.SpiGroupType default=perSap |
| subscrIdent |
Unique identifier for this subscriber
type=string |
| subscrSLAProfileDisplayedName |
Displayed name of the subscriber SLA profile assigned to this subscriber host.
type=string default= |
| validityTimeAvail |
Indicates the time left from the validity time of the granted service units.
When the service units are granted by the Online Charging Server (OCS),
the validity time is provided by the OCS.
type=long access=read-only default=0 Displayed(tab/group)=Validity Time Available |
| validityTimeUsed |
Indicates the used portion of the validity time of the granted service units.
When the service units are granted by the Online Charging Server (OCS),
the validity time is provided by the OCS.
type=long access=read-only default=0 Displayed(tab/group)=Validity Time Used |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |
| Methods |
|---|
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.
configs
: List (generic.CommonManagedEntityConfigurationInformation) -
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
ressubscr.SubscriberHostCreditReset.resetCreditException
| Supported Network Elements | |
|---|---|
| 7750 SR | Supported from 7.0.R3 |
| 7450 ESS | Supported from 7.0.R3 |
| 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 | |
| 7750 SR 20.0 | |
| 7750 SR 21.0 | |
| 7750 SR 22.0 | |
| 7750 SR 23.0 | |
| 7750 SR 24.0 | |
| 7750 SR 25.0 | |