meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Last revisionBoth sides next revision
documentation:redfish_api:schema_definition [2017/04/21 08:36] – remove version numbers bildocumentation:redfish_api:schema_definition [2017/04/28 05:52] – old revision restored bil
Line 1: Line 1:
  
-====== AccountService ======+====== AccountService 1.1.0 ======
  
 Account Service contains properties common to all user accounts, such as password requirements, and control features such as account lockout.  It also contains links to the collections of Manager Accounts and Roles. Account Service contains properties common to all user accounts, such as password requirements, and control features such as account lockout.  It also contains links to the collections of Manager Accounts and Roles.
Line 82: Line 82:
  
  
-====== ActionInfo ======+====== ActionInfo 1.0.1 ======
  
 ActionInfo describes the parameters and other information necessary to perform a Redfish Action to a particular Action target.  As parameter support may differ between implementations and even among instances of a resource, this data can be used to ensure Action requests from applications contain supported parameters. ActionInfo describes the parameters and other information necessary to perform a Redfish Action to a particular Action target.  As parameter support may differ between implementations and even among instances of a resource, this data can be used to ensure Action requests from applications contain supported parameters.
Line 115: Line 115:
  
  
-====== AttributeRegistry ======+====== AttributeRegistry 1.0.1 ======
  
 An Attribute Registry is a set of key-value pairs which are specific to a particular implementation or product, such that creating standardized property names would be impractical.  This schema describes the structure of a Registry, and also includes mechanisms for building user interfaces (menus) allowing consistent navigation of the contents. An Attribute Registry is a set of key-value pairs which are specific to a particular implementation or product, such that creating standardized property names would be impractical.  This schema describes the structure of a Registry, and also includes mechanisms for building user interfaces (menus) allowing consistent navigation of the contents.
Line 138: Line 138:
 | } ] |   |   | | } ] |   |   |
  
-====== Bios ======+====== Bios 1.0.1 ======
  
 Bios contains properties surrounding a BIOS Attribute Registry (where the system-specific BIOS attributes are described) and the Actions needed to perform changes to BIOS settings, which typically require a system reset to apply. Bios contains properties surrounding a BIOS Attribute Registry (where the system-specific BIOS attributes are described) and the Actions needed to perform changes to BIOS settings, which typically require a system reset to apply.
Line 156: Line 156:
 | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. |
  
-====== Chassis ======+====== Chassis 1.4.0 ======
  
 A Chassis represents the physical components for any system.  This resource represents the sheet-metal confined spaces and logical zones like racks, enclosures, chassis and all other containers. Subsystems (like sensors), which operate outside of a system's data plane (meaning the resources are not accessible to software running on the system) are linked either directly or indirectly through this resource. A Chassis represents the physical components for any system.  This resource represents the sheet-metal confined spaces and logical zones like racks, enclosures, chassis and all other containers. Subsystems (like sensors), which operate outside of a system's data plane (meaning the resources are not accessible to software running on the system) are linked either directly or indirectly through this resource.
Line 356: Line 356:
  
  
-====== ClassOfService ======+====== ClassOfService 1.0.0 ======
  
 A service option composed of one or more service options. A service option composed of one or more service options.
Line 392: Line 392:
  
  
-====== ComputerSystem ======+====== ComputerSystem 1.3.0 ======
  
 This schema defines a computer system and its respective properties.  A computer system represents a machine (physical or virtual) and the local resources such as memory, cpu and other devices that can be accessed from that machine. This schema defines a computer system and its respective properties.  A computer system represents a machine (physical or virtual) and the local resources such as memory, cpu and other devices that can be accessed from that machine.
Line 759: Line 759:
  
  
-====== DataProtectionLoSCapabilities ======+====== DataProtectionLoSCapabilities 1.0.0 ======
  
 Describe data protection capabilities Describe data protection capabilities
Line 839: Line 839:
  
  
-====== DataSecurityLoSCapabilities ======+====== DataSecurityLoSCapabilities 1.0.0 ======
  
 Describe data security capabilities. Describe data security capabilities.
Line 941: Line 941:
  
  
-====== DataStorageLoSCapabilities ======+====== DataStorageLoSCapabilities 1.0.0 ======
  
 Describe data storage capabilities. Describe data storage capabilities.
Line 986: Line 986:
  
  
-====== Drive ======+====== Drive 1.1.1 ======
  
 Drive contains properties describing a single physical disk drive for any system, along with links to associated Volumes. Drive contains properties describing a single physical disk drive for any system, along with links to associated Volumes.
Line 1145: Line 1145:
  
  
-====== Endpoint ======+====== Endpoint 1.0.1 ======
  
 This is the schema definition for the Endpoint resource. It represents the properties of an entity that sends or receives protocol defined messages over a transport. This is the schema definition for the Endpoint resource. It represents the properties of an entity that sends or receives protocol defined messages over a transport.
Line 1283: Line 1283:
  
  
-====== EndpointGroup ======+====== EndpointGroup 1.0.0 ======
  
 A group of endpoints that are managed as a unit. A group of endpoints that are managed as a unit.
Line 1342: Line 1342:
  
  
-====== EthernetInterface ======+====== EthernetInterface 1.2.0 ======
  
 This schema defines a simple ethernet NIC resource. This schema defines a simple ethernet NIC resource.
Line 1472: Line 1472:
  
  
-====== Event ======+====== Event 1.1.2 ======
  
 The Event schema describes the JSON payload received by an Event Destination (which has subscribed to event notification) when events occurs.  This resource contains data about event(s), including descriptions, severity and MessageId reference to a Message Registry that can be accessed for further information. The Event schema describes the JSON payload received by an Event Destination (which has subscribed to event notification) when events occurs.  This resource contains data about event(s), including descriptions, severity and MessageId reference to a Message Registry that can be accessed for further information.
Line 1511: Line 1511:
  
  
-====== EventDestination ======+====== EventDestination 1.1.1 ======
  
 An Event Destination desribes the target of an event subscription, including the types of events subscribed and context to provide to the target in the Event payload. An Event Destination desribes the target of an event subscription, including the types of events subscribed and context to provide to the target in the Event payload.
Line 1539: Line 1539:
  
  
-====== EventService ======+====== EventService 1.0.3 ======
  
 The Event Service resource contains properties for managing event subcriptions and generates the events sent to subscribers.  The resource has links to the actual collection of subscriptions (called Event Destinations). The Event Service resource contains properties for managing event subcriptions and generates the events sent to subscribers.  The resource has links to the actual collection of subscriptions (called Event Destinations).
Line 1606: Line 1606:
  
  
-====== Fabric ======+====== Fabric 1.0.1 ======
  
 Fabric contains properties describing a simple fabric consisting of one or more switches, zero or more endpoints, and zero or more zones. Fabric contains properties describing a simple fabric consisting of one or more switches, zero or more endpoints, and zero or more zones.
Line 1687: Line 1687:
  
  
-====== FileShare ======+====== FileShare 1.0.0 ======
  
 An instance of a shared set of files with a common directory structure. An instance of a shared set of files with a common directory structure.
Line 1778: Line 1778:
  
  
-====== FileSystem ======+====== FileSystem 1.0.0 ======
  
 An instance of a hierarchical namespace of files. An instance of a hierarchical namespace of files.
Line 2036: Line 2036:
  
  
-====== HostInterface ======+====== HostInterface 1.0.0 ======
  
 This schema defines a Host Interface resource. This schema defines a Host Interface resource.
Line 2203: Line 2203:
 | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. |
  
-====== IOConnectivityLoSCapabilities ======+====== IOConnectivityLoSCapabilities 1.0.0 ======
  
 Describe IO Connectivity capabilities. Describe IO Connectivity capabilities.
Line 2258: Line 2258:
  
  
-====== IOPerformanceLoSCapabilities ======+====== IOPerformanceLoSCapabilities 1.0.0 ======
  
 Describe io performance capabilities. Describe io performance capabilities.
Line 2302: Line 2302:
  
  
-====== JsonSchemaFile ======+====== JsonSchemaFile 1.0.3 ======
  
 This is the schema definition for the Schema File locator resource. This is the schema definition for the Schema File locator resource.
Line 2322: Line 2322:
 | **Schema** | string\\ \\ *read-only* | The @odata.type name this schema describes. | | **Schema** | string\\ \\ *read-only* | The @odata.type name this schema describes. |
  
-====== LogEntry ======+====== LogEntry 1.1.1 ======
  
 This resource defines the record format for a log.  It is designed to be used for SEL logs (from IPMI) as well as Event Logs and OEM-specific log formats.  The EntryType field indicates the type of log and the resource includes several additional properties dependent on the EntryType. This resource defines the record format for a log.  It is designed to be used for SEL logs (from IPMI) as well as Event Logs and OEM-specific log formats.  The EntryType field indicates the type of log and the resource includes several additional properties dependent on the EntryType.
Line 2481: Line 2481:
  
  
-====== LogService ======+====== LogService 1.0.3 ======
  
 This resource represents the log service for the resource or service to which it is associated. This resource represents the log service for the resource or service to which it is associated.
Line 2557: Line 2557:
  
  
-====== Manager ======+====== Manager 1.3.0 ======
  
 This is the schema definition for a Manager.  Examples of managers are BMCs, Enclosure Managers, Management Controllers and other subsystems assigned managability functions. This is the schema definition for a Manager.  Examples of managers are BMCs, Enclosure Managers, Management Controllers and other subsystems assigned managability functions.
Line 2742: Line 2742:
  
  
-====== ManagerAccount ======+====== ManagerAccount 1.0.3 ======
  
  
Line 2802: Line 2802:
 | **UserName** | string\\ \\ *read-write* | This property contains the user name for the account. | | **UserName** | string\\ \\ *read-write* | This property contains the user name for the account. |
  
-====== ManagerNetworkProtocol ======+====== ManagerNetworkProtocol 1.1.0 ======
  
 This resource is used to obtain or modify the network services managed by a given manager. This resource is used to obtain or modify the network services managed by a given manager.
Line 2907: Line 2907:
  
  
-====== Memory ======+====== Memory 1.1.0 ======
  
 This is the schema definition for definition of a Memory and its configuration. This is the schema definition for definition of a Memory and its configuration.
Line 3095: Line 3095:
  
  
-====== MemoryChunks ======+====== MemoryChunks 1.0.1 ======
  
 This is the schema definition of a Memory Chunk and its configuration. This is the schema definition of a Memory Chunk and its configuration.
Line 3128: Line 3128:
  
  
-====== MemoryDomain ======+====== MemoryDomain 1.1.0 ======
  
 This is the schema definition of a Memory Domain and its configuration. Memory Domains are used to indicate to the client which Memory (DIMMs) can be grouped together in Memory Chunks to form interleave sets or otherwise grouped together. This is the schema definition of a Memory Domain and its configuration. Memory Domains are used to indicate to the client which Memory (DIMMs) can be grouped together in Memory Chunks to form interleave sets or otherwise grouped together.
Line 3154: Line 3154:
 | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. |
  
-====== MemoryMetrics ======+====== MemoryMetrics 1.1.1 ======
  
 MemoryMetrics contains usage and health statistics for a single Memory module or device instance. MemoryMetrics contains usage and health statistics for a single Memory module or device instance.
Line 3186: Line 3186:
 | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. |
  
-====== MessageRegistry ======+====== MessageRegistry 1.0.3 ======
  
 This is the schema definition for all Message Registries.  It represents the properties for the registries themselves.  The MessageId is formed per the Redfish specification.  It consists of the RegistryPrefix concatenated with the version concatenated with the unique identifier for the message registry entry. This is the schema definition for all Message Registries.  It represents the properties for the registries themselves.  The MessageId is formed per the Redfish specification.  It consists of the RegistryPrefix concatenated with the version concatenated with the unique identifier for the message registry entry.
Line 3202: Line 3202:
 | **RegistryVersion** | string\\ \\ *read-only* | This is the message registry version which is used in the middle portion of a messageID. | | **RegistryVersion** | string\\ \\ *read-only* | This is the message registry version which is used in the middle portion of a messageID. |
  
-====== MessageRegistryFile ======+====== MessageRegistryFile 1.0.3 ======
  
 This is the schema definition for the Schema File locator resource. This is the schema definition for the Schema File locator resource.
Line 3222: Line 3222:
 | **Registry** | string\\ \\ *read-only* | The Registry Name, Major and Minor version used in MessageID construction. | | **Registry** | string\\ \\ *read-only* | The Registry Name, Major and Minor version used in MessageID construction. |
  
-====== NetworkAdapter ======+====== NetworkAdapter 1.0.0 ======
  
 A NetworkAdapter represents the physical network adapter capable of connecting to a computer network.  Examples include but are not limited to Ethernet, Fibre Channel, and converged network adapters. A NetworkAdapter represents the physical network adapter capable of connecting to a computer network.  Examples include but are not limited to Ethernet, Fibre Channel, and converged network adapters.
Line 3302: Line 3302:
  
  
-====== NetworkDeviceFunction ======+====== NetworkDeviceFunction 1.0.0 ======
  
 A Network Device Function represents a logical interface exposed by the network adapter. A Network Device Function represents a logical interface exposed by the network adapter.
Line 3526: Line 3526:
  
  
-====== NetworkInterface ======+====== NetworkInterface 1.0.0 ======
  
 A NetworkInterface contains references linking NetworkAdapter, NetworkPort, and NetworkDeviceFunction resources and represents the functionality available to the containing system. A NetworkInterface contains references linking NetworkAdapter, NetworkPort, and NetworkDeviceFunction resources and represents the functionality available to the containing system.
Line 3596: Line 3596:
  
  
-====== NetworkPort ======+====== NetworkPort 1.0.0 ======
  
 A Network Port represents a discrete physical port capable of connecting to a network. A Network Port represents a discrete physical port capable of connecting to a network.
Line 3712: Line 3712:
  
  
-====== PCIeDevice ======+====== PCIeDevice 1.0.1 ======
  
 This is the schema definition for the PCIeDevice resource.  It represents the properties of a PCIeDevice attached to a System. This is the schema definition for the PCIeDevice resource.  It represents the properties of a PCIeDevice attached to a System.
Line 3787: Line 3787:
  
  
-====== PCIeFunction ======+====== PCIeFunction 1.0.1 ======
  
 This is the schema definition for the PCIeFunction resource.  It represents the properties of a PCIeFunction attached to a System. This is the schema definition for the PCIeFunction resource.  It represents the properties of a PCIeFunction attached to a System.
Line 3893: Line 3893:
  
  
-====== Port ======+====== Port 1.0.1 ======
  
 Port contains properties describing a port of a switch. Port contains properties describing a port of a switch.
Line 3975: Line 3975:
  
  
-====== Power ======+====== Power 1.2.1 ======
  
 This is the schema definition for the Power Metrics.  It represents the properties for Power Consumption and Power Limiting. This is the schema definition for the Power Metrics.  It represents the properties for Power Consumption and Power Limiting.
Line 4131: Line 4131:
  
  
-====== PrivilegeRegistry ======+====== PrivilegeRegistry 1.0.0 ======
  
 This is the schema definition for Operation to Privilege mapping. This is the schema definition for Operation to Privilege mapping.
Line 4151: Line 4151:
 | **PrivilegesUsed** [ {} ] | array\\ \\ *read-only* | Lists the set of Redfish standard priviliges used in building this mapping. | | **PrivilegesUsed** [ {} ] | array\\ \\ *read-only* | Lists the set of Redfish standard priviliges used in building this mapping. |
  
-====== Processor ======+====== Processor 1.0.3 ======
  
 This is the schema definition for the Processor resource.  It represents the properties of a processor attached to a System. This is the schema definition for the Processor resource.  It represents the properties of a processor attached to a System.
Line 4254: Line 4254:
  
  
-====== Role ======+====== Role 1.0.2 ======
  
 This resource defines a user role to be used in conjunction with a Manager Account. This resource defines a user role to be used in conjunction with a Manager Account.
Line 4268: Line 4268:
 | **OemPrivileges** [ {} ] | array\\ \\ *read-write* | The OEM privileges that this role includes. | | **OemPrivileges** [ {} ] | array\\ \\ *read-write* | The OEM privileges that this role includes. |
  
-====== SecureBoot ======+====== SecureBoot 1.0.1 ======
  
 This resource contains UEFI Secure Boot information. It represents properties for managing the UEFI Secure Boot functionality of a system. This resource contains UEFI Secure Boot information. It represents properties for managing the UEFI Secure Boot functionality of a system.
Line 4305: Line 4305:
  
  
-====== SerialInterface ======+====== SerialInterface 1.0.3 ======
  
 This schema defines an asynchronous serial interface resource. This schema defines an asynchronous serial interface resource.
Line 4405: Line 4405:
  
  
-====== ServiceRoot ======+====== ServiceRoot 1.1.1 ======
  
 This object represents the root Redfish service. This object represents the root Redfish service.
Line 4553: Line 4553:
  
  
-====== Session ======+====== Session 1.0.3 ======
  
 The Session resource describes a single connection (session) between a client and a Redfish service instance. The Session resource describes a single connection (session) between a client and a Redfish service instance.
Line 4566: Line 4566:
 | **UserName** | string, null\\ \\ *read-only* | The UserName for the account for this session. | | **UserName** | string, null\\ \\ *read-only* | The UserName for the account for this session. |
  
-====== SessionService ======+====== SessionService 1.1.1 ======
  
 This is the schema definition for the Session Service.  It represents the properties for the service itself and has links to the actual list of sessions. This is the schema definition for the Session Service.  It represents the properties for the service itself and has links to the actual list of sessions.
Line 4630: Line 4630:
  
  
-====== SimpleStorage ======+====== SimpleStorage 1.1.1 ======
  
 This is the schema definition for the Simple Storage resource.  It represents the properties of a storage controller and its directly-attached devices. This is the schema definition for the Simple Storage resource.  It represents the properties of a storage controller and its directly-attached devices.
Line 4691: Line 4691:
  
  
-====== SoftwareInventory ======+====== SoftwareInventory 1.1.0 ======
  
 This schema defines an inventory of software components. This schema defines an inventory of software components.
Line 4753: Line 4753:
  
  
-====== Storage ======+====== Storage 1.1.1 ======
  
 This schema defines a storage subsystem and its respective properties.  A storage subsystem represents a set of storage controllers (physical or virtual) and the resources such as volumes that can be accessed from that subsystem. This schema defines a storage subsystem and its respective properties.  A storage subsystem represents a set of storage controllers (physical or virtual) and the resources such as volumes that can be accessed from that subsystem.
Line 4951: Line 4951:
  
  
-====== StorageGroup ======+====== StorageGroup 1.0.0 ======
  
 Collection of resources that are managed and exposed to hosts as a group. Collection of resources that are managed and exposed to hosts as a group.
Line 5229: Line 5229:
  
  
-====== StoragePool ======+====== StoragePool 1.0.0 ======
  
 A container of data storage. A container of data storage.
Line 5335: Line 5335:
  
  
-====== StorageService ======+====== StorageService 1.0.0 ======
  
 Collection of resources that are managed and exposed to hosts as a group. Collection of resources that are managed and exposed to hosts as a group.
Line 5501: Line 5501:
  
  
-====== Switch ======+====== Switch 1.0.1 ======
  
 Switch contains properties describing a simple fabric switch. Switch contains properties describing a simple fabric switch.
Line 5629: Line 5629:
  
  
-====== Task ======+====== Task 1.0.3 ======
  
 This resource contains information about a specific Task scheduled by or being executed by a Redfish service's Task Service. This resource contains information about a specific Task scheduled by or being executed by a Redfish service's Task Service.
Line 5672: Line 5672:
  
  
-====== TaskService ======+====== TaskService 1.0.3 ======
  
 This is the schema definition for the Task Service.  It represents the properties for the service itself and has links to the actual list of tasks. This is the schema definition for the Task Service.  It represents the properties for the service itself and has links to the actual list of tasks.
Line 5742: Line 5742:
  
  
-====== Thermal ======+====== Thermal 1.2.0 ======
  
 This is the schema definition for the Thermal properties.  It represents the properties for Temperature and Cooling. This is the schema definition for the Thermal properties.  It represents the properties for Temperature and Cooling.
Line 5906: Line 5906:
  
  
-====== UpdateService ======+====== UpdateService 1.1.0 ======
  
 This is the schema definition for the Update Service. It represents the properties for the service itself and has links to collections of firmware and software inventory. This is the schema definition for the Update Service. It represents the properties for the service itself and has links to collections of firmware and software inventory.
Line 5978: Line 5978:
  
  
-====== VLanNetworkInterface ======+====== VLanNetworkInterface 1.0.3 ======
  
 This resource contains information for a Virtual LAN (VLAN) network instance available on a manager, system or other device. This resource contains information for a Virtual LAN (VLAN) network instance available on a manager, system or other device.
Line 5991: Line 5991:
 | **VLANId** | number, null\\ \\ *read-write* | This indicates the VLAN identifier for this VLAN. | | **VLANId** | number, null\\ \\ *read-write* | This indicates the VLAN identifier for this VLAN. |
  
-====== VirtualMedia ======+====== VirtualMedia 1.0.3 ======
  
 This resource allows monitoring and control of an instance of virtual media (e.g. a remote CD, DVD, or USB device) functionality provided by a Manager for a system or device. This resource allows monitoring and control of an instance of virtual media (e.g. a remote CD, DVD, or USB device) functionality provided by a Manager for a system or device.
Line 6020: Line 6020:
  
  
-====== Volume ======+====== Volume 1.1.0 ======
  
 Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system. Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system.
Line 6346: Line 6346:
  
  
-====== Zone ======+====== Zone 1.0.1 ======
  
 Switch contains properties describing a simple fabric zone. Switch contains properties describing a simple fabric zone.
Line 6403: Line 6403:
 | UnavailableOffline | This function or resource is present but cannot be used. | | UnavailableOffline | This function or resource is present but cannot be used. |
 | Updating | The element is updating and may be unavailable or degraded. | | Updating | The element is updating and may be unavailable or degraded. |
-