NCM.EntityPhysical
SolarWinds Information Service 2024.4 Schema Documentation
Physical entities data. For valid Orion user with at least WebViewer NCM role. Read-only.
Inheritance
Access control
everyone
Properties
| Name | Type | Summary | Access Control |
|---|---|---|---|
| EntityID | System.Int32 | Entity ID. | everyone |
| EntityName | System.String | The textual name of the physical entity. The value of this object should be the name of the component as assigned by the local device and should be suitable for use in commands entered at the device's 'console'. This might be a text name, such as 'console' or a simple component number (for example, port or module number) , such as '1' , depending on the physical component naming syntax of the device. If there is no local name, or this object is otherwise not applicable, then this object contains a zero-length string. |
everyone |
| EntityDescription | System.String | A textual description of physical entity. This object should contain a string that identifies the manufacturer's name for the physical entity, and should be set to a distinct value for each version or model of the physical entity. | everyone |
| EntityType | System.String | An indication of the vendor-specific hardware type of the physical entity. Note that this is different from the definition of MIB-II's sysObjectID. An agent should set this object to a enterprise-specific registration identifier value indicating the specific equipment type in detail. The associated instance of entPhysicalClass is used to indicate the general type of hardware device. If no vendor-specific registration identifier exists for this physical entity, or the value is unknown by this agent then the value { 0 } is returned. |
everyone |
| ContainedIn | System.String | The value of entPhysicalIndex for the physical entity that 'contains' this physical entity. A value of zero indicates this physical entity is not contained in any other physical entity. Note that the set of 'containment' relationships define a strict hierarchy; that is, recursion is not allowed. In the event a physical entity is contained by more than one physical entity (for example, double-wide modules) , this object should identify the containing entity with the lowest value of entPhysicalIndex. |
everyone |
| EntityClass | System.String | An indication of the general hardware type of the physical entity. An agent should set this object to the standard enumeration value that most accurately indicates the general class of the physical entity or the primary class if there is more than one. If no appropriate standard registration identifier exists for this physical entity, then the value 'other(1)' is returned. If the value is unknown by this agent, then the value 'unknown(2)' is returned. | everyone |
| Position | System.Int32 | An indication of the relative position of this 'child' component among all its 'sibling' components. Sibling components are defined as entPhysicalEntries that share the same instance values of each of the entPhysicalContainedIn and entPhysicalClass objects. | everyone |
| HardwareRevision | System.String | The vendor-specific hardware revision string for the physical entity. The preferred value is the hardware revision identifier actually printed on the component itself (if present). Note that if revision information is stored internally in a non-printable (for example, binary) format, then the agent must convert such information to a printable format, in an implementation-specific manner. If no specific hardware revision string is associated with the physical component, or this information is unknown to the agent, then this object contains a zero-length string. |
everyone |
| FirmwareRevision | System.String | The vendor-specific firmware revision string for the physical entity. Note that if revision information is stored internally in a non-printable (for example, binary) format , then the agent must convert such information to a printable format , in an implementation-specific manner. If no specific firmware programs are associated with the physical component, or this information is unknown to the agent, then this object contains a zero-length string. |
everyone |
| SoftwareRevision | System.String | The vendor-specific software revision string for the physical entity. Note that if revision information is stored internally in a non-printable (for example, binary) format, then the agent must convert such information to a printable format , in an implementation-specific manner. If no specific software programs are associated with the physical component, or this information is unknown to the agent, then this object contains a zero-length string. |
everyone |
| Serial | System.String | The vendor-specific serial number string for the physical entity. The preferred value is the serial number string actually printed on the component itself (if present). | everyone |
| Manufacturer | System.String | The name of the manufacturer of this physical component. The preferred value is the manufacturer name string actually printed on the component itself (if present). | everyone |
| Model | System.String | The vendor-specific model name identifier string associated with this physical component. The preferred value is the customer-visible part number, which may be printed on the component itself. If the model name string associated with the physical component is unknown to the agent, then this object contains a zero-length string. | everyone |
| Alias | System.String | This object is an 'alias' name for the physical entity as specified by a network manager, and provides a non-volatile 'handle' for the physical entity. | everyone |
| AssetID | System.String | This object is a user-assigned asset tracking identifier for the physical entity as specified by a network manager, and provides non-volatile storage of this information. | everyone |
| FieldReplaceable | System.String | This object indicates whether or not this physical entity is considered a 'field replaceable unit' by the vendor. If this object contains the value 'true(1)' then this entPhysicalEntry identifies a field replaceable unit. For all entPhysicalEntries that represent components that are permanently contained within a field replaceable unit, the value 'false(2)' should be returned for this object. | everyone |
| NodeID | System.Guid | A SWIS-generated unique identifier of a network node in the current inventory. (Instances of this property recur in this table according to the number of Cisco devices for which data is reported.) | everyone |
| LastDiscovery | System.DateTime | A SWIS-generated date and time marker for when NCM last discovered the device during inventory. | everyone |
| FirstDiscovery | System.DateTime | A SWIS-generated date and time marker for when NCM first discovered the device during inventory. | everyone |
| Missing | System.Boolean | Not used. | everyone |
| EntPhysicalIndex | System.Int32 | The value of entPhysicalName for two physical entities is the same if the console interface does not distinguish between them (for example, slot-1 and the card in slot-1). | everyone |
Source Relationships
| Name | Type | Notes |
|---|---|---|
| CiscoFruPowerStatus | NCM.CiscoFruPowerStatus | Defined by relationship NCM.EntityPhysicalRefCiscoFruPowerStatus (System.Reference) |
| CiscoFruFanTrayStatus | NCM.CiscoFruFanTrayStatus | Defined by relationship NCM.EntityPhysicalRefCiscoFruFanTrayStatus (System.Reference) |
| CiscoFruPowerSupplyGroups | NCM.CiscoFruPowerSupplyGroups | Defined by relationship NCM.EntityPhysicalRefCiscoFruPowerSupplyGroups (System.Reference) |
| CiscoBootloadImages | NCM.CiscoBootloadImages | Defined by relationship NCM.EntityPhysicalHostsCiscoBootloadImages (System.Reference) |
Target Relationships
| Name | Type | Notes |
|---|---|---|
| NodeProperties | NCM.NodeProperties | Defined by relationship NCM.NodePropertiesRefEntityPhysical (System.Reference) |
| Node | NCM.Nodes | Defined by relationship NCM.NodeHostsEntityPhysical (System.Hosting) |