Class ape:AdapterVnic (ABSTRACT)

Class ID:60
Encrypted: false - Exportable: false - Persistent: true
Privileges: []
SNMP OID:

NO COMMENTS


Naming Rules
RN FORMAT: AdapterVnic-[name]

    [1] PREFIX=AdapterVnic
    [2] PREFIX=- PROPERTY = name




DN FORMAT: 

[0] ape/NicAgManager/Menlo-[mac1]/AdapterVnic-[name]

[1] ape/NicAgManager/Palo-[mac1]/AdapterVnic-[name]

                




Inheritance
naming:NamedObject
 ├
ape:AdapterVnic
 
 ├
ape:MenloVnic
 
 ├
ape:PaloVnic

Events
                



Faults
                



Fsms
                



Properties Summary
Defined in: ape:AdapterVnic
ape:Cookie
          scalar:Uint64
cookie  (ape:AdapterVnic:cookie)
           NO COMMENTS
scalar:UByte cos  (ape:AdapterVnic:cos)
           NO COMMENTS
address:MAC mac  (ape:AdapterVnic:mac)
           Identity properties: set by Host Agent
naming:Name
          string:Basic
name  (ape:AdapterVnic:name)
           Overrides:naming:NamedObject:name
           NO COMMENTS
reference:Object nicDn  (ape:AdapterVnic:nicDn)
           NO COMMENTS
ape:AdaptorState
          scalar:Enum16
state  (ape:AdapterVnic:state)
           Read only properties set by the adapter FW, read by NicAG
ape:VnicType
          scalar:Enum16
type  (ape:AdapterVnic:type)
           NO COMMENTS
nic:UplinkPortId
          scalar:UByte
uplinkPortId  (ape:AdapterVnic:uplinkPortId)
           Uplink port ID, identifies one of the two uplink ports (DCE) must be specified when creating a VNIC
nic:VifId
          scalar:Uint32
vifId  (ape:AdapterVnic:vifId)
           VIF ID is a unique identifier for the VNIC, SAM picks one, must be unique per adapter
scalar:UByte vifType  (ape:AdapterVnic:vifType)
           NO COMMENTS
scalar:Uint16 vlanId  (ape:AdapterVnic:vlanId)
           Properties that are set by SAM but are not settable from the NicAG, they must be set by configuring the switch server port
scalar:Uint16 vntag  (ape:AdapterVnic:vntag)
           NO COMMENTS
storage:WWN
          address:WWN
wwnn  (ape:AdapterVnic:wwnn)
           NO COMMENTS
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

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: ape:Cookie
Primitive Type: scalar:Uint64
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

cos

Type: scalar:UByte
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
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" />

mac

Type: address:MAC
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
Identity properties: set by Host Agent

name

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

nicDn

Type: reference:Object
Refers: ape:Adapter
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
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

state

Type: ape:AdaptorState
Primitive Type: scalar:Enum16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
Read only properties set by the adapter FW, read by NicAG
Constants
Unknown 0 NO COMMENTS
Present 1 NO COMMENTS
Creating 2 NO COMMENTS
Modifying 3 NO COMMENTS
Destroying 4 NO COMMENTS
CreatePend 5 NO COMMENTS
ModifyPend 6 NO COMMENTS
DestroyPend 7 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.


type

Type: ape:VnicType
Primitive Type: scalar:Enum16
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
Unknown 0 NO COMMENTS
Eth 1 NO COMMENTS
Fc 2 NO COMMENTS
Scsi 3 NO COMMENTS
DEFAULT 0 NO COMMENTS

uplinkPortId

Type: nic:UplinkPortId
Primitive Type: scalar:UByte
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
Uplink port ID, identifies one of the two uplink ports (DCE) must be specified when creating a VNIC

vifId

Type: nic:VifId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
VIF ID is a unique identifier for the VNIC, SAM picks one, must be unique per adapter

vifType

Type: scalar:UByte
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

vlanId

Type: scalar:Uint16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
Properties that are set by SAM but are not settable from the NicAG, they must be set by configuring the switch server port

vntag

Type: scalar:Uint16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

wwnn

Type: storage:WWN
Primitive Type: address:WWN
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS