Resource Properties

This section describes the resource properties.

Table 1. Resource Type Definitions
Name	Type	Read Only	Description
Id	String	True	Uniquely identifies the resource within the collection of like resources.
Description	Null, String	True	This object represents the Name property.
Name	String	True	Provides a description of this resource and is used for commonality in the schema definitions.
UUID	String	True	pattern: ([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})
Identifier	Object	True	Name	Type	Read Only	Description
			DurableName	String	True	This indicates the world wide, persistent name of the resource.
			DurableNameFormat		True	This represents the format of the DurableName property.

All EnumTypes mentioned in this table are of the "String" type.

Table 2. Resource - Enum Type
State
Enum	Description
Enabled	This function or resource has been enabled.
Disabled	This function or resource has been disabled.
StandbyOffline	This function or resource is enabled, but awaiting an external action to activate it.
StandbySpare	This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it.
InTest	This function or resource is undergoing testing.
Starting	This function or resource is starting.
Absent	This function or resource is not present or not detected.
UnavailableOffline	This function or resource is present but cannot be used.
Deferring	The element will not process any commands but will queue new requests.
Quiesced	The element is enabled but only processes a restricted set of commands.
Updating	The element is updating and may be unavailable or degraded.
Reset
On	Turn the system on.
ForceOff	Turn the system off immediately (non-graceful) shutdown.
GracefulShutdown	Perform a graceful system shutdown and power off.
ForceRestart	Perform an immediate (non-graceful) shutdown, followed by a restart of the system.
Health / HealthRollup
OK	Normal
Warning	A condition exists that requires attention.
Critical	A critical condition exists that requires immediate attention.
IndicatorLED
Lit	The Indicator LED is lit.
Blinking	The Indicator LED is blinking. Note The property Blinking indicates that indicator LED turns ON blinking to the time interval specified in IPMI.
Off	The Indicator LED is off.

Table 3. Resource Complex Types
Links
Property	Type	Description
Oem	Object	This object represents the Oem property. It can also contain an object of the type OemObject.
Status
Property	Type	Read Only	Description
State	String	True	This property shall represent if this component is available or not. See Resource - Enum Type. EnableDindicates the resource is available. DisableDindicates the resource has been intentionally made unavailable but it can be enabled. Offline indicates the resource is unavailable intentionally and requires action to be made available. In Test indicates that the component is undergoing testing. Starting indicates that the resource is on its way to becoming available. Absent indicates the resources are physically unavailable.
HealthRollup	String	True	This property shall represent the HealthState of the resource and its dependent resources.
Health	String	True	This property shall represent the HealthState of the resource without considering its dependent resources.
Oem	Object	False	Oem extension object. This object represents the Oem properties.

Table 4. Resource.v1_8_1 schema property

Identifier

Property Name

Type

Read Only

Description

DurableName

String

True

This property shall contain the worldwide unique identifier for the resource.

DurableNameFormat

String

True

This property shall represent the format of the DurableName property.

Enum

Description

NAA

This durable name shall be a hexadecimal representation of the Name Address Authority structure as defined in the T11 Fibre Channel - Framing and Signaling - 3 (FC-FS-3) specification.

FC_WWN

This durable name shall be a hexadecimal representation of the Worldwide Name format as defined in the T11 Fibre Channel Physical and Signaling Interface Specification.

UUID

This durable name shall be the hexadecimal representation of the Universal Unique Identifier as defined in the International Telecom Union's OSI networking and system aspects - Naming, Addressing and Registration Specification.

EUI

This durable name shall be the hexadecimal representation of the IEEE-defined 64-bit Extended Unique Identifier as defined in the IEEE's Guidelines for 64-bit Global Identifier (EUI-64) Specification.

iQN

This durable name shall be in the iSCSI Qualified Name format as defined in RFC 3720 and RFC 3721.

Location

Name

Type

Read Only

Description

AltitudeMeters

Number

True

The altitude of the resource in meters.

Latitude

Number

True

The latitude resources.

Longitude

Number

True

The longitude resource in degrees.

Oem

Object

True

See resource_type_definitions.

Note

This property will be a part of JSON response only if an OEM property is implemented according to the "How to Add OEM extensions" document.

Contacts

Array

True

Array of contact information.

Name	Type	Read Only	Description
Contact	String	False	Name of this contact.
EmailAddress	String	False	Email address for this contact.
PhoneNumber	String	False	Phone number for this contact.

PartLocation

Object

True

Postal address of the addressed resource.

Name	Type	Read Only	Description
LocationOrdinalValue	Number	True	The number that represents the location of the part. If LocationType is slot and this unit is in slot 2 then the LocationOrdinalValue will be 2.
LocationType	Object	True	The type of location of the part, such as slot, bay, socket, and slot.
			Enum	Description
			Slot	Defines a slot as the type of location.
			Bay	Defines a bay as the type of location.
			Connector	Defines a bay as the type of location.
			Socket	Defines a socket as the type of location.
Orientation	Object	True	The orientation for the ordering of the slot enumeration used by the LocationOrdinalValue property.
			Enum	Description
			FrontToBack	Defines a slot as the type of location.
			BackToFront	Defines a bay as the type of location.
			TopToBottom	Defines a bay as the type of location.
			BottomToTop	Defines the ordering for the LocationOrdinalValue is bottom to top.
			LeftToRight	Defines the ordering for the LocationOrdinalValue is left to right.
			RightToLeft	Defines the ordering for the LocationOrdinalValue is right to left.
Reference	Object	True	Defines a reference area for the location of the part.
			Enum	Description
			Top	Defines the part as being in the top of the unit.
			Bottom	Defines the part as being in the bottom of the unit.
			Front	Defines the part as being in the top of the unit.
			Rear	Defines the part as being in the bottom of the unit.
			Left	Defines the part as being in the top of the unit.
			Right	Defines the part as being in the bottom of the unit.
			Middle	Defines the part as being in the middle of the unit.
ServiceLabel	String	True

PostalAddress

Object

False

A place within the addressed location.

Name

Type

Read Only

Description

AdditionalInfo

String

False

Area designation or other additional info.

AdditionalCode

String

False

The value shall conform the requirements of the ADDCODE field as defined in RFC5139.

Building

String

False

Name of the building.

City

String

False

City, township, or shi (JP).

Community

String

False

Postal community name.

Country

String

False

The value shall conform the requirements of the Country field as defined in RFC5139.

District

String

False

A county, parish, gun (JP), or district (IN).

Division

String

False

City division, borough, city district, ward, chou (JP).

Floor

String

False

The value shall conform the requirements of the FLR field as defined in RFC5139. It is used to provide a floor designation.

HouseNumber

String

False

Numeric portion of house number.

HouseNumberSuffix

String

False

House number suffix.

Landmark

String

False

The value shall conform the requirements of the LMK field as defined in RFC5139. It is used to identify a landmark or vanity address.

LeadingStreetDirection

String

False

A leading street direction.

Location

String

False

Room designation or other additional info.

Name

String

False

The value shall conform the requirements of the NAM field as defined in RFC5139. It is used to name the occupant.

POBox

String

False

Post office box (P.O. box).

PlaceType

String

False

A description of the type of place that is addressed.

PostalCode

String

False

Postal code (or zip code).

Road

String

False

A primary road or street.

RoadBranch

String

False

Road Branch

RoadPostModifier

String

False

Road post-modifier.

RoadPreModifier

String

False

Road pre-modifier.

RoadSection

String

False

Road Section

RoadSubBranch

String

False

Road Subbranch

Room

String

False

Name or number of the room.

Seat

String

False

Seat (desk, cubicle, workstation).

Street

String

False

Street name

StreetSuffix

String

False

Avenue, Platz, Street, Circle.

Territory

String

False

A top-level subdivision within a country.

TrailingStreetSuffix

String

False

A trailing street suffix.

Unit

String

False

Name or number of the unit (apartment, suite).

Neighborhood

String

False

Neighborhood or block.

Placement

Object

False

Postal address of the addressed resource.

Name

Type

Read Only

Description

AdditionalInfo

String

False

Area designation or other additional info.

Rack

String

False

Name of a rack location within a row.

RackOffset

Number

False

Vertical location of the item in terms of RackOffsetUnits.

RackOffsetUnits

String

False

Enum

Description

OpenU

Defines a rack unit as being equal to 48 mm (1.89 in).

EIA_310

Defines a rack unit as being equal to 1.75 in (44.45 mm).

Row

String

False

Name of row

Table 5. Enum Types Indicator LED
Member Name	Description
Lit	The Indicator LED is lit.
Blinking	The Indicator LED is blinking.
Off	The Indicator LED is off.

Note

The properties in Resource Type are inherited by all properties.

The property Blinking indicates that indicator LED turns ON blinking to the time interval specified in IPMI.

Give documentation feedback