Class vns:AMName (ABSTRACT)

Class ID:4732
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin]
Creatable/Deletable: derived (see Container Mos for details)
Possible Semantic Scopes: EPG, Fabric,
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

The meta configuration information.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: naming:NamedObject,
Sub Mos: vns:AMItem, vns:CfgRoot, vns:ClusterCfg, vns:DevCfg, vns:DevInt, vns:DevMod, vns:DevProf, vns:DevScript, vns:DevSlot, vns:MCap, vns:MConn, vns:MCred, vns:MCredSecret, vns:MDevCfg, vns:MFeature, vns:MFunc, vns:MGrpCfg, vns:MIfLbl, vns:RoutingCfg, vns:TrunkingCfg,


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] vns:AMName The meta configuration information.
 
 ├
[V] vns:AMItem An abstract configuration item: MFolder, MParam, or MRel. AMItem can contain the generic configuration of the device. It can be used for settings that are function-independent, such as NTP or DHCP servers.
 
 
 ├
[V] vns:MFolder The meta folder information. The model utilizes a generic configuration consisting of MFolders and MParams. This allows the configuration to be specified as a hierarchy.
 
 
 ├
[V] vns:MParam A meta parameter. The model utilizes a generic configuration consisting of MFolders and MParams. This enables configuration to be specified as a hierarchy. The metadata within this model consists of a key, a type (integer, boolean), and other attributes related to parameters.
 
 
 ├
[V] vns:MRel A meta relation.
 
 ├
[V] vns:CfgRoot The root node for the device parameter configuration tree.
 
 ├
[V] vns:ClusterCfg The cluster configuration.
 
 ├
[V] vns:DevCfg The device configuration.
 
 ├
[V] vns:DevInt 
 
 ├
[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:DevProf 
 
 ├
[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] vns:DevSlot 
 
 ├
[V] vns:MCap The features or capabilities that can be licensed on a device. The capabilities are typically restricted by license. The device is queried for actual values through the script interface.
 
 ├
[V] vns:MConn A connector between logical functions. The attributes includes the cardinality, direction, and encapsulation type for the given connection.
 
 ├
[V] vns:MCred The credentials necessary to authenticate a user into the device. For example, key is used for key-based authentication schemes. This model details the meta information for such key-based authentication of credentials.
 
 ├
[V] vns:MCredSecret An object that holds the password for logging into a service device.
 
 ├
[V] vns:MDevCfg The base level device configuration. This serves as an anchor to differentiate between different device configurations and the shared configuration (MSharedCfg).
 
 ├
[V] vns:MFeature 
 
 ├
[V] vns:MFunc The metadata for a single function on a device. A function contains a set of connectors and a function-specific configuration tree. This managed object contains the metadata for all such operations.
 
 ├
[V] vns:MGrpCfg The meta group configuration. It contains the part of the configuration that can be shared across multiple functions in a group.
 
 ├
[V] vns:MIfLbl An interface label. Interfaces can be labelled in an abstract way on devices. For example, a firewall device could implement trusted, untrusted, and management interfaces. The concrete models would specify how many of each label a given device supports.
 
 ├
[V] vns:RoutingCfg 
 
 ├
[V] vns:TrunkingCfg  Represents ability to vlan tag packets by device cluster


Events
                


Faults
                


Fsms
                


Properties Summary
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: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

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.



name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular
    Comments:
The name of this meta configuration instance.



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
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.