Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming 

Class fabric:CartridgePhEp (CONCRETE)

Class ID:2197
Encrypted: false - Exportable: false - Persistent: true
Privileges: [admin, pn-equipment, pn-maintenance, pn-policy]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.45.5

Represents compute resource fru presence in the system. This object also remembers logical resource binding to corresponding compute unit.

Naming Rules 
RN FORMAT: cart-ep-ven-[vendor]-mod-[model]-ser-[serial]

    [1] PREFIX=cart-ep
    [2] PREFIX=-ven- PROPERTY = vendor


    [3] PREFIX=-mod- PROPERTY = model


    [4] PREFIX=-ser- PROPERTY = serial




DN FORMAT: 

[0] fabric/server/cart-ep-ven-[vendor]-mod-[model]-ser-[serial]


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:DceSrv Internal DCE server domain. This object is a container for server configuration objects.
 
 		 
 		 ├
 		fabric:CartridgePhEp


Contained Hierarchy
fabric:CartridgePhEp
 ├
 		fabric:LastAckedSlot Represents compute resource fru acknowledgement in a given slot. This object is defined in context of ComputePhEp and identifies the acknowledgement of given fru in a corresponding slot.
 ├
 		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:PhysEp
 
 		 
 		 
 		 
 		 ├
 		network:PIoEp Physical Interface End Point abstraction
 
 		 
 		 
 		 
 		 
 		 ├
 		fabric:PIoEp An abstract representation of a Universal Connectivity Domain (UCD) termination of IO Interface (Port).
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		fabric:InternalEp Abstraction of logical Configuration Objects for server-related objects. Concrete subclasses are defined to model server-related configuration objects, such as logical server-facing ports on the Fabric Interconnect and logical chassis.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		fabric:ComputeEp Abstraction for blade end-point. identifies compute resource presence.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		fabric:CartridgePhEp
Events


Faults 
                fabric:PIoEp:errorMisconfigured


Fsms


Properties Summary
Defined in: fabric:CartridgePhEp
fabric:BladeLifeCycle
          scalar:Enum8 		lc  (fabric:CartridgePhEp:lc)
           Lifecycle of the enclosure. Used to distinquish between in service and out of service (decommissioned) storage blades
equipment:Model
          string:Basic 		model  (fabric:CartridgePhEp:model)
           NO COMMENTS
equipment:Revision
          string:Basic 		revision  (fabric:CartridgePhEp:revision)
           NO COMMENTS
equipment:Serial
          string:Basic 		serial  (fabric:CartridgePhEp:serial)
           NO COMMENTS
equipment:Vendor
          string:Basic 		vendor  (fabric:CartridgePhEp:vendor)
           NO COMMENTS
Defined in: fabric:ComputeEp
equipment:ChassisId
          scalar:Uint32 		chassisId  (fabric:ComputeEp:chassisId)
           Overrides:network:PhysEp:chassisId
           NO COMMENTS
network:PortRole
          scalar:Enum8 		ifRole  (fabric:ComputeEp:ifRole)
           Overrides:network:IfEp:ifRole
           NO COMMENTS
network:ConnectionType
          scalar:Bitmask8 		type  (fabric:ComputeEp:type)
           Overrides:network:Conn:type
           NO COMMENTS
Defined in: fabric:InternalEp
fabric:AdminState
          scalar:Enum8 		adminState  (fabric:InternalEp:adminState)
           The administrative (desired) state of this end-point
network:Locale
          scalar:Bitmask8 		locale  (fabric:InternalEp:locale)
           Overrides:network:Conn:locale
           NO COMMENTS
Defined in: fabric:PIoEp
scalar:Bool autoNegotiate  (fabric:PIoEp:autoNegotiate)
           NO COMMENTS
reference:Object epDn  (fabric:PIoEp:epDn)
           Overrides:network:Ep:epDn
           The DN of the associated physical interface
scalar:Uint64 fltAggr  (fabric:PIoEp:fltAggr)
           NO COMMENTS
network:PortType
          scalar:Enum8 		ifType  (fabric:PIoEp:ifType)
           Overrides:network:PhysEp:ifType | network:IfEp:ifType
           The interface type of this logical interface
license:GracePeriod
          scalar:Uint64 		licGP  (fabric:PIoEp:licGP)
           NO COMMENTS
license:State
          scalar:Enum8 		licState  (fabric:PIoEp:licState)
           NO COMMENTS
fabric:OperState
          scalar:Enum8 		operState  (fabric:PIoEp:operState)
           The operational state of this logical interface
port:StateQual
          string:Basic 		operStateReason  (fabric:PIoEp:operStateReason)
           The reason why the operState is not up
equipment:PortId
          scalar:Uint32 		portId  (fabric:PIoEp:portId)
           Overrides:network:PhysEp:portId
           The port ID of this logical interface.
equipment:SlotId
          scalar:Uint32 		slotId  (fabric:PIoEp:slotId)
           Overrides:network:PhysEp:slotId
           The slot ID of this logical interface.
naming:UserLabel
          string:Basic 		usrLbl  (fabric:PIoEp:usrLbl)
           NO COMMENTS
Defined in: network:PIoEp
equipment:PortId
          scalar:Uint32 		aggrPortId  (network:PIoEp:aggrPortId)
           The aggregate port ID of this endpoint. Port using break-out cable to split an aggregate port to multiple ports.
equipment:PortId
          scalar:Uint32 		peerAggrPortId  (network:PIoEp:peerAggrPortId)
           NO COMMENTS
Defined in: network:PhysEp
equipment:ChassisId
          scalar:Uint32 		peerChassisId  (network:PhysEp:peerChassisId)
           NO COMMENTS
equipment:Id
          scalar:Uint32 		peerPortId  (network:PhysEp:peerPortId)
           NO COMMENTS
equipment:Id
          scalar:Uint32 		peerSlotId  (network:PhysEp:peerSlotId)
           NO COMMENTS
network:SwitchId
          scalar:Enum8 		switchId  (network:PhysEp:switchId)
           The switch ID of this endpoint
Defined in: network:IfEp
reference:Object peerDn  (network:IfEp:peerDn)
           NO COMMENTS
Defined in: network:Conn
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.
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

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 end-point
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.

aggrPortId

Type: equipment:PortId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
The aggregate port ID of this endpoint. Port using break-out cable to split an aggregate port to multiple ports.

autoNegotiate

Type: scalar:Bool
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
yes true NO COMMENTS
no false NO COMMENTS

chassisId

Type: equipment:ChassisId
Primitive Type: scalar:Uint32
Overrides:network:PhysEp:chassisId
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)255l

Comments:
NO COMMENTS
Constants
N/A 0u NO COMMENTS
DEFAULT 0 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

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:
The DN of the associated physical interface

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 server(2) NO COMMENTS

ifType

Type: network:PortType
Primitive Type: scalar:Enum8
Overrides:network:PhysEp: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 physical(1) NO COMMENTS

lc

Type: fabric:BladeLifeCycle
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
Lifecycle of the enclosure. Used to distinquish between in service and out of service (decommissioned) storage blades
Constants
in-service 1 NO COMMENTS
out-of-service 2 NO COMMENTS
migrate 3 NO COMMENTS
out-of-service-slave 3 NO COMMENTS
DEFAULT in-service(1) NO COMMENTS

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
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 internal(4) NO COMMENTS

model

Type: equipment:Model
Primitive Type: string:Basic
Like: equipment:Info:model
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "510"

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

operState

Type: fabric:OperState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
The operational state of this logical interface
Constants
unknown 0 Indicates the operational state of a logical interface is unknown
up 1 Indicates the logical interface is operationally up
down 2 Indicates the logical interface is operationally down
error-misconfigured 3 This interface is misconfigured.
failed 4 The interface failed to configure (added for FCOE, CSCuo51553)
error-unsupported-mini-server-port 5 The interface is not supported for UCS Mini Platform. Server port on a non-scalability port
DEFAULT up(1) Indicates the logical interface is operationally up

operStateReason

Type: port:StateQual
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"

Comments:
The reason why the operState is not up

peerAggrPortId

Type: equipment:PortId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

peerChassisId

Type: equipment:ChassisId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)255l

Comments:
NO COMMENTS
Constants
N/A 0u NO COMMENTS
DEFAULT 0 NO COMMENTS

peerDn

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

Comments:
NO COMMENTS

peerPortId

Type: equipment:Id
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

peerSlotId

Type: equipment:Id
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

portId

Type: equipment:PortId
Primitive Type: scalar:Uint32
Overrides:network:PhysEp:portId
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)48l

Comments:
The port ID of this logical interface.

revision

Type: equipment:Revision
Primitive Type: string:Basic
Like: equipment:Info:revision
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"

Comments:
NO COMMENTS
Constants
defaultValue "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

serial

Type: equipment:Serial
Primitive Type: string:Basic
Like: equipment:Info:serial
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "510"

Comments:
NO COMMENTS

slotId

Type: equipment:SlotId
Primitive Type: scalar:Uint32
Overrides:network:PhysEp:slotId
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)4l

Comments:
The slot ID of this logical interface.

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 switch ID of this endpoint
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
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 lan(1) NO COMMENTS

usrLbl

Type: naming:UserLabel
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "32"
        Allowed Chars:
            Regex: [a-zA-Z0-9\[\]!#$%()*+,-./:;@ _{|}˜?&]+

Comments:
NO COMMENTS

vendor

Type: equipment:Vendor
Primitive Type: string:Basic
Like: equipment:Info:vendor
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "510"

Comments:
NO COMMENTS
Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming