Class adepg:Svr (CONCRETE)

Class ID:12628
Class Label: Interface to Auth server
Encrypted: true - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Infra
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

This is profile object corresponding to ISE. The AD-related state retrieved from the ISE Controller is kept here.

Naming Rules
RN FORMAT: authsvr-{tnName}-{svrGrpName}-{name}

    [1] PREFIX=authsvr- PROPERTY = tnName


    [2] PREFIX=- PROPERTY = svrGrpName


    [3] PREFIX=- PROPERTY = name




DN FORMAT: 

[0] adepg/authsvr-{tnName}-{svrGrpName}-{name}

                


Diagram

Super Mo: adepg:ASvr,
Container Mos: adepg:Uni (deletable:yes),
Contained Mos: aaa:IDomainRef, adepg:EventCont, adepg:GroupCont, adepg:ResCont, adepg:UserCont,
Relations To: pki:TP, pki:KeyRing,
Relations: adepg:RsSvrCertChain, adepg:RsSvrKeyRing,


Containers Hierarchies
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] adepg:Uni  This is the top level class for all AD related objects
 
 ├
[V] adepg:Svr  This is profile object corresponding to ISE. The AD-related state retrieved from the ISE Controller is kept here.


Contained Hierarchy
[V] adepg:Svr  This is profile object corresponding to ISE. The AD-related state retrieved from the ISE Controller is kept here.
 ├
[V] aaa:IDomainRef This object is generated and used only by internal processes.
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 
 ├
[V] tag:Annotation 
 
 
 ├
[V] tag:Tag 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] adepg:EventCont  This represents AD event container
 
 ├
[V] adepg:Event  This represents AD event
 
 
 ├
[V] adepg:RsEvtUser 
 
 
 ├
[V] adepg:RtFltIp 
 ├
[V] adepg:GroupCont  This represents AD group container
 
 ├
[V] adepg:Domain  This represents AD domain
 
 
 ├
[V] adepg:Group  This represents AD group
 
 
 
 ├
[V] adepg:RtFltIdGrp 
 
 
 
 ├
[V] adepg:RtPriAttrToGroup  This represents the primary AD attr associated with a group (one instance of this relation per group per tenant)
 
 
 
 ├
[V] adepg:RtSecAttrToGroup  This represents an AD attr associated with a group; derived from primary AD attr of ancestor group. (one instance of this relation per group per tenant)
 
 
 
 ├
[V] adepg:RtUsrGroup 
 ├
[V] adepg:ResCont  This represents the top-level container
 
 ├
[V] adepg:GroupUsrData  This represents AD event
 
 ├
[V] adepg:ResTenant  This represents tenant
 
 
 ├
[V] adepg:ResEpPFltAttrCont 
 
 
 
 ├
[V] adepg:ResFltAttr  This represents identity group filter attribute
 
 
 
 
 ├
[V] adepg:RsFltIp 
 
 
 
 
 ├
[V] adepg:RsPriAttrToGroup  This represents the primary AD attr associated with a group (one instance of this relation per group per tenant)
 
 
 
 
 ├
[V] adepg:RsSecAttrToGroup  This represents an AD attr associated with a group; derived from primary AD attr of ancestor group. (one instance of this relation per group per tenant)
 
 
 
 ├
[V] adepg:RtEpcpToRemoteADResEpPAttr  Relation to fv:EpCP @@@ To get the criteria for classification @@@ local relation with resolve remote false
 ├
[V] adepg:RsSvrCertChain  ISE certChain
 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 
 ├
[V] tag:Annotation 
 
 
 ├
[V] tag:Tag 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] adepg:RsSvrKeyRing  ISE private key, certificate
 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 
 ├
[V] tag:Annotation 
 
 
 ├
[V] tag:Tag 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] adepg:UserCont  This represents AD user container
 
 ├
[V] adepg:User  This represents AD user
 
 
 ├
[V] adepg:RsUsrGroup 
 
 
 ├
[V] adepg:RtEvtUser 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 ├
[V] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 ├
[V] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] naming:NamedIdentifiedObject An abstract base class for an object that contains a name and ID.
 
 ├
[V] adepg:Entity 
 
 
 ├
[V] adepg:ASvr 
 
 
 
 ├
[V] adepg:Svr  This is profile object corresponding to ISE. The AD-related state retrieved from the ISE Controller is kept here.


Events
                


Faults
                adepg:Svr:connectFailed


Fsms
                


Properties Summary
Defined in: adepg:Svr
eqpt:Model
          string:Basic
model  (adepg:Svr:model)
           The model of the controller.
reference:BinRef monPolDn  (adepg:Svr:monPolDn)
           The monitoring policy attached to this observable object.
naming:Name
          string:Basic
name  (adepg:Svr:name)
           Overrides:adepg:Entity:name | naming:NamedObject:name
           The name of the object.
eqpt:Revision
          string:Basic
rev  (adepg:Svr:rev)
           The revision of the controller.
eqpt:Serial
          string:Basic
ser  (adepg:Svr:ser)
           The serial number of the controller.
naming:Name
          string:Basic
svrGrpName  (adepg:Svr:svrGrpName)
           Overrides:adepg:ASvr:svrGrpName
           NO COMMENTS
naming:Name
          string:Basic
tnName  (adepg:Svr:tnName)
           Overrides:adepg:ASvr:tnName
           NO COMMENTS
eqpt:Vendor
          string:Basic
vendor  (adepg:Svr:vendor)
           The vendor of the controller.
Defined in: adepg:ASvr
reference:BinRef accKey  (adepg:ASvr:accKey)
           Access profile
string:Basic apiVer  (adepg:ASvr:apiVer)
           Version of Controller API
reference:BinRef authSvrKey  (adepg:ASvr:authSvrKey)
           authSvr Key
auth:evtActTimer
          scalar:Uint16
evtPullTimer  (adepg:ASvr:evtPullTimer)
           Event Timers
string:Basic hostIp  (adepg:ASvr:hostIp)
           Controller name, ip and port info
auth:TrigSt
          scalar:Enum8
inventoryTrigSt  (adepg:ASvr:inventoryTrigSt)
           Manual trigger state of inventory sync
string:Basic lastEvtUsrIvtTs  (adepg:ASvr:lastEvtUsrIvtTs)
           NO COMMENTS
adepg:InventorySt
          scalar:Enum8
lastInventorySt  (adepg:ASvr:lastInventorySt)
           Last inventory pull status, timestamps
string:Basic lastUsrGrpIvtTs  (adepg:ASvr:lastUsrGrpIvtTs)
           NO COMMENTS
ads:WorkerQueueSz
          scalar:Uint16
maxWorkerQSize  (adepg:ASvr:maxWorkerQSize)
           Max Doer-to-worker queue size
adepg:OperState
          scalar:Enum8
operSt  (adepg:ASvr:operSt)
           The runtime state of the object or policy.
adepg:Port
          scalar:Uint16
port  (adepg:ASvr:port)
           The service port number for the LDAP service.
string:Password pwd  (adepg:ASvr:pwd)
           The system user password.
string:Basic usr  (adepg:ASvr:usr)
           The user account profile user name.
Defined in: adepg:Entity
naming:Descr
          string:Basic
descr  (adepg:Entity:descr)
           The description of this configuration item.
naming:Id
          scalar:Uint64
id  (adepg:Entity:id)
           Overrides:naming:NamedIdentifiedObject:id
           An object identifier.
adepg:Issues
          scalar:Bitmask64
issues  (adepg:Entity:issues)
           General Issues It captures various issues happened to the Entity.
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32
childAction  (mo:TopProps:childAction)
           Delete or ignore. For internal use only.
reference:BinRef dn  (mo:TopProps:dn)
           A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
reference:BinRN rn  (mo:TopProps:rn)
           Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
mo:ModificationStatus
          scalar:Bitmask32
status  (mo:TopProps:status)
           The upgrade status. This property is for internal use only.
Defined in: mo:Resolvable
mo:Owner
          scalar:Enum8
lcOwn  (mo:Resolvable:lcOwn)
           A value that indicates how this object was created. For internal use only.
Properties Detail

accKey

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Access profile



apiVer

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Version of Controller API



authSvrKey

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
authSvr Key



childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
    Comments:
Delete or ignore. For internal use only.
Constants
deleteAll 16384u deleteAll NO COMMENTS
ignore 4096u ignore NO COMMENTS
deleteNonPresent 8192u deleteNonPresent 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
    Comments:
The description of this configuration item.



dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
    Comments:
A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.



evtPullTimer

Type: auth:evtActTimer
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Event Timers
Constants
defaultValue 30 --- NO COMMENTS





hostIp

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Controller name, ip and port info



id

Type: naming:Id
Primitive Type: scalar:Uint64

Overrides:naming:NamedIdentifiedObject:id
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
An object identifier.



inventoryTrigSt

Type: auth:TrigSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Manual trigger state of inventory sync
Constants
triggered 0 triggered NO COMMENTS
untriggered 1 untriggered NO COMMENTS
DEFAULT untriggered(1) untriggered NO COMMENTS





issues

Type: adepg:Issues
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
General Issues It captures various issues happened to the Entity.
Constants
none 0x0ull None NO COMMENTS
connection-fault 0x1ull Failed to connect to external Identity server NO COMMENTS
DEFAULT none(0x0ull) None NO COMMENTS





lastEvtUsrIvtTs

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



lastInventorySt

Type: adepg:InventorySt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Last inventory pull status, timestamps
Constants
completed 0 Completed NO COMMENTS
partial 1 Partially Completed NO COMMENTS
failed 2 Failed NO COMMENTS
completedex 3 Completed with exception NO COMMENTS
DEFAULT completed(0) Completed NO COMMENTS





lastUsrGrpIvtTs

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS



lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A value that indicates how this object was created. For internal use only.
Constants
local 0 Local NO COMMENTS
policy 1 Policy NO COMMENTS
replica 2 Replica NO COMMENTS
resolveOnBehalf 3 ResolvedOnBehalf NO COMMENTS
implicit 4 Implicit NO COMMENTS
DEFAULT local(0) Local NO COMMENTS





maxWorkerQSize

Type: ads:WorkerQueueSz
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Max Doer-to-worker queue size
Constants
defaultQueueSize 300 Default Worker Queue Size NO COMMENTS
DEFAULT defaultQueueSize(300) Default Worker Queue Size NO COMMENTS





modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The time when this object was last modified.
Constants
never 0ull never NO COMMENTS
DEFAULT never(0ull) never NO COMMENTS





model

Type: eqpt:Model
Primitive Type: string:Basic

Like: eqpt:Dev:model
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The model of the controller.



monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The monitoring policy attached to this observable object.



name

Type: naming:Name
Primitive Type: string:Basic

Overrides:adepg:Entity:name  |  naming:NamedObject:name
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
The name of the object.



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS



operSt

Type: adepg:OperState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The runtime state of the object or policy.
Constants
unknown 0 Unknown NO COMMENTS
online 1 Online NO COMMENTS
offline 2 Offline NO COMMENTS
deallocated 3 Deallocated NO COMMENTS
DEFAULT unknown(0) Unknown NO COMMENTS





port

Type: adepg:Port
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The service port number for the LDAP service.
Constants
defaultValue 0 --- NO COMMENTS





pwd

Type: string:Password

Units: null
Encrypted: true
Access: implicit
Category: TopLevelRegular
    Comments:
The system user password.



rev

Type: eqpt:Revision
Primitive Type: string:Basic

Like: eqpt:Dev:rev
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The revision of the controller.
Constants
defaultValue "0" --- NO COMMENTS





rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
    Comments:
Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.



ser

Type: eqpt:Serial
Primitive Type: string:Basic

Like: eqpt:Dev:ser
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The serial number of the controller.



status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
    Comments:
The upgrade status. This property is for internal use only.
Constants
created 2u created 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 modified 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 deleted 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.






svrGrpName

Type: naming:Name
Primitive Type: string:Basic

Overrides:adepg:ASvr:svrGrpName
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
NO COMMENTS



tnName

Type: naming:Name
Primitive Type: string:Basic

Overrides:adepg:ASvr:tnName
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
NO COMMENTS



usr

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The user account profile user name.



vendor

Type: eqpt:Vendor
Primitive Type: string:Basic

Like: eqpt:Dev:vendor
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The vendor of the controller.
Constants
defaultValue "Cisco Systems, Inc" --- NO COMMENTS