Class vns:CDevState (CONCRETE)

Class ID:4853
Class Label: State of the Device
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Logical Model
Write Access: [admin, nw-svc-device]
Read Access: [admin, nw-svc-device, nw-svc-policy]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: true ]

The state of the concrete device.

Naming Rules
RN FORMAT: cDevState-{[priKey]}

    [1] PREFIX=cDevState- PROPERTY = priKey




DN FORMAT: 

[1] uni/ten-{[tnDn]}-scriptHandlerState/cDevState-{[priKey]}

                


Diagram

Super Mo: naming:NamedObject,
Container Mos: vns:ScriptHandlerState (deletable:no),
Contained Mos: tag:Annotation, tag:Tag, vns:DevHealth, vns:TxId,


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] fabric:Topology The root for IFC topology.
 
 ├
[V] fabric:Pod A pod.
 
 
 ├
[V] fabric:Node The root node for the APIC.
 
 
 
 ├
[V] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] vns:ScriptHandlerState The internal state of the script handler daemon. The script handler daemon handles the configuration of service nodes (firewall, load balancer etc.,) in the fabric. This object is for internal use only.
 
 
 
 
 
 
 
 ├
[V] vns:CDevState The state of the concrete device.
[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] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] vns:ScriptHandlerState The internal state of the script handler daemon. The script handler daemon handles the configuration of service nodes (firewall, load balancer etc.,) in the fabric. This object is for internal use only.
 
 
 ├
[V] vns:CDevState The state of the concrete device.


Contained Hierarchy
[V] vns:CDevState The state of the concrete device.
 ├
[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] 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] vns:DevHealth The health of a service device, typically from 0 (poor) to 100 (good).
 
 ├
[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] tag:Annotation 
 
 
 ├
[V] tag:Tag 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] vns:TxId The transaction ID used in communication between script handler and script wrapper script. This object is for internal use only.


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] vns:CDevState The state of the concrete device.


Events
                vns:CDevState:vns_CDevState_DevModifySuccess
vns:CDevState:vns_CDevState_DevModifyTransient
vns:CDevState:vns_CDevState_DevModifyPermanent
vns:CDevState:vns_CDevState_DevModifyAudit
vns:CDevState:vns_CDevState_DevHealthSuccess
vns:CDevState:vns_CDevState_DevHealthTransient
vns:CDevState:vns_CDevState_DevHealthPermanent
vns:CDevState:vns_CDevState_DevHealthAudit
vns:CDevState:vns_CDevState_DeviceStateChange
vns:CDevState:vns_CDevState_DevValidateSuccess
vns:CDevState:vns_CDevState_DevValidateTransient
vns:CDevState:vns_CDevState_DevValidatePermanent
vns:CDevState:vns_CDevState_DevValidateAudit
vns:CDevState:creation__vns_CDevState
vns:CDevState:modification__vns_CDevState
vns:CDevState:deletion__vns_CDevState


Faults
                vns:CDevState:cDevAuditFailure
vns:CDevState:cDevModifyFailure
vns:CDevState:cDevValidateFailure


Fsms
                


Properties Summary
Defined in: vns:CDevState
mo:Annotation
          string:Basic
annotation  (vns:CDevState:annotation)
           NO COMMENTS
scalar:Uint16 backoff  (vns:CDevState:backoff)
           NO COMMENTS
scalar:Bool configured  (vns:CDevState:configured)
           A boolean value that tracks whether service device was configured.
vns:CDevStateType
          scalar:Enum8
devState  (vns:CDevState:devState)
           The concrete device configuration state.
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (vns:CDevState:extMngdBy)
           NO COMMENTS
vns:CalloutResponse
          scalar:Enum8
hlthResp  (vns:CDevState:hlthResp)
          
scalar:Date lastCounterCheckTime  (vns:CDevState:lastCounterCheckTime)
           NO COMMENTS
scalar:Date lastHealthCheckTime  (vns:CDevState:lastHealthCheckTime)
           NO COMMENTS
scalar:Date lastTransitionTime  (vns:CDevState:lastTransitionTime)
          
vns:CalloutResponse
          scalar:Enum8
modResp  (vns:CDevState:modResp)
          
reference:BinRef monPolDn  (vns:CDevState:monPolDn)
           The monitoring policy attached to this observable object.
reference:BinRef priKey  (vns:CDevState:priKey)
          
vns:TrigState
          scalar:Enum8
trigDevCnt  (vns:CDevState:trigDevCnt)
          
vns:TrigResp
          scalar:Enum8
trigDevCntResp  (vns:CDevState:trigDevCntResp)
          
vns:TrigState
          scalar:Enum8
trigDevHlth  (vns:CDevState:trigDevHlth)
          
vns:TrigResp
          scalar:Enum8
trigDevHlthResp  (vns:CDevState:trigDevHlthResp)
          
vns:TrigState
          scalar:Enum8
trigReSync  (vns:CDevState:trigReSync)
          
vns:TrigResp
          scalar:Enum8
trigReSyncResp  (vns:CDevState:trigReSyncResp)
          
scalar:Bool validatePending  (vns:CDevState:validatePending)
          
vns:CalloutResponse
          scalar:Enum8
validateResp  (vns:CDevState:validateResp)
          
string:Basic version  (vns:CDevState:version)
           The version of the compatibility catalog.
Defined in: naming:NamedObject
naming:Name
          string:Basic
name  (naming:NamedObject:name)
           The name of the object.
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:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
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.
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.
Properties Detail

annotation

Type: mo:Annotation
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
NO COMMENTS



backoff

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
defaultValue 1 --- NO COMMENTS





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





configured

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A boolean value that tracks whether service device was configured.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





devState

Type: vns:CDevStateType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The concrete device configuration state.
Constants
init 0 init NO COMMENTS
validaterequested 1 validaterequested NO COMMENTS
validatepending 2 validatepending NO COMMENTS
validatefailed 3 validatefailed NO COMMENTS
modifyrequested 4 modifyrequested NO COMMENTS
modifypending 5 modifypending NO COMMENTS
modifyfailed 6 modifyfailed NO COMMENTS
auditrequested 7 auditrequested NO COMMENTS
auditpending 8 auditpending NO COMMENTS
auditfailed 9 auditfailed NO COMMENTS
stable 10 stable NO COMMENTS
unmanaged 11 unmanaged NO COMMENTS
DEFAULT init(0) init NO COMMENTS





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.



extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
undefined 0u undefined NO COMMENTS
msc 1u msc NO COMMENTS
DEFAULT undefined(0u) undefined NO COMMENTS





hlthResp

Type: vns:CalloutResponse
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
success 0 success NO COMMENTS
transient 1 transient NO COMMENTS
permanent 2 permanent NO COMMENTS
audit 3 audit NO COMMENTS
DEFAULT 0 --- NO COMMENTS





lastCounterCheckTime

Type: scalar:Date

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



lastHealthCheckTime

Type: scalar:Date

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



lastTransitionTime

Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
defaultValue 0ull --- 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





modResp

Type: vns:CalloutResponse
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
success 0 success NO COMMENTS
transient 1 transient NO COMMENTS
permanent 2 permanent NO COMMENTS
audit 3 audit NO COMMENTS
DEFAULT 0 --- 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





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

Like: naming:Named:name
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
The name of the object.



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "63"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.-]+
    Comments:
NO COMMENTS



priKey

Type: reference:BinRef

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    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.



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.






trigDevCnt

Type: vns:TrigState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
off 0 off NO COMMENTS
on 1 on NO COMMENTS
DEFAULT off(0) off NO COMMENTS





trigDevCntResp

Type: vns:TrigResp
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
success 0 success NO COMMENTS
failure 1 failure NO COMMENTS
NotTrig 2 NotTrig NO COMMENTS
DEFAULT NotTrig(2) NotTrig NO COMMENTS





trigDevHlth

Type: vns:TrigState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
off 0 off NO COMMENTS
on 1 on NO COMMENTS
DEFAULT off(0) off NO COMMENTS





trigDevHlthResp

Type: vns:TrigResp
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
success 0 success NO COMMENTS
failure 1 failure NO COMMENTS
NotTrig 2 NotTrig NO COMMENTS
DEFAULT NotTrig(2) NotTrig NO COMMENTS





trigReSync

Type: vns:TrigState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
off 0 off NO COMMENTS
on 1 on NO COMMENTS
DEFAULT off(0) off NO COMMENTS





trigReSyncResp

Type: vns:TrigResp
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
success 0 success NO COMMENTS
failure 1 failure NO COMMENTS
NotTrig 2 NotTrig NO COMMENTS
DEFAULT NotTrig(2) NotTrig NO COMMENTS





uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A unique identifier for this object.



validatePending

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





validateResp

Type: vns:CalloutResponse
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
success 0 success NO COMMENTS
transient 1 transient NO COMMENTS
permanent 2 permanent NO COMMENTS
audit 3 audit NO COMMENTS
DEFAULT 0 --- NO COMMENTS





version

Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
The version of the compatibility catalog.