Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class comp:Nic (ABSTRACT)

Class ID:1115
Class Label: Abstraction of a Nic Interface
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled
Write Access: []
Read Access: [admin, tenant-epg, tenant-network-profile, vmm-connectivity, vmm-ep]
Creatable/Deletable: derived (see Container Mos for details)
Possible Semantic Scopes: EPG, Infra,
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

An abstraction of all the network interface cards (NIC) objects.

Naming Rules 


DN FORMAT:


Diagram

Super Mo: comp:Element,
Sub Mos: comp:DNic, comp:MgmtNic, comp:PNic,
Contained Mos: comp:EpPConn, comp:Ip, comp:PrimaryEncapDef,
Relations From: fv:CEp, fv:Ep,
Relations To: hvs:Adj, comp:EpPD,
Relations: comp:RsNicAdj, comp:RsUsegEpPD, comp:RtNic, comp:RtToNic,


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:Element An abstract base class representing a physical, virtual or logical compute element.
 
 		 
 		 
 		 ├
 		[V] comp:Nic An abstraction of all the network interface cards (NIC) objects.
 
 		 
 		 
 		 
 		 ├
 		[V] comp:DNic A discovered network interface card or an endpoint. Note that this is an internal object.
 
 		 
 		 
 		 
 		 ├
 		[V] comp:MgmtNic An endpoint or NIC used for management connectivity on the host. For example, vmk interface of a VMware vCenter.
 
 		 
 		 
 		 
 		 ├
 		[V] comp:PNic An abstraction of physical network interface card object.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] comp:HpNic The physical interface information on the hypervisor.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] comp:PpNic A physical interface on the physical host.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] comp:VNic The virtual network interface on the VM.


Events


Faults


Fsms


Properties Summary
Defined in: comp:Nic
address:IPv4 ip  (comp:Nic:ip)
           null
address:MAC mac  (comp:Nic:mac)
           null
comp:NicState
          scalar:Enum8 		operSt  (comp:Nic:operSt)
           The runtime state of the object or policy.
comp:NicInstType
          scalar:Enum8 		type  (comp:Nic:type)
           null
Defined in: comp:Element
comp:Guid
          string:Basic 		guid  (comp:Element:guid)
           Globally Unique Identifier (GUID)
comp:Oid
          string:Basic 		oid  (comp:Element:oid)
           OID
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
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: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




descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    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.


guid

Type: comp:Guid
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Globally Unique Identifier (GUID)


id

Type: naming:Id
Primitive Type: scalar:Uint64

Overrides:naming:NamedIdentifiedObject:id

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


ip

Type: address:IPv4

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


mac

Type: address:MAC

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


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
Property Validators:
    Range:  min: "0"  max: "63"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.-]+
    Comments:
NO COMMENTS


oid

Type: comp:Oid
Primitive Type: string:Basic

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


operSt

Type: comp:NicState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The runtime state of the object or policy.
Constants
down 0 Down NO COMMENTS
up 1 Up NO COMMENTS
DEFAULT down(0) Down 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.





type

Type: comp:NicInstType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
null
Constants
unknown 0 Unknown NO COMMENTS
phys 1 Baremetal Host NO COMMENTS
virt 2 Virtual Machine NO COMMENTS
hv 3 Hypervisor Host NO COMMENTS
vmk 4 Hypervisor Kernel NO COMMENTS
DEFAULT unknown(0) Unknown NO COMMENTS






Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail