Class vns:DevPing (CONCRETE)

Class ID:4948
Class Label: CDev Ping Policy
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled
Write Access: [admin, nw-svc-device]
Read Access: [admin, nw-svc-device]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: false, HasHealth: true, HasEventRules: false ]

An object created to test the reachability information of a device node.

Naming Rules
RN FORMAT: devPing-{name}

    [1] PREFIX=devPing- PROPERTY = name




DN FORMAT: 

[1] uni/ten-{[tnDn]}-scriptHandlerState/scriptHandlerUserState/devPing-{name}

                


Diagram

Super Mo: naming:NamedObject,
Container Mos: vns:ScriptHandlerUserState (deletable:yes),
Relations To: vns:CDev,
Relations: vns:RsDevPingToCDev,


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:ScriptHandlerUserState The user created state for L4 to L7.
 
 
 
 
 
 
 
 
 ├
[V] vns:DevPing An object created to test the reachability information of a device node.
[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:ScriptHandlerUserState The user created state for L4 to L7.
 
 
 
 ├
[V] vns:DevPing An object created to test the reachability information of a device node.


Contained Hierarchy
[V] vns:DevPing An object created to test the reachability information of a device node.
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] vns:RsDevPingToCDev This property is managed internally and should not be modified by the user.
 
 ├
[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] 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] vns:DevPing An object created to test the reachability information of a device node.


Events
                vns:DevPing:creation__vns_DevPing
vns:DevPing:modification__vns_DevPing
vns:DevPing:deletion__vns_DevPing


Faults
                


Fsms
                


Properties Summary
Defined in: vns:DevPing
action:AdminSt
          scalar:Enum8
adminSt  (vns:DevPing:adminSt)
          
action:Freq
          scalar:Time
freq  (vns:DevPing:freq)
          
reference:BinRef monPolDn  (vns:DevPing:monPolDn)
           The monitoring policy attached to this observable object.
naming:Name
          string:Basic
name  (vns:DevPing:name)
           Overrides:naming:NamedObject:name
          
action:OperSt
          scalar:Enum8
operSt  (vns:DevPing:operSt)
          
scalar:Bool pingStatus  (vns:DevPing:pingStatus)
          
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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.
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.
Properties Detail

adminSt

Type: action:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
unknown 0 Unknown NO COMMENTS
start 1 Start NO COMMENTS
stop 2 Stop NO COMMENTS
suspend 3 Suspend NO COMMENTS
prepare 4 Prepare NO COMMENTS
DEFAULT unknown(0) Unknown 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





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.



freq

Type: action:Freq
Primitive Type: scalar:Time

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
one-shot 0ull One shot Exectue only once
DEFAULT 0 --- Frequency of the task





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





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

Overrides:naming:NamedObject:name
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular Property Validators: Range: min: "1" max: "16" Allowed Chars: Regex: [a-zA-Z0-9_.:-]+
    Comments:



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



operSt

Type: action:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
scheduled 0 Scheduled NO COMMENTS
processing 1 Processing NO COMMENTS
completed 2 Completed NO COMMENTS
cancelled 3 Cancelled NO COMMENTS
failed 4 Failed NO COMMENTS
indeterminate 5 Indeterminate NO COMMENTS
suspended 6 Suspended NO COMMENTS
crashsuspect 7 Crash-Suspect NO COMMENTS
ready 8 Ready NO COMMENTS
DEFAULT scheduled(0) Scheduled NO COMMENTS





pingStatus

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





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.






uid

Type: scalar:Uint16

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