Class sw:VlanGroup (CONCRETE)

Class ID:1418
Encrypted: false - Exportable: false - Persistent: true
Privileges: [read-only]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.122.60

A Group containing zero or more sw:Vlan instances. This object is used to model VLAN compression groups.


Naming Rules
RN FORMAT: vlan-group-[id]

    [1] PREFIX=vlan-group- PROPERTY = id




DN FORMAT: 

[0] sys/switch-[id]/border-eth/vlan-group-[id]

                



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.
 ├
top:System Provides general information about this system, such as the name, IP address and current time.
 
 ├
network:Element Represents a physical network element, such as a Fabric Interconnect.
 
 
 ├
sw:EthLanBorder Represents Switch Ethernet LAN Border Domain which is a collection of Ethernet physical ports and port channels and their configurations.
 
 
 
 ├
sw:VlanGroup


Contained Hierarchy
sw:VlanGroup
 ├
sw:VIFRef A reference to a VIF
 ├
sw:VlanRef A reference to a sw:Vlan

Inheritance
sw:VlanGroup

Events
                



Faults
                



Fsms
                



Properties Summary
Defined in: sw:VlanGroup
sw:GroupId
          scalar:Uint32
id  (sw:VlanGroup:id)
           The VLAN Group ID. Every VLAN group has a unique group ID within a fabric side (A or B) For VLAN Optimization group, IDs starts with 0 to max of 40K. For VP Optimization group, IDs starts with 5000 TBD-KETAN: ADD RIGHT REFERENCE FOR 5000
reference:Object peerDn  (sw:VlanGroup:peerDn)
           A reference to a fabric:NetGroup instance
scalar:Uint32 pvScore  (sw:VlanGroup:pvScore)
           A PV Score for this group numVIFs * numVlans
network:SwitchId
          scalar:Enum8
switchId  (sw:VlanGroup:switchId)
           The fabric side (A or B)
sw:VlanGroupType
          scalar:Enum8
type  (sw:VlanGroup:type)
           A group type
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

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: sw:GroupId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
Comments:
The VLAN Group ID. Every VLAN group has a unique group ID within a fabric side (A or B) For VLAN Optimization group, IDs starts with 0 to max of 40K. For VP Optimization group, IDs starts with 5000 TBD-KETAN: ADD RIGHT REFERENCE FOR 5000

peerDn

Type: reference:Object
Refers: fabric:NetGroup
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
A reference to a fabric:NetGroup instance

pvScore

Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
A PV Score for this group numVIFs * numVlans

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.


switchId

Type: network:SwitchId
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
The fabric side (A or B)
Constants
NONE 0 NO COMMENTS
A 1 NO COMMENTS
B 2 NO COMMENTS
DEFAULT A(1) NO COMMENTS

type

Type: sw:VlanGroupType
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
A group type
Constants
compressed 1 A system-created SW VLAN Group that represents a VLAN compression group. XML API users cannot manually create VLAN compression groups.
uncompressed 2 A system-created SW VLAN Group that represents a uncompressed VLAN group. XML API users cannot manually create a uncompressed VLAN group.
vp-compressed 3 A system-created SW VLAN Group that represents a VP compression group. XML API users cannot manually create VP compression groups.
DEFAULT compressed(1) A system-created SW VLAN Group that represents a VLAN compression group. XML API users cannot manually create VLAN compression groups.