Class fabric:SwSubGroup (CONCRETE)

Class ID:2144
Encrypted: false - Exportable: true - Persistent: true
Privileges: [admin, ls-network, ls-network-policy]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.45.106

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.


Naming Rules
RN FORMAT: sw-[switchId]-slot-[slotId]-aggr-port-[aggrPortId]

    [1] PREFIX=sw- PROPERTY = switchId


    [2] PREFIX=-slot- PROPERTY = slotId


    [3] PREFIX=-aggr-port- PROPERTY = aggrPortId




DN FORMAT: 

[0] fabric/lan/[id]/net-group-[name]/sw-[switchId]-slot-[slotId]-aggr-port-[aggrPortId]

[1] fabric/lan/net-group-[name]/sw-[switchId]-slot-[slotId]-aggr-port-[aggrPortId]

[2] fabric/eth-estc/[id]/net-[name]/sw-[switchId]-slot-[slotId]-aggr-port-[aggrPortId]

[3] fabric/eth-estc/net-[name]/sw-[switchId]-slot-[slotId]-aggr-port-[aggrPortId]

[4] fabric/lan/[id]/net-[name]/sw-[switchId]-slot-[slotId]-aggr-port-[aggrPortId]

[5] fabric/lan/net-[name]/sw-[switchId]-slot-[slotId]-aggr-port-[aggrPortId]

[6] fabric/fc-estc/[id]/net-[name]/sw-[switchId]-slot-[slotId]-aggr-port-[aggrPortId]

[7] fabric/fc-estc/net-[name]/sw-[switchId]-slot-[slotId]-aggr-port-[aggrPortId]

[8] fabric/san/[id]/net-[name]/sw-[switchId]-slot-[slotId]-aggr-port-[aggrPortId]

[9] fabric/san/net-[name]/sw-[switchId]-slot-[slotId]-aggr-port-[aggrPortId]

                



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:EthEstcCloud A container of logical Configuration Objects for Ethernet-based storage, such as NFS filers attached to the Fabric Interconnects ports. The contained configuration objects specify the logical storage configuration, including logical ports on fabric A and B, VLANs used specifically for NAS storage, and threshold policy.
 
 
 ├
fabric:EthEstc Container for External Storage Target Connectivity (ESTC) Objects that are specific to a Fabric Interconnect.
 
 
 
 ├
fabric:Vlan A user-created object representing a named Layer 2 bridge in an Ethernet Fabric or LAN Cloud. Create an instance of this MO to configure a VLAN on the UCS Fabric Interconnect (A or B). To create a VLAN on both UCS Fabric Interconnects, create this MO as a child of fabricLanCloud.
 
 
 
 
 ├
fabric:SwSubGroup
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:EthEstcCloud A container of logical Configuration Objects for Ethernet-based storage, such as NFS filers attached to the Fabric Interconnects ports. The contained configuration objects specify the logical storage configuration, including logical ports on fabric A and B, VLANs used specifically for NAS storage, and threshold policy.
 
 
 ├
fabric:Vlan A user-created object representing a named Layer 2 bridge in an Ethernet Fabric or LAN Cloud. Create an instance of this MO to configure a VLAN on the UCS Fabric Interconnect (A or B). To create a VLAN on both UCS Fabric Interconnects, create this MO as a child of fabricLanCloud.
 
 
 
 ├
fabric:SwSubGroup
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:FcEstcCloud A container of Fibre-Channel configuration Objects that span across the Fabric Interconnects. The contained configuration objects specify the logical configuration for direct-attach Fibre Channel storage to the Fabric Interconnect.
 
 
 ├
fabric:FcEstc A logical FC port channel on a Fabric Interconnect, for connectivity to an external FC storage, using an FC port channel.
 
 
 
 ├
fabric:Vsan A VSAN provides the ability to create completely isolated fabric topologies, with its own set of fabric services, on top of a scalable common physical infrastructure. As each VSAN possesses its own zoning service, zoning is then configured within each VSAN independently and has no affect on any other VSAN and zoning service
 
 
 
 
 ├
fabric:SwSubGroup
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:FcEstcCloud A container of Fibre-Channel configuration Objects that span across the Fabric Interconnects. The contained configuration objects specify the logical configuration for direct-attach Fibre Channel storage to the Fabric Interconnect.
 
 
 ├
fabric:Vsan A VSAN provides the ability to create completely isolated fabric topologies, with its own set of fabric services, on top of a scalable common physical infrastructure. As each VSAN possesses its own zoning service, zoning is then configured within each VSAN independently and has no affect on any other VSAN and zoning service
 
 
 
 ├
fabric:SwSubGroup
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:SwSubGroup
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:Vlan A user-created object representing a named Layer 2 bridge in an Ethernet Fabric or LAN Cloud. Create an instance of this MO to configure a VLAN on the UCS Fabric Interconnect (A or B). To create a VLAN on both UCS Fabric Interconnects, create this MO as a child of fabricLanCloud.
 
 
 
 
 ├
fabric:SwSubGroup
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:SwSubGroup
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:Vlan A user-created object representing a named Layer 2 bridge in an Ethernet Fabric or LAN Cloud. Create an instance of this MO to configure a VLAN on the UCS Fabric Interconnect (A or B). To create a VLAN on both UCS Fabric Interconnects, create this MO as a child of fabricLanCloud.
 
 
 
 ├
fabric:SwSubGroup
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:SanCloud A container for logical Fibre Channel configuration Objects that span across the Fabric Interconnects. The contained configuration objects specify the logical Fibre Channel configuration, including fabric A and B, VSANs, pin groups, and threshold policy.
 
 
 ├
fabric:FcSan Represents a SAN fabric, which contains the user-configured VSANs, Fibre Channel (FC) interfaces and FC port channel interfaces. In a UCS HA configuration, there are two SAN Fabrics, A and B. Each fabric can contain a distinct set of configured VSANs, FC interfaces and port channel interfaces. The VSAN may be configured per SAN fabric (i.e. fabric A or fabric B) or per San Cloud, in which case the VSAN will be configure...
 
 
 
 ├
fabric:Vsan A VSAN provides the ability to create completely isolated fabric topologies, with its own set of fabric services, on top of a scalable common physical infrastructure. As each VSAN possesses its own zoning service, zoning is then configured within each VSAN independently and has no affect on any other VSAN and zoning service
 
 
 
 
 ├
fabric:SwSubGroup
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:SanCloud A container for logical Fibre Channel configuration Objects that span across the Fabric Interconnects. The contained configuration objects specify the logical Fibre Channel configuration, including fabric A and B, VSANs, pin groups, and threshold policy.
 
 
 ├
fabric:Vsan A VSAN provides the ability to create completely isolated fabric topologies, with its own set of fabric services, on top of a scalable common physical infrastructure. As each VSAN possesses its own zoning service, zoning is then configured within each VSAN independently and has no affect on any other VSAN and zoning service
 
 
 
 ├
fabric:SwSubGroup


Contained Hierarchy
fabric:SwSubGroup
 ├
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.

Inheritance
naming:NamedObject
 ├
network:Conn EndPoint abstraction
 
 ├
fabric:SwSubGroup

Events
                



Faults
                



Fsms
                



Properties Summary
Defined in: fabric:SwSubGroup
equipment:PortId
          scalar:Uint32
aggrPortId  (fabric:SwSubGroup:aggrPortId)
           NO COMMENTS
fabric:AdminState
          scalar:Enum8
configState  (fabric:SwSubGroup:configState)
           The summary (OR) of all adminStates of breakout ports
license:GracePeriod
          scalar:Uint64
licGP  (fabric:SwSubGroup:licGP)
           NO COMMENTS
license:State
          scalar:Enum8
licState  (fabric:SwSubGroup:licState)
           NO COMMENTS
equipment:SlotId
          scalar:Uint32
slotId  (fabric:SwSubGroup:slotId)
           NO COMMENTS
network:SwitchId
          scalar:Enum8
switchId  (fabric:SwSubGroup:switchId)
           The fabric side (A or B)
Defined in: network:Conn
network:Locale
          scalar:Bitmask8
locale  (network:Conn:locale)
           NO COMMENTS
network:Transport
          scalar:Bitmask8
transport  (network:Conn:transport)
           The types of transport currently supported by this endpoint. This property is a bitmask, so multiple transports can be supported.
network:ConnectionType
          scalar:Bitmask8
type  (network:Conn:type)
           NO COMMENTS
Defined in: naming:NamedObject
naming:Name
          string:Basic
name  (naming:NamedObject:name)
           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

aggrPortId

Type: equipment:PortId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)48l
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

configState

Type: fabric:AdminState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
The summary (OR) of all adminStates of breakout ports
Constants
enabled 1 Indicates the administrative state is enabled. Set this value when you want to administratively enable an end-point. The system will enable the end-point and the operational state should transition to an "up" state. However, some pre-condition may prevent the operational state to be up, such as a misconfigured end-point, or external conditions such as a port not being physically connected.
disabled 2 Indicates the administrative state is disabled. Set this value when you want to administratively disable an end-point. The system will disable the end-point and the operational state will transition to a "down" state.
DEFAULT disabled(2) Indicates the administrative state is disabled. Set this value when you want to administratively disable an end-point. The system will disable the end-point and the operational state will transition to a "down" state.

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

licGP

Type: license:GracePeriod
Primitive Type: scalar:Uint64
Like: license:Licensable:licGP
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

licState

Type: license:State
Primitive Type: scalar:Enum8
Like: license:Licensable:licState
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
license-ok 1 NO COMMENTS
license-insufficient 2 NO COMMENTS
license-graceperiod 3 NO COMMENTS
license-expired 4 NO COMMENTS
not-applicable 5 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS

locale

Type: network:Locale
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
server 1 NO COMMENTS
chassis 2 NO COMMENTS
internal 4 NO COMMENTS
external 8 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS

name

Type: naming:Name
Primitive Type: string:Basic
Like: naming:Named:name
Units: null
Encrypted: false
Access: admin
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

slotId

Type: equipment:SlotId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)4l
Comments:
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
Naming Property -- [NAMING RULES]
Access: naming
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

transport

Type: network:Transport
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
The types of transport currently supported by this endpoint. This property is a bitmask, so multiple transports can be supported.
Constants
unknown 0 NO COMMENTS
ether 1 Transport is Ethernet
dce 2 Transport is Data Center Ethernet (DCE)
fc 4 Transport is Fibre Channel
DEFAULT unknown(0) NO COMMENTS

type

Type: network:ConnectionType
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
lan 1 NO COMMENTS
san 2 NO COMMENTS
ipc 4 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS