Overview Package Class Deprecated Help

radiusaccounting
Policy

Defines a RADIUS Accounting policy instance.

public class Policy

Stats:
radiusaccounting.PolicyStats

Properties
accessAlgorithm Specifies the algorithm used to select a RADIUS server from the list of configured servers.

type=radiusaccounting.AccessAlgorithmType
default=direct
Displayed(tab/group)=Access Algorithm (RADIUS Servers)
callingStationIdType Specifies what string will be put in the RADIUS Calling-Station-Id attribute if included in RADIUS accounting-request messages. This field is only applicable if the 'callingStationId' bit is set in 'radiusAttributes'

type=radiusaccounting.CallingStationIdType
default=sapString
Displayed(tab/group)=Calling Station ID Type (/Calling Station ID)
delayStartTime Specifies, in seconds, the time an accounting-start gets delayed before being sent out.

type=int
default=0
minimum=0
maximum=10
units=seconds
Displayed(tab/group)=Delay Start Time (/Accounting)
hostAccounting Specifies whether or not per-host accounting is done.

type=boolean
default=false
hostAccountingMessage The value of hostAccountingMessage specifies what kind of accounting messages are sent

type=radiusaccounting.HostAccountingMessageType
default=onlySLA
Displayed(tab/group)=Host Accounting Message (/Accounting)
nasPortBitspec Specifies what number will be put in the RADIUS NAS-Port attribute if included in RADIUS accounting-request messages. This field is only applicable if the 'nasPort' bit is set in 'radiusAttributes' If less than 32 bits are specified, the least significant bits are used and the omitted higher bits are set to zero.

type=string
default=
minimum=0
maximum=255
Displayed(tab/group)=Port Binary Specification (/NAS Port)
nasPortPrefixString Specifies the user configurable string to be added as prefix to the NAS-Port attribute if included in RADIUS accounting-request messages. This field is only applicable if the 'nasPortId' bit is set and nasPortPrefixType is set to userString.

type=string
default=
minimum=0
maximum=8
Displayed(tab/group)=Port Prefix String (/NAS Port ID)
nasPortPrefixType Specifies what type of prefix will be added to the NAS-Port attribute if included in RADIUS accounting-request messages. This field is only applicable if the 'nasPortId' bit is set

type=radiusaccounting.NasPortPrefixType
default=none
Displayed(tab/group)=Port Prefix Type (/NAS Port ID)
nasPortSuffixType specifies what type of suffix will be added to the NAS-Port attribute if included in RADIUS accounting-request messages. This field is only applicable if the 'nasPortId' bit is set

type=radiusaccounting.NasPortSuffixType
default=none
Displayed(tab/group)=Port Suffix Type (/NAS Port ID)
nasPortTypeType Specifies what kind of value will be put in the RADIUS NAS-Port-Type attribute if included in RADIUS accounting-request messages. This field is only applicable if the NAS Port Type bit is set in Radius Attributes

type=radiusaccounting.NasPortTypeType
default=standard
Displayed(tab/group)=Port Type (/NAS Port Type)
nasPortTypeValue Specifies what value will be put in the RADIUS NAS-Port-Type attribute if included in RADIUS accounting-request messages. This field is only applicable if the NAS Port Type bit is set in Radius Attributes and the value of NAS Port Type is equal to 'config'.

type=int
default=0
minimum=0
maximum=255
Displayed(tab/group)=Port Type Value (/NAS Port Type)
queueInstAcct The value of hostAccountingMessage specifies what kind of accounting messages are sent

type=radiusaccounting.QueueAccountingMessageType
default=onlyQueue
Displayed(tab/group)=Queue Instance Accounting (/Accounting)
radiusAttributes Specifies what RADIUS attributes the system should include into RADIUS accounting messages. A new bit stdAccoutingAttr was added in this bitmask field to replace the parameter useStdAcctAttrib. It is recommended that user should use this new bit mask instead of the useStdAcctAttrib parameter for global policy or local policy on 12.0R1+ nodes.

type=radiusaccounting.RadiusAttributeType
default=2147483648
Displayed(tab/group)=RADIUS Attributes
radiusServerPolicyPointer The value of radiusServerPolicyPointer specifies the RADIUS server policy as defined in TIMETRA-RADIUS-MIB::tmnxRadSrvPlcyTable to be applied in this RADIUS accounting policy

type=Pointer
default=
Displayed(tab/group)=RADIUS Server Policy (/RADIUS Server Policy)
radiusaccounting.CustomOverrideConfig-Set type=Children-Set
radiusaccounting.CustomQueueConfig-Set type=Children-Set
radiusaccounting.CustomRecord-Set type=Children-Set
radiusaccounting.RadiusEntry-Set type=Children-Set
requestScriptPolicy Specifies the RADIUS script policy used to change the RADIUS attributes of the outgoing Accounting-Request messages

type=string
default=
Displayed(tab/group)=Script Policy (/RADIUS Script Policy)
retryAttempts Specifies the number of RADIUS requests towards the same RADIUS server.

type=int
default=3
minimum=1
maximum=256
Displayed(tab/group)=Retry Attempts (RADIUS Servers)
router Identify a virtual router instance in the system. This value cannot be changed once an RADIUS server is configured for this policy. When the value is '0', both base and management router instances are matched.

type=long
default=0
routerType Specifies a virtual router type in the system. This value cannot be changed once a RADIUS server is configured for this policy. This attribute is used for NFM-P configuration only. When the Base option is selected, the routing table configuration of the router is the Base routing instance. When the Management option is selected, the routing table configuration of the router is the Management routing instance. When the Matched option is selected, the Base and Management router instances are the same. When the VPRN option is selected, a VPRN service is used as the routing instance.

type=radiusaccounting.RouterType
default=matched
Displayed(tab/group)=Router Instance (RADIUS Servers)
sessionAcct The value of hostAccountingMessage specifies what kind of accounting messages are sent

type=radiusaccounting.SessionAccountingMessageType
default=onlySLA
Displayed(tab/group)=Session Accounting (/Accounting)
sessionIDFormat Indicates the format for the acct-session-id attribute used in RADIUS accounting requests.

type=radiusaccounting.SessionIDFormatType
default=description
Displayed(tab/group)=Session ID Format
sourceAddress Specifies the source address of a RADIUS packet for DHCP radius authentication. It must be a valid unicast address (otherwise an error is returned). If this object is configured with the address of the router interface (ref TIMETRA-VRTR-MIB::vRiaIpAddress) the Radius client uses it while making a request to the server. If the address is not configured or is not the address of one of the interfaces, the source address is based on the address of the Radius server. If the server address is in-band, the client uses the system ip address. If it is out-of-band, the source address is the address of the management interface (The addresses can be found in TIMETRA-VRTR-MIB::vRiaIpAddress).

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Source Address (RADIUS Servers)
sourceAddressType Specifies the type of host address stored in property 'sourceAddress'.

type=rtr.InetAddressType
default=ipv4
timeoutSeconds Specifies, in seconds, between authentication request retries towards the same RADIUS server.

type=int
default=5
minimum=1
maximum=340
units=seconds
Displayed(tab/group)=Timeout (RADIUS Servers)
updateInterval Specifies the interval at which accounting data of subscriber hosts will be updated. If set to 0, no intermediate updates will be sent. Valid ranges are 0, 10..1080.

type=int
default=0
minimum=0
maximum=259200
units=minutes
Displayed(tab/group)=Value (/Interval)
updateIntervalJitter The value of updateIntervalJitter specifies the amount of jitter to be applied on the update interval which is configured in updateInterval and can be overruled by RADIUS. A value between 0..3600 specifies the amount of jitter in seconds. The (default) value -10 corresponds to a jitter value of 10% of the update interval. The operational value used by the system will never be bigger then 10% of the update interval.

type=long
default=-10
minimum=-10
maximum=3600
units=seconds
Displayed(tab/group)=Absolute Jitter (/Interval)
useStdAcctAttrib specifies whether or not the standard accounting attributes are used. If set to 'true (1)', the standard accounting attributes are used for accounting information, instead of the vendor specific attributes.

DEPRECATED: for local policies on 12.0 R1 +SR nodes and global policies, use radiusAttributes instead
type=boolean
default=false
Displayed(tab/group)=Use Standard Accounting Attribute
vprnPointer Identify a VPRN instance in the system. This value cannot be changed once an RADIUS server is configured for this policy. This attribute is used for NFM-P configuration only.

type=Pointer
default=
Displayed(tab/group)=VPRN ID (RADIUS Servers/Service Type)
 
Overridden Properties
configurationAction

default=failIfExists
description

displayedName

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

findVPRNInstances

finds VPRN Instances that have site configured.
Input Parameters:
aInSiteID : string -
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:
infoList : List (generic.CommonManagedEntityInformation) -
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 Gen 2
7705 SAR Hm
7450 ESS
Product Specifics
7450 ESS (all versions)
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
7705 SAR Hm 20.0
7705 SAR Hm 21.0
7705 SAR Hm 22.0
7705 SAR Hm 23.0
7705 SAR Hm 24.0
7705 SAR Hm 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