Class top:Root (CONCRETE)

Class ID:2
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Resolved Model - APIC NX Processing: Disabled
Write Access: [admin]
Read Access: [aaa, access-connectivity-l1, access-connectivity-l2, access-connectivity-l3, access-connectivity-mgmt, access-connectivity-util, access-equipment, access-protocol-l1, access-protocol-l2, access-protocol-l3, access-protocol-mgmt, access-protocol-ops, access-protocol-util, access-qos, admin, fabric-connectivity-l1, fabric-connectivity-l2, fabric-connectivity-l3, fabric-connectivity-mgmt, fabric-connectivity-util, fabric-equipment, fabric-protocol-l1, fabric-protocol-l2, fabric-protocol-l3, fabric-protocol-mgmt, fabric-protocol-ops, fabric-protocol-util, nw-svc-device, nw-svc-devshare, nw-svc-params, nw-svc-policy, ops, tenant-connectivity-l1, tenant-connectivity-l2, tenant-connectivity-l3, tenant-connectivity-mgmt, tenant-connectivity-util, tenant-epg, tenant-ext-connectivity-l1, tenant-ext-connectivity-l2, tenant-ext-connectivity-l3, tenant-ext-connectivity-mgmt, tenant-ext-connectivity-util, tenant-ext-protocol-l1, tenant-ext-protocol-l2, tenant-ext-protocol-l3, tenant-ext-protocol-mgmt, tenant-ext-protocol-util, tenant-network-profile, tenant-protocol-l1, tenant-protocol-l2, tenant-protocol-l3, tenant-protocol-mgmt, tenant-protocol-ops, tenant-protocol-util, tenant-qos, tenant-security, vmm-connectivity, vmm-ep, vmm-policy, vmm-protocol-ops, vmm-security]
Creatable/Deletable: derived (see Container Mos for details)
Semantic Scope: None
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: false, HasHealth: true, HasEventRules: false ]

This class represents the root element in the object hierarchy.
All managed objects in the system are descendants of the Root element.

Naming Rules


DN FORMAT:

[0]



Diagram, Containers, Contained
NOTE: Because this class represents the root element in the object hierarchy, the diagram and contained objects list are too large to display here.


Inheritance
[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.


Events



Faults



Fsms



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



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.