Class eqptdiagp:SupCTsOd (ABSTRACT)

Class ID:2236
Class Label: On-Demand Diag Policy Set for the Sup Card Type
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Concrete Model
Write Access: [admin]
Read Access: [admin]
Creatable/Deletable: derived (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

The on-demand abstract diagnostic policy for supervisor cards.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: eqptdiagp:CardTestSetOd,
Sub Mos: eqptdiagp:LeTsOdSc, eqptdiagp:SpTsOdSc,
Relations To: eqpt:SupC,
Relations: eqptdiagp:RsSupCOdDiag,


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] pol:Obj Represents a generic policy object.
 
 ├
[V] pol:Def Represents self-contained policy document.
 
 
 ├
[V] eqptdiagp:TestSet An abstract diagnostics policy for fabric nodes.
 
 
 
 ├
[V] eqptdiagp:TestSetBoot A bootup abstract diagnostic policy for fabric nodes.
 
 
 
 
 ├
[V] eqptdiagp:TestSetOd An on-demand abstract diagnostic policy for fabric nodes.
 
 
 
 
 
 ├
[V] eqptdiagp:CardTestSetOd The on-demand abstract diagnostic policy for cards.
 
 
 
 
 
 
 ├
[V] eqptdiagp:SupCTsOd The on-demand abstract diagnostic policy for supervisor cards.
 
 
 
 
 
 
 
 ├
[V] eqptdiagp:LeTsOdSc The diagnostic on-demand test set for leaf fabric nodes to run on supervisor cards.
 
 
 
 
 
 
 
 ├
[V] eqptdiagp:SpTsOdSc The diagnostic on-demand test set for leaf fabric nodes to run on spine supervisor cards.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: eqptdiagp:TestSetOd
test:Freq
          scalar:Time
freq  (eqptdiagp:TestSetOd:freq)
           Overrides:eqptdiagp:TestSetBoot:freq | eqptdiagp:TestSet:freq
           The frequency of the on-demand abstract diagnostic policy for fabric nodes.
scalar:Bool inclDisruptive  (eqptdiagp:TestSetOd:inclDisruptive)
           Flag to control if disruptive tests from the group should be run or not. Default value is false.
scalar:Date triggerTS  (eqptdiagp:TestSetOd:triggerTS)
          
Defined in: eqptdiagp:TestSet
eqptdiagp:AdminSt
          scalar:Enum8
adminSt  (eqptdiagp:TestSet:adminSt)
           Administrative state of the diag policy
Defined in: pol:Def
naming:Descr
          string:Basic
descr  (pol:Def:descr)
           Specifies a description of the policy definition.
naming:Descr
          string:Basic
ownerKey  (pol:Def:ownerKey)
           The key for enabling clients to own their data for entity correlation.
naming:Descr
          string:Basic
ownerTag  (pol:Def:ownerTag)
           A tag for enabling clients to add their own data. For example, to indicate who created this object.
Defined in: pol:Obj
naming:Name
          string:Basic
name  (pol:Obj:name)
           Overrides:naming:NamedObject:name
           null
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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

adminSt

Type: eqptdiagp:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Administrative state of the diag policy
Constants
start 1 Start NO COMMENTS
stop 2 Stop NO COMMENTS
suspend 3 Suspend NO COMMENTS
DEFAULT start(1) Start 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





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: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
Specifies a description of the policy definition.



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: test:Freq
Primitive Type: scalar:Time

Overrides:eqptdiagp:TestSetBoot:freq  |  eqptdiagp:TestSet:freq
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
The frequency of the on-demand abstract diagnostic policy for fabric nodes.
Constants
one-shot 0ull Once One time trigger
every4hrs 14400000ull Every 4 hours NO COMMENTS
every30mins 1800000ull Every 30 mins NO COMMENTS
every4weeks 2419200000ull Every 4 weeks NO COMMENTS
every8hrs 28800000ull Every 8 hours NO COMMENTS
every5mins 300000ull Every 5 mins NO COMMENTS
every1hr 3600000ull Every 1 hour NO COMMENTS
every12hrs 43200000ull Every 12 hours NO COMMENTS
every10mins 600000ull Every 10 mins NO COMMENTS
every1week 604800000ull Every 1 week NO COMMENTS
every2hrs 7200000ull Every 2 hours NO COMMENTS
every1day 86400000ull Every 1 day NO COMMENTS
DEFAULT one-shot(0ull) Once One time trigger





inclDisruptive

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Flag to control if disruptive tests from the group should be run or not. Default value is false.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





name

Type: naming:Name
Primitive Type: string:Basic

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



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



ownerKey

Type: naming:Descr
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:
The key for enabling clients to own their data for entity correlation.



ownerTag

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "64"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
A tag for enabling clients to add their own data. For example, to indicate who created this object.



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.






triggerTS

Type: scalar:Date

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