Class comp:Inst (CONCRETE)

Class ID:12363
Class Label: L4-L7 device
Encrypted: true - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, vmm-policy]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Infra
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

L4-L7 device in the controller

Naming Rules
RN FORMAT: inst-{[cDevDn]}

    [1] PREFIX=inst- PROPERTY = cDevDn




DN FORMAT: 

[1] uni/vmmp-{vendor}/dom-{name}/ctrlr-{name}/polCont/instPol-{name}/inst-{[cDevDn]}

[2] comp/prov-{name}/ctrlr-{[domName]}-{name}/polCont/instPol-{name}/inst-{[cDevDn]}

                


Diagram

Super Mo: comp:Entity,
Container Mos: comp:InstPol (deletable:yes),
Contained Mos: comp:VNicConf,


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] vmm:ProvP The VMM provider profile stores the policies of VMM systems from a particular vendor (VMware or Microsoft). This container is automatically created by the system.
 
 
 
 
 
 
 
 ├
[V] vmm:DomP The VMM domain profile is a policy for grouping VM controllers with similar networking policy requirements. For example, the VM controllers can share VLAN or VXLAN space and application endpoint groups. The APIC communicates with the controller to publish network configurations such as port groups that are then applied to the virtual workloads.
 
 
 
 
 
 
 
 
 ├
[V] vmm:CtrlrP The VMM controller profile specifies how to connect to a single VM management controller that is part of a policy enforcement domain. For example, the VMM controller profile could be a policy to connect a VMware vCenter that is part of a VMM domain.
 
 
 
 
 
 
 
 
 
 ├
[V] comp:PolCont An abstraction of the container for various policies. This object is generated and used only by internal process.
 
 
 
 
 
 
 
 
 
 
 ├
[V] comp:InstPol  L4-L7 device policy for the controller
 
 
 
 
 
 
 
 
 
 
 
 ├
[V] comp:Inst  L4-L7 device in the controller
[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] vmm:ProvP The VMM provider profile stores the policies of VMM systems from a particular vendor (VMware or Microsoft). This container is automatically created by the system.
 
 
 ├
[V] vmm:DomP The VMM domain profile is a policy for grouping VM controllers with similar networking policy requirements. For example, the VM controllers can share VLAN or VXLAN space and application endpoint groups. The APIC communicates with the controller to publish network configurations such as port groups that are then applied to the virtual workloads.
 
 
 
 ├
[V] vmm:CtrlrP The VMM controller profile specifies how to connect to a single VM management controller that is part of a policy enforcement domain. For example, the VMM controller profile could be a policy to connect a VMware vCenter that is part of a VMM domain.
 
 
 
 
 ├
[V] comp:PolCont An abstraction of the container for various policies. This object is generated and used only by internal process.
 
 
 
 
 
 ├
[V] comp:InstPol  L4-L7 device policy for the controller
 
 
 
 
 
 
 ├
[V] comp:Inst  L4-L7 device in the controller
[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] comp:Uni The top level class for all compute related objects.
 
 ├
[V] comp:Prov The VM provider inventory is the inventory of a VM provider such as VMware or Microsoft. The VM provider profile policies determine the VM inventory that is collected.
 
 
 ├
[V] comp:Ctrlr The operational state of the VM management system controller such as a VMware vCenter, VMware vShield, or Microsoft SCVMM.
 
 
 
 ├
[V] comp:PolCont An abstraction of the container for various policies. This object is generated and used only by internal process.
 
 
 
 
 ├
[V] comp:InstPol  L4-L7 device policy for the controller
 
 
 
 
 
 ├
[V] comp:Inst  L4-L7 device in the controller


Contained Hierarchy
[V] comp:Inst  L4-L7 device in the controller
 ├
[V] comp:VNicConf  L4-L7 device interface
 
 ├
[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] 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] 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
 
 ├
[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] naming:NamedIdentifiedObject An abstract base class for an object that contains a name and ID.
 
 ├
[V] comp:Entity An abstract based class representing a compute entity.
 
 
 ├
[V] comp:Inst  L4-L7 device in the controller


Events
                


Faults
                comp:Inst:remoteOperIssues


Fsms
                


Properties Summary
Defined in: comp:Inst
reference:BinRef cDevDn  (comp:Inst:cDevDn)
           The fully qualified name of a concrete device in the management information tree.
string:Basic host  (comp:Inst:host)
           The hostname or IP for export destination. Call Home sends email messages to either the IP address or hostname, and the associated port number.
reference:BinRef instPolDn  (comp:Inst:instPolDn)
           InstPol that the L4-L7 device is associated with
string:Basic ldev  (comp:Inst:ldev)
           The naming property of a proxy object in the tenant that points to the logical device.
reference:BinRef monPolDn  (comp:Inst:monPolDn)
           The monitoring policy attached to this observable object.
string:Password password  (comp:Inst:password)
           The administrative password.
scalar:Uint32 policyChangeCount  (comp:Inst:policyChangeCount)
           NO COMMENTS
string:Basic remoteErrMsg  (comp:Inst:remoteErrMsg)
           Error message recieved from VC during deployment
comp:HostState
          scalar:Enum8
state  (comp:Inst:state)
           The state of the relationship.
string:Basic userName  (comp:Inst:userName)
           The name of the user whose password is to be changed.
comp:DeploymentStatus
          scalar:Enum8
vmDeploymentStatus  (comp:Inst:vmDeploymentStatus)
           Deployment stage of VM
string:Basic vmName  (comp:Inst:vmName)
           The virtual center VM name on which the device is hosted in the L4-L7 device cluster. The virtual center VM name uniquely identifies the VM.
Defined in: comp:Entity
naming:Descr
          string:Basic
descr  (comp:Entity:descr)
           Additional descriptive information about the object.
naming:Id
          scalar:Uint64
id  (comp:Entity:id)
           Overrides:naming:NamedIdentifiedObject:id
           ID
comp:Issues
          scalar:Bitmask64
issues  (comp:Entity:issues)
           General Issues It captures various issues happened to the Entity.
naming:Name
          string:Basic
name  (comp:Entity:name)
           Overrides:naming:NamedObject:name
           Name
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
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

cDevDn

Type: reference:BinRef

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
The fully qualified name of a concrete device in the management information tree.



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





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Additional descriptive information about the object.



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.



host

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The hostname or IP for export destination. Call Home sends email messages to either the IP address or hostname, and the associated port number.



id

Type: naming:Id
Primitive Type: scalar:Uint64

Overrides:naming:NamedIdentifiedObject:id
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
ID



instPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
InstPol that the L4-L7 device is associated with



issues

Type: comp:Issues
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
General Issues It captures various issues happened to the Entity.
Constants
none 0x0ull None NO COMMENTS
tagging-cat-fault 0x10000ull Failed to retrieve all Tag Category information NO COMMENTS
ds-update-fault 0x1000ull Failed to update DS(Data Store) property NO COMMENTS
hv-miss-vmknic-fault 0x100ull ESX Host does not have any vmknic NO COMMENTS
vnic-miss-epg-fault 0x10ull VNIC is attached to an invalid DVS Port Group or unable to communicate with vCenter NO COMMENTS
lnode-property-fault 0x1ull Failed to get DVS property NO COMMENTS
prep-iso-file-fault 0x20000ull Failed to prepare or push iso file for service vm deployment. Please check if correct datastore is selected in policy. NO COMMENTS
rp-update-fault 0x2000ull Failed to update RP(Resource Pool) property NO COMMENTS
mgmtnic-miss-dvs-fault 0x200ull VMK Nic is configured with invalid DVS NO COMMENTS
hpnic-miss-epg-fault 0x20ull HpNIC is attached to an invalid uplink DVS Port Group NO COMMENTS
hv-update-fault 0x2ull Failed to update Hv(ESX Host) property NO COMMENTS
vmfolder-update-fault 0x40000ull Failed to update VM(Virtual Machine) Folder property NO COMMENTS
opflex-channels-down-ave 0x4000ull Both the opflex channels are down for AVE. Please check the connections on the host. NO COMMENTS
hv-miss-pnic-fault 0x400ull ESX Host does not have any pnic NO COMMENTS
hv-miss-dvs-fault 0x40ull ESX Host is configured with invalid DVS NO COMMENTS
vm-update-fault 0x4ull Failed to update VM(Virtual Machine) property NO COMMENTS
tagging-tag-fault 0x8000ull Failed to retrieve all Tag information NO COMMENTS
vm-deploy-task-fault 0x800ull deployVm task failed on vcenter NO COMMENTS
hv-disconnect-fault 0x80ull ESX Host is disconnected or not responding NO COMMENTS
vm-miss-hv-fault 0x8ull VM is attached to an invalid Hv(ESX Host) NO COMMENTS
DEFAULT none(0x0ull) None 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





ldev

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The naming property of a proxy object in the tenant that points to the logical device.



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





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: implicit Category: TopLevelRegular
    Comments:
Name



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS



password

Type: string:Password

Units: null
Encrypted: true
Access: implicit
Category: TopLevelRegular
    Comments:
The administrative password.



policyChangeCount

Type: scalar:Uint32

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





remoteErrMsg

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Error message recieved from VC during deployment



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.



state

Type: comp:HostState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The state of the relationship.
Constants
maintenance 0 Maintenance Mode NO COMMENTS
connected 1 Connected NO COMMENTS
noresponse 2 Not Responding NO COMMENTS
disconnected 3 Disconnected NO COMMENTS
poweredOn 4 Powered On NO COMMENTS
poweredOff 5 Powered Off NO COMMENTS
standBy 6 StandBy NO COMMENTS
suspended 7 Suspended NO COMMENTS
unknown 8 Unknown NO COMMENTS
maintReq 9 Maintenance Required NO COMMENTS
deployPending 10 Service VM Pending Deployment NO COMMENTS
quarantine 11 Quarantine Mode NO COMMENTS
DEFAULT disconnected(3) Disconnected NO COMMENTS





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.






userName

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The name of the user whose password is to be changed.



vmDeploymentStatus

Type: comp:DeploymentStatus
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Deployment stage of VM
Constants
deploying 0 deploying NO COMMENTS
prepisofile 1 prepisofile NO COMMENTS
vmcreated 2 vmcreated NO COMMENTS
deploymentfailure 3 deploymentfailure NO COMMENTS
redeploying 4 redeploying NO COMMENTS
DEFAULT deploying(0) deploying NO COMMENTS





vmName

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The virtual center VM name on which the device is hosted in the L4-L7 device cluster. The virtual center VM name uniquely identifies the VM.