{ "$id": "http://redfish.dmtf.org/schemas/v1/Resource.v1_20_0.json", "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", "copyright": "Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", "definitions": { "ContactInfo": { "additionalProperties": false, "description": "Contact information for this resource.", "longDescription": "This object shall contain contact information for an individual or organization responsible for this resource.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "ContactName": { "description": "Name of this contact.", "longDescription": "This property shall contain the name of a person or organization to contact for information about this resource.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_7_0" }, "EmailAddress": { "description": "Email address for this contact.", "longDescription": "This property shall contain the email address for a person or organization to contact for information about this resource.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_7_0" }, "PhoneNumber": { "description": "Phone number for this contact.", "longDescription": "This property shall contain the phone number for a person or organization to contact for information about this resource.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_7_0" } }, "type": "object" }, "DurableNameFormat": { "enum": [ "NAA", "iQN", "FC_WWN", "UUID", "EUI", "NQN", "NSID", "NGUID", "MACAddress", "GCXLID" ], "enumDeprecated": { "NSID": "This value has been deprecated due to its non-uniqueness and `NGUID` should be used." }, "enumDescriptions": { "EUI": "The IEEE-defined 64-bit Extended Unique Identifier (EUI).", "FC_WWN": "The Fibre Channel (FC) World Wide Name (WWN).", "GCXLID": "The globally unique CXL logical device identifier (GCXLID).", "MACAddress": "The media access control address (MAC address).", "NAA": "The Name Address Authority (NAA) format.", "NGUID": "The Namespace Globally Unique Identifier (NGUID).", "NQN": "The NVMe Qualified Name (NQN).", "NSID": "The NVM Namespace Identifier (NSID).", "UUID": "The Universally Unique Identifier (UUID).", "iQN": "The iSCSI Qualified Name (iQN)." }, "enumLongDescriptions": { "EUI": "This durable name shall contain the hexadecimal representation of the IEEE-defined 64-bit Extended Unique Identifier (EUI), as defined in the IEEE's Guidelines for 64-bit Global Identifier (EUI-64) Specification. The `DurableName` property shall follow the regular expression pattern `^([0-9A-Fa-f]{2}[:-]){7}([0-9A-Fa-f]{2})$`, where the most significant octet is first.", "FC_WWN": "This durable name shall contain a hexadecimal representation of the World-Wide Name (WWN) format, as defined in the T11 Fibre Channel Physical and Signaling Interface Specification. The `DurableName` property shall follow the regular expression pattern `^([0-9A-Fa-f]{2}[:-]){7}([0-9A-Fa-f]{2})$`, where the most significant octet is first.", "GCXLID": "This durable name shall be in the globally unique CXL logical device identifier (GCXLID). The `DurableName` property shall follow the regular expression pattern `^([0-9A-Fa-f]{2}-){7}[0-9A-Fa-f]{2}:([0-9A-Fa-f]{4})$`, where the first eight hyphen-delimited octets contain the PCIe serial number, where the most significant octet is first, and the remaining 16-bit field contains the CXL Logical Device Identifier, with the most significant byte first.", "MACAddress": "This durable name shall be a media access control address (MAC address), which is a unique identifier assigned to a network interface controller (NIC) for use as a network address. This value should not be used if a more specific type of identifier is available. The `DurableName` property shall follow the regular expression pattern `^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$`, where the most significant octet is first.", "NAA": "This durable name shall contain a hexadecimal representation of the Name Address Authority structure, as defined in the T11 Fibre Channel - Framing and Signaling - 3 (FC-FS-3) specification. The `DurableName` property shall follow the regular expression pattern `^(([0-9A-Fa-f]{2}){8}){1,2}$`, where the most significant octet is first.", "NGUID": "This durable name shall be in the Namespace Globally Unique Identifier (NGUID), as defined in the NVN Express Specification. The `DurableName` property shall follow the regular expression pattern `^([0-9A-Fa-f]{2}){16}$`, where the most significant octet is first.", "NQN": "This durable name shall be in the NVMe Qualified Name (NQN) format, as defined in the NVN Express over Fabric Specification.", "NSID": "This durable name shall be in the NVM Namespace Identifier (NSID) format, as defined in the NVN Express Specification.", "UUID": "This durable name shall contain the hexadecimal representation of the UUID, as defined by RFC4122. The `DurableName` property shall follow the regular expression pattern '([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})'.", "iQN": "This durable name shall be in the iSCSI Qualified Name (iQN) format, as defined in RFC3720 and RFC3721." }, "enumVersionAdded": { "GCXLID": "v1_15_0", "MACAddress": "v1_14_0", "NGUID": "v1_10_0", "NQN": "v1_6_0", "NSID": "v1_6_0" }, "enumVersionDeprecated": { "NSID": "v1_12_0" }, "type": "string" }, "Identifier": { "additionalProperties": false, "description": "Any additional identifiers for a resource.", "longDescription": "This type shall contain any additional identifiers for a resource.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "DurableName": { "description": "The world-wide, persistent name of the resource.", "longDescription": "This property shall contain the world-wide unique identifier for the resource. The string shall be in the format described by the value in the `DurableNameFormat` property.", "readonly": true, "type": [ "string", "null" ], "versionAdded": "v1_1_0" }, "DurableNameFormat": { "anyOf": [ { "$ref": "#/definitions/DurableNameFormat" }, { "type": "null" } ], "description": "The format of the durable name property.", "longDescription": "This property shall represent the format of the `DurableName` property.", "readonly": true, "versionAdded": "v1_1_0" } }, "type": "object" }, "Location": { "additionalProperties": false, "description": "The location of a resource.", "longDescription": "This type shall describe the location of a resource.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "AltitudeMeters": { "description": "The altitude of the resource in meters.", "longDescription": "This property shall contain the altitude of the resource, in meter units, defined as the elevation above sea level.", "readonly": false, "type": [ "number", "null" ], "units": "m", "versionAdded": "v1_6_0" }, "Contacts": { "description": "An array of contact information.", "items": { "anyOf": [ { "$ref": "#/definitions/ContactInfo" }, { "type": "null" } ] }, "longDescription": "This property shall contain an array of contact information for an individual or organization responsible for this resource.", "type": "array", "versionAdded": "v1_7_0" }, "Info": { "deprecated": "This property has been deprecated in favor of the `PostalAddress`, `Placement`, and `PartLocation` properties.", "description": "The location of the resource.", "longDescription": "This property shall represent the location of the resource.", "readonly": true, "type": [ "string", "null" ], "versionAdded": "v1_1_0", "versionDeprecated": "v1_5_0" }, "InfoFormat": { "deprecated": "This property has been deprecated in favor of the `PostalAddress`, `Placement`, and `PartLocation` properties.", "description": "The format of the `Info` property.", "longDescription": "This property shall represent the `Info` property format.", "readonly": true, "type": [ "string", "null" ], "versionAdded": "v1_1_0", "versionDeprecated": "v1_5_0" }, "Latitude": { "description": "The latitude of the resource.", "longDescription": "This property shall contain the latitude of the resource specified in degree units using a decimal format and not minutes or seconds.", "readonly": false, "type": [ "number", "null" ], "units": "deg", "versionAdded": "v1_6_0" }, "Longitude": { "description": "The longitude of the resource in degree units.", "longDescription": "This property shall contain the longitude of the resource specified in degree units using a decimal format and not minutes or seconds.", "readonly": false, "type": [ "number", "null" ], "units": "deg", "versionAdded": "v1_6_0" }, "Oem": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", "description": "The OEM extension property.", "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements.", "versionAdded": "v1_1_0" }, "PartLocation": { "$ref": "#/definitions/PartLocation", "description": "The part location for a resource within an enclosure.", "longDescription": "This property shall contain the part location for a resource within an enclosure. This representation shall indicate the location of a part within a location specified by the `Placement` property.", "versionAdded": "v1_5_0" }, "PartLocationContext": { "description": "Human-readable string to enable differentiation between `PartLocation` values for parts in the same enclosure, which might include hierarchical information of containing `PartLocation` values for the part.", "longDescription": "This property shall contain a human-readable string to enable differentiation between `PartLocation` values for parts in the same enclosure, which may include hierarchical information of containing `PartLocation` values for the part. The value of this property shall not include values of the `PartLocation` properties for the part itself. The purpose of this value, in conjunction with the `PartLocation` of the part itself, is to allow clients to determine the physical location of the part without tracing through the `PartLocation` of multiple resources.", "readonly": true, "type": [ "string", "null" ], "versionAdded": "v1_16_0" }, "PhysicalAddress": { "$ref": "#/definitions/PhysicalAddress", "description": "The physical address for a resource.", "longDescription": "This property shall contain a physical address for a resource. This property should be present for resources that represent physical objects that can operate without requiring physical containment by another resource. For example, a server chassis might be contained by a rack, but it might also be deployed individually, while a drive is always contained by a chassis and therefore is described by the containing resource.", "versionAdded": "v1_17_0" }, "Placement": { "$ref": "#/definitions/Placement", "description": "A place within the addressed location.", "longDescription": "This property shall contain a place within the addressed location.", "versionAdded": "v1_3_0" }, "PostalAddress": { "$ref": "#/definitions/PostalAddress", "description": "The postal address of the addressed resource.", "longDescription": "This property shall contain a postal address of the resource.", "versionAdded": "v1_3_0" } }, "type": "object" }, "LocationType": { "description": "The types of locations for a part within an enclosure.", "enum": [ "Slot", "Bay", "Connector", "Socket", "Backplane", "Embedded" ], "enumDescriptions": { "Backplane": "A backplane.", "Bay": "A bay.", "Connector": "A connector or port.", "Embedded": "Embedded within a part.", "Slot": "A slot.", "Socket": "A socket." }, "enumLongDescriptions": { "Backplane": "This value shall indicate the part is a backplane in an enclosure.", "Bay": "This value shall indicate the part is located in a bay.", "Connector": "This value shall indicate the part is located in a connector or port.", "Embedded": "This value shall indicate the part is embedded or otherwise permanently incorporated into a larger part or device. This value shall not be used for parts that can be removed by a user or are considered field-replaceable.", "Slot": "This value shall indicate the part is located in a slot.", "Socket": "This value shall indicate the part is located in a socket." }, "enumVersionAdded": { "Backplane": "v1_12_0", "Embedded": "v1_13_0" }, "longDescription": "This enumeration shall list the types of locations for a part within an enclosure.", "type": "string" }, "Orientation": { "description": "The orientations for the ordering of the part location ordinal value.", "enum": [ "FrontToBack", "BackToFront", "TopToBottom", "BottomToTop", "LeftToRight", "RightToLeft" ], "enumDescriptions": { "BackToFront": "The ordering for the LocationOrdinalValue is back to front.", "BottomToTop": "The ordering for `LocationOrdinalValue` is bottom to top.", "FrontToBack": "The ordering for `LocationOrdinalValue` is front to back.", "LeftToRight": "The ordering for the LocationOrdinalValue is left to right.", "RightToLeft": "The ordering for the LocationOrdinalValue is right to left.", "TopToBottom": "The ordering for the LocationOrdinalValue is top to bottom." }, "enumLongDescriptions": { "BackToFront": "This value shall indicate the ordering for `LocationOrdinalValue` is back to front.", "BottomToTop": "This value shall indicate the ordering for `LocationOrdinalValue` is bottom to top.", "FrontToBack": "This value shall indicate the ordering for `LocationOrdinalValue` is front to back.", "LeftToRight": "This value shall indicate the ordering for `LocationOrdinalValue` is left to right.", "RightToLeft": "This value shall indicate the ordering for `LocationOrdinalValue` is right to left.", "TopToBottom": "This value shall indicate the ordering for `LocationOrdinalValue` is top to bottom." }, "longDescription": "This enumeration shall list the orientations for the ordering of the `LocationOrdinalValue` property.", "type": "string" }, "PartLocation": { "additionalProperties": false, "description": "The part location for a resource within an enclosure.", "longDescription": "This type shall describe a location for a resource within an enclosure.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "LocationOrdinalValue": { "description": "The number that represents the location of the part. For example, if `LocationType` is `Slot` and this unit is in slot 2, the LocationOrdinalValue is `2`.", "longDescription": "This property shall contain the number that represents the location of the part based on the `LocationType`. `LocationOrdinalValue` shall be measured based on the Orientation value starting with `0`.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_5_0" }, "LocationType": { "anyOf": [ { "$ref": "#/definitions/LocationType" }, { "type": "null" } ], "description": "The type of location of the part.", "longDescription": "This property shall contain the type of location of the part.", "readonly": true, "versionAdded": "v1_5_0" }, "Orientation": { "anyOf": [ { "$ref": "#/definitions/Orientation" }, { "type": "null" } ], "description": "The orientation for the ordering of the slot enumeration used by the `LocationOrdinalValue` property.", "longDescription": "This property shall contain the orientation for the ordering used by the `LocationOrdinalValue` property.", "readonly": true, "versionAdded": "v1_5_0" }, "Reference": { "anyOf": [ { "$ref": "#/definitions/Reference" }, { "type": "null" } ], "description": "The reference point for the part location. Provides guidance about the general location of the part.", "longDescription": "This property shall contain the general location within the unit of the part.", "readonly": true, "versionAdded": "v1_5_0" }, "ServiceLabel": { "description": "The label of the part location, such as a silk-screened name or a printed label.", "longDescription": "This property shall contain the label assigned for service at the part location.", "readonly": true, "type": [ "string", "null" ], "versionAdded": "v1_5_0" } }, "type": "object" }, "PhysicalAddress": { "additionalProperties": false, "description": "The physical address for a resource.", "longDescription": "This type shall contain a physical address for a resource.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "City": { "description": "City, township, or shi (JP).", "longDescription": "This property shall contain the city, township, or shi (JP) location for this resource.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_17_0" }, "Country": { "description": "The country.", "longDescription": "This property shall contain the country location for this resource.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_17_0" }, "ISOCountryCode": { "description": "The ISO 3166-1 country code.", "longDescription": "This property shall contain the ISO 3166-1-defined alpha-2 or alpha-3 country code.", "pattern": "^([A-Z]{2}|[A-Z]{3})$", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_17_0" }, "ISOSubdivisionCode": { "description": "ISO 3166-2 subdivision code.", "longDescription": "This property shall contain the ISO 3166-2-defined state, province, or territory subdivision code for this resource.", "pattern": "^[A-Z0-9]{1,3}$", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_17_0" }, "PostalCode": { "description": "The postal code.", "longDescription": "The property shall contain the postal code for this resource. The value shall conform to the RFC5139-defined requirements of the PC field.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_17_0" }, "StateOrProvince": { "description": "State or province.", "longDescription": "This property shall contain the state, province, or territory location within the country for this resource.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_17_0" }, "StreetAddress": { "description": "The street-level address, including building, room, or other identifiers.", "longDescription": "This property shall contain the street-level physical address of the resource, including identifiers such as apartment, room, or building to further locate the resource within a given street address.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_17_0" } }, "type": "object" }, "Placement": { "additionalProperties": false, "description": "The placement within the addressed location.", "longDescription": "The value shall describe a location within a resource. Examples include a shelf in a rack.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "AdditionalInfo": { "description": "Area designation or other additional info.", "longDescription": "This property shall contain additional information, such as Tile, Column (Post), Wall, or other designation that describes a location that cannot be conveyed with other properties defined for the Placement object.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_7_0" }, "Rack": { "description": "The name of a rack location within a row.", "longDescription": "This property shall contain the name of the rack within a row.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "RackOffset": { "description": "The vertical location of the item, in terms of RackOffsetUnits.", "longDescription": "The vertical location of the item in the rack. Rack offset units shall be measured from bottom to top, starting with 0.", "readonly": false, "type": [ "integer", "null" ], "versionAdded": "v1_3_0" }, "RackOffsetUnits": { "anyOf": [ { "$ref": "#/definitions/RackUnits" }, { "type": "null" } ], "description": "The type of rack units in use.", "longDescription": "This property shall contain a RackUnit enumeration literal that indicates the type of rack units in use.", "readonly": false, "versionAdded": "v1_3_0" }, "Row": { "description": "The name of the row.", "longDescription": "This property shall contain the name of the row.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" } }, "type": "object" }, "PostalAddress": { "additionalProperties": false, "deprecated": "This object and its properties have been deprecated in favor of `PhysicalAddress`.", "description": "The postal address for a resource.", "longDescription": "Instances shall describe a postal address for a resource. For more information, see RFC5139. Depending on use, the instance can represent a past, current, or future location.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "AdditionalCode": { "description": "The additional code.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the ADDCODE field.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "AdditionalInfo": { "description": "The room designation or other additional information.", "longDescription": "The value shall conform to the requirements of the LOC field as defined in RFC5139. Provides additional information.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_7_0" }, "Building": { "description": "The name of the building.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the BLD field. Names the building.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "City": { "description": "City, township, or shi (JP).", "longDescription": "The value shall conform to the RFC5139-defined requirements of the A3 field. Names a city, township, or shi (JP).", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "Community": { "description": "The postal community name.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the PCN field. A postal community name.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "Country": { "description": "The country.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the Country field.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "District": { "description": "A county, parish, gun (JP), or district (IN).", "longDescription": "The value shall conform to the RFC5139-defined requirements of the A2 field. Names a county, parish, gun (JP), or district (IN).", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "Division": { "description": "City division, borough, city district, ward, or chou (JP).", "longDescription": "The value shall conform to the RFC5139-defined requirements of the A4 field. Names a city division, borough, city district, ward, or chou (JP).", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "Floor": { "description": "The floor.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the FLR field. Provides a floor designation.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "GPSCoords": { "deprecated": "This property has been deprecated in favor of the Longitude and Latitude properties.", "description": "The GPS coordinates of the part.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the ADDCODE field. Shall contain the GPS coordinates of the location. If furnished, expressed in the `[-][nn]n.nnnnnn, [-][nn]n.nnnnn` format. For example, two comma-separated positive or negative numbers with six decimal places of precision.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0", "versionDeprecated": "v1_6_0" }, "HouseNumber": { "description": "The numeric portion of house number.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the HNO field. The numeric portion of the house number.", "readonly": false, "type": [ "integer", "null" ], "versionAdded": "v1_3_0" }, "HouseNumberSuffix": { "description": "The house number suffix.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the HNS field. Provides a suffix to a house number, (F, B, or 1/2).", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "Landmark": { "description": "The landmark.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the LMK field. Identifies a landmark or vanity address.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "LeadingStreetDirection": { "description": "A leading street direction.", "longDescription": "The value shall conform to the requirements of the PRD field as defined in RFC5139. Names a leading street direction, (N, W, or SE).", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "Location": { "deprecated": "This property has been deprecated in favor of the `AdditionalInfo` property.", "description": "The room designation or other additional information.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the LOC field. Provides additional information.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0", "versionDeprecated": "v1_7_0" }, "Name": { "description": "The name.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the NAM field. Names the occupant.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "Neighborhood": { "description": "Neighborhood or block.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the A5 field. Names a neighborhood or block.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "POBox": { "description": "The post office box (PO box).", "longDescription": "The value shall conform to the RFC5139-defined requirements of the POBOX field. A post office box (PO box).", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "PlaceType": { "description": "The description of the type of place that is addressed.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the PLC field. Examples include office and residence.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "PostalCode": { "description": "The postal code or zip code.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the PC field. A postal code (or zip code).", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "Road": { "description": "The primary road or street.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the RD field. Designates a primary road or street.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "RoadBranch": { "description": "The road branch.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the RDBR field. Shall contain a post office box (PO box) road branch.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "RoadPostModifier": { "description": "The road post-modifier.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the POM field. For example, Extended.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "RoadPreModifier": { "description": "The road pre-modifier.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the PRM field. For example, Old or New.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "RoadSection": { "description": "The road section.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the RDSEC field. A road section.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "RoadSubBranch": { "description": "The road sub branch.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the RDSUBBR field.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "Room": { "description": "The name or number of the room.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the ROOM field. A name or number of a room to locate the resource within the unit.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "Seat": { "description": "The seat, such as the desk, cubicle, or workstation.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the SEAT field. A name or number of a seat, such as the desk, cubicle, or workstation.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "Street": { "description": "Street name.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the A6 field. Names a street.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "StreetSuffix": { "description": "Avenue, Platz, Street, Circle.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the STS field. Names a street suffix.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "Territory": { "description": "A top-level subdivision within a country.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the A1 field when it names a territory, state, region, province, or prefecture within a country.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "TrailingStreetSuffix": { "description": "A trailing street suffix.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the POD field. Names a trailing street suffix.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" }, "Unit": { "description": "The name or number of the apartment unit or suite.", "longDescription": "The value shall conform to the RFC5139-defined requirements of the UNIT field. The name or number of a unit, such as the apartment or suite, to locate the resource.", "readonly": false, "type": [ "string", "null" ], "versionAdded": "v1_3_0" } }, "type": "object", "versionDeprecated": "v1_17_0" }, "RackUnits": { "description": "The type of rack unit in use.", "enum": [ "OpenU", "EIA_310" ], "enumDescriptions": { "EIA_310": "A rack unit that is equal to 1.75 in (44.45 mm).", "OpenU": "A rack unit that is equal to 48 mm (1.89 in)." }, "enumLongDescriptions": { "EIA_310": "Rack units shall conform to the EIA-310 standard.", "OpenU": "Rack units shall be specified in terms of the Open Compute Open Rack Specification." }, "longDescription": "Enumeration literals shall name the type of rack unit in use.", "type": "string" }, "Reference": { "description": "The reference areas for the location of the part within an enclosure.", "enum": [ "Top", "Bottom", "Front", "Rear", "Left", "Right", "Middle" ], "enumDescriptions": { "Bottom": "The part is in the bottom of the unit.", "Front": "The part is in the front of the unit.", "Left": "The part is on the left side of the unit.", "Middle": "The part is in the middle of the unit.", "Rear": "The part is in the rear of the unit.", "Right": "The part is on the right side of the unit.", "Top": "The part is in the top of the unit." }, "enumLongDescriptions": { "Bottom": "This value shall indicate the part is in the bottom of the unit.", "Front": "This value shall indicate the part is in the front of the unit.", "Left": "This value shall indicate the part is on the left side of the unit.", "Middle": "This value shall indicate the part is in the middle of the unit.", "Rear": "This value shall indicate the part is in the rear of the unit.", "Right": "This value shall indicate the part is on the right side of the unit.", "Top": "This value shall indicate the part is in the top of the unit." }, "longDescription": "This enumeration shall list the reference areas for the location of the part within an enclosure.", "type": "string" }, "ReferenceableMember": { "additionalProperties": false, "description": "The base type for addressable members of an array.", "longDescription": "References array members by using the value returned in the `@odata.id` property, which can be a dereferenceable URL. The `@odata.id` of this entity shall contain the location of this element within an item.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "@odata.id": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "MemberId": { "description": "The unique identifier for the member within an array.", "longDescription": "This property shall contain the unique identifier for this member within an array. For services supporting Redfish v1.6 or higher, this value shall contain the zero-based array index.", "readonly": true, "type": "string" }, "Oem": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", "description": "The OEM extension property.", "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." } }, "required": [ "MemberId", "@odata.id" ], "type": "object" }, "Resource": { "additionalProperties": false, "description": "The base type for resources and members that can be linked to.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "@odata.context": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "@odata.type": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" }, "Description": { "anyOf": [ { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" }, { "type": "null" } ], "readonly": true }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", "readonly": true }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", "readonly": true }, "Oem": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", "description": "The OEM extension property.", "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." } }, "required": [ "Id", "Name", "@odata.id", "@odata.type" ], "type": "object" }, "ResourceCollection": { "additionalProperties": false, "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "@odata.context": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "@odata.type": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" }, "Description": { "anyOf": [ { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" }, { "type": "null" } ], "readonly": true }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", "readonly": true }, "Oem": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", "description": "The OEM extension property.", "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements." } }, "required": [ "Name", "@odata.id", "@odata.type" ], "type": "object" } }, "language": "en", "owningEntity": "DMTF", "release": "2024.3", "title": "#Resource.v1_20_0" }