Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming 

Class vm:Vif (CONCRETE)

Class ID:910
Encrypted: false - Exportable: false - Persistent: true
Privileges: [admin]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.131.12

NO COMMENTS

Naming Rules 
RN FORMAT: sw-[phSwitchId]vif-[vifId]

    [1] PREFIX=sw- PROPERTY = phSwitchId


    [2] PREFIX=vif- PROPERTY = vifId




DN FORMAT: 

[0] vmm/computeEp-[uuid]/nic-[name]/sw-[phSwitchId]vif-[vifId]

[1] vmm/hv-[uuid]/nic-[name]/sw-[phSwitchId]vif-[vifId]

[2] vmm/vm-[uuid]/nic-[name]/sw-[phSwitchId]vif-[vifId]


Containers Hierarchies
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		vm:Ep root of vm instance hierarchy.
 
 		 ├
 		vm:ComputeEp Represents a compute endpoint (e.g. userland process)
 
 		 
 		 ├
 		vm:Nic Network-centric abstraction of vmnic
 
 		 
 		 
 		 ├
 		vm:Vif
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		vm:Ep root of vm instance hierarchy.
 
 		 ├
 		vm:Hv Abstraction of a HyperVisor instance
 
 		 
 		 ├
 		vm:Nic Network-centric abstraction of vmnic
 
 		 
 		 
 		 ├
 		vm:Vif
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		vm:Ep root of vm instance hierarchy.
 
 		 ├
 		vm:Instance Abstraction of a vitual machine instance.
 
 		 
 		 ├
 		vm:Nic Network-centric abstraction of vmnic
 
 		 
 		 
 		 ├
 		vm:Vif


Contained Hierarchy
vm:Vif
 ├
 		fault:Inst An abnormal condition or defect at the component, equipment, or sub-system level which may lead to a failure, as defined in ISO/CD 10303-226.
Inheritance
vm:Vif
Events


Faults 
                vm:Vif:linkState


Fsms


Properties Summary
Defined in: vm:Vif
dcx:VIFId
          scalar:Uint32 		adpVifId  (vm:Vif:adpVifId)
           vif id assigned to the vnic on which this vmadaptor terminates
scalar:Uint32 cookie  (vm:Vif:cookie)
           Cookie to tag VIF inventory updates. This is an internal property and shouldn't be exposed by northbound APIs.
adaptor:LinkState
          scalar:Enum8 		linkState  (vm:Vif:linkState)
           NO COMMENTS
dcx:OperState
          scalar:Enum8 		operState  (vm:Vif:operState)
           NO COMMENTS
network:SwitchId
          scalar:Enum8 		phSwitchId  (vm:Vif:phSwitchId)
           Physical access switch ID
scalar:Uint32 phsAccessAggrPortId  (vm:Vif:phsAccessAggrPortId)
           Physical switch access aggregate port ID
scalar:Uint32 phsAccessCardId  (vm:Vif:phsAccessCardId)
           Physical switch access card ID
scalar:Uint32 phsAccessPortId  (vm:Vif:phsAccessPortId)
           Physical switch access port ID
scalar:Uint32 phsBorderAggrPortId  (vm:Vif:phsBorderAggrPortId)
           Physical switch border aggregate port ID
scalar:Uint32 phsBorderCardId  (vm:Vif:phsBorderCardId)
           Physical switch border card ID
scalar:Uint32 phsBorderPortId  (vm:Vif:phsBorderPortId)
           Physical switch border port ID
port:StateQual
          string:Basic 		stateQual  (vm:Vif:stateQual)
           NO COMMENTS
scalar:Date statusChangeTs  (vm:Vif:statusChangeTs)
           NO COMMENTS
vm:Status
          scalar:Enum8 		vStatus  (vm:Vif:vStatus)
           NO COMMENTS
reference:Object vcDn  (vm:Vif:vcDn)
           reference to the virtual switch interface providing a pipe to corresponding DVS
dcx:VIFId
          scalar:Uint32 		vifId  (vm:Vif:vifId)
           nxos floating veth ID
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32 		childAction  (mo:TopProps:childAction)
          
reference:Object dn  (mo:TopProps:dn)
           The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />
reference:RN rn  (mo:TopProps:rn)
           The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />
mo:InstSaclType
          scalar:Bitmask8 		sacl  (mo:TopProps:sacl)
           The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
mo:ModificationStatus
          scalar:Bitmask32 		status  (mo:TopProps:status)
           This property controls the life cycle of a managed object
Properties Detail

adpVifId

Type: dcx:VIFId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
vif id assigned to the vnic on which this vmadaptor terminates

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
Property Validators:

Comments:
Constants
deleteAll 16384u NO COMMENTS
ignore 4096u NO COMMENTS
deleteNonPresent 8192u NO COMMENTS
DEFAULT 0 This type is used to

cookie

Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
Cookie to tag VIF inventory updates. This is an internal property and shouldn't be exposed by northbound APIs.

dn

Type: reference:Object
Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
Property Validators:

Comments:
The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />

linkState

Type: adaptor:LinkState
Primitive Type: scalar:Enum8
Like: adaptor:LinkStateHolder:linkState
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
admin-down 1 NO COMMENTS
down 2 NO COMMENTS
error 3 NO COMMENTS
up 4 NO COMMENTS
unallocated 5 NO COMMENTS
unavailable 6 NO COMMENTS
offline 7 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS

operState

Type: dcx:OperState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
admin-down 1 NO COMMENTS
link-down 2 NO COMMENTS
error 3 NO COMMENTS
active 4 NO COMMENTS
passive 5 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS

phSwitchId

Type: network:SwitchId
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:

Comments:
Physical access switch ID
Constants
NONE 0 NO COMMENTS
A 1 NO COMMENTS
B 2 NO COMMENTS
DEFAULT A(1) NO COMMENTS

phsAccessAggrPortId

Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
Physical switch access aggregate port ID
Constants
defaultValue 0u NO COMMENTS

phsAccessCardId

Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
Physical switch access card ID

phsAccessPortId

Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
Physical switch access port ID

phsBorderAggrPortId

Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
Physical switch border aggregate port ID
Constants
defaultValue 0u NO COMMENTS

phsBorderCardId

Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
Physical switch border card ID

phsBorderPortId

Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
Physical switch border port ID

rn

Type: reference:RN
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
Property Validators:

Comments:
The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />

sacl

Type: mo:InstSaclType
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelSacl
Property Validators:

Comments:
The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
Constants
none 0 NO COMMENTS
del 1 NO COMMENTS
mod 2 NO COMMENTS
addchild 4 NO COMMENTS
cascade 8 NO COMMENTS
DEFAULT 0 NO COMMENTS

stateQual

Type: port:StateQual
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"

Comments:
NO COMMENTS

status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
Property Validators:

Comments:
This property controls the life cycle of a managed object
Constants
removed 16u In a setter method: specifies that an object should be removed.
In the return value of a setter method: indicates that an object has been removed.
created 2u 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 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 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.

statusChangeTs

Type: scalar:Date
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

vStatus

Type: vm:Status
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
online 1 NO COMMENTS
offline 2 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS

vcDn

Type: reference:Object
Refers: dcx:Vc
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
reference to the virtual switch interface providing a pipe to corresponding DVS

vifId

Type: dcx:VIFId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:

Comments:
nxos floating veth ID
Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming