Class aaa:RadiusProvider (CONCRETE)

Class ID:258
Encrypted: true - Exportable: true - Persistent: true
Privileges: [aaa, admin]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.1.25

NO COMMENTS


Naming Rules
RN FORMAT: provider-[name]

    [1] PREFIX=provider- PROPERTY = name




DN FORMAT: 

[0] sys/radius-ext/provider-[name]

                



Containers Hierarchies
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
top:System Provides general information about this system, such as the name, IP address and current time.
 
 ├
aaa:RadiusEp
 
 
 ├
aaa:RadiusProvider


Contained Hierarchy
aaa:RadiusProvider

Inheritance
policy:Item The base class for all objects contained by policy:Definition. Though no containment rules are specified here, by convention policy:Item must be contained by either policy:Definition or another policy:Item.
 ├
aaa:Item
 
 ├
aaa:Provider
 
 
 ├
aaa:RadiusProvider

Events
                



Faults
                



Fsms
                



Properties Summary
Defined in: aaa:RadiusProvider
aaa:Port
          scalar:Uint32
authPort  (aaa:RadiusProvider:authPort)
           NO COMMENTS
aaa:RadiusService
          scalar:Enum8
service  (aaa:RadiusProvider:service)
           NO COMMENTS
aaa:TimeSec
          scalar:Uint32
timeout  (aaa:RadiusProvider:timeout)
           Overrides:aaa:Provider:timeout
           Per provider configuration, if set to 0, it uses global settings value
Defined in: aaa:Provider
aaa:EncKey
          string:Password
encKey  (aaa:Provider:encKey)
           encrypted provider key
aaa:Key
          string:Password
key  (aaa:Provider:key)
           NO COMMENTS
scalar:Bool keySet  (aaa:Provider:keySet)
           NO COMMENTS
naming:Name
          string:Basic
name  (aaa:Provider:name)
           Overrides:aaa:Item:name
           NO COMMENTS
aaa:Order
          scalar:Uint16
order  (aaa:Provider:order)
           NO COMMENTS
aaa:Retries
          scalar:Uint32
retries  (aaa:Provider:retries)
           NO COMMENTS
Defined in: aaa:Item
naming:Descr
          string:Basic
descr  (aaa:Item:descr)
           NO COMMENTS
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32
childAction  (mo:TopProps:childAction)
          
reference:Object dn  (mo:TopProps:dn)
           The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />
reference:RN rn  (mo:TopProps:rn)
           The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />
mo:InstSaclType
          scalar:Bitmask8
sacl  (mo:TopProps:sacl)
           The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
mo:ModificationStatus
          scalar:Bitmask32
status  (mo:TopProps:status)
           This property controls the life cycle of a managed object

Properties Detail

authPort

Type: aaa:Port
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)65535l
Comments:
NO COMMENTS
Constants
defaultValue 1812u NO COMMENTS

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
Property Validators:
Comments:
Constants
deleteAll 16384u NO COMMENTS
ignore 4096u NO COMMENTS
deleteNonPresent 8192u NO COMMENTS
DEFAULT 0 This type is used to

descr

Type: naming:Descr
Primitive Type: string:Basic
Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "256"
        Allowed Chars:
            Regex: [a-zA-Z0-9\[\]!#$%()*+,-./:;@ _{|}˜?&]+
Comments:
NO COMMENTS

dn

Type: reference:Object
Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
Property Validators:
Comments:
The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />

encKey

Type: aaa:EncKey
Primitive Type: string:Password
Units: null
Encrypted: true
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "63"
Comments:
encrypted provider key

key

Type: aaa:Key
Primitive Type: string:Password
Units: null
Encrypted: true
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "63"
        Allowed Chars:
            Regex: [$]
            Regex: [\\a-zA-Z0-9'"\[\]!#%&()*+,-./:;@_{|}˜`<>ˆ]+
Comments:
NO COMMENTS

keySet

Type: scalar:Bool
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
yes true NO COMMENTS
defaultValue false NO COMMENTS

name

Type: naming:Name
Primitive Type: string:Basic
Overrides:aaa:Item:name
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Regex: ˆ[a-zA-Z0-9][a-zA-Z0-9_.-]{0,63}$|ˆ([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}$|ˆ([0-9a-fA-F]{1,4}:){1,7}:$|ˆ([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}$|ˆ([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}$|ˆ([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}$|ˆ([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}$|ˆ([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}$|ˆ[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})$|ˆ:((:[0-9a-fA-F]{1,4}){1,7}|:)$
Comments:
NO COMMENTS

order

Type: aaa:Order
Primitive Type: scalar:Uint16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 16
Comments:
NO COMMENTS
Constants
lowest-available 0 NO COMMENTS
DEFAULT 0 NO COMMENTS

retries

Type: aaa:Retries
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)5l
Comments:
NO COMMENTS
Constants
defaultValue 1u NO COMMENTS

rn

Type: reference:RN
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
Property Validators:
Comments:
The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />

sacl

Type: mo:InstSaclType
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelSacl
Property Validators:
Comments:
The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
Constants
none 0 NO COMMENTS
del 1 NO COMMENTS
mod 2 NO COMMENTS
addchild 4 NO COMMENTS
cascade 8 NO COMMENTS
DEFAULT 0 NO COMMENTS

service

Type: aaa:RadiusService
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
all 0 NO COMMENTS
authorization 1 NO COMMENTS
accounting 2 NO COMMENTS
DEFAULT authorization(1) NO COMMENTS

status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
Property Validators:
Comments:
This property controls the life cycle of a managed object
Constants
removed 16u In a setter method: specifies that an object should be removed.
In the return value of a setter method: indicates that an object has been removed.
created 2u In a setter method: specifies that an object should be created. An error is returned if the object already exists.
In the return value of a setter method: indicates that an object has been created.
modified 4u In a setter method: specifies that an object should be modified
In the return value of a setter method: indicates that an object has been modified.
deleted 8u In a setter method: specifies that an object should be deleted.
In the return value of a setter method: indicates that an object has been deleted.
DEFAULT 0 This type controls the life cycle of objects passed in the XML API.

When used in a setter method (such as configConfMo), the ModificationStatus specifies whether an object should be created, modified, deleted or removed.
In the return value of a setter method, the ModificationStatus indicates the actual operation that was performed. For example, the ModificationStatus is set to "created" if the object was created. The ModificationStatus is not set if the object was neither created, modified, deleted or removed.

When invoking a setter method, the ModificationStatus is optional:
If a setter method such as configConfMo is invoked and the ModificationStatus is not set, the system automatically determines if the object should be created or modified.


timeout

Type: aaa:TimeSec
Primitive Type: scalar:Uint32
Overrides:aaa:Provider:timeout
Units: sec
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)60l
Comments:
Per provider configuration, if set to 0, it uses global settings value
Constants
defaultValue 5u NO COMMENTS