Overview Package Class Deprecated Help

subscrprofile
Policy

public class Policy

Properties
accountingOn Collect Accounting Statistics if the value is true

type=boolean
default=false
Displayed(tab/group)=Accounting Enabled (/Accounting Policy)
accountingPolicyObjectPointer Pointer to an Accounting Policy

type=Pointer
default=
Displayed(tab/group)=Accounting Policy ID (/Accounting Policy)
acctSessOptimStop Specifies whether the stop behavior is optimized for session accounting.

type=boolean
default=false
Displayed(tab/group)=Optimize for Session Accounting (RADIUS Accounting/RADIUS Accounting Policies)
adaptationRule Specifies the adaptation rule for the operational PIR value when an aggregate shaper is used for the subscriber.

type=qos.RateAdaptationRule
default=closest
Displayed(tab/group)=Adaptation Rule (Scheduling/Egress Aggregate Rate Limit)
ancpPolicy Pointer specifies the ANCP Policy applicable to this host

type=Pointer
default=
Displayed(tab/group)=ANCP Policy (/ANCP Policy)
burstLimit Specifies the burst size when an aggregate shaper is used for the subscriber

type=int
default=-1
minimum=-1
maximum=14000000
units=bytes
Displayed(tab/group)=Burst Limit (Scheduling/Egress Aggregate Rate Limit)
duplicateRadiusAccountingPolicyObjectPointer Specifies the RADIUS Accounting policy to be used for generating duplicate accounting information.

type=Pointer
default=
Displayed(tab/group)=Policy #2 (RADIUS Accounting/RADIUS Accounting Policies)
egrPolicerPolicyObjPointer Policer Policy applicable to Subscriber profile

type=Pointer
default=
Displayed(tab/group)=Policer Control Policy (Policer Control/Egress Policer Control Policy)
egrSubProfPCtrlOvrMaxRate Specifies the maximum frame based bandwidth limit of this policer.

type=int
default=-2
minimum=-2
maximum=2000000000
units=kbps
Displayed(tab/group)=Maximum Frame Based Bandwidth (Policer Control/Egress Policer Control Policy Override)
egrSubProfPCtrlOvrMinMBSSep Specifies the minimum amount of separation buffer space (in bytes) allowed by this policer.

type=int
default=-2
minimum=-2
maximum=16777216
units=bytes
Displayed(tab/group)=Minimum Separation Buffer Space (Policer Control/Egress Policer Control Policy Override)
egressAggRateLimit Specifies the maximum total rate of all egress queues for this subscriber. The value -1 means that there is no limit.

type=int
default=-1
minimum=-1
maximum=800000000
units=kbps
Displayed(tab/group)=Aggregate Rate Limit (Scheduling/Egress Aggregate Rate Limit)
egressHsAggRateLimit Specifies the maximum total rate of all egress HS queues for the subscriber. The value '-1' means that there is no limit.

type=int
default=-1
minimum=-1
maximum=100000000
units=kbps
Displayed(tab/group)=HS Aggregate Rate Limit (Scheduling/HS Egress Aggregate Rate Limit)
egressHsResvBw Specifies the mimimum reserved peak rate of all egress HS queues for this subscriber. A non zero value of egressHsResvBw must be lower than a positive value of egressHsAggRateLimit.

type=int
default=1
minimum=0
maximum=100000000
units=kbps
Displayed(tab/group)=HS Minimum Reserved Bandwidth (Scheduling/HS Egress Aggregate Rate Limit)
egressHsmdaResvBw Specifies the mimimum reserved peak rate of all egress HSMDA queues for this subscriber. A non zero value of egressHsmdaResvBw must be lower than a positive value of hsmdaEgressAggRateLimit.

DEPRECATED: 21.2 R1- This parameter is no longer supported by SR.
type=int
default=1
minimum=0
maximum=100000000
units=kbps
Displayed(tab/group)=Minimum Reserved Bandwidth (HSMDA QoS/Egress)
egressQosPolicyObjPointer Specifies the identifier of the SAP egress QOS policy for HSMDA subscribers.

DEPRECATED: 21.2 R1- This parameter is no longer supported by SR.
type=Pointer
default=Access Egress:1
Displayed(tab/group)=Egress Policy (HSMDA QoS/Egress)
egressQosSchedObjPointer Pointer to Qos Egress Scheduler Policy

type=Pointer
default=
Displayed(tab/group)=Egress Scheduler (Scheduling/Egress)
egressResvBw Specifies the mimimum reserved peak rate of all egress queues for this subscriber. A non zero value of egressResvBw must be lower than a positive value of egressAggRateLimit.

type=int
default=1
minimum=0
maximum=800000000
units=kbps
Displayed(tab/group)=Minimum Reserved Bandwidth (Scheduling/Egress Aggregate Rate Limit)
encapOffset Specifies the fixed packet offset.

type=qos.EncapsOffsetType
default=none
Displayed(tab/group)=Encapsulation Offset (Scheduling/Egress Aggregate Rate Limit)
encapOffsetMode Specifies how the fixed packet offset will be derived.

type=qos.EncapsOffsetModeType
default=none
Displayed(tab/group)=Encapsulation Offset Mode (Scheduling/Egress Aggregate Rate Limit)
firewallPolicyPointer Specifies the firewall policy for subscribers associated with this subscriber profile.

type=Pointer
default=
Displayed(tab/group)=Firewall Policy (/Firewall Policy)
hostTrackingPolicyName The name of the host tracking policy.

type=string
access=read-only
default=
minimum=0
maximum=32
hostTrackingPolicyPointer The pointer that specifies the host tracking Policy applied to the profile.

type=Pointer
default=
Displayed(tab/group)=Host Tracking Policy (/Host Tracking Policy)
hsSlaMode Specifies the SLA profile handling mode for the subscriber if on a HS board.

type=subscrprofile.HsSlaMode
default=expanded
Displayed(tab/group)=HS SLA Profile Handling Mode (SLA Profiles.General)
hsmdaEgrPackByteOffOvrd Specifies the Packet Byte Offset of an hsmda egress policy for this subscriber. The value -128 means that there is no override.

DEPRECATED: 21.2 R1- This parameter is no longer supported by SR.
type=int
default=-128
minimum=-128
maximum=31
Displayed(tab/group)=Packet Byte Offset (bytes) (HSMDA QoS/Egress HSMDA Override)
hsmdaEgrQosWrrPlcyOvrd Specifies the HSMDA Weighted Round Robin (WRR) scheduling policy.

DEPRECATED: 21.2 R1- This parameter is no longer supported by SR.
type=Pointer
default=
Displayed(tab/group)=WRR Policy (HSMDA QoS/Egress HSMDA Override)
hsmdaEgressAggRateLimit Specifies the maximum total rate of hsmda egress queues for this subscriber. The value -1 means that there is no limit.

DEPRECATED: 21.2 R1- This parameter is no longer supported by SR.
type=int
default=-1
minimum=-1
maximum=100000000
units=kbps
Displayed(tab/group)=Aggregate Rate Limit (HSMDA QoS/Egress)
igmpPolicyObjPointer The pointer that specifies the Igmp Policy applied to the profile.

type=Pointer
default=
Displayed(tab/group)=IGMP Policy (/IGMP Policy)
ingPolicerPolicyObjPointer Policer Policy applicable to Subscriber profile

type=Pointer
default=
Displayed(tab/group)=Policer Control Policy (Policer Control/Ingress Policer Control Policy)
ingSubProfPCtrlOvrMaxRate Specifies the maximum frame based bandwidth limit of this policer.

type=int
default=-2
minimum=-2
maximum=2000000000
units=kbps
Displayed(tab/group)=Maximum Frame Based Bandwidth (Policer Control/Ingress Policer Control Policy Override)
ingSubProfPCtrlOvrMinMBSSep Specifies the minimum amount of separation buffer space (in bytes) allowed by this policer.

type=int
default=-2
minimum=-2
maximum=16777216
units=bytes
Displayed(tab/group)=Minimum Separation Buffer Space (Policer Control/Ingress Policer Control Policy Override)
ingressQosPolicyObjPointer Specifies the identifier of the SAP ingress QOS policy for HSMDA subscribers.

DEPRECATED: 21.2 R1- This parameter is no longer supported by SR.
type=Pointer
default=Access Ingress:1
Displayed(tab/group)=Ingress Policy (HSMDA QoS/Ingress)
ingressQosSchedObjPointer Pointer to Qos Ingress Scheduler Policy

type=Pointer
default=
Displayed(tab/group)=Ingress Scheduler (Scheduling/Ingress)
mldPolicyObjPointer The pointer that specifies the MLD Policy applied to the profile.

type=Pointer
default=
Displayed(tab/group)=MLD Policy (/MLD Policy)
natPolicyObjPointer Nat Policy applicable to Subscriber profile

type=Pointer
default=
Displayed(tab/group)=NAT Policy (/NAT Policy)
natPrefixList The value of natPrefixList specifies the name of the NAT Prefix List associated with this Subscriber Profile.

type=string
access=read-only
default=
Displayed(tab/group)=NAT Prefix List (/NAT Prefix List)
natPrefixListPointer Specifies the pointer name of the NAT Prefix List associated with this Subscriber Profile.

type=Pointer
default=
Displayed(tab/group)=NAT Prefix List Pointer (/NAT Prefix List)
pimPolicyObjPointer The pointer that specifies the PIM Policy applied to the profile.

type=Pointer
default=
Displayed(tab/group)=PIM Policy (/PIM Policy)
plhClass Specifies the class to be used to select a LAG link. The value of this object is only applicable when the subscriber uses a SAP on a LAG where the value of the object TIMETRA-LAG-MIB::tLagPerLinkHashWeighted is equal to 'true'.

type=int
default=1
minimum=1
maximum=3
Displayed(tab/group)=Class (Scheduling/LAG Per-Link-Hashing)
plhWeight Specifies the weight to be associated with this SAP when selecting a LAG link. The value of this object is only applicable when the subscriber uses a SAP on a LAG where the value of the object LAG.Interface.perLinkHashWeighted is equal to 'true'.

type=int
default=1
minimum=1
maximum=1024
Displayed(tab/group)=Weight (Scheduling/LAG Per-Link-Hashing)
preference Specifies its preference with respect to other subscriber profiles. The number '1' corresponds to the lowest preference. For a given subscriber, it is possible that the current subscriber profile is replaced with another one that has a higher or equal preference; the current subscriber profile will never be replaced with another one that has a lower preference.

type=int
default=5
minimum=1
maximum=10
Displayed(tab/group)=Preference
radiusAccountingPolicyObjectPointer Specifies the RADIUS Accounting policy applicable to this subscriber profile.

type=Pointer
default=
Displayed(tab/group)=Policy #1 (RADIUS Accounting/RADIUS Accounting Policies)
secShaperHashing Specifies whether or not LAG hashing over different forwarding complexes based on secondary shaper ID is applied for the subscriber downstream traffic. This setting only applies to HSMDA/HSQ ports. For standard LAGs, see vportHashing.

type=boolean
default=false
Displayed(tab/group)=Secondary Shaper Hashing
subMcastCacPolicyObjPointer The pointer that specifies the Subscriber Multicast CAC Policy applied to the profile.

type=Pointer
default=
Displayed(tab/group)=Subscriber Multicast CAC Policy (/Subscriber Multicast CAC Policy)
subProfFrameBasedAccounting

type=boolean
default=false
Displayed(tab/group)=Frame-Based Accounting (Scheduling/Egress Aggregate Rate Limit)
subscrprofile.EgressPolicerLevelOverride-Set type=Children-Set
subscrprofile.EgressSchedulerPolicyEntryOverride-Set type=Children-Set
subscrprofile.HsmdaEgressAccessPolicyQueueOverride-Set type=Children-Set
subscrprofile.HsmdaIngressPolicyPolicerOverride-Set type=Children-Set
subscrprofile.HsmdaIngressPolicyQueueOverride-Set type=Children-Set
subscrprofile.IngressPolicerLevelOverride-Set type=Children-Set
subscrprofile.IngressSchedulerPolicyEntryOverride-Set type=Children-Set
subscrprofile.SLAProfileEntry-Set type=Children-Set
thirdRadiusAccountingPolicyObjectPointer Specifies the third RADIUS accounting policy applicable to this subscriber profile.

type=Pointer
default=
Displayed(tab/group)=Policy #3 (RADIUS Accounting/RADIUS Accounting Policies)
upnpPolicyPointer Specifies the pointer name of the UPnP Policy associated with this Subscriber Profile.

type=Pointer
default=
Displayed(tab/group)=UPnP Policy Pointer (/UPnP Policy)
useDirectMapAsDefault It specifies whether the provided SLA profile string is mapped directly to the SLA profile.

type=generic.TruthValue
default=false
Displayed(tab/group)=Use Direct Map as Default (SLA Profiles.General)
volumeStatsType Specifies what volume statistics are used for accounting in this subscriber profile. 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).

type=subscrprofile.SubProfVolumeStatsType
default=default
Displayed(tab/group)=Volume Stats Type (/Accounting Policy)
vportHashing Specifies whether or not LAG hashing over different forwarding complexes based on VPort ID (inter-dest-id) is applied for the subscriber downstream traffic. This setting only applies to standard LAG ports. For HSMDA/HSQ LAGs, see secShaperHashing

type=boolean
default=false
Displayed(tab/group)=Virtual Port Hashing
 
Overridden Properties
description

displayedName Unique Subscriber Profile name

access=read-create
minimum=1
maximum=32
 
Properties inherited from policy.PolicyDefinition
configurationAction, configurationMode, discoveryState, displayedName, distributionMode, isMaster, lastSyncTime, numberOfUnderlyingPolicyItems, origin, policyMode, policySyncGroupPointer, policyType
 
Properties inherited from policy.PolicyObject
description, displayedName, globalPolicy, id, isLocal, policyType, siteId, siteName, templateObject
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods inherited from policy.PolicyDefinition
distribute, distributeUsingGroups, distributeV2, evaluatePolicy, findGlobal, findLocal, findReleased, getSyncTaskResult, resetToReleasedPolicy, setConfigurationModeToDraft, setConfigurationModeToReleased, setDistributionModeToLocalEditOnly, setDistributionModeToSyncWithGlobal, syncTo, syncToLocalWithResync
 
Supported Network Elements
7750 SR
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
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0