Class fabric:NetGroup (CONCRETE)

Class ID:1467
Encrypted: false - Exportable: true - Persistent: true
Privileges: [admin, ext-lan-config, ext-lan-policy]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.45.80

A group of VLANs. A fabric:NetGroup contains zero or more pool members, each member refers to a named fabric:Vlan. One of the member may be tagged as the native VLAN, using the fabric:PooledVlan:isNative property. At most one member VLAN can be tagged as the native VLAN. A fabric:NetGroup can be assigned to logical entities, such as service profile vNICs, Ethernet border ports, or internal interfaces for Layer 3 switching.


Naming Rules
RN FORMAT: net-group-[name]

    [1] PREFIX=net-group- PROPERTY = name




DN FORMAT: 

[0] fabric/lan/[id]/net-group-[name]

[1] fabric/lan/net-group-[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.
 
 
 ├
fabric:EthLan Represents an Ethernet fabric, which contains the user-configured VLANs, Ethernet interfaces and Ethernet port channel interfaces. In a UCS HA configuration, there are two Ethernet Fabrics, A and B. Each fabric can contain a distinct set of configured VLANs, Ethernet interfaces and port channel interfaces. The VLAN may be configured per Ethernet fabric (i.e. fabric A or fabric B) or per Lan Cloud, in which case the VLAN wi...
 
 
 
 ├
fabric:NetGroup
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.
 
 
 ├
fabric:NetGroup


Contained Hierarchy
fabric:NetGroup
 ├
fabric:EthVlanPc Represents an association between a VLAN and an Ethernet port channel. This MO is added as a child of fabric:Vlan and indicates the specified Ethernet port channel should carry the VLAN ID of the parent fabric:Vlan.
 
 ├
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.
 ├
fabric:EthVlanPortEp Represents an association between a VLAN and an Ethernet port. This MO is added as a child of fabric:Vlan and indicates the specified Ethernet port should carry the VLAN ID of the parent fabric:Vlan.
 
 ├
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.
 ├
fabric:PooledVlan A fabric:Vlan that is a member of a pool. This object is a subclass of generic PoolMember class and provides a pool membership relationship between containing pool and the Poolable VLAN. A given fabric:Vlan can be a member of multiple pools.
 
 ├
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.
 ├
fabric:SwSubGroup A SwSubGroup contains ports which are made availabe by connecting a break-out cable to an aggregated port. (For FcoeVsanPortEp and EthVlanPortEp) Example in UCS-Mini a 40GB Scalability port is connected to a 4x10GB breakout cable to get 4 10GB ports.
 
 ├
fabric:EthVlanPortEp Represents an association between a VLAN and an Ethernet port. This MO is added as a child of fabric:Vlan and indicates the specified Ethernet port should carry the VLAN ID of the parent fabric:Vlan.
 
 
 ├
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.
 
 ├
fabric:FcoeVsanPortEp FCoE Port that attaches to the parent VSAN. Indicates the parent VSAN will be configured on the specified FCoE port. This is configured explicitly by the user.
 
 
 ├
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.

Inheritance
naming:NamedObject
 ├
policy:Object
 
 ├
policy:Definition
 
 
 ├
pool:Pool Abstraction of shared resource pool. A generic abstraction of resource pool. Pool contains PoolMembership objects that terminate on corresponding Poolable entities. If such PoolMember relationship exists a corresponding Poolable object is said to be a member of given pool.
 
 
 
 ├
fabric:NetGroup

Events
                



Faults
                fabric:NetGroup:NativeVlanNotFound



Fsms
                



Properties Summary
Defined in: fabric:NetGroup
fabric:NetGroupConfigIssues
          scalar:Bitmask64
configIssues  (fabric:NetGroup:configIssues)
           NetGroup configuration issues.
fabric:GroupId
          scalar:Uint32
id  (fabric:NetGroup:id)
           The Network Group ID. Each group has a unique group ID within a fabric side (A or B)
naming:Name
          string:Basic
name  (fabric:NetGroup:name)
           Overrides:pool:Pool:name | policy:Object:name | naming:NamedObject:name
           NO COMMENTS
string:Basic nativeNet  (fabric:NetGroup:nativeNet)
           The name of a fabric:Vlan which will be used as the native VLAN
reference:Object nativeNetDn  (fabric:NetGroup:nativeNetDn)
           The resolved DN of the native fabric:Vlan.
fabric:Owner
          scalar:Enum8
owner  (fabric:NetGroup:owner)
           The owner of this network group. Indicates if the group was created by the system or by the user.
reference:Object peerDn  (fabric:NetGroup:peerDn)
           A reference to a sw:VlanGroup instance. This property is set for VLAN compression groups.
network:SwitchId
          scalar:Enum8
switchId  (fabric:NetGroup:switchId)
           The switch ID
fabric:NetGroupType
          scalar:Bitmask8
type  (fabric:NetGroup:type)
           The Network Group type. User-created Network Groups can be used to simplify assignment of border ports to VLANs and assignment of VLAN to Service Profile vNICs. System-created Network Groups represent VLAN compression groups, which are an internal optimization to support higher P,V count.
Defined in: pool:Pool
pool:Size
          scalar:Uint32
assigned  (pool:Pool:assigned)
           The number of resources in this pool that have been assigned to a logical entity
scalar:Enum8 assignmentOrder  (pool:Pool:assignmentOrder)
           flag for sequentially assign entry from the pool, default is none-sequential for backward compitible
naming:Descr
          string:Basic
descr  (pool:Pool:descr)
           Overrides:policy:Definition:descr
           NO COMMENTS
pool:Size
          scalar:Uint32
size  (pool:Pool:size)
           The current number of resources in this pool.
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

assigned

Type: pool:Size
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
The number of resources in this pool that have been assigned to a logical entity

assignmentOrder

Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
flag for sequentially assign entry from the pool, default is none-sequential for backward compitible
Constants
default 0 NO COMMENTS
sequential 1 NO COMMENTS
DEFAULT default(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

configIssues

Type: fabric:NetGroupConfigIssues
Primitive Type: scalar:Bitmask64
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NetGroup configuration issues.
Constants
not-applicable 0ull Not applicable
native-vlan-not-found 1ull Native vlan is not found
DEFAULT not-applicable(0ull) Not applicable

descr

Type: naming:Descr
Primitive Type: string:Basic
Overrides:policy:Definition:descr
Paths: 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" />

id

Type: fabric:GroupId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
The Network Group ID. Each group has a unique group ID within a fabric side (A or B)

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

name

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

nativeNet

Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"
Comments:
The name of a fabric:Vlan which will be used as the native VLAN

nativeNetDn

Type: reference:Object
Refers: fabric:Vlan
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
The resolved DN of the native fabric:Vlan.

owner

Type: fabric:Owner
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
The owner of this network group. Indicates if the group was created by the system or by the user.
Constants
policy 1 Indicates the MO has been created implicitly by the system
management 2 Indicates the MO has been created explicitly by the XML API user
DEFAULT management(2) Indicates the MO has been created explicitly by the XML API user

peerDn

Type: reference:Object
Refers: sw:VlanGroup
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
A reference to a sw:VlanGroup instance. This property is set for VLAN compression groups.

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

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

size

Type: pool:Size
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
The current number of resources in this pool.

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.


switchId

Type: network:SwitchId
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
The switch ID
Constants
NONE 0 NO COMMENTS
A 1 NO COMMENTS
B 2 NO COMMENTS
dual 3 Indicates this fabric:NetGroup is global and applies to both Fabric Interconnects.
DEFAULT dual(3) Indicates this fabric:NetGroup is global and applies to both Fabric Interconnects.

type

Type: fabric:NetGroupType
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
The Network Group type. User-created Network Groups can be used to simplify assignment of border ports to VLANs and assignment of VLAN to Service Profile vNICs. System-created Network Groups represent VLAN compression groups, which are an internal optimization to support higher P,V count.
Constants
mgmt 1 A user-created Network Group that can be used to simplify assignment of border ports to VLANs and assignment of VLAN to Service Profile vNICs
vlan-compression 2 A system-created Network Group that represents a VLAN compression group. XML API users cannot manually create VLAN compression groups.
vlan-uncompressed 4 A system-created Network Group that represents a uncompressed VLAN group. XML API users cannot manually create a uncompressed VLAN group.
vp-compression 8 A system-created Network Group that represents a VLAN compression group. XML API users cannot manually create VLAN compression groups.
DEFAULT mgmt(1) A user-created Network Group that can be used to simplify assignment of border ports to VLANs and assignment of VLAN to Service Profile vNICs