Class im:MgmtIf (CONCRETE)

Class ID:3651
Class Label: Managment Interface
Encrypted: false - Exportable: false - Persistent: false - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-connectivity-l1, admin]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

The runtime state of a management interface.

Naming Rules
RN FORMAT: mgmt

    [1] PREFIX=mgmt


DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/mgmt-{[id]}/mgmt

[1] sys/mgmt-{[id]}/mgmt

                


Diagram

Container Mos: mgmt:MgmtIf (deletable:yes),


Containers Hierarchies
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] fabric:Topology The root for IFC topology.
 
 ├
[V] fabric:Pod A pod.
 
 
 ├
[V] fabric:Node The root node for the APIC.
 
 
 
 ├
[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 
 
 
 ├
[V] mgmt:MgmtIf The management interface.
 
 
 
 
 
 ├
[V] im:MgmtIf The runtime state of a management interface.
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...
 
 ├
[V] mgmt:MgmtIf The management interface.
 
 
 ├
[V] im:MgmtIf The runtime state of a management interface.


Contained Hierarchy
[V] im:MgmtIf The runtime state of a management interface.
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 ├
[V] health:Inst A base class for a health score instance.(Switch only)


Inheritance
[V] im:MgmtIf The runtime state of a management interface.


Events
                


Faults
                im:MgmtIf:portDownMgmt


Fsms
                


Properties Summary
Defined in: im:MgmtIf
address:MAC backplaneMac  (im:MgmtIf:backplaneMac)
           Specifies the port backplane MAC.
scalar:Uint32 createSig  (im:MgmtIf:createSig)
           The per virtual drive context signature.
scalar:Uint64 iod  (im:MgmtIf:iod)
           Specifies the IOD.
scalar:Date lastLinkStChg  (im:MgmtIf:lastLinkStChg)
           Holds the last link state change.
reference:BinRef monPolDn  (im:MgmtIf:monPolDn)
           The monitoring policy attached to this observable object.
l1:Duplex
          scalar:Enum8
operDuplex  (im:MgmtIf:operDuplex)
           Specifies the operational duplex.
l1:Mtu
          scalar:Uint32
operMtu  (im:MgmtIf:operMtu)
           An operational MTU.
l1:PhyLayer
          scalar:Enum8
operPhyLayer  (im:MgmtIf:operPhyLayer)
          
address:MAC operRouterMac  (im:MgmtIf:operRouterMac)
           Specifies the operational port router MAC.
l1:Speed
          scalar:Enum8
operSpeed  (im:MgmtIf:operSpeed)
           Indicates the operational port speed.
l1:OperSt
          scalar:Enum8
operSt  (im:MgmtIf:operSt)
           The runtime state of the object or policy.
l1:OperStQual
          scalar:Enum32
operStQual  (im:MgmtIf:operStQual)
           The chassis operational status qualifier.
nw:OSSum
          scalar:Enum8
osSum  (im:MgmtIf:osSum)
           The operational state summary.
scalar:UByte portInitEvalFlag  (im:MgmtIf:portInitEvalFlag)
           A port initialize evaluation flag.
l2:VdcId
          scalar:Uint16
vdcId  (im:MgmtIf:vdcId)
           Specifies the VDC ID.
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32
childAction  (mo:TopProps:childAction)
           Delete or ignore. For internal use only.
reference:BinRef dn  (mo:TopProps:dn)
           A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
reference:BinRN rn  (mo:TopProps:rn)
           Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
mo:ModificationStatus
          scalar:Bitmask32
status  (mo:TopProps:status)
           The upgrade status. This property is for internal use only.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

backplaneMac

Type: address:MAC

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Specifies the port backplane MAC.



childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
    Comments:
Delete or ignore. For internal use only.
Constants
deleteAll 16384u deleteAll NO COMMENTS
ignore 4096u ignore NO COMMENTS
deleteNonPresent 8192u deleteNonPresent NO COMMENTS
DEFAULT 0 --- This type is used to





createSig

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The per virtual drive context signature.



dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
    Comments:
A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.



iod

Type: scalar:Uint64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Specifies the IOD.



lastLinkStChg

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Holds the last link state change.



modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The time when this object was last modified.
Constants
never 0ull never NO COMMENTS
DEFAULT never(0ull) never NO COMMENTS





monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The monitoring policy attached to this observable object.



operDuplex

Type: l1:Duplex
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Specifies the operational duplex.
Constants
auto 1 auto NO COMMENTS
full 2 full NO COMMENTS
half 3 half NO COMMENTS
DEFAULT auto(1) auto NO COMMENTS





operMtu

Type: l1:Mtu
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
An operational MTU.
Constants
defaultValue 9000u --- NO COMMENTS





operPhyLayer

Type: l1:PhyLayer
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
ethernet 2 ethernet NO COMMENTS
sup-inband 4 sup-inband NO COMMENTS
eobc 5 eobc NO COMMENTS
mgmt 6 mgmt NO COMMENTS
max 8 max NO COMMENTS
DEFAULT ethernet(2) ethernet NO COMMENTS





operRouterMac

Type: address:MAC

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Specifies the operational port router MAC.



operSpeed

Type: l1:Speed
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Indicates the operational port speed.
Constants
unknown 0 Unspecified Speed is unknown
100M 1 100 Mbps Speed is 100 Mbps
1G 2 1 Gbps Speed is 1 Gbps
10G 3 10 Gbps Speed is 10 Gbps
25G 4 25 Gbps Speed is 25 Gbps
40G 5 40 Gbps Speed is 40 Gbps
100G 6 100 Gbps Speed is 100 Gbps
inherit 7 inherit Speed is Inherited
DEFAULT inherit(7) inherit Speed is Inherited





operSt

Type: l1:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The runtime state of the object or policy.
Constants
unknown 0 unknown Unknown state
down 1 down Port is down
up 2 up Port is up
link-up 3 link-up Port is link-up
DEFAULT down(1) down Port is down





operStQual

Type: l1:OperStQual
Primitive Type: scalar:Enum32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The chassis operational status qualifier.
Constants
unknown 0u down The port state is unknown
sfp-missing 10u sfpAbsent The SFP is absent on this port
loopback-diag-failure 11u faulty NO COMMENTS
udld-unidir-detected 12u udldUnidir NO COMMENTS
udld-tx-rx-loop 13u udldLoop NO COMMENTS
udld-neighbor-mismatch 14u udldMismatch NO COMMENTS
udld-empty-echo 15u udldEmpEcho NO COMMENTS
udld-aggressive-mode-link-failed 16u udldAggr NO COMMENTS
link-flap-err 17u linkFlapErr NO COMMENTS
err-disabled-ip-conflict 18u conflctErrDis NO COMMENTS
ipqos-dcbxp-compat-failure 19u ipQosDcbxpCompatFailure NO COMMENTS
up 1u up This port is operationally up
link-failure 20u notconnect NO COMMENTS
offline 21u offline NO COMMENTS
initializing 22u init NO COMMENTS
inactive 23u inactive NO COMMENTS
channel-admin-down 24u channelDown NO COMMENTS
channel-err-disabled 25u Channel error-disabled-err-disabled NO COMMENTS
suspended 26u suspnd NO COMMENTS
proto-port-suspend 27u portSuspnd NO COMMENTS
channel-membership-update-in-progress 28u channelUpdate NO COMMENTS
parent-down 29u parentDown NO COMMENTS
admin-down 2u disabled This port is down because it is admin down
parent-admin-down 30u adminDown-parentDown NO COMMENTS
interface-removed 31u ifRemoved NO COMMENTS
fcot-no-present 32u fcotAbsent NO COMMENTS
fcot-vendor-not-supported 33u SFP vendor not supported-err-disabled NO COMMENTS
incompatible-admin-mode 34u errDisabledIncompatPortMode-err-disabled NO COMMENTS
incompatible-admin-speed 35u errDisabledIncompatPortSpeed-err-disabled NO COMMENTS
suspended-by-mode 36u suspended-by-mode NO COMMENTS
suspended-by-speed 37u suspended-by-speed NO COMMENTS
domain-max-retransmission-failure 38u isolated NO COMMENTS
loopback-isolation 39u isolated NO COMMENTS
link-down 3u parentEthDown The link is down
upgrade-in-progress 40u modUpgrade NO COMMENTS
port-channel-members-down 41u noOperMembers NO COMMENTS
ethernet-link-down 42u parentEthDown NO COMMENTS
ethernet-interface-down 43u interface-parentEthDown NO COMMENTS
admin-config-change 44u adminCfgChng NO COMMENTS
module-removed 45u modRemoved NO COMMENTS
vrf-unusable 46u vrfUnusable NO COMMENTS
none 47u connected NO COMMENTS
xcvr-initializing 48u sfpInit NO COMMENTS
cap-absent 49u capAbsent NO COMMENTS
fail 4u fail The link is failed state
sfp-eth-compliant-err 50u xcvrEthComplianceErr NO COMMENTS
sdp-timeout 51u SDP timeout/SFP Mismatch NO COMMENTS
sat-incompat-topo 52u FEX identity mismatch NO COMMENTS
sat-not-configured 53u FEX not configured NO COMMENTS
auth-fail 54u xcvrAuthFailed NO COMMENTS
auth-pending 55u authPending NO COMMENTS
suspended-due-to-minlinks 56u suspendedMinLinks NO COMMENTS
suspended-due-to-no-lacp-pdus 57u suspended(no LACP PDUs) NO COMMENTS
sat-fabric-if-down 58u fabrcIfDown NO COMMENTS
invalid-sat-fabric-if 59u invalidFbIf NO COMMENTS
no-license 5u portLicNtAvl The port has no valid license
fex-sfp-invalid 60u FEX-fabric sfp invalid NO COMMENTS
suspend-by-mtu 61u mtuFailure NO COMMENTS
suspend-by-vpc 62u suspndByVpc NO COMMENTS
router-mac-failure 63u routrmacFail NO COMMENTS
xcvr-auth-failed 64u xcvrAuthFailed NO COMMENTS
non-sticky-externally-disabled 65u ServDisab NO COMMENTS
sfp-speed-mismatch 66u xcvrSpeedMismatch NO COMMENTS
fcot-chksum-err 67u SFP checksum error NO COMMENTS
xcvr-invalid 68u Transceiver validation failed NO COMMENTS
vpc-peer-link-down 69u vpcPeerLinkDown NO COMMENTS
link-up 6u link-up-connected The link is up
vpc-cfg-in-progress 70u vpcConfigInProgress NO COMMENTS
vpc-no-response-from-peer 71u noRespFrmVpc NO COMMENTS
bpdu-guard-err-disable 72u BPDUGuard errDisable NO COMMENTS
hot-standby-in-bundle 73u htStdbyInBndl NO COMMENTS
handshake-fail-errdisable 74u intFailErrDis NO COMMENTS
mcp-loop-err-disable 75u mcpLoop errDisable NO COMMENTS
epm-learn-err-disable 76u epmLearn errDisable NO COMMENTS
mac-pinning 77u macPinning NO COMMENTS
fabric-track 78u fabricTrack NO COMMENTS
configuration-incomplete 79u incomplete config NO COMMENTS
hw-fail 7u faulty This port has a hardware failure
ethernet-vlan-down 80u parentVlanDown NO COMMENTS
link-fail-reset 81u linkReset NO COMMENTS
vfc-binding-invalid 82u vfcBindingInvalid NO COMMENTS
vlan-not-fcoe-enabled 83u vlanNotFcoeEnabled NO COMMENTS
ethernet-invalid-binding 84u parentInvalidBinding NO COMMENTS
link-fail-port-unusable 85u linkFailPortUnusable NO COMMENTS
diag-failure-errdisable 86u diag failure errDisable NO COMMENTS
incompatible-fecmode 87u errDisabledIncompatFECMode-err-disabled NO COMMENTS
npm-no-ext-link 88u NPV upstream port not available NO COMMENTS
port-reinit-limit 89u Port reinit threshold reached NO COMMENTS
sw-fail 8u faulty This port has a software failure
npiv-not-enb-upstream 90u NPIV upstream port not available NO COMMENTS
vsan-mismatch-upstream 91u VSAN mismatch with upstream port NO COMMENTS
pause-rate-limit-err-disable 92u pauseRateLimit errDisable NO COMMENTS
hw-disabled 93u hwDisabled NO COMMENTS
err-disabled 9u err-disabled The port is in err disable mode
DEFAULT admin-down(2u) disabled This port is down because it is admin down





osSum

Type: nw:OSSum
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The operational state summary.
Constants
failed 0 Failed Failed
initializing 1 Initializing Initializing
resetting 2 Resetting Resetting
degraded 3 Degraded Degraded
ok 4 Ok Ok
DEFAULT ok(4) Ok Ok





portInitEvalFlag

Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
A port initialize evaluation flag.



rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
    Comments:
Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.



status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
    Comments:
The upgrade status. This property is for internal use only.
Constants
created 2u created 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 modified 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 deleted 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.






vdcId

Type: l2:VdcId
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Specifies the VDC ID.