Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class vns:AMItem (ABSTRACT)

Class ID:4733
Class Label: Abstract Configuration Item. can be either MFolder, MParam or MRel
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
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 ]

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.

Naming Rules 


DN FORMAT:


Diagram

Super Mo: vns:AMName,
Sub Mos: vns:MFolder, vns:MParam, vns:MRel,
Relations To: vns:MConn,
Relations: vns:RsConnector,


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.


Events


Faults


Fsms


Properties Summary
Defined in: vns:AMItem
vns:VnsCardinalityType
          scalar:Enum8 		cardinality  (vns:AMItem:cardinality)
           A value to determine how many instances of this type can be present.
string:Basic description  (vns:AMItem:description)
           The description of this configuration item. The configuration item can be MFolder, MParam or MRel.
string:Basic dispFeature  (vns:AMItem:dispFeature)
          
string:Basic dispLabel  (vns:AMItem:dispLabel)
          
vns:VnsDispType
          scalar:Enum8 		dispType  (vns:AMItem:dispType)
          
string:Basic key  (vns:AMItem:key)
           The key uniquely identifying this configuration item. Every item is uniquely identified by this key.
naming:Name
          string:Basic 		name  (vns:AMItem:name)
           Overrides:vns:AMName:name | naming:NamedObject:name
           The name of this configuration item. Every item has a unique name.
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

cardinality

Type: vns:VnsCardinalityType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A value to determine how many instances of this type can be present.
Constants
unspecified 0 unspecified NO COMMENTS
1 1 1 NO COMMENTS
n 2 n NO COMMENTS
DEFAULT unspecified(0) unspecified 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




description

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The description of this configuration item. The configuration item can be MFolder, MParam or MRel.


dispFeature

Type: string:Basic

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


dispLabel

Type: string:Basic

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


dispType

Type: vns:VnsDispType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
basic 0 basic NO COMMENTS
advanced 1 advanced NO COMMENTS
DEFAULT advanced(1) advanced NO 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.


key

Type: string:Basic

Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
    Comments:
The key uniquely identifying this configuration item. Every item is uniquely identified by this key.


name

Type: naming:Name
Primitive Type: string:Basic

Overrides:vns:AMName:name  |  naming:NamedObject:name

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The name of this configuration item. Every item has a unique name.


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.







Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail