Class comp:VNicConf (CONCRETE)

Class ID:12367
Class Label: L4-L7 device interface
Encrypted: false - 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: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

L4-L7 device interface

Naming Rules
RN FORMAT: vnicConf-{vnicName}

    [1] PREFIX=vnicConf- PROPERTY = vnicName




DN FORMAT: 

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

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

                


Diagram

Super Mo: comp:Obj,
Container Mos: comp:Inst (deletable:yes),


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] comp:VNicConf  L4-L7 device interface
[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] comp:VNicConf  L4-L7 device interface
[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
 
 
 
 
 
 
 ├
[V] comp:VNicConf  L4-L7 device interface


Contained Hierarchy
[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.


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] pol:Obj Represents a generic policy object.
 
 ├
[V] comp:Obj An abstraction of compute objects in the system. This object is generated and used only by internal process.
 
 
 ├
[V] comp:VNicConf  L4-L7 device interface


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: comp:VNicConf
scalar:Sint64 controllerKey  (comp:VNicConf:controllerKey)
           NO COMMENTS
string:Basic dnsDomain  (comp:VNicConf:dnsDomain)
           NO COMMENTS
address:Ip gateway  (comp:VNicConf:gateway)
           Gateway address of the interface
address:Ip ip  (comp:VNicConf:ip)
           The IP address.
vns:IpAllocationType
          scalar:Enum8
ipAllocationType  (comp:VNicConf:ipAllocationType)
           NO COMMENTS
scalar:Bool isHAInterface  (comp:VNicConf:isHAInterface)
           NO COMMENTS
scalar:Bool isInBand  (comp:VNicConf:isInBand)
           dynamic only: Tell type of the network
scalar:Sint64 key  (comp:VNicConf:key)
           The key or password used to uniquely identify this configuration object.
reference:BinRef managementEpg  (comp:VNicConf:managementEpg)
           dynamic only: management epg for in-band network
string:Basic portGroupName  (comp:VNicConf:portGroupName)
           dynamic only: management nic port group for out-of-band network
address:Ip standbyIP  (comp:VNicConf:standbyIP)
           standby IP address
address:Ip subnetmask  (comp:VNicConf:subnetmask)
           Subnet mask of the interface
string:Basic vnicName  (comp:VNicConf:vnicName)
           The Vnic adapter name.
Defined in: pol:Obj
naming:Name
          string:Basic
name  (pol:Obj:name)
           Overrides:naming:NamedObject:name
           null
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

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





controllerKey

Type: scalar:Sint64

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



dnsDomain

Type: string:Basic

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



gateway

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Gateway address of the interface



ip

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The IP address.



ipAllocationType

Type: vns:IpAllocationType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
dhcp 0 dhcp NO COMMENTS
fixed 1 fixed NO COMMENTS
default 2 default NO COMMENTS
DEFAULT default(2) default NO COMMENTS





isHAInterface

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





isInBand

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
dynamic only: Tell type of the network
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT yes(true) --- NO COMMENTS





key

Type: scalar:Sint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The key or password used to uniquely identify this configuration object.



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





managementEpg

Type: reference:BinRef

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
dynamic only: management epg for in-band network



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





name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular
    Comments:
null



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

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



portGroupName

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
dynamic only: management nic port group for out-of-band network



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.



standbyIP

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
standby IP address



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.






subnetmask

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Subnet mask of the interface



vnicName

Type: string:Basic

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
The Vnic adapter name.