Class eqpt:Nic (CONCRETE)

Class ID:513
Class Label: Nic
Encrypted: false - Exportable: false - Persistent: false - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-equipment, admin, fabric-equipment, ops]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Explicit
Monitoring Policy Source: Explicit
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: true ]

A NIC card.

Naming Rules
RN FORMAT: nic-{id}

    [1] PREFIX=nic- PROPERTY = id




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/ch/nslot-{id}/nic-{id}

[1] sys/ch/nslot-{id}/nic-{id}

                


Diagram

Super Mo: eqpt:Card,
Container Mos: eqpt:NSlot (deletable:no),
Contained Mos: eqpt:Asic, eqpt:CPU, eqpt:Dimm, eqpt:ExtAP, eqpt:Flash, eqpt:Fpga, eqpt:Obfl, eqpt:Sensor, tag:AInst,
Relations To: mon:Pol,
Relations: eqpt:RsMonPolModulePolCons,


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] eqpt:Ch A hardware chassis container contains chassis properties such as its role in the fabric (spine/tor) and a description of switch.
 
 
 
 
 
 ├
[V] eqpt:NSlot A NIC slot.
 
 
 
 
 
 
 ├
[V] eqpt:Nic A NIC card.
[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] eqpt:Ch A hardware chassis container contains chassis properties such as its role in the fabric (spine/tor) and a description of switch.
 
 
 ├
[V] eqpt:NSlot A NIC slot.
 
 
 
 ├
[V] eqpt:Nic A NIC card.


Contained Hierarchy
[V] eqpt:Nic A NIC card.
 ├
[V] eqpt:Asic The ASIC information container.
 
 ├
[V] eqpt:FwdInst  Forwarding information container
 
 ├
[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)
 ├
[V] eqpt:CPU A CPU information container.
 
 ├
[V] eqpt:Core An equipment core container.
 ├
[V] eqpt:Dimm A DIMM memory unit.
 ├
[V] eqpt:ExtAP An external extension port for a controller.
 
 ├
[V] eqpt:LPort Removed, ignore
 ├
[V] eqpt:Flash A flash memory unit.
 ├
[V] eqpt:Fpga A field-programmable gate array container.
 
 ├
[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] firmware:CompRunning Information about each equipment component firmware that is running.
 
 
 ├
[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)
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] eqpt:Obfl The onboard failure log information.
 ├
[V] eqpt:RsMonPolModulePolCons A source relation to a monitoring policy. Note that this relation is an internal object.
 ├
[V] eqpt:Sensor A temperature sensor monitors the on-board temperature on the chassis. The temperatures are an input into the fan control algorithm. The chassis software adjusts fan speed to keep all sensors within normal operating conditions.
 
 ├
[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)
 ├
[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)
 ├
[V] tag:AInst The label instance, which is contained by the taggable object.
 
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.


Inheritance
[V] nw:Item Ignore.
 ├
[V] eqpt:Item The abstraction for any equipment component/container in the system.
 
 ├
[V] eqpt:Comp An equipment component such as a card, port, transceiver, or ASIC.
 
 
 ├
[V] eqpt:Fru An abstraction of a field-replaceable unit, such as cards, receivers, fans, and PSUs.
 
 
 
 ├
[V] eqpt:Card A container for different cards such as line cards and fabric cards.
 
 
 
 
 ├
[V] eqpt:Nic A NIC card.


Events
                eqpt:Card:eqpt_Card_powerStChange
eqpt:Card:eqpt_Card_operStChange
eqpt:Card:eqpt_Card_redunStChange
eqpt:Card:eqpt_Card_detected
eqpt:Card:eqpt_Card_removed
eqpt:Card:eqpt_Card_operStChange
eqpt:Card:eqpt_Card_powerStChange


Faults
                eqpt:Card:mismatchSlot
eqpt:Card:powerStDeny
eqpt:Card:unknownSwId


Fsms
                


Properties Summary
Defined in: eqpt:Nic
eqpt:Id
          scalar:Uint32
id  (eqpt:Nic:id)
           Overrides:eqpt:Item:id
           A NIC identifier.
reference:BinRef monPolDn  (eqpt:Nic:monPolDn)
           The monitoring policy attached to this observable object.
Defined in: eqpt:Card
eqpt:MacAddr
          string:Basic
macB  (eqpt:Card:macB)
           The MAC address base.
eqpt:MacAddrLen
          scalar:Uint16
macL  (eqpt:Card:macL)
           The MAC address length.
eqpt:CardNumPorts
          scalar:Uint16
numP  (eqpt:Card:numP)
           The number of ports on the card.
eqpt:COpSt
          scalar:Enum8
operSt  (eqpt:Card:operSt)
           The operational status.
eqpt:PwrState
          scalar:Enum8
pwrSt  (eqpt:Card:pwrSt)
          
eqpt:RdSt
          scalar:Enum8
rdSt  (eqpt:Card:rdSt)
           The redundancy state.
eqpt:CardId
          scalar:Uint32
swCId  (eqpt:Card:swCId)
           The software card ID
eqpt:CardT
          scalar:Enum16
type  (eqpt:Card:type)
           The type of card.
scalar:Date upTs  (eqpt:Card:upTs)
          
Defined in: eqpt:Fru
cap:Version
          string:Basic
hwVer  (eqpt:Fru:hwVer)
           The hardware version of a card.
Defined in: eqpt:Comp
naming:Descr
          string:Basic
descr  (eqpt:Comp:descr)
           Additional descriptive information about the object.
scalar:Date mfgTm  (eqpt:Comp:mfgTm)
           The manufacturing time.
eqpt:Model
          string:Basic
model  (eqpt:Comp:model)
           The model of the component.
eqpt:Revision
          string:Basic
rev  (eqpt:Comp:rev)
           The revision number.
eqpt:Serial
          string:Basic
ser  (eqpt:Comp:ser)
           The serial number.
eqpt:Vendor
          string:Basic
vendor  (eqpt:Comp:vendor)
           The vendor.
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:Resolvable
mo:Owner
          scalar:Enum8
lcOwn  (mo:Resolvable:lcOwn)
           A value that indicates how this object was created. For internal use only.
Defined in: mo:Taggable
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (mo:Taggable:extMngdBy)
           True is Mo is managed by external orchestrators.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

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





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Additional descriptive information about the object.



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.



extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
True is Mo is managed by external orchestrators.
Constants
undefined 0u undefined NO COMMENTS
msc 1u msc NO COMMENTS
DEFAULT undefined(0u) undefined NO COMMENTS





hwVer

Type: cap:Version
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The hardware version of a card.



id

Type: eqpt:Id
Primitive Type: scalar:Uint32

Overrides:eqpt:Item:id
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
A NIC identifier.



lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A value that indicates how this object was created. For internal use only.
Constants
local 0 Local NO COMMENTS
policy 1 Policy NO COMMENTS
replica 2 Replica NO COMMENTS
resolveOnBehalf 3 ResolvedOnBehalf NO COMMENTS
implicit 4 Implicit NO COMMENTS
DEFAULT local(0) Local NO COMMENTS





macB

Type: eqpt:MacAddr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The MAC address base.



macL

Type: eqpt:MacAddrLen
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The MAC address length.



mfgTm

Type: scalar:Date

Like: eqpt:Mfg:mfgTm
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The manufacturing time.
Constants
not-applicable 0ull N/A NO COMMENTS
DEFAULT not-applicable(0ull) N/A NO COMMENTS





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





model

Type: eqpt:Model
Primitive Type: string:Basic

Like: eqpt:Dev:model
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The model of the component.



monPolDn

Type: reference:BinRef

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



numP

Type: eqpt:CardNumPorts
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The number of ports on the card.
Constants
defaultValue 0 --- NO COMMENTS





operSt

Type: eqpt:COpSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The operational status.
Constants
unknown 0 Unknown Unknown
inserted 1 Inserted Inserted
absent 2 Absent Absent
mismatch 3 Mismatch Mismatch slot
fail 4 Failed Fail state
present 5 Present Present state
removed 6 Removed Removed state
online 7 Online Online state
offline 8 Offline Offline state
pwr-up 9 Powered up powered-up state
pwr-down 10 Powered down powered-down state
err-pwr-down 11 Errored powered down err-powered-down state
testing 12 Testing waiting for diag results state
init 13 Initializing initializing state
reg-failure 14 Registration failed registration failure state
dnld 15 Downloading downloading state
upg 16 Upgrading upgrading state
srg-fail 17 SRG failed srg failure state
ha-seq-fail 18 HA Sequence number failed HA SEQNO failure state
DEFAULT unknown(0) Unknown Unknown





pwrSt

Type: eqpt:PwrState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
unknown 0 Unknown Unknown
off 1 Off admin powered off
on 2 On admin powered on
deny 3 Deny oper power deny
multi-boot-fail 4 Multiple boot failure oper powered off due to multiple bootup attempt failures
DEFAULT unknown(0) Unknown Unknown





rdSt

Type: eqpt:RdSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The redundancy state.
Constants
unknown 0 Unknown Unknown
active 1 Active Active state
standby 2 Standby Standby state
DEFAULT unknown(0) Unknown Unknown





rev

Type: eqpt:Revision
Primitive Type: string:Basic

Like: eqpt:Dev:rev
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The revision number.
Constants
defaultValue "0" --- NO COMMENTS





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.



ser

Type: eqpt:Serial
Primitive Type: string:Basic

Like: eqpt:Dev:ser
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The serial number.



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.






swCId

Type: eqpt:CardId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The software card ID



type

Type: eqpt:CardT
Primitive Type: scalar:Enum16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The type of card.
Constants
unknown 0 Unknown Invalid card type
supervisor 1 Supervisor Supervisor card type
linecard 2 Line card Linecard card type
fabriccard 3 Fabric card Fabric card type
sysctrlcard 4 System control card System control card type
extchcard 5 Extension chassis card Extension chassis card type
fan-tray 6 fan tray fan-tray FRU type
power-supply 7 power supply power-supply FRU type
motherboard 8 motherboard motherboard type
DEFAULT unknown(0) Unknown Invalid card type





upTs

Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:



vendor

Type: eqpt:Vendor
Primitive Type: string:Basic

Like: eqpt:Dev:vendor
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The vendor.
Constants
defaultValue "Cisco Systems, Inc" --- NO COMMENTS