Overview Package Class Deprecated Help

aaa
RouteDownloadPolicy

Defines an Route Download Policy to allow download of routes from RADIUS server

public class RouteDownloadPolicy

Stats:
aaa.RadRouteDownloadStats

Properties
adminState Specifies the administrative state.

type=int
default=outService
Displayed(tab/group)=Administrative State
enums=
    2: inService - In Service
    3: outService - Out of Service
baseUserName Specifies the prefix of the username that is used in the RADIUS access requests. The username used in the RADIUS access requests is a concatenation of this string, the dash character and an increasing integer. If the value of this object is the default value then the string configured in tmnxChassisName is used.

type=string
default=
maximum=32
Displayed(tab/group)=Base User Name
defMetric Specifies the default metric of the routes imported.

type=int
default=2
minimum=0
maximum=254
Displayed(tab/group)=Default Metric
defTag Specifies the default tag of the routes imported.

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=Default Tag
interval Specifies the time interval, in minutes, between the start of the last route downloader run and the start of the next route downloader run.

type=int
default=720
minimum=1
maximum=1440
units=minutes
Displayed(tab/group)=Download Interval
maxIntvl Specifies the maximum duration, in minutes, of the retry interval. The start value of the retry interval is configured in tmnxRadRouteDownlMinRetryIntvl and this duration grows exponentially after each sequential failure.

type=int
default=20
minimum=1
maximum=1440
units=minutes
Displayed(tab/group)=Maximum Retry Interval
maxRoutes Specifies the maximum number of the routes imported.

type=int
default=200000
minimum=1
maximum=200000
Displayed(tab/group)=Maximum Number of Routes
minIntvl Specifies the duration, in minutes, of the retry interval. This duration grows exponentially after each sequential failure.

type=int
default=10
minimum=1
maximum=1440
units=minutes
Displayed(tab/group)=Minimum Retry Interval
password Specifies the password that is used in the RADIUS access requests. The value of this object must be set to a non-empty string when tmnxRadRouteDownlAdminState is set to 'inService'.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Password
radServerPlcyName Specifies the the RADIUS Server Policy.

type=string
access=read-only
default=
radServerPlcyPointer Specifies the the RADIUS Server Policy.

type=Pointer
default=
Displayed(tab/group)=RADIUS Server Policy
 
Overridden Properties
displayedName Unique policy identity.

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

forceDownload

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
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.R4
7705 SAR Gen 2
7450 ESS Supported from 10.0.R4
7705 SAR Hm
7250 IXR Supported from 20.10.R1