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 - APIC NX Processing: Disabled
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 ]

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: aaa:RbacAnnotation, tag:Annotation, tag:Tag, vns:DevMod, vns:RTInfo,

Containers Hierarchies

top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.  ├ fabric:Topology The root for IFC topology.    ├ fabric:Pod A pod.      ├ fabric:Node The root node for the APIC.        ├ ctx:Local The local Context.          ├ ctx:Application The context application.            ├ pol:Uni Represents policy definition/resolution universe.              ├ infra:Infra A container for all tenant infra configurations.                ├ 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.                  ├ vns:DevScript A device script handler contains meta information about the script handler's related attributes, including its name, package name, and version. top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.  ├ pol:Uni Represents policy definition/resolution universe.    ├ infra:Infra A container for all tenant infra configurations.      ├ 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.        ├ 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

vns:DevScript A device script handler contains meta information about the script handler's related attributes, including its name, package name, and version.  ├ 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  ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.  ├ 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.  ├ health:Inst A base class for a health score instance.(Switch only)  ├ tag:Annotation   ├ tag:Tag   ├ 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.  ├ vns:RTInfo     ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.    ├ 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.      ├ 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      ├ tag:Annotation       ├ tag:Tag     ├ health:Inst A base class for a health score instance.(Switch only)

Inheritance

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

                vns:DevScript:creation__vns_DevScript

                vns:DevScript:modification__vns_DevScript

                vns:DevScript:deletion__vns_DevScript

                

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_.:-]+

NO COMMENTS

auditTimeout

Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)900l  max: (long)10800l

device script timeout for audit operations

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction

Delete or ignore. For internal use only.

concurrency

Type: scalar:Uint16

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

NO COMMENTS

ctrlrVersion

Type: vns:CtrlrVersion
Primitive Type: string:Basic

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

The controller model version supported by this package.

dbgPort

Type: scalar:Uint16

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

dbgSrv

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"

dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn

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

NO COMMENTS

lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

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

A value that indicates how this object was created. For internal use only.

logLevel

Type: vns:LogLevel
Primitive Type: scalar:Enum8

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

The current severity logged level of the fault.

minorversion

Type: string:Basic

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

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.

modTs

Type: mo:TStamp
Primitive Type: scalar:Date

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

The time when this object was last modified.

modifyTimeout

Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)300l  max: (long)10800l

device script timeout for modify operations

monPolDn

Type: reference:BinRef

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

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_.:-]+

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_.-]+

NO COMMENTS

packageName

Type: string:Basic

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

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

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

The upgrade status. This property is for internal use only.

uid

Type: scalar:Uint16

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

A unique identifier for this object.

upgradeType

Type: vns:DevScriptUpgradeType
Primitive Type: scalar:Enum8

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

validateTimeout

Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)300l  max: (long)10800l

device script timeout for validate operations

versionExpr

Type: string:Basic

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

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

watchdog timeout for device script