Class fabric:PooledVlan (CONCRETE)

Class ID:1468
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.47.97

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.


Naming Rules
RN FORMAT: net-[name]

    [1] PREFIX=net- PROPERTY = name




DN FORMAT: 

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

[1] fabric/lan/net-group-[name]/net-[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 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, Et...
 
 
 
 
 ├
fabric:PooledVlan
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 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, Et...
 
 
 
 ├
fabric:PooledVlan


Contained Hierarchy
fabric:PooledVlan
 ├
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
pool:PoolMember Abstraction of pool membership relationship. Represents pool membership of a corresponding Poolable object. This object is instantiated under Pool to make target Poolable object a member of the containing pool. When such PoolMember object is deleted pool membership of the corresponding Poolable object is terminated.
 ├
fabric:PooledVlan

Events
                



Faults
                fabric:PooledVlan:NamedVlanUnresolved



Fsms
                



Properties Summary
Defined in: fabric:PooledVlan
reference:Object assignedToDn  (fabric:PooledVlan:assignedToDn)
           Overrides:pool:PoolMember:assignedToDn
           Always empty. A VLAN can be assigned to more than one logical entity.
fabric:PoolMemberConfigIssues
          scalar:Bitmask64
configIssues  (fabric:PooledVlan:configIssues)
           VLAN configuration issues.
string:Basic name  (fabric:PooledVlan:name)
           The name of a fabric:Vlan instance. This property indicates the named fabric:Vlan is a member of the parent fabric:NetGroup.
reference:Object peerDn  (fabric:PooledVlan:peerDn)
           A reference to a sw:Vlan instance
reference:Object poolableDn  (fabric:PooledVlan:poolableDn)
           Overrides:pool:PoolMember:poolableDn
           The DN of a fabric:Vlan
reference:Object prevAssignedToDn  (fabric:PooledVlan:prevAssignedToDn)
           Overrides:pool:PoolMember:prevAssignedToDn
           Always empty. A VLAN can be assigned to more than one logical entity.
Defined in: pool:PoolMember
pool:Assignement
          scalar:Bool
assigned  (pool:PoolMember:assigned)
           True if this pool member has been assigned. False if this pool member is not assigned to any logical entity. If the pool member can be assigned to multiple logical entities, this property is set to true when the pool member has been assigned to at least one logical entity.
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:Assignement
Primitive Type: scalar:Bool
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
True if this pool member has been assigned. False if this pool member is not assigned to any logical entity. If the pool member can be assigned to multiple logical entities, this property is set to true when the pool member has been assigned to at least one logical entity.
Constants
yes true NO COMMENTS
no false NO COMMENTS

assignedToDn

Type: reference:Object
Overrides:pool:PoolMember:assignedToDn
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
Always empty. A VLAN can be assigned to more than one logical entity.

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:PoolMemberConfigIssues
Primitive Type: scalar:Bitmask64
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
VLAN configuration issues.
Constants
not-applicable 0ull Not applicable
named-vlan-unresolved 1ull Named vlan is not resolvable
DEFAULT not-applicable(0ull) Not applicable

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

name

Type: string:Basic
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "510"
Comments:
The name of a fabric:Vlan instance. This property indicates the named fabric:Vlan is a member of the parent fabric:NetGroup.

peerDn

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

poolableDn

Type: reference:Object
Refers: fabric:Vlan
Overrides:pool:PoolMember:poolableDn
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
The DN of a fabric:Vlan

prevAssignedToDn

Type: reference:Object
Overrides:pool:PoolMember:prevAssignedToDn
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
Always empty. A VLAN can be assigned to more than one logical entity.

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.