Class vnic:FcGroupDef (CONCRETE)

Class ID:1321
Encrypted: false - Exportable: true - Persistent: true
Privileges: [admin, ls-compute, ls-config, ls-server, ls-storage]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.135.16

vHBA Group


Naming Rules
RN FORMAT: fc-group

    [1] PREFIX=fc-group


DN FORMAT: 

[0] org-[name]/tier-[name]/ls-[name]/grp-[name]/fc-group

[1] org-[name]/ls-[name]/grp-[name]/fc-group

[2] org-[name]/san-conn-pol-[name]/grp-[name]/fc-group

                



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.
 ├
org:Org
 
 ├
ls:Server Logical Server Definition. Holds and Regulates Specification of: identity connectivity applied to the physical compute node like compute:Blade upon association. Logical Server can serve the following purposes: associatable instance initialization template persistent ...
 
 
 ├
storage:IniGroup Initiator Group definition. This specifies the list of initiators that form a logical group for HA/Multipath purpose.
 
 
 
 ├
vnic:FcGroupDef
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
org:Org
 
 ├
ls:Tier Tier
 
 
 ├
ls:Server Logical Server Definition. Holds and Regulates Specification of: identity connectivity applied to the physical compute node like compute:Blade upon association. Logical Server can serve the following purposes: associatable instance initialization template persistent ...
 
 
 
 ├
storage:IniGroup Initiator Group definition. This specifies the list of initiators that form a logical group for HA/Multipath purpose.
 
 
 
 
 ├
vnic:FcGroupDef
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
org:Org
 
 ├
vnic:SanConnPolicy This policy describes the storage configuration that can be applied to a service profile. The storage configuration would include wwn, wwpn, iscsi vnics and vhbas. It can be referenced from a vnicConnPolicy.
 
 
 ├
storage:IniGroup Initiator Group definition. This specifies the list of initiators that form a logical group for HA/Multipath purpose.
 
 
 
 ├
vnic:FcGroupDef


Contained Hierarchy
vnic:FcGroupDef
 ├
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.
 ├
storage:ConnectionDef Policy used for specifying the target storage configuration. storage::ConnectionDef is created under storage::IniGroup, hence a local storage:ConnectionDef can be created for every IniGroup.
 
 ├
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.
 
 ├
storage:FcTargetEp FcTargetEp represents target pWWNs given by the user. An FcTargetEpMo is created for every target pWWN.
 
 
 ├
storage:VsanRef VsanRefMo represents the Vsan applied on the storage:Target/ User-defined FC Zone. A VsanRefMo is created for every Vsan applied on the storage:Target/ User-defined FC Zone.
 
 
 
 ├
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
naming:NamedObject
 ├
policy:Object
 
 ├
policy:Definition
 
 
 ├
vnic:AGroup Vnic Group Base Class
 
 
 
 ├
vnic:FcGroupDef

Events
                



Faults
                



Fsms
                



Properties Summary
Defined in: vnic:FcGroupDef
naming:Name
          string:Basic
adaptorProfileName  (vnic:FcGroupDef:adaptorProfileName)
           Overrides:vnic:AGroup:adaptorProfileName
           NO COMMENTS
pool:Name
          string:Basic
identPoolName  (vnic:FcGroupDef:identPoolName)
           Overrides:vnic:AGroup:identPoolName
           NO COMMENTS
storage:MaxDataFieldSize
          scalar:Uint32
maxDataFieldSize  (vnic:FcGroupDef:maxDataFieldSize)
           MaxDataFieldSize for the group members.
naming:Name
          string:Basic
nwTemplName  (vnic:FcGroupDef:nwTemplName)
           Overrides:vnic:AGroup:nwTemplName
           NO COMMENTS
reference:Object operStorageConnPolicyName  (vnic:FcGroupDef:operStorageConnPolicyName)
           NO COMMENTS
naming:Name
          string:Basic
qosPolicyName  (vnic:FcGroupDef:qosPolicyName)
           Overrides:vnic:AGroup:qosPolicyName
           NO COMMENTS
naming:Name
          string:Basic
storageConnPolicyName  (vnic:FcGroupDef:storageConnPolicyName)
           Remote storage::ConnectionPolicy name. This policy contains the target storage configuration.
Defined in: vnic:AGroup
naming:Descr
          string:Basic
descr  (vnic:AGroup:descr)
           Overrides:policy:Definition:descr
           Description is not provided by the user. No Need to backup descr. This object is created internally.
naming:Name
          string:Basic
name  (vnic:AGroup:name)
           Overrides:policy:Object:name | naming:NamedObject:name
           Name is not provided by the user. No Need to backup name. This object is created internally.
reference:Object operStatsPolicyName  (vnic:AGroup:operStatsPolicyName)
           NO COMMENTS
naming:Name
          string:Basic
statsPolicyName  (vnic:AGroup:statsPolicyName)
           Stats Policy Name for the members of the group.
Defined in: policy:Definition
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

adaptorProfileName

Type: naming:Name
Primitive Type: string:Basic
Overrides:vnic:AGroup:adaptorProfileName
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
Comments:
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

descr

Type: naming:Descr
Primitive Type: string:Basic
Overrides:policy:Definition:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "256"
        Allowed Chars:
            Regex: [a-zA-Z0-9\[\]!#$%()*+,-./:;@ _{|}˜?&]+
Comments:
Description is not provided by the user. No Need to backup descr. This object is created internally.

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

identPoolName

Type: pool:Name
Primitive Type: string:Basic
Overrides:vnic:AGroup:identPoolName
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "32"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
Comments:
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

maxDataFieldSize

Type: storage:MaxDataFieldSize
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)256l  max: (long)2112l
Comments:
MaxDataFieldSize for the group members.
Constants
defaultValue 2048u NO COMMENTS

name

Type: naming:Name
Primitive Type: string:Basic
Overrides:policy:Object:name  |  naming:NamedObject:name
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
Comments:
Name is not provided by the user. No Need to backup name. This object is created internally.

nwTemplName

Type: naming:Name
Primitive Type: string:Basic
Overrides:vnic:AGroup:nwTemplName
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
Comments:
NO COMMENTS

operStatsPolicyName

Type: reference:Object
Refers: stats:ThresholdPolicy
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

operStorageConnPolicyName

Type: reference:Object
Refers: storage:ConnectionPolicy
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
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

qosPolicyName

Type: naming:Name
Primitive Type: string:Basic
Overrides:vnic:AGroup:qosPolicyName
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
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

statsPolicyName

Type: naming:Name
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Policy Reference to: stats:ThresholdPolicy
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
Comments:
Stats Policy Name for the members of the group.
Constants
defaultValue "default" 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.


storageConnPolicyName

Type: naming:Name
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Policy Reference to: storage:ConnectionPolicy
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
Comments:
Remote storage::ConnectionPolicy name. This policy contains the target storage configuration.