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

Class vnic:Profile (CONCRETE)

Class ID:193
Encrypted: false - Exportable: true - Persistent: true
Privileges: [admin, ls-network, ls-network-policy]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.135.57

A vnic profile is a policy applied to vnic/connectivity resources dynamically requested by a hypervisor. It defines:
  1. Connectivity rules by referring to a set of networks (VLANs) via contained vnic:EtherIf objects. Each contained vnic:EtherIf refers to a named VLAN.
  2. Qos policy binding
Typically, a vnic:Profile is configured with a single VLAN. When that is the case, virtual machines attached to the port profile send and receive packets without 802.1q tags.
When a vnic:Profile is configured with multiple VLANs, virtual machines attached to the port profile must be able to handle 802.1q tags.

To create a network end-point that can be used by a Virtual Machine, perform the following operations:

  1. Create a vnic:Profile and assign VLANs through contained vnic:EtherIf objects.
  2. Add at least one vm:VnicProfCl child to the vnic:Profile. This object specifies a criteria for determining the set of switches where the port profile should be configured.
  3. Create a vm:Switch object, which represents a switch in a Virtual Machine Manager
Under each applicable vm:Switch (based on the vm:VnicProfCl criteria), vm:VnicProfInst objects will be created automatically. Each vm:VnicProfInst represents a configured vnic:Profile.

Naming Rules 
RN FORMAT: vnic-[name]

    [1] PREFIX=vnic- PROPERTY = name




DN FORMAT: 

[0] fabric/lan/profiles/vnic-[name]


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.
 ├
 		fabric:Ep The root container of all fabric configuration objects.
 
 		 ├
 		fabric:LanCloud A container for logical Ethernet configuration Objects that span across the Fabric Interconnects. The contained configuration objects specify the logical Ethernet configuration, including fabric A and B, VLANs, pin groups, flow control policy, QoS policy, threshold policy, and port profiles.
 
 		 
 		 ├
 		vnic:ProfileSet A collection of vnic profile policies.
 
 		 
 		 
 		 ├
 		vnic:Profile


Contained Hierarchy
vnic:Profile
 ├
 		fabric:FlowMonSrcEp An abstract representation of a source interface in a flow monitoring session.
 ├
 		fabric:NetGroupRef
 
 		 ├
 		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.
 ├
 		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.
 ├
 		sw:NetflowMonitorRef
 ├
 		vm:VnicProfCl A Port Profile Client is contained in a vnic:Profile and specifies the set of virtual switches where the port profile is deployed. A vnic:Profile Managed Object is a policy that specifies the characteristics of the port profile, such as QoS, PIN group and network control policy. However, vnic:Profile does not specify on which virtual switches the port profile should actuall...
 ├
 		vnic:EtherIf A logical Ethernet Interface connected to a single Layer 2 network. Multiple vnic:EtherIf instances can belong to a single network adapter. For example, to create a service profile with one network adapter configured in trunk mode, add a vnic:Ether MO, which represents the network adapter. Then add a vnic:EtherIf MO as a child of vnic:Ether for each VLAN that you want to expose to the network adapter.
 
 		 ├
 		fabric:NetflowIPv4Addr Represents the source ip-address of the SVI on a given fabric. this is in turn used by the exporter vNICs on sereno. Separate vNICs are used per fabric interconnect for exporting flow records to the external collector using the same user specified VLAN. A different source ip is used for each of these vNIC.
 
 		 ├
 		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.
 
 		 ├
 		vnic:IPv4If Represents a network end-point configured with an IPv4 Interface. An IP interface can be provisioned using a user-specified static address, a pool of IP addresses or through DHCP. Optionally, the IPv4 interface may be provisionned with a default gateway, static routes and DNS servers.
 
 		 
 		 ├
 		vnic:IPv4Dhcp Represents an IPv4 interface which is configured at run-time through DHCP.
 
 		 
 		 ├
 		vnic:IPv4Dns Represents the IP address of a DNS server, which is used to resolve host names to IP addresses.
 
 		 
 		 ├
 		vnic:IPv4StaticRoute Represents a statically configured IPv4 route entry. A static route is configured by specifying a destination network and next hop router.
 
 		 
 		 ├
 		vnic:IfRole An abstract base class representing the role(s) assigned to the IP interface
 
 		 
 		 ├
 		vnic:IpV4Addr An abstract base class for IP v4 addresses.
 
 		 
 		 ├
 		vnic:IpV4PooledAddr Represents the IPv4 address of an IP interface, where the IP address is obtained from a pool of IP addresses.
 
 		 
 		 
 		 ├
 		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.
 
 		 
 		 
 		 ├
 		vnic:IpV4History A temporary object used to hold the history of ipv4 address of MOs.
 
 		 
 		 ├
 		vnic:IpV4StaticAddr Represents a statically assigned IPv4 address.
 ├
 		vnic:OProfileAlias Other aliases, for non-vmware
 ├
 		vnic:ProfileAlias
Inheritance
naming:NamedObject
 ├
 		policy:Object
 
 		 ├
 		policy:Definition
 
 		 
 		 ├
 		vnic:Profile
Events


Faults 
                vnic:Profile:profileConfigIncorrect


Fsms


Properties Summary
Defined in: vnic:Profile
nwctrl:AdminState
          scalar:Enum8 		cdp  (vnic:Profile:cdp)
           NO COMMENTS
vnic:ProfileConfigQualifier
          scalar:Enum8 		configQualifier  (vnic:Profile:configQualifier)
           NO COMMENTS
qos:Class
          scalar:UByte 		cos  (vnic:Profile:cos)
           NO COMMENTS
dpsec:ForgedTransmit
          scalar:Enum8 		forgeMac  (vnic:Profile:forgeMac)
           NO COMMENTS
vnic:HostNwIOPerfPref
          scalar:Enum8 		hostNwIOPerf  (vnic:Profile:hostNwIOPerf)
           NO COMMENTS
nwctrl:LldpAdminStateBitmask
          scalar:Bitmask8 		lldp  (vnic:Profile:lldp)
           NO COMMENTS
nwctrl:RegistrationMode
          scalar:Enum8 		macRegisterMode  (vnic:Profile:macRegisterMode)
           NO COMMENTS
scalar:Uint16 maxPorts  (vnic:Profile:maxPorts)
           NO COMMENTS
naming:Name
          string:Basic 		name  (vnic:Profile:name)
           Overrides:policy:Object:name | naming:NamedObject:name
           NO COMMENTS
naming:Name
          string:Basic 		nwCtrlPolicyName  (vnic:Profile:nwCtrlPolicyName)
           NO COMMENTS
reference:Object operNwCtrlPolicyName  (vnic:Profile:operNwCtrlPolicyName)
           NO COMMENTS
reference:Object operQosPolicyName  (vnic:Profile:operQosPolicyName)
           NO COMMENTS
naming:Name
          string:Basic 		pinToGroupName  (vnic:Profile:pinToGroupName)
           NO COMMENTS
address:UUID portProfileUuid  (vnic:Profile:portProfileUuid)
           NO COMMENTS
network:VNetId
          scalar:Uint32 		primaryVlanId  (vnic:Profile:primaryVlanId)
           NO COMMENTS
reference:Object qosPolicyDn  (vnic:Profile:qosPolicyDn)
           NO COMMENTS
policy:InternalId
          scalar:Uint32 		qosPolicyId  (vnic:Profile:qosPolicyId)
           NO COMMENTS
naming:Name
          string:Basic 		qosPolicyName  (vnic:Profile:qosPolicyName)
           NO COMMENTS
equipment:Id
          scalar:Uint32 		swABorderAggrPort  (vnic:Profile:swABorderAggrPort)
           NO COMMENTS
equipment:Id
          scalar:Uint32 		swABorderPort  (vnic:Profile:swABorderPort)
           NO COMMENTS
equipment:Id
          scalar:Uint32 		swABorderSlot  (vnic:Profile:swABorderSlot)
           NO COMMENTS
equipment:Id
          scalar:Uint32 		swBBorderAggrPort  (vnic:Profile:swBBorderAggrPort)
           NO COMMENTS
equipment:Id
          scalar:Uint32 		swBBorderPort  (vnic:Profile:swBBorderPort)
           NO COMMENTS
equipment:Id
          scalar:Uint32 		swBBorderSlot  (vnic:Profile:swBBorderSlot)
           NO COMMENTS
vnic:portProfileType
          scalar:Enum8 		type  (vnic:Profile:type)
           NO COMMENTS
nwctrl:LinkFailAction
          scalar:Enum8 		uplinkFailAction  (vnic:Profile:uplinkFailAction)
           NO COMMENTS
Defined in: policy:Definition
naming:Descr
          string:Basic 		descr  (policy:Definition:descr)
           NO COMMENTS
policy:InternalId
          scalar:Uint32 		intId  (policy:Definition:intId)
           NO COMMENTS
scalar:Uint32 policyLevel  (policy:Definition:policyLevel)
           policyLevel is used internally by generic policy server.
policy:PolicyOwner
          scalar:Enum8 		policyOwner  (policy:Definition:policyOwner)
           "local" denotes policy created by local policy client, "policy" denotes a policy created by remote policy server.
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

cdp

Type: nwctrl:AdminState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
disabled 0 NO COMMENTS
enabled 1 NO COMMENTS
DEFAULT disabled(0) NO COMMENTS

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

configQualifier

Type: vnic:ProfileConfigQualifier
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
normal 0 NO COMMENTS
invalid-name 1 NO COMMENTS
DEFAULT normal(0) NO COMMENTS

cos

Type: qos:Class
Primitive Type: scalar:UByte
Like: epqos:Conf:cos
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: (short)0  max: (short)6
    Range:  min: (short)255  max: (short)255

Comments:
NO COMMENTS
Constants
any 255 NO COMMENTS
defaultValue 0 NO COMMENTS

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: "256"
        Allowed Chars:
            Regex: [a-zA-Z0-9\[\]!#$%()*+,-./:;@ _{|}˜?&]+

Comments:
NO COMMENTS

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" />

forgeMac

Type: dpsec:ForgedTransmit
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
allow 0 NO COMMENTS
deny 1 NO COMMENTS
DEFAULT allow(0) NO COMMENTS

hostNwIOPerf

Type: vnic:HostNwIOPerfPref
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
none 0 NO COMMENTS
high-perf-reqd 1 NO COMMENTS
DEFAULT none(0) NO COMMENTS

intId

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

Comments:
NO COMMENTS
Constants
none 0u NO COMMENTS
DEFAULT none(0u) NO COMMENTS

lldp

Type: nwctrl:LldpAdminStateBitmask
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
none 0x00 NO COMMENTS
transmit 0x01 NO COMMENTS
receive 0x02 NO COMMENTS
all 0x03 NO COMMENTS
DEFAULT none(0x00) NO COMMENTS

macRegisterMode

Type: nwctrl:RegistrationMode
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
only-native-vlan 0 NO COMMENTS
all-host-vlans 1 NO COMMENTS
DEFAULT only-native-vlan(0) NO COMMENTS

maxPorts

Type: scalar:Uint16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: 1  max: 4096

Comments:
NO COMMENTS
Constants
defaultValue 64 NO COMMENTS

name

Type: naming:Name
Primitive Type: string:Basic
Overrides:policy:Object:name  |  naming:NamedObject:name
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "31"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+

Comments:
NO COMMENTS

nwCtrlPolicyName

Type: naming:Name
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Policy Reference to: nwctrl:Definition
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+

Comments:
NO COMMENTS

operNwCtrlPolicyName

Type: reference:Object
Refers: nwctrl:Definition
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

operQosPolicyName

Type: reference:Object
Refers: epqos:Definition
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

pinToGroupName

Type: naming:Name
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+

Comments:
NO COMMENTS

policyLevel

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

Comments:
policyLevel is used internally by generic policy server.

policyOwner

Type: policy:PolicyOwner
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
"local" denotes policy created by local policy client, "policy" denotes a policy created by remote policy server.
Constants
local 0 NO COMMENTS
policy 1 NO COMMENTS
pending-policy 2 NO COMMENTS
DEFAULT local(0) NO COMMENTS

portProfileUuid

Type: address:UUID
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

primaryVlanId

Type: network:VNetId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)4093l

Comments:
NO COMMENTS
Constants
defaultValue 0u NO COMMENTS

qosPolicyDn

Type: reference:Object
Like: epqos:Conf:qosPolicyDn
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

qosPolicyId

Type: policy:InternalId
Primitive Type: scalar:Uint32
Like: epqos:Conf:qosPolicyId
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
none 0u NO COMMENTS
DEFAULT none(0u) NO COMMENTS

qosPolicyName

Type: naming:Name
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Policy Reference to: epqos:Definition
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+

Comments:
NO COMMENTS

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

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.

swABorderAggrPort

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

Comments:
NO COMMENTS

swABorderPort

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

Comments:
NO COMMENTS

swABorderSlot

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

Comments:
NO COMMENTS

swBBorderAggrPort

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

Comments:
NO COMMENTS

swBBorderPort

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

Comments:
NO COMMENTS

swBBorderSlot

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

Comments:
NO COMMENTS

type

Type: vnic:portProfileType
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
regular 0 NO COMMENTS
sla-only 1 NO COMMENTS
DEFAULT regular(0) NO COMMENTS

uplinkFailAction

Type: nwctrl:LinkFailAction
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
link-down 0 NO COMMENTS
warning 1 NO COMMENTS
DEFAULT link-down(0) NO COMMENTS
Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming