meta data for this page
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
| documentation:redfish_api:schema_definition [2017/04/24 12:32] – [Property Details] bil | documentation:redfish_api:schema_definition [2017/04/27 12:26] – bil | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Schema Definition ====== | ||
| + | ====== Schema Definition ====== | ||
| Line 7: | Line 7: | ||
| Account Service contains properties common to all user accounts, such as password requirements, | Account Service contains properties common to all user accounts, such as password requirements, | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AccountLockoutCounterResetAfter** | number | read-write | The interval of time in seconds since the last failed login attempt at which point the lockout threshold counter for the account is reset to zero. Must be less than or equal to AccountLockoutDuration.\\ unit: s | | + | | **AccountLockoutCounterResetAfter** | number |
| - | | **AccountLockoutDuration** | number, null | read-write | The time in seconds an account is locked after the account lockout threshold is met. Must be >= AccountLockoutResetAfter. If set to 0, no lockout will occur.\\ unit: s | | + | | **AccountLockoutDuration** | number |
| - | | **AccountLockoutThreshold** | number, null | read-write | The number of failed login attempts before a user account is locked for a specified duration (0=never locked). | | + | | **AccountLockoutThreshold** | number |
| - | | **[[documentation: | + | | **Accounts** | reference([[documentation: |
| - | | **AuthFailureLoggingThreshold** | number | read-write | This is the number of authorization failures that need to occur before the failure attempt is logged to the manager log. | | + | | **AuthFailureLoggingThreshold** | number |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **MaxPasswordLength** | number | read-only | This is the maximum password length for this service. | | + | | **MaxPasswordLength** | number |
| - | | **MinPasswordLength** | number | read-only | This is the minimum password length for this service. | | + | | **MinPasswordLength** | number |
| - | | **Name** | string | read-write | The name of the resource or array element. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **[[documentation: | + | | **PrivilegeMap** | reference([[documentation: |
| - | | **[[documentation: | + | | **Roles** | reference([[documentation: |
| - | | **ServiceEnabled** | boolean, null | read-write | This indicates whether this service is enabled. | | + | | **ServiceEnabled** | boolean |
| - | | **Status** { | object | read-only | | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| === Property Details === | === Property Details === | ||
| Line 65: | Line 65: | ||
| ActionInfo describes the parameters and other information necessary to perform a Redfish Action to a particular Action target. | ActionInfo describes the parameters and other information necessary to perform a Redfish Action to a particular Action target. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Name** | string | read-write | The name of the resource or array element. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Parameters** [ { | array | read-write | The parameters associated with the specified Redfish Action. | | + | | **Parameters** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **AllowableValues** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **DataType** | string |
| - | | < | + | | \ \ \ \ \ \ **Name** | string |
| - | | < | + | | \ \ \ \ \ \ **ObjectDataType** | string |
| - | | < | + | | \ \ \ \ \ \ **Required** | boolean |
| - | | } ] | | + | | } ] | | | |
| === Property Details === | === Property Details === | ||
| Line 96: | Line 96: | ||
| 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. | 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Language** | string | read-only | This is the RFC 5646 compliant language code for the registry. | | + | | **Language** | string |
| - | | **Name** | string | read-write | The name of the resource or array element. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **OwningEntity** | string | read-only | This is the organization or company that publishes this registry. | | + | | **OwningEntity** | string |
| - | | **RegistryEntries** { | object | read-write | List of all attributes and their metadata for this component. | | + | | **RegistryEntries** { | object |
| - | | < | + | | \ \ \ \ \ \ **Attributes** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Dependencies** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Menus** [ {} ] | array | |
| - | | } | | + | | } | | | |
| - | | **RegistryVersion** | string | read-only | This is the attribute registry version which is used in the middle portion of a AttributeRegistry. | | + | | **RegistryVersion** | string |
| - | | **SupportedSystems** [ { | array | read-write | Array of systems supported by this attribute registry. | | + | | **SupportedSystems** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **ProductName** | string |
| - | | < | + | | \ \ \ \ \ \ **SystemId** | string |
| - | | } ] | | + | | } ] | | | |
| ===== Bios ===== | ===== Bios ===== | ||
| Line 118: | Line 118: | ||
| 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **AttributeRegistry** | string, null | read-only | The Resource ID of the Attribute Registry for the BIOS Attributes resource. | | + | | **AttributeRegistry** | string |
| - | | **Attributes** {} | object | read-write | This is the manufacturer/ | + | | **Attributes** {} | object |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Name** | string | read-write | The name of the resource or array element. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== Chassis ===== | ===== Chassis ===== | ||
| Line 135: | Line 135: | ||
| A Chassis represents the physical components for any system. | A Chassis represents the physical components for any system. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **AssetTag** | string, null | read-write | The user assigned asset tag for this chassis. | | + | | **AssetTag** | string |
| - | | **ChassisType** | string | read-write | This property indicates the type of physical form factor of this resource.\\ | + | | **ChassisType** | string |
| - | | **DepthMm** | number, null | read-only | The depth of the chassis.\\ unit: mm | | + | | **DepthMm** | number |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **HeightMm** | number, null | read-only | The height of the chassis.\\ unit: mm | | + | | **HeightMm** | number |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **IndicatorLED** | string, null | read-write | The state of the indicator LED, used to identify the chassis.\\ | + | | **IndicatorLED** | string |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **ComputerSystems** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **ContainedBy** {} | object |
| - | | < | + | | \ \ \ \ \ \ **Contains** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **CooledBy** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Drives** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **ManagedBy** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **ManagersInChassis** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **PCIeDevices** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **PoweredBy** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Storage** [ {} ] | array | |
| - | | < | + | | } | | | |
| - | | < | + | | **Location** { | object |
| - | | < | + | | \ \ \ \ \ \ **Info** | string |
| - | | < | + | | \ \ \ \ \ \ **InfoFormat** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | } | | | |
| - | | < | + | | **LogServices** | reference([[documentation: |
| - | | < | + | | **Manufacturer** | string |
| - | | < | + | | **Model** | string |
| - | | } | | + | | **Name** | string |
| - | | **Location** { | object | read-only | | | + | | **NetworkAdapters** | reference([[documentation: |
| - | | < | + | | **Oem** {} | object |
| - | | < | + | | **PartNumber** | string |
| - | | < | + | | **PhysicalSecurity** { | object |
| - | | } | | + | | \ \ \ \ \ \ **IntrusionSensor** | string |
| - | | **[[documentation: | + | | \ \ \ \ \ \ **IntrusionSensorNumber** | number |
| - | | **Manufacturer** | string, null | read-only | This is the manufacturer of this chassis. | | + | | \ \ \ \ \ \ **IntrusionSensorReArm** | string |
| - | | **Model** | string, null | read-only | This is the model number for the chassis. | | + | | } | | | |
| - | | **Name** | string | read-write | The name of the resource or array element. | | + | | **Power** | reference([[documentation: |
| - | | **[[documentation: | + | | **PowerState** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **SKU** | string |
| - | | **PartNumber** | string, null | read-only | The part number for this chassis. | | + | | **SerialNumber** | string |
| - | | **PhysicalSecurity** { | object | read-write | The state of the physical security sensor. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | \ \ \ \ \ \ **State** | string |
| - | | **[[documentation: | + | | } | | | |
| - | | **PowerState** | string, null | read-write | This is the current power state of the chassis.\\ | + | | **Thermal** | reference([[documentation: |
| - | | **SKU** | string, null | read-only | This is the SKU for this chassis. | | + | | **WeightKg** | number |
| - | | **SerialNumber** | string, null | read-only | The serial number for this chassis. | | + | | **WidthMm** | number |
| - | | **Status** { | object | read-only | | | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } | | + | |
| - | | **[[documentation: | + | |
| - | | **WeightKg** | number, null | read-only | The weight of the chassis.\\ unit: kg | | + | |
| - | | **WidthMm** | number, null | read-only | The width of the chassis.\\ unit: mm | | + | |
| === Property Details === | === Property Details === | ||
| Line 289: | Line 280: | ||
| A Collection of Chassis resource instances. | A Collection of Chassis resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | The name of the resource or array element. | |
| - | | < | + | | **Oem** {} | object |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | + | |
| - | | **Name** | string | + | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | === Property Details === | + | |
| - | + | ||
| - | == ChassisType == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Blade | An enclosed or semi-enclosed, | + | |
| - | | Card | A loose device or circuit board intended to be installed in a system or other enclosure. | | + | |
| - | | Cartridge | A small self-contained system intended to be plugged into a multi-system chassis. | | + | |
| - | | Component | A small chassis, card, or device which contains devices for a particular subsystem or function. | | + | |
| - | | Drawer | An enclosed or semi-enclosed, | + | |
| - | | Enclosure | A generic term for a chassis that does not fit any other description. | | + | |
| - | | Expansion | A chassis which expands the capabilities or capacity of another chassis. | | + | |
| - | | IPBasedDrive | A chassis in a drive form factor with IP-based network connections. | | + | |
| - | | Module | A small, typically removable, chassis or card which contains devices for a particular subsystem or function. | | + | |
| - | | Other | A chassis that does not fit any of these definitions. | | + | |
| - | | Pod | A collection of equipment racks in a large, likely transportable, | + | |
| - | | Rack | An equipment rack, typically a 19-inch wide freestanding unit. | | + | |
| - | | RackGroup | A group of racks which form a single entity or share infrastructure. | | + | |
| - | | RackMount | A single system chassis designed specifically for mounting in an equipment rack. | | + | |
| - | | Row | A collection of equipment racks. | | + | |
| - | | Shelf | An enclosed or semi-enclosed, | + | |
| - | | Sidecar | A chassis that mates mechanically with another chassis to expand its capabilities or capacity. | | + | |
| - | | Sled | An enclosed or semi-enclosed, | + | |
| - | | StandAlone | A single, free-standing system, commonly called a tower or desktop chassis. | | + | |
| - | | Zone | A logical division or portion of a physical chassis that contains multiple devices or systems that cannot be physically separated. | | + | |
| - | + | ||
| - | == IndicatorLED == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Blinking | The Indicator LED is blinking. | | + | |
| - | | Lit | The Indicator LED is lit. | | + | |
| - | | Off | The Indicator LED is off. | | + | |
| - | | Unknown | The state of the Indicator LED cannot be determined. Deprecated: Return null if state is unknown. | | + | |
| - | + | ||
| - | == PowerState == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Off | The components within the chassis has no power, except some components may continue to have AUX power such as management controller. | | + | |
| - | | On | The components within the chassis has power on. | | + | |
| - | | PoweringOff | A temporary state between On and Off. The components within the chassis can take time to process the power off action. | | + | |
| - | | PoweringOn | A temporary state between Off and On. The components within the chassis can take time to process the power on action. | | + | |
| ===== ClassOfService ===== | ===== ClassOfService ===== | ||
| Line 370: | Line 290: | ||
| A service option composed of one or more service options. | A service option composed of one or more service options. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **ClassOfServiceVersion** | string, null | read-write | The value identifies the current version of this class of service definition. | | + | | **ClassOfServiceVersion** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Identifier** { | object, null | read-only | The value identifies this resource. | | + | | **Identifier** { | object |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | } | | + | | } | | | |
| - | | **LinesOfService** { | object, null | read-write | Lines of Service that define the required choices of utility or warranty. | | + | | **LinesOfService** { | object |
| - | | < | + | | \ \ \ \ \ \ **DataProtectionLinesOfService** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **DataSecurityLinesOfService** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **DataStorageLinesOfService** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **IOConnectivityLinesOfService** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **IOPerformanceLinesOfService** [ {} ] | array | |
| - | | } | | + | | } | | | |
| - | | **Name** | string | read-write | The name of the resource or array element. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| === Property Details === | === Property Details === | ||
| Line 404: | Line 324: | ||
| A Collection of ClassOfService resource instances. | A Collection of ClassOfService resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | The name of the resource or array element. | |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Name** | string | read-write | The name of the resource or array element. | | + | |
| - | | **Oem** {} | object | + | |
| ===== ComputerSystem ===== | ===== ComputerSystem ===== | ||
| Line 423: | Line 334: | ||
| This schema defines a computer system and its respective properties. | This schema defines a computer system and its respective properties. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **AssetTag** | string, null | read-write | The user definable tag that can be used to track this computer system for inventory or other client purposes. | | + | | **AssetTag** | string |
| - | | **[[documentation: | + | | **Bios** | reference([[documentation: |
| - | | **BiosVersion** | string, null | read-only | The version of the system BIOS or primary system firmware. | | + | | **BiosVersion** | string |
| - | | **Boot** { | object | read-write | Information about the boot settings for this system. | | + | | **Boot** { | object |
| - | | < | + | | \ \ \ \ \ \ **BootSourceOverrideEnabled** | string |
| - | | < | + | | \ \ \ \ \ \ **BootSourceOverrideMode** | string |
| - | | < | + | | \ \ \ \ \ \ **BootSourceOverrideTarget** | string |
| - | | < | + | | \ \ \ \ \ \ **UefiTargetBootSourceOverride** | string |
| - | | } | | + | | } | | | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **[[documentation: | + | | **EthernetInterfaces** | reference([[documentation: |
| - | | **HostName** | string, null | read-write | The DNS Host Name, without any domain information. | | + | | **HostName** | string |
| - | | **HostedServices** { | object | read-write | The services that this computer system supports. | | + | | **HostedServices** { | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **StorageServices** |
| - | | } | | + | | } | | | |
| - | | **HostingRoles** [ {} ] | array | read-only | The hosing roles that this computer system supports. | | + | | **HostingRoles** [ {} ] | array | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **IndicatorLED** | string, null | read-write | The state of the indicator LED, used to identify the system.\\ | + | | **IndicatorLED** | string |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Chassis** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **CooledBy** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Endpoints** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **ManagedBy** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **PoweredBy** [ {} ] | array | |
| - | | < | + | | } | | | |
| - | | < | + | | **LogServices** | reference([[documentation: |
| - | | < | + | | **Manufacturer** | string |
| - | | < | + | | **Memory** | reference([[documentation: |
| - | | < | + | | **MemoryDomains** | object | Yes | read-write | A reference to the collection of Memory Domains associated with this system. | |
| - | | } | | + | | **MemorySummary** { | object |
| - | | **[[documentation: | + | | \ \ \ \ \ \ **MemoryMirroring** | string |
| - | | **Manufacturer** | string, null | read-only | The manufacturer or OEM of this system. | | + | | \ \ \ \ \ \ **Status** {} | object |
| - | | **[[documentation: | + | | \ \ \ \ \ \ **TotalSystemMemoryGiB** | number |
| - | | **[[documentation: | + | | } | | | |
| - | | **MemorySummary** { | object | read-write | This object describes the central memory of the system in general detail. | | + | | **Model** | string |
| - | | < | + | | **Name** | string |
| - | | < | + | | **NetworkInterfaces** | reference([[documentation: |
| - | | < | + | | **Oem** {} | object |
| - | | } | | + | | **PCIeDevices** | array(reference([[documentation: |
| - | | **Model** | string, null | read-only | The model number for this system. | | + | | **PCIeFunctions** | array(reference([[documentation:redfish_api: |
| - | | **Name** | string | read-write | The name of the resource or array element. | | + | | **PartNumber** | string | Yes | read-only | The part number for this system. | |
| - | | **[[documentation: | + | | **PowerState** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **ProcessorSummary** { | object |
| - | | **PCIeDevices** | + | | \ \ \ \ \ \ **Count** | number |
| - | | < | + | | \ \ \ \ \ \ **Model** | string |
| - | | < | + | | \ \ \ \ \ \ **Status** {} | object |
| - | | < | + | | } | | | |
| - | | < | + | | **Processors** | reference([[documentation: |
| - | | < | + | | **SKU** | string |
| - | | < | + | | **SecureBoot** | reference([[documentation: |
| - | | < | + | | **SerialNumber** | string |
| - | | < | + | | **SimpleStorage** | reference([[documentation: |
| - | | < | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | < | + | | } | | | |
| - | | } ] | | + | | **Storage** | reference([[documentation: |
| - | | **[email protected]** | string | read-write | + | | **SystemType** | string |
| - | | **PCIeFunctions** [ { | array | read-only | A reference to a collection of PCIe Functions | + | | **TrustedModules** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **FirmwareVersion** | string |
| - | | < | + | | \ \ \ \ \ \ **FirmwareVersion2** | string |
| - | | < | + | | \ \ \ \ \ \ **InterfaceType** | string |
| - | | < | + | | \ \ \ \ \ \ **InterfaceTypeSelection** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **Status** {} | object |
| - | | < | + | | } ] | | | |
| - | | < | + | | **UUID** | string |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | | | + | |
| - | | **PartNumber** | string, null | read-only | The part number for this system. | | + | |
| - | | **PowerState** | string, null | read-write | This is the current power state of the system.\\ | + | |
| - | | **ProcessorSummary** { | object | read-write | This object describes the central processors of the system in general detail. | | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } | | + | |
| - | | **[[documentation: | + | |
| - | | **SKU** | string, null | read-only | The manufacturer SKU for this system. | | + | |
| - | | **[[documentation: | + | |
| - | | **SerialNumber** | string, null | read-only | The serial number for this system. | | + | |
| - | | **[[documentation: | + | |
| - | | **Status** { | object | read-only | | | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } | | + | |
| - | | **[[documentation: | + | |
| - | | **SystemType** | string | read-write | The type of computer system represented by this resource.\\ | + | |
| - | | **TrustedModules** [ { | array | read-write | This object describes the array of Trusted Modules in the system. | | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **UUID** | string, null | read-write | The universal unique identifier (UUID) for this system.\\ pattern: ([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}) | | + | |
| === Property Details === | === Property Details === | ||
| Line 663: | Line 536: | ||
| | PoweringOff | A temporary state between On and Off. The power off action can take time while the OS is in the shutdown process. | | | PoweringOff | A temporary state between On and Off. The power off action can take time while the OS is in the shutdown process. | | ||
| | PoweringOn | A temporary state between Off and On. This temporary state can be very short. | | | PoweringOn | A temporary state between Off and On. This temporary state can be very short. | | ||
| + | |||
| + | == SecureBootCurrentBoot == | ||
| + | |||
| + | ^ string ^ Description ^ | ||
| + | | Disabled | Secure Boot is currently disabled. | | ||
| + | | Enabled | Secure Boot is currently enabled. | | ||
| + | |||
| + | == SecureBootMode == | ||
| + | |||
| + | ^ string ^ Description ^ | ||
| + | | AuditMode | Secure Boot is currently in Audit Mode. | | ||
| + | | DeployedMode | Secure Boot is currently in Deployed Mode. | | ||
| + | | SetupMode | Secure Boot is currently in Setup Mode. | | ||
| + | | UserMode | Secure Boot is currently in User Mode. | | ||
| == State == | == State == | ||
| Line 693: | Line 580: | ||
| A Collection of ComputerSystem resource instances. | A Collection of ComputerSystem resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | The name of the resource or array element. | |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | | | + | |
| - | | **Name** | string | read-write | The name of the resource or array element. | | + | |
| - | | **Oem** {} | object | + | |
| - | + | ||
| - | === Property Details === | + | |
| - | + | ||
| - | == IndicatorLED == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Blinking | The Indicator LED is blinking. | | + | |
| - | | Lit | The Indicator LED is lit. | | + | |
| - | | Off | The Indicator LED is off. | | + | |
| - | | Unknown | The state of the Indicator LED cannot be determined. Deprecated: Return null if state is unknown. | | + | |
| - | + | ||
| - | == PowerState == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Off | The system is powered off, although some components may continue to have AUX power such as management controller. | | + | |
| - | | On | The system is powered on. | | + | |
| - | | PoweringOff | A temporary state between On and Off. The power off action can take time while the OS is in the shutdown process. | | + | |
| - | | PoweringOn | A temporary state between Off and On. This temporary state can be very short. | | + | |
| - | + | ||
| - | == SystemType == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | OS | An operating system instance. | | + | |
| - | | Physical | A computer system. | | + | |
| - | | PhysicallyPartitioned | A hardware-based partition of a computer system. | | + | |
| - | | Virtual | A virtual machine instance running on this system. | | + | |
| - | | VirtuallyPartitioned | A virtual or software-based partition of a computer system. | | + | |
| ===== DataProtectionLoSCapabilities ===== | ===== DataProtectionLoSCapabilities ===== | ||
| Line 772: | Line 590: | ||
| Describe data protection capabilities | Describe data protection capabilities | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Identifier** { | object, null | read-only | The value identifies this resource. | | + | | **Identifier** { | object |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | } | | + | | } | | | |
| - | | **Links** { | object | read-only | Contains links to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **SupportedReplicaOptions** [ {} ] | array | |
| - | | < | + | | } | | | |
| - | | } | | + | | **Name** | string |
| - | | **Name** | string | read-write | The name of the resource or array element. | | + | | **Oem** {} | object |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **SupportedDataProtectionLinesOfService** [ { | array | |
| - | | **SupportedDataProtectionLinesOfService** [ { | array | read-write | Collection of known and supported DataProtectionLinesOfService. | | + | | \ \ \ \ \ \ **IsIsolated** | boolean |
| - | | < | + | | \ \ \ \ \ \ **MinLifetime** | number |
| - | | < | + | | \ \ \ \ \ \ **Name** | string |
| - | | < | + | | \ \ \ \ \ \ **RecoveryGeographicObjective** | string |
| - | | < | + | | \ \ \ \ \ \ **RecoveryPointObjective** | string |
| - | | < | + | | \ \ \ \ \ \ **RecoveryTimeObjective** | string |
| - | | < | + | | \ \ \ \ \ \ **ReplicaAccessLocation** {} | object |
| - | | < | + | | \ \ \ \ \ \ **ReplicaClassOfService** |
| - | | < | + | | \ \ \ \ \ \ **ReplicaType** | string |
| - | | < | + | | \ \ \ \ \ \ **Schedule** {} | object |
| - | | < | + | | } ] | | | |
| - | | } ] | | + | | **SupportedMinLifetime** [ {} ] | array | |
| - | | **SupportedMinLifetime** [ {} ] | array | read-write | Supported minimum lifetime that replica must be maintained. | | + | | **SupportedRecoveryGeographicObjectives** [ {} ] | array | |
| - | | **SupportedRecoveryGeographicObjectives** [ {} ] | array | read-write | Supported types of failure domains. | | + | | **SupportedRecoveryPointObjectiveSeconds** [ {} ] | array | |
| - | | **SupportedRecoveryPointObjectiveSeconds** [ {} ] | array | read-write | Supported time intervals defining how much source information can be lost on failure. | | + | | **SupportedRecoveryTimeObjectives** [ {} ] | array | |
| - | | **SupportedRecoveryTimeObjectives** [ {} ] | array | read-write | Supported expectations for time to access an alternate replica. | | + | | **SupportedReplicaTypes** [ {} ] | array | |
| - | | **SupportedReplicaTypes** [ {} ] | array | read-write | Supported replica types. | | + | | **SupportsIsolated** | boolean |
| - | | **SupportsIsolated** | boolean, null | read-write | Allocating a replica in a separate fault domain is supported. | | + | |
| === Property Details === | === Property Details === | ||
| Line 847: | Line 664: | ||
| Describe data security capabilities. | Describe data security capabilities. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Identifier** { | object, null | read-only | The value identifies this resource. | | + | | **Identifier** { | object |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | } | | + | | } | | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **SupportedAntivirusEngineProviders** [ {} ] | array | read-write | Supported AntiVirus providers. | | + | | **SupportedAntivirusEngineProviders** [ {} ] | array | |
| - | | **SupportedAntivirusScanPolicies** [ {} ] | array | read-write | Supported policies that trigger an AntiVirus scan. | | + | | **SupportedAntivirusScanPolicies** [ {} ] | array | |
| - | | **SupportedChannelEncryptionStrengths** [ {} ] | array | read-write | Supported key sizes for transport channel encryption. | | + | | **SupportedChannelEncryptionStrengths** [ {} ] | array | |
| - | | **SupportedDataSanitizationPolicies** [ {} ] | array | read-write | Supported data sanitization policies. | | + | | **SupportedDataSanitizationPolicies** [ {} ] | array | |
| - | | **SupportedDataSecurityLinesOfService** [ { | array | read-write | Collection of known and supported DataSecurityLinesOfService. | | + | | **SupportedDataSecurityLinesOfService** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **AntivirusEngineProvider** | string |
| - | | < | + | | \ \ \ \ \ \ **AntivirusScanPolicies** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **ChannelEncryptionStrength** | string |
| - | | < | + | | \ \ \ \ \ \ **DataSanitizationPolicy** | string |
| - | | < | + | | \ \ \ \ \ \ **HostAuthenticationType** | string |
| - | | < | + | | \ \ \ \ \ \ **MediaEncryptionStrength** | string |
| - | | < | + | | \ \ \ \ \ \ **Name** | string |
| - | | < | + | | \ \ \ \ \ \ **SecureChannelProtocol** | string |
| - | | < | + | | \ \ \ \ \ \ **UserAuthenticationType** | string |
| - | | } ] | | + | | } ] | | | |
| - | | **SupportedHostAuthenticationTypes** [ {} ] | array | read-write | Supported authentication types for hosts (servers) or initiator endpoints. | | + | | **SupportedHostAuthenticationTypes** [ {} ] | array | |
| - | | **SupportedMediaEncryptionStrengths** [ {} ] | array | read-write | Supported key sizes for media encryption. | | + | | **SupportedMediaEncryptionStrengths** [ {} ] | array | |
| - | | **SupportedSecureChannelProtocols** [ {} ] | array | read-write | Supported protocols that provide encrypted communication. | | + | | **SupportedSecureChannelProtocols** [ {} ] | array | |
| - | | **SupportedUserAuthenticationTypes** [ {} ] | array | read-write | Supported authentication types for users (or programs). | | + | | **SupportedUserAuthenticationTypes** [ {} ] | array | |
| === Property Details === | === Property Details === | ||
| Line 941: | Line 758: | ||
| Describe data storage capabilities. | Describe data storage capabilities. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Identifier** { | object, null | read-only | The value identifies this resource. | | + | | **Identifier** { | object |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | } | | + | | } | | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **SupportedAccessCapabilities** [ {} ] | array | read-write | Supported access capabilities. | | + | | **SupportedAccessCapabilities** [ {} ] | array | |
| - | | **SupportedDataStorageLinesOfService** [ { | array | read-write | Collection of known and supported DataStorageLinesOfService. | | + | | **SupportedDataStorageLinesOfService** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **IsSpaceEfficient** | boolean |
| - | | < | + | | \ \ \ \ \ \ **Name** | string |
| - | | < | + | | \ \ \ \ \ \ **ProvisioningPolicy** | string |
| - | | < | + | | \ \ \ \ \ \ **RecoveryTimeObjectives** | | Yes | read-write | Expectations for time to access the primary store after disaster recover. | |
| - | | } ] | | + | | } ] | | | |
| - | | **SupportedProvisioningPolicies** [ {} ] | array | read-write | Thin allows over allocation of storage. | | + | | **SupportedProvisioningPolicies** [ {} ] | array | |
| - | | **SupportedRecoveryTimeObjectives** [ {} ] | array | read-write | Supported expectations for time to access the primary store after recovery. | | + | | **SupportedRecoveryTimeObjectives** [ {} ] | array | |
| - | | **SupportsSpaceEfficiency** | boolean, null | read-write | Allows compression or deduplication of storage. | | + | | **SupportsSpaceEfficiency** | boolean |
| === Property Details === | === Property Details === | ||
| Line 983: | Line 800: | ||
| 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **AssetTag** | string, null | read-write | The user assigned asset tag for this drive. | | + | | **AssetTag** | string |
| - | | **BlockSizeBytes** | number, null | read-only | The size of the smallest addressible unit (Block) of this drive in bytes.\\ unit: By | | + | | **BlockSizeBytes** | number |
| - | | **CapableSpeedGbs** | number, null | read-only | The speed which this drive can communicate to a storage controller in ideal conditions in Gigabits per second.\\ unit: Gbit/s | | + | | **CapableSpeedGbs** | number |
| - | | **CapacityBytes** | number, null | read-only | The size in bytes of this Drive.\\ unit: By | | + | | **CapacityBytes** | number |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **EncryptionAbility** | string, null | read-write | The encryption abilities of this drive.\\ | + | | **EncryptionAbility** | string |
| - | | **EncryptionStatus** | string, null | read-write | The status of the encrytion of this drive.\\ | + | | **EncryptionStatus** | string |
| - | | **FailurePredicted** | boolean, null | read-only | Is this drive currently predicting a failure in the near future. | | + | | **FailurePredicted** | boolean |
| - | | **HotspareType** | string, null | read-write | The type of hotspare this drive is currently serving as.\\ *See Property Details, below, for more information about this property.* | | + | | **HotspareType** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Identifiers** [ { | array | read-write | The Durable names for the drive. | | + | | **Identifiers** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | } ] | | + | | } ] | | | |
| - | | **IndicatorLED** | string, null | read-write | The state of the indicator LED, used to identify the drive.\\ | + | | **IndicatorLED** | string |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Endpoints** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **Volumes** [ {} ] | array | |
| - | | < | + | | } | | | |
| - | | < | + | | **Location** [ { | array | |
| - | | } | | + | | \ \ \ \ \ \ **Info** | string |
| - | | **Location** [ { | array | read-write | The Location of the drive. | | + | | \ \ \ \ \ \ **InfoFormat** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | } ] | | | |
| - | | < | + | | **Manufacturer** | string |
| - | | } ] | | + | | **MediaType** | string |
| - | | **Manufacturer** | string, null | read-only | This is the manufacturer of this drive. | | + | | **Model** | string |
| - | | **MediaType** | string, null | read-write | The type of media contained in this drive.\\ | + | | **Name** | string |
| - | | **Model** | string, null | read-only | This is the model number for the drive. | | + | | **NegotiatedSpeedGbs** | number |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Oem** {} | object |
| - | | **NegotiatedSpeedGbs** | number, null | read-only | The speed which this drive is currently communicating to the storage controller in Gigabits per second.\\ unit: Gbit/s | | + | | **Operations** [ {} ] | array | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **PartNumber** | string |
| - | | **Operations** [ {} ] | array | read-write | The operations currently running on the Drive. | | + | | **PredictedMediaLifeLeftPercent** | number |
| - | | **PartNumber** | string, null | read-only | The part number for this drive. | | + | | **Protocol** | | Yes | read-write | The protocol this drive is using to communicate to the storage controller. | |
| - | | **PredictedMediaLifeLeftPercent** | number, null | read-only | The percentage of reads and writes that are predicted to still be available for the media. | | + | | **Revision** | string |
| - | | **Protocol** | null | read-write | The protocol this drive is using to communicate to the storage controller. | | + | | **RotationSpeedRPM** | number |
| - | | **Revision** | string, null | read-only | The revision of this Drive. This is typically the firmware/ | + | | **SKU** | string |
| - | | **RotationSpeedRPM** | number, null | read-only | The rotation speed of this Drive in Revolutions per Minute (RPM).\\ unit: RPM | | + | | **SerialNumber** | string |
| - | | **SKU** | string, null | read-only | This is the SKU for this drive. | | + | | **Status** { | object |
| - | | **SerialNumber** | string, null | read-only | The serial number for this drive. | | + | | \ \ \ \ \ \ **Health** | string |
| - | | **Status** { | object | read-only | | | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | < | + | | } | | | |
| - | | < | + | | **StatusIndicator** | string |
| - | | } | | + | |
| - | | **StatusIndicator** | string, null | read-write | The state of the status indicator, used to communicate status information about this drive.\\ | + | |
| === Property Details === | === Property Details === | ||
| Line 1131: | Line 946: | ||
| A Collection of Drive resource instances. | A Collection of Drive resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | | | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| - | + | ||
| - | === Property Details === | + | |
| - | + | ||
| - | == EncryptionAbility == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | None | The drive is not capable of self encryption. | | + | |
| - | | Other | The drive is capable of self encryption through some other means. | | + | |
| - | | SelfEncryptingDrive | The drive is capable of self encryption per the Trusted Computing Group' | + | |
| - | + | ||
| - | == EncryptionStatus == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Foreign | The drive is currently encrypted, the data is not accessible to the user, and the system requires user intervention to expose the data. | | + | |
| - | | Locked | The drive is currently encrypted and the data is not accessible to the user, however the system has the ability to unlock the drive automatically. | | + | |
| - | | Unecrypted | The drive is not currently encrypted. Deprecated: Use Unencrypted. | | + | |
| - | | Unencrypted | The drive is not currently encrypted. | | + | |
| - | | Unlocked | The drive is currently encrypted but the data is accessible to the user unencrypted. | | + | |
| - | + | ||
| - | == HotspareType == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Chassis | The drive is currently serving as a hotspare for all other drives in the chassis. | | + | |
| - | | Dedicated | The drive is currently serving as a hotspare for a user defined set of drives. | | + | |
| - | | Global | The drive is currently serving as a hotspare for all other drives in the storage system. | | + | |
| - | | None | The drive is not currently a hotspare. | | + | |
| - | + | ||
| - | == IndicatorLED == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Blinking | The Indicator LED is blinking. | | + | |
| - | | Lit | The Indicator LED is lit. | | + | |
| - | | Off | The Indicator LED is off. | | + | |
| - | + | ||
| - | == MediaType == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | HDD | The drive media type is traditional magnetic platters. | | + | |
| - | | SMR | The drive media type is shingled magnetic recording. | | + | |
| - | | SSD | The drive media type is solid state or flash memory. | | + | |
| - | + | ||
| - | == StatusIndicator == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Fail | The drive has failed. | | + | |
| - | | Hotspare | The drive is marked to be automatically rebuilt and used as a replacement for a failed drive. | | + | |
| - | | InACriticalArray | The array that this drive is a part of is degraded. | | + | |
| - | | InAFailedArray | The array that this drive is a part of is failed. | | + | |
| - | | OK | The drive is OK. | | + | |
| - | | PredictiveFailureAnalysis | The drive is still working but predicted to fail soon. | | + | |
| - | | Rebuild | The drive is being rebuilt. | | + | |
| ===== Endpoint ===== | ===== Endpoint ===== | ||
| Line 1226: | Line 956: | ||
| 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The Actions object contains the available custom actions on this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **ConnectedEntities** [ { | array | read-write | All the entities connected to this endpoint. | | + | | **ConnectedEntities** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **EntityLink** |
| - | | < | + | | \ \ \ \ \ \ **EntityPciId** {} | object |
| - | | < | + | | \ \ \ \ \ \ **EntityRole** | string |
| - | | < | + | | \ \ \ \ \ \ **EntityType** | string |
| - | | < | + | | \ \ \ \ \ \ **Identifiers** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **PciClassCode** | string |
| - | | < | + | | \ \ \ \ \ \ **PciFunctionNumber** | number |
| - | | } ] | | + | | } ] | | | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **EndpointProtocol** | null | read-write | The protocol supported by this endpoint. | | + | | **EndpointProtocol** | | Yes | read-write | The protocol supported by this endpoint. | |
| - | | **HostReservationMemoryBytes** | number, null | read-only | The amount of memory in Bytes that the Host should allocate to connect to this endpoint.\\ unit: By | | + | | **HostReservationMemoryBytes** | number |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Identifiers** [ { | array | read-write | Identifiers for this endpoint. | | + | | **Identifiers** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | } ] | | + | | } ] | | | |
| - | | **Links** { | object | read-write | The links object contains the links to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **MutuallyExclusiveEndpoints** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **Ports** [ {} ] | array | |
| - | | < | + | | } | | | |
| - | | < | + | | **Name** | string |
| - | | } | | + | | **Oem** {} | object |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **PciId** { | object |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | \ \ \ \ \ \ **DeviceId** | string |
| - | | **PciId** { | object, null | read-write | The PCI ID of the endpoint. | | + | | \ \ \ \ \ \ **SubsystemId** | string |
| - | | < | + | | \ \ \ \ \ \ **SubsystemVendorId** | string |
| - | | < | + | | \ \ \ \ \ \ **VendorId** | string |
| - | | < | + | | } | | | |
| - | | < | + | | **Redundancy** [ { | array | |
| - | | } | | + | | \ \ \ \ \ \ **MaxNumSupported** | number |
| - | | **Redundancy** [ { | array | read-write | Redundancy information for the lower level endpoints supporting this endpoint. | | + | | \ \ \ \ \ \ **MemberId** | string |
| - | | < | + | | \ \ \ \ \ \ **MinNumNeeded** | number |
| - | | < | + | | \ \ \ \ \ \ **Mode** | string |
| - | | < | + | | \ \ \ \ \ \ **Name** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **RedundancySet** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Status** {} | object |
| - | | < | + | | \ \ \ \ \ \ **MemberId** | string |
| - | | < | + | | \ \ \ \ \ \ **RedundancyEnabled** | boolean |
| - | | < | + | | } ] | | | |
| - | | < | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | } ] | | | | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | **[email protected]** | string | read-write | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | **Status** { | object, null | read-only | | | + | | \ \ \ \ \ \ **State** | string |
| - | | < | + | | } | | | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } | | + | |
| === Property Details === | === Property Details === | ||
| Line 1356: | Line 1082: | ||
| A Collection of Endpoint resource instances. | A Collection of Endpoint resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | | | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| ===== EndpointGroup ===== | ===== EndpointGroup ===== | ||
| Line 1382: | Line 1092: | ||
| A group of endpoints that are managed as a unit. | A group of endpoints that are managed as a unit. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AccessState** | string, null | read-write | Access State for this group.\\ | + | | **AccessState** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **[[documentation: | + | | **Endpoints** | object | Yes | read-write | The Endpoints. | |
| - | | **GroupType** | string, null | read-write | Endpoint group type.\\ | + | | **GroupType** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Identifier** { | object, null | read-only | The value identifies this resource. | | + | | **Identifier** { | object |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | } | | + | | } | | | |
| - | | **Links** { | object | read-only | Contains links to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Preferred** | boolean, null | read-write | Access to resource is preferred. | | + | | **Preferred** | boolean |
| - | | **TargetEndpointGroupIdentifier** | number, null | read-write | A defined identifier for this group. | | + | | **TargetEndpointGroupIdentifier** | number |
| === Property Details === | === Property Details === | ||
| Line 1431: | Line 1141: | ||
| A Collection of endpoint group resource instances. | A Collection of endpoint group resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| - | + | ||
| - | === Property Details === | + | |
| - | + | ||
| - | == AccessState == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | NonOptimized | The endpoint(s) are in an Active/ | + | |
| - | | Optimized | The endpoint(s) are in an Active/ | + | |
| - | | Standby | The endpoint(s) are in a Standby state. | | + | |
| - | | Transitioning | The endpoint(s) are transitioning to a new AccesState. | | + | |
| - | | Unavailable | The endpoint(s) are unavailable. | | + | |
| - | + | ||
| - | == GroupType == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Client | The group contains the client (initiator) endpoints. | | + | |
| - | | Server | The group contains the server (target) endpoints. | | + | |
| ===== EthernetInterface ===== | ===== EthernetInterface ===== | ||
| Line 1472: | Line 1151: | ||
| This schema defines a simple ethernet NIC resource. | This schema defines a simple ethernet NIC resource. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AutoNeg** | boolean, null | read-write | This indicates if the speed and duplex are automatically negotiated and configured on this interface. | | + | | **AutoNeg** | boolean |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **FQDN** | string, null | read-write | This is the complete, fully qualified domain name obtained by DNS for this interface. | | + | | **FQDN** | string |
| - | | **FullDuplex** | boolean, null | read-write | This indicates if the interface is in Full Duplex mode or not. | | + | | **FullDuplex** | boolean |
| - | | **HostName** | string, null | read-write | The DNS Host Name, without any domain information. | | + | | **HostName** | string |
| - | | **IPv4Addresses** [ { | array | read-write | The IPv4 addresses assigned to this interface. | | + | | **IPv4Addresses** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **Address** | string |
| - | | < | + | | \ \ \ \ \ \ **AddressOrigin** | string |
| - | | < | + | | \ \ \ \ \ \ **Gateway** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **SubnetMask** | string |
| - | | } ] | | + | | } ] | | | |
| - | | **IPv6AddressPolicyTable** [ { | array | read-write | An array representing the RFC 6724 Address Selection Policy Table. | | + | | **IPv6AddressPolicyTable** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **Label** | number |
| - | | < | + | | \ \ \ \ \ \ **Precedence** | number |
| - | | < | + | | \ \ \ \ \ \ **Prefix** | string |
| - | | } ] | | + | | } ] | | | |
| - | | **IPv6Addresses** [ { | array | read-write | This array of objects enumerates all of the currently assigned IPv6 addresses on this interface. | | + | | **IPv6Addresses** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **Address** | string |
| - | | < | + | | \ \ \ \ \ \ **AddressOrigin** | string |
| - | | < | + | | \ \ \ \ \ \ **AddressState** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **PrefixLength** | number |
| - | | } ] | | + | | } ] | | | |
| - | | **IPv6DefaultGateway** | string, null | read-only | This is the IPv6 default gateway address that is currently in use on this interface. | | + | | **IPv6DefaultGateway** | string |
| - | | **IPv6StaticAddresses** [ { | array | read-write | This array of objects represents all of the IPv6 static addresses to be assigned on this interface. | | + | | **IPv6StaticAddresses** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **Address** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **PrefixLength** | number |
| - | | } ] | | + | | } ] | | | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **InterfaceEnabled** | boolean, null | read-write | This indicates whether this interface is enabled. | | + | | **InterfaceEnabled** | boolean |
| - | | **LinkStatus** | string, null | read-write | The link status of this interface (port).\\ | + | | **LinkStatus** | string |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Endpoints** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **HostInterface** {} | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | } | | | |
| - | | } | | + | | **MACAddress** | string |
| - | | **MACAddress** | string, null | read-write | This is the currently configured MAC address of the (logical port) interface.\\ pattern: ^([0-9A-Fa-f]{2}[: | + | | **MTUSize** | number |
| - | | **MTUSize** | number, null | read-write | This is the currently configured Maximum Transmission Unit (MTU) in bytes on this interface. | | + | | **MaxIPv6StaticAddresses** | number |
| - | | **MaxIPv6StaticAddresses** | number, null | read-only | This indicates the maximum number of Static IPv6 addresses that can be configured on this interface. | | + | | **Name** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **NameServers** [ {} ] | array | |
| - | | **NameServers** [ {} ] | array | read-only | This represents DNS name servers that are currently in use on this interface. | | + | | **Oem** {} | object |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **PermanentMACAddress** | string |
| - | | **PermanentMACAddress** | string, null | read-write | This is the permanent MAC address assigned to this interface (port).\\ pattern: ^([0-9A-Fa-f]{2}[: | + | | **SpeedMbps** | number |
| - | | **SpeedMbps** | number, null | read-write | This is the current speed in Mbps of this interface.\\ unit: Mbit/s | | + | | **Status** { | object |
| - | | **Status** { | object, null | read-only | | | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | < | + | | } | | | |
| - | | } | | + | | **UefiDevicePath** | string |
| - | | **UefiDevicePath** | string, null | read-only | The UEFI device path for this interface. | | + | | **VLAN** | | Yes | read-write | If this Network Interface supports more than one VLAN, this property will not be present and the client should look for VLANs collection in the link section of this resource. | |
| - | | **VLAN** | null | read-write | If this Network Interface supports more than one VLAN, this property will not be present and the client should look for VLANs collection in the link section of this resource. | | + | | **VLANs** | reference([[documentation: |
| - | | **[[documentation: | + | |
| === Property Details === | === Property Details === | ||
| Line 1589: | Line 1267: | ||
| A Collection of EthernetInterface resource instances. | A Collection of EthernetInterface resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation:redfish_api: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | + | |
| - | | **Name** | string | + | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | === Property Details === | + | |
| - | + | ||
| - | == LinkStatus == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | LinkDown | There is no link on this interface, but the interface is connected. | | + | |
| - | | LinkUp | The link is available for communication on this interface. | | + | |
| - | | NoLink | There is no link or connection detected on this interface. | | + | |
| ===== Event ===== | ===== Event ===== | ||
| Line 1637: | Line 1277: | ||
| The Event schema describes the JSON payload received by an Event Destination (which has subscribed to event notification) when events occurs. | The Event schema describes the JSON payload received by an Event Destination (which has subscribed to event notification) when events occurs. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Context** | string | read-only | A context can be supplied at subscription time. This property is the context value supplied by the subscriber. | | + | | **Context** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Events** [ { | array | read-write | Each event in this array has a set of properties that describe the event. | + | | **Events** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **Context** | string |
| - | | < | + | | \ \ \ \ \ \ **EventId** | string |
| - | | < | + | | \ \ \ \ \ \ **EventTimestamp** | string |
| - | | < | + | | \ \ \ \ \ \ **EventType** | string |
| - | | < | + | | \ \ \ \ \ \ **MemberId** | string |
| - | | < | + | | \ \ \ \ \ \ **Message** | string |
| - | | < | + | | \ \ \ \ \ \ **MessageArgs** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **MessageId** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **OriginOfCondition** |
| - | | < | + | | \ \ \ \ \ \ **Severity** | string |
| - | | } ] | | | | + | | } ] | | | |
| - | | **[email protected]** | string | read-write | + | | **Id** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Name** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Oem** {} | object |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | |
| === Property Details === | === Property Details === | ||
| Line 1674: | Line 1313: | ||
| An Event Destination desribes the target of an event subscription, | An Event Destination desribes the target of an event subscription, | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Context** | string | read-write | A client-supplied string that is stored with the event destination subscription. | | + | | **Context** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Destination** | string | read-only | The URI of the destination Event Service. | | + | | **Destination** | string |
| - | | **EventTypes** [ {} ] | array | read-only | This property shall contain the types of events that shall be sent to the desination. | | + | | **EventTypes** [ {} ] | array | |
| - | | **HttpHeaders** [ {} ] | array | read-write | This is for setting HTTP headers, such as authorization information. | + | | **HttpHeaders** [ {} ] | array | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **MessageIds** [ {} ] | array | read-only | A list of MessageIds that the service will only send. | | + | | **MessageIds** [ {} ] | array | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **OriginResources** [ {} ] | array | read-only | A list of resources for which the service will only send related events. | | + | | **OriginResources** [ {} ] | array | |
| - | | **[email protected]** | string | + | | **Protocol** | string | | read-write | The protocol type of the event connection.\\ |
| - | | **Protocol** | string | + | |
| === Property Details === | === Property Details === | ||
| Line 1693: | Line 1331: | ||
| ^ string ^ | ^ string ^ | ||
| - | | Redfish | | + | | Redfish | |
| Line 1700: | Line 1338: | ||
| A Collection of EventDestination resource instances. | A Collection of EventDestination resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | + | |
| - | | **Name** | string | + | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | === Property Details === | + | |
| - | + | ||
| - | == Protocol == | + | |
| - | + | ||
| - | ^ string ^ | + | |
| - | | Redfish | | + | |
| ===== EventService ===== | ===== EventService ===== | ||
| Line 1732: | Line 1348: | ||
| The Event Service resource contains properties for managing event subcriptions and generates the events sent to subscribers. | The Event Service resource contains properties for managing event subcriptions and generates the events sent to subscribers. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **DeliveryRetryAttempts** | number | read-only | This is the number of attempts an event posting is retried before the subscription is terminated. | | + | | **DeliveryRetryAttempts** | number |
| - | | **DeliveryRetryIntervalSeconds** | number | read-only | This represents the number of seconds between retry attempts for sending any given Event.\\ unit: s | | + | | **DeliveryRetryIntervalSeconds** | number |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **EventTypesForSubscription** [ {} ] | array | read-only | This is the types of Events that can be subscribed to. | | + | | **EventTypesForSubscription** [ {} ] | array | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **ServiceEnabled** | boolean, null | read-write | This indicates whether this service is enabled. | | + | | **ServiceEnabled** | boolean |
| - | | **Status** { | object | read-only | | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| - | | **[[documentation: | + | | **Subscriptions** | reference([[documentation: |
| === Property Details === | === Property Details === | ||
| Line 1789: | Line 1405: | ||
| 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **[[documentation: | + | | **Endpoints** | reference([[documentation: |
| - | | **FabricType** | null | read-write | The protocol being sent over this fabric. | | + | | **FabricType** | | Yes | read-write | The protocol being sent over this fabric. | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **MaxZones** | number, null | read-only | The value of this property shall contain the maximum number of zones the switch can currently configure. | | + | | **MaxZones** | number |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Status** { | object | read-only | | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| - | | **[[documentation: | + | | **Switches** | reference([[documentation: |
| - | | **[[documentation: | + | | **Zones** | reference([[documentation: |
| === Property Details === | === Property Details === | ||
| Line 1848: | Line 1464: | ||
| A Collection of Fabric resource instances. | A Collection of Fabric resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | + | |
| - | | **Name** | string | + | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | |
| ===== FileShare ===== | ===== FileShare ===== | ||
| Line 1872: | Line 1474: | ||
| 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **CASupported** | boolean, null | read-write | Continuous Availability is supported. Client/ | + | | **CASupported** | boolean |
| - | | **DefaultAccessPrivileges** [ {} ] | array | read-only | An array of default access privileges for the file share. The types of default access can include Read, Write, and/or Execute. | | + | | **DefaultAccessPrivileges** [ {} ] | array | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **[[documentation: | + | | **EthernetInterfaces** | reference([[documentation: |
| - | | **ExecuteSupport** | boolean, null | read-only | Execute access is supported by the file share. | | + | | **ExecuteSupport** | boolean |
| - | | **FileSharePath** | string, null | read-only | A path to an exported file or directory on the file system where this file share is hosted. | | + | | **FileSharePath** | string |
| - | | **FileShareQuotaType** | string, null | read-write | Specifies the type of quota enforcement.\\ | + | | **FileShareQuotaType** | string |
| - | | **FileShareRemainingQuotaBytes** | number, null | read-write | The number of remaining bytes that may be used by this file share.\\ unit: By | | + | | **FileShareRemainingQuotaBytes** | number |
| - | | **FileShareTotalQuotaBytes** | number, null | read-write | The maximum number of bytes that may be used by this file share.\\ unit: By | | + | | **FileShareTotalQuotaBytes** | number |
| - | | **FileSharingProtocols** [ {} ] | array | read-only | An array of file sharing protocols supported by this file share. | | + | | **FileSharingProtocols** [ {} ] | array | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Links** { | object | read-only | Contains links to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **ClassOfService** |
| - | | < | + | | \ \ \ \ \ \ **FileSystem** |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **LowSpaceWarningThresholdPercents** [ {} ] | array | read-write | An array of low space warning threshold percentages for the file share. | | + | | **LowSpaceWarningThresholdPercents** [ {} ] | array | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **RootAccess** | boolean, null | read-only | Root access is allowed by the file share. | | + | | **RootAccess** | boolean |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| - | | **WritePolicy** | string, null | read-write | Defines how writes are replicated to the shared source.\\ | + | | **WritePolicy** | string |
| === Property Details === | === Property Details === | ||
| Line 1951: | Line 1553: | ||
| An instance of a hierarchical namespace of files. | An instance of a hierarchical namespace of files. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AccessCapabilities** [ {} ] | array | read-write | An array of supported IO access capabilities. | | + | | **AccessCapabilities** [ {} ] | array | |
| - | | **BlockSizeBytes** | number, null | read-only | Block size of the file system in bytes.\\ unit: By | | + | | **BlockSizeBytes** | number |
| - | | **Capacity** { | object, null | read-write | Capacity allocated to the file system. | | + | | **Capacity** { | object |
| - | | < | + | | \ \ \ \ \ \ **Data** {} | object |
| - | | < | + | | \ \ \ \ \ \ **IsThinProvisioned** | boolean |
| - | | < | + | | \ \ \ \ \ \ **Metadata** {} | object |
| - | | < | + | | \ \ \ \ \ \ **Snapshot** {} | object |
| - | | } | | + | | } | | | |
| - | | **CapacitySources** [ { | array | read-write | An array of capacity sources for the file system. | | + | | **CapacitySources** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **ProvidedCapacity** {} | object |
| - | | < | + | | \ \ \ \ \ \ **ProvidedClassOfService** |
| - | | < | + | | \ \ \ \ \ \ **ProvidingDrives** |
| - | | < | + | | \ \ \ \ \ \ **ProvidingPools** |
| - | | < | + | | \ \ \ \ \ \ **ProvidingVolumes** |
| - | | } ] | | + | | } ] | | | |
| - | | **CasePreserved** | boolean, null | read-write | The case of file names is preserved by the file system. | | + | | **CasePreserved** | boolean |
| - | | **CaseSensitive** | boolean, null | read-write | Case sensitive file names are supported by the file system. | | + | | **CaseSensitive** | boolean |
| - | | **CharacterCodeSet** [ {} ] | array | read-write | An array of the character sets or encodings supported by the file system. | | + | | **CharacterCodeSet** [ {} ] | array | |
| - | | **ClusterSizeBytes** | number, null | read-write | A value indicating the minimum file allocation size imposed by the file system.\\ unit: By\\ minimum: 1 | | + | | **ClusterSizeBytes** | number |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **ExportedShares** | + | | **ExportedShares** | array(reference([[documentation: |
| - | | < | + | | **Id** | string |
| - | | < | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **ClassOfService** {} | object | Yes | read-write | The ClassOfService of this file system. | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **ReplicaCollection** [ {} ] | array | |
| - | | < | + | | } | | | |
| - | | < | + | | **LowSpaceWarningThresholdPercents** [ {} ] | array | |
| - | | < | + | | **MaxFileNameLengthBytes** | number |
| - | | < | + | | **Name** | string |
| - | | < | + | | **Oem** {} | object |
| - | | < | + | | **RemainingCapacity** { | object |
| - | | < | + | | \ \ \ \ \ \ **Data** {} | object |
| - | | < | + | | \ \ \ \ \ \ **IsThinProvisioned** | boolean |
| - | | < | + | | \ \ \ \ \ \ **Metadata** {} | object |
| - | | < | + | | \ \ \ \ \ \ **Snapshot** {} | object |
| - | | < | + | | } | | | |
| - | | < | + | | **ReplicaInfo** { | object |
| - | | < | + | | \ \ \ \ \ \ **ConsistencyEnabled** | boolean |
| - | | } ] | | + | | \ \ \ \ \ \ **ConsistencyState** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | \ \ \ \ \ \ **ConsistencyStatus** | string |
| - | | **Links** { | object | read-only | Contains links to other resources that are related to this resource. | | + | | \ \ \ \ \ \ **ConsistencyType** | string |
| - | | < | + | | \ \ \ \ \ \ **FailedCopyStopsHostIO** | boolean |
| - | | < | + | | \ \ \ \ \ \ **PercentSynced** | number |
| - | | < | + | | \ \ \ \ \ \ **Replica** | | Yes | read-write | The resource that is the source of this replica. | |
| - | | < | + | | \ \ \ \ \ \ **ReplicaPriority** | string |
| - | | } | | + | | \ \ \ \ \ \ **ReplicaProgressStatus** | string |
| - | | **LowSpaceWarningThresholdPercents** [ {} ] | array | read-write | An array of low space warning threshold percentages for the file system. | | + | | \ \ \ \ \ \ **ReplicaReadOnlyAccess** | string |
| - | | **MaxFileNameLengthBytes** | number, null | read-write | A value indicating the maximum length of a file name within the file system.\\ unit: By\\ minimum: 1 | | + | | \ \ \ \ \ \ **ReplicaRecoveryMode** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | \ \ \ \ \ \ **ReplicaRole** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | \ \ \ \ \ \ **ReplicaSkewBytes** | number |
| - | | **RemainingCapacity** { | object, null | read-write | Remaining capacity allocated to the file system. | | + | | \ \ \ \ \ \ **ReplicaState** | string |
| - | | < | + | | \ \ \ \ \ \ **ReplicaType** | string |
| - | | < | + | | \ \ \ \ \ \ **ReplicaUpdateMode** | string |
| - | | < | + | | \ \ \ \ \ \ **RequestedReplicaState** | string |
| - | | < | + | | \ \ \ \ \ \ **SyncMaintained** | boolean |
| - | | } | | + | | \ \ \ \ \ \ **UndiscoveredElement** | string |
| - | | **ReplicaInfo** { | object, null | read-write | This value describes the replica attributes if this file system is a replica. | | + | | \ \ \ \ \ \ **WhenActivated** | string |
| - | | < | + | | \ \ \ \ \ \ **WhenDeactivated** | string |
| - | | < | + | | \ \ \ \ \ \ **WhenEstablished** | string |
| - | | < | + | | \ \ \ \ \ \ **WhenSuspended** | string |
| - | | < | + | | \ \ \ \ \ \ **WhenSynced** | string |
| - | | < | + | | \ \ \ \ \ \ **WhenSynchronized** | string |
| - | | < | + | | } | | | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } | | + | |
| === Property Details === | === Property Details === | ||
| Line 2193: | Line 1775: | ||
| Contains a collection of references to FileSystem resource instances. | Contains a collection of references to FileSystem resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation:redfish_api: |
| - | | < | + | | **Name** | string |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| ===== HostInterface ===== | ===== HostInterface ===== | ||
| Line 2223: | Line 1785: | ||
| This schema defines a Host Interface resource. | This schema defines a Host Interface resource. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AuthenticationModes** [ {} ] | array | read-write | This indicates the authentication modes available on this interface. | | + | | **AuthenticationModes** [ {} ] | array | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **ExternallyAccessible** | boolean, null | read-only | This indicates whether this interface is accessible by external entities. | | + | | **ExternallyAccessible** | boolean |
| - | | **FirmwareAuthEnabled** | boolean, null | read-write | This indicates whether this firmware authentication is enabled for this interface. | | + | | **FirmwareAuthEnabled** | boolean |
| - | | **FirmwareAuthRoleId** | string | read-write | This property contains the Role for firmware authentication on this interface. | | + | | **FirmwareAuthRoleId** | string |
| - | | **[[documentation: | + | | **HostEthernetInterfaces** | reference([[documentation: |
| - | | **HostInterfaceType** | string, null | read-write | This indicates the Host Interface type for this interface.\\ | + | | **HostInterfaceType** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **InterfaceEnabled** | boolean, null | read-write | This indicates whether this interface is enabled. | | + | | **InterfaceEnabled** | boolean |
| - | | **KernelAuthEnabled** | boolean, null | read-write | This indicates whether this kernel authentication is enabled for this interface. | | + | | **KernelAuthEnabled** | boolean |
| - | | **KernelAuthRoleId** | string | read-write | This property contains the Role for kernel authentication on this interface. | | + | | **KernelAuthRoleId** | string |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **ComputerSystems** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **FirmwareAuthRole** {} | object |
| - | | < | + | | \ \ \ \ \ \ **KernelAuthRole** |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | } | | | |
| - | | } | | + | | **ManagerEthernetInterface** | reference([[documentation: |
| - | | **[[documentation: | + | | **Name** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **NetworkProtocol** | reference([[documentation: |
| - | | **[[documentation: | + | | **Oem** {} | object |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Status** { | object |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | < | + | | } | | | |
| - | | } | | + | |
| === Property Details === | === Property Details === | ||
| Line 2273: | Line 1834: | ||
| ^ string ^ Description ^ | ^ string ^ Description ^ | ||
| | NetworkHostInterface | This interface is a Network Host Interface. | | | NetworkHostInterface | This interface is a Network Host Interface. | | ||
| + | |||
| + | == LinkStatus == | ||
| + | |||
| + | ^ string ^ Description ^ | ||
| + | | LinkDown | There is no link on this interface, but the interface is connected. | | ||
| + | | LinkUp | The link is available for communication on this interface. | | ||
| + | | NoLink | There is no link or connection detected on this interface. | | ||
| == State == | == State == | ||
| Line 2294: | Line 1862: | ||
| A Collection of HostInterface resource instances. | A Collection of HostInterface resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | + | |
| - | | **Name** | string | + | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | === Property Details === | + | |
| - | + | ||
| - | == HostInterfaceType == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | NetworkHostInterface | This interface is a Network Host Interface. | | + | |
| ===== HostedStorageServices ===== | ===== HostedStorageServices ===== | ||
| Line 2331: | Line 1872: | ||
| A Collection of Hosted Storage Service resource instances. | A Collection of Hosted Storage Service resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | | | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| ===== IOConnectivityLoSCapabilities ===== | ===== IOConnectivityLoSCapabilities ===== | ||
| Line 2362: | Line 1882: | ||
| Describe IO Connectivity capabilities. | Describe IO Connectivity capabilities. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Identifier** { | object, null | read-only | The value identifies this resource. | | + | | **Identifier** { | object |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | } | | + | | } | | | |
| - | | **MaxSupportedIOPS** | number, null | read-write | The maximum IOPS that a connection can support. | | + | | **MaxSupportedIOPS** | number |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **SupportedAccessProtocols** [ {} ] | array | read-write | SupportedAccessProtocols. | | + | | **SupportedAccessProtocols** [ {} ] | array | |
| - | | **SupportedIOConnectivityLinesOfService** [ { | array | read-write | Collection of known and supported IOConnectivityLinesOfService. | | + | | **SupportedIOConnectivityLinesOfService** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **AccessProtocol** | string |
| - | | < | + | | \ \ \ \ \ \ **MaxIOPS** | number |
| - | | < | + | | \ \ \ \ \ \ **Name** | string |
| - | | } ] | | + | | } ] | | | |
| === Property Details === | === Property Details === | ||
| Line 2414: | Line 1934: | ||
| Describe io performance capabilities. | Describe io performance capabilities. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **IOLimitingIsSupported** | boolean, null | read-write | Limiting IOPS is supported. | | + | | **IOLimitingIsSupported** | boolean |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Identifier** { | object, null | read-only | The value identifies this resource. | | + | | **Identifier** { | object |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | } | | + | | } | | | |
| - | | **MaxSamplePeriod** | string, null | read-write | Maximum sampling period over which average values are calculated.\\ unit: s | | + | | **MaxSamplePeriod** | string |
| - | | **MinSamplePeriod** | string, null | read-write | Minimum sampling period over which average values are calculated.\\ unit: s | | + | | **MinSamplePeriod** | string |
| - | | **MinSupportedIoOperationLatencyMicroseconds** | number, null | read-write | Minimum supported average IO latency.\\ unit: us | | + | | **MinSupportedIoOperationLatencyMicroseconds** | number |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **SupportedIOPerformanceLinesOfService** [ { | array | read-write | Collection of known and supported IOPerformanceLinesOfService. | | + | | **SupportedIOPerformanceLinesOfService** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **AverageIOOperationLatencyMicroseconds** | number |
| - | | < | + | | \ \ \ \ \ \ **IOOperationsPerSecondIsLimited** | boolean |
| - | | < | + | | \ \ \ \ \ \ **IOWorkload** {} | object |
| - | | < | + | | \ \ \ \ \ \ **MaxIOOperationsPerSecondPerTerabyte** | number |
| - | | < | + | | \ \ \ \ \ \ **Name** | string |
| - | | < | + | | \ \ \ \ \ \ **SamplePeriod** | string |
| - | | } ] | | + | | } ] | | | |
| - | | **SupportedIOWorkloads** [ { | array | read-write | A collection of supported workloads. | | + | | **SupportedIOWorkloads** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **Components** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Name** | string |
| - | | } ] | | + | | } ] | | | |
| === Property Details === | === Property Details === | ||
| Line 2456: | Line 1976: | ||
| This is the schema definition for the Schema File locator resource. | This is the schema definition for the Schema File locator resource. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Languages** [ {} ] | array | read-only | Language codes for the schemas available. | | + | | **Languages** [ {} ] | array | |
| - | | **Location** [ { | array | read-write | Location information for this schema file. | | + | | **Location** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **ArchiveFile** | string |
| - | | < | + | | \ \ \ \ \ \ **ArchiveUri** | string |
| - | | < | + | | \ \ \ \ \ \ **Language** | string |
| - | | < | + | | \ \ \ \ \ \ **PublicationUri** | string |
| - | | < | + | | \ \ \ \ \ \ **Uri** | string |
| - | | } ] | | + | | } ] | | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Schema** | string | read-only | The @odata.type name this schema describes. | | + | | **Schema** | string |
| ===== JsonSchemaFileCollection ===== | ===== JsonSchemaFileCollection ===== | ||
| Line 2475: | Line 1995: | ||
| A Collection of JsonSchemaFile resource instances. | A Collection of JsonSchemaFile resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| ===== LogEntry ===== | ===== LogEntry ===== | ||
| Line 2494: | Line 2005: | ||
| 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. | 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Created** | string | read-only | The time the log entry was created. | | + | | **Created** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **EntryCode** | string, null | read-write | If the EntryType is SEL, this will have the entry code for the log entry.\\ | + | | **EntryCode** | string |
| - | | **EntryType** | string | read-write | his is the type of log entry.\\ | + | | **EntryType** | string |
| - | | **EventId** | string | read-only | This is a unique instance identifier of an event. | | + | | **EventId** | string |
| - | | **EventTimestamp** | string | read-only | This is time the event occurred. | | + | | **EventTimestamp** | string |
| - | | **EventType** | | read-only | This indicates the type of an event recorded in this log. | | + | | **EventType** |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **OriginOfCondition** |
| - | | } | | + | | } | | | |
| - | | **Message** | string, null | read-only | This property decodes from EntryType: | + | | **Message** | string |
| - | | **MessageArgs** [ {} ] | array | read-only | The values of this property shall be any arguments for the message. | | + | | **MessageArgs** [ {} ] | array | |
| - | | **MessageId** | string | read-only | This property decodes from EntryType: | + | | **MessageId** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **OemRecordFormat** | string, null | read-only | If the entry type is Oem, this will contain more information about the record format from the Oem. | | + | | **OemRecordFormat** | string |
| - | | **SensorNumber** | number, null | read-only | This property decodes from EntryType: | + | | **SensorNumber** | number |
| - | | **SensorType** | string, null | read-write | If the EntryType is SEL, this will have the sensor type that the log entry pertains to.\\ *See Property Details, below, for more information about this property.* | | + | | **SensorType** | string |
| - | | **Severity** | string, null | read-write | This is the severity of the log entry.\\ | + | | **Severity** | string |
| === Property Details === | === Property Details === | ||
| Line 2522: | Line 2033: | ||
| ^ string ^ | ^ string ^ | ||
| - | | Assert | | + | | Assert | |
| - | | Deassert | | + | | Deassert | |
| - | | Lower Non-critical - going low | | + | | Lower Non-critical - going low | |
| - | | Lower Non-critical - going high | | + | | Lower Non-critical - going high | |
| - | | Lower Critical - going low | | + | | Lower Critical - going low | |
| - | | Lower Critical - going high | | + | | Lower Critical - going high | |
| - | | Lower Non-recoverable - going low | | + | | Lower Non-recoverable - going low | |
| - | | Lower Non-recoverable - going high | | + | | Lower Non-recoverable - going high | |
| - | | Upper Non-critical - going low | | + | | Upper Non-critical - going low | |
| - | | Upper Non-critical - going high | | + | | Upper Non-critical - going high | |
| - | | Upper Critical - going low | | + | | Upper Critical - going low | |
| - | | Upper Critical - going high | | + | | Upper Critical - going high | |
| - | | Upper Non-recoverable - going low | | + | | Upper Non-recoverable - going low | |
| - | | Upper Non-recoverable - going high | | + | | Upper Non-recoverable - going high | |
| - | | Transition to Idle | | + | | Transition to Idle | |
| - | | Transition to Active | | + | | Transition to Active | |
| - | | Transition to Busy | | + | | Transition to Busy | |
| - | | State Deasserted | | + | | State Deasserted | |
| - | | State Asserted | | + | | State Asserted | |
| - | | Predictive Failure deasserted | | + | | Predictive Failure deasserted | |
| - | | Predictive Failure asserted | | + | | Predictive Failure asserted | |
| - | | Limit Not Exceeded | | + | | Limit Not Exceeded | |
| - | | Limit Exceeded | | + | | Limit Exceeded | |
| - | | Performance Met | | + | | Performance Met | |
| - | | Performance Lags | | + | | Performance Lags | |
| - | | Transition to OK | | + | | Transition to OK | |
| - | | Transition to Non-Critical from OK | | + | | Transition to Non-Critical from OK | |
| - | | Transition to Critical from less severe | | + | | Transition to Critical from less severe | |
| - | | Transition to Non-recoverable from less severe | | + | | Transition to Non-recoverable from less severe | |
| - | | Transition to Non-Critical from more severe | | + | | Transition to Non-Critical from more severe | |
| - | | Transition to Critical from Non-recoverable | | + | | Transition to Critical from Non-recoverable | |
| - | | Transition to Non-recoverable | | + | | Transition to Non-recoverable | |
| - | | Monitor | | + | | Monitor | |
| - | | Informational | | + | | Informational | |
| - | | Device Removed / Device Absent | | + | | Device Removed / Device Absent | |
| - | | Device Inserted / Device Present | | + | | Device Inserted / Device Present | |
| - | | Device Disabled | | + | | Device Disabled | |
| - | | Device Enabled | | + | | Device Enabled | |
| - | | Transition to Running | | + | | Transition to Running | |
| - | | Transition to In Test | | + | | Transition to In Test | |
| - | | Transition to Power Off | | + | | Transition to Power Off | |
| - | | Transition to On Line | | + | | Transition to On Line | |
| - | | Transition to Off Line | | + | | Transition to Off Line | |
| - | | Transition to Off Duty | | + | | Transition to Off Duty | |
| - | | Transition to Degraded | | + | | Transition to Degraded | |
| - | | Transition to Power Save | | + | | Transition to Power Save | |
| - | | Install Error | | + | | Install Error | |
| - | | Fully Redundant | | + | | Fully Redundant | |
| - | | Redundancy Lost | | + | | Redundancy Lost | |
| - | | Redundancy Degraded | | + | | Redundancy Degraded | |
| - | | Non-redundant: | + | | Non-redundant: |
| - | | Non-redundant: | + | | Non-redundant: |
| - | | Non-redundant: | + | | Non-redundant: |
| - | | Redundancy Degraded from Fully Redundant | | + | | Redundancy Degraded from Fully Redundant | |
| - | | Redundancy Degraded from Non-redundant | | + | | Redundancy Degraded from Non-redundant | |
| - | | D0 Power State | | + | | D0 Power State | |
| - | | D1 Power State | | + | | D1 Power State | |
| - | | D2 Power State | | + | | D2 Power State | |
| - | | D3 Power State | | + | | D3 Power State | |
| == EntryType == | == EntryType == | ||
| ^ string ^ | ^ string ^ | ||
| - | | Event | | + | | Event | |
| - | | SEL | | + | | SEL | |
| - | | Oem | | + | | Oem | |
| == SensorType == | == SensorType == | ||
| ^ string ^ | ^ string ^ | ||
| - | | Platform Security Violation Attempt | | + | | Platform Security Violation Attempt | |
| - | | Temperature | | + | | Temperature | |
| - | | Voltage | | + | | Voltage | |
| - | | Current | | + | | Current | |
| - | | Fan | | + | | Fan | |
| - | | Physical Chassis Security | | + | | Physical Chassis Security | |
| - | | Processor | | + | | Processor | |
| - | | Power Supply / Converter | | + | | Power Supply / Converter | |
| - | | PowerUnit | | + | | PowerUnit | |
| - | | CoolingDevice | | + | | CoolingDevice | |
| - | | Other Units-based Sensor | | + | | Other Units-based Sensor | |
| - | | Memory | | + | | Memory | |
| - | | Drive Slot/Bay | | + | | Drive Slot/Bay | |
| - | | POST Memory Resize | | + | | POST Memory Resize | |
| - | | System Firmware Progress | | + | | System Firmware Progress | |
| - | | Event Logging Disabled | | + | | Event Logging Disabled | |
| - | | System Event | | + | | System Event | |
| - | | Critical Interrupt | | + | | Critical Interrupt | |
| - | | Button/ | + | | Button/ |
| - | | Module/ | + | | Module/ |
| - | | Microcontroller/ | + | | Microcontroller/ |
| - | | Add-in Card | | + | | Add-in Card | |
| - | | Chassis | | + | | Chassis | |
| - | | ChipSet | | + | | ChipSet | |
| - | | Other FRU | | + | | Other FRU | |
| - | | Cable/ | + | | Cable/ |
| - | | Terminator | | + | | Terminator | |
| - | | SystemBoot/ | + | | SystemBoot/ |
| - | | Boot Error | | + | | Boot Error | |
| - | | BaseOSBoot/ | + | | BaseOSBoot/ |
| - | | OS Stop/ | + | | OS Stop/ |
| - | | Slot/ | + | | Slot/ |
| - | | System ACPI PowerState | | + | | System ACPI PowerState | |
| - | | Watchdog | | + | | Watchdog | |
| - | | Platform Alert | | + | | Platform Alert | |
| - | | Entity Presence | | + | | Entity Presence | |
| - | | Monitor ASIC/IC | | + | | Monitor ASIC/IC | |
| - | | LAN | | + | | LAN | |
| - | | Management Subsystem Health | | + | | Management Subsystem Health | |
| - | | Battery | | + | | Battery | |
| - | | Session Audit | | + | | Session Audit | |
| - | | Version Change | | + | | Version Change | |
| - | | FRUState | | + | | FRUState | |
| == Severity == | == Severity == | ||
| ^ string ^ | ^ string ^ | ||
| - | | OK | | + | | OK | |
| - | | Warning | | + | | Warning | |
| - | | Critical | | + | | Critical | |
| Line 2648: | Line 2159: | ||
| A Collection of LogEntry resource instances. | A Collection of LogEntry resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | | | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| - | + | ||
| - | === Property Details === | + | |
| - | + | ||
| - | == EntryCode == | + | |
| - | + | ||
| - | ^ string ^ | + | |
| - | | Assert | | + | |
| - | | Deassert | | + | |
| - | | Lower Non-critical - going low | | + | |
| - | | Lower Non-critical - going high | | + | |
| - | | Lower Critical - going low | | + | |
| - | | Lower Critical - going high | | + | |
| - | | Lower Non-recoverable - going low | | + | |
| - | | Lower Non-recoverable - going high | | + | |
| - | | Upper Non-critical - going low | | + | |
| - | | Upper Non-critical - going high | | + | |
| - | | Upper Critical - going low | | + | |
| - | | Upper Critical - going high | | + | |
| - | | Upper Non-recoverable - going low | | + | |
| - | | Upper Non-recoverable - going high | | + | |
| - | | Transition to Idle | | + | |
| - | | Transition to Active | | + | |
| - | | Transition to Busy | | + | |
| - | | State Deasserted | | + | |
| - | | State Asserted | | + | |
| - | | Predictive Failure deasserted | | + | |
| - | | Predictive Failure asserted | | + | |
| - | | Limit Not Exceeded | | + | |
| - | | Limit Exceeded | | + | |
| - | | Performance Met | | + | |
| - | | Performance Lags | | + | |
| - | | Transition to OK | | + | |
| - | | Transition to Non-Critical from OK | | + | |
| - | | Transition to Critical from less severe | | + | |
| - | | Transition to Non-recoverable from less severe | | + | |
| - | | Transition to Non-Critical from more severe | | + | |
| - | | Transition to Critical from Non-recoverable | | + | |
| - | | Transition to Non-recoverable | | + | |
| - | | Monitor | | + | |
| - | | Informational | | + | |
| - | | Device Removed / Device Absent | | + | |
| - | | Device Inserted / Device Present | | + | |
| - | | Device Disabled | | + | |
| - | | Device Enabled | | + | |
| - | | Transition to Running | | + | |
| - | | Transition to In Test | | + | |
| - | | Transition to Power Off | | + | |
| - | | Transition to On Line | | + | |
| - | | Transition to Off Line | | + | |
| - | | Transition to Off Duty | | + | |
| - | | Transition to Degraded | | + | |
| - | | Transition to Power Save | | + | |
| - | | Install Error | | + | |
| - | | Fully Redundant | | + | |
| - | | Redundancy Lost | | + | |
| - | | Redundancy Degraded | | + | |
| - | | Non-redundant: | + | |
| - | | Non-redundant: | + | |
| - | | Non-redundant: | + | |
| - | | Redundancy Degraded from Fully Redundant | | + | |
| - | | Redundancy Degraded from Non-redundant | | + | |
| - | | D0 Power State | | + | |
| - | | D1 Power State | | + | |
| - | | D2 Power State | | + | |
| - | | D3 Power State | | + | |
| - | + | ||
| - | == EntryType == | + | |
| - | + | ||
| - | ^ string ^ | + | |
| - | | Event | | + | |
| - | | SEL | | + | |
| - | | Oem | | + | |
| - | + | ||
| - | == SensorType == | + | |
| - | + | ||
| - | ^ string ^ | + | |
| - | | Platform Security Violation Attempt | | + | |
| - | | Temperature | | + | |
| - | | Voltage | | + | |
| - | | Current | | + | |
| - | | Fan | | + | |
| - | | Physical Chassis Security | | + | |
| - | | Processor | | + | |
| - | | Power Supply / Converter | | + | |
| - | | PowerUnit | | + | |
| - | | CoolingDevice | | + | |
| - | | Other Units-based Sensor | | + | |
| - | | Memory | | + | |
| - | | Drive Slot/Bay | | + | |
| - | | POST Memory Resize | | + | |
| - | | System Firmware Progress | | + | |
| - | | Event Logging Disabled | | + | |
| - | | System Event | | + | |
| - | | Critical Interrupt | | + | |
| - | | Button/ | + | |
| - | | Module/ | + | |
| - | | Microcontroller/ | + | |
| - | | Add-in Card | | + | |
| - | | Chassis | | + | |
| - | | ChipSet | | + | |
| - | | Other FRU | | + | |
| - | | Cable/ | + | |
| - | | Terminator | | + | |
| - | | SystemBoot/ | + | |
| - | | Boot Error | | + | |
| - | | BaseOSBoot/ | + | |
| - | | OS Stop/ | + | |
| - | | Slot/ | + | |
| - | | System ACPI PowerState | | + | |
| - | | Watchdog | | + | |
| - | | Platform Alert | | + | |
| - | | Entity Presence | | + | |
| - | | Monitor ASIC/IC | | + | |
| - | | LAN | | + | |
| - | | Management Subsystem Health | | + | |
| - | | Battery | | + | |
| - | | Session Audit | | + | |
| - | | Version Change | | + | |
| - | | FRUState | | + | |
| - | + | ||
| - | == Severity == | + | |
| - | + | ||
| - | ^ string ^ | + | |
| - | | OK | | + | |
| - | | Warning | | + | |
| - | | Critical | | + | |
| ===== LogService ===== | ===== LogService ===== | ||
| Line 2805: | Line 2169: | ||
| 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **DateTime** | string, null | read-write | The current DateTime (with offset) for the log service, used to set or read time. | | + | | **DateTime** | string |
| - | | **DateTimeLocalOffset** | string, null | read-write | The time offset from UTC that the DateTime property is set to in format: +06:00 .\\ pattern: ([-+][0-1][0-9]: | + | | **DateTimeLocalOffset** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **[[documentation: | + | | **Entries** | reference([[documentation: |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **MaxNumberOfRecords** | number | read-only | The maximum number of log entries this service can have. | | + | | **MaxNumberOfRecords** | number |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **OverWritePolicy** | string | read-write | The overwrite policy for this service that takes place when the log is full.\\ | + | | **OverWritePolicy** | string |
| - | | **ServiceEnabled** | boolean, null | read-write | This indicates whether this service is enabled. | | + | | **ServiceEnabled** | boolean |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| === Property Details === | === Property Details === | ||
| Line 2870: | Line 2234: | ||
| A Collection of LogService resource instances. | A Collection of LogService resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| - | + | ||
| - | === Property Details === | + | |
| - | + | ||
| - | == OverWritePolicy == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | NeverOverWrites | When full, new entries to the Log will be discarded. | | + | |
| - | | Unknown | The overwrite policy is not known or is undefined. | | + | |
| - | | WrapsWhenFull | When full, new entries to the Log will overwrite previous entries. | | + | |
| ===== Manager ===== | ===== Manager ===== | ||
| Line 2904: | Line 2244: | ||
| This is the schema definition for a Manager. | This is the schema definition for a Manager. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **CommandShell** { | object | read-write | Information about the Command Shell service provided by this manager. | | + | | **CommandShell** { | object |
| - | | < | + | | \ \ \ \ \ \ **ConnectTypesSupported** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **MaxConcurrentSessions** | number |
| - | | < | + | | \ \ \ \ \ \ **ServiceEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **DateTime** | string, null | read-write | The current DateTime (with offset) for the manager, used to set or read time. | | + | | **DateTime** | string |
| - | | **DateTimeLocalOffset** | string, null | read-write | The time offset from UTC that the DateTime property is set to in format: +06:00 .\\ pattern: ([-+][0-1][0-9]: | + | | **DateTimeLocalOffset** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **[[documentation: | + | | **EthernetInterfaces** | reference([[documentation: |
| - | | **FirmwareVersion** | string, null | read-only | The firmware version of this Manager. | | + | | **FirmwareVersion** | string |
| - | | **GraphicalConsole** { | object | read-write | The value of this property shall contain the information about the Graphical Console (KVM-IP) service of this manager. | | + | | **GraphicalConsole** { | object |
| - | | < | + | | \ \ \ \ \ \ **ConnectTypesSupported** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **MaxConcurrentSessions** | number |
| - | | < | + | | \ \ \ \ \ \ **ServiceEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **[[documentation: | + | | **HostInterfaces** | reference([[documentation: |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **ManagerForChassis** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **ManagerForServers** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **ManagerInChassis** {} | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | } | | | |
| - | | < | + | | **LogServices** | reference([[documentation: |
| - | | } | | + | | **ManagerType** | string |
| - | | **[[documentation: | + | | **Model** | string |
| - | | **ManagerType** | string | read-write | This property represents the type of manager that this resource represents.\\ | + | | **Name** | string |
| - | | **Model** | string, null | read-only | The model information of this Manager as defined by the manufacturer. | | + | | **NetworkProtocol** | reference([[documentation: |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Oem** {} | object |
| - | | **[[documentation: | + | | **PowerState** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Redundancy** [ { | array | |
| - | | **PowerState** | string, null | read-write | This is the current power state of the Manager.\\ | + | | \ \ \ \ \ \ **MaxNumSupported** | number |
| - | | **Redundancy** [ { | array | read-write | Redundancy information for the managers of this system. | | + | | \ \ \ \ \ \ **MemberId** | string |
| - | | < | + | | \ \ \ \ \ \ **MinNumNeeded** | number |
| - | | < | + | | \ \ \ \ \ \ **Mode** | string |
| - | | < | + | | \ \ \ \ \ \ **Name** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **RedundancySet** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Status** {} | object |
| - | | < | + | | \ \ \ \ \ \ **MemberId** | string |
| - | | < | + | | \ \ \ \ \ \ **RedundancyEnabled** | boolean |
| - | | < | + | | } ] | | | |
| - | | < | + | | **SerialConsole** { | object |
| - | | < | + | | \ \ \ \ \ \ **ConnectTypesSupported** [ {} ] | array | |
| - | | } ] | | | | + | | \ \ \ \ \ \ **MaxConcurrentSessions** | number |
| - | | **[email protected]** | string | read-write | + | | \ \ \ \ \ \ **ServiceEnabled** | boolean |
| - | | **SerialConsole** { | object | read-write | Information about the Serial Console service provided by this manager. | | + | | } | | | |
| - | | < | + | | **SerialInterfaces** | reference([[documentation: |
| - | | < | + | | **ServiceEntryPointUUID** | string |
| - | | < | + | | **Status** { | object |
| - | | } | | + | | \ \ \ \ \ \ **Health** | string |
| - | | **[[documentation: | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | **ServiceEntryPointUUID** | string | read-write | The UUID of the Redfish Service provided by this manager.\\ pattern: ([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}) | | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | \ \ \ \ \ \ **State** | string |
| - | | < | + | | } | | | |
| - | | < | + | | **UUID** | string |
| - | | < | + | | **VirtualMedia** | reference([[documentation: |
| - | | < | + | |
| - | | } | | + | |
| - | | **UUID** | string, null | read-write | The Universal Unique Identifier (UUID) for this Manager.\\ pattern: ([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}) | | + | |
| - | | **[[documentation: | + | |
| === Property Details === | === Property Details === | ||
| Line 3034: | Line 2370: | ||
| The user accounts, owned by a Manager, are defined in this resource. | The user accounts, owned by a Manager, are defined in this resource. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Enabled** | boolean | read-write | This property is used by a User Administrator to disable an account w/o having to delet the user information. | + | | **Enabled** | boolean |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **Role** |
| - | | } | | + | | } | | | |
| - | | **Locked** | boolean | read-write | This property indicates that the account has been auto-locked by the account service because the lockout threshold has been exceeded. | + | | **Locked** | boolean |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Password** | string, null | read-write | This property is used with a PATCH or PUT to write the password for the account. | + | | **Password** | string |
| - | | **RoleId** | string | read-write | This property contains the Role for this account. | | + | | **RoleId** | string |
| - | | **UserName** | string | read-write | This property contains the user name for the account. | | + | | **UserName** | string |
| ===== ManagerAccountCollection ===== | ===== ManagerAccountCollection ===== | ||
| Line 3053: | Line 2389: | ||
| A Collection of ManagerAccount resource instances. | A Collection of ManagerAccount resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | | | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| ===== ManagerCollection ===== | ===== ManagerCollection ===== | ||
| Line 3075: | Line 2399: | ||
| A Collection of Manager resource instances. | A Collection of Manager resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | | | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| - | + | ||
| - | === Property Details === | + | |
| - | + | ||
| - | == ManagerType == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | AuxiliaryController | A controller which provides management functions for a particular subsystem or group of devices. | | + | |
| - | | BMC | A controller which provides management functions for a single computer system. | | + | |
| - | | EnclosureManager | A controller which provides management functions for a chassis or group of devices or systems. | | + | |
| - | | ManagementController | A controller used primarily to monitor or manage the operation of a device or system. | | + | |
| - | | RackManager | A controller which provides management functions for a whole or part of a rack. | | + | |
| - | + | ||
| - | == PowerState == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Off | The state is powered Off. | | + | |
| - | | On | The state is powered On. | | + | |
| - | | PoweringOff | A temporary state between On and Off. | | + | |
| - | | PoweringOn | A temporary state between Off and On. | | + | |
| ===== ManagerNetworkProtocol ===== | ===== ManagerNetworkProtocol ===== | ||
| Line 3133: | Line 2409: | ||
| 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **DHCP** { | object | read-write | Settings for this Manager' | + | | **DHCP** { | object |
| - | | < | + | | \ \ \ \ \ \ **Port** | number |
| - | | < | + | | \ \ \ \ \ \ **ProtocolEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **FQDN** | string, null | read-only | This is the fully qualified domain name for the manager obtained by DNS including the host name and top-level domain name. | | + | | **FQDN** | string |
| - | | **HTTP** { | object | read-write | Settings for this Manager' | + | | **HTTP** { | object |
| - | | < | + | | \ \ \ \ \ \ **Port** | number |
| - | | < | + | | \ \ \ \ \ \ **ProtocolEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **HTTPS** { | object | read-write | Settings for this Manager' | + | | **HTTPS** { | object |
| - | | < | + | | \ \ \ \ \ \ **Port** | number |
| - | | < | + | | \ \ \ \ \ \ **ProtocolEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **HostName** | string, null | read-only | The DNS Host Name of this manager, without any domain information. | | + | | **HostName** | string |
| - | | **IPMI** { | object | read-write | Settings for this Manager' | + | | **IPMI** { | object |
| - | | < | + | | \ \ \ \ \ \ **Port** | number |
| - | | < | + | | \ \ \ \ \ \ **ProtocolEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **KVMIP** { | object | read-write | Settings for this Manager' | + | | **KVMIP** { | object |
| - | | < | + | | \ \ \ \ \ \ **Port** | number |
| - | | < | + | | \ \ \ \ \ \ **ProtocolEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **SNMP** { | object | read-write | Settings for this Manager' | + | | **SNMP** { | object |
| - | | < | + | | \ \ \ \ \ \ **Port** | number |
| - | | < | + | | \ \ \ \ \ \ **ProtocolEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **SSDP** { | object | read-write | Settings for this Manager' | + | | **SSDP** { | object |
| - | | < | + | | \ \ \ \ \ \ **NotifyIPv6Scope** | string |
| - | | < | + | | \ \ \ \ \ \ **NotifyMulticastIntervalSeconds** | number |
| - | | < | + | | \ \ \ \ \ \ **NotifyTTL** | number |
| - | | < | + | | \ \ \ \ \ \ **Port** | number |
| - | | < | + | | \ \ \ \ \ \ **ProtocolEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **SSH** { | object | read-write | Settings for this Manager' | + | | **SSH** { | object |
| - | | < | + | | \ \ \ \ \ \ **Port** | number |
| - | | < | + | | \ \ \ \ \ \ **ProtocolEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| - | | **Telnet** { | object | read-write | Settings for this Manager' | + | | **Telnet** { | object |
| - | | < | + | | \ \ \ \ \ \ **Port** | number |
| - | | < | + | | \ \ \ \ \ \ **ProtocolEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **VirtualMedia** { | object | read-write | Settings for this Manager' | + | | **VirtualMedia** { | object |
| - | | < | + | | \ \ \ \ \ \ **Port** | number |
| - | | < | + | | \ \ \ \ \ \ **ProtocolEnabled** | boolean |
| - | | } | | + | | } | | | |
| === Property Details === | === Property Details === | ||
| Line 3233: | Line 2509: | ||
| 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **AllowedSpeedsMHz** [ {} ] | array | read-only | Speed bins supported by this Memory. | | + | | **AllowedSpeedsMHz** [ {} ] | array | |
| - | | **BaseModuleType** | string, null | read-write | The base module type of Memory.\\ | + | | **BaseModuleType** | string |
| - | | **BusWidthBits** | number, null | read-only | Bus Width in bits. | | + | | **BusWidthBits** | number |
| - | | **CapacityMiB** | number, null | read-only | Memory Capacity in MiB.\\ unit: MiBy | | + | | **CapacityMiB** | number |
| - | | **DataWidthBits** | number, null | read-only | Data Width in bits. | | + | | **DataWidthBits** | number |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **DeviceID** | string, null | read-only | Device ID. | | + | | **DeviceID** | string |
| - | | **DeviceLocator** | string, null | read-only | Location of the Memory in the platform. | | + | | **DeviceLocator** | string |
| - | | **ErrorCorrection** | string, null | read-write | Error correction scheme supported for this memory.\\ | + | | **ErrorCorrection** | string |
| - | | **FirmwareApiVersion** | string, null | read-only | Version of API supported by the firmware. | | + | | **FirmwareApiVersion** | string |
| - | | **FirmwareRevision** | string, null | read-only | Revision of firmware on the Memory controller. | | + | | **FirmwareRevision** | string |
| - | | **FunctionClasses** [ {} ] | array | read-only | Function Classes by the Memory. | | + | | **FunctionClasses** [ {} ] | array | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **IsRankSpareEnabled** | boolean, null | read-only | Rank spare enabled status. | | + | | **IsRankSpareEnabled** | boolean |
| - | | **IsSpareDeviceEnabled** | boolean, null | read-only | Spare device enabled status. | | + | | **IsSpareDeviceEnabled** | boolean |
| - | | **Manufacturer** | string, null | read-only | The Memory manufacturer. | | + | | **Manufacturer** | string |
| - | | **MaxTDPMilliWatts** [ {} ] | array | read-only | Maximum TDPs in milli Watts. | | + | | **MaxTDPMilliWatts** [ {} ] | array | |
| - | | **MemoryDeviceType** | string, null | read-write | Type details of the Memory.\\ | + | | **MemoryDeviceType** | string |
| - | | **MemoryLocation** { | object | read-write | Memory connection information to sockets and memory controllers. | | + | | **MemoryLocation** { | object |
| - | | < | + | | \ \ \ \ \ \ **Channel** | number |
| - | | < | + | | \ \ \ \ \ \ **MemoryController** | number |
| - | | < | + | | \ \ \ \ \ \ **Slot** | number |
| - | | < | + | | \ \ \ \ \ \ **Socket** | number |
| - | | } | | + | | } | | | |
| - | | **MemoryMedia** [ {} ] | array | read-only | Media of this Memory. | | + | | **MemoryMedia** [ {} ] | array | |
| - | | **MemoryType** | string, null | read-write | The type of Memory.\\ | + | | **MemoryType** | string |
| - | | **[[documentation: | + | | **Metrics** | reference([[documentation: |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **OperatingMemoryModes** [ {} ] | array | read-only | Memory modes supported by the Memory. | | + | | **OperatingMemoryModes** [ {} ] | array | |
| - | | **OperatingSpeedMhz** | number, null | read-only | Operating speed of Memory in MHz. | | + | | **OperatingSpeedMhz** | number |
| - | | **PartNumber** | string, null | read-only | The product part number of this device. | | + | | **PartNumber** | string |
| - | | **PersistentRegionSizeLimitMiB** | number, null | read-only | Total size of persistent regions in MiB. | | + | | **PersistentRegionSizeLimitMiB** | number |
| - | | **PowerManagementPolicy** { | object | read-write | Power management policy information. | | + | | **PowerManagementPolicy** { | object |
| - | | < | + | | \ \ \ \ \ \ **AveragePowerBudgetMilliWatts** | number |
| - | | < | + | | \ \ \ \ \ \ **MaxTDPMilliWatts** | number |
| - | | < | + | | \ \ \ \ \ \ **PeakPowerBudgetMilliWatts** | number |
| - | | < | + | | \ \ \ \ \ \ **PolicyEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **RankCount** | number, null | read-only | Number of ranks available in the Memory. | | + | | **RankCount** | number |
| - | | **Regions** [ { | array | read-write | Memory regions information within the Memory. | | + | | **Regions** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **MemoryClassification** | string |
| - | | < | + | | \ \ \ \ \ \ **OffsetMiB** | number |
| - | | < | + | | \ \ \ \ \ \ **PassphraseState** | boolean |
| - | | < | + | | \ \ \ \ \ \ **RegionId** | string |
| - | | < | + | | \ \ \ \ \ \ **SizeMiB** | number |
| - | | } ] | | + | | } ] | | | |
| - | | **SecurityCapabilities** { | object | read-write | This object contains security capabilities of the Memory. | | + | | **SecurityCapabilities** { | object |
| - | | < | + | | \ \ \ \ \ \ **MaxPassphraseCount** | number |
| - | | < | + | | \ \ \ \ \ \ **PassphraseCapable** | boolean |
| - | | < | + | | \ \ \ \ \ \ **SecurityStates** [ {} ] | array | |
| - | | } | | + | | } | | | |
| - | | **SerialNumber** | string, null | read-only | The product serial number of this device. | | + | | **SerialNumber** | string |
| - | | **SpareDeviceCount** | number, null | read-only | Number of unused spare devices available in the Memory. | | + | | **SpareDeviceCount** | number |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| - | | **SubsystemDeviceID** | string, null | read-only | Subsystem Device ID. | | + | | **SubsystemDeviceID** | string |
| - | | **SubsystemVendorID** | string, null | read-only | SubSystem Vendor ID. | | + | | **SubsystemVendorID** | string |
| - | | **VendorID** | string, null | read-only | Vendor ID. | | + | | **VendorID** | string |
| - | | **VolatileRegionSizeLimitMiB** | number, null | read-only | Total size of volatile regions in MiB. | | + | | **VolatileRegionSizeLimitMiB** | number |
| === Property Details === | === Property Details === | ||
| Line 3402: | Line 2678: | ||
| This is the schema definition of a Memory Chunk and its configuration. | This is the schema definition of a Memory Chunk and its configuration. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AddressRangeType** | string, null | read-write | Memory type of this memory chunk.\\ | + | | **AddressRangeType** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **InterleaveSets** [ { | array | read-write | This is the interleave sets for the memory chunk. | | + | | **InterleaveSets** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **Memory** |
| - | | < | + | | \ \ \ \ \ \ **MemoryLevel** | number |
| - | | < | + | | \ \ \ \ \ \ **OffsetMiB** | number |
| - | | < | + | | \ \ \ \ \ \ **RegionId** | string |
| - | | < | + | | \ \ \ \ \ \ **SizeMiB** | number |
| - | | } ] | | + | | } ] | | | |
| - | | **IsMirrorEnabled** | boolean, null | read-only | Mirror Enabled status. | | + | | **IsMirrorEnabled** | boolean |
| - | | **IsSpare** | boolean, null | read-only | Spare enabled status. | | + | | **IsSpare** | boolean |
| - | | **MemoryChunkSizeMiB** | number, null | read-only | Size of the memory chunk in MiB. | | + | | **MemoryChunkSizeMiB** | number |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| === Property Details === | === Property Details === | ||
| Line 3433: | Line 2709: | ||
| A Collection of MemoryChunks resource instances. | A Collection of MemoryChunks resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| - | + | ||
| - | === Property Details === | + | |
| - | + | ||
| - | == AddressRangeType == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Block | Block accesible memory. | | + | |
| - | | PMEM | Byte accessible persistent memory. | | + | |
| - | | Volatile | Volatile memory. | | + | |
| ===== MemoryCollection ===== | ===== MemoryCollection ===== | ||
| Line 3464: | Line 2719: | ||
| A Collection of Memory resource instances. | A Collection of Memory resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Name** | string | + | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | === Property Details === | + | |
| - | + | ||
| - | == BaseModuleType == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | LRDIMM | Load Reduced. | | + | |
| - | | Mini_RDIMM | Mini_RDIMM. | | + | |
| - | | Mini_UDIMM | Mini_UDIMM. | | + | |
| - | | RDIMM | Registered DIMM. | | + | |
| - | | SO_DIMM | SO_DIMM. | | + | |
| - | | SO_DIMM_16b | SO_DIMM_16b. | | + | |
| - | | SO_DIMM_32b | SO_DIMM_32b. | | + | |
| - | | SO_RDIMM_72b | SO_RDIMM_72b. | | + | |
| - | | SO_UDIMM_72b | SO_UDIMM_72b. | | + | |
| - | | UDIMM | UDIMM. | | + | |
| - | + | ||
| - | == ErrorCorrection == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | AddressParity | Address Parity errors can be corrected. | | + | |
| - | | MultiBitECC | Multi-bit Data errors can be corrected by ECC. | | + | |
| - | | NoECC | No ECC available. | | + | |
| - | | SingleBitECC | Single bit Data error can be corrected by ECC. | | + | |
| - | + | ||
| - | == MemoryDeviceType == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | DDR | DDR. | | + | |
| - | | DDR2 | DDR2. | | + | |
| - | | DDR2_SDRAM | DDR2 SDRAM. | | + | |
| - | | DDR2_SDRAM_FB_DIMM | DDR2 SDRAM FB_DIMM. | | + | |
| - | | DDR2_SDRAM_FB_DIMM_PROBE | DDR2 SDRAM FB_DIMM PROBE. | | + | |
| - | | DDR3 | DDR3. | | + | |
| - | | DDR3_SDRAM | DDR3 SDRAM. | | + | |
| - | | DDR4 | DDR4. | | + | |
| - | | DDR4E_SDRAM | DDR4E SDRAM. | | + | |
| - | | DDR4_SDRAM | DDR4 SDRAM. | | + | |
| - | | DDR_SDRAM | DDR SDRAM. | | + | |
| - | | DDR_SGRAM | DDR SGRAM. | | + | |
| - | | EDO | EDO. | | + | |
| - | | FastPageMode | Fast Page Mode. | | + | |
| - | | LPDDR3_SDRAM | LPDDR3 SDRAM. | | + | |
| - | | LPDDR4_SDRAM | LPDDR4 SDRAM. | | + | |
| - | | PipelinedNibble | Pipelined Nibble. | | + | |
| - | | ROM | ROM. | | + | |
| - | | SDRAM | SDRAM. | | + | |
| - | + | ||
| - | == MemoryType == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | DRAM | DRAM. | | + | |
| - | | NVDIMM_F | NVDIMM_F as defined by JEDEC. | | + | |
| - | | NVDIMM_N | NVDIMM_N as defined by JEDEC. | | + | |
| - | | NVDIMM_P | NVDIMM_P as defined by JEDEC. | | + | |
| ===== MemoryDomain ===== | ===== MemoryDomain ===== | ||
| Line 3572: | Line 2729: | ||
| 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AllowsBlockProvisioning** | boolean, null | read-only | Indicates if this Memory Domain supports the provisioning of blocks of memory. | | + | | **AllowsBlockProvisioning** | boolean |
| - | | **AllowsMemoryChunkCreation** | boolean, null | read-only | Indicates if this Memory Domain supports the creation of Memory Chunks. | | + | | **AllowsMemoryChunkCreation** | boolean |
| - | | **AllowsMirroring** | boolean, null | read-only | Indicates if this Memory Domain supports the creation of Memory Chunks with mirroring enabled. | | + | | **AllowsMirroring** | boolean |
| - | | **AllowsSparing** | boolean, null | read-only | Indicates if this Memory Domain supports the creation of Memory Chunks with sparing enabled. | | + | | **AllowsSparing** | boolean |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **InterleavableMemorySets** [ { | array | read-write | This is the interleave sets for the memory chunk. | | + | | **InterleavableMemorySets** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **MemorySet** [ {} ] | array | |
| - | | < | + | | } ] | | | |
| - | | } ] | | + | | **MemoryChunks** | object | Yes | read-write | A reference to the collection of Memory Chunks associated with this Memory Domain. | |
| - | | **[[documentation: | + | | **Name** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Oem** {} | object |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | |
| ===== MemoryDomainCollection ===== | ===== MemoryDomainCollection ===== | ||
| Line 3591: | Line 2747: | ||
| A Collection of MemoryDomain resource instances. | A Collection of MemoryDomain resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| ===== MemoryMetrics ===== | ===== MemoryMetrics ===== | ||
| Line 3613: | Line 2757: | ||
| 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **BlockSizeBytes** | number, null | read-only | Block size in bytes.\\ unit: By | | + | | **BlockSizeBytes** | number |
| - | | **CurrentPeriod** { | object | read-write | This object describes the central memory of the system in general detail. | | + | | **CurrentPeriod** { | object |
| - | | < | + | | \ \ \ \ \ \ **BlocksRead** | number |
| - | | < | + | | \ \ \ \ \ \ **BlocksWritten** | string |
| - | | } | | + | | } | | | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **HealthData** { | object | read-write | This object describes the central memory of the system in general detail. | | + | | **HealthData** { | object |
| - | | < | + | | \ \ \ \ \ \ **AlarmTrips** {} | object |
| - | | < | + | | \ \ \ \ \ \ **DataLossDetected** | boolean |
| - | | < | + | | \ \ \ \ \ \ **LastShutdownSuccess** | boolean |
| - | | < | + | | \ \ \ \ \ \ **PerformanceDegraded** | boolean |
| - | | < | + | | \ \ \ \ \ \ **PredictedMediaLifeLeftPercent** | number |
| - | | < | + | | \ \ \ \ \ \ **RemainingSpareBlockPercentage** | number |
| - | | } | | + | | } | | | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **LifeTime** { | object | read-write | This object describes the central memory of the system in general detail. | | + | | **LifeTime** { | object |
| - | | < | + | | \ \ \ \ \ \ **BlocksRead** | number |
| - | | < | + | | \ \ \ \ \ \ **BlocksWritten** | string |
| - | | } | | + | | } | | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== MessageRegistry ===== | ===== MessageRegistry ===== | ||
| Line 3644: | Line 2788: | ||
| This is the schema definition for all Message Registries. | This is the schema definition for all Message Registries. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Language** | string | read-only | This is the RFC 5646 compliant language code for the registry. | | + | | **Language** | string |
| - | | **Messages** {} | object | read-write | The pattern property indicates that a free-form string is the unique identifier for the message within the registry. | | + | | **Messages** {} | object |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **OwningEntity** | string | read-only | This is the organization or company that publishes this registry. | | + | | **OwningEntity** | string |
| - | | **RegistryPrefix** | string | read-only | This is the single word prefix used to form a messageID structure. | | + | | **RegistryPrefix** | string |
| - | | **RegistryVersion** | string | read-only | This is the message registry version which is used in the middle portion of a messageID. | | + | | **RegistryVersion** | string |
| ===== MessageRegistryCollection ===== | ===== MessageRegistryCollection ===== | ||
| Line 3659: | Line 2803: | ||
| A Collection of MessageRegistry resource instances. | A Collection of MessageRegistry resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| ===== MessageRegistryFile ===== | ===== MessageRegistryFile ===== | ||
| Line 3680: | Line 2813: | ||
| This is the schema definition for the Schema File locator resource. | This is the schema definition for the Schema File locator resource. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Languages** [ {} ] | array | read-only | Language codes for the schemas available. | | + | | **Languages** [ {} ] | array | |
| - | | **Location** [ { | array | read-write | Location information for this schema file. | | + | | **Location** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **ArchiveFile** | string |
| - | | < | + | | \ \ \ \ \ \ **ArchiveUri** | string |
| - | | < | + | | \ \ \ \ \ \ **Language** | string |
| - | | < | + | | \ \ \ \ \ \ **PublicationUri** | string |
| - | | < | + | | \ \ \ \ \ \ **Uri** | string |
| - | | } ] | | + | | } ] | | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Registry** | string | read-only | The Registry Name, Major and Minor version used in MessageID construction. | | + | | **Registry** | string |
| ===== MessageRegistryFileCollection ===== | ===== MessageRegistryFileCollection ===== | ||
| Line 3699: | Line 2832: | ||
| A Collection of MessageRegistryFile resource instances. | A Collection of MessageRegistryFile resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| ===== NetworkAdapter ===== | ===== NetworkAdapter ===== | ||
| Line 3718: | Line 2842: | ||
| A NetworkAdapter represents the physical network adapter capable of connecting to a computer network. | A NetworkAdapter represents the physical network adapter capable of connecting to a computer network. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **Controllers** [ { | array | read-write | The set of network controllers ASICs that make up this NetworkAdapter. | | + | | **Controllers** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **ControllerCapabilities** {} | object |
| - | | < | + | | \ \ \ \ \ \ **FirmwarePackageVersion** | string |
| - | | < | + | | \ \ \ \ \ \ **Links** {} | object |
| - | | } ] | | + | | } ] | | | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Manufacturer** | string, null | read-only | The manufacturer or OEM of this network adapter. | | + | | **Manufacturer** | string |
| - | | **Model** | string, null | read-only | The model string for this network adapter. | | + | | **Model** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **[[documentation: | + | | **NetworkDeviceFunctions** | reference([[documentation: |
| - | | **[[documentation: | + | | **NetworkPorts** | reference([[documentation: |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **PartNumber** | string, null | read-only | Part number for this network adapter. | | + | | **PartNumber** | string |
| - | | **SKU** | string, null | read-only | The manufacturer SKU for this network adapter. | | + | | **SKU** | string |
| - | | **SerialNumber** | string, null | read-only | The serial number for this network adapter. | | + | | **SerialNumber** | string |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| === Property Details === | === Property Details === | ||
| Line 3782: | Line 2906: | ||
| A Collection of NetworkAdapter resource instances. | A Collection of NetworkAdapter resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Name** | string | + | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | |
| ===== NetworkDeviceFunction ===== | ===== NetworkDeviceFunction ===== | ||
| Line 3808: | Line 2916: | ||
| 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AssignablePhysicalPorts** | + | | **AssignablePhysicalPorts** | array(reference([[documentation: |
| - | | < | + | | **BootMode** | string | Yes | read-write | The boot mode configured for this network device function.\\ |
| - | | < | + | | **Description** | string |
| - | | < | + | | **DeviceEnabled** | boolean |
| - | | < | + | | **Ethernet** { | object |
| - | | < | + | | \ \ \ \ \ \ **MACAddress** | string |
| - | | < | + | | \ \ \ \ \ \ **MTUSize** | number |
| - | | < | + | | \ \ \ \ \ \ **PermanentMACAddress** | string |
| - | | < | + | | } | | | |
| - | | < | + | | **FibreChannel** { | object |
| - | | < | + | | \ \ \ \ \ \ **AllowFIPVLANDiscovery** | boolean |
| - | | < | + | | \ \ \ \ \ \ **BootTargets** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **FCoEActiveVLANId** | number |
| - | | < | + | | \ \ \ \ \ \ **FCoELocalVLANId** | number |
| - | | < | + | | \ \ \ \ \ \ **PermanentWWNN** | string |
| - | | < | + | | \ \ \ \ \ \ **PermanentWWPN** | string |
| - | | < | + | | \ \ \ \ \ \ **WWNN** | string |
| - | | < | + | | \ \ \ \ \ \ **WWNSource** | string |
| - | | < | + | | \ \ \ \ \ \ **WWPN** | string |
| - | | < | + | | } | | | |
| - | | } ] | | + | | **Id** | string |
| - | | **[email protected]** | string | read-write | | | + | | **Links** { | object |
| - | | **BootMode** | string, null | read-write | The boot mode configured for this network device function.\\ | + | | \ \ \ \ \ \ **PCIeFunction** |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | } | | | |
| - | | **DeviceEnabled** | boolean, null | read-write | Whether the network device function is enabled. | | + | | **MaxVirtualFunctions** | number |
| - | | **Ethernet** { | object, null | read-write | Ethernet. | | + | | **Name** | string |
| - | | < | + | | **NetDevFuncCapabilities** [ {} ] | array | |
| - | | < | + | | **NetDevFuncType** | string |
| - | | < | + | | **Oem** {} | object |
| - | | } | | + | | **PhysicalPortAssignment** | reference([[documentation: |
| - | | **FibreChannel** { | object, null | read-write | Fibre Channel. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | < | + | | } | | | |
| - | | < | + | | **VirtualFunctionsEnabled** | boolean |
| - | | < | + | | **iSCSIBoot** { | object |
| - | | < | + | | \ \ \ \ \ \ **AuthenticationMethod** | string |
| - | | < | + | | \ \ \ \ \ \ **CHAPSecret** | string |
| - | | } | | + | | \ \ \ \ \ \ **CHAPUsername** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | \ \ \ \ \ \ **IPAddressType** | string |
| - | | **Links** { | object | read-write | Links. | | + | | \ \ \ \ \ \ **IPMaskDNSViaDHCP** | boolean |
| - | | < | + | | \ \ \ \ \ \ **InitiatorDefaultGateway** | string |
| - | | } | | + | | \ \ \ \ \ \ **InitiatorIPAddress** | string |
| - | | **MaxVirtualFunctions** | number, null | read-only | The number of virtual functions (VFs) that are available for this Network Device Function. | | + | | \ \ \ \ \ \ **InitiatorName** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | \ \ \ \ \ \ **InitiatorNetmask** | string |
| - | | **NetDevFuncCapabilities** [ {} ] | array | read-only | Capabilities of this network device function. | | + | | \ \ \ \ \ \ **MutualCHAPSecret** | string |
| - | | **NetDevFuncType** | string, null | read-write | The configured capability of this network device function.\\ | + | | \ \ \ \ \ \ **MutualCHAPUsername** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | \ \ \ \ \ \ **PrimaryDNS** | string |
| - | | **[[documentation: | + | | \ \ \ \ \ \ **PrimaryLUN** | number |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | \ \ \ \ \ \ **PrimaryTargetIPAddress** | string |
| - | | < | + | | \ \ \ \ \ \ **PrimaryTargetName** | string |
| - | | < | + | | \ \ \ \ \ \ **PrimaryTargetTCPPort** | number |
| - | | < | + | | \ \ \ \ \ \ **PrimaryVLANEnable** | boolean |
| - | | < | + | | \ \ \ \ \ \ **PrimaryVLANId** | number |
| - | | } | | + | | \ \ \ \ \ \ **RouterAdvertisementEnabled** | boolean |
| - | | **VirtualFunctionsEnabled** | boolean, null | read-only | Whether Single Root I/O Virtualization (SR-IOV) Virual Functions (VFs) are enabled for this Network Device Function. | | + | | \ \ \ \ \ \ **SecondaryDNS** | string |
| - | | **iSCSIBoot** { | object, null | read-write | iSCSI Boot. | | + | | \ \ \ \ \ \ **SecondaryLUN** | number |
| - | | < | + | | \ \ \ \ \ \ **SecondaryTargetIPAddress** | string |
| - | | < | + | | \ \ \ \ \ \ **SecondaryTargetName** | string |
| - | | < | + | | \ \ \ \ \ \ **SecondaryTargetTCPPort** | number |
| - | | < | + | | \ \ \ \ \ \ **SecondaryVLANEnable** | boolean |
| - | | < | + | | \ \ \ \ \ \ **SecondaryVLANId** | number |
| - | | < | + | | \ \ \ \ \ \ **TargetInfoViaDHCP** | boolean |
| - | | < | + | | } | | | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } | | + | |
| === Property Details === | === Property Details === | ||
| Line 3999: | Line 3086: | ||
| A Collection of NetworkDeviceFunction resource instances. | A Collection of NetworkDeviceFunction resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | + | |
| - | | **Name** | string | + | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | === Property Details === | + | |
| - | + | ||
| - | == BootMode == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Disabled | Do not indicate to UEFI/BIOS that this device is bootable. | | + | |
| - | | FibreChannel | Boot this device using the embedded Fibre Channel support and configuration. | + | |
| - | | FibreChannelOverEthernet | Boot this device using the embedded Fibre Channel over Ethernet (FCoE) boot support and configuration. | + | |
| - | | PXE | Boot this device using the embedded PXE support. | + | |
| - | | iSCSI | Boot this device using the embedded iSCSI boot support and configuration. | + | |
| - | + | ||
| - | == NetDevFuncType == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Disabled | Neither enumerated nor visible to the operating system. | | + | |
| - | | Ethernet | Appears to the operating system as an Ethernet device. | | + | |
| - | | FibreChannel | Appears to the operating system as a Fibre Channel device. | | + | |
| - | | FibreChannelOverEthernet | Appears to the operating system as an FCoE device. | | + | |
| - | | iSCSI | Appears to the operating system as an iSCSI device. | | + | |
| ===== NetworkInterface ===== | ===== NetworkInterface ===== | ||
| Line 4050: | Line 3096: | ||
| A NetworkInterface contains references linking NetworkAdapter, | A NetworkInterface contains references linking NetworkAdapter, | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Links** { | object | read-write | Links. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **NetworkAdapter** |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **[[documentation: | + | | **NetworkDeviceFunctions** | reference([[documentation: |
| - | | **[[documentation: | + | | **NetworkPorts** | reference([[documentation: |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| === Property Details === | === Property Details === | ||
| Line 4104: | Line 3150: | ||
| A Collection of NetworkInterface resource instances. | A Collection of NetworkInterface resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | + | |
| - | | **Name** | string | + | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | |
| ===== NetworkPort ===== | ===== NetworkPort ===== | ||
| Line 4124: | Line 3160: | ||
| 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **ActiveLinkTechnology** | string, null | read-write | Network Port Active Link Technology.\\ | + | | **ActiveLinkTechnology** | string |
| - | | **AssociatedNetworkAddresses** [ {} ] | array | read-only | The array of configured network addresses (MAC or WWN) that are associated with this Network Port, including the programmed address of the lowest numbered Network Device Function, the configured but not active address if applicable, the address for hardware port teaming, or other network addresses. | | + | | **AssociatedNetworkAddresses** [ {} ] | array | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **EEEEnabled** | boolean, null | read-write | Whether IEEE 802.3az Energy Efficient Ethernet (EEE) is enabled for this network port. | | + | | **EEEEnabled** | boolean |
| - | | **FlowControlConfiguration** | string, null | read-write | The locally configured 802.3x flow control setting for this network port.\\ | + | | **FlowControlConfiguration** | string |
| - | | **FlowControlStatus** | string, null | read-write | The 802.3x flow control behavior negotiated with the link partner for this network port (Ethernet-only).\\ | + | | **FlowControlStatus** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **LinkStatus** | string, null | read-write | The status of the link between this port and its link partner.\\ | + | | **LinkStatus** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **NetDevFuncMaxBWAlloc** [ { | array | read-write | The array of maximum bandwidth allocation percentages for the Network Device Functions associated with this port. | | + | | **NetDevFuncMaxBWAlloc** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **MaxBWAllocPercent** | number |
| - | | < | + | | \ \ \ \ \ \ **NetworkDeviceFunction** |
| - | | } ] | | + | | } ] | | | |
| - | | **NetDevFuncMinBWAlloc** [ { | array | read-write | The array of minimum bandwidth allocation percentages for the Network Device Functions associated with this port. | | + | | **NetDevFuncMinBWAlloc** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **MinBWAllocPercent** | number |
| - | | < | + | | \ \ \ \ \ \ **NetworkDeviceFunction** |
| - | | } ] | | + | | } ] | | | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **PhysicalPortNumber** | string, null | read-only | The physical port number label for this port. | | + | | **PhysicalPortNumber** | string |
| - | | **PortMaximumMTU** | number, null | read-only | The largest maximum transmission unit (MTU) that can be configured for this network port. | | + | | **PortMaximumMTU** | number |
| - | | **SignalDetected** | boolean, null | read-only | Whether or not the port has detected enough signal on enough lanes to establish link. | | + | | **SignalDetected** | boolean |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| - | | **SupportedEthernetCapabilities** [ {} ] | array | read-only | The set of Ethernet capabilities that this port supports. | | + | | **SupportedEthernetCapabilities** [ {} ] | array | |
| - | | **SupportedLinkCapabilities** [ { | array | read-write | The self-described link capabilities of this port. | | + | | **SupportedLinkCapabilities** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **LinkNetworkTechnology** | string |
| - | | < | + | | \ \ \ \ \ \ **LinkSpeedMbps** | number |
| - | | } ] | | + | | } ] | | | |
| - | | **WakeOnLANEnabled** | boolean, null | read-write | Whether Wake on LAN (WoL) is enabled for this network port. | | + | | **WakeOnLANEnabled** | boolean |
| === Property Details === | === Property Details === | ||
| Line 4231: | Line 3267: | ||
| A Collection of NetworkPort resource instances. | A Collection of NetworkPort resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | + | |
| - | | **Name** | string | + | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | === Property Details === | + | |
| - | + | ||
| - | == ActiveLinkTechnology == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Ethernet | The port is capable of connecting to an Ethernet network. | | + | |
| - | | FibreChannel | The port is capable of connecting to a Fibre Channel network. | | + | |
| - | | InfiniBand | The port is capable of connecting to an InfiniBand network. | | + | |
| - | + | ||
| - | == FlowControlConfiguration == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | None | No IEEE 802.3x flow control is enabled on this port. | | + | |
| - | | RX | IEEE 802.3x flow control may be initiated by the link partner. | | + | |
| - | | TX | IEEE 802.3x flow control may be initiated by this station. | | + | |
| - | | TX_RX | IEEE 802.3x flow control may be initiated by this station or the link partner. | | + | |
| - | + | ||
| - | == FlowControlStatus == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | None | No IEEE 802.3x flow control is enabled on this port. | | + | |
| - | | RX | IEEE 802.3x flow control may be initiated by the link partner. | | + | |
| - | | TX | IEEE 802.3x flow control may be initiated by this station. | | + | |
| - | | TX_RX | IEEE 802.3x flow control may be initiated by this station or the link partner. | | + | |
| - | + | ||
| - | == LinkStatus == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Down | The port is enabled but link is down. | | + | |
| - | | Up | The port is enabled and link is good (up). | | + | |
| ===== PCIeDevice ===== | ===== PCIeDevice ===== | ||
| Line 4294: | Line 3277: | ||
| This is the schema definition for the PCIeDevice resource. | This is the schema definition for the PCIeDevice resource. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AssetTag** | string, null | read-write | The user assigned asset tag for this PCIe device. | | + | | **AssetTag** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **DeviceType** | string | read-write | The device type for this PCIe device.\\ | + | | **DeviceType** | string |
| - | | **FirmwareVersion** | string, null | read-only | The version of firmware for this PCIe device. | | + | | **FirmwareVersion** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Links** { | object | read-write | The links object contains the links to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Chassis** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **PCIeFunctions** [ {} ] | array | |
| - | | < | + | | } | | | |
| - | | < | + | | **Manufacturer** | string |
| - | | } | | + | | **Model** | string |
| - | | **Manufacturer** | string, null | read-only | This is the manufacturer of this PCIe device. | | + | | **Name** | string |
| - | | **Model** | string, null | read-only | This is the model number for the PCIe device. | | + | | **Oem** {} | object |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **PartNumber** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **SKU** | string |
| - | | **PartNumber** | string, null | read-only | The part number for this PCIe device. | | + | | **SerialNumber** | string |
| - | | **SKU** | string, null | read-only | This is the SKU for this PCIe device. | | + | | **Status** { | object |
| - | | **SerialNumber** | string, null | read-only | The serial number for this PCIe device. | | + | | \ \ \ \ \ \ **Health** | string |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | < | + | | } | | | |
| - | | < | + | |
| - | | } | | + | |
| === Property Details === | === Property Details === | ||
| Line 4364: | Line 3345: | ||
| This is the schema definition for the PCIeFunction resource. | This is the schema definition for the PCIeFunction resource. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **ClassCode** | string, null | read-only | The Class Code of this PCIe function.\\ pattern: / | + | | **ClassCode** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **DeviceClass** | string | read-write | The class for this PCIe Function.\\ | + | | **DeviceClass** | string |
| - | | **DeviceId** | string, null | read-only | The Device ID of this PCIe function.\\ pattern: / | + | | **DeviceId** | string |
| - | | **FunctionId** | number, null | read-only | The the PCIe Function identifier. | | + | | **FunctionId** | number |
| - | | **FunctionType** | string | read-write | The type of the PCIe Function.\\ | + | | **FunctionType** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Links** { | object | read-write | The links object contains the links to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Drives** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **EthernetInterfaces** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **PCIeDevice** |
| - | | < | + | | \ \ \ \ \ \ **StorageControllers** [ {} ] | array | |
| - | | < | + | | } | | | |
| - | | < | + | | **Name** | string |
| - | | < | + | | **Oem** {} | object |
| - | | } | | + | | **RevisionId** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Status** { | object |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | \ \ \ \ \ \ **Health** | string |
| - | | **RevisionId** | string, null | read-only | The Revision ID of this PCIe function.\\ pattern: / | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | < | + | | } | | | |
| - | | < | + | | **SubsystemId** | string |
| - | | < | + | | **SubsystemVendorId** | string |
| - | | } | | + | | **VendorId** | string |
| - | | **SubsystemId** | string, null | read-only | The Subsystem ID of this PCIe function.\\ pattern: / | + | |
| - | | **SubsystemVendorId** | string, null | read-only | The Subsystem Vendor ID of this PCIe function.\\ pattern: / | + | |
| - | | **VendorId** | string, null | read-only | The Vendor ID of this PCIe function.\\ pattern: / | + | |
| === Property Details === | === Property Details === | ||
| Line 4464: | Line 3442: | ||
| Port contains properties describing a port of a switch. | Port contains properties describing a port of a switch. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **CurrentSpeedGbps** | number, null | read-only | The current speed of this port.\\ unit: Gbit/s | | + | | **CurrentSpeedGbps** | number |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **AssociatedEndpoints** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **ConnectedSwitchPorts** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **ConnectedSwitches** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | } | | | |
| - | | < | + | | **MaxSpeedGbps** | number |
| - | | < | + | | **Name** | string |
| - | | } | | + | | **Oem** {} | object |
| - | | **MaxSpeedGbps** | number, null | read-only | The maximum speed of this port as currently configured.\\ unit: Gbit/s | | + | | **PortId** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **PortProtocol** | | Yes | read-write | The protocol being sent over this port. | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **PortType** | string |
| - | | **PortId** | string, null | read-only | This is the label of this port on the physical switch package. | | + | | **Status** { | object |
| - | | **PortProtocol** | null | read-write | The protocol being sent over this port. | | + | | \ \ \ \ \ \ **Health** | string |
| - | | **PortType** | string, null | read-write | This is the type of this port.\\ | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | < | + | | } | | | |
| - | | < | + | | **Width** | number |
| - | | < | + | |
| - | | } | | + | |
| - | | **Width** | number, null | read-only | The number of lanes, phys, or other physical transport links that this port contains. | | + | |
| === Property Details === | === Property Details === | ||
| Line 4541: | Line 3516: | ||
| A Collection of Port resource instances. | A Collection of Port resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| - | + | ||
| - | === Property Details === | + | |
| - | + | ||
| - | == PortType == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | BidirectionalPort | This port connects to any type of device. | | + | |
| - | | DownstreamPort | This port connects to a target device. | | + | |
| - | | InterswitchPort | This port connects to another switch. | | + | |
| - | | ManagementPort | This port connects to a switch manager. | | + | |
| - | | UnconfiguredPort | This port has not yet been configured. | | + | |
| - | | UpstreamPort | This port connects to a host device. | | + | |
| ===== Power ===== | ===== Power ===== | ||
| Line 4579: | Line 3526: | ||
| This is the schema definition for the Power Metrics. | This is the schema definition for the Power Metrics. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **PowerControl** [ { | array | read-write | This is the definition for power control function (power reading/ | + | | **PowerControl** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **MemberId** | string |
| - | | < | + | | \ \ \ \ \ \ **Name** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **PowerAllocatedWatts** | number |
| - | | < | + | | \ \ \ \ \ \ **PowerAvailableWatts** | number |
| - | | < | + | | \ \ \ \ \ \ **PowerCapacityWatts** | number |
| - | | < | + | | \ \ \ \ \ \ **PowerConsumedWatts** | number |
| - | | < | + | | \ \ \ \ \ \ **PowerLimit** {} | object |
| - | | < | + | | \ \ \ \ \ \ **PowerMetrics** {} | object |
| - | | < | + | | \ \ \ \ \ \ **PowerRequestedWatts** | number |
| - | | < | + | | \ \ \ \ \ \ **RelatedItem** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Status** {} | object |
| - | | < | + | | } ] | | | |
| - | | } ] | | | | + | | **PowerSupplies** [ { | array | |
| - | | **[email protected]** | string | read-write | + | | \ \ \ \ \ \ **FirmwareVersion** | string |
| - | | **PowerSupplies** [ { | array | read-write | Details of the power supplies associated with this system or device. | | + | | \ \ \ \ \ \ **IndicatorLED** | string |
| - | | < | + | | \ \ \ \ \ \ **InputRanges** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **LastPowerOutputWatts** | number |
| - | | < | + | | \ \ \ \ \ \ **LineInputVoltage** | number |
| - | | < | + | | \ \ \ \ \ \ **LineInputVoltageType** | string |
| - | | < | + | | \ \ \ \ \ \ **Manufacturer** | string |
| - | | < | + | | \ \ \ \ \ \ **MemberId** | string |
| - | | < | + | | \ \ \ \ \ \ **Model** | string |
| - | | < | + | | \ \ \ \ \ \ **Name** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **PartNumber** | string |
| - | | < | + | | \ \ \ \ \ \ **PowerCapacityWatts** | number |
| - | | < | + | | \ \ \ \ \ \ **PowerSupplyType** | string |
| - | | < | + | | \ \ \ \ \ \ **Redundancy** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **RelatedItem** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **SerialNumber** | string | Yes | read-only | The serial number for this Power Supply. | |
| - | | < | + | | \ \ \ \ \ \ **SparePartNumber** | string |
| - | | < | + | | \ \ \ \ \ \ **Status** {} | object |
| - | | < | + | | } ] | | | |
| - | | < | + | | **Redundancy** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **MaxNumSupported** | number |
| - | | < | + | | \ \ \ \ \ \ **MemberId** | string |
| - | | } ] | | | | + | | \ \ \ \ \ \ **MinNumNeeded** | number |
| - | | **[email protected]** | string | read-write | + | | \ \ \ \ \ \ **Mode** | string |
| - | | **Redundancy** [ { | array | read-write | Redundancy information for the power subsystem of this system or device. | | + | | \ \ \ \ \ \ **Name** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **RedundancySet** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Status** {} | object |
| - | | < | + | | \ \ \ \ \ \ **MemberId** | string |
| - | | < | + | | \ \ \ \ \ \ **RedundancyEnabled** | boolean |
| - | | < | + | | } ] | | | |
| - | | < | + | | **Voltages** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **LowerThresholdCritical** | number |
| - | | < | + | | \ \ \ \ \ \ **LowerThresholdFatal** | number |
| - | | < | + | | \ \ \ \ \ \ **LowerThresholdNonCritical** | number |
| - | | < | + | | \ \ \ \ \ \ **MaxReadingRange** | number |
| - | | } ] | | | | + | | \ \ \ \ \ \ **MemberId** | string |
| - | | **[email protected]** | string | read-write | + | | \ \ \ \ \ \ **MinReadingRange** | number |
| - | | **Voltages** [ { | array | read-write | This is the definition for voltage sensors. | | + | | \ \ \ \ \ \ **Name** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **PhysicalContext** | string |
| - | | < | + | | \ \ \ \ \ \ **ReadingVolts** | number |
| - | | < | + | | \ \ \ \ \ \ **RelatedItem** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **SensorNumber** | number |
| - | | < | + | | \ \ \ \ \ \ **Status** {} | object |
| - | | < | + | | \ \ \ \ \ \ **UpperThresholdCritical** | number |
| - | | < | + | | \ \ \ \ \ \ **UpperThresholdFatal** | number |
| - | | < | + | | \ \ \ \ \ \ **UpperThresholdNonCritical** | number |
| - | | < | + | | } ] | | | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | | | + | |
| - | | **[email protected]** | string | read-write | + | |
| === Property Details === | === Property Details === | ||
| Line 4729: | Line 3667: | ||
| This is the schema definition for Operation to Privilege mapping. | This is the schema definition for Operation to Privilege mapping. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Mappings** [ { | array | read-write | | | + | | **Mappings** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **Entity** | string |
| - | | < | + | | \ \ \ \ \ \ **OperationMap** {} | object |
| - | | < | + | | \ \ \ \ \ \ **PropertyOverrides** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **ResourceURIOverrides** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **SubordinateOverrides** [ {} ] | array | |
| - | | } ] | | + | | } ] | | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **OEMPrivilegesUsed** [ {} ] | array | read-only | Lists the set of OEM Priviliges used in building this mapping. | | + | | **OEMPrivilegesUsed** [ {} ] | array | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **PrivilegesUsed** [ {} ] | array | read-only | Lists the set of Redfish standard priviliges used in building this mapping. | | + | | **PrivilegesUsed** [ {} ] | array | |
| ===== Processor ===== | ===== Processor ===== | ||
| Line 4748: | Line 3686: | ||
| This is the schema definition for the Processor resource. | This is the schema definition for the Processor resource. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **InstructionSet** | string, null | read-write | The instruction set of the processor.\\ | + | | **InstructionSet** | string |
| - | | **Manufacturer** | string, null | read-only | The processor manufacturer. | | + | | **Manufacturer** | string |
| - | | **MaxSpeedMHz** | number, null | read-only | The maximum clock speed of the processor. | | + | | **MaxSpeedMHz** | number |
| - | | **Model** | string, null | read-only | The product model number of this device. | | + | | **Model** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **ProcessorArchitecture** | string, null | read-write | The architecture of the processor.\\ | + | | **ProcessorArchitecture** | string |
| - | | **ProcessorId** { | object | read-write | Identification information for this processor. | | + | | **ProcessorId** { | object |
| - | | < | + | | \ \ \ \ \ \ **EffectiveFamily** | string |
| - | | < | + | | \ \ \ \ \ \ **EffectiveModel** | string |
| - | | < | + | | \ \ \ \ \ \ **IdentificationRegisters** | string |
| - | | < | + | | \ \ \ \ \ \ **MicrocodeInfo** | string |
| - | | < | + | | \ \ \ \ \ \ **Step** | string |
| - | | < | + | | \ \ \ \ \ \ **VendorId** | string |
| - | | } | | + | | } | | | |
| - | | **ProcessorType** | string, null | read-write | The type of processor.\\ | + | | **ProcessorType** | string |
| - | | **Socket** | string, null | read-only | The socket or location of the processor. | | + | | **Socket** | string |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| - | | **TotalCores** | number, null | read-only | The total number of cores contained in this processor. | | + | | **TotalCores** | number |
| - | | **TotalThreads** | number, null | read-only | The total number of execution threads supported by this processor. | | + | | **TotalThreads** | number |
| === Property Details === | === Property Details === | ||
| Line 4844: | Line 3782: | ||
| A Collection of Processor resource instances. | A Collection of Processor resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| - | + | ||
| - | === Property Details === | + | |
| - | + | ||
| - | == InstructionSet == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | ARM-A32 | ARM 32-bit. | | + | |
| - | | ARM-A64 | ARM 64-bit. | | + | |
| - | | IA-64 | Intel IA-64. | | + | |
| - | | MIPS32 | MIPS 32-bit. | | + | |
| - | | MIPS64 | MIPS 64-bit. | | + | |
| - | | OEM | OEM-defined. | | + | |
| - | | x86 | x86 32-bit. | | + | |
| - | | x86-64 | x86 64-bit. | | + | |
| - | + | ||
| - | == ProcessorArchitecture == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | ARM | ARM. | | + | |
| - | | IA-64 | Intel Itanium. | | + | |
| - | | MIPS | MIPS. | | + | |
| - | | OEM | OEM-defined. | | + | |
| - | | x86 | x86 or x86-64. | | + | |
| - | + | ||
| - | == ProcessorType == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Accelerator | An Accelerator. | | + | |
| - | | CPU | A Central Processing Unit. | | + | |
| - | | DSP | A Digital Signal Processor. | | + | |
| - | | FPGA | A Field Programmable Gate Array. | | + | |
| - | | GPU | A Graphics Processing Unit. | | + | |
| - | | OEM | An OEM-defined Processing Unit. | | + | |
| ===== Role ===== | ===== Role ===== | ||
| Line 4905: | Line 3792: | ||
| 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AssignedPrivileges** [ {} ] | array | read-write | The redfish privileges that this role includes. | | + | | **AssignedPrivileges** [ {} ] | array | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **IsPredefined** | boolean | read-only | This property is used to indicate if the Role is one of the Redfish Predefined Roles vs a Custom role. | | + | | **IsPredefined** | boolean |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **OemPrivileges** [ {} ] | array | read-write | The OEM privileges that this role includes. | | + | | **OemPrivileges** [ {} ] | array | |
| ===== RoleCollection ===== | ===== RoleCollection ===== | ||
| Line 4918: | Line 3805: | ||
| A Collection of Role resource instances. | A Collection of Role resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| ===== SecureBoot ===== | ===== SecureBoot ===== | ||
| Line 4937: | Line 3815: | ||
| 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **SecureBootCurrentBoot** | string, null | read-write | Secure Boot state during the current boot cycle.\\ | + | | **SecureBootCurrentBoot** | string |
| - | | **SecureBootEnable** | boolean, null | read-write | Enable or disable UEFI Secure Boot (takes effect on next boot). | | + | | **SecureBootEnable** | boolean |
| - | | **SecureBootMode** | string, null | read-write | Current Secure Boot Mode.\\ | + | | **SecureBootMode** | string |
| === Property Details === | === Property Details === | ||
| Line 4971: | Line 3849: | ||
| This schema defines an asynchronous serial interface resource. | This schema defines an asynchronous serial interface resource. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **BitRate** | string | read-write | The receive and transmit rate of data flow, typically in bits-per-second (bps), over the serial connection.\\ | + | | **BitRate** | string |
| - | | **ConnectorType** | string | read-write | The type of connector used for this interface.\\ | + | | **ConnectorType** | string |
| - | | **DataBits** | string | read-write | The number of data bits that will follow the start bit over the serial connection.\\ | + | | **DataBits** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **FlowControl** | string | read-write | The type of flow control, if any, that will be imposed on the serial connection.\\ | + | | **FlowControl** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **InterfaceEnabled** | boolean, null | read-write | This indicates whether this interface is enabled. | | + | | **InterfaceEnabled** | boolean |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Parity** | string | read-write | The type of parity used by the sender and receiver in order to detect errors over the serial connection.\\ | + | | **Parity** | string |
| - | | **PinOut** | string, null | read-write | The physical pin configuration needed for a serial connector.\\ | + | | **PinOut** | string |
| - | | **SignalType** | string | read-write | The type of signal used for the communication connection - RS232 or RS485.\\ | + | | **SignalType** | string |
| - | | **StopBits** | string | read-write | The period of time before the next start bit is transmitted.\\ | + | | **StopBits** | string |
| === Property Details === | === Property Details === | ||
| Line 4991: | Line 3869: | ||
| ^ string ^ | ^ string ^ | ||
| - | | 1200 | | + | | 1200 | |
| - | | 2400 | | + | | 2400 | |
| - | | 4800 | | + | | 4800 | |
| - | | 9600 | | + | | 9600 | |
| - | | 19200 | | + | | 19200 | |
| - | | 38400 | | + | | 38400 | |
| - | | 57600 | | + | | 57600 | |
| - | | 115200 | | + | | 115200 | |
| - | | 230400 | | + | | 230400 | |
| == ConnectorType == | == ConnectorType == | ||
| ^ string ^ | ^ string ^ | ||
| - | | RJ45. | | + | | RJ45. | |
| - | | RJ11. | | + | | RJ11. | |
| - | | DB9 Female. | | + | | DB9 Female. | |
| - | | DB9 Male. | | + | | DB9 Male. | |
| - | | DB25 Female. | | + | | DB25 Female. | |
| - | | DB25 Male. | | + | | DB25 Male. | |
| - | | USB. | | + | | USB. | |
| - | | mUSB. | | + | | mUSB. | |
| - | | uUSB. | | + | | uUSB. | |
| == DataBits == | == DataBits == | ||
| ^ string ^ | ^ string ^ | ||
| - | | 5 | | + | | 5 | |
| - | | 6 | | + | | 6 | |
| - | | 7 | | + | | 7 | |
| - | | 8 | | + | | 8 | |
| == FlowControl == | == FlowControl == | ||
| Line 5032: | Line 3910: | ||
| ^ string ^ | ^ string ^ | ||
| - | | None | | + | | None | |
| - | | Even | | + | | Even | |
| - | | Odd | | + | | Odd | |
| - | | Mark | | + | | Mark | |
| - | | Space | | + | | Space | |
| == PinOut == | == PinOut == | ||
| ^ string ^ | ^ string ^ | ||
| - | | Cisco | | + | | Cisco | |
| - | | Cyclades | | + | | Cyclades | |
| - | | Digi | | + | | Digi | |
| == SignalType == | == SignalType == | ||
| ^ string ^ | ^ string ^ | ||
| - | | Rs232 | | + | | Rs232 | |
| - | | Rs485 | | + | | Rs485 | |
| == StopBits == | == StopBits == | ||
| ^ string ^ | ^ string ^ | ||
| - | | 1 | | + | | 1 | |
| - | | 2 | | + | | 2 | |
| Line 5062: | Line 3940: | ||
| A Collection of SerialInterface resource instances. | A Collection of SerialInterface resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| - | === Property Details | + | ===== ServiceRoot ===== |
| - | == BitRate == | + | This object represents the root Redfish service. |
| - | ^ string | + | ^ Property ^ Type ^ Nullable ^ Permission ^ Description |
| - | | 1200 | | + | | **AccountService** | reference([[documentation: |
| - | | 2400 | | + | | **Chassis** | reference([[documentation: |
| - | | 4800 | | + | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality |
| - | | 9600 | | + | | **EventService** | reference([[documentation: |
| - | | 19200 | | + | | **Fabrics** | reference([[documentation: |
| - | | 38400 | | + | | **Id** | string | | read-write | Uniquely identifies the resource within the collection of like resources. |
| - | | 57600 | | + | | **JsonSchemas** | reference([[documentation: |
| - | | 115200 | + | | **Links** { | object | | read-write | Contains references to other resources that are related to this resource. |
| - | | 230400 | + | | \ \ \ \ \ \ **Oem** {} | object | | read-write | Oem extension object. | |
| + | | \ \ \ \ \ \ **Sessions** {} | object | | read-write | Link to a collection of Sessions. | | ||
| + | | } | | | | ||
| + | | **Managers** | reference([[documentation: | ||
| + | | **Name** | string | | read-write | A friendly name for this line of service. | | ||
| + | | **Oem** {} | object | | read-write | This is the manufacturer/ | ||
| + | | **RedfishVersion** | string | | read-only | The version of the Redfish service.\\ pattern: %%^%%\d+\.\d+\.\d+$ | | ||
| + | | **Registries** | reference([[documentation: | ||
| + | | **SessionService** | reference([[documentation: | ||
| + | | **StorageServices** | reference([[documentation: | ||
| + | | **StorageSystems** | reference([[documentation: | ||
| + | | **Systems** | reference([[documentation: | ||
| + | | **Tasks** | reference([[documentation: | ||
| + | | **UUID** | string | Yes | read-write | Unique identifier for a service instance. When SSDP is used, this value should be an exact match of the UUID value returned in a 200OK from an SSDP M-SEARCH request during discovery.\\ pattern: ([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}) | | ||
| + | | **UpdateService** | reference([[documentation: | ||
| - | == ConnectorType | + | === Property Details === |
| - | ^ string ^ | + | == CompletedTaskOverWritePolicy |
| - | | RJ45. | | + | |
| - | | RJ11. | | + | |
| - | | DB9 Female. | | + | |
| - | | DB9 Male. | | + | |
| - | | DB25 Female. | | + | |
| - | | DB25 Male. | | + | |
| - | | USB. | | + | |
| - | | mUSB. | | + | |
| - | | uUSB. | | + | |
| - | + | ||
| - | == DataBits == | + | |
| - | + | ||
| - | ^ string ^ | + | |
| - | | 5 | | + | |
| - | | 6 | | + | |
| - | | 7 | | + | |
| - | | 8 | | + | |
| - | + | ||
| - | == FlowControl | + | |
| ^ string ^ Description ^ | ^ string ^ Description ^ | ||
| - | | Hardware | + | | Manual |
| - | | None | No flow control imposed. | | + | | Oldest |
| - | | Software | XON/XOFF in-band flow control imposed. | | + | |
| - | + | ||
| - | == Parity == | + | |
| - | + | ||
| - | ^ string ^ | + | |
| - | | None | | + | |
| - | | Even | | + | |
| - | | Odd | | + | |
| - | | Mark | | + | |
| - | | Space | | + | |
| - | + | ||
| - | == PinOut == | + | |
| - | + | ||
| - | ^ string ^ | + | |
| - | | Cisco | | + | |
| - | | Cyclades | | + | |
| - | | Digi | | + | |
| - | + | ||
| - | == SignalType == | + | |
| - | + | ||
| - | ^ string ^ | + | |
| - | | Rs232 | | + | |
| - | | Rs485 | | + | |
| - | + | ||
| - | == StopBits == | + | |
| - | + | ||
| - | ^ string ^ | + | |
| - | | 1 | | + | |
| - | | 2 | | + | |
| - | + | ||
| - | + | ||
| - | ===== ServiceRoot ===== | + | |
| - | + | ||
| - | This object represents the root Redfish service. | + | |
| - | ^ Property ^ Type ^ Permission ^ Description ^ | ||
| - | | **[[documentation: | ||
| - | | **[[documentation: | ||
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
| - | | **[[documentation: | ||
| - | | **[[documentation: | ||
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
| - | | **[[documentation: | ||
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | ||
| - | | < | ||
| - | | < | ||
| - | | } | | ||
| - | | **[[documentation: | ||
| - | | **Name** | string | read-write | A friendly name for this line of service. | | ||
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
| - | | **RedfishVersion** | string | read-only | The version of the Redfish service.\\ pattern: ^\d+\.\d+\.\d+$ | | ||
| - | | **[[documentation: | ||
| - | | **[[documentation: | ||
| - | | **[[documentation: | ||
| - | | **[[documentation: | ||
| - | | **[[documentation: | ||
| - | | **[[documentation: | ||
| - | | **UUID** | string, null | read-write | Unique identifier for a service instance. When SSDP is used, this value should be an exact match of the UUID value returned in a 200OK from an SSDP M-SEARCH request during discovery.\\ pattern: ([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}) | | ||
| - | | **[[documentation: | ||
| ===== Session ===== | ===== Session ===== | ||
| Line 5188: | Line 3988: | ||
| 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Password** | string, null | read-only | This property is used in a POST to specify a password when creating a new session. | + | | **Password** | string |
| - | | **UserName** | string, null | read-only | The UserName for the account for this session. | | + | | **UserName** | string |
| ===== SessionCollection ===== | ===== SessionCollection ===== | ||
| Line 5200: | Line 4000: | ||
| A Collection of Session resource instances. | A Collection of Session resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | | | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| ===== SessionService ===== | ===== SessionService ===== | ||
| Line 5218: | Line 4010: | ||
| This is the schema definition for the Session Service. | This is the schema definition for the Session Service. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The Actions object contains the available custom actions on this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **ServiceEnabled** | boolean, null | read-write | This indicates whether this service is enabled. | | + | | **ServiceEnabled** | boolean |
| - | | **SessionTimeout** | number | read-write | This is the number of seconds of inactivity that a session may have before the session service closes the session due to inactivity.\\ unit: s\\ minimum: 30\\ maximum: 86400 | | + | | **SessionTimeout** | number |
| - | | **[[documentation: | + | | **Sessions** | reference([[documentation: |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| === Property Details === | === Property Details === | ||
| Line 5272: | Line 4064: | ||
| This is the schema definition for the Simple Storage resource. | This is the schema definition for the Simple Storage resource. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Devices** [ { | array | read-write | The storage devices associated with this resource. | | + | | **Devices** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **CapacityBytes** | number |
| - | | < | + | | \ \ \ \ \ \ **Manufacturer** | string |
| - | | < | + | | \ \ \ \ \ \ **Model** | string |
| - | | < | + | | \ \ \ \ \ \ **Name** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **Status** {} | object |
| - | | } ] | | + | | } ] | | | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| - | | **UefiDevicePath** | string, null | read-only | The UEFI device path used to access this storage controller. | | + | | **UefiDevicePath** | string |
| === Property Details === | === Property Details === | ||
| Line 5329: | Line 4121: | ||
| A Collection of SimpleStorage resource instances. | A Collection of SimpleStorage resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| ===== SoftwareInventory ===== | ===== SoftwareInventory ===== | ||
| Line 5348: | Line 4131: | ||
| This schema defines an inventory of software components. | This schema defines an inventory of software components. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The Actions object contains the available custom actions on this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **LowestSupportedVersion** | string, null | read-only | A string representing the lowest supported version of this software. | | + | | **LowestSupportedVersion** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **RelatedItem** [ {} ] | array | read-only | The ID(s) of the resources associated with this software inventory item. | | + | | **RelatedItem** [ {} ] | array | |
| - | | **[email protected]** | string | + | | **SoftwareId** | string | | read-only | A string representing the implementation-specific ID for identifying this software. | |
| - | | **SoftwareId** | string | + | | **Status** { | object |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | < | + | | } | | | |
| - | | } | | + | | **UefiDevicePaths** [ {} ] | array | |
| - | | **UefiDevicePaths** [ {} ] | array | read-only | A list of strings representing the UEFI Device Path(s) of the component(s) associated with this software inventory item. | | + | | **Updateable** | boolean |
| - | | **Updateable** | boolean, null | read-only | Indicates whether this software can be updated by the update service. | | + | | **Version** | string |
| - | | **Version** | string, null | read-only | A string representing the version of this software. | | + | |
| === Property Details === | === Property Details === | ||
| Line 5406: | Line 4188: | ||
| A Collection of SoftwareInventory resource instances. | A Collection of SoftwareInventory resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | + | |
| - | | **Name** | string | + | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | |
| ===== Storage ===== | ===== Storage ===== | ||
| Line 5431: | Line 4198: | ||
| This schema defines a storage subsystem and its respective properties. | This schema defines a storage subsystem and its respective properties. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Drives** | + | | **Drives** | array(reference([[documentation: |
| - | | < | + | | **Id** | string | | read-write | Uniquely identifies the resource within the collection of like resources. | |
| - | | < | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Enclosures** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | } | | | |
| - | | < | + | | **Name** | string |
| - | | < | + | | **Oem** {} | object |
| - | | < | + | | **Redundancy** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **MaxNumSupported** | number |
| - | | < | + | | \ \ \ \ \ \ **MemberId** | string |
| - | | < | + | | \ \ \ \ \ \ **MinNumNeeded** | number |
| - | | < | + | | \ \ \ \ \ \ **Mode** | string |
| - | | < | + | | \ \ \ \ \ \ **Name** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **RedundancySet** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Status** {} | object |
| - | | < | + | | \ \ \ \ \ \ **MemberId** | string |
| - | | < | + | | \ \ \ \ \ \ **RedundancyEnabled** | boolean |
| - | | < | + | | } ] | | | |
| - | | < | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | < | + | | } | | | |
| - | | < | + | | **StorageControllers** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **AssetTag** | string |
| - | | < | + | | \ \ \ \ \ \ **FirmwareVersion** | string |
| - | | < | + | | \ \ \ \ \ \ **Identifiers** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Links** {} | object |
| - | | < | + | | \ \ \ \ \ \ **Manufacturer** | string |
| - | | } ] | | + | | \ \ \ \ \ \ **MemberId** | string |
| - | | **[email protected]** | string | read-write | | | + | | \ \ \ \ \ \ **Model** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | \ \ \ \ \ \ **PartNumber** | string |
| - | | < | + | | \ \ \ \ \ \ **SKU** | string |
| - | | < | + | | \ \ \ \ \ \ **SerialNumber** | string |
| - | | < | + | | \ \ \ \ \ \ **SpeedGbps** | number |
| - | | } | | + | | \ \ \ \ \ \ **Status** {} | object |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | \ \ \ \ \ \ **SupportedControllerProtocols** [ {} ] | array | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | \ \ \ \ \ \ **SupportedDeviceProtocols** [ {} ] | array | |
| - | | **Redundancy** [ { | array | read-write | Redundancy information for the storage subsystem. | | + | | } ] | | | |
| - | | < | + | | **Volumes** | reference([[documentation: |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } | | + | |
| - | | **StorageControllers** [ { | array | read-only | The set of storage controllers represented by this resource. | | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | | | + | |
| - | | **[[documentation: | + | |
| === Property Details === | === Property Details === | ||
| Line 5612: | Line 4342: | ||
| A Collection of Storage resource instances. | A Collection of Storage resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | + | |
| - | | **Name** | string | + | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | |
| ===== StorageGroup ===== | ===== StorageGroup ===== | ||
| Line 5638: | Line 4352: | ||
| 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AccessState** | null | read-write | AccessState for this storage group. | | + | | **AccessState** | | Yes | read-write | AccessState for this storage group. | |
| - | | **Actions** { | object | read-only | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **[[documentation: | + | | **ClientEndpointGroups** | object | Yes | read-write | ClientEndpointGroup in this StorageGroup. | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Identifier** { | object, null | read-only | The value identifies this resource. | | + | | **Identifier** { | object |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | } | | + | | } | | | |
| - | | **Links** { | object | read-only | Contains links to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **ChildStorageGroups** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **ClassOfService** |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **ParentStorageGroups** [ {} ] | array | |
| - | | < | + | | } | | | |
| - | | < | + | | **MembersAreConsistent** | boolean |
| - | | } | | + | | **Name** | string |
| - | | **MembersAreConsistent** | boolean, null | read-only | Members are kept in a consistent state. | | + | | **Oem** {} | object |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **ReplicaInfos** [ { | array | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | \ \ \ \ \ \ **ConsistencyEnabled** | boolean |
| - | | **ReplicaInfos** [ { | array | read-only | Describes this storage group in its role as a source and/or target for replication. | | + | | \ \ \ \ \ \ **ConsistencyState** | string |
| - | | < | + | | \ \ \ \ \ \ **ConsistencyStatus** | string |
| - | | < | + | | \ \ \ \ \ \ **ConsistencyType** | string |
| - | | < | + | | \ \ \ \ \ \ **FailedCopyStopsHostIO** | boolean |
| - | | < | + | | \ \ \ \ \ \ **PercentSynced** | number |
| - | | < | + | | \ \ \ \ \ \ **Replica** | | Yes | read-write | The resource that is the source of this replica. | |
| - | | < | + | | \ \ \ \ \ \ **ReplicaPriority** | string |
| - | | < | + | | \ \ \ \ \ \ **ReplicaProgressStatus** | string |
| - | | < | + | | \ \ \ \ \ \ **ReplicaReadOnlyAccess** | string |
| - | | < | + | | \ \ \ \ \ \ **ReplicaRecoveryMode** | string |
| - | | < | + | | \ \ \ \ \ \ **ReplicaRole** | string |
| - | | < | + | | \ \ \ \ \ \ **ReplicaSkewBytes** | number |
| - | | < | + | | \ \ \ \ \ \ **ReplicaState** | string |
| - | | < | + | | \ \ \ \ \ \ **ReplicaType** | string |
| - | | < | + | | \ \ \ \ \ \ **ReplicaUpdateMode** | string |
| - | | < | + | | \ \ \ \ \ \ **RequestedReplicaState** | string |
| - | | < | + | | \ \ \ \ \ \ **SyncMaintained** | boolean |
| - | | < | + | | \ \ \ \ \ \ **UndiscoveredElement** | string |
| - | | < | + | | \ \ \ \ \ \ **WhenActivated** | string |
| - | | < | + | | \ \ \ \ \ \ **WhenDeactivated** | string |
| - | | < | + | | \ \ \ \ \ \ **WhenEstablished** | string |
| - | | < | + | | \ \ \ \ \ \ **WhenSuspended** | string |
| - | | < | + | | \ \ \ \ \ \ **WhenSynced** | string |
| - | | < | + | | \ \ \ \ \ \ **WhenSynchronized** | string |
| - | | < | + | | } ] | | | |
| - | | < | + | | **ServerEndpointGroups** | object | Yes | read-write | ServerEndpointGroups in this StorageGroup. | |
| - | | } ] | | + | | **Status** { | object |
| - | | **[[documentation: | + | | \ \ \ \ \ \ **Health** | string |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | < | + | | } | | | |
| - | | < | + | | **Volumes** | object | Yes | read-write | Volumes in this StorageGroup. | |
| - | | } | | + | | **VolumesAreExposed** | boolean |
| - | | **[[documentation: | + | |
| - | | **VolumesAreExposed** | boolean, null | read-only | Storage volumes are exposed to the Client Endpoints. | | + | |
| === Property Details === | === Property Details === | ||
| Line 5880: | Line 4592: | ||
| A Collection of StorageGroup resource instances. | A Collection of StorageGroup resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | + | |
| - | | **Name** | string | + | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | |
| ===== StoragePool ===== | ===== StoragePool ===== | ||
| Line 5907: | Line 4602: | ||
| A container of data storage. | A container of data storage. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **[[documentation: | + | | **AllocatedPools** | object | Yes | read-write | A reference to the collection of storage pools allocated from this storage pool. | |
| - | | **[[documentation: | + | | **AllocatedVolumes** | object | Yes | read-write | A reference to the collection of volumes allocated from this storage pool. | |
| - | | **BlockSizeBytes** | number, null | read-only | Maximum Block size in bytes.\\ unit: By | | + | | **BlockSizeBytes** | number |
| - | | **Capacity** { | object, null | read-write | Capacity utilization. | | + | | **Capacity** { | object |
| - | | < | + | | \ \ \ \ \ \ **Data** {} | object |
| - | | < | + | | \ \ \ \ \ \ **IsThinProvisioned** | boolean |
| - | | < | + | | \ \ \ \ \ \ **Metadata** {} | object |
| - | | < | + | | \ \ \ \ \ \ **Snapshot** {} | object |
| - | | } | | + | | } | | | |
| - | | **CapacitySources** [ { | array | read-only | An array of space allocations to this store. | | + | | **CapacitySources** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **ProvidedCapacity** {} | object |
| - | | < | + | | \ \ \ \ \ \ **ProvidedClassOfService** |
| - | | < | + | | \ \ \ \ \ \ **ProvidingDrives** |
| - | | < | + | | \ \ \ \ \ \ **ProvidingPools** |
| - | | < | + | | \ \ \ \ \ \ **ProvidingVolumes** |
| - | | } ] | | + | | } ] | | | |
| - | | **[[documentation: | + | | **ClassesOfService** | object | Yes | read-write | The ClassesOfService supported by this storage pool. | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Identifier** { | object, null | read-only | The value identifies this resource. | | + | | **Identifier** { | object |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | } | | + | | } | | | |
| - | | **Links** { | object | read-only | Contains links to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **DefaultClassOfService** |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **LowSpaceWarningThresholdPercents** [ {} ] | array | read-write | Low space warning threshold specified in percents. | | + | | **LowSpaceWarningThresholdPercents** [ {} ] | array | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| === Property Details === | === Property Details === | ||
| Line 5990: | Line 4685: | ||
| A Collection of StoragePool resource instances. | A Collection of StoragePool resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| ===== StorageService ===== | ===== StorageService ===== | ||
| Line 6016: | Line 4695: | ||
| 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-only | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **[[documentation: | + | | **ClassesOfService** | object | Yes | read-write | The ClassesOfService that all storage in this StorageService can support. | |
| - | | **[[documentation: | + | | **ClientEndpointGroups** | object | Yes | read-write | Client endpoint groups. | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **[[documentation: | + | | **Drives** | reference([[documentation: |
| - | | **[[documentation: | + | | **Endpoints** | object | Yes | read-write | Endpoints. | |
| - | | **[[documentation: | + | | **FileSystems** | reference([[documentation: |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Identifier** { | object, null | read-only | The value identifies this resource. | | + | | **Identifier** { | object |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | } | | + | | } | | | |
| - | | **Links** { | object | read-only | Contains links to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **DataProtectionLoSCapabilities** |
| - | | < | + | | \ \ \ \ \ \ **DataSecurityLoSCapabilities** |
| - | | < | + | | \ \ \ \ \ \ **DataStorageLoSCapabilities** |
| - | | < | + | | \ \ \ \ \ \ **DefaultClassOfService** |
| - | | < | + | | \ \ \ \ \ \ **HostingSystem** |
| - | | < | + | | \ \ \ \ \ \ **IOConnectivityLoSCapabilities** |
| - | | < | + | | \ \ \ \ \ \ **IOPerformanceLoSCapabilities** |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Redundancy** [ { | array | read-only | Redundancy information for the storage subsystem | | + | | **Redundancy** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **MaxNumSupported** | number |
| - | | < | + | | \ \ \ \ \ \ **MemberId** | string |
| - | | < | + | | \ \ \ \ \ \ **MinNumNeeded** | number |
| - | | < | + | | \ \ \ \ \ \ **Mode** | string |
| - | | < | + | | \ \ \ \ \ \ **Name** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **RedundancySet** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Status** {} | object |
| - | | < | + | | \ \ \ \ \ \ **MemberId** | string |
| - | | < | + | | \ \ \ \ \ \ **RedundancyEnabled** | boolean |
| - | | < | + | | } ] | | | |
| - | | } ] | | | | + | | **ServerEndpointGroups** | object | Yes | read-write | Server endpoint groups. | |
| - | | **[email protected]** | string | read-write | + | | **Status** { | object |
| - | | **[[documentation: | + | | \ \ \ \ \ \ **Health** | string |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | < | + | | } | | | |
| - | | < | + | | **StorageGroups** | object | Yes | read-write | StorageGroups. | |
| - | | } | | + | | **StoragePools** | reference([[documentation: |
| - | | **[[documentation: | + | | **Volumes** | reference([[documentation: |
| - | | **[[documentation: | + | |
| - | | **[[documentation: | + | |
| === Property Details === | === Property Details === | ||
| Line 6122: | Line 4799: | ||
| A collection of references to Storage Service resource instances. | A collection of references to Storage Service resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | | | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| ===== StorageSystemCollection ===== | ===== StorageSystemCollection ===== | ||
| Line 6153: | Line 4809: | ||
| A Collection of ComputerSystem resource instances that each have an entry in HostingRoles set to ' | A Collection of ComputerSystem resource instances that each have an entry in HostingRoles set to ' | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Name** | string | + | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | === Property Details === | + | |
| - | + | ||
| - | == IndicatorLED == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Blinking | The Indicator LED is blinking. | | + | |
| - | | Lit | The Indicator LED is lit. | | + | |
| - | | Off | The Indicator LED is off. | | + | |
| - | | Unknown | The state of the Indicator LED cannot be determined. Deprecated: Return null if state is unknown. | | + | |
| - | + | ||
| - | == PowerState == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Off | The system is powered off, although some components may continue to have AUX power such as management controller. | | + | |
| - | | On | The system is powered on. | | + | |
| - | | PoweringOff | A temporary state between On and Off. The power off action can take time while the OS is in the shutdown process. | | + | |
| - | | PoweringOn | A temporary state between Off and On. This temporary state can be very short. | | + | |
| - | + | ||
| - | == SystemType == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | OS | An operating system instance. | | + | |
| - | | Physical | A computer system. | | + | |
| - | | PhysicallyPartitioned | A hardware-based partition of a computer system. | | + | |
| - | | Virtual | A virtual machine instance running on this system. | | + | |
| - | | VirtuallyPartitioned | A virtual or software-based partition of a computer system. | | + | |
| ===== Switch ===== | ===== Switch ===== | ||
| Line 6232: | Line 4819: | ||
| Switch contains properties describing a simple fabric switch. | Switch contains properties describing a simple fabric switch. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **AssetTag** | string, null | read-write | The user assigned asset tag for this switch. | | + | | **AssetTag** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **DomainID** | number, null | read-only | The Domain ID for this switch. | | + | | **DomainID** | number |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **IndicatorLED** | string, null | read-write | The state of the indicator LED, used to identify the switch.\\ | + | | **IndicatorLED** | string |
| - | | **IsManaged** | boolean, null | read-write | This indicates whether the switch is in a managed or unmanaged state. | | + | | **IsManaged** | boolean |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Chassis** |
| - | | < | + | | \ \ \ \ \ \ **ManagedBy** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | } | | | |
| - | | } | | + | | **LogServices** | object | Yes | read-write | A reference to the collection of Log Services associated with this system. | |
| - | | **[[documentation: | + | | **Manufacturer** | string |
| - | | **Manufacturer** | string, null | read-only | This is the manufacturer of this switch. | | + | | **Model** | string |
| - | | **Model** | string, null | read-only | The product model number of this switch. | | + | | **Name** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Oem** {} | object |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **PartNumber** | string |
| - | | **PartNumber** | string, null | read-only | The part number for this switch. | | + | | **Ports** | reference([[documentation: |
| - | | **[[documentation: | + | | **PowerState** | string |
| - | | **PowerState** | string, null | read-write | This is the current power state of the switch.\\ | + | | **Redundancy** [ { | array | |
| - | | **Redundancy** [ { | array | read-write | Redundancy information for the switches. | | + | | \ \ \ \ \ \ **MaxNumSupported** | number |
| - | | < | + | | \ \ \ \ \ \ **MemberId** | string |
| - | | < | + | | \ \ \ \ \ \ **MinNumNeeded** | number |
| - | | < | + | | \ \ \ \ \ \ **Mode** | string |
| - | | < | + | | \ \ \ \ \ \ **Name** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **RedundancySet** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Status** {} | object |
| - | | < | + | | \ \ \ \ \ \ **MemberId** | string |
| - | | < | + | | \ \ \ \ \ \ **RedundancyEnabled** | boolean |
| - | | < | + | | } ] | | | |
| - | | < | + | | **SKU** | string |
| - | | } ] | | | | + | | **SerialNumber** | string |
| - | | **[email protected]** | string | read-write | + | | **Status** { | object |
| - | | **SKU** | string, null | read-only | This is the SKU for this switch. | | + | | \ \ \ \ \ \ **Health** | string |
| - | | **SerialNumber** | string, null | read-only | The serial number for this switch. | | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | < | + | | } | | | |
| - | | < | + | | **SwitchType** | | Yes | read-write | The protocol being sent over this switch. | |
| - | | < | + | | **TotalSwitchWidth** | number |
| - | | } | | + | |
| - | | **SwitchType** | null | read-write | The protocol being sent over this switch. | | + | |
| - | | **TotalSwitchWidth** | number, null | read-only | The total number of lanes, phys, or other physical transport links that this switch contains. | | + | |
| === Property Details === | === Property Details === | ||
| Line 6341: | Line 4925: | ||
| A Collection of Switch resource instances. | A Collection of Switch resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | + | |
| - | | **Name** | string | + | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | === Property Details === | + | |
| - | + | ||
| - | == IndicatorLED == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Blinking | The Indicator LED is blinking. | | + | |
| - | | Lit | The Indicator LED is lit. | | + | |
| - | | Off | The Indicator LED is off. | | + | |
| - | + | ||
| - | == PowerState == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Off | The state is powered Off. | | + | |
| - | | On | The state is powered On. | | + | |
| - | | PoweringOff | A temporary state between On and Off. | | + | |
| - | | PoweringOn | A temporary state between Off and On. | | + | |
| ===== Task ===== | ===== Task ===== | ||
| Line 6394: | Line 4935: | ||
| This resource contains information about a specific Task scheduled by or being executed by a Redfish service' | This resource contains information about a specific Task scheduled by or being executed by a Redfish service' | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **EndTime** | string | read-only | The date-time stamp that the task was last completed. | | + | | **EndTime** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Messages** [ {} ] | array | read-write | This is an array of messages associated with the task. | | + | | **Messages** [ {} ] | array | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **StartTime** | string | read-only | The date-time stamp that the task was last started. | | + | | **StartTime** | string |
| - | | **TaskState** | string | read-write | The state of the task.\\ | + | | **TaskState** | string |
| - | | **TaskStatus** | string | read-write | This is the completion status of the task.\\ | + | | **TaskStatus** | string |
| === Property Details === | === Property Details === | ||
| Line 6434: | Line 4975: | ||
| A Collection of Task resource instances. | A Collection of Task resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| - | + | ||
| - | === Property Details === | + | |
| - | + | ||
| - | == TaskState == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Completed | Task has completed. | | + | |
| - | | Exception | Task has stopped due to an exception condition. | | + | |
| - | | Interrupted | Task has been interrupted. | | + | |
| - | | Killed | Task was terminated. | | + | |
| - | | New | A new task. | | + | |
| - | | Pending | Task is pending and has not started. | | + | |
| - | | Running | Task is running normally. | | + | |
| - | | Service | Task is running as a service. | | + | |
| - | | Starting | Task is starting. | | + | |
| - | | Stopping | Task is in the process of stopping. | | + | |
| - | | Suspended | Task has been suspended. | | + | |
| - | + | ||
| - | == TaskStatus == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Critical | A critical condition exists that requires immediate attention. | | + | |
| - | | OK | Normal. | | + | |
| - | | Warning | A condition exists that requires attention. | | + | |
| ===== TaskService ===== | ===== TaskService ===== | ||
| Line 6480: | Line 4985: | ||
| This is the schema definition for the Task Service. | This is the schema definition for the Task Service. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **CompletedTaskOverWritePolicy** | string | read-write | Overwrite policy of completed tasks.\\ | + | | **CompletedTaskOverWritePolicy** | string |
| - | | **DateTime** | string, null | read-only | The current DateTime (with offset) setting that the task service is using. | | + | | **DateTime** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **LifeCycleEventOnTaskStateChange** | boolean | read-only | Send an Event upon Task State Change. | | + | | **LifeCycleEventOnTaskStateChange** | boolean |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **ServiceEnabled** | boolean, null | read-write | This indicates whether this service is enabled. | | + | | **ServiceEnabled** | boolean |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| - | | **[[documentation: | + | | **Tasks** | reference([[documentation: |
| === Property Details === | === Property Details === | ||
| Line 6539: | Line 5044: | ||
| This is the schema definition for the Thermal properties. | This is the schema definition for the Thermal properties. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Fans** [ { | array | read-write | This is the definition for fans. | | + | | **Fans** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **FanName** | string |
| - | | < | + | | \ \ \ \ \ \ **IndicatorLED** | string |
| - | | < | + | | \ \ \ \ \ \ **LowerThresholdCritical** | number |
| - | | < | + | | \ \ \ \ \ \ **LowerThresholdFatal** | number |
| - | | < | + | | \ \ \ \ \ \ **LowerThresholdNonCritical** | number |
| - | | < | + | | \ \ \ \ \ \ **Manufacturer** | string |
| - | | < | + | | \ \ \ \ \ \ **MaxReadingRange** | number |
| - | | < | + | | \ \ \ \ \ \ **MemberId** | string |
| - | | < | + | | \ \ \ \ \ \ **MinReadingRange** | number |
| - | | < | + | | \ \ \ \ \ \ **Model** | string |
| - | | < | + | | \ \ \ \ \ \ **Name** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **PartNumber** | string |
| - | | < | + | | \ \ \ \ \ \ **PhysicalContext** | string |
| - | | < | + | | \ \ \ \ \ \ **Reading** | number |
| - | | < | + | | \ \ \ \ \ \ **ReadingUnits** | string |
| - | | < | + | | \ \ \ \ \ \ **Redundancy** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **RelatedItem** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **SerialNumber** | string |
| - | | < | + | | \ \ \ \ \ \ **SparePartNumber** | string |
| - | | < | + | | \ \ \ \ \ \ **Status** {} | object |
| - | | < | + | | \ \ \ \ \ \ **UpperThresholdCritical** | number |
| - | | < | + | | \ \ \ \ \ \ **UpperThresholdFatal** | number |
| - | | < | + | | \ \ \ \ \ \ **UpperThresholdNonCritical** | number |
| - | | < | + | | } ] | | | |
| - | | < | + | | **Id** | string |
| - | | } ] | | | | + | | **Name** | string |
| - | | **[email protected]** | string | read-write | + | | **Oem** {} | object |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Redundancy** [ { | array | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | \ \ \ \ \ \ **MaxNumSupported** | number |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | \ \ \ \ \ \ **MemberId** | string |
| - | | **Redundancy** [ { | array | read-write | This structure is used to show redundancy for fans. The Component ids will reference the members of the redundancy groups. | | + | | \ \ \ \ \ \ **MinNumNeeded** | number |
| - | | < | + | | \ \ \ \ \ \ **Mode** | string |
| - | | < | + | | \ \ \ \ \ \ **Name** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **RedundancySet** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Status** {} | object |
| - | | < | + | | \ \ \ \ \ \ **MemberId** | string |
| - | | < | + | | \ \ \ \ \ \ **RedundancyEnabled** | boolean |
| - | | < | + | | } ] | | | |
| - | | < | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | } ] | | | | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | **[email protected]** | string | read-write | + | | \ \ \ \ \ \ **State** | string |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | } | | | |
| - | | < | + | | **Temperatures** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **LowerThresholdCritical** | number |
| - | | < | + | | \ \ \ \ \ \ **LowerThresholdFatal** | number |
| - | | < | + | | \ \ \ \ \ \ **LowerThresholdNonCritical** | number |
| - | | } | | + | | \ \ \ \ \ \ **MaxReadingRangeTemp** | number |
| - | | **Temperatures** [ { | array | read-write | This is the definition for temperature sensors. | | + | | \ \ \ \ \ \ **MemberId** | string |
| - | | < | + | | \ \ \ \ \ \ **MinReadingRangeTemp** | number |
| - | | < | + | | \ \ \ \ \ \ **Name** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **PhysicalContext** | string |
| - | | < | + | | \ \ \ \ \ \ **ReadingCelsius** | number |
| - | | < | + | | \ \ \ \ \ \ **RelatedItem** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **SensorNumber** | number |
| - | | < | + | | \ \ \ \ \ \ **Status** {} | object |
| - | | < | + | | \ \ \ \ \ \ **UpperThresholdCritical** | number |
| - | | < | + | | \ \ \ \ \ \ **UpperThresholdFatal** | number |
| - | | < | + | | \ \ \ \ \ \ **UpperThresholdNonCritical** | number |
| - | | < | + | | } ] | | | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | | | + | |
| - | | **[email protected]** | string | read-write | + | |
| === Property Details === | === Property Details === | ||
| Line 6695: | Line 5193: | ||
| 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The Actions object contains the available custom actions on this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **[[documentation: | + | | **FirmwareInventory** | object | Yes | read-write | An inventory of firmware. | |
| - | | **HttpPushUri** | string | read-only | The URI used to perform an HTTP or HTTPS push update to the Update Service. | | + | | **HttpPushUri** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **ServiceEnabled** | boolean, null | read-write | This indicates whether this service is enabled. | | + | | **ServiceEnabled** | boolean |
| - | | **[[documentation: | + | | **SoftwareInventory** | object | Yes | read-write | An inventory of software. | |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| === Property Details === | === Property Details === | ||
| Line 6751: | Line 5249: | ||
| 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **VLANEnable** | boolean, null | read-write | This indicates if this VLAN is enabled. | | + | | **VLANEnable** | boolean |
| - | | **VLANId** | number, null | read-write | This indicates the VLAN identifier for this VLAN.\\ maximum: 4094 | | + | | **VLANId** | number |
| ===== VLanNetworkInterfaceCollection ===== | ===== VLanNetworkInterfaceCollection ===== | ||
| Line 6763: | Line 5261: | ||
| A Collection of VLanNetworkInterface resource instances. | A Collection of VLanNetworkInterface resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| ===== VirtualMedia ===== | ===== VirtualMedia ===== | ||
| Line 6781: | Line 5271: | ||
| 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **ConnectedVia** | string, null | read-write | Current virtual media connection methods.\\ | + | | **ConnectedVia** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Image** | string, null | read-only | A URI providing the location of the selected image. | | + | | **Image** | string |
| - | | **ImageName** | string, null | read-only | The current image name. | | + | | **ImageName** | string |
| - | | **Inserted** | boolean, null | read-only | Indicates if virtual media is inserted in the virtual device. | | + | | **Inserted** | boolean |
| - | | **MediaTypes** [ {} ] | array | read-only | This is the media types supported as virtual media. | | + | | **MediaTypes** [ {} ] | array | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **WriteProtected** | boolean, null | read-only | Indicates the media is write protected. | | + | | **WriteProtected** | boolean |
| === Property Details === | === Property Details === | ||
| Line 6808: | Line 5298: | ||
| A Collection of VirtualMedia resource instances. | A Collection of VirtualMedia resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| - | + | ||
| - | === Property Details === | + | |
| - | + | ||
| - | == ConnectedVia == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Applet | Connected to a client application. | | + | |
| - | | NotConnected | No current connection. | | + | |
| - | | Oem | Connected via an OEM-defined method. | | + | |
| - | | URI | Connected to a URI location. | | + | |
| ===== Volume ===== | ===== Volume ===== | ||
| Line 6841: | Line 5308: | ||
| 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. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AccessCapabilities** [ {} ] | array | read-write | Supported IO access capabilities. | | + | | **AccessCapabilities** [ {} ] | array | |
| - | | **Actions** { | object | read-only | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **AllocatedPools** | + | | **AllocatedPools** | array(reference([[documentation: |
| - | | < | + | | **BlockSizeBytes** | number |
| - | | < | + | | **Capacity** { | object |
| - | | < | + | | \ \ \ \ \ \ **Data** {} | object |
| - | | < | + | | \ \ \ \ \ \ **IsThinProvisioned** | boolean |
| - | | < | + | | \ \ \ \ \ \ **Metadata** {} | object |
| - | | < | + | | \ \ \ \ \ \ **Snapshot** {} | object |
| - | | < | + | | } | | | |
| - | | < | + | | **CapacityBytes** | number |
| - | | < | + | | **CapacitySources** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **ProvidedCapacity** {} | object |
| - | | < | + | | \ \ \ \ \ \ **ProvidedClassOfService** |
| - | | < | + | | \ \ \ \ \ \ **ProvidingDrives** |
| - | | < | + | | \ \ \ \ \ \ **ProvidingPools** |
| - | | < | + | | \ \ \ \ \ \ **ProvidingVolumes** |
| - | | } ] | | + | | } ] | | | |
| - | | **[email protected]** | string | read-write | | + | | **Description** | string |
| - | | **BlockSizeBytes** | number, null | read-only | The size of the smallest addressable unit (Block) of this volume in bytes\\ unit: By | | + | | **Encrypted** | boolean |
| - | | **Capacity** { | object, null | read-write | Capacity utilization. | | + | | **EncryptionTypes** [ {} ] | array | |
| - | | < | + | | **Id** | string |
| - | | < | + | | **Identifiers** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | } | | + | | } ] | | | |
| - | | **CapacityBytes** | number, null | read-only | The size in bytes of this Volume\\ unit: By | | + | | **Links** { | object |
| - | | **CapacitySources** [ { | array | read-write | An array of space allocations to this volume. | | + | | \ \ \ \ \ \ **ClassOfService** |
| - | | < | + | | \ \ \ \ \ \ **Drives** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | } | | | |
| - | | < | + | | **LowSpaceWarningThresholdPercents** [ {} ] | array | |
| - | | < | + | | **Manufacturer** | string |
| - | | } ] | | + | | **MaxBlockSizeBytes** | number |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Model** | string |
| - | | **Encrypted** | boolean, null | read-write | Is this Volume encrypted | | + | | **Name** | string |
| - | | **EncryptionTypes** [ {} ] | array | read-write | The types of encryption used by this Volume | | + | | **Oem** {} | object |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Operations** [ { | array | |
| - | | **Identifiers** [ { | array | read-only | The Durable names for the volume | | + | | \ \ \ \ \ \ **AssociatedTask** |
| - | | < | + | | \ \ \ \ \ \ **OperationName** | string |
| - | | < | + | | \ \ \ \ \ \ **PercentageComplete** | number |
| - | | } ] | | + | | } ] | | | |
| - | | **Links** { | object | read-only | Contains references to other resources that are related to this resource. | | + | | **OptimumIOSizeBytes** | number |
| - | | < | + | | **ReplicaInfos** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **ConsistencyEnabled** | boolean |
| - | | < | + | | \ \ \ \ \ \ **ConsistencyState** | string |
| - | | < | + | | \ \ \ \ \ \ **ConsistencyStatus** | string |
| - | | } | | + | | \ \ \ \ \ \ **ConsistencyType** | string |
| - | | **LowSpaceWarningThresholdPercents** [ {} ] | array | read-write | Low space warning. | | + | | \ \ \ \ \ \ **FailedCopyStopsHostIO** | boolean |
| - | | **Manufacturer** | string, null | read-only | The manufacturer or OEM of this storage volume. | | + | | \ \ \ \ \ \ **PercentSynced** | number |
| - | | **MaxBlockSizeBytes** | number, null | read-only | Max Block size in bytes .\\ unit: By | | + | | \ \ \ \ \ \ **Replica** | | Yes | read-write | The resource that is the source of this replica. | |
| - | | **Model** | string, null | read-only | The model number for this storage volume | | + | | \ \ \ \ \ \ **ReplicaPriority** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | \ \ \ \ \ \ **ReplicaProgressStatus** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | \ \ \ \ \ \ **ReplicaReadOnlyAccess** | string |
| - | | **Operations** [ { | array | read-only | The operations currently running on the Volume | | + | | \ \ \ \ \ \ **ReplicaRecoveryMode** | string |
| - | | < | + | | \ \ \ \ \ \ **ReplicaRole** | string |
| - | | < | + | | \ \ \ \ \ \ **ReplicaSkewBytes** | number |
| - | | < | + | | \ \ \ \ \ \ **ReplicaState** | string |
| - | | } ] | | + | | \ \ \ \ \ \ **ReplicaType** | string |
| - | | **OptimumIOSizeBytes** | number, null | read-only | The size in bytes of this Volume' | + | | \ \ \ \ \ \ **ReplicaUpdateMode** | string |
| - | | **ReplicaInfos** [ { | array | read-only | Describes this storage volume in its role as a source and/or target replica. | | + | | \ \ \ \ \ \ **RequestedReplicaState** | string |
| - | | < | + | | \ \ \ \ \ \ **SyncMaintained** | boolean |
| - | | < | + | | \ \ \ \ \ \ **UndiscoveredElement** | string |
| - | | < | + | | \ \ \ \ \ \ **WhenActivated** | string |
| - | | < | + | | \ \ \ \ \ \ **WhenDeactivated** | string |
| - | | < | + | | \ \ \ \ \ \ **WhenEstablished** | string |
| - | | < | + | | \ \ \ \ \ \ **WhenSuspended** | string |
| - | | < | + | | \ \ \ \ \ \ **WhenSynced** | string |
| - | | < | + | | \ \ \ \ \ \ **WhenSynchronized** | string |
| - | | < | + | | } ] | | | |
| - | | < | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | < | + | | } | | | |
| - | | < | + | | **StorageGroups** | array(reference([[documentation: |
| - | | < | + | | **VolumeType** | string | Yes | read-write | The type of this volume\\ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } | | + | |
| - | | **StorageGroups** | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | | | + | |
| - | | **VolumeType** | string, null | read-write | The type of this volume\\ | + | |
| === Property Details === | === Property Details === | ||
| Line 7148: | Line 5581: | ||
| A Collection of Volume resource instances. | A Collection of Volume resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation:redfish_api:schema_definition# |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | | | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |
| - | + | ||
| - | === Property Details === | + | |
| - | + | ||
| - | == VolumeType == | + | |
| - | + | ||
| - | ^ string ^ Description ^ | + | |
| - | | Mirrored | The volume is a mirrored device | | + | |
| - | | NonRedundant | The volume is a non-redundant storage device | | + | |
| - | | RawDevice | The volume is a raw physical device without any RAID or other virtualization applied | | + | |
| - | | SpannedMirrors | The volume is a spanned set of mirrored devices | | + | |
| - | | SpannedStripesWithParity | The volume is a spanned set of devices which uses parity to retain redundant information | | + | |
| - | | StripedWithParity | The volume is a device which uses parity to retain redundant information | | + | |
| ===== Zone ===== | ===== Zone ===== | ||
| Line 7200: | Line 5591: | ||
| Switch contains properties describing a simple fabric zone. | Switch contains properties describing a simple fabric zone. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Endpoints** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **InvolvedSwitches** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | } | | | |
| - | | < | + | | **Name** | string |
| - | | } | | + | | **Oem** {} | object |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Status** { | object |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | \ \ \ \ \ \ **Health** | string |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | < | + | | } | | | |
| - | | < | + | |
| - | | } | | + | |
| === Property Details === | === Property Details === | ||
| Line 7255: | Line 5644: | ||
| A Collection of Zone resource instances. | A Collection of Zone resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** | + | | **Members** | array(reference([[documentation: |
| - | | < | + | | **Name** | string | | read-write | A friendly name for this line of service. | |
| - | | < | + | | **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | < | + | |
| - | | } ] | | + | |
| - | | **[email protected]** | string | read-write | + | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | + | |