Class fabric:FcSanPc (CONCRETE)

Class ID:93
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.55

A Fibre Channel (FB) Port Channel Interface, which aggregate multiple FB ports to increase the link throughput and increase redundancy for higher availability. This is configured by the API user.


Naming Rules
RN FORMAT: pc-[portId]

    [1] PREFIX=pc- PROPERTY = portId




DN FORMAT: 

[0] fabric/san/[id]/pc-[portId]

                



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: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:FcSanPc


Contained Hierarchy
fabric:FcSanPc
 ├
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:FcSanPcEp A member of a Fibre Channel Port Channel Interface, representing a single Fibre Channel port member of a port channel. This is configured by the API 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:VsanEp VSAN Ep attaches to the fabricSanEp MO (FC Port) This is an artifact of creating FcVsanPortEp under a VSAN
 
 ├
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:VsanMembership VSAN Member Status MO attaches to the fabricFcoeSanEp or fabricFcoeSanPc (FCoE uplinks) This is an artifact of capturing the state of an fcoe interface on a VSAN
 
 ├
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.
 ├
fc:ErrStats
 
 ├
fc:ErrStatsHist
 ├
fc:Stats
 
 ├
fc:StatsHist

Inheritance
naming:NamedObject
 ├
network:Conn EndPoint abstraction
 
 ├
network:Ep EndPoint abstraction
 
 
 ├
network:IfEp Interface End Point abstraction
 
 
 
 ├
network:CIoEp Port Channel/Aggregation Interface End Point abstraction
 
 
 
 
 ├
fabric:CIoEp An abstract representation of a logical Port Channel Interface. Concrete subclasses define specific port channel types, such as Ethernet uplink Port Channel, FC uplink port channel, Ethernet storage port channel...
 
 
 
 
 
 ├
fabric:ExternalPc Abstraction of a logical, externally-connected port channel end-point on a Fabric Interconnect. Concrete sub-classes define specific endpoint types, such as Ethernet port channels, or FC port channels.
 
 
 
 
 
 
 ├
fabric:SanPc An abstract representation of a Fibre Channel Port Channel Interface.
 
 
 
 
 
 
 
 ├
fabric:FcSanPc

Events
                



Faults
                fabric:FcSanPc:fc-portchannel-members-invalid
fabric:FcSanPc:incompatibleSpeed
fabric:ExternalPc:down



Fsms
                



Properties Summary
Defined in: fabric:FcSanPc
port:Speed
          scalar:Enum8
adminSpeed  (fabric:FcSanPc:adminSpeed)
           The desired speed of this Fibre Channel interface.
fabric:ConfigState
          scalar:Enum8
configState  (fabric:FcSanPc:configState)
           Configuration state :Based on check on member ports
fabric:PcConfigStatus
          scalar:Enum8
configStatus  (fabric:FcSanPc:configStatus)
           The configuration status of this Port Channel Interface.
scalar:Uint32 operSpeed  (fabric:FcSanPc:operSpeed)
           The operational speed of this Fibre Channel interface.
equipment:PortId
          scalar:Uint32
portId  (fabric:FcSanPc:portId)
           Overrides:fabric:SanPc:portId | network:CIoEp:portId
           NO COMMENTS
network:Transport
          scalar:Bitmask8
transport  (fabric:FcSanPc:transport)
           Overrides:network:Conn:transport
           NO COMMENTS
Defined in: fabric:SanPc
network:PortRole
          scalar:Enum8
ifRole  (fabric:SanPc:ifRole)
           Overrides:network:IfEp:ifRole
           NO COMMENTS
network:ConnectionType
          scalar:Bitmask8
type  (fabric:SanPc:type)
           Overrides:network:Conn:type
           NO COMMENTS
Defined in: fabric:ExternalPc
network:Locale
          scalar:Bitmask8
locale  (fabric:ExternalPc:locale)
           Overrides:network:Conn:locale
           NO COMMENTS
network:PortOperState
          scalar:Enum8
operState  (fabric:ExternalPc:operState)
           The operational status of this port channel
port:StateQual
          string:Basic
stateQual  (fabric:ExternalPc:stateQual)
           NO COMMENTS
fabric:Warnings
          scalar:Bitmask32
warnings  (fabric:ExternalPc:warnings)
           Property to be used for raising warning faults
Defined in: fabric:CIoEp
fabric:AdminState
          scalar:Enum8
adminState  (fabric:CIoEp:adminState)
           The administrative (desired) state of this Port Channel interface.
naming:Descr
          string:Basic
descr  (fabric:CIoEp:descr)
           NO COMMENTS
reference:Object epDn  (fabric:CIoEp:epDn)
           Overrides:network:Ep:epDn
           NO COMMENTS
scalar:Uint64 fltAggr  (fabric:CIoEp:fltAggr)
           NO COMMENTS
network:PortType
          scalar:Enum8
ifType  (fabric:CIoEp:ifType)
           Overrides:network:CIoEp:ifType | network:IfEp:ifType
           The interface type of this logical interface
Defined in: network:CIoEp
network:SwitchId
          scalar:Enum8
switchId  (network:CIoEp:switchId)
           NO COMMENTS
Defined in: network:IfEp
reference:Object peerDn  (network:IfEp:peerDn)
           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

adminSpeed

Type: port:Speed
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
The desired speed of this Fibre Channel interface.
Constants
indeterminate 0 NO COMMENTS
1gbps 1 NO COMMENTS
2gbps 2 NO COMMENTS
4gbps 3 NO COMMENTS
8gbps 4 NO COMMENTS
auto 5 NO COMMENTS
16gbps 6 NO COMMENTS
DEFAULT auto(5) NO COMMENTS

adminState

Type: fabric:AdminState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
The administrative (desired) state of this Port Channel interface.
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 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.

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:ConfigState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
Configuration state :Based on check on member ports
Constants
applied 1 NO COMMENTS
inconsistent 2 NO COMMENTS
DEFAULT applied(1) NO COMMENTS

configStatus

Type: fabric:PcConfigStatus
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
The configuration status of this Port Channel Interface.
Constants
applied 1 NO COMMENTS
incompatible-speed 2 NO COMMENTS
DEFAULT applied(1) NO COMMENTS

descr

Type: naming:Descr
Primitive Type: string:Basic
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" />

epDn

Type: reference:Object
Refers: port:PIo
Overrides:network:Ep:epDn
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

fltAggr

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

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:CIoEp:ifType  |  network:IfEp:ifType
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
The interface type of this logical interface
Constants
unknown 0 NO COMMENTS
physical 1 NO COMMENTS
aggregation 2 NO COMMENTS
virtual 3 NO COMMENTS
DEFAULT aggregation(2) 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
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

operSpeed

Type: scalar:Uint32
Units: Gbps
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
The operational speed of this Fibre Channel interface.

operState

Type: network:PortOperState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
The operational status of this port channel
Constants
indeterminate 0
up 1 This port is operationally up
admin-down 2 This port is down because it is administratively down.
link-down 3 The link is down
failed 4 NO COMMENTS
no-license 5 The port has no valid license
link-up 6 NO COMMENTS
hardware-failure 7 This port has a hardware failure
software-failure 8 This port has a software failure
error-disabled 9 NO COMMENTS
sfp-not-present 10 NO COMMENTS
udld-aggr-down 11 NO COMMENTS
down 12 NO COMMENTS
DEFAULT indeterminate(0)

peerDn

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

portId

Type: equipment:PortId
Primitive Type: scalar:Uint32
Overrides:fabric:SanPc:portId  |  network:CIoEp:portId
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)256l
Comments:
NO COMMENTS
Constants
defaultValue 1u 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

stateQual

Type: port:StateQual
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"
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
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
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
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:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
lan 1 NO COMMENTS
san 2 NO COMMENTS
ipc 4 NO COMMENTS
DEFAULT san(2) NO COMMENTS

warnings

Type: fabric:Warnings
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
Property to be used for raising warning faults
Constants
none 0u No warnings
fc-zoning-enabled 1u Fc Zoning is Enabled
configuration-error 2u N/W Group Overlapping Vlan
DEFAULT none(0u) No warnings