Overview Package Class Deprecated Help

ressubscr
SubscriberPccRuleEntry

Contains read-only information on the PCC-rules currently active in the system.

public class SubscriberPccRuleEntry

Properties
hostIpAddress The IP address of this subscriber host

type=InetAddress
access=read-only
Displayed(tab/group)=Host IP Address (/Subscriber Information)
hostIpAddressType The IP address type for this subscriber host

type=rtr.InetAddressType
access=read-only
ipv4AddressType Specifies the address type of the IPv6 Address.

type=rtr.InetAddressType
access=read-only
default=ipv4
ipv6AddressType Specifies the address type of the IPv6 Address.

type=rtr.InetAddressType
access=read-only
default=ipv6
macAddress The MAC address of the subscriber host.

type=MacAddress
access=read-only
Displayed(tab/group)=Host MAC Address (/Subscriber Information)
pccRuleIndex Indicates the PCC rule index for the given host. The PCC Rules are applied in order of this index

type=long
access=read-create
Mandatory on create
pccRulePrecedence Indicates the PCC rule precedence for the given host. The different pcc-rules for a host are applied in order of increasing precedence, i.e. the lowest precedence is the first pcc-rule applied

type=long
access=read-only
Displayed(tab/group)=Precedence (/Subscriber Information)
pccRuleSubSvcName Indicates the name of the subscriber service with which the PCC-rule is associated. An empty string indicates that the PCC-rule is not part of a subservice for this host

type=string
access=read-only
Displayed(tab/group)=Subscriber Service (/Subscriber Information)
portId The Access Interface SNMP port ID.

type=long
access=read-only
pppoeSessionId Thef PPPoE session id of this subscriber host is connected with. 0 is if this is not a PPPoE based host

type=long
access=read-only
ressubscr.SubscriberPccRuleFlowEntry-Set type=Children-Set
sapEncapValue The combined encapsulation value of the SAP.

type=long
access=read-only
siteId System IP address of the node where PCC Rule exists.

type=InetAddress
access=read-create
default=
Mandatory on create
siteIdAddressType

type=rtr.InetAddressType
access=read-create
default=ipv4
siteName

type=string
access=read-only
default=
maximum=252
subPCCRuleDirection The value of subPCCRuleDirection indicates the flow direction on which the PCC-rule acts

type=ressubscr.DirectionType
access=read-only
Displayed(tab/group)=Flow Direction
subPccRuleForwardAction The value of subPccRuleForwardAction indicates the the forwarding action of the PCC-rule

type=ressubscr.SubPccRuleForwardActionType
access=read-only
default=none
Displayed(tab/group)=Forward Action
subPccRuleKey The value of subPccRuleKey indicates a system wide unique identifier assigned by the system to each PCC-rule

type=long
access=read-create
Mandatory on create
Displayed(tab/group)=Rule Key
subPccRuleMonitoringKey If non NULL, the value of subPccRuleMonitoringKey indicates the monitoring key defined in this PCC-rule. This value is only taken into account if the bit 'monitor' is set in the object subPccRuleQosAction

type=string
access=read-only
minimum=0
maximum=80
Displayed(tab/group)=Monitoring Key
subPccRuleName The value of subPccRuleName indicates the PCC rule name. The name of a PCC rule must however not be unique in the system

type=string
access=read-create
minimum=1
maximum=100
Mandatory on create
Displayed(tab/group)=Rule Name
subPccRuleNbrFlows The value of SubPccRuleNbrFlows indicates how many flow rules are defined in this PCC-rule

type=int
access=read-only
Displayed(tab/group)=Number of Rules
subPccRuleQosAction The value of subPccRuleQosAction indicates the Qos action of the PCC-rule

type=ressubscr.SubPccRuleQosActionType
access=read-only
Displayed(tab/group)=QoS Action
subPccRuleRateLimCirDwns The value of subPccRuleRateLimCirDwns indicates the CIR that will be applied to all downstream data flows that pertain to this PCC-rule. This value is only taken into account if the bit 'rateLimit' is set in the object subPccRuleQosAction

type=long
access=read-only
units=kbps
Displayed(tab/group)=Downstream CIR
subPccRuleRateLimCirUps The value of subPccRuleRateLimCirUps indicates the CIR that will be applied to all upstream data flows that pertain to this PCC-rule. This value is only taken into account if the bit 'rateLimit' is set in the object subPccRuleQosAction

type=long
access=read-only
units=kbps
Displayed(tab/group)=Upstream CIR
subPccRuleRateLimPirDwns The value of subPccRuleRateLimPirDwns indicates the PIR that will be applied to all downstream data flows that pertain to this PCC-rule. This value is only taken into account if the bit 'rateLimit' is set in the object subPccRuleQosAction

type=long
access=read-only
units=kbps
Displayed(tab/group)=Downstream PIR
subPccRuleRateLimPirUps The value of subPccRuleRateLimPirUps indicates the PIR that will be applied to all upstream data flows that pertain to this PCC-rule. This value is only taken into account if the bit 'rateLimit' is set in the object subPccRuleQosAction

type=long
access=read-only
units=kbps
Displayed(tab/group)=Upstream PIR
subPccRuleRedirIpv4Addr The value of subPccRuleRedirIpv4Addr indicates the IPv4 address to which all IPv4 data flows that pertain to this PCC-rule must be redirected. A value of all zero's indicate that no redirection address is present. This value is only taken into account if the object subPccRuleForwardAction is set to forward

type=InetAddress
access=read-only
Displayed(tab/group)=IPv4 Redirect Address
subPccRuleRedirIpv6Addr The value of subPccRuleRedirIpv6Addr indicates the IPv4 address to which all IPv6 data flows that pertain to this PCC-rule must be redirected. A value of all zero's indicate that no redirection address is present. This value is only taken into account if the object subPccRuleForwardAction is set to forward

type=InetAddress
access=read-only
Displayed(tab/group)=IPv6 Redirect Address
subPccRuleRedirUrl If non NULL, the value of subPccRuleRedirUrl indicates the URL to which all data flows that pertain to this PCC-rule must be redirected. This value is only taken into account if the object subPccRuleForwardAction is set to redirUrl

type=string
access=read-only
Displayed(tab/group)=Redirect URL
subPccRuleRedirectRouterV4 The value of subPccRuleRedirectRouterV4 indicates the service ID into which all IPv4 data flows that pertain to this PCC-rule must be routed. A value of all zero's indicate that no redirection service is present. This value is only taken into account if the object subPccRuleForwardAction is set to forward

type=long
access=read-only
Displayed(tab/group)=IPv4 Redirect Router
subPccRuleRedirectRouterV6 The value of subPccRuleRedirectRouterV6 indicates the service ID into which all IPv6 data flows that pertain to this PCC-rule must be routed. A value of all zero's indicate that no redirection service is present. This value is only taken into account if the object subPccRuleForwardAction is set to forward

type=long
access=read-only
Displayed(tab/group)=IPv6 Redirect Router
subPccRuleSetFC The value of subPccRuleSetFC indicates the forwarding class (FC) that will be assigned to all data flows that pertain to this PCC-rule. This value is only taken into account if the bit 'fcRemark' is set in the object subPccRuleQosAction

type=ressubscr.TFCType
access=read-only
Displayed(tab/group)=Forwarding Class
svcId The service ID.

type=long
access=read-only
Displayed(tab/group)=Service ID (/Subscriber Information)
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

retrievePccRule

Method used to query the NE for the PCC Rules
Input Parameters:
retrievePccRuleStruct : ressubscr.RetrievePccRuleStruct - retrievePccRuleStruct is used to pass in searching criteria to retrieve PCC Rule(s) from NE. siteId is mandatory in retrievePccRuleStruct.
retrievePccRuleFlowEntry : boolean - (Optional) Specifies if Flow Entries should be retrieved,the default is "true".
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.SubscriberPccRuleEntry.retrievePccRuleException

retrievePccRulesPerSubscrHost

Method used to query all PCC Rules used by a particular subscriber host present in the given NE.
Input Parameters:
subHostPccRuleInfoStruct : ressubscr.SubHostPccRuleStruct -
includeFlowsInRtrv : boolean - (Optional)
timeout : long - (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:
resultList : List (generic.CommonManagedEntityInformation) -
Exceptions:
ressubscr.SubscriberPccRuleEntry.retrievePccRulesPerSubscrHostException
Supported Network Elements
7750 SR Supported from 13.0.R4
7450 ESS Supported from 13.0.R4
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