Class fabric:EpMgr (CONCRETE)

Class ID:1197
Encrypted: false - Exportable: true - Persistent: true
Privileges: [admin]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.45.19

This object is used by the system to coordinate port configuration activities. This object is not configurable by the API user.


Naming Rules
RN FORMAT: [id]

    [1] PREFIX= PROPERTY = id




DN FORMAT: 

[0] fabric/[id]

                



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


Contained Hierarchy
fabric:EpMgr
 ├
event:Inst
 ├
fabric:EpMgrFsm
 
 ├
fabric:EpMgrFsmStage
 ├
fabric:EpMgrFsmTask
 ├
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
fabric:EpMgr

Events
                



Faults
                fabric:EpMgr:epTransModeFail



Fsms
                fabric:EpMgr:Configure



Properties Summary
Defined in: fabric:EpMgr
fabric:ConfMode
          scalar:Enum8
confMode  (fabric:EpMgr:confMode)
           Indicates the current stage of the configuration
port:StateQual
          string:Basic
confQual  (fabric:EpMgr:confQual)
           The reason why there is a fault on the logical configuration.
fabric:ConfState
          scalar:Enum8
confState  (fabric:EpMgr:confState)
           Indicates if the logical configuration is valid or not
scalar:Uint64 fltAggr  (fabric:EpMgr:fltAggr)
           NO COMMENTS
fsm:Descr
          string:Basic
fsmDescr  (fabric:EpMgr:fsmDescr)
           NO COMMENTS
fabric:EpMgrFsmFlags
          scalar:Bitmask64
fsmFlags  (fabric:EpMgr:fsmFlags)
           NO COMMENTS
fabric:EpMgrFsmStatus
          scalar:Enum32
fsmPrev  (fabric:EpMgr:fsmPrev)
           NO COMMENTS
fsm:Progress
          scalar:UByte
fsmProgr  (fabric:EpMgr:fsmProgr)
           NO COMMENTS
condition:ErrCode
          scalar:Uint32
fsmRmtInvErrCode  (fabric:EpMgr:fsmRmtInvErrCode)
           NO COMMENTS
string:Basic fsmRmtInvErrDescr  (fabric:EpMgr:fsmRmtInvErrDescr)
           NO COMMENTS
condition:RemoteInvRslt
          scalar:Bitmask32
fsmRmtInvRslt  (fabric:EpMgr:fsmRmtInvRslt)
           NO COMMENTS
fsm:Descr
          string:Basic
fsmStageDescr  (fabric:EpMgr:fsmStageDescr)
           NO COMMENTS
scalar:Date fsmStamp  (fabric:EpMgr:fsmStamp)
           NO COMMENTS
fabric:EpMgrFsmStatus
          scalar:Enum32
fsmStatus  (fabric:EpMgr:fsmStatus)
           NO COMMENTS
scalar:UByte fsmTry  (fabric:EpMgr:fsmTry)
           NO COMMENTS
network:SwitchId
          scalar:Enum8
id  (fabric:EpMgr:id)
           The ID of the switch managed by this endpoint manager.
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

confMode

Type: fabric:ConfMode
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
Indicates the current stage of the configuration
Constants
none 0 NO COMMENTS
logical-config-invalid 1 NO COMMENTS
validating-conf 2 NO COMMENTS
apply-phys-trans 3 NO COMMENTS
conf-switch 4 NO COMMENTS
DEFAULT none(0) NO COMMENTS

confQual

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 there is a fault on the logical configuration.

confState

Type: fabric:ConfState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
Indicates if the logical configuration is valid or not
Constants
ok 0 NO COMMENTS
logical-config-invalid 1 NO COMMENTS
DEFAULT ok(0) 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" />

fltAggr

Type: scalar:Uint64
Units: null
Encrypted: false
Access: oper
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

fsmFlags

Type: fabric:EpMgrFsmFlags
Primitive Type: scalar:Bitmask64
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
sam:dme:FabricEpMgrConfigure:fc-storage-config 144115188075855872ull NO COMMENTS
sam:dme:FabricEpMgrConfigure:eth-uplink-config 18014398509481984ull NO COMMENTS
sam:dme:FabricEpMgrConfigure:phys-change 2251799813685248ull NO COMMENTS
sam:dme:FabricEpMgrConfigure:fc-uplink-config 36028797018963968ull NO COMMENTS
sam:dme:FabricEpMgrConfigure:modification 4503599627370496ull NO COMMENTS
sam:dme:FabricEpMgrConfigure:eth-storage-config 72057594037927936ull NO COMMENTS
sam:dme:FabricEpMgrConfigure:eth-server-config 9007199254740992ull NO COMMENTS
defaultValue 0ull NO COMMENTS

fsmPrev

Type: fabric:EpMgrFsmStatus
Primitive Type: scalar:Enum32
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
nop 0u NO COMMENTS
ConfigureBegin 1113u NO COMMENTS
ConfigureValidateConfiguration 1114u NO COMMENTS
ConfigureApplyPhysical 1115u NO COMMENTS
ConfigureWaitOnPhys 1116u NO COMMENTS
ConfigureApplyConfig 1117u NO COMMENTS
ConfigureFail 1144u NO COMMENTS
ConfigureSuccess 1145u 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: fabric:EpMgrFsmStatus
Primitive Type: scalar:Enum32
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
nop 0u NO COMMENTS
ConfigureBegin 1113u NO COMMENTS
ConfigureValidateConfiguration 1114u NO COMMENTS
ConfigureApplyPhysical 1115u NO COMMENTS
ConfigureWaitOnPhys 1116u NO COMMENTS
ConfigureApplyConfig 1117u NO COMMENTS
ConfigureFail 1144u NO COMMENTS
ConfigureSuccess 1145u NO COMMENTS
DEFAULT nop(0u) NO COMMENTS

fsmTry

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

id

Type: network:SwitchId
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
Comments:
The ID of the switch managed by this endpoint manager.
Constants
NONE 0 NO COMMENTS
A 1 NO COMMENTS
B 2 NO COMMENTS
DEFAULT A(1) 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.