Class vns:DevScript (CONCRETE)

Class ID:4746
Class Label: Device Script
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Logical Model
Write Access: [access-connectivity-l1, admin]
Read Access: [access-connectivity-l1, 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 ]

A device script handler contains meta information about the script handler's related attributes, including its name, package name, and version.

Naming Rules
RN FORMAT: mDevScr

    [1] PREFIX=mDevScr


DN FORMAT: 

[1] uni/infra/mDev-{vendor}-{model}-{version}/mDevScr

                


Diagram

Super Mo: vns:AMName,
Container Mos: vns:MDev (deletable:yes),
Contained Mos: tag:Annotation, tag:Tag, vns:DevMod, vns:RTInfo,


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] infra:Infra A container for all tenant infra configurations.
 
 
 
 
 
 
 
 ├
[V] vns:MDev Import a device package into the Application Policy Infrastructure Controller (APIC). The device package contains meta device type definition and definitions of the metadata for a service device type. The metadata contains vendor-specific data including the vendor name, device model, and device version.
 
 
 
 
 
 
 
 
 ├
[V] vns:DevScript A device script handler contains meta information about the script handler's related attributes, including its name, package name, and version.
[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] infra:Infra A container for all tenant infra configurations.
 
 
 ├
[V] vns:MDev Import a device package into the Application Policy Infrastructure Controller (APIC). The device package contains meta device type definition and definitions of the metadata for a service device type. The metadata contains vendor-specific data including the vendor name, device model, and device version.
 
 
 
 ├
[V] vns:DevScript A device script handler contains meta information about the script handler's related attributes, including its name, package name, and version.


Contained Hierarchy
[V] vns:DevScript A device script handler contains meta information about the script handler's related attributes, including its name, package name, and version.
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] tag:Annotation 
 ├
[V] tag:Tag 
 ├
[V] vns:DevMod A device extension module. When device script handlers need extensions to their existing functionality, use this module to supplement the handlers with additional functionality.
 ├
[V] vns:RTInfo 
 
 ├
[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)


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] vns:AMName The meta configuration information.
 
 ├
[V] vns:DevScript A device script handler contains meta information about the script handler's related attributes, including its name, package name, and version.


Events
                vns:DevScript:creation__vns_DevScript
vns:DevScript:modification__vns_DevScript
vns:DevScript:deletion__vns_DevScript


Faults
                


Fsms
                


Properties Summary
Defined in: vns:DevScript
mo:Annotation
          string:Basic
annotation  (vns:DevScript:annotation)
           NO COMMENTS
scalar:Uint32 auditTimeout  (vns:DevScript:auditTimeout)
           device script timeout for audit operations
scalar:Uint16 concurrency  (vns:DevScript:concurrency)
           NO COMMENTS
vns:CtrlrVersion
          string:Basic
ctrlrVersion  (vns:DevScript:ctrlrVersion)
           The controller model version supported by this package.
scalar:Uint16 dbgPort  (vns:DevScript:dbgPort)
          
string:Basic dbgSrv  (vns:DevScript:dbgSrv)
          
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (vns:DevScript:extMngdBy)
           NO COMMENTS
vns:LogLevel
          scalar:Enum8
logLevel  (vns:DevScript:logLevel)
           The current severity logged level of the fault.
string:Basic minorversion  (vns:DevScript:minorversion)
           The minor version number of the APIC model supported by this package. There are several APIC model versions. This property uniquely identifies the APIC model minor version the device script handler uses.
scalar:Uint32 modifyTimeout  (vns:DevScript:modifyTimeout)
           device script timeout for modify operations
reference:BinRef monPolDn  (vns:DevScript:monPolDn)
           The monitoring policy attached to this observable object.
string:Basic packageName  (vns:DevScript:packageName)
           The device script package name. There can be several package names for the device script. This property uniquely identifies the package name to which the device script belongs.
vns:DevScriptUpgradeType
          scalar:Enum8
upgradeType  (vns:DevScript:upgradeType)
          
scalar:Uint32 validateTimeout  (vns:DevScript:validateTimeout)
           device script timeout for validate operations
string:Basic versionExpr  (vns:DevScript:versionExpr)
           The version expression for the device versions supported by this package.
scalar:Uint32 watchdogTimeout  (vns:DevScript:watchdogTimeout)
           watchdog timeout for device script
Defined in: vns:AMName
naming:Name
          string:Basic
name  (vns:AMName:name)
           Overrides:naming:NamedObject:name
           The name of this meta configuration instance.
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: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



auditTimeout

Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)900l  max: (long)10800l
    Comments:
device script timeout for audit operations
Constants
defaultValue 900u --- 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





concurrency

Type: scalar:Uint16

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





ctrlrVersion

Type: vns:CtrlrVersion
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The controller model version supported by this package.



dbgPort

Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:



dbgSrv

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    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





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





logLevel

Type: vns:LogLevel
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The current severity logged level of the fault.
Constants
EMERG 0 EMERGENCY NO COMMENTS
ALERT 1 ALERT NO COMMENTS
CRIT 2 CRITICAL NO COMMENTS
ERR 3 ERROR NO COMMENTS
WARNING 4 WARNING NO COMMENTS
NOTICE 5 NOTICE NO COMMENTS
INFO 6 INFORMATIONAL NO COMMENTS
DEBUG 7 DEBUG NO COMMENTS
DEBUG1 8 DEBUG1 NO COMMENTS
DEBUG2 9 DEBUG2 NO COMMENTS
DEBUG3 10 DEBUG3 NO COMMENTS
DEBUG4 11 DEBUG4 NO COMMENTS
DEFAULT DEBUG(7) DEBUG NO COMMENTS





minorversion

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The minor version number of the APIC model supported by this package. There are several APIC model versions. This property uniquely identifies the APIC model minor version the device script handler uses.
Constants
defaultValue "1" --- 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





modifyTimeout

Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)300l  max: (long)10800l
    Comments:
device script timeout for modify operations
Constants
defaultValue 300u --- 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 Access: admin Category: TopLevelRegular Property Validators: Range: min: "1" max: "128" Allowed Chars: Regex: [a-zA-Z0-9_.:-]+
    Comments:
The name of this meta configuration instance.



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



packageName

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The device script package name. There can be several package names for the device script. This property uniquely identifies the package name to which the device script belongs.



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.



upgradeType

Type: vns:DevScriptUpgradeType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
None 0 None NO COMMENTS
Minor 1 Minor NO COMMENTS
Major 2 Major NO COMMENTS
DEFAULT None(0) None NO COMMENTS





validateTimeout

Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)300l  max: (long)10800l
    Comments:
device script timeout for validate operations
Constants
defaultValue 300u --- NO COMMENTS





versionExpr

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The version expression for the device versions supported by this package.



watchdogTimeout

Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)900l  max: (long)10800l
    Comments:
watchdog timeout for device script
Constants
defaultValue 900u --- NO COMMENTS