Overview  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class port:PIo (ABSTRACT)

Class ID:519
Encrypted: false - Exportable: false - Persistent: true
Privileges: []
SNMP OID:

An abstraction of a Physical Port on a Fabric Interconnect switch device.

Naming Rules 
RN FORMAT: port-[portId]

    [1] PREFIX=port- PROPERTY = portId




DN FORMAT: 

[0] sys/chassis-[id]/slot-[id]/[type]/port-[portId]

[1] sys/fex-[id]/slot-[id]/[type]/port-[portId]

[2] sys/chassis-[id]/shared-io-module/[type]/port-[portId]

[3] sys/chassis-[id]/slot-[id]/shared-io-module/[type]/port-[portId]

[4] sys/switch-[id]/slot-[id]/[type]/port-[portId]

[5] sys/chassis-[id]/sw-slot-[id]/[type]/port-[portId]

[6] sys/chassis-[id]/slot-[id]/[type]/aggr-port-[aggrPortId]/port-[portId]

[7] sys/fex-[id]/slot-[id]/[type]/aggr-port-[aggrPortId]/port-[portId]

[8] sys/chassis-[id]/shared-io-module/[type]/aggr-port-[aggrPortId]/port-[portId]

[9] sys/chassis-[id]/slot-[id]/shared-io-module/[type]/aggr-port-[aggrPortId]/port-[portId]

[10] sys/switch-[id]/slot-[id]/[type]/aggr-port-[aggrPortId]/port-[portId]

[11] sys/chassis-[id]/sw-slot-[id]/[type]/aggr-port-[aggrPortId]/port-[portId]


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
 
 		 
 		 
 		 
 		 
 		 ├
 		port:PhysSwitchIo Physical switch port superclass.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		port:PIo
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		ether:PIo An inventoried Physical Ethernet Port on a physical device, such as a L2 switch, FEX, or IOM module on a Chassis. The "ifRole" property specifies if this is a server-facing port or uplink Ethernet port.
 
 		 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		fc:PIo An inventoried Physical Fibre Channel port on a physical device, such as a Fabric Interconnect or FEX.
Events


Faults 
                port:PIo:failed

                port:PIo:hardware-failure

                port:PIo:invalid-sfp

                port:PIo:link-down

                port:PIo:sfp-not-present


Fsms 
                port:PIo:InCompatSfpPresence

                port:PIo:InCompatSfpReplaced


Properties Summary
Defined in: port:PIo
network:Transport
          scalar:Bitmask8 		adminTransport  (port:PIo:adminTransport)
           The desired transport of this physical port (FC or Ethernet). This property is set when a Physical port is going through a transition from one mode to another mode. For example, if an Ethernet Port is being changed to an FC port, then the adminTransport will first be set to FC; after reconfiguration, the etherPIo will be deleted and a new fcPIo object will be created. The operational value (i.e. the currently configured transport mode) is available through the "transport" property.
fsm:Descr
          string:Basic 		fsmDescr  (port:PIo:fsmDescr)
           NO COMMENTS
port:PIoFsmStatus
          scalar:Enum32 		fsmPrev  (port:PIo:fsmPrev)
           NO COMMENTS
fsm:Progress
          scalar:UByte 		fsmProgr  (port:PIo:fsmProgr)
           NO COMMENTS
condition:ErrCode
          scalar:Uint32 		fsmRmtInvErrCode  (port:PIo:fsmRmtInvErrCode)
           NO COMMENTS
string:Basic fsmRmtInvErrDescr  (port:PIo:fsmRmtInvErrDescr)
           NO COMMENTS
condition:RemoteInvRslt
          scalar:Bitmask32 		fsmRmtInvRslt  (port:PIo:fsmRmtInvRslt)
           NO COMMENTS
fsm:Descr
          string:Basic 		fsmStageDescr  (port:PIo:fsmStageDescr)
           NO COMMENTS
scalar:Date fsmStamp  (port:PIo:fsmStamp)
           NO COMMENTS
port:PIoFsmStatus
          scalar:Enum32 		fsmStatus  (port:PIo:fsmStatus)
           NO COMMENTS
scalar:UByte fsmTry  (port:PIo:fsmTry)
           NO COMMENTS
scalar:Bool isBreakoutXcvr  (port:PIo:isBreakoutXcvr)
           NO COMMENTS
scalar:Bool isPortChannelMember  (port:PIo:isPortChannelMember)
           Indicates if this physical port is a port-channel member CSCuw11187 - isPortChannelMember property is used only by GUI and is set in postExplicitCb. Should not be used in backend code.
fsm:Lifecycle
          scalar:Enum8 		lc  (port:PIo:lc)
           NO COMMENTS
license:GracePeriod
          scalar:Uint64 		licGP  (port:PIo:licGP)
           NO COMMENTS
license:State
          scalar:Enum8 		licState  (port:PIo:licState)
           NO COMMENTS
portapi:peerCapability
          scalar:Enum8 		portCapability  (port:PIo:portCapability)
           NO COMMENTS
equipment:PortId
          scalar:Uint32 		portId  (port:PIo:portId)
           Overrides:network:PhysEp:portId
           NO COMMENTS
scalar:Bool unifiedPort  (port:PIo:unifiedPort)
           Indicates if this physical port supports both FC and Ethernet transport modes.
naming:UserLabel
          string:Basic 		usrLbl  (port:PIo:usrLbl)
           Field to hold user label CSCta06454, CSCsx53838
equipment:XcvrType
          scalar:Enum16 		xcvrType  (port:PIo:xcvrType)
           NO COMMENTS
Defined in: port:PhysSwitchIo
fabric:AdminState
          scalar:Enum8 		adminState  (port:PhysSwitchIo:adminState)
           NO COMMENTS
port:Encap
          scalar:Enum8 		encap  (port:PhysSwitchIo:encap)
           NO COMMENTS
reference:Object epDn  (port:PhysSwitchIo:epDn)
           Overrides:network:Ep:epDn
           NO COMMENTS
port:Mode
          scalar:Enum8 		mode  (port:PhysSwitchIo:mode)
           NO COMMENTS
equipment:Model
          string:Basic 		model  (port:PhysSwitchIo:model)
           NO COMMENTS
network:PortOperState
          scalar:Enum8 		operState  (port:PhysSwitchIo:operState)
           NO COMMENTS
equipment:Revision
          string:Basic 		revision  (port:PhysSwitchIo:revision)
           NO COMMENTS
equipment:Serial
          string:Basic 		serial  (port:PhysSwitchIo:serial)
           NO COMMENTS
port:StateQual
          string:Basic 		stateQual  (port:PhysSwitchIo:stateQual)
           NO COMMENTS
scalar:Date ts  (port:PhysSwitchIo:ts)
           NO COMMENTS
equipment:Vendor
          string:Basic 		vendor  (port:PhysSwitchIo:vendor)
           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 		chassisId  (network:PhysEp:chassisId)
           The chassis ID of this endpoint
network:PortType
          scalar:Enum8 		ifType  (network:PhysEp:ifType)
           Overrides:network:IfEp:ifType
           NO COMMENTS
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
equipment:SlotId
          scalar:Uint32 		slotId  (network:PhysEp:slotId)
           The slot ID of this endpoint
network:SwitchId
          scalar:Enum8 		switchId  (network:PhysEp:switchId)
           The switch ID of this endpoint
Defined in: network:IfEp
network:PortRole
          scalar:Enum8 		ifRole  (network:IfEp:ifRole)
           NO COMMENTS
reference:Object peerDn  (network:IfEp:peerDn)
           NO COMMENTS
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

adminState

Type: fabric:AdminState
Primitive Type: scalar:Enum8
Like: port:Port:adminState
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
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.

adminTransport

Type: network:Transport
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
The desired transport of this physical port (FC or Ethernet). This property is set when a Physical port is going through a transition from one mode to another mode. For example, if an Ethernet Port is being changed to an FC port, then the adminTransport will first be set to FC; after reconfiguration, the etherPIo will be deleted and a new fcPIo object will be created. The operational value (i.e. the currently configured transport mode) is available through the "transport" property.
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

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.

chassisId

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

Comments:
The chassis ID of this endpoint
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" />

encap

Type: port:Encap
Primitive Type: scalar:Enum8
Like: port:Port:encap
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
dot1q 1 NO COMMENTS
isl 2 NO COMMENTS
negotiate 3 NO COMMENTS
proprietary 4 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS

epDn

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

Comments:
NO COMMENTS

fsmDescr

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

Comments:
NO COMMENTS

fsmPrev

Type: port:PIoFsmStatus
Primitive Type: scalar:Enum32
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
nop 0u NO COMMENTS
InCompatSfpPresenceBegin 1014u NO COMMENTS
InCompatSfpPresenceShutdown 1015u NO COMMENTS
InCompatSfpPresenceFail 1034u NO COMMENTS
InCompatSfpPresenceSuccess 1035u NO COMMENTS
InCompatSfpReplacedBegin 1268u NO COMMENTS
InCompatSfpReplacedEnablePort 1269u NO COMMENTS
InCompatSfpReplacedFail 1462u NO COMMENTS
InCompatSfpReplacedSuccess 1463u NO COMMENTS
DEFAULT nop(0u) NO COMMENTS

fsmProgr

Type: fsm:Progress
Primitive Type: scalar:UByte
Units: %
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: (short)0  max: (short)100

Comments:
NO COMMENTS
Constants
defaultValue 100 NO COMMENTS

fsmRmtInvErrCode

Type: condition:ErrCode
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
none 0u NO COMMENTS
ERR-MO-illegal-iterator-state 100u NO COMMENTS
ERR-MO-illegal-object-lifecycle-transition 101u NO COMMENTS
ERR-MO-object-not-found 102u NO COMMENTS
ERR-MO-duplicate-object 103u NO COMMENTS
ERR-MO-naming-rule-violation 104u NO COMMENTS
ERR-MO-illegal-creation 105u NO COMMENTS
ERR-MO-illegal-containment 106u NO COMMENTS
ERR-MO-deletion-rule-violation 107u NO COMMENTS
ERR-MO-PROPERTY-value-out-of-range 120u NO COMMENTS
ERR-MO-PROPERTY-no-such-property 121u NO COMMENTS
ERR-MO-META-no-such-object-class 122u NO COMMENTS
ERR-MO-CONFIG-child-object-cant-be-configured 130u NO COMMENTS
ERR-FILTER-illegal-format 140u NO COMMENTS
ERR-MO-resource-allocation 150u NO COMMENTS
ERR-FSM-no-such-state 160u NO COMMENTS
ERR-MO-access-denied 170u NO COMMENTS
ERR-test-error-1 501u NO COMMENTS
ERR-test-error-2 502u NO COMMENTS
ERR-HOST-fru-identity-mismatch 503u NO COMMENTS
ERR-IBMC-connect-error 504u NO COMMENTS
ERR-IBMC-fru-retrieval-error 505u NO COMMENTS
ERR-IBMC-invalid-end-point-config 506u NO COMMENTS
ERR-SWITCH-invalid-if-config 507u NO COMMENTS
ERR-DNLD-authentication-failure 508u NO COMMENTS
ERR-DNLD-invalid-image 509u NO COMMENTS
ERR-DNLD-no-space 510u NO COMMENTS
ERR-DNLD-no-file 511u NO COMMENTS
ERR-radius-group-set-error 512u NO COMMENTS
ERR-ldap-group-set-error 513u NO COMMENTS
ERR-tacacs-group-set-error 514u NO COMMENTS
ERR-tacacs-enable-error 515u NO COMMENTS
ERR-radius-set-error 516u NO COMMENTS
ERR-radius-global-set-error 517u NO COMMENTS
ERR-tacacs-set-error 518u NO COMMENTS
ERR-tacacs-global-set-error 519u NO COMMENTS
ERR-ldap-get-error 520u NO COMMENTS
ERR-ldap-delete-error 521u NO COMMENTS
ERR-ldap-set-error 522u NO COMMENTS
ERR-acct-realm-set-error 523u NO COMMENTS
ERR-auth-realm-set-error 524u NO COMMENTS
ERR-role-set-error 525u NO COMMENTS
ERR-locale-set-error 526u NO COMMENTS
ERR-user-set-error 527u NO COMMENTS
ERR-NTP-set-error 528u NO COMMENTS
ERR-NTP-get-error 529u NO COMMENTS
ERR-NTP-delete-error 530u NO COMMENTS
ERR-DNS-set-error 531u NO COMMENTS
ERR-DNS-get-error 532u NO COMMENTS
ERR-DNS-delete-error 533u NO COMMENTS
ERR-UPDATE-in-progress 534u NO COMMENTS
ERR-UPDATE-failed 535u NO COMMENTS
ERR-UPDATE-retry 536u NO COMMENTS
ERR-admin-passwd-set 537u NO COMMENTS
ERR-delete-user 538u NO COMMENTS
ERR-create-user 539u NO COMMENTS
ERR-modify-user 540u NO COMMENTS
ERR-modify-role 541u NO COMMENTS
ERR-modify-locale 542u NO COMMENTS
ERR-modify-user-role 543u NO COMMENTS
ERR-modify-user-locale 544u NO COMMENTS
ERR-HTTP-set-error 545u NO COMMENTS
ERR-HTTPS-set-error 546u NO COMMENTS
ERR-timezone-set-error 547u NO COMMENTS
ERR-set-network 548u NO COMMENTS
ERR-set-port-channel 549u NO COMMENTS
ERR-BIOS-network-boot-order-not-found 550u NO COMMENTS
ERR-authentication 551u NO COMMENTS
ERR-authorization-required 552u NO COMMENTS
ERR-user-account-expired 553u NO COMMENTS
ERR-session-cache-full 554u NO COMMENTS
ERR-session-not-found 555u NO COMMENTS
ERR-service-not-ready 556u NO COMMENTS
ERR-internal-error 557u NO COMMENTS
ERR-create-role 558u NO COMMENTS
ERR-create-locale 559u NO COMMENTS
ERR-Diagnostics-in-progress 560u NO COMMENTS
ERR-Diagnostics-memtest-in-progress 561u NO COMMENTS
ERR-Diagnostics-network-in-progress 562u NO COMMENTS
ERR-delete-role 563u NO COMMENTS
ERR-delete-locale 564u NO COMMENTS
ERR-efi-Diagnostics--in-progress 565u NO COMMENTS
ERR-delete-session 566u NO COMMENTS
ERR-DNLD-hostkey-mismatch 567u NO COMMENTS
ERR-IBMC-results-not-ready 568u NO COMMENTS
ERR-IBMC-analyze-results 569u NO COMMENTS
ERR-create-keyring 570u NO COMMENTS
ERR-insufficiently-equipped 571u NO COMMENTS
ERR-max-userid-sessions-reached 572u NO COMMENTS
ERR-set-password-strength-check 573u NO COMMENTS
ERR-BOARDCTRLUPDATE-ignore 574u NO COMMENTS
ERR-DIAG-test-failed 575u NO COMMENTS
ERR-DIAG-cancelled 576u NO COMMENTS
ERR-DIAG-fsm-restarted 577u NO COMMENTS
ERR-UNABLE-TO-FETCH-BIOS-SETTINGS 578u NO COMMENTS
ERR-BIOS-TOKENS-OLD-BIOS 579u NO COMMENTS
ERR-BIOS-TOKENS-OLD-CIMC 580u NO COMMENTS
ERR-POWER-CAP-UNSUPPORTED 581u NO COMMENTS
ERR-provider-group-set-error 582u NO COMMENTS
ERR-ldap-group-modify-error 583u NO COMMENTS
ERR-provider-group-modify-error 584u NO COMMENTS
ERR-aaa-config-modify-error 585u NO COMMENTS
ERR-get-max-http-user-sessions 586u NO COMMENTS
ERR-SERVER-mis-connect 587u NO COMMENTS
ERR-store-pre-login-banner-msg 588u NO COMMENTS
ERR-ACTIVATE-in-progress 589u NO COMMENTS
ERR-ACTIVATE-failed 590u NO COMMENTS
ERR-ACTIVATE-retry 591u NO COMMENTS
ERR-request-timeout 592u NO COMMENTS
ERR-missing-method 593u NO COMMENTS
ERR-xml-parse-error 594u NO COMMENTS
ERR-auth-issue 595u NO COMMENTS
ERR-http-initializing 596u NO COMMENTS
ERR-secondary-node 597u NO COMMENTS
ERR-auth-realm-get-error 598u NO COMMENTS
ERR-radius-get-error 599u NO COMMENTS
ERR-tacacs-plus-get-error 600u NO COMMENTS
ERR-ep-set-error 601u NO COMMENTS
ERR-MAX-subscriptions-allowed-error 602u NO COMMENTS
ERR-enable-mgmt-conn 603u NO COMMENTS
ERR-reset-adapter 604u NO COMMENTS
ERR-TOKEN-request-denied 605u NO COMMENTS
ERR-cli-session-limit-reached 606u NO COMMENTS
ERR-2fa-auth-retry 607u NO COMMENTS
ERR-IBMC-connector-info-retrieval-error 608u NO COMMENTS
ERR-create-tp 609u NO COMMENTS
ERR-POWER-PROFILE-IN-PROGRESS 610u NO COMMENTS
ERR-DNLD-usb-unmounted 611u NO COMMENTS
ERR-downgrade-fail 612u NO COMMENTS
ERR-set-min-passphrase-length 613u NO COMMENTS
ERR-set-key-cert 614u NO COMMENTS
DEFAULT 0 NO COMMENTS

fsmRmtInvErrDescr

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

Comments:
NO COMMENTS

fsmRmtInvRslt

Type: condition:RemoteInvRslt
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
not-applicable 0u NO COMMENTS
resource-unavailable 1024u NO COMMENTS
service-unavailable 1048576u NO COMMENTS
intermittent-error 1073741824u NO COMMENTS
sw-defect 128u NO COMMENTS
service-not-implemented-ignore 131072u NO COMMENTS
extend-timeout 134217728u NO COMMENTS
capability-not-implemented-failure 16384u NO COMMENTS
illegal-fru 16777216u NO COMMENTS
end-point-unavailable 16u NO COMMENTS
failure 1u NO COMMENTS
resource-capacity-exceeded 2048u NO COMMENTS
service-protocol-error 2097152u NO COMMENTS
fw-defect 256u NO COMMENTS
service-not-implemented-fail 262144u NO COMMENTS
task-reset 268435456u NO COMMENTS
unidentified-fail 2u NO COMMENTS
capability-not-supported 32768u NO COMMENTS
end-point-failed 32u NO COMMENTS
fru-state-indeterminate 33554432u NO COMMENTS
resource-dependency 4096u NO COMMENTS
fru-identity-indeterminate 4194304u NO COMMENTS
internal-error 4u NO COMMENTS
hw-defect 512u NO COMMENTS
service-not-supported 524288u NO COMMENTS
fru-not-supported 536870912u NO COMMENTS
end-point-protocol-error 64u NO COMMENTS
capability-unavailable 65536u NO COMMENTS
fru-not-ready 67108864u NO COMMENTS
capability-not-implemented-ignore 8192u NO COMMENTS
fru-info-malformed 8388608u NO COMMENTS
timeout 8u NO COMMENTS
DEFAULT not-applicable(0u) NO COMMENTS

fsmStageDescr

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

Comments:
NO COMMENTS

fsmStamp

Type: scalar:Date
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
never 0ull NO COMMENTS
DEFAULT 0 NO COMMENTS

fsmStatus

Type: port:PIoFsmStatus
Primitive Type: scalar:Enum32
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
nop 0u NO COMMENTS
InCompatSfpPresenceBegin 1014u NO COMMENTS
InCompatSfpPresenceShutdown 1015u NO COMMENTS
InCompatSfpPresenceFail 1034u NO COMMENTS
InCompatSfpPresenceSuccess 1035u NO COMMENTS
InCompatSfpReplacedBegin 1268u NO COMMENTS
InCompatSfpReplacedEnablePort 1269u NO COMMENTS
InCompatSfpReplacedFail 1462u NO COMMENTS
InCompatSfpReplacedSuccess 1463u NO COMMENTS
DEFAULT nop(0u) NO COMMENTS

fsmTry

Type: scalar:UByte
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

ifRole

Type: network:PortRole
Primitive Type: scalar:Enum8
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 unknown(0) 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 physical(1) NO COMMENTS

isBreakoutXcvr

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

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

isPortChannelMember

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

Comments:
Indicates if this physical port is a port-channel member CSCuw11187 - isPortChannelMember property is used only by GUI and is set in postExplicitCb. Should not be used in backend code.
Constants
yes true NO COMMENTS
no false NO COMMENTS

lc

Type: fsm:Lifecycle
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
available 0 NO COMMENTS
allocated 1 NO COMMENTS
deallocated 2 NO COMMENTS
repurposed 3 NO COMMENTS
DEFAULT available(0) 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
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

mode

Type: port:Mode
Primitive Type: scalar:Enum8
Like: port:Port:mode
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
access 1 NO COMMENTS
trunk 2 NO COMMENTS
fabric 3 NO COMMENTS
n_proxy 4 NO COMMENTS
F 5 FC NP mode
E 6 FC F mode
SD 7 FC E mode
vntag 8 FC Span Destination Mode
promiscuousAccess 9 NO COMMENTS
promiscuousTrunk 10 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS

model

Type: equipment:Model
Primitive Type: string:Basic
Like: equipment:Info:model
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  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: network:PortOperState
Primitive Type: scalar:Enum8
Like: port:Port:operState
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
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)

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

portCapability

Type: portapi:peerCapability
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
ethRackServerPort 1 NO COMMENTS
ethFexServerPort 2 NO COMMENTS
ethAppliantPort 3 NO COMMENTS
ethUplinkPort 4 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS

portId

Type: equipment:PortId
Primitive Type: scalar:Uint32
Overrides:network:PhysEp:portId
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

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
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"

Comments:
NO COMMENTS

slotId

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

Comments:
The slot ID of this endpoint

stateQual

Type: port:StateQual
Primitive Type: string:Basic
Like: port:Port:stateQual
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:
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

ts

Type: scalar:Date
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

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

unifiedPort

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

Comments:
Indicates if this physical port supports both FC and Ethernet transport modes.
Constants
yes true NO COMMENTS
no false 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:
Field to hold user label CSCta06454, CSCsx53838

vendor

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

Comments:
NO COMMENTS

xcvrType

Type: equipment:XcvrType
Primitive Type: scalar:Enum16
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
h10gcu1m 1 NO COMMENTS
h10gcu3m 2 NO COMMENTS
h10gcu5m 3 NO COMMENTS
h10gcu7m 4 NO COMMENTS
h10gusr 5 NO COMMENTS
h10glrmsm 6 NO COMMENTS
cwdm1471 7 NO COMMENTS
cwdm1531 8 NO COMMENTS
cwdm1551 9 NO COMMENTS
fet 10 NO COMMENTS
sfp 11 NO COMMENTS
x2 12 NO COMMENTS
10gbasesr 13 NO COMMENTS
10gbaselr 14 NO COMMENTS
10gbaselrm 15 NO COMMENTS
10gbaseer 16 NO COMMENTS
h10gacu1m 17 NO COMMENTS
h10gacu3m 18 NO COMMENTS
h10gacu5m 19 NO COMMENTS
h10gacu7m 20 NO COMMENTS
h10gacu10m 21 NO COMMENTS
h10gacu15m 22 NO COMMENTS
qsfp40gsr4 23 NO COMMENTS
qsfph40gcu1m 24 NO COMMENTS
qsfph40gcu2m 25 NO COMMENTS
qsfph40gcu3m 26 NO COMMENTS
qsfph40gcu5m 27 NO COMMENTS
qsfp40gcr4 28 NO COMMENTS
qsfp40glr4 29 NO COMMENTS
qsfp4sfp10gcu1m 30 NO COMMENTS
qsfp4sfp10gcu3m 31 NO COMMENTS
qsfp4sfp10gcu5m 32 NO COMMENTS
qsfp4x10gac1m 33 NO COMMENTS
qsfp4x10gac3m 34 NO COMMENTS
qsfp4x10gac5m 35 NO COMMENTS
qsfp4x10gac7m 36 NO COMMENTS
qsfp4x10gac10m 37 NO COMMENTS
qsfploop 38 NO COMMENTS
qsfph40gacu1m 39 NO COMMENTS
qsfph40gacu3m 40 NO COMMENTS
qsfph40gacu5m 41 NO COMMENTS
qsfph40gacu7m 42 NO COMMENTS
qsfph40gacu10m 43 NO COMMENTS
qsfp4x10glr 44 NO COMMENTS
qsfp40gcsr4 45 NO COMMENTS
qsfpqsa 46 NO COMMENTS
qsfp4sfp10gcu2m 47 NO COMMENTS
qsfp40gfet 48 NO COMMENTS
qsfp40gsrbd 49 NO COMMENTS
qsfph40gaoc1m 50 NO COMMENTS
qsfph40gaoc2m 51 NO COMMENTS
qsfph40gaoc3m 52 NO COMMENTS
qsfph40gaoc5m 53 NO COMMENTS
qsfph40gaoc7m 54 NO COMMENTS
qsfph40gaoc10m 55 NO COMMENTS
qsfph40gaocunknown 56 NO COMMENTS
qsfp4x10ga0c1m 57 NO COMMENTS
qsfp4x10ga0c2m 58 NO COMMENTS
qsfp4x10ga0c3m 59 NO COMMENTS
qsfp4x10ga0c5m 60 NO COMMENTS
qsfp4x10ga0c7m 61 NO COMMENTS
qsfp4x10ga0c10m 62 NO COMMENTS
qsfp4x10ga0cunknown 63 NO COMMENTS
qsfpunknown 64 NO COMMENTS
qsfph40gaoc15m 65 NO COMMENTS
1000basesx 66 NO COMMENTS
1000baselx 67 NO COMMENTS
1000baselh 68 NO COMMENTS
1000basevx 69 NO COMMENTS
1000basezx 70 NO COMMENTS
1000basecx 71 NO COMMENTS
1000basex 72 NO COMMENTS
1000baset 73 NO COMMENTS
1000baseunknown 74 NO COMMENTS
h10gacuaoc1m 192 NO COMMENTS
h10gacuaoc2m 193 NO COMMENTS
h10gacuaoc3m 194 NO COMMENTS
h10gacuaoc5m 195 NO COMMENTS
h10gacuaoc7m 196 NO COMMENTS
h10gacuaoc10m 197 NO COMMENTS
h10gacuaoc15m 198 NO COMMENTS
h10gaoc1m 199 NO COMMENTS
h10gaoc2m 200 NO COMMENTS
h10gaoc3m 201 NO COMMENTS
h10gaoc5m 202 NO COMMENTS
h10gaoc7m 203 NO COMMENTS
h10gaoc10m 204 NO COMMENTS
h10gcu2m 205 NO COMMENTS
h10gcu10m 206 NO COMMENTS
10gbasezr 207 NO COMMENTS
dwdmsfp 208 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS
Overview  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail