aaa
RadiusServerPolicy



public class RadiusServerPolicy

Stats:
aaa.RadSrvPlcyMsgBufStats aaa.RadSrvPlcyStats

Properties
aaa.AcctOnOffOperation-Set type=Children-Set
aaa.AcctOnOffStatus-Set type=Children-Set
aaa.ServerEntry-Set type=Children-Set
acceptScriptPolicy Specifies the RADIUS script policy used to change the RADIUS attributes of the outgoing Access-Accept messages.

type=string
default=
Displayed(tab/group)=Script Policy (/RADIUS Script Policy)

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

type=aaa.AccessAlgorithmType
default=direct
Displayed(tab/group)=Access Algorithm

accountingRequestScriptPolicy The value of accountingRequestScriptPolicy specifies the RADIUS script policy used to change the RADIUS attributes of the Accounting-Request messages.

type=string
default=
Displayed(tab/group)=Script Policy (/RADIUS Script Policy)

acctInterimLifetime Specifies the time (in hours) an accounting message can be in the retransmission buffer. The value '0' specifies that no retries are performed, and hence that no data is buffered.

type=int
default=0
minimum=0
maximum=25
units=hours
Displayed(tab/group)=Lifetime (/RADIUS Accounting Interim Update)

acctInterimMax Specifies the maximum interval (in seconds) between retries to send the RADIUS accounting interim update message. The value '0' specifies that no retries are performed.

type=int
default=0
minimum=0
maximum=3600
units=seconds
Displayed(tab/group)=Max Interval (/RADIUS Accounting Interim Update)

acctInterimMin Specifies the minimum interval (in seconds) between retries to send the RADIUS accounting interim update message. The value '0' specifies that no retries are performed.

type=int
default=0
minimum=0
maximum=3600
units=seconds
Displayed(tab/group)=Minimum Interval (/RADIUS Accounting Interim Update)

acctOnOffAdminState Specifies the admin state of the accounting-on-off.

type=aaa.AcctOnOffAdminStateType
default=disabled
Displayed(tab/group)=Admin State (Accounting On/Off)

acctOnOffGroup Specifies the name of a RADIUS server policy Accounting-On-Off-Group.

type=Pointer
default=
Displayed(tab/group)=Group Name (Accounting On/Off)

acctStopLifetime Specifies the time (in hours) an accounting message can be in the retransmission buffer. The value '0' specifies that no retries are performed, and hence that no data is buffered. If a value '0' is specified for any of the objects acctStopMin, acctStopMax, or acctInterimLifetime, then all 3 objects will be set to '0' by the system.

type=int
default=0
minimum=0
maximum=25
units=hours
Displayed(tab/group)=Lifetime (/RADIUS Accounting Stop)

acctStopMax Specifies the maximum interval (in seconds) between retries to send the RADIUS accounting interim update message. The value '0' specifies that no retries are performed. The value specified must be bigger then or equal to the value specified for the object tmnxRadSrvPlcyAcctStopMinItvl.

type=int
default=0
minimum=0
maximum=3600
units=seconds
Displayed(tab/group)=Max Interval (/RADIUS Accounting Stop)

acctStopMin Specifies the minimum interval (in seconds) between retries to send the RADIUS accounting interim update message. The value '0' specifies that no retries are performed. The value specified must be less then or equal to the value specified for the object tmnxRadSrvPlcyAcctStopMaxItvl.

type=int
default=0
minimum=0
maximum=3600
units=seconds
Displayed(tab/group)=Minimum Interval (/RADIUS Accounting Stop)

blockedState Indicates whether or not the RADIUS server policy is blocked by the acct-on-off function as controlled by the object acctOnOffAdminState. In the state 'blocked' only the RADIUS meesages Acct-on and Acct-off can be exchanged.

type=aaa.BlockedState
access=read-only
Displayed(tab/group)=Blocked State (Accounting On/Off)

disableStickiness In a multi-server application, the value of disableStickiness specifies the subsequent packets to be sent to the same host as the first packet was sent to. In case disableStickiness is true, this behavior is disabled.

type=boolean
default=false
Displayed(tab/group)=Disable Stickiness

holdDownTime Specifies, in seconds, how long the system waits for before addressing that server again if the server was detected to be 'outOfService'

type=int
default=30
minimum=30
maximum=86400
units=seconds

holdDownTimeDays holdDownTime time in days.

type=int
default=0
minimum=0
maximum=1
Displayed(tab/group)=Days (/Hold Down Time)

holdDownTimeHours holdDownTime time in hours.

type=int
default=0
minimum=0
maximum=23
Displayed(tab/group)=Hours (/Hold Down Time)

holdDownTimeMins holdDownTime time in minutes.

type=int
default=0
minimum=0
maximum=59
Displayed(tab/group)=Minutes (/Hold Down Time)

holdDownTimeSecs holdDownTime time in seconds.

type=int
default=30
minimum=0
maximum=59
Displayed(tab/group)=Seconds (/Hold Down Time)

ipv6SourceAddress Specifies the IPv6 source address while transmitting RADIUS protocol messages to one of the RADIUS servers; it must be a valid unicast address.

type=InetAddress
default=0:0:0:0:0:0:0:0
Displayed(tab/group)=IPv6 Source Address

ipv6SourceAddressType Specifies the type of the host address stored in the property 'ipv6SourceAddress'.

type=rtr.InetAddressType
default=ipv6

masterRadSrvPlcyPointer Indicates the name of controller RADIUS server policy.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Controller (Accounting On/Off)

pythonPolicy Specifies the Python policy used to change the RADIUS attributes of the different RADIUS messages.

type=string
access=read-only
default=
Displayed(tab/group)=Python Policy Name

pythonPolicyPointer Specifies the "pythonPolicy:" prefix and the name of the Python policy used to change the RADIUS attributes of the different RADIUS messages.

type=Pointer
default=
Displayed(tab/group)=Python Policy

requestScriptPolicy The value of requestScriptPolicy specifies the RADIUS script policy used to change the RADIUS attributes of the outgoing Access-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

router Identify the virtual router instance applicable for the set of configured RADIUS servers

type=long
access=read-only
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=aaa.RouterType
default=none
Displayed(tab/group)=Router Instance

serverDownTimeoutMinute The value specifies the number of minutes portion of the configured serverDownTimeout.

type=int
default=0
minimum=0
maximum=5
Displayed(tab/group)=Minutes (/Server Down Timeout)

serverDownTimeoutSecond The value specifies the number of seconds portion of the configured serverDownTimeout.

type=int
default=0
minimum=0
maximum=59
Displayed(tab/group)=Seconds (/Server Down Timeout)

sourceAddress Specifies the source addresses while transmitting RADIUS protocol messages to one of the RADIUS servers; it must be a valid unicast address.

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Source Address

sourceAddressType Specifies the the type of host address stored in property 'sourceAddress'.

type=rtr.InetAddressType
default=ipv4

testAccntChecking Specifies if periodic checking for the operational state of the RADIUS servers configured. Checking will be done via the generation of a dummy RADIUS Access-Request including a User-Name and Password attribute set with respectively testAccntUserName and testAccntPassword. If not set, the system will generate the content for the User-Name and/or Password attribute itself. The interval at which these requests will be sent is defined with testAccntIvl.

type=subscrident.AdministrativeState
default=disabled
Displayed(tab/group)=Enable Test Account (/Health Check Test Account)

testAccntIvl Specifies the interval used to periodically check the operational state of the RADIUS servers configured.

type=int
default=3
minimum=1
maximum=60
units=seconds
Displayed(tab/group)=Interval (/Health Check Test Account)

testAccntPassword Specifies the content of the Password attribute when periodically performing health-checking of the RADIUS servers. If testAccntPassword is set to the empty string,the system will generate a password itself.

type=string
default=
minimum=0
maximum=64
Displayed(tab/group)=Password (/Health Check Test Account)

testAccntUserName Specifies the content of the User-Name attribute when periodically performing health-checking of the RADIUS servers. If testAccntUserName is set to the empty string, the system will generate a user-name itself.

type=string
default=
minimum=0
maximum=64
Displayed(tab/group)=User Name (/Health Check Test Account)

timeout Specifies, in seconds, the timeout between retries towards the same RADIUS server.

type=int
default=5
minimum=1
maximum=340
units=seconds

timeoutMins timeout value in minutes.

type=int
default=0
minimum=0
maximum=5
Displayed(tab/group)=Minutes (/Timeout)

timeoutSecs timeout value in seconds.

type=int
default=5
minimum=0
maximum=59
Displayed(tab/group)=Seconds (/Timeout)

vprnPointer Identify a VPRN instance in the system. This attribute is used for NFM-P configuration only.

type=Pointer
default=
Displayed(tab/group)=VPRN ID (/Service)

 
Overridden Properties
description

displayedName Specifies the name of the RADIUS Server Policy.

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

clearSecret

Remove secret associated with RADIUS Server Policy Test account.
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.
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

requestClearMessageBuffer

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.
instanceFullName : string - the full name of the object.
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:
aOutResult : clear.RequestHandleStruct - A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.
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 Supported from 10.0.R2
7705 SAR Gen 2
7450 ESS Supported from 10.0.R2
7705 SAR Hm
7250 IXR Supported from 20.10.R1
Product Specifics
7250 IXR 20.0
7250 IXR 21.0
7250 IXR 22.0
7250 IXR 23.0
7250 IXR 24.0
7250 IXR 25.0
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 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 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0