Class fabric:Vsan (CONCRETE)

Class ID:131
Encrypted: false - Exportable: true - Persistent: true
Privileges: [admin, ext-san-config, ext-san-policy]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.45.118

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


Naming Rules
RN FORMAT: net-[name]

    [1] PREFIX=net- PROPERTY = name




DN FORMAT: 

[0] fabric/fc-estc/[id]/net-[name]

[1] fabric/fc-estc/net-[name]

[2] fabric/san/[id]/net-[name]

[3] fabric/san/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: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
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
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
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


Contained Hierarchy
fabric:Vsan
 ├
fabric:FcMonFiltEp
 ├
fabric:FcMonSrcEp A Fibre Channel source port of a Switch Port Analyzer (SPAN) session. The traffic on this source port (receive, transmit, or both) is sent to the destination port specified for the SPAN session.
 ├
fabric:FcVsanPc Port-channel that attaches to the VSAN. This is configured by the admin.
 
 ├
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:FcVsanPortEp FC Port that attaches to the parent VSAN. Indicates the parent VSAN will be configured on the specified FC port (FC storage port or FC uplink 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.
 ├
fabric:FcoeVsanPc FCoE uplink Port-channel that attaches to the VSAN. This is configured by the admin.
 
 ├
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.
 ├
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
 ├
network:Conn EndPoint abstraction
 
 ├
network:Ep EndPoint abstraction
 
 
 ├
network:IfEp Interface End Point abstraction
 
 
 
 ├
network:VnetEp Port Channel/Aggregation Interface End Point abstraction
 
 
 
 
 ├
fabric:VnetEp Represents UCD termination of VNET
 
 
 
 
 
 ├
fabric:AVsan Abstraction of a named VSAN
 
 
 
 
 
 
 ├
fabric:Vsan

Events
                



Faults
                fabric:Vsan:errorDisabled



Fsms
                



Properties Summary
Defined in: fabric:Vsan
fabric:DefaultZoningState
          scalar:Enum32
defaultZoning  (fabric:Vsan:defaultZoning)
           Default Zoning fetaure is getting depricated. Making this property implicit and non-backupable. Removed refernces from CLI & GUI. Controls whether the data flow within the members of default zone is enabled or disabled for this VSAN
fabric:FcZoneSharingMode
          scalar:Enum8
fcZoneSharingMode  (fabric:Vsan:fcZoneSharingMode)
           NO COMMENTS
network:VNetId
          scalar:Uint32
fcoeVlan  (fabric:Vsan:fcoeVlan)
           Overrides:fabric:AVsan:fcoeVlan
           NO COMMENTS
scalar:Uint64 fltAggr  (fabric:Vsan:fltAggr)
           NO COMMENTS
scalar:Uint64 global  (fabric:Vsan:global)
           NO COMMENTS
scalar:Uint64 local  (fabric:Vsan:local)
           NO COMMENTS
naming:Name
          string:Basic
name  (fabric:Vsan:name)
           Overrides:fabric:AVsan:name | fabric:VnetEp:name | naming:NamedObject:name
           NO COMMENTS
network:SwitchId
          scalar:Enum8
switchId  (fabric:Vsan:switchId)
           Overrides:fabric:VnetEp:switchId
           NO COMMENTS
Defined in: fabric:AVsan
fabric:VsanOperState
          scalar:Enum8
operState  (fabric:AVsan:operState)
           NO COMMENTS
network:Transport
          scalar:Bitmask8
transport  (fabric:AVsan:transport)
           Overrides:network:Conn:transport
           NO COMMENTS
network:ConnectionType
          scalar:Bitmask8
type  (fabric:AVsan:type)
           Overrides:network:Conn:type
           override name="epDn" refers="vnet:Instance" /
fabric:ZoningState
          scalar:Enum32
zoningState  (fabric:AVsan:zoningState)
           Controls whether zoning is enabled or disabled for this VSAN
Defined in: fabric:VnetEp
network:VNetId
          scalar:Uint32
id  (fabric:VnetEp:id)
           Overrides:network:VnetEp:id
           NO COMMENTS
network:PortRole
          scalar:Enum8
ifRole  (fabric:VnetEp:ifRole)
           Overrides:network:IfEp:ifRole
           NO COMMENTS
network:Locale
          scalar:Bitmask8
locale  (fabric:VnetEp:locale)
           Overrides:network:Conn:locale
           NO COMMENTS
policy:PolicyOwner
          scalar:Enum8
policyOwner  (fabric:VnetEp:policyOwner)
           since Vlan can be imported from Pasadena or created locally by ucsm the following property will differentiate between the two options: "local" denotes a policy created by local policy client, "policy" denotes a policy created by remote policy server.
Defined in: network:VnetEp
network:PortType
          scalar:Enum8
ifType  (network:VnetEp:ifType)
           Overrides:network:IfEp:ifType
           NO COMMENTS
Defined in: network:IfEp
reference:Object peerDn  (network:IfEp:peerDn)
           NO COMMENTS
Defined in: network:Ep
reference:Object epDn  (network:Ep:epDn)
           cross-pointer to the other side of connection
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

defaultZoning

Type: fabric:DefaultZoningState
Primitive Type: scalar:Enum32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
Default Zoning fetaure is getting depricated. Making this property implicit and non-backupable. Removed refernces from CLI & GUI. Controls whether the data flow within the members of default zone is enabled or disabled for this VSAN
Constants
disabled 0u NO COMMENTS
enabled 1u NO COMMENTS
DEFAULT disabled(0u) 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" />

epDn

Type: reference:Object
Refers: network:PIoEp
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
cross-pointer to the other side of connection

fcZoneSharingMode

Type: fabric:FcZoneSharingMode
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
coalesce 0 NO COMMENTS
clear-unmanaged-zone-all 1 NO COMMENTS
DEFAULT coalesce(0) NO COMMENTS

fcoeVlan

Type: network:VNetId
Primitive Type: scalar:Uint32
Overrides:fabric:AVsan:fcoeVlan
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)4048l  max: (long)4093l
    Range:  min: (long)1l  max: (long)4029l
Comments:
NO COMMENTS
Constants
defaultValue 1u const name="default" value="1"/

fltAggr

Type: scalar:Uint64
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

global

Type: scalar:Uint64
Like: fabric:VnicUsers:global
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

id

Type: network:VNetId
Primitive Type: scalar:Uint32
Overrides:network:VnetEp:id
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)4093l
Comments:
NO COMMENTS
Constants
defaultValue 1u const name="default" value="1"/

ifRole

Type: network:PortRole
Primitive Type: scalar:Enum8
Overrides:network:IfEp:ifRole
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
network 1 NO COMMENTS
server 2 NO COMMENTS
mgmt 3 NO COMMENTS
diag 4 NO COMMENTS
storage 5 NO COMMENTS
monitor 6 NO COMMENTS
fcoe-storage 7 NO COMMENTS
nas-storage 8 NO COMMENTS
fcoe-nas-storage 9 NO COMMENTS
fcoe-uplink 10 NO COMMENTS
network-fcoe-uplink 11 NO COMMENTS
service 12 NO COMMENTS
DEFAULT network(1) NO COMMENTS

ifType

Type: network:PortType
Primitive Type: scalar:Enum8
Overrides:network:IfEp:ifType
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
physical 1 NO COMMENTS
aggregation 2 NO COMMENTS
virtual 3 NO COMMENTS
DEFAULT virtual(3) NO COMMENTS

local

Type: scalar:Uint64
Like: fabric:VnicUsers:local
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

locale

Type: network:Locale
Primitive Type: scalar:Bitmask8
Overrides:network:Conn:locale
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 external(8) NO COMMENTS

name

Type: naming:Name
Primitive Type: string:Basic
Overrides:fabric:AVsan:name  |  fabric:VnetEp: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

operState

Type: fabric:VsanOperState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
ok 1 NO COMMENTS
error-misconfigured 2 NO COMMENTS
error-reserved 3 NO COMMENTS
DEFAULT ok(1) NO COMMENTS

peerDn

Type: reference:Object
Refers: network:PIoEp
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

policyOwner

Type: policy:PolicyOwner
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
since Vlan can be imported from Pasadena or created locally by ucsm the following property will differentiate between the two options: "local" denotes a 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

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
Overrides:fabric:VnetEp:switchId
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
NONE 0 NO COMMENTS
A 1 NO COMMENTS
B 2 NO COMMENTS
dual 3 NO COMMENTS
DEFAULT dual(3) NO COMMENTS

transport

Type: network:Transport
Primitive Type: scalar:Bitmask8
Overrides:network:Conn:transport
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
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 fc(4) Transport is Fibre Channel

type

Type: network:ConnectionType
Primitive Type: scalar:Bitmask8
Overrides:network:Conn:type
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
override name="epDn" refers="vnet:Instance" /
Constants
unknown 0 NO COMMENTS
lan 1 NO COMMENTS
san 2 NO COMMENTS
ipc 4 NO COMMENTS
DEFAULT san(2) NO COMMENTS

zoningState

Type: fabric:ZoningState
Primitive Type: scalar:Enum32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
Controls whether zoning is enabled or disabled for this VSAN
Constants
disabled 0u NO COMMENTS
enabled 1u NO COMMENTS
DEFAULT disabled(0u) NO COMMENTS