meta data for this page
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
| documentation:redfish_api:schema_definition [2017/04/27 12:10] – bil | documentation:redfish_api:schema_definition [2017/04/28 05:52] – old revision restored bil | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Schema Definition ====== | ||
| - | + | ====== AccountService | |
| - | ===== AccountService ===== | + | |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **AccountLockoutCounterResetAfter** | number | + | | --- | --- | --- | |
| - | | **AccountLockoutDuration** | number | + | | **AccountLockoutCounterResetAfter** | number\\ (s)\\ \\ *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. | |
| - | | **AccountLockoutThreshold** | number | + | | **AccountLockoutDuration** | number, null\\ (s)\\ \\ *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. | |
| - | | **Accounts** | reference([[documentation: | + | | **AccountLockoutThreshold** | number, null\\ \\ *read-write* | The number of failed login attempts before a user account is locked for a specified duration (0=never locked). | |
| - | | **AuthFailureLoggingThreshold** | number | + | | **Accounts** |
| - | | **Description** | string | + | | < |
| - | | **Id** | string | + | | < |
| - | | **MaxPasswordLength** | number | + | | < |
| - | | **MinPasswordLength** | number | + | | < |
| - | | **Name** | string | + | | < |
| - | | **Oem** {} | object | + | | } | |
| - | | **PrivilegeMap** | + | | **AuthFailureLoggingThreshold** | number\\ \\ *read-write* |
| - | | **Roles** | reference([[documentation: | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **ServiceEnabled** | boolean | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Status** { | object | + | | **MaxPasswordLength** | number\\ \\ *read-only* | This is the maximum password length for this service. | |
| - | | \ \ \ \ \ \ **Health** | string | + | | **MinPasswordLength** | number\\ \\ *read-only* | This is the minimum password length for this service. | |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | **Name** | string\\ \\ *read-write* | The name of the resource or array element. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | \ \ \ \ \ \ **State** | string | + | | **PrivilegeMap** |
| - | | } | | | | + | | < |
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Roles** { | object\\ \\ *read-write* | Link to a collection of Roles. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **ServiceEnabled** | boolean, null\\ \\ *read-write* | ||
| + | | **Status** { | object\\ \\ *read-only* | | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 60: | Line 82: | ||
| - | ===== ActionInfo ===== | + | ====== ActionInfo |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Description** | string | + | | --- | --- | --- | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Name** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | The name of the resource or array element. | |
| - | | **Parameters** [ { | array | | read-write | The parameters associated with the specified Redfish Action. | | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | \ \ \ \ \ \ **AllowableValues** [ {} ] | array | | read-only | A list of values for this parameter supported by this Action target. | | + | | **Parameters** [ { | array\\ \\ *read-write* | The parameters associated with the specified Redfish Action. | |
| - | | \ \ \ \ \ \ **DataType** | string | + | | < |
| - | | \ \ \ \ \ \ **Name** | string | + | | < |
| - | | \ \ \ \ \ \ **ObjectDataType** | string | + | | < |
| - | | \ \ \ \ \ \ **Required** | boolean | + | | < |
| - | | } ] | | | | + | | < |
| + | | } ] | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == DataType == | + | ==== DataType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Boolean | A boolean (true or false). | | | Boolean | A boolean (true or false). | | ||
| | Number | A number. | | | Number | A number. | | ||
| Line 91: | Line 115: | ||
| - | ===== AttributeRegistry ===== | + | ====== AttributeRegistry |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Description** | string | + | | --- | --- | --- | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Language** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Name** | string | + | | **Language** | string\\ \\ *read-only* | This is the RFC 5646 compliant language code for the registry. | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | The name of the resource or array element. | |
| - | | **OwningEntity** | string | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **RegistryEntries** { | object | + | | **OwningEntity** | string\\ \\ *read-only* | This is the organization or company that publishes this registry. | |
| - | | \ \ \ \ \ \ **Attributes** [ {} ] | array | | read-write | The array containing the attributes and their possible values. | | + | | **RegistryEntries** { | object\\ \\ *read-write* | List of all attributes and their metadata for this component. | |
| - | | \ \ \ \ \ \ **Dependencies** [ {} ] | array | | read-write | The array containing a list of dependencies of attributes on this component. | | + | | < |
| - | | \ \ \ \ \ \ **Menus** [ {} ] | array | | read-write | The array containing the attributes menus and their hierarchy. | | + | | < |
| - | | } | | | | + | | < |
| - | | **RegistryVersion** | string | + | | } | |
| - | | **SupportedSystems** [ { | array | | read-write | Array of systems supported by this attribute registry. | | + | | **RegistryVersion** | string\\ \\ *read-only* | This is the attribute registry version which is used in the middle portion of a AttributeRegistry. | |
| - | | \ \ \ \ \ \ **ProductName** | string | + | | **SupportedSystems** [ { | array\\ \\ *read-write* | Array of systems supported by this attribute registry. | |
| - | | \ \ \ \ \ \ **SystemId** | string | + | | < |
| - | | } ] | | | | + | | < |
| + | | } ] | | ||
| - | ===== Bios ===== | + | ====== Bios 1.0.1 ====== |
| Bios contains properties surrounding a BIOS Attribute Registry (where the system-specific BIOS attributes are described) and the Actions needed to perform changes to BIOS settings, which typically require a system reset to apply. | Bios contains properties surrounding a BIOS Attribute Registry (where the system-specific BIOS attributes are described) and the Actions needed to perform changes to BIOS settings, which typically require a system reset to apply. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Actions** { | object | + | | --- | --- | --- | |
| - | | \ \ \ \ \ \ **# | + | | **Actions** { | object\\ \\ *read-write* | The available actions for this resource. | |
| - | | \ \ \ \ \ \ **# | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **AttributeRegistry** | string | + | | } | |
| - | | **Attributes** {} | object | + | | **AttributeRegistry** | string, null\\ \\ *read-only* | The Resource ID of the Attribute Registry for the BIOS Attributes resource. | |
| - | | **Description** | string | + | | **Attributes** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Name** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | The name of the resource or array element. | |
| + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ | ||
| - | ===== Chassis ===== | + | ====== Chassis |
| A Chassis represents the physical components for any system. | A Chassis represents the physical components for any system. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Actions** { | object | + | | --- | --- | --- | |
| - | | \ \ \ \ \ \ **# | + | | **Actions** { | object\\ \\ *read-write* | The available actions for this resource. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **AssetTag** | string | + | | } | |
| - | | **ChassisType** | string | + | | **AssetTag** | string, null\\ \\ *read-write* | The user assigned asset tag for this chassis. | |
| - | | **DepthMm** | number | + | | **ChassisType** | string\\ \\ *read-write* | This property indicates the type of physical form factor of this resource. |
| - | | **Description** | string | + | | **DepthMm** *(v1.4+)* | number, null\\ (mm)\\ \\ *read-only* | The depth of the chassis. | |
| - | | **HeightMm** | number | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Id** | string | + | | **HeightMm** *(v1.4+)* | number, null\\ (mm)\\ \\ *read-only* | The height of the chassis. | |
| - | | **IndicatorLED** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Links** { | object | + | | **IndicatorLED** | string, null\\ \\ *read-write* | The state of the indicator LED, used to identify the chassis. |
| - | | \ \ \ \ \ \ **ComputerSystems** [ {} ] | array | | read-only | An array of references to the computer systems contained in this chassis. | + | | **Links** { | object\\ \\ *read-write* | Contains references to other resources that are related to this resource. | |
| - | | \ \ \ \ \ \ **ContainedBy** {} | object | + | | < |
| - | | \ \ \ \ \ \ **Contains** [ {} ] | array | | read-only | An array of references to any other chassis that this chassis has in it. | | + | | < |
| - | | \ \ \ \ \ \ **CooledBy** [ {} ] | array | | read-only | An array of ID[s] of resources that cool this chassis. Normally the ID will be a chassis or a specific set of fans. | | + | | < |
| - | | \ \ \ \ \ \ **Drives** [ {} ] | array | | read-only | An array of references to the disk drives located in this Chassis. | | + | | < |
| - | | \ \ \ \ \ \ **ManagedBy** [ {} ] | array | | read-only | An array of references to the Managers responsible for managing this chassis. | | + | | < |
| - | | \ \ \ \ \ \ **ManagersInChassis** [ {} ] | array | | read-only | An array of references to the managers located in this Chassis. | | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **PCIeDevices** [ {} ] | array | | read-only | An array of references to the PCIe Devices located in this Chassis. | | + | | < |
| - | | \ \ \ \ \ \ **PoweredBy** [ {} ] | array | | read-only | An array of ID[s] of resources that power this chassis. Normally the ID will be a chassis or a specific set of Power Supplies. | | + | | < |
| - | | \ \ \ \ \ \ **Storage** [ {} ] | array | | read-only | An array of references to the storage subsystems connected to or inside this Chassis. | | + | | < |
| - | | } | | | | + | | < |
| - | | **Location** { | object | + | | < |
| - | | \ \ \ \ \ \ **Info** | string | + | | < |
| - | | \ \ \ \ \ \ **InfoFormat** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **LogServices** | reference([[documentation: | + | | < |
| - | | **Manufacturer** | string | Yes | read-only | This is the manufacturer of this chassis. | | + | | < |
| - | | **Model** | string | + | | < |
| - | | **Name** | string | + | | < |
| - | | **NetworkAdapters** | + | | } | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | | **Location** *(v1.2+)* { | object\\ \\ *read-only* | | |
| - | | **PartNumber** | string | + | | < |
| - | | **PhysicalSecurity** { | object | + | | < |
| - | | \ \ \ \ \ \ **IntrusionSensor** | string | + | | < |
| - | | \ \ \ \ \ \ **IntrusionSensorNumber** | number | + | | } | |
| - | | \ \ \ \ \ \ **IntrusionSensorReArm** | string | + | | **LogServices** |
| - | | } | | | | + | | < |
| - | | **Power** | reference([[documentation: | + | | < |
| - | | **PowerState** | string | Yes | read-write | This is the current power state of the chassis.\\ //See Property Details, below, for more information about this property.// | | + | | < |
| - | | **SKU** | string | + | | < |
| - | | **SerialNumber** | string | + | | < |
| - | | **Status** { | object | + | | } | |
| - | | \ \ \ \ \ \ **Health** | string | + | | **Manufacturer** | string, null\\ \\ *read-only* |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | **Model** | string, null\\ \\ *read-only* | This is the model number for the chassis. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | The name of the resource or array element. | |
| - | | \ \ \ \ \ \ **State** | string | + | | **NetworkAdapters** |
| - | | } | | | | + | | < |
| - | | **Thermal** | reference([[documentation: | + | | < |
| - | | **WeightKg** | number | + | | < |
| - | | **WidthMm** | number | + | | < |
| + | | < | ||
| + | | } | | ||
| + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ | ||
| + | | **PartNumber** | string, null\\ \\ *read-only* | The part number for this chassis. | | ||
| + | | **PhysicalSecurity** *(v1.1+)* { | object\\ \\ *read-write* | The state of the physical security sensor. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Power** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **PowerState** *(v1.0+)* | string, null\\ \\ *read-write* | ||
| + | | **SKU** | string, null\\ \\ *read-only* | This is the SKU for this chassis. | | ||
| + | | **SerialNumber** | string, null\\ \\ *read-only* | The serial number for this chassis. | | ||
| + | | **Status** { | object\\ \\ *read-only* | | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Thermal** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **WeightKg** *(v1.4+)* | number, null\\ (kg)\\ \\ *read-only* | ||
| + | | **WidthMm** *(v1.4+)* | number, null\\ (mm)\\ \\ *read-only* | The width of the chassis. | ||
| - | === Property Details === | + | ===== Property Details |
| - | == ChassisType == | + | ==== ChassisType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Blade | An enclosed or semi-enclosed, | | Blade | An enclosed or semi-enclosed, | ||
| | Card | A loose device or circuit board intended to be installed in a system or other enclosure. | | | Card | A loose device or circuit board intended to be installed in a system or other enclosure. | | ||
| Line 216: | Line 290: | ||
| | Zone | A logical division or portion of a physical chassis that contains multiple devices or systems that cannot be physically separated. | | | Zone | A logical division or portion of a physical chassis that contains multiple devices or systems that cannot be physically separated. | | ||
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == IndicatorLED == | + | ==== IndicatorLED: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Blinking | The Indicator LED is blinking. | | | Blinking | The Indicator LED is blinking. | | ||
| | Lit | The Indicator LED is lit. | | | Lit | The Indicator LED is lit. | | ||
| Line 238: | Line 315: | ||
| | Unknown | The state of the Indicator LED cannot be determined. Deprecated: Return null if state is unknown. | | | Unknown | The state of the Indicator LED cannot be determined. Deprecated: Return null if state is unknown. | | ||
| - | == IntrusionSensor == | + | ==== IntrusionSensor: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | HardwareIntrusion | A door, lock, or other mechanism protecting the internal system hardware from being accessed is detected as being in an insecure state. | | | HardwareIntrusion | A door, lock, or other mechanism protecting the internal system hardware from being accessed is detected as being in an insecure state. | | ||
| | Normal | No abnormal physical security conditions are detected at this time. | | | Normal | No abnormal physical security conditions are detected at this time. | | ||
| | TamperingDetected | Physical tampering of the monitored entity is detected. | | | TamperingDetected | Physical tampering of the monitored entity is detected. | | ||
| - | == IntrusionSensorReArm == | + | ==== IntrusionSensorReArm: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Automatic | This sensor would be restored to the Normal state automatically as no abnormal physical security conditions are detected. | | | Automatic | This sensor would be restored to the Normal state automatically as no abnormal physical security conditions are detected. | | ||
| | Manual | This sensor would be restored to the Normal state by a manual re-arm. | | | Manual | This sensor would be restored to the Normal state by a manual re-arm. | | ||
| - | == PowerState == | + | ==== PowerState: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Off | The components within the chassis has no power, except some components may continue to have AUX power such as management controller. | | | 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. | | | On | The components within the chassis has power on. | | ||
| Line 259: | Line 339: | ||
| | PoweringOn | A temporary state between Off and On. The components within the chassis can take time to process the power on action. | | | PoweringOn | A temporary state between Off and On. The components within the chassis can take time to process the power on action. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 275: | Line 356: | ||
| - | ===== ChassisCollection | + | ====== |
| - | + | ||
| - | A Collection of Chassis resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | The name of the resource or array element. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== ClassOfService | + | |
| A service option composed of one or more service options. | A service option composed of one or more service options. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **ClassOfServiceVersion** | string | + | | --- | --- | --- | |
| - | | **Description** | string | + | | **ClassOfServiceVersion** | string, null\\ \\ *read-write* | The value identifies the current version of this class of service definition. | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Identifier** { | object | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **DurableName** | string | + | | **Identifier** { | object, null\\ \\ *read-only* | The value identifies this resource. | |
| - | | \ \ \ \ \ \ **DurableNameFormat** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **LinesOfService** { | object | + | | } | |
| - | | \ \ \ \ \ \ **DataProtectionLinesOfService** [ {} ] | array | | read-write | A collection of DataProtection lines of service elements. | | + | | **LinesOfService** { | object, null\\ \\ *read-write* | Lines of Service that define the required choices of utility or warranty. | |
| - | | \ \ \ \ \ \ **DataSecurityLinesOfService** [ {} ] | array | | read-write | A collection of DataSecurity lines of service elements. | | + | | < |
| - | | \ \ \ \ \ \ **DataStorageLinesOfService** [ {} ] | array | | read-write | A collection of DataStorage lines of service elements. | | + | | < |
| - | | \ \ \ \ \ \ **IOConnectivityLinesOfService** [ {} ] | array | | read-write | A collection of IOConnectivity lines of service elements. | | + | | < |
| - | | \ \ \ \ \ \ **IOPerformanceLinesOfService** [ {} ] | array | | read-write | A collection of IOPerformance lines of service elements. | | + | | < |
| - | | } | | | | + | | < |
| - | | **Name** | string | + | | } | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | The name of the resource or array element. | |
| + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ | ||
| - | === Property Details === | + | ===== Property Details |
| - | == DurableNameFormat == | + | ==== DurableNameFormat: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | EUI | IEEE-defined 64-bit Extended Unique Identifier | | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
| | FC_WWN | Fibre Channel World Wide Name | | | FC_WWN | Fibre Channel World Wide Name | | ||
| Line 319: | Line 392: | ||
| - | ===== ClassOfServiceCollection | + | ====== |
| - | + | ||
| - | A Collection of ClassOfService resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | The name of the resource or array element. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== ComputerSystem | + | |
| This schema defines a computer system and its respective properties. | This schema defines a computer system and its respective properties. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Actions** { | object | + | | --- | --- | --- | |
| - | | \ \ \ \ \ \ **# | + | | **Actions** { | object\\ \\ *read-write* | The available actions for this resource. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **AssetTag** | string | + | | } | |
| - | | **Bios** | + | | **AssetTag** | string, null\\ \\ *read-write* | The user definable tag that can be used to track this computer system for inventory or other client purposes. | |
| - | | **BiosVersion** | string | Yes | read-only | The version of the system BIOS or primary system firmware. | | + | | **Bios** |
| - | | **Boot** { | object | + | | < |
| - | | \ \ \ \ \ \ **BootSourceOverrideEnabled** | string | + | | < |
| - | | \ \ \ \ \ \ **BootSourceOverrideMode** | string | + | | < |
| - | | \ \ \ \ \ \ **BootSourceOverrideTarget** | string | + | | < |
| - | | \ \ \ \ \ \ **UefiTargetBootSourceOverride** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **Description** | string | + | | < |
| - | | **EthernetInterfaces** | reference([[documentation: | + | | } | |
| - | | **HostName** | string | Yes | read-write | The DNS Host Name, without any domain information. | | + | | **BiosVersion** | string, null\\ \\ *read-only* | The version of the system BIOS or primary system firmware. | |
| - | | **HostedServices** { | object | + | | **Boot** { | object\\ \\ *read-write* | Information about the boot settings for this system. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **StorageServices** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **HostingRoles** [ {} ] | array | | read-only | The hosing roles that this computer system supports. | | + | | < |
| - | | **Id** | string | + | | } | |
| - | | **IndicatorLED** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Links** { | object | + | | **EthernetInterfaces** |
| - | | \ \ \ \ \ \ **Chassis** [ {} ] | array | | read-only | An array of references to the chassis in which this system is contained. | | + | | < |
| - | | \ \ \ \ \ \ **CooledBy** [ {} ] | array | | read-only | An array of ID[s] of resources that cool this computer system. Normally the ID will be a chassis or a specific set of fans. | | + | | < |
| - | | \ \ \ \ \ \ **Endpoints** [ {} ] | array | | read-only | An array of references to the endpoints that connect to this system. | | + | | < |
| - | | \ \ \ \ \ \ **ManagedBy** [ {} ] | array | | read-only | An array of references to the Managers responsible for this system. | | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **PoweredBy** [ {} ] | array | | read-only | An array of ID[s] of resources that power this computer system. Normally the ID will be a chassis or a specific set of Power Supplies. | | + | | } | |
| - | | } | | | | + | | **HostName** | string, null\\ \\ *read-write* |
| - | | **LogServices** | reference([[documentation: | + | | **HostedServices** *(v1.2+)* { | object\\ \\ *read-write* | The services that this computer system supports. | |
| - | | **Manufacturer** | string | Yes | read-only | The manufacturer or OEM of this system. | | + | | < |
| - | | **Memory** | + | | < |
| - | | **MemoryDomains** | object | Yes | read-write | A reference to the collection of Memory Domains associated with this system. | | + | | } | |
| - | | **MemorySummary** { | object | + | | **HostingRoles** *(v1.2+)* [ {} ] | array\\ \\ *read-only* | The hosing roles that this computer system supports. | |
| - | | \ \ \ \ \ \ **MemoryMirroring** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **Status** {} | object | + | | **IndicatorLED** | string, null\\ \\ *read-write* | The state of the indicator LED, used to identify the system. |
| - | | \ \ \ \ \ \ **TotalSystemMemoryGiB** | number | + | | **Links** { | object\\ \\ *read-write* | Contains references to other resources that are related to this resource. | |
| - | | } | | | | + | | < |
| - | | **Model** | string | + | | < |
| - | | **Name** | string | + | | < |
| - | | **NetworkInterfaces** | + | | < |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | | < |
| - | | **PCIeDevices** | + | | < |
| - | | **PCIeFunctions** | array(reference([[documentation: | + | | < |
| - | | **PartNumber** | string | Yes | read-only | The part number for this system. | | + | | < |
| - | | **PowerState** | string | + | | < |
| - | | **ProcessorSummary** { | object | + | | < |
| - | | \ \ \ \ \ \ **Count** | number | + | | < |
| - | | \ \ \ \ \ \ **Model** | string | + | | } | |
| - | | \ \ \ \ \ \ **Status** {} | object | + | | **LogServices** |
| - | | } | | | | + | | < |
| - | | **Processors** | reference([[documentation: | + | | < |
| - | | **SKU** | string | Yes | read-only | The manufacturer SKU for this system. | | + | | < |
| - | | **SecureBoot** | + | | < |
| - | | **SerialNumber** | string | Yes | read-only | The serial number for this system. | | + | | < |
| - | | **SimpleStorage** | reference([[documentation: | + | | } | |
| - | | **Status** { | object | + | | **Manufacturer** | string, null\\ \\ *read-only* |
| - | | \ \ \ \ \ \ **Health** | string | + | | **Memory** |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **State** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **Storage** | + | | < |
| - | | **SystemType** | string | | read-write | The type of computer system represented by this resource.\\ //See Property Details, below, for more information about this property.// | | + | | } | |
| - | | **TrustedModules** [ { | array | | read-write | This object describes the array of Trusted Modules in the system. | | + | | **MemoryDomains** *(v1.2+)* { | object, null\\ \\ *read-write* | A reference to the collection of Memory Domains associated with this system. | |
| - | | \ \ \ \ \ \ **FirmwareVersion** | string | + | | < |
| - | | \ \ \ \ \ \ **FirmwareVersion2** | string | + | | < |
| - | | \ \ \ \ \ \ **InterfaceType** | string | + | | < |
| - | | \ \ \ \ \ \ **InterfaceTypeSelection** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **Status** {} | object | + | | } | |
| - | | } ] | | | | + | | **MemorySummary** { | object\\ \\ *read-write* |
| - | | **UUID** | string | + | | < |
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Model** | string, null\\ \\ *read-only* | The model number for this system. | | ||
| + | | **Name** | string\\ \\ *read-write* | The name of the resource or array element. | | ||
| + | | **NetworkInterfaces** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ | ||
| + | | **PCIeDevices** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } ] | | ||
| + | | **[email protected]** *(v1.2+)* | string\\ \\ *read-write* | ||
| + | | **PCIeFunctions** *(v1.2+)* [ { | array\\ \\ *read-only* | A reference to a collection of PCIe Functions used by this computer system. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } ] | | ||
| + | | **[email protected]** *(v1.2+)* | string\\ \\ *read-write* | | | ||
| + | | **PartNumber** | string, null\\ \\ *read-only* | ||
| + | | **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. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Processors** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **SKU** | string, null\\ \\ *read-only* | ||
| + | | **SecureBoot** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **SerialNumber** | string, null\\ \\ *read-only* | The serial number for this system. | | ||
| + | | **SimpleStorage** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Status** { | object\\ \\ *read-only* | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Storage** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **SystemType** | string\\ \\ *read-write* | ||
| + | | **TrustedModules** *(v1.1+)* [ { | 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. | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == BootSourceOverrideEnabled == | + | ==== BootSourceOverrideEnabled: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Continuous | The system will boot to the target specified in the BootSourceOverrideTarget until this property is set to Disabled. | | | Continuous | The system will boot to the target specified in the BootSourceOverrideTarget until this property is set to Disabled. | | ||
| | Disabled | The system will boot normally. | | | Disabled | The system will boot normally. | | ||
| | Once | On its next boot cycle, the system will boot (one time) to the Boot Source Override Target. The value of BootSourceOverrideEnabled is then reset back to Disabled. | | | Once | On its next boot cycle, the system will boot (one time) to the Boot Source Override Target. The value of BootSourceOverrideEnabled is then reset back to Disabled. | | ||
| - | == BootSourceOverrideMode == | + | ==== BootSourceOverrideMode: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Legacy | The system will boot in non-UEFI boot mode to the Boot Source Override Target. | | | Legacy | The system will boot in non-UEFI boot mode to the Boot Source Override Target. | | ||
| | UEFI | The system will boot in UEFI boot mode to the Boot Source Override Target. | | | UEFI | The system will boot in UEFI boot mode to the Boot Source Override Target. | | ||
| - | == BootSourceOverrideTarget == | + | ==== BootSourceOverrideTarget: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | BiosSetup | Boot to the BIOS Setup Utility. | | | BiosSetup | Boot to the BIOS Setup Utility. | | ||
| | Cd | Boot from the CD/DVD disc. | | | Cd | Boot from the CD/DVD disc. | | ||
| Line 443: | Line 613: | ||
| | Utilities | Boot the manufacturer' | | Utilities | Boot the manufacturer' | ||
| - | == DeviceClass == | + | ==== DeviceClass: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Bridge | A bridge. | | | Bridge | A bridge. | | ||
| | CommunicationController | A communication controller. | | | CommunicationController | A communication controller. | | ||
| Line 470: | Line 641: | ||
| | WirelessController | A wireless controller. | | | WirelessController | A wireless controller. | | ||
| - | == DeviceType == | + | ==== DeviceType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | MultiFunction | A multi-function PCIe device. | | | MultiFunction | A multi-function PCIe device. | | ||
| | Simulated | A PCIe device which is not currently physically present, but is being simulated by the PCIe infrastructure. | | | Simulated | A PCIe device which is not currently physically present, but is being simulated by the PCIe infrastructure. | | ||
| | SingleFunction | A single-function PCIe device. | | | SingleFunction | A single-function PCIe device. | | ||
| - | == FunctionType == | + | ==== FunctionType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Physical | A physical PCie function. | | | Physical | A physical PCie function. | | ||
| | Virtual | A virtual PCIe function. | | | Virtual | A virtual PCIe function. | | ||
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == IndicatorLED == | + | ==== IndicatorLED: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Blinking | The Indicator LED is blinking. | | | Blinking | The Indicator LED is blinking. | | ||
| | Lit | The Indicator LED is lit. | | | Lit | The Indicator LED is lit. | | ||
| Line 505: | Line 681: | ||
| | Unknown | The state of the Indicator LED cannot be determined. Deprecated: Return null if state is unknown. | | | Unknown | The state of the Indicator LED cannot be determined. Deprecated: Return null if state is unknown. | | ||
| - | == InterfaceType == | + | ==== InterfaceType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | TCM1_0 | Trusted Cryptography Module (TCM) 1.0. | | | TCM1_0 | Trusted Cryptography Module (TCM) 1.0. | | ||
| | TPM1_2 | Trusted Platform Module (TPM) 1.2. | | | TPM1_2 | Trusted Platform Module (TPM) 1.2. | | ||
| | TPM2_0 | Trusted Platform Module (TPM) 2.0. | | | TPM2_0 | Trusted Platform Module (TPM) 2.0. | | ||
| - | == InterfaceTypeSelection == | + | ==== InterfaceTypeSelection: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | BiosSetting | The TrustedModule supports switching InterfaceType via platform software, such as a BIOS configuration Attribute. | | | BiosSetting | The TrustedModule supports switching InterfaceType via platform software, such as a BIOS configuration Attribute. | | ||
| | FirmwareUpdate | The TrustedModule supports switching InterfaceType via a firmware update. | | | FirmwareUpdate | The TrustedModule supports switching InterfaceType via a firmware update. | | ||
| Line 520: | Line 698: | ||
| | OemMethod | The TrustedModule supports switching InterfaceType via an OEM proprietary mechanism. | | | OemMethod | The TrustedModule supports switching InterfaceType via an OEM proprietary mechanism. | | ||
| - | == MemoryMirroring == | + | ==== MemoryMirroring: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | DIMM | The system supports DIMM mirroring at the DIMM level. | | DIMM | The system supports DIMM mirroring at the DIMM level. | ||
| | Hybrid | The system supports a hybrid mirroring at the system and DIMM levels. | | Hybrid | The system supports a hybrid mirroring at the system and DIMM levels. | ||
| Line 528: | Line 707: | ||
| | System | The system supports DIMM mirroring at the System level. | | System | The system supports DIMM mirroring at the System level. | ||
| - | == PowerState == | + | ==== PowerState: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Off | The system is powered off, although some components may continue to have AUX power such as management controller. | | | 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. | | | On | The system is powered on. | | ||
| Line 536: | Line 716: | ||
| | 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 == | + | ==== SecureBootCurrentBoot: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Disabled | Secure Boot is currently disabled. | | | Disabled | Secure Boot is currently disabled. | | ||
| | Enabled | Secure Boot is currently enabled. | | | Enabled | Secure Boot is currently enabled. | | ||
| - | == SecureBootMode == | + | ==== SecureBootMode: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | AuditMode | Secure Boot is currently in Audit Mode. | | | AuditMode | Secure Boot is currently in Audit Mode. | | ||
| | DeployedMode | Secure Boot is currently in Deployed Mode. | | | DeployedMode | Secure Boot is currently in Deployed Mode. | | ||
| Line 550: | Line 732: | ||
| | UserMode | Secure Boot is currently in User Mode. | | | UserMode | Secure Boot is currently in User Mode. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 565: | Line 748: | ||
| | Updating | The element is updating and may be unavailable or degraded. | | | Updating | The element is updating and may be unavailable or degraded. | | ||
| - | == SystemType == | + | ==== SystemType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | OS | An operating system instance. | | | OS | An operating system instance. | | ||
| | Physical | A computer system. | | | Physical | A computer system. | | ||
| Line 575: | Line 759: | ||
| - | ===== ComputerSystemCollection | + | ====== |
| - | + | ||
| - | A Collection of ComputerSystem resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | The name of the resource or array element. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== DataProtectionLoSCapabilities | + | |
| Describe data protection capabilities | Describe data protection capabilities | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Description** | string | + | | --- | --- | --- | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Identifier** { | object | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **DurableName** | string | + | | **Identifier** { | object, null\\ \\ *read-only* | The value identifies this resource. | |
| - | | \ \ \ \ \ \ **DurableNameFormat** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **Links** { | object | + | | } | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **Links** { | object\\ \\ *read-only* | Contains links to other resources that are related to this resource. | |
| - | | \ \ \ \ \ \ **SupportedReplicaOptions** [ {} ] | array | | read-write | Collection of known and supported replica Classes of Service. | | + | | < |
| - | | } | | | | + | | < |
| - | | **Name** | string | + | | < |
| - | | **Oem** {} | object | + | | } | |
| - | | **SupportedDataProtectionLinesOfService** [ { | array | | read-write | Collection of known and supported DataProtectionLinesOfService. | | + | | **Name** | string\\ \\ *read-write* | The name of the resource or array element. | |
| - | | \ \ \ \ \ \ **IsIsolated** | boolean | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | \ \ \ \ \ \ **MinLifetime** | number | + | | **SupportedDataProtectionLinesOfService** [ { | array\\ \\ *read-write* | Collection of known and supported DataProtectionLinesOfService. | |
| - | | \ \ \ \ \ \ **Name** | string | + | | < |
| - | | \ \ \ \ \ \ **RecoveryGeographicObjective** | string | + | | < |
| - | | \ \ \ \ \ \ **RecoveryPointObjective** | string | + | | < |
| - | | \ \ \ \ \ \ **RecoveryTimeObjective** | string | + | | < |
| - | | \ \ \ \ \ \ **ReplicaAccessLocation** {} | object | + | | < |
| - | | \ \ \ \ \ \ **ReplicaClassOfService** {} | object | + | | < |
| - | | \ \ \ \ \ \ **ReplicaType** | string | + | | < |
| - | | \ \ \ \ \ \ **Schedule** {} | object | + | | < |
| - | | } ] | | | | + | | < |
| - | | **SupportedMinLifetime** [ {} ] | array | | read-write | Supported minimum lifetime that replica must be maintained. | | + | | < |
| - | | **SupportedRecoveryGeographicObjectives** [ {} ] | array | | read-write | Supported types of failure domains. | | + | | } ] | |
| - | | **SupportedRecoveryPointObjectiveSeconds** [ {} ] | array | | read-write | Supported time intervals defining how much source information can be lost on failure. | | + | | **SupportedMinLifetime** [ {} ] | array\\ \\ *read-write* | Supported minimum lifetime that replica must be maintained. | |
| - | | **SupportedRecoveryTimeObjectives** [ {} ] | array | | read-write | Supported expectations for time to access an alternate replica. | | + | | **SupportedRecoveryGeographicObjectives** [ {} ] | array\\ \\ *read-write* | Supported types of failure domains. | |
| - | | **SupportedReplicaTypes** [ {} ] | array | | read-write | Supported replica types. | | + | | **SupportedRecoveryPointObjectiveSeconds** [ {} ] | array\\ \\ *read-write* | Supported time intervals defining how much source information can be lost on failure. | |
| - | | **SupportsIsolated** | boolean | + | | **SupportedRecoveryTimeObjectives** [ {} ] | array\\ \\ *read-write* | Supported expectations for time to access an alternate replica. | |
| + | | **SupportedReplicaTypes** [ {} ] | array\\ \\ *read-write* | Supported replica types. | | ||
| + | | **SupportsIsolated** | boolean, null\\ \\ *read-write* | Allocating a replica in a separate fault domain is supported. | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == DurableNameFormat == | + | ==== DurableNameFormat: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | EUI | IEEE-defined 64-bit Extended Unique Identifier | | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
| | FC_WWN | Fibre Channel World Wide Name | | | FC_WWN | Fibre Channel World Wide Name | | ||
| Line 632: | Line 809: | ||
| | iQN | iSCSI Qualified Name | | | iQN | iSCSI Qualified Name | | ||
| - | == RecoveryGeographicObjective == | + | ==== RecoveryGeographicObjective: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Datacenter | A co-located set of servers, including network and storage that share communication, | | Datacenter | A co-located set of servers, including network and storage that share communication, | ||
| | Rack | A container for Servers, Networking, and Storage. | | | Rack | A container for Servers, Networking, and Storage. | | ||
| Line 642: | Line 820: | ||
| | Server | A CPU/memory complex. | | | Server | A CPU/memory complex. | | ||
| - | == RecoveryTimeObjective == | + | ==== RecoveryTimeObjective: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Immediate | Active access to synchronous replicas. | | | Immediate | Active access to synchronous replicas. | | ||
| | Nearline | Access to replica via a different front-end interconnect. A restore step is required before recovery can commence. | | | Nearline | Access to replica via a different front-end interconnect. A restore step is required before recovery can commence. | | ||
| Line 650: | Line 829: | ||
| | Online | Passive access to replicas via the same front-end interconnect. | | | Online | Passive access to replicas via the same front-end interconnect. | | ||
| - | == ReplicaType == | + | ==== ReplicaType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Clone | Create a point in time, full copy the source. | | | Clone | Create a point in time, full copy the source. | | ||
| | Mirror | Create and maintain a copy of the source. | | | Mirror | Create and maintain a copy of the source. | | ||
| Line 659: | Line 839: | ||
| - | ===== DataSecurityLoSCapabilities ===== | + | ====== DataSecurityLoSCapabilities |
| Describe data security capabilities. | Describe data security capabilities. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Description** | string | + | | --- | --- | --- | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Identifier** { | object | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **DurableName** | string | + | | **Identifier** { | object, null\\ \\ *read-only* | The value identifies this resource. | |
| - | | \ \ \ \ \ \ **DurableNameFormat** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **Name** | string | + | | } | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **SupportedAntivirusEngineProviders** [ {} ] | array | | read-write | Supported AntiVirus providers. | | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **SupportedAntivirusScanPolicies** [ {} ] | array | | read-write | Supported policies that trigger an AntiVirus scan. | | + | | **SupportedAntivirusEngineProviders** [ {} ] | array\\ \\ *read-write* | Supported AntiVirus providers. | |
| - | | **SupportedChannelEncryptionStrengths** [ {} ] | array | | read-write | Supported key sizes for transport channel encryption. | | + | | **SupportedAntivirusScanPolicies** [ {} ] | array\\ \\ *read-write* | Supported policies that trigger an AntiVirus scan. | |
| - | | **SupportedDataSanitizationPolicies** [ {} ] | array | | read-write | Supported data sanitization policies. | | + | | **SupportedChannelEncryptionStrengths** [ {} ] | array\\ \\ *read-write* | Supported key sizes for transport channel encryption. | |
| - | | **SupportedDataSecurityLinesOfService** [ { | array | | read-write | Collection of known and supported DataSecurityLinesOfService. | | + | | **SupportedDataSanitizationPolicies** [ {} ] | array\\ \\ *read-write* | Supported data sanitization policies. | |
| - | | \ \ \ \ \ \ **AntivirusEngineProvider** | string | + | | **SupportedDataSecurityLinesOfService** [ { | array\\ \\ *read-write* | Collection of known and supported DataSecurityLinesOfService. | |
| - | | \ \ \ \ \ \ **AntivirusScanPolicies** [ {} ] | array | | read-write | Policy for triggering an AntiVirus scan. | | + | | < |
| - | | \ \ \ \ \ \ **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. | | + | | } ] | |
| - | | **SupportedMediaEncryptionStrengths** [ {} ] | array | | read-write | Supported key sizes for media encryption. | | + | | **SupportedHostAuthenticationTypes** [ {} ] | array\\ \\ *read-write* | Supported authentication types for hosts (servers) or initiator endpoints. | |
| - | | **SupportedSecureChannelProtocols** [ {} ] | array | | read-write | Supported protocols that provide encrypted communication. | | + | | **SupportedMediaEncryptionStrengths** [ {} ] | array\\ \\ *read-write* | Supported key sizes for media encryption. | |
| - | | **SupportedUserAuthenticationTypes** [ {} ] | array | | read-write | Supported authentication types for users (or programs). | | + | | **SupportedSecureChannelProtocols** [ {} ] | array\\ \\ *read-write* | Supported protocols that provide encrypted communication. | |
| + | | **SupportedUserAuthenticationTypes** [ {} ] | array\\ \\ *read-write* | Supported authentication types for users (or programs). | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == ChannelEncryptionStrength == | + | ==== ChannelEncryptionStrength: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Bits_0 | No key. | | | Bits_0 | No key. | | ||
| | Bits_112 | 3DES 112 bit key. | | | Bits_112 | 3DES 112 bit key. | | ||
| Line 703: | Line 885: | ||
| | Bits_256 | AES 256 bit key. | | | Bits_256 | AES 256 bit key. | | ||
| - | == DataSanitizationPolicy == | + | ==== DataSanitizationPolicy: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Clear | Sanitize data in all user-addressable storage locations for protection against simple non-invasive data recovery techniques. | | | Clear | Sanitize data in all user-addressable storage locations for protection against simple non-invasive data recovery techniques. | | ||
| | CryptographicErase | Leverages the encryption of target data by enabling sanitization of the target data's encryption key. This leaves only the ciphertext remaining on the media, effectively sanitizing the data by preventing read-access. For more information, | | CryptographicErase | Leverages the encryption of target data by enabling sanitization of the target data's encryption key. This leaves only the ciphertext remaining on the media, effectively sanitizing the data by preventing read-access. For more information, | ||
| | None | No sanitization. | | | None | No sanitization. | | ||
| - | == DurableNameFormat == | + | ==== DurableNameFormat: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | EUI | IEEE-defined 64-bit Extended Unique Identifier | | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
| | FC_WWN | Fibre Channel World Wide Name | | | FC_WWN | Fibre Channel World Wide Name | | ||
| Line 719: | Line 903: | ||
| | iQN | iSCSI Qualified Name | | | iQN | iSCSI Qualified Name | | ||
| - | == HostAuthenticationType == | + | ==== HostAuthenticationType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | None | No authentication. | | | None | No authentication. | | ||
| | PKI | Public Key Infrastructure. | | | PKI | Public Key Infrastructure. | | ||
| Line 727: | Line 912: | ||
| | Ticket | Ticket-based (e.g., Kerberos) | | | Ticket | Ticket-based (e.g., Kerberos) | | ||
| - | == MediaEncryptionStrength == | + | ==== MediaEncryptionStrength: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Bits_0 | No key. | | | Bits_0 | No key. | | ||
| | Bits_112 | 3DES 112 bit key. | | | Bits_112 | 3DES 112 bit key. | | ||
| Line 736: | Line 922: | ||
| | Bits_256 | AES 256 bit key. | | | Bits_256 | AES 256 bit key. | | ||
| - | == SecureChannelProtocol == | + | ==== SecureChannelProtocol: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | IPsec | Internet Protocol Security (IPsec), as defined by IETF RFC 2401. | | | IPsec | Internet Protocol Security (IPsec), as defined by IETF RFC 2401. | | ||
| | None | No encryption. | | | None | No encryption. | | ||
| Line 744: | Line 931: | ||
| | TLS | Transport Layer Security (TLS), as defined by IETF RFC 5246. | | | TLS | Transport Layer Security (TLS), as defined by IETF RFC 5246. | | ||
| - | == UserAuthenticationType == | + | ==== UserAuthenticationType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | None | No authentication. | | | None | No authentication. | | ||
| | PKI | Public Key Infrastructure. | | | PKI | Public Key Infrastructure. | | ||
| Line 753: | Line 941: | ||
| - | ===== DataStorageLoSCapabilities ===== | + | ====== DataStorageLoSCapabilities |
| Describe data storage capabilities. | Describe data storage capabilities. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Description** | string | + | | --- | --- | --- | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Identifier** { | object | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **DurableName** | string | + | | **Identifier** { | object, null\\ \\ *read-only* | The value identifies this resource. | |
| - | | \ \ \ \ \ \ **DurableNameFormat** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **Name** | string | + | | } | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **SupportedAccessCapabilities** [ {} ] | array | | read-write | Supported access capabilities. | | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **SupportedDataStorageLinesOfService** [ { | array | | read-write | Collection of known and supported DataStorageLinesOfService. | | + | | **SupportedAccessCapabilities** [ {} ] | array\\ \\ *read-write* | Supported access capabilities. | |
| - | | \ \ \ \ \ \ **IsSpaceEfficient** | boolean | + | | **SupportedDataStorageLinesOfService** [ { | array\\ \\ *read-write* | Collection of known and supported DataStorageLinesOfService. | |
| - | | \ \ \ \ \ \ **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. | | + | | } ] | |
| - | | **SupportedRecoveryTimeObjectives** [ {} ] | array | | read-write | Supported expectations for time to access the primary store after recovery. | | + | | **SupportedProvisioningPolicies** [ {} ] | array\\ \\ *read-write* | Thin allows over allocation of storage. | |
| - | | **SupportsSpaceEfficiency** | boolean | + | | **SupportedRecoveryTimeObjectives** [ {} ] | array\\ \\ *read-write* | Supported expectations for time to access the primary store after recovery. | |
| + | | **SupportsSpaceEfficiency** | boolean, null\\ \\ *read-write* | Allows compression or deduplication of storage. | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == DurableNameFormat == | + | ==== DurableNameFormat: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | EUI | IEEE-defined 64-bit Extended Unique Identifier | | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
| | FC_WWN | Fibre Channel World Wide Name | | | FC_WWN | Fibre Channel World Wide Name | | ||
| Line 788: | Line 978: | ||
| | iQN | iSCSI Qualified Name | | | iQN | iSCSI Qualified Name | | ||
| - | == ProvisioningPolicy == | + | ==== ProvisioningPolicy: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Fixed | Storage is fully allocated | | | Fixed | Storage is fully allocated | | ||
| | Thin | Storage may be over allocated. | | | Thin | Storage may be over allocated. | | ||
| - | ===== Drive ===== | + | ====== Drive 1.1.1 ====== |
| Drive contains properties describing a single physical disk drive for any system, along with links to associated Volumes. | Drive contains properties describing a single physical disk drive for any system, along with links to associated Volumes. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Actions** { | object | + | | --- | --- | --- | |
| - | | \ \ \ \ \ \ **# | + | | **Actions** { | object\\ \\ *read-write* | The available actions for this resource. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **AssetTag** | string | + | | } | |
| - | | **BlockSizeBytes** | number | + | | **AssetTag** | string, null\\ \\ *read-write* | The user assigned asset tag for this drive. | |
| - | | **CapableSpeedGbs** | number | + | | **BlockSizeBytes** | number, null\\ (By)\\ \\ *read-only* | The size of the smallest addressible unit (Block) of this drive in bytes. | |
| - | | **CapacityBytes** | number | + | | **CapableSpeedGbs** | number, null\\ (Gbit/s)\\ \\ *read-only* | The speed which this drive can communicate to a storage controller in ideal conditions in Gigabits per second. | |
| - | | **Description** | string | + | | **CapacityBytes** | number, null\\ (By)\\ \\ *read-only* | The size in bytes of this Drive. | |
| - | | **EncryptionAbility** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **EncryptionStatus** | string | + | | **EncryptionAbility** | string, null\\ \\ *read-write* | The encryption abilities of this drive. |
| - | | **FailurePredicted** | boolean | + | | **EncryptionStatus** | string, null\\ \\ *read-write* | The status of the encrytion of this drive. |
| - | | **HotspareType** | string | + | | **FailurePredicted** | boolean, null\\ \\ *read-only* | Is this drive currently predicting a failure in the near future. | |
| - | | **Id** | string | + | | **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.* | |
| - | | **Identifiers** [ { | array | | read-write | The Durable names for the drive. | | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **DurableName** | string | + | | **Identifiers** [ { | array\\ \\ *read-write* | The Durable names for the drive. | |
| - | | \ \ \ \ \ \ **DurableNameFormat** | string | + | | < |
| - | | } ] | | | | + | | < |
| - | | **IndicatorLED** | string | + | | } ] | |
| - | | **Links** { | object | + | | **IndicatorLED** | string, null\\ \\ *read-write* | The state of the indicator LED, used to identify the drive. |
| - | | \ \ \ \ \ \ **Endpoints** [ {} ] | array | | read-only | An array of references to the endpoints that connect to this drive. | | + | | **Links** { | object\\ \\ *read-write* | Contains references to other resources that are related to this resource. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **Volumes** [ {} ] | array | | read-only | An array of references to the volumes contained in this drive. This will reference Volumes that are either wholly or only partly contained by this drive. | | + | | < |
| - | | } | | | | + | | < |
| - | | **Location** [ { | array | | read-write | The Location of the drive. | | + | | < |
| - | | \ \ \ \ \ \ **Info** | string | + | | < |
| - | | \ \ \ \ \ \ **InfoFormat** | string | + | | } | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **Location** [ { | array\\ \\ *read-write* | The Location of the drive. | |
| - | | } ] | | | | + | | < |
| - | | **Manufacturer** | string | + | | < |
| - | | **MediaType** | string | + | | < |
| - | | **Model** | string | + | | } ] | |
| - | | **Name** | string | + | | **Manufacturer** | string, null\\ \\ *read-only* | This is the manufacturer of this drive. | |
| - | | **NegotiatedSpeedGbs** | number | + | | **MediaType** | string, null\\ \\ *read-write* | The type of media contained in this drive. |
| - | | **Oem** {} | object | + | | **Model** | string, null\\ \\ *read-only* | This is the model number for the drive. | |
| - | | **Operations** [ {} ] | array | | read-write | The operations currently running on the Drive. | | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **PartNumber** | string | + | | **NegotiatedSpeedGbs** | number, null\\ (Gbit/s)\\ \\ *read-only* | The speed which this drive is currently communicating to the storage controller in Gigabits per second. | |
| - | | **PredictedMediaLifeLeftPercent** | number | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **Protocol** | | Yes | read-write | The protocol this drive is using to communicate to the storage controller. | | + | | **Operations** *(v1.1+)* [ {} ] | array\\ \\ *read-write* | The operations currently running on the Drive. | |
| - | | **Revision** | string | + | | **PartNumber** | string, null\\ \\ *read-only* | The part number for this drive. | |
| - | | **RotationSpeedRPM** | number | + | | **PredictedMediaLifeLeftPercent** | number, null\\ \\ *read-only* | The percentage of reads and writes that are predicted to still be available for the media. | |
| - | | **SKU** | string | + | | **Protocol** | null\\ \\ *read-write* | The protocol this drive is using to communicate to the storage controller. | |
| - | | **SerialNumber** | string | + | | **Revision** | string, null\\ \\ *read-only* | The revision of this Drive. This is typically the firmware/ |
| - | | **Status** { | object | + | | **RotationSpeedRPM** | number, null\\ (RPM)\\ \\ *read-only* | The rotation speed of this Drive in Revolutions per Minute (RPM). | |
| - | | \ \ \ \ \ \ **Health** | string | + | | **SKU** | string, null\\ \\ *read-only* | This is the SKU for this drive. | |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | **SerialNumber** | string, null\\ \\ *read-only* | The serial number for this drive. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **Status** { | object\\ \\ *read-only* | | |
| - | | \ \ \ \ \ \ **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 |
| - | == DurableNameFormat == | + | ==== DurableNameFormat: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | EUI | IEEE-defined 64-bit Extended Unique Identifier | | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
| | FC_WWN | Fibre Channel World Wide Name | | | FC_WWN | Fibre Channel World Wide Name | | ||
| Line 862: | Line 1057: | ||
| | iQN | iSCSI Qualified Name | | | iQN | iSCSI Qualified Name | | ||
| - | == EncryptionAbility == | + | ==== EncryptionAbility: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | None | The drive is not capable of self encryption. | | | None | The drive is not capable of self encryption. | | ||
| | Other | The drive is capable of self encryption through some other means. | | | 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' | | SelfEncryptingDrive | The drive is capable of self encryption per the Trusted Computing Group' | ||
| - | == EncryptionStatus == | + | ==== EncryptionStatus: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Foreign | The drive is currently encrypted, the data is not accessible to the user, and the system requires user intervention to expose the data. | | | 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. | | | 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. | | ||
| Line 878: | Line 1075: | ||
| | Unlocked | The drive is currently encrypted but the data is accessible to the user unencrypted. | | | Unlocked | The drive is currently encrypted but the data is accessible to the user unencrypted. | | ||
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HotspareType == | + | ==== HotspareType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Chassis | The drive is currently serving as a hotspare for all other drives in the chassis. | | | 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. | | | Dedicated | The drive is currently serving as a hotspare for a user defined set of drives. | | ||
| Line 900: | Line 1100: | ||
| | None | The drive is not currently a hotspare. | | | None | The drive is not currently a hotspare. | | ||
| - | == IndicatorLED == | + | ==== IndicatorLED: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Blinking | The Indicator LED is blinking. | | | Blinking | The Indicator LED is blinking. | | ||
| | Lit | The Indicator LED is lit. | | | Lit | The Indicator LED is lit. | | ||
| | Off | The Indicator LED is off. | | | Off | The Indicator LED is off. | | ||
| - | == MediaType == | + | ==== MediaType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | HDD | The drive media type is traditional magnetic platters. | | | HDD | The drive media type is traditional magnetic platters. | | ||
| | SMR | The drive media type is shingled magnetic recording. | | | SMR | The drive media type is shingled magnetic recording. | | ||
| | SSD | The drive media type is solid state or flash memory. | | | SSD | The drive media type is solid state or flash memory. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 929: | Line 1132: | ||
| | Updating | The element is updating and may be unavailable or degraded. | | | Updating | The element is updating and may be unavailable or degraded. | | ||
| - | == StatusIndicator == | + | ==== StatusIndicator: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Fail | The drive has failed. | | | Fail | The drive has failed. | | ||
| | Hotspare | The drive is marked to be automatically rebuilt and used as a replacement for a failed drive. | | | Hotspare | The drive is marked to be automatically rebuilt and used as a replacement for a failed drive. | | ||
| Line 941: | Line 1145: | ||
| - | ===== DriveCollection | + | ====== |
| - | + | ||
| - | A Collection of Drive resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== Endpoint | + | |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Actions** { | object | + | | --- | --- | --- | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **Actions** { | object\\ \\ *read-write* | The Actions object contains the available custom actions on this resource. | |
| - | | } | | | | + | | < |
| - | | **ConnectedEntities** [ { | array | | read-write | All the entities connected to this endpoint. | | + | | } | |
| - | | \ \ \ \ \ \ **EntityLink** {} | object | + | | **ConnectedEntities** [ { | array\\ \\ *read-write* | All the entities connected to this endpoint. | |
| - | | \ \ \ \ \ \ **EntityPciId** {} | object | + | | < |
| - | | \ \ \ \ \ \ **EntityRole** | string | + | | < |
| - | | \ \ \ \ \ \ **EntityType** | string | + | | < |
| - | | \ \ \ \ \ \ **Identifiers** [ {} ] | array | | read-write | Identifiers for the remote entity. | | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **PciClassCode** | string | + | | < |
| - | | \ \ \ \ \ \ **PciFunctionNumber** | number | + | | < |
| - | | } ] | | | | + | | < |
| - | | **Description** | string | + | | } ] | |
| - | | **EndpointProtocol** | | Yes | read-write | The protocol supported by this endpoint. | | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **HostReservationMemoryBytes** | number | + | | **EndpointProtocol** | null\\ \\ *read-write* | The protocol supported by this endpoint. | |
| - | | **Id** | string | + | | **HostReservationMemoryBytes** | number, null\\ (By)\\ \\ *read-only* | The amount of memory in Bytes that the Host should allocate to connect to this endpoint. | |
| - | | **Identifiers** [ { | array | | read-write | Identifiers for this endpoint. | | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **DurableName** | string | + | | **Identifiers** [ { | array\\ \\ *read-write* | Identifiers for this endpoint. | |
| - | | \ \ \ \ \ \ **DurableNameFormat** | string | + | | < |
| - | | } ] | | | | + | | < |
| - | | **Links** { | object | + | | } ] | |
| - | | \ \ \ \ \ \ **MutuallyExclusiveEndpoints** [ {} ] | array | | read-only | An array of references to the endpoints that may not be used in zones if this endpoint is used in a zone. | | + | | **Links** { | object\\ \\ *read-write* | The links object contains the links to other resources that are related to this resource. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **Ports** [ {} ] | array | | read-only | An array of references to the the physical ports associated with this endpoint. | | + | | < |
| - | | } | | | | + | | < |
| - | | **Name** | string | + | | < |
| - | | **Oem** {} | object | + | | < |
| - | | **PciId** { | object | + | | } | |
| - | | \ \ \ \ \ \ **DeviceId** | string | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | \ \ \ \ \ \ **SubsystemId** | string | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | \ \ \ \ \ \ **SubsystemVendorId** | string | + | | **PciId** { | object, null\\ \\ *read-write* | The PCI ID of the endpoint. | |
| - | | \ \ \ \ \ \ **VendorId** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **Redundancy** [ { | array | | read-write | Redundancy information for the lower level endpoints supporting this endpoint. | | + | | < |
| - | | \ \ \ \ \ \ **MaxNumSupported** | number | + | | < |
| - | | \ \ \ \ \ \ **MemberId** | string | + | | } | |
| - | | \ \ \ \ \ \ **MinNumNeeded** | number | + | | **Redundancy** [ { | array\\ \\ *read-write* | Redundancy information for the lower level endpoints supporting this endpoint. | |
| - | | \ \ \ \ \ \ **Mode** | string | + | | < |
| - | | \ \ \ \ \ \ **Name** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **RedundancySet** [ {} ] | array | | read-only | Contains any ids that represent components of this redundancy set. | | + | | < |
| - | | \ \ \ \ \ \ **Status** {} | object | + | | < |
| - | | \ \ \ \ \ \ **MemberId** | string | + | | < |
| - | | \ \ \ \ \ \ **RedundancyEnabled** | boolean | + | | < |
| - | | } ] | | | | + | | < |
| - | | **Status** { | object | + | | < |
| - | | \ \ \ \ \ \ **Health** | string | + | | < |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | } ] | | | |
| - | | \ \ \ \ \ \ **State** | string | + | | **[email protected]** | string\\ \\ *read-write* |
| - | | } | | | | + | | **Status** { | object, null\\ \\ *read-only* | | |
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == DurableNameFormat == | + | ==== DurableNameFormat: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | EUI | IEEE-defined 64-bit Extended Unique Identifier | | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
| | FC_WWN | Fibre Channel World Wide Name | | | FC_WWN | Fibre Channel World Wide Name | | ||
| Line 1020: | Line 1220: | ||
| | iQN | iSCSI Qualified Name | | | iQN | iSCSI Qualified Name | | ||
| - | == EntityRole == | + | ==== EntityRole: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Both | The entity is acting as both an initiator and a target. | | | Both | The entity is acting as both an initiator and a target. | | ||
| | Initiator | The entity is acting as an initiator. | | | Initiator | The entity is acting as an initiator. | | ||
| | Target | The entity is acting as a target. | | | Target | The entity is acting as a target. | | ||
| - | == EntityType == | + | ==== EntityType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Bridge | The entity is a PCI(e) bridge. | | | Bridge | The entity is a PCI(e) bridge. | | ||
| | DisplayController | The entity is a display controller. | | | DisplayController | The entity is a display controller. | | ||
| Line 1039: | Line 1241: | ||
| | StorageInitiator | The entity is a storage initator. The EntityLink property (if present) should be a Storage.StorageController entity. | | | StorageInitiator | The entity is a storage initator. The EntityLink property (if present) should be a Storage.StorageController entity. | | ||
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == Mode == | + | ==== Mode: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Failover | Failure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set. | | | Failover | Failure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set. | | ||
| | N+m | Multiple units are available and active such that normal operation will continue if one or more units fail. | | | N+m | Multiple units are available and active such that normal operation will continue if one or more units fail. | | ||
| Line 1061: | Line 1266: | ||
| | Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. | | | Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 1077: | Line 1283: | ||
| - | ===== EndpointCollection | + | ====== |
| - | + | ||
| - | A Collection of Endpoint resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== EndpointGroup | + | |
| A group of endpoints that are managed as a unit. | A group of endpoints that are managed as a unit. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **AccessState** | string | + | | --- | --- | --- | |
| - | | **Description** | string | + | | **AccessState** | string, null\\ \\ *read-write* | Access State for this group. |
| - | | **Endpoints** | object | Yes | read-write | The Endpoints. | | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **GroupType** | string | Yes | read-write | Endpoint group type.\\ //See Property Details, below, for more information about this property.// | | + | | **Endpoints** |
| - | | **Id** | string | + | | < |
| - | | **Identifier** { | object | + | | < |
| - | | \ \ \ \ \ \ **DurableName** | string | + | | < |
| - | | \ \ \ \ \ \ **DurableNameFormat** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **Links** { | object | + | | } | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **GroupType** | string, null\\ \\ *read-write* | Endpoint group type. *See Property Details, below, for more information about this property.* | |
| - | | } | | | | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Name** | string | + | | **Identifier** { | object, null\\ \\ *read-only* | The value identifies this resource. | |
| - | | **Oem** {} | object | + | | < |
| - | | **Preferred** | boolean | + | | < |
| - | | **TargetEndpointGroupIdentifier** | number | + | | } | |
| + | | **Links** { | object\\ \\ *read-only* | Contains links to other resources that are related to this resource. | | ||
| + | | < | ||
| + | | } | | ||
| + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | | ||
| + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ | ||
| + | | **Preferred** | boolean, null\\ \\ *read-write* | Access to resource is preferred. | | ||
| + | | **TargetEndpointGroupIdentifier** | number, null\\ \\ *read-write* | A defined identifier for this group. | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == AccessState == | + | ==== AccessState: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | NonOptimized | The endpoint(s) are in an Active/ | | NonOptimized | The endpoint(s) are in an Active/ | ||
| | Optimized | The endpoint(s) are in an Active/ | | Optimized | The endpoint(s) are in an Active/ | ||
| Line 1120: | Line 1324: | ||
| | Unavailable | The endpoint(s) are unavailable. | | | Unavailable | The endpoint(s) are unavailable. | | ||
| - | == DurableNameFormat == | + | ==== DurableNameFormat: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | EUI | IEEE-defined 64-bit Extended Unique Identifier | | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
| | FC_WWN | Fibre Channel World Wide Name | | | FC_WWN | Fibre Channel World Wide Name | | ||
| Line 1129: | Line 1334: | ||
| | iQN | iSCSI Qualified Name | | | iQN | iSCSI Qualified Name | | ||
| - | == GroupType == | + | ==== GroupType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Client | The group contains the client (initiator) endpoints. | | | Client | The group contains the client (initiator) endpoints. | | ||
| | Server | The group contains the server (target) endpoints. | | | Server | The group contains the server (target) endpoints. | | ||
| - | ===== EndpointGroupCollection | + | ====== |
| - | + | ||
| - | A Collection of endpoint group resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== EthernetInterface | + | |
| This schema defines a simple ethernet NIC resource. | This schema defines a simple ethernet NIC resource. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **AutoNeg** | boolean | + | | --- | --- | --- | |
| - | | **Description** | string | + | | **AutoNeg** | boolean, null\\ \\ *read-write* | This indicates if the speed and duplex are automatically negotiated and configured on this interface. | |
| - | | **FQDN** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **FullDuplex** | boolean | + | | **FQDN** | string, null\\ \\ *read-write* | This is the complete, fully qualified domain name obtained by DNS for this interface. | |
| - | | **HostName** | string | + | | **FullDuplex** | boolean, null\\ \\ *read-write* | This indicates if the interface is in Full Duplex mode or not. | |
| - | | **IPv4Addresses** [ { | array | | read-write | The IPv4 addresses assigned to this interface. | | + | | **HostName** | string, null\\ \\ *read-write* | The DNS Host Name, without any domain information. | |
| - | | \ \ \ \ \ \ **Address** | string | + | | **IPv4Addresses** [ { | array\\ \\ *read-write* | The IPv4 addresses assigned to this interface. | |
| - | | \ \ \ \ \ \ **AddressOrigin** | string | + | | < |
| - | | \ \ \ \ \ \ **Gateway** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **SubnetMask** | string | + | | < |
| - | | } ] | | | | + | | < |
| - | | **IPv6AddressPolicyTable** [ { | array | | read-write | An array representing the RFC 6724 Address Selection Policy Table. | | + | | } ] | |
| - | | \ \ \ \ \ \ **Label** | number | + | | **IPv6AddressPolicyTable** [ { | array\\ \\ *read-write* | An array representing the RFC 6724 Address Selection Policy Table. | |
| - | | \ \ \ \ \ \ **Precedence** | number | + | | < |
| - | | \ \ \ \ \ \ **Prefix** | string | + | | < |
| - | | } ] | | | | + | | < |
| - | | **IPv6Addresses** [ { | array | | read-write | This array of objects enumerates all of the currently assigned IPv6 addresses on this interface. | | + | | } ] | |
| - | | \ \ \ \ \ \ **Address** | string | + | | **IPv6Addresses** [ { | array\\ \\ *read-write* | This array of objects enumerates all of the currently assigned IPv6 addresses on this interface. | |
| - | | \ \ \ \ \ \ **AddressOrigin** | string | + | | < |
| - | | \ \ \ \ \ \ **AddressState** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **PrefixLength** | number | + | | < |
| - | | } ] | | | | + | | < |
| - | | **IPv6DefaultGateway** | string | + | | } ] | |
| - | | **IPv6StaticAddresses** [ { | array | | read-write | This array of objects represents all of the IPv6 static addresses to be assigned on this interface. | | + | | **IPv6DefaultGateway** | string, null\\ \\ *read-only* | This is the IPv6 default gateway address that is currently in use on this interface. | |
| - | | \ \ \ \ \ \ **Address** | string | + | | **IPv6StaticAddresses** [ { | array\\ \\ *read-write* | This array of objects represents all of the IPv6 static addresses to be assigned on this interface. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **PrefixLength** | number | + | | < |
| - | | } ] | | | | + | | < |
| - | | **Id** | string | + | | } ] | |
| - | | **InterfaceEnabled** | boolean | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **LinkStatus** | string | + | | **InterfaceEnabled** | boolean, null\\ \\ *read-write* | This indicates whether this interface is enabled. | |
| - | | **Links** { | object | + | | **LinkStatus** *(v1.1+)* | string, null\\ \\ *read-write* | The link status of this interface (port). |
| - | | \ \ \ \ \ \ **Endpoints** [ {} ] | array | | read-only | An array of references to the endpoints that connect to this ethernet interface. | | + | | **Links** *(v1.1+)* { | object\\ \\ *read-write* | Contains references to other resources that are related to this resource. | |
| - | | \ \ \ \ \ \ **HostInterface** {} | object | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **MACAddress** | string | + | | < |
| - | | **MTUSize** | number | + | | } | |
| - | | **MaxIPv6StaticAddresses** | number | + | | **MACAddress** | string, null\\ \\ *read-write* | This is the currently configured MAC address of the (logical port) interface. | |
| - | | **Name** | string | + | | **MTUSize** | number, null\\ \\ *read-write* | This is the currently configured Maximum Transmission Unit (MTU) in bytes on this interface. | |
| - | | **NameServers** [ {} ] | array | | read-only | This represents DNS name servers that are currently in use on this interface. | | + | | **MaxIPv6StaticAddresses** | number, null\\ \\ *read-only* | This indicates the maximum number of Static IPv6 addresses that can be configured on this interface. | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **PermanentMACAddress** | string | + | | **NameServers** [ {} ] | array\\ \\ *read-only* | This represents DNS name servers that are currently in use on this interface. | |
| - | | **SpeedMbps** | number | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **Status** { | object | + | | **PermanentMACAddress** | string, null\\ \\ *read-write* | This is the permanent MAC address assigned to this interface (port). | |
| - | | \ \ \ \ \ \ **Health** | string | + | | **SpeedMbps** | number, null\\ (Mbit/s)\\ \\ *read-write* | This is the current speed in Mbps of this interface. | |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | **Status** { | object, null\\ \\ *read-only* | | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **State** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **UefiDevicePath** | string | + | | < |
| - | | **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. | | + | | } | |
| - | | **VLANs** | reference([[documentation: | + | | **UefiDevicePath** | string, null\\ \\ *read-only* | The UEFI device path for this interface. | |
| + | | **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** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == AddressOrigin == | + | ==== AddressOrigin: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | DHCPv6 | Address is provided by a DHCPv6 service | | | DHCPv6 | Address is provided by a DHCPv6 service | | ||
| | LinkLocal | Address is valid only for this network segment (link) | | | LinkLocal | Address is valid only for this network segment (link) | | ||
| Line 1217: | Line 1422: | ||
| | Static | A static address as configured by the user | | | Static | A static address as configured by the user | | ||
| - | == AddressState == | + | ==== AddressState: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Deprecated | This address is currently within it's valid lifetime, but is now outside of it's preferred lifetime as defined in RFC 4862. | | | Deprecated | This address is currently within it's valid lifetime, but is now outside of it's preferred lifetime as defined in RFC 4862. | | ||
| | Failed | This address has failed Duplicate Address Detection testing as defined in RFC 4862 section 5.4 and is not currently in use. | | | Failed | This address has failed Duplicate Address Detection testing as defined in RFC 4862 section 5.4 and is not currently in use. | | ||
| Line 1225: | Line 1431: | ||
| | Tentative | This address is currently undergoing Duplicate Address Detection testing as defined in RFC 4862 section 5.4. | | | Tentative | This address is currently undergoing Duplicate Address Detection testing as defined in RFC 4862 section 5.4. | | ||
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == LinkStatus == | + | ==== LinkStatus: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | LinkDown | There is no link on this interface, but the interface is connected. | | | LinkDown | There is no link on this interface, but the interface is connected. | | ||
| | LinkUp | The link is available for communication on this interface. | | | LinkUp | The link is available for communication on this interface. | | ||
| | NoLink | There is no link or connection detected on this interface. | | | NoLink | There is no link or connection detected on this interface. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 1262: | Line 1472: | ||
| - | ===== EthernetInterfaceCollection | + | ====== |
| - | + | ||
| - | A Collection of EthernetInterface resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== Event ===== | + | |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Context** | string | + | | --- | --- | --- | |
| - | | **Description** | string | + | | **Context** *(v1.1+)* | string\\ \\ *read-only* | A context can be supplied at subscription time. This property is the context value supplied by the subscriber. | |
| - | | **Events** [ { | array | | read-write | Each event in this array has a set of properties that describe the event. | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | \ \ \ \ \ \ **Context** | string | + | | **Events** [ { | array\\ \\ *read-write* | Each event in this array has a set of properties that describe the event. |
| - | | \ \ \ \ \ \ **EventId** | string | + | | < |
| - | | \ \ \ \ \ \ **EventTimestamp** | string | + | | < |
| - | | \ \ \ \ \ \ **EventType** | string | + | | < |
| - | | \ \ \ \ \ \ **MemberId** | string | + | | < |
| - | | \ \ \ \ \ \ **Message** | string | + | | < |
| - | | \ \ \ \ \ \ **MessageArgs** [ {} ] | array | | read-only | This array of message arguments are substituted for the arguments in the message when looked up in the message registry. | | + | | < |
| - | | \ \ \ \ \ \ **MessageId** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **OriginOfCondition** {} | object | + | | < |
| - | | \ \ \ \ \ \ **Severity** | string | + | | < |
| - | | } ] | | | | + | | < |
| - | | **Id** | string | | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | } ] | |
| - | | **Name** | string | + | | **[email protected]** | string\\ \\ *read-write* |
| - | | **Oem** {} | object | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | | ||
| + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ | ||
| - | === Property Details === | + | ===== Property Details |
| - | == EventType == | + | ==== EventType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Alert | A condition exists which requires attention. | | | Alert | A condition exists which requires attention. | | ||
| | ResourceAdded | A resource has been added. | | | ResourceAdded | A resource has been added. | | ||
| Line 1308: | Line 1511: | ||
| - | ===== EventDestination ===== | + | ====== EventDestination |
| An Event Destination desribes the target of an event subscription, | An Event Destination desribes the target of an event subscription, | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Context** | string | + | | --- | --- | --- | |
| - | | **Description** | string | + | | **Context** | string\\ \\ *read-write* | A client-supplied string that is stored with the event destination subscription. | |
| - | | **Destination** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **EventTypes** [ {} ] | array | | read-only | This property shall contain the types of events that shall be sent to the desination. | | + | | **Destination** | string\\ \\ *read-only* | The URI of the destination Event Service. | |
| - | | **HttpHeaders** [ {} ] | array | | read-write | This is for setting HTTP headers, such as authorization information. | + | | **EventTypes** [ {} ] | array\\ \\ *read-only* | This property shall contain the types of events that shall be sent to the desination. | |
| - | | **Id** | string | + | | **HttpHeaders** [ {} ] | array\\ \\ *read-write* | This is for setting HTTP headers, such as authorization information. |
| - | | **MessageIds** [ {} ] | array | | read-only | A list of MessageIds that the service will only send. | | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Name** | string | + | | **MessageIds** *(v1.1+)* [ {} ] | array\\ \\ *read-only* | A list of MessageIds that the service will only send. | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **OriginResources** [ {} ] | array | | read-only | A list of resources for which the service will only send related events. | | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **Protocol** | string | | read-write | The protocol type of the event connection.\\ //See Property Details, below, for more information about this property.// | | + | | **OriginResources** *(v1.1+)* [ {} ] | array\\ \\ *read-only* | A list of resources for which the service will only send related events. | |
| - | + | | **[email protected]** *(v1.1+)* | string\\ \\ *read-write* | |
| - | === Property Details === | + | | **Protocol** | string\\ \\ *read-write* | The protocol type of the event connection. |
| - | + | ||
| - | == Protocol == | + | |
| - | + | ||
| - | ^ string ^ | + | |
| - | | Redfish | + | |
| + | ===== Property Details ===== | ||
| - | ===== EventDestinationCollection ===== | + | ==== Protocol: |
| - | A Collection of EventDestination resource instances. | + | | string | |
| + | | --- | | ||
| + | | Redfish | | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | ||
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | ||
| - | | **Members** | array(reference([[documentation: | ||
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | ||
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | ||
| - | ===== EventService ===== | + | ====== EventService |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Actions** { | object | + | | --- | --- | --- | |
| - | | \ \ \ \ \ \ **# | + | | **Actions** { | object\\ \\ *read-write* | The available actions for this resource. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **DeliveryRetryAttempts** | number | + | | } | |
| - | | **DeliveryRetryIntervalSeconds** | number | + | | **DeliveryRetryAttempts** | number\\ \\ *read-only* | This is the number of attempts an event posting is retried before the subscription is terminated. | |
| - | | **Description** | string | + | | **DeliveryRetryIntervalSeconds** | number\\ (s)\\ \\ *read-only* | This represents the number of seconds between retry attempts for sending any given Event. | |
| - | | **EventTypesForSubscription** [ {} ] | array | | read-only | This is the types of Events that can be subscribed to. | | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Id** | string | + | | **EventTypesForSubscription** [ {} ] | array\\ \\ *read-only* | This is the types of Events that can be subscribed to. | |
| - | | **Name** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **ServiceEnabled** | boolean | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **Status** { | object | + | | **ServiceEnabled** | boolean, null\\ \\ *read-write* | This indicates whether this service is enabled. | |
| - | | \ \ \ \ \ \ **Health** | string | + | | **Status** { | object\\ \\ *read-only* | | |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **State** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **Subscriptions** | reference([[documentation: | + | | } | |
| + | | **Subscriptions** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 1400: | Line 1606: | ||
| - | ===== Fabric ===== | + | ====== Fabric |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Actions** { | object | + | | --- | --- | --- | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **Actions** { | object\\ \\ *read-write* | The available actions for this resource. | |
| - | | } | | | | + | | < |
| - | | **Description** | string | + | | } | |
| - | | **Endpoints** | reference([[documentation: | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **FabricType** | | Yes | read-write | The protocol being sent over this fabric. | | + | | **Endpoints** |
| - | | **Id** | string | + | | < |
| - | | **Links** { | object | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **MaxZones** | number | + | | < |
| - | | **Name** | string | + | | } | |
| - | | **Oem** {} | object | + | | **FabricType** | null\\ \\ *read-write* |
| - | | **Status** { | object | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **Health** | string | + | | **Links** { | object\\ \\ *read-write* | Contains references to other resources that are related to this resource. | |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | } | |
| - | | \ \ \ \ \ \ **State** | string | + | | **MaxZones** | number, null\\ \\ *read-only* | The value of this property shall contain the maximum number of zones the switch can currently configure. | |
| - | | } | | | | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **Switches** | reference([[documentation: | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **Zones** | reference([[documentation: | + | | **Status** { | object\\ \\ *read-only* | | |
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Switches** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Zones** { | object\\ \\ *read-write* | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 1459: | Line 1687: | ||
| - | ===== FabricCollection | + | ====== |
| - | + | ||
| - | A Collection of Fabric resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== FileShare | + | |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **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. | | + | | **CASupported** | boolean, null\\ \\ *read-write* | Continuous Availability is supported. Client/ |
| - | | **Description** | string | + | | **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. | |
| - | | **EthernetInterfaces** | reference([[documentation: | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **ExecuteSupport** | boolean | + | | **EthernetInterfaces** |
| - | | **FileSharePath** | string | + | | < |
| - | | **FileShareQuotaType** | string | + | | < |
| - | | **FileShareRemainingQuotaBytes** | number | + | | < |
| - | | **FileShareTotalQuotaBytes** | number | + | | < |
| - | | **FileSharingProtocols** [ {} ] | array | | read-only | An array of file sharing protocols supported by this file share. | | + | | < |
| - | | **Id** | string | + | | } | |
| - | | **Links** { | object | + | | **ExecuteSupport** | boolean, null\\ \\ *read-only* |
| - | | \ \ \ \ \ \ **ClassOfService** {} | object | + | | **FileSharePath** | string, null\\ \\ *read-only* | A path to an exported file or directory on the file system where this file share is hosted. | |
| - | | \ \ \ \ \ \ **FileSystem** {} | object | + | | **FileShareQuotaType** | string, null\\ \\ *read-write* | Specifies the type of quota enforcement. |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **FileShareRemainingQuotaBytes** | number, null\\ (By)\\ \\ *read-write* | The number of remaining bytes that may be used by this file share. | |
| - | | } | | | | + | | **FileShareTotalQuotaBytes** | number, null\\ (By)\\ \\ *read-write* | The maximum number of bytes that may be used by this file share. | |
| - | | **LowSpaceWarningThresholdPercents** [ {} ] | array | | read-write | An array of low space warning threshold percentages for the file share. | | + | | **FileSharingProtocols** [ {} ] | array\\ \\ *read-only* | An array of file sharing protocols supported by this file share. | |
| - | | **Name** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Oem** {} | object | + | | **Links** { | object\\ \\ *read-only* | Contains links to other resources that are related to this resource. | |
| - | | **RootAccess** | boolean | + | | < |
| - | | **Status** { | object | + | | < |
| - | | \ \ \ \ \ \ **Health** | string | + | | < |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | } | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **LowSpaceWarningThresholdPercents** [ {} ] | array\\ \\ *read-write* | An array of low space warning threshold percentages for the file share. | |
| - | | \ \ \ \ \ \ **State** | string | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | } | | | | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **WritePolicy** | string | + | | **RootAccess** | boolean, null\\ \\ *read-only* | Root access is allowed by the file share. | |
| + | | **Status** { | object, null\\ \\ *read-only* | Indicates the status of the file share. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **WritePolicy** | string, null\\ \\ *read-write* | Defines how writes are replicated to the shared source. | ||
| - | === Property Details === | + | ===== Property Details |
| - | == FileShareQuotaType == | + | ==== FileShareQuotaType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Hard | Quotas are enabled and enforced. | | | Hard | Quotas are enabled and enforced. | | ||
| | Soft | Quotas are enabled but not enforced. | | | Soft | Quotas are enabled but not enforced. | | ||
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 1539: | Line 1768: | ||
| | Updating | The element is updating and may be unavailable or degraded. | | | Updating | The element is updating and may be unavailable or degraded. | | ||
| - | == WritePolicy == | + | ==== WritePolicy: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Active | Active-Active (i.e. bidirectional) synchronous updates. | | | Active | Active-Active (i.e. bidirectional) synchronous updates. | | ||
| | Adaptive | Allows implementation to switch between synchronous and asynchronous modes. | | | Adaptive | Allows implementation to switch between synchronous and asynchronous modes. | | ||
| Line 1548: | Line 1778: | ||
| - | ===== FileSystem ===== | + | ====== FileSystem |
| An instance of a hierarchical namespace of files. | An instance of a hierarchical namespace of files. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **AccessCapabilities** [ {} ] | array | | read-write | An array of supported IO access capabilities. | | + | | --- | --- | --- | |
| - | | **BlockSizeBytes** | number | + | | **AccessCapabilities** [ {} ] | array\\ \\ *read-write* | An array of supported IO access capabilities. | |
| - | | **Capacity** { | object | + | | **BlockSizeBytes** | number, null\\ (By)\\ \\ *read-only* | Block size of the file system in bytes. | |
| - | | \ \ \ \ \ \ **Data** {} | object | + | | **Capacity** { | object, null\\ \\ *read-write* | Capacity allocated to the file system. | |
| - | | \ \ \ \ \ \ **IsThinProvisioned** | boolean | + | | < |
| - | | \ \ \ \ \ \ **Metadata** {} | object | + | | < |
| - | | \ \ \ \ \ \ **Snapshot** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **CapacitySources** [ { | array | | read-write | An array of capacity sources for the file system. | | + | | } | |
| - | | \ \ \ \ \ \ **ProvidedCapacity** {} | object | + | | **CapacitySources** [ { | array\\ \\ *read-write* | An array of capacity sources for the file system. | |
| - | | \ \ \ \ \ \ **ProvidedClassOfService** {} | object | + | | < |
| - | | \ \ \ \ \ \ **ProvidingDrives** {} | object | + | | < |
| - | | \ \ \ \ \ \ **ProvidingPools** {} | object | + | | < |
| - | | \ \ \ \ \ \ **ProvidingVolumes** {} | object | + | | < |
| - | | } ] | | | | + | | < |
| - | | **CasePreserved** | boolean | + | | } ] | |
| - | | **CaseSensitive** | boolean | + | | **CasePreserved** | boolean, null\\ \\ *read-write* | The case of file names is preserved by the file system. | |
| - | | **CharacterCodeSet** [ {} ] | array | | read-write | An array of the character sets or encodings supported by the file system. | | + | | **CaseSensitive** | boolean, null\\ \\ *read-write* | Case sensitive file names are supported by the file system. | |
| - | | **ClusterSizeBytes** | number | + | | **CharacterCodeSet** [ {} ] | array\\ \\ *read-write* | An array of the character sets or encodings supported by the file system. | |
| - | | **Description** | string | + | | **ClusterSizeBytes** | number, null\\ (By)\\ \\ *read-write* | A value indicating the minimum file allocation size imposed by the file system. | |
| - | | **ExportedShares** | array(reference([[documentation: | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Id** | string | | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **ExportedShares** |
| - | | **Links** { | object | + | | < |
| - | | \ \ \ \ \ \ **ClassOfService** {} | object | Yes | read-write | The ClassOfService of this file system. | | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **ReplicaCollection** [ {} ] | array | | read-only | An array of links to replicas for this file system. | | + | | < |
| - | | } | | | | + | | < |
| - | | **LowSpaceWarningThresholdPercents** [ {} ] | array | | read-write | An array of low space warning threshold percentages for the file system. | | + | | < |
| - | | **MaxFileNameLengthBytes** | number | + | | < |
| - | | **Name** | string | + | | < |
| - | | **Oem** {} | object | + | | < |
| - | | **RemainingCapacity** { | object | + | | < |
| - | | \ \ \ \ \ \ **Data** {} | object | + | | < |
| - | | \ \ \ \ \ \ **IsThinProvisioned** | boolean | + | | < |
| - | | \ \ \ \ \ \ **Metadata** {} | object | + | | < |
| - | | \ \ \ \ \ \ **Snapshot** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **ReplicaInfo** { | object | + | | < |
| - | | \ \ \ \ \ \ **ConsistencyEnabled** | boolean | + | | < |
| - | | \ \ \ \ \ \ **ConsistencyState** | string | + | | < |
| - | | \ \ \ \ \ \ **ConsistencyStatus** | string | + | | } ] | |
| - | | \ \ \ \ \ \ **ConsistencyType** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **FailedCopyStopsHostIO** | boolean | + | | **Links** { | object\\ \\ *read-only* | Contains links to other resources that are related to this resource. | |
| - | | \ \ \ \ \ \ **PercentSynced** | number | + | | < |
| - | | \ \ \ \ \ \ **Replica** | | Yes | read-write | The resource that is the source of this replica. | | + | | < |
| - | | \ \ \ \ \ \ **ReplicaPriority** | string | + | | < |
| - | | \ \ \ \ \ \ **ReplicaProgressStatus** | string | + | | < |
| - | | \ \ \ \ \ \ **ReplicaReadOnlyAccess** | string | + | | } | |
| - | | \ \ \ \ \ \ **ReplicaRecoveryMode** | string | + | | **LowSpaceWarningThresholdPercents** [ {} ] | array\\ \\ *read-write* | An array of low space warning threshold percentages for the file system. | |
| - | | \ \ \ \ \ \ **ReplicaRole** | string | + | | **MaxFileNameLengthBytes** | number, null\\ (By)\\ \\ *read-write* | A value indicating the maximum length of a file name within the file system. | |
| - | | \ \ \ \ \ \ **ReplicaSkewBytes** | number | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | \ \ \ \ \ \ **ReplicaState** | string | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | \ \ \ \ \ \ **ReplicaType** | string | + | | **RemainingCapacity** { | object, null\\ \\ *read-write* | Remaining capacity allocated to the file system. | |
| - | | \ \ \ \ \ \ **ReplicaUpdateMode** | string | + | | < |
| - | | \ \ \ \ \ \ **RequestedReplicaState** | string | + | | < |
| - | | \ \ \ \ \ \ **SyncMaintained** | boolean | + | | < |
| - | | \ \ \ \ \ \ **UndiscoveredElement** | string | + | | < |
| - | | \ \ \ \ \ \ **WhenActivated** | string | + | | } | |
| - | | \ \ \ \ \ \ **WhenDeactivated** | string | + | | **ReplicaInfo** { | object, null\\ \\ *read-write* | This value describes the replica attributes if this file system is a replica. | |
| - | | \ \ \ \ \ \ **WhenEstablished** | string | + | | < |
| - | | \ \ \ \ \ \ **WhenSuspended** | string | + | | < |
| - | | \ \ \ \ \ \ **WhenSynced** | string | + | | < |
| - | | \ \ \ \ \ \ **WhenSynchronized** | string | + | | < |
| - | | } | | | | + | | < |
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == ConsistencyState == | + | ==== ConsistencyState: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Consistent | Consistent. | | | Consistent | Consistent. | | ||
| | Inconsistent | Not consistent. | | | Inconsistent | Not consistent. | | ||
| - | == ConsistencyStatus == | + | ==== ConsistencyStatus: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Consistent | Consistent. | | | Consistent | Consistent. | | ||
| | Disabled | Consistency disabled. | | | Disabled | Consistency disabled. | | ||
| Line 1634: | Line 1887: | ||
| | InProgress | Becoming consistent. | | | InProgress | Becoming consistent. | | ||
| - | == ConsistencyType == | + | ==== ConsistencyType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | SequentiallyConsistent | Sequentially consistent. | | | SequentiallyConsistent | Sequentially consistent. | | ||
| - | == FileShareQuotaType == | + | ==== FileShareQuotaType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Hard | Quotas are enabled and enforced. | | | Hard | Quotas are enabled and enforced. | | ||
| | Soft | Quotas are enabled but not enforced. | | | Soft | Quotas are enabled but not enforced. | | ||
| - | == ReplicaPriority == | + | ==== ReplicaPriority: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | High | Copy engine I/O has higher priority than host I/O. | | | High | Copy engine I/O has higher priority than host I/O. | | ||
| | Low | Copy engine I/O lower priority than host I/O. | | | Low | Copy engine I/O lower priority than host I/O. | | ||
| Line 1653: | Line 1909: | ||
| | Urgent | Copy operation to be performed as soon as possible, regardless of the host I/O requests. | | | Urgent | Copy operation to be performed as soon as possible, regardless of the host I/O requests. | | ||
| - | == ReplicaProgressStatus == | + | ==== ReplicaProgressStatus: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Aborting | Abort in progress. | | | Aborting | Abort in progress. | | ||
| | Completed | The request is completed. Data flow is idle. | | | Completed | The request is completed. Data flow is idle. | | ||
| Line 1680: | Line 1937: | ||
| | Terminating | The relationship is in the process of terminating. | | | Terminating | The relationship is in the process of terminating. | | ||
| - | == ReplicaReadOnlyAccess == | + | ==== ReplicaReadOnlyAccess: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Both | Both the source and the target elements are read only to the host. | | | Both | Both the source and the target elements are read only to the host. | | ||
| | ReplicaElement | The replica element. | | ReplicaElement | The replica element. | ||
| | SourceElement | The source element. | | | SourceElement | The source element. | | ||
| - | == ReplicaRecoveryMode == | + | ==== ReplicaRecoveryMode: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Automatic | Copy operation resumes automatically. | | | Automatic | Copy operation resumes automatically. | | ||
| | Manual | ReplicaState is set to Suspended after the link is restored. It is required to issue the Resume operation to continue. | | | Manual | ReplicaState is set to Suspended after the link is restored. It is required to issue the Resume operation to continue. | | ||
| - | == ReplicaRole == | + | ==== ReplicaRole: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Source | The source element. | | | Source | The source element. | | ||
| | Target | The target element. | | Target | The target element. | ||
| - | == ReplicaState == | + | ==== ReplicaState: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Aborted | The copy operation is aborted with the Abort operation. Use the Resync Replica operation to restart the copy operation. | | Aborted | The copy operation is aborted with the Abort operation. Use the Resync Replica operation to restart the copy operation. | ||
| | Broken | The relationship is non-functional due to errors in the source, the target, the path between the two or space constraints. | | Broken | The relationship is non-functional due to errors in the source, the target, the path between the two or space constraints. | ||
| Line 1719: | Line 1980: | ||
| | Unsynchronized | Not all the source element data has been copied to the target element. | | Unsynchronized | Not all the source element data has been copied to the target element. | ||
| - | == ReplicaType == | + | ==== ReplicaType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Clone | Create a point in time, full copy the source. | | | Clone | Create a point in time, full copy the source. | | ||
| | Mirror | Create and maintain a copy of the source. | | | Mirror | Create and maintain a copy of the source. | | ||
| Line 1727: | Line 1989: | ||
| | TokenizedClone | Create a token based clone. | | | TokenizedClone | Create a token based clone. | | ||
| - | == ReplicaUpdateMode == | + | ==== ReplicaUpdateMode: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Active | Active-Active (i.e. bidirectional) synchronous updates. | | | Active | Active-Active (i.e. bidirectional) synchronous updates. | | ||
| | Adaptive | Allows implementation to switch between synchronous and asynchronous modes. | | | Adaptive | Allows implementation to switch between synchronous and asynchronous modes. | | ||
| Line 1735: | Line 1998: | ||
| | Synchronous | Synchronous updates. | | | Synchronous | Synchronous updates. | | ||
| - | == RequestedReplicaState == | + | ==== RequestedReplicaState: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Aborted | The copy operation is aborted with the Abort operation. Use the Resync Replica operation to restart the copy operation. | | Aborted | The copy operation is aborted with the Abort operation. Use the Resync Replica operation to restart the copy operation. | ||
| | Broken | The relationship is non-functional due to errors in the source, the target, the path between the two or space constraints. | | Broken | The relationship is non-functional due to errors in the source, the target, the path between the two or space constraints. | ||
| Line 1755: | Line 2019: | ||
| | Unsynchronized | Not all the source element data has been copied to the target element. | | Unsynchronized | Not all the source element data has been copied to the target element. | ||
| - | == UndiscoveredElement == | + | ==== UndiscoveredElement: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | ReplicaElement | The replica element is undiscovered. | | | ReplicaElement | The replica element is undiscovered. | | ||
| | SourceElement | The source element is undiscovered. | | | SourceElement | The source element is undiscovered. | | ||
| - | == WritePolicy == | + | ==== WritePolicy: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Active | Active-Active (i.e. bidirectional) synchronous updates. | | | Active | Active-Active (i.e. bidirectional) synchronous updates. | | ||
| | Adaptive | Allows implementation to switch between synchronous and asynchronous modes. | | | Adaptive | Allows implementation to switch between synchronous and asynchronous modes. | | ||
| Line 1770: | Line 2036: | ||
| - | ===== FileSystemCollection | + | ====== |
| - | + | ||
| - | Contains a collection of references to FileSystem resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== HostInterface | + | |
| This schema defines a Host Interface resource. | This schema defines a Host Interface resource. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **AuthenticationModes** [ {} ] | array | | read-write | This indicates the authentication modes available on this interface. | | + | | --- | --- | --- | |
| - | | **Description** | string | + | | **AuthenticationModes** [ {} ] | array\\ \\ *read-write* | This indicates the authentication modes available on this interface. | |
| - | | **ExternallyAccessible** | boolean | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **FirmwareAuthEnabled** | boolean | + | | **ExternallyAccessible** | boolean, null\\ \\ *read-only* | This indicates whether this interface is accessible by external entities. | |
| - | | **FirmwareAuthRoleId** | string | + | | **FirmwareAuthEnabled** | boolean, null\\ \\ *read-write* | This indicates whether this firmware authentication is enabled for this interface. | |
| - | | **HostEthernetInterfaces** | reference([[documentation: | + | | **FirmwareAuthRoleId** | string\\ \\ *read-write* | This property contains the Role for firmware authentication on this interface. | |
| - | | **HostInterfaceType** | string | Yes | read-write | This indicates the Host Interface type for this interface.\\ //See Property Details, below, for more information about this property.// | | + | | **HostEthernetInterfaces** |
| - | | **Id** | string | + | | < |
| - | | **InterfaceEnabled** | boolean | + | | < |
| - | | **KernelAuthEnabled** | boolean | + | | < |
| - | | **KernelAuthRoleId** | string | + | | < |
| - | | **Links** { | object | + | | < |
| - | | \ \ \ \ \ \ **ComputerSystems** [ {} ] | array | | read-only | An array of references to the Computer Systems connected to this Host Interface. | | + | | } | |
| - | | \ \ \ \ \ \ **FirmwareAuthRole** {} | object | + | | **HostInterfaceType** | string, null\\ \\ *read-write* |
| - | | \ \ \ \ \ \ **KernelAuthRole** {} | object | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **InterfaceEnabled** | boolean, null\\ \\ *read-write* | This indicates whether this interface is enabled. | |
| - | | } | | | | + | | **KernelAuthEnabled** | boolean, null\\ \\ *read-write* | This indicates whether this kernel authentication is enabled for this interface. | |
| - | | **ManagerEthernetInterface** | reference([[documentation: | + | | **KernelAuthRoleId** | string\\ \\ *read-write* | This property contains the Role for kernel authentication on this interface. | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | | **Links** { | object\\ \\ *read-write* | Contains references to other resources that are related to this resource. | |
| - | | **NetworkProtocol** | reference([[documentation: | + | | < |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | | < |
| - | | **Status** { | object | Yes | read-only | Indicates the status of the file share. | | + | | < |
| - | | \ \ \ \ \ \ **Health** | string | + | | < |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | } | |
| - | | \ \ \ \ \ \ **State** | string | + | | **ManagerEthernetInterface** |
| - | | } | | | | + | | < |
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | | ||
| + | | **NetworkProtocol** { | object\\ \\ *read-write* | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Oem** {} | object\\ \\ *read-write* | ||
| + | | **Status** { | object, null\\ \\ *read-only* | Indicates the status of the file share. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HostInterfaceType == | + | ==== HostInterfaceType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | NetworkHostInterface | This interface is a Network Host Interface. | | | NetworkHostInterface | This interface is a Network Host Interface. | | ||
| - | == LinkStatus == | + | ==== LinkStatus: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | LinkDown | There is no link on this interface, but the interface is connected. | | | LinkDown | There is no link on this interface, but the interface is connected. | | ||
| | LinkUp | The link is available for communication on this interface. | | | LinkUp | The link is available for communication on this interface. | | ||
| | NoLink | There is no link or connection detected on this interface. | | | NoLink | There is no link or connection detected on this interface. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 1857: | Line 2171: | ||
| - | ===== HostInterfaceCollection | + | ====== |
| - | + | ||
| - | A Collection of HostInterface resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== HostedStorageServices | + | |
| A Collection of Hosted Storage Service resource instances. | A Collection of Hosted Storage Service resource instances. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Description** | string | + | | --- | --- | --- | |
| - | | **Members** | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | | **Members** [ { | array\\ \\ *read-write* | The value of each member references a StorageService resource. | |
| - | | **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\\ \\ *read-write* | ||
| - | ===== IOConnectivityLoSCapabilities ===== | + | ====== IOConnectivityLoSCapabilities |
| Describe IO Connectivity capabilities. | Describe IO Connectivity capabilities. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Description** | string | + | | --- | --- | --- | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Identifier** { | object | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **DurableName** | string | + | | **Identifier** { | object, null\\ \\ *read-only* | The value identifies this resource. | |
| - | | \ \ \ \ \ \ **DurableNameFormat** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **MaxSupportedIOPS** | number | + | | } | |
| - | | **Name** | string | + | | **MaxSupportedIOPS** | number, null\\ \\ *read-write* | The maximum IOPS that a connection can support. | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **SupportedAccessProtocols** [ {} ] | array | | read-write | SupportedAccessProtocols. | | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **SupportedIOConnectivityLinesOfService** [ { | array | | read-write | Collection of known and supported IOConnectivityLinesOfService. | | + | | **SupportedAccessProtocols** [ {} ] | array\\ \\ *read-write* | SupportedAccessProtocols. | |
| - | | \ \ \ \ \ \ **AccessProtocol** | string | + | | **SupportedIOConnectivityLinesOfService** [ { | array\\ \\ *read-write* | Collection of known and supported IOConnectivityLinesOfService. | |
| - | | \ \ \ \ \ \ **MaxIOPS** | number | + | | < |
| - | | \ \ \ \ \ \ **Name** | string | + | | < |
| - | | } ] | | | | + | | < |
| + | | } ] | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == AccessProtocol == | + | ==== AccessProtocol: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | FC | FC2 | | | FC | FC2 | | ||
| | FCOE | FC2 over Ethernet | | | FCOE | FC2 over Ethernet | | ||
| Line 1919: | Line 2247: | ||
| | iSCSI | Internet SCSI | | | iSCSI | Internet SCSI | | ||
| - | == DurableNameFormat == | + | ==== DurableNameFormat: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | EUI | IEEE-defined 64-bit Extended Unique Identifier | | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
| | FC_WWN | Fibre Channel World Wide Name | | | FC_WWN | Fibre Channel World Wide Name | | ||
| Line 1929: | Line 2258: | ||
| - | ===== IOPerformanceLoSCapabilities ===== | + | ====== IOPerformanceLoSCapabilities |
| Describe io performance capabilities. | Describe io performance capabilities. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Description** | string | + | | --- | --- | --- | |
| - | | **IOLimitingIsSupported** | boolean | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Id** | string | + | | **IOLimitingIsSupported** | boolean, null\\ \\ *read-write* | Limiting IOPS is supported. | |
| - | | **Identifier** { | object | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **DurableName** | string | + | | **Identifier** { | object, null\\ \\ *read-only* | The value identifies this resource. | |
| - | | \ \ \ \ \ \ **DurableNameFormat** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **MaxSamplePeriod** | string | + | | } | |
| - | | **MinSamplePeriod** | string | + | | **MaxSamplePeriod** | string, null\\ (s)\\ \\ *read-write* | Maximum sampling period over which average values are calculated. | |
| - | | **MinSupportedIoOperationLatencyMicroseconds** | number | + | | **MinSamplePeriod** | string, null\\ (s)\\ \\ *read-write* | Minimum sampling period over which average values are calculated. | |
| - | | **Name** | string | + | | **MinSupportedIoOperationLatencyMicroseconds** | number, null\\ (us)\\ \\ *read-write* | Minimum supported average IO latency. | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **SupportedIOPerformanceLinesOfService** [ { | array | | read-write | Collection of known and supported IOPerformanceLinesOfService. | | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | \ \ \ \ \ \ **AverageIOOperationLatencyMicroseconds** | number | Yes | read-write | Expected average IO latency.\\ unit: us | | + | | **SupportedIOPerformanceLinesOfService** [ { | array\\ \\ *read-write* | Collection of known and supported IOPerformanceLinesOfService. | |
| - | | \ \ \ \ \ \ **IOOperationsPerSecondIsLimited** | boolean | + | | < |
| - | | \ \ \ \ \ \ **IOWorkload** {} | object | + | | < |
| - | | \ \ \ \ \ \ **MaxIOOperationsPerSecondPerTerabyte** | number | + | | < |
| - | | \ \ \ \ \ \ **Name** | string | + | | < |
| - | | \ \ \ \ \ \ **SamplePeriod** | string | + | | < |
| - | | } ] | | | | + | | < |
| - | | **SupportedIOWorkloads** [ { | array | | read-write | A collection of supported workloads. | | + | | } ] | |
| - | | \ \ \ \ \ \ **Components** [ {} ] | array | | read-write | An array of IO workload component descriptions. | | + | | **SupportedIOWorkloads** [ { | array\\ \\ *read-write* | A collection of supported workloads. | |
| - | | \ \ \ \ \ \ **Name** | string | + | | < |
| - | | } ] | | | | + | | < |
| + | | } ] | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == DurableNameFormat == | + | ==== DurableNameFormat: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | EUI | IEEE-defined 64-bit Extended Unique Identifier | | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
| | FC_WWN | Fibre Channel World Wide Name | | | FC_WWN | Fibre Channel World Wide Name | | ||
| Line 1971: | Line 2302: | ||
| - | ===== JsonSchemaFile ===== | + | ====== JsonSchemaFile |
| This is the schema definition for the Schema File locator resource. | This is the schema definition for the Schema File locator resource. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Description** | string | + | | --- | --- | --- | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Languages** [ {} ] | array | | read-only | Language codes for the schemas available. | | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Location** [ { | array | | read-write | Location information for this schema file. | | + | | **Languages** [ {} ] | array\\ \\ *read-only* | Language codes for the schemas available. | |
| - | | \ \ \ \ \ \ **ArchiveFile** | string | + | | **Location** [ { | array\\ \\ *read-write* | Location information for this schema file. | |
| - | | \ \ \ \ \ \ **ArchiveUri** | string | + | | < |
| - | | \ \ \ \ \ \ **Language** | string | + | | < |
| - | | \ \ \ \ \ \ **PublicationUri** | string | + | | < |
| - | | \ \ \ \ \ \ **Uri** | string | + | | < |
| - | | } ] | | | | + | | < |
| - | | **Name** | string | + | | } ] | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **Schema** | string | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | + | | **Schema** | string\\ \\ *read-only* | The @odata.type name this schema describes. | | |
| - | ===== JsonSchemaFileCollection ===== | + | |
| - | + | ||
| - | A Collection of JsonSchemaFile resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | ===== LogEntry ===== | + | ====== LogEntry |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Created** | string | + | | --- | --- | --- | |
| - | | **Description** | string | + | | **Created** | string\\ \\ *read-only* | The time the log entry was created. | |
| - | | **EntryCode** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **EntryType** | string | + | | **EntryCode** | string, null\\ \\ *read-write* | If the EntryType is SEL, this will have the entry code for the log entry. |
| - | | **EventId** | string | + | | **EntryType** | string\\ \\ *read-write* | his is the type of log entry. |
| - | | **EventTimestamp** | string | + | | **EventId** *(v1.1+)* | string\\ \\ *read-only* | This is a unique instance identifier of an event. | |
| - | | **EventType** | | + | | **EventTimestamp** *(v1.1+)* | string\\ \\ *read-only* | This is time the event occurred. | |
| - | | **Id** | string | + | | **EventType** *(v1.1+)* | \\ \\ *read-only* | This indicates the type of an event recorded in this log. | |
| - | | **Links** { | object | + | | **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. | |
| - | | \ \ \ \ \ \ **OriginOfCondition** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **Message** | string | + | | } | |
| - | | **MessageArgs** [ {} ] | array | | read-only | The values of this property shall be any arguments for the message. | | + | | **Message** | string, null\\ \\ *read-only* | This property decodes from EntryType: |
| - | | **MessageId** | string | + | | **MessageArgs** [ {} ] | array\\ \\ *read-only* | The values of this property shall be any arguments for the message. | |
| - | | **Name** | string | + | | **MessageId** | string\\ \\ *read-only* | This property decodes from EntryType: |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **OemRecordFormat** | string | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **SensorNumber** | number | + | | **OemRecordFormat** | string, null\\ \\ *read-only* | If the entry type is Oem, this will contain more information about the record format from the Oem. | |
| - | | **SensorType** | string | + | | **SensorNumber** | number, null\\ \\ *read-only* | This property decodes from EntryType: |
| - | | **Severity** | string | + | | **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.* | |
| + | | **Severity** | string, null\\ \\ *read-write* | This is the severity of the log entry. | ||
| - | === Property Details === | + | ===== Property Details |
| - | == EntryCode == | + | ==== EntryCode: ==== |
| - | ^ string | + | | string |
| - | | Assert | | + | | --- | |
| - | | Deassert | | + | | Assert | |
| - | | Lower Non-critical - going low | | + | | Deassert | |
| - | | Lower Non-critical - going high | | + | | Lower Non-critical - going low | |
| - | | Lower Critical - going low | | + | | Lower Non-critical - going high | |
| - | | Lower Critical - going high | | + | | Lower Critical - going low | |
| - | | Lower Non-recoverable - going low | | + | | Lower Critical - going high | |
| - | | Lower Non-recoverable - going high | | + | | Lower Non-recoverable - going low | |
| - | | Upper Non-critical - going low | | + | | Lower Non-recoverable - going high | |
| - | | Upper Non-critical - going high | | + | | Upper Non-critical - going low | |
| - | | Upper Critical - going low | | + | | Upper Non-critical - going high | |
| - | | Upper Critical - going high | | + | | Upper Critical - going low | |
| - | | Upper Non-recoverable - going low | | + | | Upper Critical - going high | |
| - | | Upper Non-recoverable - going high | | + | | Upper Non-recoverable - going low | |
| - | | Transition to Idle | | + | | Upper Non-recoverable - going high | |
| - | | Transition to Active | | + | | Transition to Idle | |
| - | | Transition to Busy | | + | | Transition to Active | |
| - | | State Deasserted | | + | | Transition to Busy | |
| - | | State Asserted | | + | | State Deasserted | |
| - | | Predictive Failure deasserted | | + | | State Asserted | |
| - | | Predictive Failure asserted | | + | | Predictive Failure deasserted | |
| - | | Limit Not Exceeded | | + | | Predictive Failure asserted | |
| - | | Limit Exceeded | | + | | Limit Not Exceeded | |
| - | | Performance Met | | + | | Limit Exceeded | |
| - | | Performance Lags | | + | | Performance Met | |
| - | | Transition to OK | | + | | Performance Lags | |
| - | | Transition to Non-Critical from OK | | + | | Transition to OK | |
| - | | Transition to Critical from less severe | | + | | Transition to Non-Critical from OK | |
| - | | Transition to Non-recoverable from less severe | | + | | Transition to Critical from less severe | |
| - | | Transition to Non-Critical from more severe | | + | | Transition to Non-recoverable from less severe | |
| - | | Transition to Critical from Non-recoverable | | + | | Transition to Non-Critical from more severe | |
| - | | Transition to Non-recoverable | | + | | Transition to Critical from Non-recoverable | |
| - | | Monitor | | + | | Transition to Non-recoverable | |
| - | | Informational | | + | | Monitor | |
| - | | Device Removed / Device Absent | | + | | Informational | |
| - | | Device Inserted / Device Present | | + | | Device Removed / Device Absent | |
| - | | Device Disabled | | + | | Device Inserted / Device Present | |
| - | | Device Enabled | | + | | Device Disabled | |
| - | | Transition to Running | | + | | Device Enabled | |
| - | | Transition to In Test | | + | | Transition to Running | |
| - | | Transition to Power Off | | + | | Transition to In Test | |
| - | | Transition to On Line | | + | | Transition to Power Off | |
| - | | Transition to Off Line | | + | | Transition to On Line | |
| - | | Transition to Off Duty | | + | | Transition to Off Line | |
| - | | Transition to Degraded | | + | | Transition to Off Duty | |
| - | | Transition to Power Save | | + | | Transition to Degraded | |
| - | | Install Error | | + | | Transition to Power Save | |
| - | | Fully Redundant | | + | | Install Error | |
| - | | Redundancy Lost | | + | | Fully Redundant | |
| - | | Redundancy Degraded | | + | | Redundancy Lost | |
| - | | Non-redundant: | + | | Redundancy Degraded | |
| - | | Non-redundant: | + | | Non-redundant: |
| - | | Non-redundant: | + | | Non-redundant: |
| - | | Redundancy Degraded from Fully Redundant | | + | | Non-redundant: |
| - | | Redundancy Degraded from Non-redundant | | + | | Redundancy Degraded from Fully Redundant | |
| - | | D0 Power State | | + | | Redundancy Degraded from Non-redundant | |
| - | | D1 Power State | | + | | D0 Power State | |
| - | | D2 Power State | | + | | D1 Power State | |
| - | | D3 Power State | | + | | D2 Power State | |
| + | | D3 Power State | | ||
| - | == EntryType == | + | ==== EntryType: ==== |
| - | ^ string | + | | string |
| - | | Event | | + | | --- | |
| - | | SEL | | + | | Event | |
| - | | Oem | | + | | SEL | |
| + | | Oem | | ||
| - | == SensorType == | + | ==== SensorType: ==== |
| - | ^ string | + | | string |
| - | | Platform Security Violation Attempt | | + | | --- | |
| - | | Temperature | | + | | Platform Security Violation Attempt | |
| - | | Voltage | | + | | Temperature | |
| - | | Current | | + | | Voltage | |
| - | | Fan | | + | | Current | |
| - | | Physical Chassis Security | | + | | Fan | |
| - | | Processor | | + | | Physical Chassis Security | |
| - | | Power Supply / Converter | | + | | Processor | |
| - | | PowerUnit | | + | | Power Supply / Converter | |
| - | | CoolingDevice | | + | | PowerUnit | |
| - | | Other Units-based Sensor | | + | | CoolingDevice | |
| - | | Memory | | + | | Other Units-based Sensor | |
| - | | Drive Slot/Bay | | + | | Memory | |
| - | | POST Memory Resize | | + | | Drive Slot/Bay | |
| - | | System Firmware Progress | | + | | POST Memory Resize | |
| - | | Event Logging Disabled | | + | | System Firmware Progress | |
| - | | System Event | | + | | Event Logging Disabled | |
| - | | Critical Interrupt | | + | | System Event | |
| - | | Button/ | + | | Critical Interrupt | |
| - | | Module/ | + | | Button/ |
| - | | Microcontroller/ | + | | Module/ |
| - | | Add-in Card | | + | | Microcontroller/ |
| - | | Chassis | | + | | Add-in Card | |
| - | | ChipSet | | + | | Chassis | |
| - | | Other FRU | | + | | ChipSet | |
| - | | Cable/ | + | | Other FRU | |
| - | | Terminator | | + | | Cable/ |
| - | | SystemBoot/ | + | | Terminator | |
| - | | Boot Error | | + | | SystemBoot/ |
| - | | BaseOSBoot/ | + | | Boot Error | |
| - | | OS Stop/ | + | | BaseOSBoot/ |
| - | | Slot/ | + | | OS Stop/ |
| - | | System ACPI PowerState | | + | | Slot/ |
| - | | Watchdog | | + | | System ACPI PowerState | |
| - | | Platform Alert | | + | | Watchdog | |
| - | | Entity Presence | | + | | Platform Alert | |
| - | | Monitor ASIC/IC | | + | | Entity Presence | |
| - | | LAN | | + | | Monitor ASIC/IC | |
| - | | Management Subsystem Health | | + | | LAN | |
| - | | Battery | | + | | Management Subsystem Health | |
| - | | Session Audit | | + | | Battery | |
| - | | Version Change | | + | | Session Audit | |
| - | | FRUState | | + | | Version Change | |
| + | | FRUState | | ||
| - | == Severity == | + | ==== Severity: ==== |
| - | ^ string | + | | string |
| - | | OK | | + | | --- | |
| - | | Warning | | + | | OK | |
| - | | Critical | | + | | Warning | |
| + | | Critical | | ||
| - | ===== LogEntryCollection | + | ====== |
| - | + | ||
| - | A Collection of LogEntry resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== LogService | + | |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Actions** { | object | + | | --- | --- | --- | |
| - | | \ \ \ \ \ \ **# | + | | **Actions** { | object\\ \\ *read-write* | The available actions for this resource. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **DateTime** | string | + | | } | |
| - | | **DateTimeLocalOffset** | string | + | | **DateTime** | string, null\\ \\ *read-write* | The current DateTime (with offset) for the log service, used to set or read time. | |
| - | | **Description** | string | + | | **DateTimeLocalOffset** | string, null\\ \\ *read-write* | The time offset from UTC that the DateTime property is set to in format: +06:00 . | |
| - | | **Entries** | reference([[documentation: | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Id** | string | + | | **Entries** { | object\\ \\ *read-write* | References to the log entry collection. |
| - | | **MaxNumberOfRecords** | number | + | | < |
| - | | **Name** | string | + | | < |
| - | | **Oem** {} | object | + | | < |
| - | | **OverWritePolicy** | string | + | | < |
| - | | **ServiceEnabled** | boolean | + | | < |
| - | | **Status** { | object | + | | } | |
| - | | \ \ \ \ \ \ **Health** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | **MaxNumberOfRecords** | number\\ \\ *read-only* | The maximum number of log entries this service can have. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | \ \ \ \ \ \ **State** | string | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | } | | | | + | | **OverWritePolicy** | string\\ \\ *read-write* | The overwrite policy for this service that takes place when the log is full. *See Property Details, below, for more information about this property.* | |
| + | | **ServiceEnabled** | boolean, null\\ \\ *read-write* | This indicates whether this service is enabled. | | ||
| + | | **Status** { | object, null\\ \\ *read-only* | Indicates the status of the file share. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == OverWritePolicy == | + | ==== OverWritePolicy: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | NeverOverWrites | When full, new entries to the Log will be discarded. | | | NeverOverWrites | When full, new entries to the Log will be discarded. | | ||
| | Unknown | The overwrite policy is not known or is undefined. | | | Unknown | The overwrite policy is not known or is undefined. | | ||
| | WrapsWhenFull | When full, new entries to the Log will overwrite previous entries. | | | WrapsWhenFull | When full, new entries to the Log will overwrite previous entries. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 2229: | Line 2557: | ||
| - | ===== LogServiceCollection | + | ====== |
| - | + | ||
| - | A Collection of LogService resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== Manager | + | |
| This is the schema definition for a Manager. | This is the schema definition for a Manager. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Actions** { | object | + | | --- | --- | --- | |
| - | | \ \ \ \ \ \ **# | + | | **Actions** { | object\\ \\ *read-write* | The available actions for this resource. | |
| - | | \ \ \ \ \ \ **# | + | | < |
| - | | \ \ \ \ \ \ **# | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **CommandShell** { | object | + | | } | |
| - | | \ \ \ \ \ \ **ConnectTypesSupported** [ {} ] | array | | read-only | This object is used to enumerate the Command Shell connection types allowed by the implementation. | | + | | **CommandShell** { | object\\ \\ *read-write* | Information about the Command Shell service provided by this manager. | |
| - | | \ \ \ \ \ \ **MaxConcurrentSessions** | number | + | | < |
| - | | \ \ \ \ \ \ **ServiceEnabled** | boolean | + | | < |
| - | | } | | | | + | | < |
| - | | **DateTime** | string | + | | } | |
| - | | **DateTimeLocalOffset** | string | + | | **DateTime** | string, null\\ \\ *read-write* | The current DateTime (with offset) for the manager, used to set or read time. | |
| - | | **Description** | string | + | | **DateTimeLocalOffset** | string, null\\ \\ *read-write* | The time offset from UTC that the DateTime property is set to in format: +06:00 . | |
| - | | **EthernetInterfaces** | reference([[documentation: | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **FirmwareVersion** | string | Yes | read-only | The firmware version of this Manager. | | + | | **EthernetInterfaces** |
| - | | **GraphicalConsole** { | object | + | | < |
| - | | \ \ \ \ \ \ **ConnectTypesSupported** [ {} ] | array | | read-only | This object is used to enumerate the Graphical Console connection types allowed by the implementation. | | + | | < |
| - | | \ \ \ \ \ \ **MaxConcurrentSessions** | number | + | | < |
| - | | \ \ \ \ \ \ **ServiceEnabled** | boolean | + | | < |
| - | | } | | | | + | | < |
| - | | **HostInterfaces** | + | | } | |
| - | | **Id** | string | | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **FirmwareVersion** | string, null\\ \\ *read-only* |
| - | | **Links** { | object | + | | **GraphicalConsole** { | object\\ \\ *read-write* | The value of this property shall contain the information about the Graphical Console (KVM-IP) service of this manager. | |
| - | | \ \ \ \ \ \ **ManagerForChassis** [ {} ] | array | | read-only | This property is an array of references to the chassis that this manager has control over. | | + | | < |
| - | | \ \ \ \ \ \ **ManagerForServers** [ {} ] | array | | read-only | This property is an array of references to the systems that this manager has control over. | | + | | < |
| - | | \ \ \ \ \ \ **ManagerInChassis** {} | object | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | } | |
| - | | } | | | | + | | **HostInterfaces** |
| - | | **LogServices** | reference([[documentation: | + | | < |
| - | | **ManagerType** | string | | read-write | This property represents the type of manager that this resource represents.\\ //See Property Details, below, for more information about this property.// | | + | | < |
| - | | **Model** | string | + | | < |
| - | | **Name** | string | + | | < |
| - | | **NetworkProtocol** | reference([[documentation: | + | | < |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | | } | |
| - | | **PowerState** | string | + | | **Id** | string\\ \\ *read-write* |
| - | | **Redundancy** [ { | array | | read-write | Redundancy information for the managers of this system. | | + | | **Links** { | object\\ \\ *read-write* | Contains references to other resources that are related to this resource. | |
| - | | \ \ \ \ \ \ **MaxNumSupported** | number | + | | < |
| - | | \ \ \ \ \ \ **MemberId** | string | + | | < |
| - | | \ \ \ \ \ \ **MinNumNeeded** | number | + | | < |
| - | | \ \ \ \ \ \ **Mode** | string | + | | < |
| - | | \ \ \ \ \ \ **Name** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **RedundancySet** [ {} ] | array | | read-only | Contains any ids that represent components of this redundancy set. | | + | | } | |
| - | | \ \ \ \ \ \ **Status** {} | object | + | | **LogServices** |
| - | | \ \ \ \ \ \ **MemberId** | string | + | | < |
| - | | \ \ \ \ \ \ **RedundancyEnabled** | boolean | + | | < |
| - | | } ] | | | | + | | < |
| - | | **SerialConsole** { | object | + | | < |
| - | | \ \ \ \ \ \ **ConnectTypesSupported** [ {} ] | array | | read-only | This object is used to enumerate the Serial Console connection types allowed by the implementation. | | + | | < |
| - | | \ \ \ \ \ \ **MaxConcurrentSessions** | number | + | | } | |
| - | | \ \ \ \ \ \ **ServiceEnabled** | boolean | + | | **ManagerType** | string\\ \\ *read-write* |
| - | | } | | | | + | | **Model** | string, null\\ \\ *read-only* | The model information of this Manager as defined by the manufacturer. | |
| - | | **SerialInterfaces** | reference([[documentation: | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **ServiceEntryPointUUID** | string | + | | **NetworkProtocol** |
| - | | **Status** { | object | + | | < |
| - | | \ \ \ \ \ \ **Health** | string | + | | < |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **State** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **UUID** | string | + | | < |
| - | | **VirtualMedia** | reference([[documentation: | + | | < |
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ | ||
| + | | **PowerState** *(v1.2+)* | string, null\\ \\ *read-write* | ||
| + | | **Redundancy** [ { | array\\ \\ *read-write* | Redundancy information for the managers of this system. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } ] | | | | ||
| + | | **[email protected]** | string\\ \\ *read-write* | ||
| + | | **SerialConsole** { | object\\ \\ *read-write* | Information about the Serial Console service provided by this manager. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **SerialInterfaces** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **ServiceEntryPointUUID** | string\\ \\ *read-write* | The UUID of the Redfish Service provided by this manager. | ||
| + | | **Status** { | object\\ \\ *read-only* | Indicates the status of the file share. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **UUID** | string, null\\ \\ *read-write* | The Universal Unique Identifier (UUID) for this Manager. | ||
| + | | **VirtualMedia** { | object\\ \\ *read-write* | This is a reference to the Virtual Media services for this particular manager. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == ManagerType == | + | ==== ManagerType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | AuxiliaryController | A controller which provides management functions for a particular subsystem or group of devices. | | | 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. | | | BMC | A controller which provides management functions for a single computer system. | | ||
| Line 2333: | Line 2707: | ||
| | RackManager | A controller which provides management functions for a whole or part of a rack. | | | RackManager | A controller which provides management functions for a whole or part of a rack. | | ||
| - | == Mode == | + | ==== Mode: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Failover | Failure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set. | | | Failover | Failure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set. | | ||
| | N+m | Multiple units are available and active such that normal operation will continue if one or more units fail. | | | N+m | Multiple units are available and active such that normal operation will continue if one or more units fail. | | ||
| Line 2341: | Line 2716: | ||
| | Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. | | | Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. | | ||
| - | == PowerState == | + | ==== PowerState: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Off | The state is powered Off. | | | Off | The state is powered Off. | | ||
| | On | The state is powered On. | | | On | The state is powered On. | | ||
| Line 2349: | Line 2725: | ||
| | PoweringOn | A temporary state between Off and On. | | | PoweringOn | A temporary state between Off and On. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 2365: | Line 2742: | ||
| - | ===== ManagerAccount ===== | + | ====== ManagerAccount |
| - | The user accounts, owned by a Manager, are defined in this resource. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description | + | Description |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Enabled** | boolean | | read-write | This property | + | |
| - | | **Id** | string | | read-write | Uniquely identifies the resource within the collection of like resources. | | + | |
| - | | **Links** { | object | | read-write | Contains references to other resources that are related to this resource. | | + | |
| - | | \ \ \ \ \ \ **Oem** {} | object | | read-write | Oem extension object. | | + | |
| - | | \ \ \ \ \ \ **Role** {} | object | | read-write | A reference to the Role object defining Privileges for this account--returned when the resource is read. The ID of the role is the same as property RoleId. | | + | |
| - | | } | | | | + | |
| - | | **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. | + | |
| - | | **Name** | string | | read-write | A friendly | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | | **Password** | string | Yes | read-write | This property is used with a PATCH or PUT to write the password for the account. | + | |
| - | | **RoleId** | string | | read-write | This property contains the Role for this account. | | + | |
| - | | **UserName** | string | | read-write | This property contains the user name for the account. | | + | |
| - | ===== ManagerAccountCollection ===== | + | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum |
| - | A Collection of ManagerAccount resource instances. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | ||
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | ||
| - | | **Members** | array(reference([[documentation: | ||
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | ||
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | ||
| - | ===== ManagerCollection ===== | ||
| - | A Collection of Manager resource instances. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | A sample JSON payload can be included, which will land in the language-specific tab when the documentation output file is fed to the Slate documentation tool. |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | ===== ManagerNetworkProtocol ===== | + | |
| + | ```json | ||
| + | [ | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | } | ||
| + | ] | ||
| + | ``` | ||
| + | |||
| + | |||
| + | | | ||
| + | | --- | --- | --- | | ||
| + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality | ||
| + | | **Enabled** | boolean\\ \\ *read-write* | This property is used by a User Administrator to disable an account w/o having to delet the user information. | ||
| + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | | ||
| + | | **Links** { | object\\ \\ *read-write* | Contains references to other resources that are related to this resource. | | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **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. | ||
| + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | | ||
| + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ | ||
| + | | **Password** | string, null\\ \\ *read-write* | This property is used with a PATCH or PUT to write the password for the account. | ||
| + | | **RoleId** | string\\ \\ *read-write* | This property contains the Role for this account. | | ||
| + | | **UserName** | string\\ \\ *read-write* | This property contains the user name for the account. | | ||
| + | |||
| + | ====== ManagerNetworkProtocol | ||
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **DHCP** { | object | + | | --- | --- | --- | |
| - | | \ \ \ \ \ \ **Port** | number | + | | **DHCP** *(v1.1+)* { | object\\ \\ *read-write* | Settings for this Manager' |
| - | | \ \ \ \ \ \ **ProtocolEnabled** | boolean | + | | < |
| - | | } | | | | + | | < |
| - | | **Description** | string | + | | } | |
| - | | **FQDN** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **HTTP** { | object | + | | **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. | |
| - | | \ \ \ \ \ \ **Port** | number | + | | **HTTP** { | object\\ \\ *read-write* | Settings for this Manager' |
| - | | \ \ \ \ \ \ **ProtocolEnabled** | boolean | + | | < |
| - | | } | | | | + | | < |
| - | | **HTTPS** { | object | + | | } | |
| - | | \ \ \ \ \ \ **Port** | number | + | | **HTTPS** { | object\\ \\ *read-write* | Settings for this Manager' |
| - | | \ \ \ \ \ \ **ProtocolEnabled** | boolean | + | | < |
| - | | } | | | | + | | < |
| - | | **HostName** | string | + | | } | |
| - | | **IPMI** { | object | + | | **HostName** | string, null\\ \\ *read-only* | The DNS Host Name of this manager, without any domain information. | |
| - | | \ \ \ \ \ \ **Port** | number | + | | **IPMI** { | object\\ \\ *read-write* | Settings for this Manager' |
| - | | \ \ \ \ \ \ **ProtocolEnabled** | boolean | + | | < |
| - | | } | | | | + | | < |
| - | | **Id** | string | + | | } | |
| - | | **KVMIP** { | object | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **Port** | number | + | | **KVMIP** { | object\\ \\ *read-write* | Settings for this Manager' |
| - | | \ \ \ \ \ \ **ProtocolEnabled** | boolean | + | | < |
| - | | } | | | | + | | < |
| - | | **Name** | string | + | | } | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **SNMP** { | object | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | \ \ \ \ \ \ **Port** | number | + | | **SNMP** { | object\\ \\ *read-write* | Settings for this Manager' |
| - | | \ \ \ \ \ \ **ProtocolEnabled** | boolean | + | | < |
| - | | } | | | | + | | < |
| - | | **SSDP** { | object | + | | } | |
| - | | \ \ \ \ \ \ **NotifyIPv6Scope** | string | + | | **SSDP** { | object\\ \\ *read-write* | Settings for this Manager' |
| - | | \ \ \ \ \ \ **NotifyMulticastIntervalSeconds** | number | Yes | read-write | Indicates how often the Multicast is done from this service for SSDP.\\ unit: s | | + | | < |
| - | | \ \ \ \ \ \ **NotifyTTL** | number | + | | < |
| - | | \ \ \ \ \ \ **Port** | number | + | | < |
| - | | \ \ \ \ \ \ **ProtocolEnabled** | boolean | + | | < |
| - | | } | | | | + | | < |
| - | | **SSH** { | object | + | | } | |
| - | | \ \ \ \ \ \ **Port** | number | + | | **SSH** { | object\\ \\ *read-write* | Settings for this Manager' |
| - | | \ \ \ \ \ \ **ProtocolEnabled** | boolean | + | | < |
| - | | } | | | | + | | < |
| - | | **Status** { | object | + | | } | |
| - | | \ \ \ \ \ \ **Health** | string | + | | **Status** { | object\\ \\ *read-only* | Indicates the status of the file share. | |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **State** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **Telnet** { | object | + | | } | |
| - | | \ \ \ \ \ \ **Port** | number | + | | **Telnet** { | object\\ \\ *read-write* | Settings for this Manager' |
| - | | \ \ \ \ \ \ **ProtocolEnabled** | boolean | + | | < |
| - | | } | | | | + | | < |
| - | | **VirtualMedia** { | object | + | | } | |
| - | | \ \ \ \ \ \ **Port** | number | + | | **VirtualMedia** { | object\\ \\ *read-write* | Settings for this Manager' |
| - | | \ \ \ \ \ \ **ProtocolEnabled** | boolean | + | | < |
| - | | } | | | | + | | < |
| + | | } | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == NotifyIPv6Scope == | + | ==== NotifyIPv6Scope: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Link | SSDP Notify messages are sent to addresses in the IPv6 Local Link scope. | | | Link | SSDP Notify messages are sent to addresses in the IPv6 Local Link scope. | | ||
| | Organization | SSDP Notify messages are sent to addresses in the IPv6 Local Organization scope. | | | Organization | SSDP Notify messages are sent to addresses in the IPv6 Local Organization scope. | | ||
| | Site | SSDP Notify messages are sent to addresses in the IPv6 Local Site scope. | | | Site | SSDP Notify messages are sent to addresses in the IPv6 Local Site scope. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 2504: | Line 2907: | ||
| - | ===== Memory ===== | + | ====== Memory |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Actions** { | object | + | | --- | --- | --- | |
| - | | \ \ \ \ \ \ **# | + | | **Actions** { | object\\ \\ *read-write* | The available actions for this resource. | |
| - | | \ \ \ \ \ \ **# | + | | < |
| - | | \ \ \ \ \ \ **# | + | | < |
| - | | \ \ \ \ \ \ **# | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **AllowedSpeedsMHz** [ {} ] | array | | read-only | Speed bins supported by this Memory. | | + | | } | |
| - | | **BaseModuleType** | string | + | | **AllowedSpeedsMHz** [ {} ] | array\\ \\ *read-only* | Speed bins supported by this Memory. | |
| - | | **BusWidthBits** | number | + | | **BaseModuleType** | string, null\\ \\ *read-write* | The base module type of Memory. |
| - | | **CapacityMiB** | number | + | | **BusWidthBits** | number, null\\ \\ *read-only* | Bus Width in bits. | |
| - | | **DataWidthBits** | number | + | | **CapacityMiB** | number, null\\ (MiBy)\\ \\ *read-only* | Memory Capacity in MiB. | |
| - | | **Description** | string | + | | **DataWidthBits** | number, null\\ \\ *read-only* | Data Width in bits. | |
| - | | **DeviceID** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **DeviceLocator** | string | + | | **DeviceID** | string, null\\ \\ *read-only* | Device ID. | |
| - | | **ErrorCorrection** | string | + | | **DeviceLocator** | string, null\\ \\ *read-only* | Location of the Memory in the platform. | |
| - | | **FirmwareApiVersion** | string | + | | **ErrorCorrection** | string, null\\ \\ *read-write* | Error correction scheme supported for this memory. |
| - | | **FirmwareRevision** | string | + | | **FirmwareApiVersion** | string, null\\ \\ *read-only* | Version of API supported by the firmware. | |
| - | | **FunctionClasses** [ {} ] | array | | read-only | Function Classes by the Memory. | | + | | **FirmwareRevision** | string, null\\ \\ *read-only* | Revision of firmware on the Memory controller. | |
| - | | **Id** | string | + | | **FunctionClasses** [ {} ] | array\\ \\ *read-only* | Function Classes by the Memory. | |
| - | | **IsRankSpareEnabled** | boolean | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **IsSpareDeviceEnabled** | boolean | + | | **IsRankSpareEnabled** | boolean, null\\ \\ *read-only* | Rank spare enabled status. | |
| - | | **Manufacturer** | string | + | | **IsSpareDeviceEnabled** | boolean, null\\ \\ *read-only* | Spare device enabled status. | |
| - | | **MaxTDPMilliWatts** [ {} ] | array | | read-only | Maximum TDPs in milli Watts. | | + | | **Manufacturer** | string, null\\ \\ *read-only* | The Memory manufacturer. | |
| - | | **MemoryDeviceType** | string | + | | **MaxTDPMilliWatts** [ {} ] | array\\ \\ *read-only* | Maximum TDPs in milli Watts. | |
| - | | **MemoryLocation** { | object | + | | **MemoryDeviceType** | string, null\\ \\ *read-write* | Type details of the Memory. |
| - | | \ \ \ \ \ \ **Channel** | number | + | | **MemoryLocation** { | object\\ \\ *read-write* | Memory connection information to sockets and memory controllers. | |
| - | | \ \ \ \ \ \ **MemoryController** | number | + | | < |
| - | | \ \ \ \ \ \ **Slot** | number | + | | < |
| - | | \ \ \ \ \ \ **Socket** | number | + | | < |
| - | | } | | | | + | | < |
| - | | **MemoryMedia** [ {} ] | array | | read-only | Media of this Memory. | | + | | } | |
| - | | **MemoryType** | string | + | | **MemoryMedia** [ {} ] | array\\ \\ *read-only* | Media of this Memory. | |
| - | | **Metrics** | reference([[documentation: | + | | **MemoryType** | string, null\\ \\ *read-write* | The type of Memory. |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | | **Metrics** |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | | < |
| - | | **OperatingMemoryModes** [ {} ] | array | | read-only | Memory modes supported by the Memory. | | + | | < |
| - | | **OperatingSpeedMhz** | number | + | | < |
| - | | **PartNumber** | string | + | | < |
| - | | **PersistentRegionSizeLimitMiB** | number | + | | < |
| - | | **PowerManagementPolicy** { | object | + | | < |
| - | | \ \ \ \ \ \ **AveragePowerBudgetMilliWatts** | number | + | | < |
| - | | \ \ \ \ \ \ **MaxTDPMilliWatts** | number | + | | < |
| - | | \ \ \ \ \ \ **PeakPowerBudgetMilliWatts** | number | + | | < |
| - | | \ \ \ \ \ \ **PolicyEnabled** | boolean | + | | } | |
| - | | } | | | | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **RankCount** | number | + | | **Oem** {} | object\\ \\ *read-write* |
| - | | **Regions** [ { | array | | read-write | Memory regions information within the Memory. | | + | | **OperatingMemoryModes** [ {} ] | array\\ \\ *read-only* | Memory modes supported by the Memory. | |
| - | | \ \ \ \ \ \ **MemoryClassification** | string | + | | **OperatingSpeedMhz** | number, null\\ \\ *read-only* | Operating speed of Memory in MHz. | |
| - | | \ \ \ \ \ \ **OffsetMiB** | number | + | | **PartNumber** | string, null\\ \\ *read-only* | The product part number of this device. | |
| - | | \ \ \ \ \ \ **PassphraseState** | boolean | + | | **PersistentRegionSizeLimitMiB** | number, null\\ \\ *read-only* | Total size of persistent regions in MiB. | |
| - | | \ \ \ \ \ \ **RegionId** | string | + | | **PowerManagementPolicy** { | object\\ \\ *read-write* | Power management policy information. | |
| - | | \ \ \ \ \ \ **SizeMiB** | number | + | | < |
| - | | } ] | | | | + | | < |
| - | | **SecurityCapabilities** { | object | + | | < |
| - | | \ \ \ \ \ \ **MaxPassphraseCount** | number | + | | < |
| - | | \ \ \ \ \ \ **PassphraseCapable** | boolean | + | | } | |
| - | | \ \ \ \ \ \ **SecurityStates** [ {} ] | array | | read-only | Security states supported by the Memory. | | + | | **RankCount** | number, null\\ \\ *read-only* | Number of ranks available in the Memory. | |
| - | | } | | | | + | | **Regions** [ { | array\\ \\ *read-write* | Memory regions information within the Memory. | |
| - | | **SerialNumber** | string | + | | < |
| - | | **SpareDeviceCount** | number | + | | < |
| - | | **Status** { | object | + | | < |
| - | | \ \ \ \ \ \ **Health** | string | + | | < |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | } ] | |
| - | | \ \ \ \ \ \ **State** | string | + | | **SecurityCapabilities** { | object\\ \\ *read-write* | This object contains security capabilities of the Memory. | |
| - | | } | | | | + | | < |
| - | | **SubsystemDeviceID** | string | + | | < |
| - | | **SubsystemVendorID** | string | + | | < |
| - | | **VendorID** | string | + | | } | |
| - | | **VolatileRegionSizeLimitMiB** | number | + | | **SerialNumber** | string, null\\ \\ *read-only* | The product serial number of this device. | |
| + | | **SpareDeviceCount** | number, null\\ \\ *read-only* | Number of unused spare devices available in the Memory. | | ||
| + | | **Status** *(v1.1+)* { | object\\ \\ *read-only* | Indicates the status of the file share. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **SubsystemDeviceID** | string, null\\ \\ *read-only* | Subsystem Device ID. | | ||
| + | | **SubsystemVendorID** | string, null\\ \\ *read-only* | SubSystem Vendor ID. | | ||
| + | | **VendorID** | string, null\\ \\ *read-only* | Vendor ID. | | ||
| + | | **VolatileRegionSizeLimitMiB** | number, null\\ \\ *read-only* | Total size of volatile regions in MiB. | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == BaseModuleType == | + | ==== BaseModuleType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | LRDIMM | Load Reduced. | | | LRDIMM | Load Reduced. | | ||
| | Mini_RDIMM | Mini_RDIMM. | | | Mini_RDIMM | Mini_RDIMM. | | ||
| Line 2597: | Line 3012: | ||
| | UDIMM | UDIMM. | | | UDIMM | UDIMM. | | ||
| - | == ErrorCorrection == | + | ==== ErrorCorrection: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | AddressParity | Address Parity errors can be corrected. | | | AddressParity | Address Parity errors can be corrected. | | ||
| | MultiBitECC | Multi-bit Data errors can be corrected by ECC. | | | MultiBitECC | Multi-bit Data errors can be corrected by ECC. | | ||
| Line 2605: | Line 3021: | ||
| | SingleBitECC | Single bit Data error can be corrected by ECC. | | | SingleBitECC | Single bit Data error can be corrected by ECC. | | ||
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == MemoryClassification == | + | ==== MemoryClassification: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Block | Block accesible memory. | | | Block | Block accesible memory. | | ||
| | ByteAccessiblePersistent | Byte accessible persistent memory. | | | ByteAccessiblePersistent | Byte accessible persistent memory. | | ||
| | Volatile | Volatile memory. | | | Volatile | Volatile memory. | | ||
| - | == MemoryDeviceType == | + | ==== MemoryDeviceType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | DDR | DDR. | | | DDR | DDR. | | ||
| | DDR2 | DDR2. | | | DDR2 | DDR2. | | ||
| Line 2649: | Line 3069: | ||
| | SDRAM | SDRAM. | | | SDRAM | SDRAM. | | ||
| - | == MemoryType == | + | ==== MemoryType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | DRAM | DRAM. | | | DRAM | DRAM. | | ||
| | NVDIMM_F | NVDIMM_F as defined by JEDEC. | | | NVDIMM_F | NVDIMM_F as defined by JEDEC. | | ||
| Line 2657: | Line 3078: | ||
| | NVDIMM_P | NVDIMM_P as defined by JEDEC. | | | NVDIMM_P | NVDIMM_P as defined by JEDEC. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 2673: | Line 3095: | ||
| - | ===== MemoryChunks ===== | + | ====== MemoryChunks |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **AddressRangeType** | string | + | | --- | --- | --- | |
| - | | **Description** | string | + | | **AddressRangeType** | string, null\\ \\ *read-write* | Memory type of this memory chunk. |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **InterleaveSets** [ { | array | | read-write | This is the interleave sets for the memory chunk. | | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **Memory** {} | object | + | | **InterleaveSets** [ { | array\\ \\ *read-write* | This is the interleave sets for the memory chunk. | |
| - | | \ \ \ \ \ \ **MemoryLevel** | number | + | | < |
| - | | \ \ \ \ \ \ **OffsetMiB** | number | + | | < |
| - | | \ \ \ \ \ \ **RegionId** | string | + | | < |
| - | | \ \ \ \ \ \ **SizeMiB** | number | + | | < |
| - | | } ] | | | | + | | < |
| - | | **IsMirrorEnabled** | boolean | + | | } ] | |
| - | | **IsSpare** | boolean | + | | **IsMirrorEnabled** | boolean, null\\ \\ *read-only* | Mirror Enabled status. | |
| - | | **MemoryChunkSizeMiB** | number | + | | **IsSpare** | boolean, null\\ \\ *read-only* | Spare enabled status. | |
| - | | **Name** | string | + | | **MemoryChunkSizeMiB** | number, null\\ \\ *read-only* | Size of the memory chunk in MiB. | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ | ||
| - | === Property Details === | + | ===== Property Details |
| - | == AddressRangeType == | + | ==== AddressRangeType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Block | Block accesible memory. | | | Block | Block accesible memory. | | ||
| | PMEM | Byte accessible persistent memory. | | | PMEM | Byte accessible persistent memory. | | ||
| Line 2704: | Line 3128: | ||
| - | ===== MemoryChunksCollection | + | ====== |
| - | + | ||
| - | A Collection of MemoryChunks resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== MemoryCollection ===== | + | |
| - | + | ||
| - | A Collection of Memory resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== MemoryDomain | + | |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **AllowsBlockProvisioning** | boolean | + | | --- | --- | --- | |
| - | | **AllowsMemoryChunkCreation** | boolean | + | | **AllowsBlockProvisioning** | boolean, null\\ \\ *read-only* | Indicates if this Memory Domain supports the provisioning of blocks of memory. | |
| - | | **AllowsMirroring** | boolean | + | | **AllowsMemoryChunkCreation** | boolean, null\\ \\ *read-only* | Indicates if this Memory Domain supports the creation of Memory Chunks. | |
| - | | **AllowsSparing** | boolean | + | | **AllowsMirroring** *(v1.1+)* | boolean, null\\ \\ *read-only* | Indicates if this Memory Domain supports the creation of Memory Chunks with mirroring enabled. | |
| - | | **Description** | string | + | | **AllowsSparing** *(v1.1+)* | boolean, null\\ \\ *read-only* | Indicates if this Memory Domain supports the creation of Memory Chunks with sparing enabled. | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **InterleavableMemorySets** [ { | array | | read-write | This is the interleave sets for the memory chunk. | | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **MemorySet** [ {} ] | array | | read-only | This is the collection of memory for a particular interleave set. | | + | | **InterleavableMemorySets** [ { | array\\ \\ *read-write* | This is the interleave sets for the memory chunk. | |
| - | | } ] | | | | + | | < |
| - | | **MemoryChunks** | object | + | | < |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | | } ] | |
| - | | **Oem** {} | object | + | | **MemoryChunks** |
| - | + | | < | |
| - | ===== MemoryDomainCollection ===== | + | | < |
| - | + | | < | |
| - | A Collection of MemoryDomain resource instances. | + | | < |
| - | + | | < | |
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | } | |
| - | | **Description** | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **Members** | array(reference([[documentation: | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **Name** | string | + | |
| - | | **Oem** {} | object | + | |
| - | ===== MemoryMetrics ===== | + | ====== MemoryMetrics |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Actions** { | object | + | | --- | --- | --- | |
| - | | \ \ \ \ \ \ **# | + | | **Actions** { | object\\ \\ *read-write* | The available actions for this resource. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **BlockSizeBytes** | number | + | | } | |
| - | | **CurrentPeriod** { | object | + | | **BlockSizeBytes** | number, null\\ (By)\\ \\ *read-only* | Block size in bytes. | |
| - | | \ \ \ \ \ \ **BlocksRead** | number | + | | **CurrentPeriod** { | object\\ \\ *read-write* | This object describes the central memory of the system in general detail. | |
| - | | \ \ \ \ \ \ **BlocksWritten** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **Description** | string | + | | } | |
| - | | **HealthData** { | object | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | \ \ \ \ \ \ **AlarmTrips** {} | object | + | | **HealthData** { | object\\ \\ *read-write* | This object describes the central memory of the system in general detail. | |
| - | | \ \ \ \ \ \ **DataLossDetected** | boolean | + | | < |
| - | | \ \ \ \ \ \ **LastShutdownSuccess** | boolean | + | | < |
| - | | \ \ \ \ \ \ **PerformanceDegraded** | boolean | + | | < |
| - | | \ \ \ \ \ \ **PredictedMediaLifeLeftPercent** | number | + | | < |
| - | | \ \ \ \ \ \ **RemainingSpareBlockPercentage** | number | + | | < |
| - | | } | | | | + | | < |
| - | | **Id** | string | + | | } | |
| - | | **LifeTime** { | object | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **BlocksRead** | number | + | | **LifeTime** { | object\\ \\ *read-write* | This object describes the central memory of the system in general detail. | |
| - | | \ \ \ \ \ \ **BlocksWritten** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **Name** | string | + | | } | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ | ||
| - | ===== MessageRegistry ===== | + | ====== MessageRegistry |
| This is the schema definition for all Message Registries. | This is the schema definition for all Message Registries. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Description** | string | + | | --- | --- | --- | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Language** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Messages** {} | object | + | | **Language** | string\\ \\ *read-only* | This is the RFC 5646 compliant language code for the registry. | |
| - | | **Name** | string | + | | **Messages** {} | object\\ \\ *read-write* | The pattern property indicates that a free-form string is the unique identifier for the message within the registry. | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **OwningEntity** | string | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **RegistryPrefix** | string | + | | **OwningEntity** | string\\ \\ *read-only* | This is the organization or company that publishes this registry. | |
| - | | **RegistryVersion** | string | + | | **RegistryPrefix** | string\\ \\ *read-only* | This is the single word prefix used to form a messageID structure. | |
| + | | **RegistryVersion** | string\\ \\ *read-only* | This is the message registry version which is used in the middle portion of a messageID. | | ||
| - | ===== MessageRegistryCollection | + | ====== |
| - | + | ||
| - | A Collection of MessageRegistry resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== MessageRegistryFile | + | |
| This is the schema definition for the Schema File locator resource. | This is the schema definition for the Schema File locator resource. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Description** | string | + | | --- | --- | --- | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Languages** [ {} ] | array | | read-only | Language codes for the schemas available. | | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Location** [ { | array | | read-write | Location information for this schema file. | | + | | **Languages** [ {} ] | array\\ \\ *read-only* | Language codes for the schemas available. | |
| - | | \ \ \ \ \ \ **ArchiveFile** | string | + | | **Location** [ { | array\\ \\ *read-write* | Location information for this schema file. | |
| - | | \ \ \ \ \ \ **ArchiveUri** | string | + | | < |
| - | | \ \ \ \ \ \ **Language** | string | + | | < |
| - | | \ \ \ \ \ \ **PublicationUri** | string | + | | < |
| - | | \ \ \ \ \ \ **Uri** | string | + | | < |
| - | | } ] | | | | + | | < |
| - | | **Name** | string | + | | } ] | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **Registry** | string | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| + | | **Registry** | string\\ \\ *read-only* | The Registry Name, Major and Minor version used in MessageID construction. | | ||
| - | ===== MessageRegistryFileCollection | + | ====== |
| - | + | ||
| - | A Collection of MessageRegistryFile resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== NetworkAdapter | + | |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Actions** { | object | + | | --- | --- | --- | |
| - | | \ \ \ \ \ \ **# | + | | **Actions** { | object\\ \\ *read-write* | The available actions for this resource. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **Controllers** [ { | array | | read-write | The set of network controllers ASICs that make up this NetworkAdapter. | | + | | } | |
| - | | \ \ \ \ \ \ **ControllerCapabilities** {} | object | + | | **Controllers** [ { | array\\ \\ *read-write* | The set of network controllers ASICs that make up this NetworkAdapter. | |
| - | | \ \ \ \ \ \ **FirmwarePackageVersion** | string | + | | < |
| - | | \ \ \ \ \ \ **Links** {} | object | + | | < |
| - | | } ] | | | | + | | < |
| - | | **Description** | string | + | | } ] | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Manufacturer** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Model** | string | + | | **Manufacturer** | string, null\\ \\ *read-only* | The manufacturer or OEM of this network adapter. | |
| - | | **Name** | string | + | | **Model** | string, null\\ \\ *read-only* | The model string for this network adapter. | |
| - | | **NetworkDeviceFunctions** | reference([[documentation: | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **NetworkPorts** | reference([[documentation: | + | | **NetworkDeviceFunctions** |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | | < |
| - | | **PartNumber** | string | + | | < |
| - | | **SKU** | string | + | | < |
| - | | **SerialNumber** | string | + | | < |
| - | | **Status** { | object | + | | < |
| - | | \ \ \ \ \ \ **Health** | string | + | | } | |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | **NetworkPorts** |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **State** | string | + | | < |
| - | | } | | | | + | | < |
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ | ||
| + | | **PartNumber** | string, null\\ \\ *read-only* | Part number for this network adapter. | | ||
| + | | **SKU** | string, null\\ \\ *read-only* | The manufacturer SKU for this network adapter. | | ||
| + | | **SerialNumber** | string, null\\ \\ *read-only* | The serial number for this network adapter. | | ||
| + | | **Status** { | object, null\\ \\ *read-only* | Indicates the status of the file share. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 2901: | Line 3302: | ||
| - | ===== NetworkAdapterCollection | + | ====== |
| - | + | ||
| - | A Collection of NetworkAdapter resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== NetworkDeviceFunction | + | |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **AssignablePhysicalPorts** | array(reference([[documentation: | + | | --- | --- | --- | |
| - | | **BootMode** | string | Yes | read-write | The boot mode configured for this network device function.\\ //See Property Details, below, for more information about this property.// | | + | | **AssignablePhysicalPorts** |
| - | | **Description** | string | + | | < |
| - | | **DeviceEnabled** | boolean | + | | < |
| - | | **Ethernet** { | object | + | | < |
| - | | \ \ \ \ \ \ **MACAddress** | string | + | | < |
| - | | \ \ \ \ \ \ **MTUSize** | number | + | | < |
| - | | \ \ \ \ \ \ **PermanentMACAddress** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **FibreChannel** { | object | + | | < |
| - | | \ \ \ \ \ \ **AllowFIPVLANDiscovery** | boolean | + | | < |
| - | | \ \ \ \ \ \ **BootTargets** [ {} ] | array | | read-write | An array of Fibre Channel boot targets configured for this network device function. | | + | | < |
| - | | \ \ \ \ \ \ **FCoEActiveVLANId** | number | + | | < |
| - | | \ \ \ \ \ \ **FCoELocalVLANId** | number | + | | < |
| - | | \ \ \ \ \ \ **PermanentWWNN** | string | + | | < |
| - | | \ \ \ \ \ \ **PermanentWWPN** | string | + | | < |
| - | | \ \ \ \ \ \ **WWNN** | string | + | | < |
| - | | \ \ \ \ \ \ **WWNSource** | string | + | | < |
| - | | \ \ \ \ \ \ **WWPN** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **Id** | string | + | | < |
| - | | **Links** { | object | + | | } ] | |
| - | | \ \ \ \ \ \ **PCIeFunction** {} | object | + | | **[email protected]** | string\\ \\ *read-write* |
| - | | } | | | | + | | **BootMode** | string, null\\ \\ *read-write* | The boot mode configured for this network device function. |
| - | | **MaxVirtualFunctions** | number | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Name** | string | + | | **DeviceEnabled** | boolean, null\\ \\ *read-write* | Whether the network device function is enabled. | |
| - | | **NetDevFuncCapabilities** [ {} ] | array | | read-only | Capabilities of this network device function. | | + | | **Ethernet** { | object, null\\ \\ *read-write* | Ethernet. | |
| - | | **NetDevFuncType** | string | + | | < |
| - | | **Oem** {} | object | + | | < |
| - | | **PhysicalPortAssignment** | reference([[documentation: | + | | < |
| - | | **Status** { | object | Yes | read-only | Indicates the status of the file share. | | + | | } | |
| - | | \ \ \ \ \ \ **Health** | string | + | | **FibreChannel** { | object, null\\ \\ *read-write* | Fibre Channel. | |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **State** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **VirtualFunctionsEnabled** | boolean | + | | < |
| - | | **iSCSIBoot** { | object | + | | < |
| - | | \ \ \ \ \ \ **AuthenticationMethod** | string | + | | < |
| - | | \ \ \ \ \ \ **CHAPSecret** | string | + | | < |
| - | | \ \ \ \ \ \ **CHAPUsername** | string | + | | < |
| - | | \ \ \ \ \ \ **IPAddressType** | string | + | | } | |
| - | | \ \ \ \ \ \ **IPMaskDNSViaDHCP** | boolean | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **InitiatorDefaultGateway** | string | + | | **Links** { | object\\ \\ *read-write* | Links. | |
| - | | \ \ \ \ \ \ **InitiatorIPAddress** | string | + | | < |
| - | | \ \ \ \ \ \ **InitiatorName** | string | + | | } | |
| - | | \ \ \ \ \ \ **InitiatorNetmask** | string | + | | **MaxVirtualFunctions** | number, null\\ \\ *read-only* | The number of virtual functions (VFs) that are available for this Network Device Function. | |
| - | | \ \ \ \ \ \ **MutualCHAPSecret** | string | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | \ \ \ \ \ \ **MutualCHAPUsername** | string | + | | **NetDevFuncCapabilities** [ {} ] | array\\ \\ *read-only* | Capabilities of this network device function. | |
| - | | \ \ \ \ \ \ **PrimaryDNS** | string | + | | **NetDevFuncType** | string, null\\ \\ *read-write* | The configured capability of this network device function. |
| - | | \ \ \ \ \ \ **PrimaryLUN** | number | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | \ \ \ \ \ \ **PrimaryTargetIPAddress** | string | + | | **PhysicalPortAssignment** |
| - | | \ \ \ \ \ \ **PrimaryTargetName** | string | + | | < |
| - | | \ \ \ \ \ \ **PrimaryTargetTCPPort** | number | + | | < |
| - | | \ \ \ \ \ \ **PrimaryVLANEnable** | boolean | + | | < |
| - | | \ \ \ \ \ \ **PrimaryVLANId** | number | + | | < |
| - | | \ \ \ \ \ \ **RouterAdvertisementEnabled** | boolean | + | | < |
| - | | \ \ \ \ \ \ **SecondaryDNS** | string | + | | < |
| - | | \ \ \ \ \ \ **SecondaryLUN** | number | + | | < |
| - | | \ \ \ \ \ \ **SecondaryTargetIPAddress** | string | + | | < |
| - | | \ \ \ \ \ \ **SecondaryTargetName** | string | + | | < |
| - | | \ \ \ \ \ \ **SecondaryTargetTCPPort** | number | + | | < |
| - | | \ \ \ \ \ \ **SecondaryVLANEnable** | boolean | + | | < |
| - | | \ \ \ \ \ \ **SecondaryVLANId** | number | + | | < |
| - | | \ \ \ \ \ \ **TargetInfoViaDHCP** | boolean | + | | < |
| - | | } | | | | + | | < |
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Status** { | object, null\\ \\ *read-only* | Indicates the status of the file share. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **VirtualFunctionsEnabled** | boolean, null\\ \\ *read-only* | Whether Single Root I/O Virtualization (SR-IOV) Virual Functions (VFs) are enabled for this Network Device Function. | | ||
| + | | **iSCSIBoot** { | object, null\\ \\ *read-write* | iSCSI Boot. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == ActiveLinkTechnology == | + | ==== ActiveLinkTechnology: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Ethernet | The port is capable of connecting to an Ethernet network. | | | Ethernet | The port is capable of connecting to an Ethernet network. | | ||
| | FibreChannel | The port is capable of connecting to a Fibre Channel network. | | | FibreChannel | The port is capable of connecting to a Fibre Channel network. | | ||
| | InfiniBand | The port is capable of connecting to an InfiniBand network. | | | InfiniBand | The port is capable of connecting to an InfiniBand network. | | ||
| - | == AuthenticationMethod == | + | ==== AuthenticationMethod: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | CHAP | iSCSI Challenge Handshake Authentication Protocol (CHAP) authentication is used. | | | CHAP | iSCSI Challenge Handshake Authentication Protocol (CHAP) authentication is used. | | ||
| | MutualCHAP | iSCSI Mutual Challenge Handshake Authentication Protocol (CHAP) authentication is used. | | | MutualCHAP | iSCSI Mutual Challenge Handshake Authentication Protocol (CHAP) authentication is used. | | ||
| | None | No iSCSI authentication is used. | | | None | No iSCSI authentication is used. | | ||
| - | == BootMode == | + | ==== BootMode: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Disabled | Do not indicate to UEFI/BIOS that this device is bootable. | | | Disabled | Do not indicate to UEFI/BIOS that this device is bootable. | | ||
| | FibreChannel | Boot this device using the embedded Fibre Channel support and configuration. | | FibreChannel | Boot this device using the embedded Fibre Channel support and configuration. | ||
| Line 3008: | Line 3444: | ||
| | iSCSI | Boot this device using the embedded iSCSI boot support and configuration. | | iSCSI | Boot this device using the embedded iSCSI boot support and configuration. | ||
| - | == FlowControlConfiguration == | + | ==== FlowControlConfiguration: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | None | No IEEE 802.3x flow control is enabled on this port. | | | 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. | | | RX | IEEE 802.3x flow control may be initiated by the link partner. | | ||
| Line 3016: | Line 3453: | ||
| | TX_RX | IEEE 802.3x flow control may be initiated by this station or the link partner. | | | TX_RX | IEEE 802.3x flow control may be initiated by this station or the link partner. | | ||
| - | == FlowControlStatus == | + | ==== FlowControlStatus: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | None | No IEEE 802.3x flow control is enabled on this port. | | | 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. | | | RX | IEEE 802.3x flow control may be initiated by the link partner. | | ||
| Line 3024: | Line 3462: | ||
| | TX_RX | IEEE 802.3x flow control may be initiated by this station or the link partner. | | | TX_RX | IEEE 802.3x flow control may be initiated by this station or the link partner. | | ||
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == IPAddressType == | + | ==== IPAddressType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | IPv4 | IPv4 addressing is used for all IP-fields in this object. | | | IPv4 | IPv4 addressing is used for all IP-fields in this object. | | ||
| | IPv6 | IPv6 addressing is used for all IP-fields in this object. | | | IPv6 | IPv6 addressing is used for all IP-fields in this object. | | ||
| - | == LinkStatus == | + | ==== LinkStatus: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Down | The port is enabled but link is down. | | | Down | The port is enabled but link is down. | | ||
| | Up | The port is enabled and link is good (up). | | | Up | The port is enabled and link is good (up). | | ||
| - | == NetDevFuncType == | + | ==== NetDevFuncType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Disabled | Neither enumerated nor visible to the operating system. | | | Disabled | Neither enumerated nor visible to the operating system. | | ||
| | Ethernet | Appears to the operating system as an Ethernet device. | | | Ethernet | Appears to the operating system as an Ethernet device. | | ||
| Line 3059: | Line 3502: | ||
| | iSCSI | Appears to the operating system as an iSCSI device. | | | iSCSI | Appears to the operating system as an iSCSI device. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 3074: | Line 3518: | ||
| | Updating | The element is updating and may be unavailable or degraded. | | | Updating | The element is updating and may be unavailable or degraded. | | ||
| - | == WWNSource == | + | ==== WWNSource: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | ConfiguredLocally | The set of FC/FCoE boot targets was applied locally through API or UI. | | | ConfiguredLocally | The set of FC/FCoE boot targets was applied locally through API or UI. | | ||
| | ProvidedByFabric | The set of FC/FCoE boot targets was applied by the Fibre Channel fabric. | | | ProvidedByFabric | The set of FC/FCoE boot targets was applied by the Fibre Channel fabric. | | ||
| - | ===== NetworkDeviceFunctionCollection | + | ====== |
| - | + | ||
| - | A Collection of NetworkDeviceFunction resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== NetworkInterface | + | |
| A NetworkInterface contains references linking NetworkAdapter, | A NetworkInterface contains references linking NetworkAdapter, | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Description** | string | + | | --- | --- | --- | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Links** { | object | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **NetworkAdapter** {} | object | + | | **Links** { | object\\ \\ *read-write* | Links. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | | read-write | Oem extension object. | | + | | < |
| - | | } | | | | + | | < |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | | } | |
| - | | **NetworkDeviceFunctions** | reference([[documentation: | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **NetworkPorts** | reference([[documentation: | + | | **NetworkDeviceFunctions** { | object\\ \\ *read-write* |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | | < |
| - | | **Status** { | object | + | | < |
| - | | \ \ \ \ \ \ **Health** | string | + | | < |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **State** | string | + | | } | |
| - | | } | | | | + | | **NetworkPorts** { | object\\ \\ *read-write* | Contains the members of this collection. | |
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ | ||
| + | | **Status** { | object, null\\ \\ *read-only* | Indicates the status of the file share. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 3145: | Line 3596: | ||
| - | ===== NetworkInterfaceCollection | + | ====== |
| - | + | ||
| - | A Collection of NetworkInterface resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== NetworkPort | + | |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **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. | | + | | **ActiveLinkTechnology** | string, null\\ \\ *read-write* | Network Port Active Link Technology. |
| - | | **Description** | 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. | |
| - | | **EEEEnabled** | boolean | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **FlowControlConfiguration** | string | + | | **EEEEnabled** | boolean, null\\ \\ *read-write* | Whether IEEE 802.3az Energy Efficient Ethernet (EEE) is enabled for this network port. | |
| - | | **FlowControlStatus** | string | + | | **FlowControlConfiguration** | string, null\\ \\ *read-write* | The locally configured 802.3x flow control setting for this network port. *See Property Details, below, for more information about this property.* | |
| - | | **Id** | string | + | | **FlowControlStatus** | string, null\\ \\ *read-write* | The 802.3x flow control behavior negotiated with the link partner for this network port (Ethernet-only). |
| - | | **LinkStatus** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Name** | string | + | | **LinkStatus** | string, null\\ \\ *read-write* | The status of the link between this port and its link partner. |
| - | | **NetDevFuncMaxBWAlloc** [ { | array | | read-write | The array of maximum bandwidth allocation percentages for the Network Device Functions associated with this port. | | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | \ \ \ \ \ \ **MaxBWAllocPercent** | number | + | | **NetDevFuncMaxBWAlloc** [ { | array\\ \\ *read-write* | The array of maximum bandwidth allocation percentages for the Network Device Functions associated with this port. | |
| - | | \ \ \ \ \ \ **NetworkDeviceFunction** {} | object | + | | < |
| - | | } ] | | | | + | | < |
| - | | **NetDevFuncMinBWAlloc** [ { | array | | read-write | The array of minimum bandwidth allocation percentages for the Network Device Functions associated with this port. | | + | | } ] | |
| - | | \ \ \ \ \ \ **MinBWAllocPercent** | number | + | | **NetDevFuncMinBWAlloc** [ { | array\\ \\ *read-write* | The array of minimum bandwidth allocation percentages for the Network Device Functions associated with this port. | |
| - | | \ \ \ \ \ \ **NetworkDeviceFunction** {} | object | + | | < |
| - | | } ] | | | | + | | < |
| - | | **Oem** {} | object | + | | } ] | |
| - | | **PhysicalPortNumber** | string | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **PortMaximumMTU** | number | + | | **PhysicalPortNumber** | string, null\\ \\ *read-only* | The physical port number label for this port. | |
| - | | **SignalDetected** | boolean | + | | **PortMaximumMTU** | number, null\\ \\ *read-only* | The largest maximum transmission unit (MTU) that can be configured for this network port. | |
| - | | **Status** { | object | + | | **SignalDetected** | boolean, null\\ \\ *read-only* | Whether or not the port has detected enough signal on enough lanes to establish link. | |
| - | | \ \ \ \ \ \ **Health** | string | + | | **Status** { | object, null\\ \\ *read-only* | Indicates the status of the file share. | |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **State** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **SupportedEthernetCapabilities** [ {} ] | array | | read-only | The set of Ethernet capabilities that this port supports. | | + | | } | |
| - | | **SupportedLinkCapabilities** [ { | array | | read-write | The self-described link capabilities of this port. | | + | | **SupportedEthernetCapabilities** [ {} ] | array\\ \\ *read-only* | The set of Ethernet capabilities that this port supports. | |
| - | | \ \ \ \ \ \ **LinkNetworkTechnology** | string | + | | **SupportedLinkCapabilities** [ { | array\\ \\ *read-write* | The self-described link capabilities of this port. | |
| - | | \ \ \ \ \ \ **LinkSpeedMbps** | number | + | | < |
| - | | } ] | | | | + | | < |
| - | | **WakeOnLANEnabled** | boolean | + | | } ] | |
| + | | **WakeOnLANEnabled** | boolean, null\\ \\ *read-write* | Whether Wake on LAN (WoL) is enabled for this network port. | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == ActiveLinkTechnology == | + | ==== ActiveLinkTechnology: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Ethernet | The port is capable of connecting to an Ethernet network. | | | Ethernet | The port is capable of connecting to an Ethernet network. | | ||
| | FibreChannel | The port is capable of connecting to a Fibre Channel network. | | | FibreChannel | The port is capable of connecting to a Fibre Channel network. | | ||
| | InfiniBand | The port is capable of connecting to an InfiniBand network. | | | InfiniBand | The port is capable of connecting to an InfiniBand network. | | ||
| - | == FlowControlConfiguration == | + | ==== FlowControlConfiguration: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | None | No IEEE 802.3x flow control is enabled on this port. | | | 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. | | | RX | IEEE 802.3x flow control may be initiated by the link partner. | | ||
| Line 3211: | Line 3655: | ||
| | TX_RX | IEEE 802.3x flow control may be initiated by this station or the link partner. | | | TX_RX | IEEE 802.3x flow control may be initiated by this station or the link partner. | | ||
| - | == FlowControlStatus == | + | ==== FlowControlStatus: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | None | No IEEE 802.3x flow control is enabled on this port. | | | 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. | | | RX | IEEE 802.3x flow control may be initiated by the link partner. | | ||
| Line 3219: | Line 3664: | ||
| | TX_RX | IEEE 802.3x flow control may be initiated by this station or the link partner. | | | TX_RX | IEEE 802.3x flow control may be initiated by this station or the link partner. | | ||
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == LinkNetworkTechnology == | + | ==== LinkNetworkTechnology: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Ethernet | The port is capable of connecting to an Ethernet network. | | | Ethernet | The port is capable of connecting to an Ethernet network. | | ||
| | FibreChannel | The port is capable of connecting to a Fibre Channel network. | | | FibreChannel | The port is capable of connecting to a Fibre Channel network. | | ||
| | InfiniBand | The port is capable of connecting to an InfiniBand network. | | | InfiniBand | The port is capable of connecting to an InfiniBand network. | | ||
| - | == LinkStatus == | + | ==== LinkStatus: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Down | The port is enabled but link is down. | | | Down | The port is enabled but link is down. | | ||
| | Up | The port is enabled and link is good (up). | | | Up | The port is enabled and link is good (up). | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 3262: | Line 3712: | ||
| - | ===== NetworkPortCollection | + | ====== |
| - | + | ||
| - | A Collection of NetworkPort resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== PCIeDevice | + | |
| This is the schema definition for the PCIeDevice resource. | This is the schema definition for the PCIeDevice resource. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **AssetTag** | string | + | | --- | --- | --- | |
| - | | **Description** | string | + | | **AssetTag** | string, null\\ \\ *read-write* | The user assigned asset tag for this PCIe device. | |
| - | | **DeviceType** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **FirmwareVersion** | string | + | | **DeviceType** | string\\ \\ *read-write* | The device type for this PCIe device. |
| - | | **Id** | string | + | | **FirmwareVersion** | string, null\\ \\ *read-only* | The version of firmware for this PCIe device. | |
| - | | **Links** { | object | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **Chassis** [ {} ] | array | | read-only | An array of references to the chassis in which the PCIe device is contained. | | + | | **Links** { | object\\ \\ *read-write* | The links object contains the links to other resources that are related to this resource. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **PCIeFunctions** [ {} ] | array | | read-only | An array of references to PCIeFunctions exposed by this device. | | + | | < |
| - | | } | | | | + | | < |
| - | | **Manufacturer** | string | + | | < |
| - | | **Model** | string | + | | < |
| - | | **Name** | string | + | | } | |
| - | | **Oem** {} | object | + | | **Manufacturer** | string, null\\ \\ *read-only* | This is the manufacturer of this PCIe device. | |
| - | | **PartNumber** | string | + | | **Model** | string, null\\ \\ *read-only* | This is the model number for the PCIe device. | |
| - | | **SKU** | string | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **SerialNumber** | string | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **Status** { | object | + | | **PartNumber** | string, null\\ \\ *read-only* | The part number for this PCIe device. | |
| - | | \ \ \ \ \ \ **Health** | string | + | | **SKU** | string, null\\ \\ *read-only* | This is the SKU for this PCIe device. | |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | **SerialNumber** | string, null\\ \\ *read-only* | The serial number for this PCIe device. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **Status** { | object, null\\ \\ *read-only* | Indicates the status of the file share. | |
| - | | \ \ \ \ \ \ **State** | string | + | | < |
| - | | } | | | | + | | < |
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == DeviceType == | + | ==== DeviceType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | MultiFunction | A multi-function PCIe device. | | | MultiFunction | A multi-function PCIe device. | | ||
| | Simulated | A PCIe device which is not currently physically present, but is being simulated by the PCIe infrastructure. | | | Simulated | A PCIe device which is not currently physically present, but is being simulated by the PCIe infrastructure. | | ||
| | SingleFunction | A single-function PCIe device. | | | SingleFunction | A single-function PCIe device. | | ||
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 3340: | Line 3787: | ||
| - | ===== PCIeFunction ===== | + | ====== PCIeFunction |
| This is the schema definition for the PCIeFunction resource. | This is the schema definition for the PCIeFunction resource. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **ClassCode** | string | + | | --- | --- | --- | |
| - | | **Description** | string | + | | **ClassCode** | string, null\\ \\ *read-only* | The Class Code of this PCIe function. | |
| - | | **DeviceClass** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **DeviceId** | string | + | | **DeviceClass** | string\\ \\ *read-write* | The class for this PCIe Function. |
| - | | **FunctionId** | number | + | | **DeviceId** | string, null\\ \\ *read-only* | The Device ID of this PCIe function. | |
| - | | **FunctionType** | string | + | | **FunctionId** | number, null\\ \\ *read-only* | The the PCIe Function identifier. | |
| - | | **Id** | string | + | | **FunctionType** | string\\ \\ *read-write* | The type of the PCIe Function. |
| - | | **Links** { | object | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **Drives** [ {} ] | array | | read-only | An array of references to the drives which the PCIe device produces. | | + | | **Links** { | object\\ \\ *read-write* | The links object contains the links to other resources that are related to this resource. | |
| - | | \ \ \ \ \ \ **EthernetInterfaces** [ {} ] | array | | read-only | An array of references to the ethernet interfaces which the PCIe device produces. | | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **PCIeDevice** {} | object | + | | < |
| - | | \ \ \ \ \ \ **StorageControllers** [ {} ] | array | | read-only | An array of references to the storage controllers which the PCIe device produces. | | + | | < |
| - | | } | | | | + | | < |
| - | | **Name** | string | + | | < |
| - | | **Oem** {} | object | + | | < |
| - | | **RevisionId** | string | + | | < |
| - | | **Status** { | object | + | | } | |
| - | | \ \ \ \ \ \ **Health** | string | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **RevisionId** | string, null\\ \\ *read-only* | The Revision ID of this PCIe function. | |
| - | | \ \ \ \ \ \ **State** | string | + | | **Status** { | object, null\\ \\ *read-only* | Indicates the status of the file share. | |
| - | | } | | | | + | | < |
| - | | **SubsystemId** | string | + | | < |
| - | | **SubsystemVendorId** | string | + | | < |
| - | | **VendorId** | string | + | | < |
| + | | } | | ||
| + | | **SubsystemId** | string, null\\ \\ *read-only* | The Subsystem ID of this PCIe function. | | ||
| + | | **SubsystemVendorId** | string, null\\ \\ *read-only* | The Subsystem Vendor ID of this PCIe function. | | ||
| + | | **VendorId** | string, null\\ \\ *read-only* | The Vendor ID of this PCIe function. | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == DeviceClass == | + | ==== DeviceClass: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Bridge | A bridge. | | | Bridge | A bridge. | | ||
| | CommunicationController | A communication controller. | | | CommunicationController | A communication controller. | | ||
| Line 3401: | Line 3853: | ||
| | WirelessController | A wireless controller. | | | WirelessController | A wireless controller. | | ||
| - | == FunctionType == | + | ==== FunctionType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Physical | A physical PCie function. | | | Physical | A physical PCie function. | | ||
| | Virtual | A virtual PCIe function. | | | Virtual | A virtual PCIe function. | | ||
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 3437: | Line 3893: | ||
| - | ===== Port ===== | + | ====== Port 1.0.1 ====== |
| Port contains properties describing a port of a switch. | Port contains properties describing a port of a switch. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Actions** { | object | + | | --- | --- | --- | |
| - | | \ \ \ \ \ \ **# | + | | **Actions** { | object\\ \\ *read-write* | The available actions for this resource. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **CurrentSpeedGbps** | number | + | | } | |
| - | | **Description** | string | + | | **CurrentSpeedGbps** | number, null\\ (Gbit/s)\\ \\ *read-only* | The current speed of this port. | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Links** { | object | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **AssociatedEndpoints** [ {} ] | array | | read-only | An array of references to the endpoints that connect to the switch through this port. | | + | | **Links** { | object\\ \\ *read-write* | Contains references to other resources that are related to this resource. | |
| - | | \ \ \ \ \ \ **ConnectedSwitchPorts** [ {} ] | array | | read-only | An array of references to the ports that connect to the switch through this port. | | + | | < |
| - | | \ \ \ \ \ \ **ConnectedSwitches** [ {} ] | array | | read-only | An array of references to the switches that connect to the switch through this port. | | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **MaxSpeedGbps** | number | + | | < |
| - | | **Name** | string | + | | < |
| - | | **Oem** {} | object | + | | < |
| - | | **PortId** | string | + | | } | |
| - | | **PortProtocol** | | Yes | read-write | The protocol being sent over this port. | | + | | **MaxSpeedGbps** | number, null\\ (Gbit/s)\\ \\ *read-only* | The maximum speed of this port as currently configured. | |
| - | | **PortType** | 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 | + | | **PortId** | string, null\\ \\ *read-only* | This is the label of this port on the physical switch package. | |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | **PortProtocol** | null\\ \\ *read-write* | The protocol being sent over this port. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **PortType** | string, null\\ \\ *read-write* | This is the type of this port. *See Property Details, below, for more information about this property.* | |
| - | | \ \ \ \ \ \ **State** | string | + | | **Status** { | object\\ \\ *read-only* | Indicates the status of the file share. | |
| - | | } | | | | + | | < |
| - | | **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 |
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == PortType == | + | ==== PortType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | BidirectionalPort | This port connects to any type of device. | | | BidirectionalPort | This port connects to any type of device. | | ||
| | DownstreamPort | This port connects to a target device. | | | DownstreamPort | This port connects to a target device. | | ||
| Line 3495: | Line 3958: | ||
| | UpstreamPort | This port connects to a host device. | | | UpstreamPort | This port connects to a host device. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 3511: | Line 3975: | ||
| - | ===== PortCollection | + | ====== |
| - | + | ||
| - | A Collection of Port resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== Power ===== | + | |
| This is the schema definition for the Power Metrics. | This is the schema definition for the Power Metrics. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Description** | string | + | | --- | --- | --- | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Name** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **PowerControl** [ { | array | | read-write | This is the definition for power control function (power reading/ | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | \ \ \ \ \ \ **MemberId** | string | + | | **PowerControl** [ { | array\\ \\ *read-write* | This is the definition for power control function (power reading/ |
| - | | \ \ \ \ \ \ **Name** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **PowerAllocatedWatts** | number | + | | < |
| - | | \ \ \ \ \ \ **PowerAvailableWatts** | number | + | | < |
| - | | \ \ \ \ \ \ **PowerCapacityWatts** | number | Yes | read-only | The total amount of power available to the chassis for allocation. This may the power supply capacity, or power budget assigned to the chassis from an up-stream chassis.\\ unit: W | | + | | < |
| - | | \ \ \ \ \ \ **PowerConsumedWatts** | number | + | | < |
| - | | \ \ \ \ \ \ **PowerLimit** {} | object | + | | < |
| - | | \ \ \ \ \ \ **PowerMetrics** {} | object | + | | < |
| - | | \ \ \ \ \ \ **PowerRequestedWatts** | number | + | | < |
| - | | \ \ \ \ \ \ **RelatedItem** [ {} ] | array | | read-only | The ID(s) of the resources associated with this Power Limit. | | + | | < |
| - | | \ \ \ \ \ \ **Status** {} | object | + | | < |
| - | | } ] | | | | + | | < |
| - | | **PowerSupplies** [ { | array | | read-write | Details of the power supplies associated with this system or device. | | + | | < |
| - | | \ \ \ \ \ \ **FirmwareVersion** | string | + | | } ] | | | |
| - | | \ \ \ \ \ \ **IndicatorLED** | string | + | | **[email protected]** | string\\ \\ *read-write* |
| - | | \ \ \ \ \ \ **InputRanges** [ {} ] | array | | read-write | This is the input ranges that the power supply can use. | | + | | **PowerSupplies** [ { | array\\ \\ *read-write* | Details of the power supplies associated with this system or device. | |
| - | | \ \ \ \ \ \ **LastPowerOutputWatts** | number | + | | < |
| - | | \ \ \ \ \ \ **LineInputVoltage** | number | + | | < |
| - | | \ \ \ \ \ \ **LineInputVoltageType** | string | + | | < |
| - | | \ \ \ \ \ \ **Manufacturer** | string | + | | < |
| - | | \ \ \ \ \ \ **MemberId** | string | + | | < |
| - | | \ \ \ \ \ \ **Model** | string | + | | < |
| - | | \ \ \ \ \ \ **Name** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **PartNumber** | string | + | | < |
| - | | \ \ \ \ \ \ **PowerCapacityWatts** | number | Yes | read-only | The maximum capacity of this Power Supply.\\ unit: W | | + | | < |
| - | | \ \ \ \ \ \ **PowerSupplyType** | string | + | | < |
| - | | \ \ \ \ \ \ **Redundancy** [ {} ] | array | | read-write | This structure is used to show redundancy for power supplies. | + | | < |
| - | | \ \ \ \ \ \ **RelatedItem** [ {} ] | array | | read-write | The ID(s) of the resources associated with this Power Limit. | | + | | < |
| - | | \ \ \ \ \ \ **SerialNumber** | string | + | | < |
| - | | \ \ \ \ \ \ **SparePartNumber** | string | + | | < |
| - | | \ \ \ \ \ \ **Status** {} | object | + | | < |
| - | | } ] | | | | + | | < |
| - | | **Redundancy** [ { | array | | read-write | Redundancy information for the power subsystem of this system or device. | | + | | < |
| - | | \ \ \ \ \ \ **MaxNumSupported** | number | + | | < |
| - | | \ \ \ \ \ \ **MemberId** | string | + | | < |
| - | | \ \ \ \ \ \ **MinNumNeeded** | number | + | | < |
| - | | \ \ \ \ \ \ **Mode** | string | + | | } ] | | | |
| - | | \ \ \ \ \ \ **Name** | string | + | | **[email protected]** | string\\ \\ *read-write* |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **Redundancy** [ { | array\\ \\ *read-write* | Redundancy information for the power subsystem of this system or device. | |
| - | | \ \ \ \ \ \ **RedundancySet** [ {} ] | array | | read-only | Contains any ids that represent components of this redundancy set. | | + | | < |
| - | | \ \ \ \ \ \ **Status** {} | object | + | | < |
| - | | \ \ \ \ \ \ **MemberId** | string | + | | < |
| - | | \ \ \ \ \ \ **RedundancyEnabled** | boolean | + | | < |
| - | | } ] | | | | + | | < |
| - | | **Voltages** [ { | array | | read-write | This is the definition for voltage sensors. | | + | | < |
| - | | \ \ \ \ \ \ **LowerThresholdCritical** | number | + | | < |
| - | | \ \ \ \ \ \ **LowerThresholdFatal** | number | + | | < |
| - | | \ \ \ \ \ \ **LowerThresholdNonCritical** | number | Yes | read-only | Below normal range.\\ unit: V | | + | | < |
| - | | \ \ \ \ \ \ **MaxReadingRange** | number | Yes | read-only | Maximum value for this Voltage sensor.\\ unit: V | | + | | < |
| - | | \ \ \ \ \ \ **MemberId** | string | + | | < |
| - | | \ \ \ \ \ \ **MinReadingRange** | number | + | | } ] | | | |
| - | | \ \ \ \ \ \ **Name** | string | + | | **[email protected]** | string\\ \\ *read-write* |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **Voltages** [ { | array\\ \\ *read-write* | This is the definition for voltage sensors. | |
| - | | \ \ \ \ \ \ **PhysicalContext** | string | + | | < |
| - | | \ \ \ \ \ \ **ReadingVolts** | number | + | | < |
| - | | \ \ \ \ \ \ **RelatedItem** [ {} ] | array | | read-only | Describes the areas or devices to which this voltage measurement applies. | | + | | < |
| - | | \ \ \ \ \ \ **SensorNumber** | number | + | | < |
| - | | \ \ \ \ \ \ **Status** {} | object | + | | < |
| - | | \ \ \ \ \ \ **UpperThresholdCritical** | number | + | | < |
| - | | \ \ \ \ \ \ **UpperThresholdFatal** | number | Yes | read-only | Above normal range and is fatal.\\ unit: V | | + | | < |
| - | | \ \ \ \ \ \ **UpperThresholdNonCritical** | number | + | | < |
| - | | } ] | | | | + | | < |
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } ] | | | | ||
| + | | **[email protected]** | string\\ \\ *read-write* | ||
| - | === Property Details === | + | ===== Property Details |
| - | == IndicatorLED == | + | ==== IndicatorLED: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Blinking | The Indicator LED is blinking. | | | Blinking | The Indicator LED is blinking. | | ||
| | Lit | The Indicator LED is lit. | | | Lit | The Indicator LED is lit. | | ||
| | Off | The Indicator LED is off. | | | Off | The Indicator LED is off. | | ||
| - | == LineInputVoltageType == | + | ==== LineInputVoltageType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | AC120V | AC 120V nominal input. | | | AC120V | AC 120V nominal input. | | ||
| | AC240V | AC 240V nominal input. | | | AC240V | AC 240V nominal input. | | ||
| Line 3621: | Line 4087: | ||
| | Unknown | The power supply line input voltage type cannot be determined. | | | Unknown | The power supply line input voltage type cannot be determined. | | ||
| - | == Mode == | + | ==== Mode: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Failover | Failure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set. | | | Failover | Failure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set. | | ||
| | N+m | Multiple units are available and active such that normal operation will continue if one or more units fail. | | | N+m | Multiple units are available and active such that normal operation will continue if one or more units fail. | | ||
| Line 3629: | Line 4096: | ||
| | Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. | | | Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. | | ||
| - | == PhysicalContext == | + | ==== PhysicalContext: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Back | The back of the chassis | | | Back | The back of the chassis | | ||
| | Backplane | A backplane within the chassis | | | Backplane | A backplane within the chassis | | ||
| Line 3653: | Line 4121: | ||
| | VoltageRegulator | A voltage regulator device | | | VoltageRegulator | A voltage regulator device | | ||
| - | == PowerSupplyType == | + | ==== PowerSupplyType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | AC | Alternating Current (AC) power supply. | | | AC | Alternating Current (AC) power supply. | | ||
| | ACorDC | Power Supply supports both DC or AC. | | | ACorDC | Power Supply supports both DC or AC. | | ||
| Line 3662: | Line 4131: | ||
| - | ===== PrivilegeRegistry ===== | + | ====== PrivilegeRegistry |
| This is the schema definition for Operation to Privilege mapping. | This is the schema definition for Operation to Privilege mapping. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Description** | string | + | | --- | --- | --- | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Mappings** [ { | array | | read-write | | | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **Entity** | string | + | | **Mappings** [ { | array\\ \\ *read-write* | | |
| - | | \ \ \ \ \ \ **OperationMap** {} | object | + | | < |
| - | | \ \ \ \ \ \ **PropertyOverrides** [ {} ] | array | | read-write | Indicates privilege overrides of property or element within a entity. | | + | | < |
| - | | \ \ \ \ \ \ **ResourceURIOverrides** [ {} ] | array | | read-write | Indicates privilege overrides of Resource URI. | | + | | < |
| - | | \ \ \ \ \ \ **SubordinateOverrides** [ {} ] | array | | read-write | Indicates privilege overrides of subordinate resource. | | + | | < |
| - | | } ] | | | | + | | < |
| - | | **Name** | string | + | | } ] | |
| - | | **OEMPrivilegesUsed** [ {} ] | array | | read-only | Lists the set of OEM Priviliges used in building this mapping. | | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **Oem** {} | object | + | | **OEMPrivilegesUsed** [ {} ] | array\\ \\ *read-only* | Lists the set of OEM Priviliges used in building this mapping. | |
| - | | **PrivilegesUsed** [ {} ] | array | | read-only | Lists the set of Redfish standard priviliges used in building this mapping. | | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| + | | **PrivilegesUsed** [ {} ] | array\\ \\ *read-only* | Lists the set of Redfish standard priviliges used in building this mapping. | | ||
| - | ===== Processor ===== | + | ====== Processor |
| This is the schema definition for the Processor resource. | This is the schema definition for the Processor resource. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Description** | string | + | | --- | --- | --- | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **InstructionSet** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Manufacturer** | string | + | | **InstructionSet** | string, null\\ \\ *read-write* | The instruction set of the processor. |
| - | | **MaxSpeedMHz** | number | + | | **Manufacturer** | string, null\\ \\ *read-only* | The processor manufacturer. | |
| - | | **Model** | string | + | | **MaxSpeedMHz** | number, null\\ \\ *read-only* | The maximum clock speed of the processor. | |
| - | | **Name** | string | + | | **Model** | string, null\\ \\ *read-only* | The product model number of this device. | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **ProcessorArchitecture** | string | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **ProcessorId** { | object | + | | **ProcessorArchitecture** | string, null\\ \\ *read-write* | The architecture of the processor. |
| - | | \ \ \ \ \ \ **EffectiveFamily** | string | + | | **ProcessorId** { | object\\ \\ *read-write* | Identification information for this processor. | |
| - | | \ \ \ \ \ \ **EffectiveModel** | string | + | | < |
| - | | \ \ \ \ \ \ **IdentificationRegisters** | string | + | | < |
| - | | \ \ \ \ \ \ **MicrocodeInfo** | string | + | | < |
| - | | \ \ \ \ \ \ **Step** | string | + | | < |
| - | | \ \ \ \ \ \ **VendorId** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **ProcessorType** | string | + | | } | |
| - | | **Socket** | string | + | | **ProcessorType** | string, null\\ \\ *read-write* | The type of processor. |
| - | | **Status** { | object | + | | **Socket** | string, null\\ \\ *read-only* | The socket or location of the processor. | |
| - | | \ \ \ \ \ \ **Health** | string | + | | **Status** { | object\\ \\ *read-only* | Indicates the status of the file share. | |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **State** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **TotalCores** | number | + | | } | |
| - | | **TotalThreads** | number | + | | **TotalCores** | number, null\\ \\ *read-only* | The total number of cores contained in this processor. | |
| + | | **TotalThreads** | number, null\\ \\ *read-only* | The total number of execution threads supported by this processor. | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == InstructionSet == | + | ==== InstructionSet: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | ARM-A32 | ARM 32-bit. | | | ARM-A32 | ARM 32-bit. | | ||
| | ARM-A64 | ARM 64-bit. | | | ARM-A64 | ARM 64-bit. | | ||
| Line 3742: | Line 4216: | ||
| | x86-64 | x86 64-bit. | | | x86-64 | x86 64-bit. | | ||
| - | == ProcessorArchitecture == | + | ==== ProcessorArchitecture: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | ARM | ARM. | | | ARM | ARM. | | ||
| | IA-64 | Intel Itanium. | | | IA-64 | Intel Itanium. | | ||
| Line 3751: | Line 4226: | ||
| | x86 | x86 or x86-64. | | | x86 | x86 or x86-64. | | ||
| - | == ProcessorType == | + | ==== ProcessorType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Accelerator | An Accelerator. | | | Accelerator | An Accelerator. | | ||
| | CPU | A Central Processing Unit. | | | CPU | A Central Processing Unit. | | ||
| Line 3761: | Line 4237: | ||
| | OEM | An OEM-defined Processing Unit. | | | OEM | An OEM-defined Processing Unit. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 3777: | Line 4254: | ||
| - | ===== ProcessorCollection | + | ====== |
| - | + | ||
| - | A Collection of Processor resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== Role ===== | + | |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **AssignedPrivileges** [ {} ] | array | | read-write | The redfish privileges that this role includes. | | + | | --- | --- | --- | |
| - | | **Description** | string | + | | **AssignedPrivileges** [ {} ] | array\\ \\ *read-write* | The redfish privileges that this role includes. | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **IsPredefined** | boolean | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Name** | 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. | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **OemPrivileges** [ {} ] | array | | read-write | The OEM privileges that this role includes. | | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | + | | **OemPrivileges** [ {} ] | array\\ \\ *read-write* | The OEM privileges that this role includes. | | |
| - | ===== RoleCollection ===== | + | |
| - | + | ||
| - | A Collection of Role resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | ===== SecureBoot ===== | + | ====== SecureBoot |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Actions** { | object | + | | --- | --- | --- | |
| - | | \ \ \ \ \ \ **# | + | | **Actions** { | object\\ \\ *read-write* | The available actions for this resource. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **Description** | string | + | | } | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Name** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **SecureBootCurrentBoot** | string | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **SecureBootEnable** | boolean | + | | **SecureBootCurrentBoot** | string, null\\ \\ *read-write* | Secure Boot state during the current boot cycle. |
| - | | **SecureBootMode** | string | + | | **SecureBootEnable** | boolean, null\\ \\ *read-write* | Enable or disable UEFI Secure Boot (takes effect on next boot). | |
| + | | **SecureBootMode** | string, null\\ \\ *read-write* | Current Secure Boot Mode. *See Property Details, below, for more information about this property.* | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == SecureBootCurrentBoot == | + | ==== SecureBootCurrentBoot: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Disabled | Secure Boot is currently disabled. | | | Disabled | Secure Boot is currently disabled. | | ||
| | Enabled | Secure Boot is currently enabled. | | | Enabled | Secure Boot is currently enabled. | | ||
| - | == SecureBootMode == | + | ==== SecureBootMode: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | AuditMode | Secure Boot is currently in Audit Mode. | | | AuditMode | Secure Boot is currently in Audit Mode. | | ||
| | DeployedMode | Secure Boot is currently in Deployed Mode. | | | DeployedMode | Secure Boot is currently in Deployed Mode. | | ||
| Line 3844: | Line 4305: | ||
| - | ===== SerialInterface ===== | + | ====== SerialInterface |
| This schema defines an asynchronous serial interface resource. | This schema defines an asynchronous serial interface resource. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **BitRate** | string | + | | --- | --- | --- | |
| - | | **ConnectorType** | string | + | | **BitRate** | string\\ \\ *read-write* | The receive and transmit rate of data flow, typically in bits-per-second (bps), over the serial connection. |
| - | | **DataBits** | string | + | | **ConnectorType** | string\\ \\ *read-write* | The type of connector used for this interface. |
| - | | **Description** | string | + | | **DataBits** | string\\ \\ *read-write* | The number of data bits that will follow the start bit over the serial connection. |
| - | | **FlowControl** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Id** | string | + | | **FlowControl** | string\\ \\ *read-write* | The type of flow control, if any, that will be imposed on the serial connection. |
| - | | **InterfaceEnabled** | boolean | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Name** | string | + | | **InterfaceEnabled** | boolean, null\\ \\ *read-write* | This indicates whether this interface is enabled. | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **Parity** | string | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **PinOut** | string | + | | **Parity** | string\\ \\ *read-write* | The type of parity used by the sender and receiver in order to detect errors over the serial connection. |
| - | | **SignalType** | string | + | | **PinOut** | string, null\\ \\ *read-write* | The physical pin configuration needed for a serial connector. |
| - | | **StopBits** | string | + | | **SignalType** | string\\ \\ *read-write* | The type of signal used for the communication connection - RS232 or RS485. |
| + | | **StopBits** | string\\ \\ *read-write* | The period of time before the next start bit is transmitted. | ||
| - | === Property Details === | + | ===== Property Details |
| - | == BitRate == | + | ==== BitRate: ==== |
| - | ^ string | + | | string |
| - | | 1200 | | + | | --- | |
| - | | 2400 | | + | | 1200 | |
| - | | 4800 | | + | | 2400 | |
| - | | 9600 | | + | | 4800 | |
| - | | 19200 | | + | | 9600 | |
| - | | 38400 | | + | | 19200 | |
| - | | 57600 | | + | | 38400 | |
| - | | 115200 | | + | | 57600 | |
| - | | 230400 | | + | | 115200 | |
| + | | 230400 | | ||
| - | == ConnectorType == | + | ==== ConnectorType: ==== |
| - | ^ string | + | | string |
| - | | RJ45. | | + | | --- | |
| - | | RJ11. | | + | | RJ45. | |
| - | | DB9 Female. | | + | | RJ11. | |
| - | | DB9 Male. | | + | | DB9 Female. | |
| - | | DB25 Female. | | + | | DB9 Male. | |
| - | | DB25 Male. | | + | | DB25 Female. | |
| - | | USB. | | + | | DB25 Male. | |
| - | | mUSB. | | + | | USB. | |
| - | | uUSB. | | + | | mUSB. | |
| + | | uUSB. | | ||
| - | == DataBits == | + | ==== DataBits: ==== |
| - | ^ string | + | | string |
| - | | 5 | | + | | --- | |
| - | | 6 | | + | | 5 | |
| - | | 7 | | + | | 6 | |
| - | | 8 | | + | | 7 | |
| + | | 8 | | ||
| - | == FlowControl == | + | ==== FlowControl: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Hardware | Out of band flow control imposed. | | | Hardware | Out of band flow control imposed. | | ||
| | None | No flow control imposed. | | | None | No flow control imposed. | | ||
| | Software | XON/XOFF in-band flow control imposed. | | | Software | XON/XOFF in-band flow control imposed. | | ||
| - | == Parity == | + | ==== Parity: ==== |
| - | ^ string | + | | string |
| - | | None | | + | | --- | |
| - | | Even | | + | | None | |
| - | | Odd | | + | | Even | |
| - | | Mark | | + | | Odd | |
| - | | Space | | + | | Mark | |
| + | | Space | | ||
| - | == PinOut == | + | ==== PinOut: ==== |
| - | ^ string | + | | string |
| - | | Cisco | | + | | --- | |
| - | | Cyclades | | + | | Cisco | |
| - | | Digi | | + | | Cyclades | |
| + | | Digi | | ||
| - | == SignalType == | + | ==== SignalType: ==== |
| - | ^ string | + | | string |
| - | | Rs232 | | + | | --- | |
| - | | Rs485 | | + | | Rs232 | |
| + | | Rs485 | | ||
| - | == StopBits == | + | ==== StopBits: ==== |
| - | ^ string | + | | string |
| - | | 1 | | + | | --- | |
| - | | 2 | | + | | 1 | |
| + | | 2 | | ||
| - | ===== SerialInterfaceCollection | + | ====== |
| - | + | ||
| - | A Collection of SerialInterface resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== ServiceRoot | + | |
| This object represents the root Redfish service. | This object represents the root Redfish service. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **AccountService** | reference([[documentation: | + | | --- | --- | --- | |
| - | | **Chassis** | reference([[documentation: | + | | **AccountService** |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | | < |
| - | | **EventService** | reference([[documentation: | + | | < |
| - | | **Fabrics** | reference([[documentation: | + | | < |
| - | | **Id** | string | | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | < |
| - | | **JsonSchemas** | reference([[documentation: | + | | < |
| - | | **Links** { | object | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **Sessions** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **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 | + | | < |
| - | | **Registries** | reference([[documentation: | + | | < |
| - | | **SessionService** | reference([[documentation: | + | | < |
| - | | **StorageServices** | reference([[documentation: | + | | } | |
| - | | **StorageSystems** | reference([[documentation: | + | | **Chassis** { | object\\ \\ *read-write* |
| - | | **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.\\ | + | | < |
| - | | **UpdateService** | reference([[documentation: | + | | < |
| + | | < | ||
| + | | } | | ||
| + | | **Description** | string, null\\ \\ *read-write* | ||
| + | | **EventService** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | | | ||
| + | | **Fabrics** *(v1.1+)* { | object\\ \\ *read-write* | A link to a collection of all fabric entities. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Id** | string\\ \\ *read-write* | ||
| + | | **JsonSchemas** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Links** { | object\\ \\ *read-write* | Contains references to other resources that are related to this resource. | | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Managers** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | | ||
| + | | **Oem** {} | object\\ \\ *read-write* | ||
| + | | **RedfishVersion** | string\\ \\ *read-only* | The version of the Redfish service. | ||
| + | | **Registries** { | object\\ \\ *read-write* | This is a link to a collection of Registries. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **SessionService** { | object\\ \\ *read-write* | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **StorageServices** *(v1.1+)* { | object\\ \\ *read-write* | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **StorageSystems** *(v1.1+)* { | object\\ \\ *read-write* | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Systems** { | object\\ \\ *read-write* | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Tasks** { | object\\ \\ *read-write* | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **UUID** | string, null\\ \\ *read-write* | ||
| + | | **UpdateService** *(v1.1+)* { | object\\ \\ *read-write* | This is a link to the UpdateService. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == CompletedTaskOverWritePolicy == | + | ==== CompletedTaskOverWritePolicy: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Manual | Completed tasks are not automatically overwritten. | | | Manual | Completed tasks are not automatically overwritten. | | ||
| | Oldest | Oldest completed tasks are overwritten. | | | Oldest | Oldest completed tasks are overwritten. | | ||
| - | ===== Session ===== | + | ====== Session |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Description** | string | + | | --- | --- | --- | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Name** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **Password** | string | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **UserName** | string | + | | **Password** | string, null\\ \\ *read-only* | This property is used in a POST to specify a password when creating a new session. |
| + | | **UserName** | string, null\\ \\ *read-only* | The UserName for the account for this session. | | ||
| - | ===== SessionCollection | + | ====== |
| - | + | ||
| - | A Collection of Session resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== SessionService | + | |
| This is the schema definition for the Session Service. | This is the schema definition for the Session Service. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Actions** { | object | + | | --- | --- | --- | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **Actions** *(v1.1+)* { | object\\ \\ *read-write* | The Actions object contains the available custom actions on this resource. | |
| - | | } | | | | + | | < |
| - | | **Description** | string | + | | } | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Name** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **ServiceEnabled** | boolean | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **SessionTimeout** | number | + | | **ServiceEnabled** | boolean, null\\ \\ *read-write* | This indicates whether this service is enabled. | |
| - | | **Sessions** | reference([[documentation: | + | | **SessionTimeout** | number\\ (s)\\ \\ *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. |
| - | | **Status** { | object | | read-only | Indicates the status of the file share. | | + | | **Sessions** { | object\\ \\ *read-write* | Link to a collection of Sessions. | |
| - | | \ \ \ \ \ \ **Health** | string | + | | < |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **State** | string | + | | < |
| - | | } | | | | + | | < |
| + | | } | | ||
| + | | **Status** { | object\\ \\ *read-only* | Indicates the status of the file share. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 4059: | Line 4630: | ||
| - | ===== SimpleStorage ===== | + | ====== SimpleStorage |
| This is the schema definition for the Simple Storage resource. | This is the schema definition for the Simple Storage resource. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Description** | string | + | | --- | --- | --- | |
| - | | **Devices** [ { | array | | read-write | The storage devices associated with this resource. | | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | \ \ \ \ \ \ **CapacityBytes** | number | + | | **Devices** [ { | array\\ \\ *read-write* | The storage devices associated with this resource. | |
| - | | \ \ \ \ \ \ **Manufacturer** | string | + | | < |
| - | | \ \ \ \ \ \ **Model** | string | + | | < |
| - | | \ \ \ \ \ \ **Name** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **Status** {} | object | + | | < |
| - | | } ] | | | | + | | < |
| - | | **Id** | string | + | | } ] | |
| - | | **Name** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **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 | + | | < |
| - | | } | | | | + | | < |
| - | | **UefiDevicePath** | string | + | | } | |
| + | | **UefiDevicePath** | string, null\\ \\ *read-only* | The UEFI device path used to access this storage controller. | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 4116: | Line 4691: | ||
| - | ===== SimpleStorageCollection | + | ====== |
| - | + | ||
| - | A Collection of SimpleStorage resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== SoftwareInventory | + | |
| This schema defines an inventory of software components. | This schema defines an inventory of software components. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Actions** { | object | + | | --- | --- | --- | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **Actions** { | object\\ \\ *read-write* | The Actions object contains the available custom actions on this resource. | |
| - | | } | | | | + | | < |
| - | | **Description** | string | + | | } | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **LowestSupportedVersion** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Name** | string | + | | **LowestSupportedVersion** *(v1.1+)* | string, null\\ \\ *read-only* | A string representing the lowest supported version of this software. | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **RelatedItem** [ {} ] | array | | read-only | The ID(s) of the resources associated with this software inventory item. | | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **SoftwareId** | string | | read-only | A string representing the implementation-specific ID for identifying this software. | | + | | **RelatedItem** *(v1.1+)* [ {} ] | array\\ \\ *read-only* | The ID(s) of the resources associated with this software inventory item. | |
| - | | **Status** { | object | + | | **[email protected]** *(v1.1+)* | string\\ \\ *read-write* |
| - | | \ \ \ \ \ \ **Health** | string | + | | **SoftwareId** *(v1.1+)* | string\\ \\ *read-only* | A string representing the implementation-specific ID for identifying this software. | |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | **Status** { | object, null\\ \\ *read-only* | Indicates the status of the file share. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **State** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **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 | + | | } | |
| - | | **Version** | string | + | | **UefiDevicePaths** *(v1.1+)* [ {} ] | 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, null\\ \\ *read-only* | Indicates whether this software can be updated by the update service. | | ||
| + | | **Version** | string, null\\ \\ *read-only* | A string representing the version of this software. | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 4183: | Line 4753: | ||
| - | ===== SoftwareInventoryCollection | + | ====== |
| - | + | ||
| - | A Collection of SoftwareInventory resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== Storage | + | |
| This schema defines a storage subsystem and its respective properties. | This schema defines a storage subsystem and its respective properties. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Actions** { | object | + | | --- | --- | --- | |
| - | | \ \ \ \ \ \ **# | + | | **Actions** { | object\\ \\ *read-write* | The available actions for this resource. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **Description** | string | + | | } | |
| - | | **Drives** | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Id** | string | | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Drives** [ { | array\\ \\ *read-only* | The set of drives attached to the storage controllers represented by this resource. | |
| - | | **Links** { | object | + | | < |
| - | | \ \ \ \ \ \ **Enclosures** [ {} ] | array | | read-only | An array of references to the chassis to which this storage subsystem is attached. | | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **Name** | string | + | | < |
| - | | **Oem** {} | object | + | | < |
| - | | **Redundancy** [ { | array | | read-write | Redundancy information for the storage subsystem. | | + | | < |
| - | | \ \ \ \ \ \ **MaxNumSupported** | number | + | | < |
| - | | \ \ \ \ \ \ **MemberId** | string | + | | < |
| - | | \ \ \ \ \ \ **MinNumNeeded** | number | + | | < |
| - | | \ \ \ \ \ \ **Mode** | string | + | | < |
| - | | \ \ \ \ \ \ **Name** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **RedundancySet** [ {} ] | array | | read-only | Contains any ids that represent components of this redundancy set. | | + | | < |
| - | | \ \ \ \ \ \ **Status** {} | object | + | | < |
| - | | \ \ \ \ \ \ **MemberId** | string | + | | < |
| - | | \ \ \ \ \ \ **RedundancyEnabled** | boolean | + | | < |
| - | | } ] | | | | + | | < |
| - | | **Status** { | object | + | | < |
| - | | \ \ \ \ \ \ **Health** | string | + | | < |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **State** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **StorageControllers** [ { | array | | read-only | The set of storage controllers represented by this resource. | | + | | < |
| - | | \ \ \ \ \ \ **AssetTag** | string | + | | < |
| - | | \ \ \ \ \ \ **FirmwareVersion** | string | + | | < |
| - | | \ \ \ \ \ \ **Identifiers** [ {} ] | array | | read-write | The Durable names for the storage controller. | | + | | < |
| - | | \ \ \ \ \ \ **Links** {} | object | + | | < |
| - | | \ \ \ \ \ \ **Manufacturer** | string | + | | < |
| - | | \ \ \ \ \ \ **MemberId** | string | + | | < |
| - | | \ \ \ \ \ \ **Model** | string | + | | } ] | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **[email protected]** | string\\ \\ *read-write* |
| - | | \ \ \ \ \ \ **PartNumber** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **SKU** | string | + | | **Links** { | object\\ \\ *read-write* | Contains references to other resources that are related to this resource. | |
| - | | \ \ \ \ \ \ **SerialNumber** | string | + | | < |
| - | | \ \ \ \ \ \ **SpeedGbps** | number | + | | < |
| - | | \ \ \ \ \ \ **Status** {} | object | + | | < |
| - | | \ \ \ \ \ \ **SupportedControllerProtocols** [ {} ] | array | | read-only | This represents the protocols by which this storage controller can be communicated to. | | + | | } | |
| - | | \ \ \ \ \ \ **SupportedDeviceProtocols** [ {} ] | array | | read-only | This represents the protocols which the storage controller can use to communicate with attached devices. | | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | } ] | | | | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **Volumes** | reference([[documentation: | + | | **Redundancy** [ { | array\\ \\ *read-write* | Redundancy information for the storage subsystem. | |
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } ] | | | | ||
| + | | **[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* | ||
| + | | **Volumes** { | object\\ \\ *read-write* | The set of volumes produced by the storage controllers represented by this resource. | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == EncryptionAbility == | + | ==== EncryptionAbility: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | None | The drive is not capable of self encryption. | | | None | The drive is not capable of self encryption. | | ||
| | Other | The drive is capable of self encryption through some other means. | | | 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' | | SelfEncryptingDrive | The drive is capable of self encryption per the Trusted Computing Group' | ||
| - | == EncryptionStatus == | + | ==== EncryptionStatus: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Foreign | The drive is currently encrypted, the data is not accessible to the user, and the system requires user intervention to expose the data. | | | 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. | | | 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. | | ||
| Line 4266: | Line 4872: | ||
| | Unlocked | The drive is currently encrypted but the data is accessible to the user unencrypted. | | | Unlocked | The drive is currently encrypted but the data is accessible to the user unencrypted. | | ||
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HotspareType == | + | ==== HotspareType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Chassis | The drive is currently serving as a hotspare for all other drives in the chassis. | | | 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. | | | Dedicated | The drive is currently serving as a hotspare for a user defined set of drives. | | ||
| Line 4288: | Line 4897: | ||
| | None | The drive is not currently a hotspare. | | | None | The drive is not currently a hotspare. | | ||
| - | == IndicatorLED == | + | ==== IndicatorLED: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Blinking | The Indicator LED is blinking. | | | Blinking | The Indicator LED is blinking. | | ||
| | Lit | The Indicator LED is lit. | | | Lit | The Indicator LED is lit. | | ||
| | Off | The Indicator LED is off. | | | Off | The Indicator LED is off. | | ||
| - | == MediaType == | + | ==== MediaType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | HDD | The drive media type is traditional magnetic platters. | | | HDD | The drive media type is traditional magnetic platters. | | ||
| | SMR | The drive media type is shingled magnetic recording. | | | SMR | The drive media type is shingled magnetic recording. | | ||
| | SSD | The drive media type is solid state or flash memory. | | | SSD | The drive media type is solid state or flash memory. | | ||
| - | == Mode == | + | ==== Mode: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Failover | Failure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set. | | | Failover | Failure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set. | | ||
| | N+m | Multiple units are available and active such that normal operation will continue if one or more units fail. | | | N+m | Multiple units are available and active such that normal operation will continue if one or more units fail. | | ||
| Line 4310: | Line 4922: | ||
| | Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. | | | Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 4325: | Line 4938: | ||
| | Updating | The element is updating and may be unavailable or degraded. | | | Updating | The element is updating and may be unavailable or degraded. | | ||
| - | == StatusIndicator == | + | ==== StatusIndicator: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Fail | The drive has failed. | | | Fail | The drive has failed. | | ||
| | Hotspare | The drive is marked to be automatically rebuilt and used as a replacement for a failed drive. | | | Hotspare | The drive is marked to be automatically rebuilt and used as a replacement for a failed drive. | | ||
| Line 4337: | Line 4951: | ||
| - | ===== StorageCollection | + | ====== |
| - | + | ||
| - | A Collection of Storage resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== StorageGroup | + | |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **AccessState** | | Yes | read-write | AccessState for this storage group. | | + | | --- | --- | --- | |
| - | | **Actions** { | object | + | | **AccessState** | null\\ \\ *read-write* | AccessState for this storage group. | |
| - | | \ \ \ \ \ \ **# | + | | **Actions** { | object\\ \\ *read-only* | The available actions for this resource. | |
| - | | \ \ \ \ \ \ **# | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **ClientEndpointGroups** | object | + | | } | |
| - | | **Description** | string | + | | **ClientEndpointGroups** |
| - | | **Id** | string | | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | < |
| - | | **Identifier** { | object | + | | < |
| - | | \ \ \ \ \ \ **DurableName** | string | + | | < |
| - | | \ \ \ \ \ \ **DurableNameFormat** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **Links** { | object | + | | } | |
| - | | \ \ \ \ \ \ **ChildStorageGroups** [ {} ] | array | | read-write | Child StorageGroups. | | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | \ \ \ \ \ \ **ClassOfService** {} | object | + | | **Id** | string\\ \\ *read-write* |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **Identifier** { | object, null\\ \\ *read-only* | The value identifies this resource. | |
| - | | \ \ \ \ \ \ **ParentStorageGroups** [ {} ] | array | | read-only | Parent StorageGroups. | | + | | < |
| - | | } | | | | + | | < |
| - | | **MembersAreConsistent** | boolean | + | | } | |
| - | | **Name** | string | + | | **Links** { | object\\ \\ *read-only* | Contains links to other resources that are related to this resource. | |
| - | | **Oem** {} | object | + | | < |
| - | | **ReplicaInfos** [ { | array | | read-only | Describes this storage group in its role as a source and/or target for replication. | | + | | < |
| - | | \ \ \ \ \ \ **ConsistencyEnabled** | boolean | + | | < |
| - | | \ \ \ \ \ \ **ConsistencyState** | string | + | | < |
| - | | \ \ \ \ \ \ **ConsistencyStatus** | string | + | | < |
| - | | \ \ \ \ \ \ **ConsistencyType** | string | + | | < |
| - | | \ \ \ \ \ \ **FailedCopyStopsHostIO** | boolean | + | | } | |
| - | | \ \ \ \ \ \ **PercentSynced** | number | + | | **MembersAreConsistent** | boolean, null\\ \\ *read-only* | Members are kept in a consistent state. | |
| - | | \ \ \ \ \ \ **Replica** | | Yes | read-write | The resource that is the source of this replica. | | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | \ \ \ \ \ \ **ReplicaPriority** | string | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | \ \ \ \ \ \ **ReplicaProgressStatus** | string | + | | **ReplicaInfos** [ { | array\\ \\ *read-only* | Describes this storage group in its role as a source and/or target for replication. | |
| - | | \ \ \ \ \ \ **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 | + | | < |
| - | | **Status** { | object | Yes | read-only | Indicates the status of the file share. | | + | | < |
| - | | \ \ \ \ \ \ **Health** | string | + | | < |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **State** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **Volumes** | object | + | | < |
| - | | **VolumesAreExposed** | boolean | + | | } ] | |
| + | | **ServerEndpointGroups** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Status** { | object, null\\ \\ *read-only* | Indicates the status of the file share. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Volumes** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **VolumesAreExposed** | boolean, null\\ \\ *read-only* | Storage volumes are exposed to the Client Endpoints. | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == ConsistencyState == | + | ==== ConsistencyState: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Consistent | Consistent. | | | Consistent | Consistent. | | ||
| | Inconsistent | Not consistent. | | | Inconsistent | Not consistent. | | ||
| - | == ConsistencyStatus == | + | ==== ConsistencyStatus: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Consistent | Consistent. | | | Consistent | Consistent. | | ||
| | Disabled | Consistency disabled. | | | Disabled | Consistency disabled. | | ||
| Line 4427: | Line 5054: | ||
| | InProgress | Becoming consistent. | | | InProgress | Becoming consistent. | | ||
| - | == ConsistencyType == | + | ==== ConsistencyType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | SequentiallyConsistent | Sequentially consistent. | | | SequentiallyConsistent | Sequentially consistent. | | ||
| - | == DurableNameFormat == | + | ==== DurableNameFormat: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | EUI | IEEE-defined 64-bit Extended Unique Identifier | | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
| | FC_WWN | Fibre Channel World Wide Name | | | FC_WWN | Fibre Channel World Wide Name | | ||
| Line 4441: | Line 5070: | ||
| | iQN | iSCSI Qualified Name | | | iQN | iSCSI Qualified Name | | ||
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == ReplicaPriority == | + | ==== ReplicaPriority: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | High | Copy engine I/O has higher priority than host I/O. | | | High | Copy engine I/O has higher priority than host I/O. | | ||
| | Low | Copy engine I/O lower priority than host I/O. | | | Low | Copy engine I/O lower priority than host I/O. | | ||
| Line 4463: | Line 5095: | ||
| | Urgent | Copy operation to be performed as soon as possible, regardless of the host I/O requests. | | | Urgent | Copy operation to be performed as soon as possible, regardless of the host I/O requests. | | ||
| - | == ReplicaProgressStatus == | + | ==== ReplicaProgressStatus: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Aborting | Abort in progress. | | | Aborting | Abort in progress. | | ||
| | Completed | The request is completed. Data flow is idle. | | | Completed | The request is completed. Data flow is idle. | | ||
| Line 4490: | Line 5123: | ||
| | Terminating | The relationship is in the process of terminating. | | | Terminating | The relationship is in the process of terminating. | | ||
| - | == ReplicaReadOnlyAccess == | + | ==== ReplicaReadOnlyAccess: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Both | Both the source and the target elements are read only to the host. | | | Both | Both the source and the target elements are read only to the host. | | ||
| | ReplicaElement | The replica element. | | ReplicaElement | The replica element. | ||
| | SourceElement | The source element. | | | SourceElement | The source element. | | ||
| - | == ReplicaRecoveryMode == | + | ==== ReplicaRecoveryMode: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Automatic | Copy operation resumes automatically. | | | Automatic | Copy operation resumes automatically. | | ||
| | Manual | ReplicaState is set to Suspended after the link is restored. It is required to issue the Resume operation to continue. | | | Manual | ReplicaState is set to Suspended after the link is restored. It is required to issue the Resume operation to continue. | | ||
| - | == ReplicaRole == | + | ==== ReplicaRole: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Source | The source element. | | | Source | The source element. | | ||
| | Target | The target element. | | Target | The target element. | ||
| - | == ReplicaState == | + | ==== ReplicaState: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Aborted | The copy operation is aborted with the Abort operation. Use the Resync Replica operation to restart the copy operation. | | Aborted | The copy operation is aborted with the Abort operation. Use the Resync Replica operation to restart the copy operation. | ||
| | Broken | The relationship is non-functional due to errors in the source, the target, the path between the two or space constraints. | | Broken | The relationship is non-functional due to errors in the source, the target, the path between the two or space constraints. | ||
| Line 4529: | Line 5166: | ||
| | Unsynchronized | Not all the source element data has been copied to the target element. | | Unsynchronized | Not all the source element data has been copied to the target element. | ||
| - | == ReplicaType == | + | ==== ReplicaType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Clone | Create a point in time, full copy the source. | | | Clone | Create a point in time, full copy the source. | | ||
| | Mirror | Create and maintain a copy of the source. | | | Mirror | Create and maintain a copy of the source. | | ||
| Line 4537: | Line 5175: | ||
| | TokenizedClone | Create a token based clone. | | | TokenizedClone | Create a token based clone. | | ||
| - | == ReplicaUpdateMode == | + | ==== ReplicaUpdateMode: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Active | Active-Active (i.e. bidirectional) synchronous updates. | | | Active | Active-Active (i.e. bidirectional) synchronous updates. | | ||
| | Adaptive | Allows implementation to switch between synchronous and asynchronous modes. | | | Adaptive | Allows implementation to switch between synchronous and asynchronous modes. | | ||
| Line 4545: | Line 5184: | ||
| | Synchronous | Synchronous updates. | | | Synchronous | Synchronous updates. | | ||
| - | == RequestedReplicaState == | + | ==== RequestedReplicaState: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Aborted | The copy operation is aborted with the Abort operation. Use the Resync Replica operation to restart the copy operation. | | Aborted | The copy operation is aborted with the Abort operation. Use the Resync Replica operation to restart the copy operation. | ||
| | Broken | The relationship is non-functional due to errors in the source, the target, the path between the two or space constraints. | | Broken | The relationship is non-functional due to errors in the source, the target, the path between the two or space constraints. | ||
| Line 4565: | Line 5205: | ||
| | Unsynchronized | Not all the source element data has been copied to the target element. | | Unsynchronized | Not all the source element data has been copied to the target element. | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 4580: | Line 5221: | ||
| | Updating | The element is updating and may be unavailable or degraded. | | | Updating | The element is updating and may be unavailable or degraded. | | ||
| - | == UndiscoveredElement == | + | ==== UndiscoveredElement: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | ReplicaElement | The replica element is undiscovered. | | | ReplicaElement | The replica element is undiscovered. | | ||
| | SourceElement | The source element is undiscovered. | | | SourceElement | The source element is undiscovered. | | ||
| - | ===== StorageGroupCollection | + | ====== |
| - | + | ||
| - | A Collection of StorageGroup resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== StoragePool | + | |
| A container of data storage. | A container of data storage. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **AllocatedPools** | object | + | | --- | --- | --- | |
| - | | **AllocatedVolumes** | object | Yes | read-write | A reference to the collection of volumes allocated from this storage pool. | | + | | **AllocatedPools** |
| - | | **BlockSizeBytes** | number | + | | < |
| - | | **Capacity** { | object | + | | < |
| - | | \ \ \ \ \ \ **Data** {} | object | + | | < |
| - | | \ \ \ \ \ \ **IsThinProvisioned** | boolean | + | | < |
| - | | \ \ \ \ \ \ **Metadata** {} | object | + | | < |
| - | | \ \ \ \ \ \ **Snapshot** {} | object | + | | } | |
| - | | } | | | | + | | **AllocatedVolumes** { | object, null\\ \\ *read-write* | A reference to the collection of volumes allocated from this storage pool. | |
| - | | **CapacitySources** [ { | array | | read-only | An array of space allocations to this store. | | + | | < |
| - | | \ \ \ \ \ \ **ProvidedCapacity** {} | object | + | | < |
| - | | \ \ \ \ \ \ **ProvidedClassOfService** {} | object | + | | < |
| - | | \ \ \ \ \ \ **ProvidingDrives** {} | object | + | | < |
| - | | \ \ \ \ \ \ **ProvidingPools** {} | object | + | | < |
| - | | \ \ \ \ \ \ **ProvidingVolumes** {} | object | + | | } | |
| - | | } ] | | | | + | | **BlockSizeBytes** | number, null\\ (By)\\ \\ *read-only* | Maximum Block size in bytes. | |
| - | | **ClassesOfService** | object | + | | **Capacity** { | object, null\\ \\ *read-write* | Capacity utilization. | |
| - | | **Description** | string | + | | < |
| - | | **Id** | string | | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | < |
| - | | **Identifier** { | object | + | | < |
| - | | \ \ \ \ \ \ **DurableName** | string | + | | < |
| - | | \ \ \ \ \ \ **DurableNameFormat** | string | + | | } | |
| - | | } | | | | + | | **CapacitySources** [ { | array\\ \\ *read-only* | An array of space allocations to this store. | |
| - | | **Links** { | object | + | | < |
| - | | \ \ \ \ \ \ **DefaultClassOfService** {} | object | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **LowSpaceWarningThresholdPercents** [ {} ] | array | | read-write | Low space warning threshold specified in percents. | | + | | < |
| - | | **Name** | string | + | | } ] | |
| - | | **Oem** {} | object | + | | **ClassesOfService** |
| - | | **Status** { | object | + | | < |
| - | | \ \ \ \ \ \ **Health** | string | + | | < |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **State** | string | + | | < |
| - | | } | | | | + | | } | |
| + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality | ||
| + | | **Id** | string\\ \\ *read-write* | ||
| + | | **Identifier** { | object, null\\ \\ *read-only* | The value identifies this resource. | | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Links** { | object\\ \\ *read-only* | Contains links to other resources that are related to this resource. | | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **LowSpaceWarningThresholdPercents** [ {} ] | array\\ \\ *read-write* | Low space warning threshold specified in percents. | | ||
| + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | | ||
| + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ | ||
| + | | **Status** { | object, null\\ \\ *read-only* | Indicates the status of the file share. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == DurableNameFormat == | + | ==== DurableNameFormat: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | EUI | IEEE-defined 64-bit Extended Unique Identifier | | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
| | FC_WWN | Fibre Channel World Wide Name | | | FC_WWN | Fibre Channel World Wide Name | | ||
| Line 4650: | Line 5302: | ||
| | iQN | iSCSI Qualified Name | | | iQN | iSCSI Qualified Name | | ||
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 4680: | Line 5335: | ||
| - | ===== StoragePoolCollection | + | ====== |
| - | + | ||
| - | A Collection of StoragePool resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== StorageService | + | |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Actions** { | object | + | | --- | --- | --- | |
| - | | \ \ \ \ \ \ **# | + | | **Actions** { | object\\ \\ *read-only* | The available actions for this resource. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **ClassesOfService** | object | + | | } | |
| - | | **ClientEndpointGroups** | object | Yes | read-write | Client endpoint groups. | | + | | **ClassesOfService** |
| - | | **Description** | string | + | | < |
| - | | **Drives** | reference([[documentation: | + | | < |
| - | | **Endpoints** | object | Yes | read-write | Endpoints. | | + | | < |
| - | | **FileSystems** | reference([[documentation: | + | | < |
| - | | **Id** | string | | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | < |
| - | | **Identifier** { | object | + | | } | |
| - | | \ \ \ \ \ \ **DurableName** | string | + | | **ClientEndpointGroups** { | object, null\\ \\ *read-write* | Client endpoint groups. | |
| - | | \ \ \ \ \ \ **DurableNameFormat** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **Links** { | object | + | | < |
| - | | \ \ \ \ \ \ **DataProtectionLoSCapabilities** {} | object | + | | < |
| - | | \ \ \ \ \ \ **DataSecurityLoSCapabilities** {} | object | + | | < |
| - | | \ \ \ \ \ \ **DataStorageLoSCapabilities** {} | object | + | | } | |
| - | | \ \ \ \ \ \ **DefaultClassOfService** {} | object | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | \ \ \ \ \ \ **HostingSystem** {} | object | + | | **Drives** { | object\\ \\ *read-write* |
| - | | \ \ \ \ \ \ **IOConnectivityLoSCapabilities** {} | object | + | | < |
| - | | \ \ \ \ \ \ **IOPerformanceLoSCapabilities** {} | object | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **Name** | string | + | | < |
| - | | **Oem** {} | object | + | | } | |
| - | | **Redundancy** [ { | array | | read-only | Redundancy information for the storage subsystem | | + | | **Endpoints** { | object, null\\ \\ *read-write* | Endpoints. | |
| - | | \ \ \ \ \ \ **MaxNumSupported** | number | + | | < |
| - | | \ \ \ \ \ \ **MemberId** | string | + | | < |
| - | | \ \ \ \ \ \ **MinNumNeeded** | number | + | | < |
| - | | \ \ \ \ \ \ **Mode** | string | + | | < |
| - | | \ \ \ \ \ \ **Name** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | } | |
| - | | \ \ \ \ \ \ **RedundancySet** [ {} ] | array | | read-only | Contains any ids that represent components of this redundancy set. | | + | | **FileSystems** { | object\\ \\ *read-write* |
| - | | \ \ \ \ \ \ **Status** {} | object | + | | < |
| - | | \ \ \ \ \ \ **MemberId** | string | + | | < |
| - | | \ \ \ \ \ \ **RedundancyEnabled** | boolean | + | | < |
| - | | } ] | | | | + | | < |
| - | | **ServerEndpointGroups** | object | + | | < |
| - | | **Status** { | object | Yes | read-only | Indicates the status of the file share. | | + | | } | |
| - | | \ \ \ \ \ \ **Health** | string | + | | **Id** | string\\ \\ *read-write* |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | **Identifier** { | object, null\\ \\ *read-only* | The value identifies this resource. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **State** | string | + | | < |
| - | | } | | | | + | | } | |
| - | | **StorageGroups** | object | Yes | read-write | StorageGroups. | | + | | **Links** { | object\\ \\ *read-only* | Contains links to other resources that are related to this resource. | |
| - | | **StoragePools** | reference([[documentation: | + | | < |
| - | | **Volumes** | reference([[documentation: | + | | < |
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | | ||
| + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ | ||
| + | | **Redundancy** [ { | array\\ \\ *read-only* | Redundancy information for the storage subsystem | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } ] | | | | ||
| + | | **[email protected]** | string\\ \\ *read-write* | ||
| + | | **ServerEndpointGroups** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Status** { | object, null\\ \\ *read-only* | Indicates the status of the file share. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **StorageGroups** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **StoragePools** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Volumes** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == DurableNameFormat == | + | ==== DurableNameFormat: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | EUI | IEEE-defined 64-bit Extended Unique Identifier | | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
| | FC_WWN | Fibre Channel World Wide Name | | | FC_WWN | Fibre Channel World Wide Name | | ||
| Line 4756: | Line 5459: | ||
| | iQN | iSCSI Qualified Name | | | iQN | iSCSI Qualified Name | | ||
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == Mode == | + | ==== Mode: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Failover | Failure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set. | | | Failover | Failure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set. | | ||
| | N+m | Multiple units are available and active such that normal operation will continue if one or more units fail. | | | N+m | Multiple units are available and active such that normal operation will continue if one or more units fail. | | ||
| Line 4778: | Line 5484: | ||
| | Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. | | | Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 4794: | Line 5501: | ||
| - | ===== StorageServiceCollection | + | ====== |
| - | + | ||
| - | A collection of references to Storage Service resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== StorageSystemCollection ===== | + | |
| - | + | ||
| - | A Collection of ComputerSystem resource instances that each have an entry in HostingRoles set to ' | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== Switch | + | |
| Switch contains properties describing a simple fabric switch. | Switch contains properties describing a simple fabric switch. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Actions** { | object | + | | --- | --- | --- | |
| - | | \ \ \ \ \ \ **# | + | | **Actions** { | object\\ \\ *read-write* | The available actions for this resource. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **AssetTag** | string | + | | } | |
| - | | **Description** | string | + | | **AssetTag** | string, null\\ \\ *read-write* | The user assigned asset tag for this switch. | |
| - | | **DomainID** | number | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Id** | string | + | | **DomainID** | number, null\\ \\ *read-only* | The Domain ID for this switch. | |
| - | | **IndicatorLED** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **IsManaged** | boolean | + | | **IndicatorLED** | string, null\\ \\ *read-write* | The state of the indicator LED, used to identify the switch. |
| - | | **Links** { | object | + | | **IsManaged** | boolean, null\\ \\ *read-write* | This indicates whether the switch is in a managed or unmanaged state. | |
| - | | \ \ \ \ \ \ **Chassis** {} | object | + | | **Links** { | object\\ \\ *read-write* | Contains references to other resources that are related to this resource. | |
| - | | \ \ \ \ \ \ **ManagedBy** [ {} ] | array | | read-only | An array of references to the managers that manage this switch. | | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **LogServices** | object | + | | < |
| - | | **Manufacturer** | string | Yes | read-only | This is the manufacturer of this switch. | | + | | } | |
| - | | **Model** | string | + | | **LogServices** |
| - | | **Name** | string | + | | < |
| - | | **Oem** {} | object | + | | < |
| - | | **PartNumber** | string | + | | < |
| - | | **Ports** | reference([[documentation: | + | | < |
| - | | **PowerState** | string | Yes | read-write | This is the current power state of the switch.\\ //See Property Details, below, for more information about this property.// | | + | | < |
| - | | **Redundancy** [ { | array | | read-write | Redundancy information for the switches. | | + | | } | |
| - | | \ \ \ \ \ \ **MaxNumSupported** | number | + | | **Manufacturer** | string, null\\ \\ *read-only* |
| - | | \ \ \ \ \ \ **MemberId** | string | + | | **Model** | string, null\\ \\ *read-only* | The product model number of this switch. | |
| - | | \ \ \ \ \ \ **MinNumNeeded** | number | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | \ \ \ \ \ \ **Mode** | string | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | \ \ \ \ \ \ **Name** | string | + | | **PartNumber** | string, null\\ \\ *read-only* | The part number for this switch. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **Ports** |
| - | | \ \ \ \ \ \ **RedundancySet** [ {} ] | array | | read-only | Contains any ids that represent components of this redundancy set. | | + | | < |
| - | | \ \ \ \ \ \ **Status** {} | object | + | | < |
| - | | \ \ \ \ \ \ **MemberId** | string | + | | < |
| - | | \ \ \ \ \ \ **RedundancyEnabled** | boolean | + | | < |
| - | | } ] | | | | + | | < |
| - | | **SKU** | string | Yes | read-only | This is the SKU for this switch. | | + | | } | |
| - | | **SerialNumber** | string | + | | **PowerState** | string, null\\ \\ *read-write* |
| - | | **Status** { | object | + | | **Redundancy** [ { | array\\ \\ *read-write* | Redundancy information for the switches. | |
| - | | \ \ \ \ \ \ **Health** | string | + | | < |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **State** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **SwitchType** | | Yes | read-write | The protocol being sent over this switch. | | + | | < |
| - | | **TotalSwitchWidth** | number | + | | < |
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } ] | | ||
| + | | **[email protected]** | string\\ \\ *read-write* | ||
| + | | **SKU** | string, null\\ \\ *read-only* | This is the SKU for this switch. | | ||
| + | | **SerialNumber** | string, null\\ \\ *read-only* | The serial number for this switch. | | ||
| + | | **Status** { | object\\ \\ *read-only* | Indicates the status of the file share. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **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 |
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == IndicatorLED == | + | ==== IndicatorLED: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Blinking | The Indicator LED is blinking. | | | Blinking | The Indicator LED is blinking. | | ||
| | Lit | The Indicator LED is lit. | | | Lit | The Indicator LED is lit. | | ||
| | Off | The Indicator LED is off. | | | Off | The Indicator LED is off. | | ||
| - | == Mode == | + | ==== Mode: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Failover | Failure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set. | | | Failover | Failure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set. | | ||
| | N+m | Multiple units are available and active such that normal operation will continue if one or more units fail. | | | N+m | Multiple units are available and active such that normal operation will continue if one or more units fail. | | ||
| Line 4896: | Line 5603: | ||
| | Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. | | | Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. | | ||
| - | == PowerState == | + | ==== PowerState: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Off | The state is powered Off. | | | Off | The state is powered Off. | | ||
| | On | The state is powered On. | | | On | The state is powered On. | | ||
| Line 4904: | Line 5612: | ||
| | PoweringOn | A temporary state between Off and On. | | | PoweringOn | A temporary state between Off and On. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 4920: | Line 5629: | ||
| - | ===== SwitchCollection | + | ====== |
| - | + | ||
| - | A Collection of Switch resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== Task ===== | + | |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Description** | string | + | | --- | --- | --- | |
| - | | **EndTime** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Id** | string | + | | **EndTime** | string\\ \\ *read-only* | The date-time stamp that the task was last completed. | |
| - | | **Messages** [ {} ] | array | | read-write | This is an array of messages associated with the task. | | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Name** | string | + | | **Messages** [ {} ] | array\\ \\ *read-write* | This is an array of messages associated with the task. | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **StartTime** | string | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **TaskState** | string | + | | **StartTime** | string\\ \\ *read-only* | The date-time stamp that the task was last started. | |
| - | | **TaskStatus** | string | + | | **TaskState** | string\\ \\ *read-write* | The state of the task. *See Property Details, below, for more information about this property.* | |
| + | | **TaskStatus** | string\\ \\ *read-write* | This is the completion status of the task. *See Property Details, below, for more information about this property.* | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == TaskState == | + | ==== TaskState: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Completed | Task has completed. | | | Completed | Task has completed. | | ||
| | Exception | Task has stopped due to an exception condition. | | | Exception | Task has stopped due to an exception condition. | | ||
| Line 4962: | Line 5663: | ||
| | Suspended | Task has been suspended. | | | Suspended | Task has been suspended. | | ||
| - | == TaskStatus == | + | ==== TaskStatus: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| Line 4970: | Line 5672: | ||
| - | ===== TaskCollection | + | ====== |
| - | + | ||
| - | A Collection of Task resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== TaskService | + | |
| This is the schema definition for the Task Service. | This is the schema definition for the Task Service. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **CompletedTaskOverWritePolicy** | string | + | | --- | --- | --- | |
| - | | **DateTime** | string | + | | **CompletedTaskOverWritePolicy** | string\\ \\ *read-write* | Overwrite policy of completed tasks. |
| - | | **Description** | string | + | | **DateTime** | string, null\\ \\ *read-only* | The current DateTime (with offset) setting that the task service is using. | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **LifeCycleEventOnTaskStateChange** | boolean | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Name** | string | + | | **LifeCycleEventOnTaskStateChange** | boolean\\ \\ *read-only* | Send an Event upon Task State Change. | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **ServiceEnabled** | boolean | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **Status** { | object | + | | **ServiceEnabled** | boolean, null\\ \\ *read-write* | This indicates whether this service is enabled. | |
| - | | \ \ \ \ \ \ **Health** | string | + | | **Status** { | object\\ \\ *read-only* | Indicates the status of the file share. | |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **State** | string | + | | < |
| - | | } | | | | + | | < |
| - | | **Tasks** | reference([[documentation: | + | | } | |
| + | | **Tasks** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == CompletedTaskOverWritePolicy == | + | ==== CompletedTaskOverWritePolicy: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Manual | Completed tasks are not automatically overwritten. | | | Manual | Completed tasks are not automatically overwritten. | | ||
| | Oldest | Oldest completed tasks are overwritten. | | | Oldest | Oldest completed tasks are overwritten. | | ||
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 5039: | Line 5742: | ||
| - | ===== Thermal ===== | + | ====== Thermal |
| This is the schema definition for the Thermal properties. | This is the schema definition for the Thermal properties. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Description** | string | + | | --- | --- | --- | |
| - | | **Fans** [ { | array | | read-write | This is the definition for fans. | | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | \ \ \ \ \ \ **FanName** | string | + | | **Fans** [ { | array\\ \\ *read-write* | This is the definition for fans. | |
| - | | \ \ \ \ \ \ **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 | | read-write | This structure is used to show redundancy for fans. The Component ids will reference the members of the redundancy groups. | | + | | < |
| - | | \ \ \ \ \ \ **RelatedItem** [ {} ] | array | | read-only | The ID(s) of the resources serviced with this fan. | | + | | < |
| - | | \ \ \ \ \ \ **SerialNumber** | string | + | | < |
| - | | \ \ \ \ \ \ **SparePartNumber** | string | + | | < |
| - | | \ \ \ \ \ \ **Status** {} | object | + | | < |
| - | | \ \ \ \ \ \ **UpperThresholdCritical** | number | + | | < |
| - | | \ \ \ \ \ \ **UpperThresholdFatal** | number | + | | < |
| - | | \ \ \ \ \ \ **UpperThresholdNonCritical** | number | + | | < |
| - | | } ] | | | | + | | < |
| - | | **Id** | string | | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | < |
| - | | **Name** | string | + | | < |
| - | | **Oem** {} | object | + | | } ] | |
| - | | **Redundancy** [ { | array | | read-write | This structure is used to show redundancy for fans. The Component ids will reference the members of the redundancy groups. | | + | | **[email protected]** | string\\ \\ *read-write* |
| - | | \ \ \ \ \ \ **MaxNumSupported** | number | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **MemberId** | string | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | \ \ \ \ \ \ **MinNumNeeded** | number | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | \ \ \ \ \ \ **Mode** | 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. | |
| - | | \ \ \ \ \ \ **Name** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **RedundancySet** [ {} ] | array | | read-only | Contains any ids that represent components of this redundancy set. | | + | | < |
| - | | \ \ \ \ \ \ **Status** {} | object | + | | < |
| - | | \ \ \ \ \ \ **MemberId** | string | + | | < |
| - | | \ \ \ \ \ \ **RedundancyEnabled** | boolean | + | | < |
| - | | } ] | | | | + | | < |
| - | | **Status** { | object | + | | < |
| - | | \ \ \ \ \ \ **Health** | string | + | | < |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **State** | string | + | | } ] | | | |
| - | | } | | | | + | | **[email protected]** | string\\ \\ *read-write* |
| - | | **Temperatures** [ { | array | | read-write | This is the definition for temperature sensors. | | + | | **Status** { | object\\ \\ *read-only* | Indicates the status of the file share. | |
| - | | \ \ \ \ \ \ **LowerThresholdCritical** | number | + | | < |
| - | | \ \ \ \ \ \ **LowerThresholdFatal** | number | + | | < |
| - | | \ \ \ \ \ \ **LowerThresholdNonCritical** | number | Yes | read-only | Below normal range.\\ unit: Cel | | + | | < |
| - | | \ \ \ \ \ \ **MaxReadingRangeTemp** | number | + | | < |
| - | | \ \ \ \ \ \ **MemberId** | string | + | | } | |
| - | | \ \ \ \ \ \ **MinReadingRangeTemp** | number | Yes | read-only | Minimum value for ReadingCelsius.\\ unit: Cel | | + | | **Temperatures** [ { | array\\ \\ *read-write* | This is the definition for temperature sensors. | |
| - | | \ \ \ \ \ \ **Name** | string | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | \ \ \ \ \ \ **PhysicalContext** | string | + | | < |
| - | | \ \ \ \ \ \ **ReadingCelsius** | number | + | | < |
| - | | \ \ \ \ \ \ **RelatedItem** [ {} ] | array | | read-only | Describes the areas or devices to which this temperature measurement applies. | | + | | < |
| - | | \ \ \ \ \ \ **SensorNumber** | number | + | | < |
| - | | \ \ \ \ \ \ **Status** {} | object | + | | < |
| - | | \ \ \ \ \ \ **UpperThresholdCritical** | number | + | | < |
| - | | \ \ \ \ \ \ **UpperThresholdFatal** | number | + | | < |
| - | | \ \ \ \ \ \ **UpperThresholdNonCritical** | number | + | | < |
| - | | } ] | | | | + | | < |
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } ] | | | | ||
| + | | **[email protected]** | string\\ \\ *read-write* | ||
| - | === Property Details === | + | ===== Property Details |
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == IndicatorLED == | + | ==== IndicatorLED: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Blinking | The Indicator LED is blinking. | | | Blinking | The Indicator LED is blinking. | | ||
| | Lit | The Indicator LED is lit. | | | Lit | The Indicator LED is lit. | | ||
| | Off | The Indicator LED is off. | | | Off | The Indicator LED is off. | | ||
| - | == Mode == | + | ==== Mode: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Failover | Failure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set. | | | Failover | Failure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set. | | ||
| | N+m | Multiple units are available and active such that normal operation will continue if one or more units fail. | | | N+m | Multiple units are available and active such that normal operation will continue if one or more units fail. | | ||
| Line 5142: | Line 5857: | ||
| | Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. | | | Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. | | ||
| - | == PhysicalContext == | + | ==== PhysicalContext: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Back | The back of the chassis | | | Back | The back of the chassis | | ||
| | Backplane | A backplane within the chassis | | | Backplane | A backplane within the chassis | | ||
| Line 5166: | Line 5882: | ||
| | VoltageRegulator | A voltage regulator device | | | VoltageRegulator | A voltage regulator device | | ||
| - | == ReadingUnits == | + | ==== ReadingUnits: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Percent | Indicates that the fan reading and thresholds are measured in percentage. | | | Percent | Indicates that the fan reading and thresholds are measured in percentage. | | ||
| | RPM | Indicates that the fan reading and thresholds are measured in rotations per minute. | | | RPM | Indicates that the fan reading and thresholds are measured in rotations per minute. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 5188: | Line 5906: | ||
| - | ===== UpdateService ===== | + | ====== UpdateService |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Actions** { | object | + | | --- | --- | --- | |
| - | | \ \ \ \ \ \ **# | + | | **Actions** { | object\\ \\ *read-write* | The Actions object contains the available custom actions on this resource. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **Description** | string | + | | } | |
| - | | **FirmwareInventory** | object | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **HttpPushUri** | string | | read-only | The URI used to perform an HTTP or HTTPS push update to the Update Service.\\ format: uri | | + | | **FirmwareInventory** |
| - | | **Id** | string | + | | < |
| - | | **Name** | string | + | | < |
| - | | **Oem** {} | object | + | | < |
| - | | **ServiceEnabled** | boolean | + | | < |
| - | | **SoftwareInventory** | object | + | | < |
| - | | **Status** { | object | Yes | read-only | Indicates the status of the file share. | | + | | } | |
| - | | \ \ \ \ \ \ **Health** | string | + | | **HttpPushUri** *(v1.1+)* | string\\ \\ *read-only* |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | \ \ \ \ \ \ **State** | string | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | } | | | | + | | **ServiceEnabled** | boolean, null\\ \\ *read-write* | This indicates whether this service is enabled. | |
| + | | **SoftwareInventory** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **Status** { | object, null\\ \\ *read-only* | Indicates the status of the file share. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 5244: | Line 5978: | ||
| - | ===== VLanNetworkInterface ===== | + | ====== VLanNetworkInterface |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Description** | string | + | | --- | --- | --- | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Name** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **VLANEnable** | boolean | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | **VLANId** | number | + | | **VLANEnable** | boolean, null\\ \\ *read-write* | This indicates if this VLAN is enabled. | |
| + | | **VLANId** | number, null\\ \\ *read-write* | This indicates the VLAN identifier for this VLAN. | | ||
| - | ===== VLanNetworkInterfaceCollection | + | ====== |
| - | + | ||
| - | A Collection of VLanNetworkInterface resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== VirtualMedia | + | |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **ConnectedVia** | string | + | | --- | --- | --- | |
| - | | **Description** | string | + | | **ConnectedVia** | string, null\\ \\ *read-write* | Current virtual media connection methods. |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Image** | string | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | **ImageName** | string | + | | **Image** | string, null\\ \\ *read-only* | A URI providing the location of the selected image. | |
| - | | **Inserted** | boolean | + | | **ImageName** | string, null\\ \\ *read-only* | The current image name. | |
| - | | **MediaTypes** [ {} ] | array | | read-only | This is the media types supported as virtual media. | | + | | **Inserted** | boolean, null\\ \\ *read-only* | Indicates if virtual media is inserted in the virtual device. | |
| - | | **Name** | string | + | | **MediaTypes** [ {} ] | array\\ \\ *read-only* | This is the media types supported as virtual media. | |
| - | | **Oem** {} | object | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | **WriteProtected** | boolean | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| + | | **WriteProtected** | boolean, null\\ \\ *read-only* | Indicates the media is write protected. | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == ConnectedVia == | + | ==== ConnectedVia: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Applet | Connected to a client application. | | | Applet | Connected to a client application. | | ||
| | NotConnected | No current connection. | | | NotConnected | No current connection. | | ||
| Line 5293: | Line 6020: | ||
| - | ===== VirtualMediaCollection | + | ====== |
| - | + | ||
| - | A Collection of VirtualMedia resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== Volume | + | |
| 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 ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **AccessCapabilities** [ {} ] | array | | read-write | Supported IO access capabilities. | | + | | --- | --- | --- | |
| - | | **Actions** { | object | + | | **AccessCapabilities** *(v1.1+)* [ {} ] | array\\ \\ *read-write* | Supported IO access capabilities. | |
| - | | \ \ \ \ \ \ **# | + | | **Actions** { | object\\ \\ *read-only* | The available actions for this resource. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **AllocatedPools** | + | | } | |
| - | | **BlockSizeBytes** | number | Yes | read-only | The size of the smallest addressable unit (Block) of this volume in bytes\\ unit: By | | + | | **AllocatedPools** |
| - | | **Capacity** { | object | + | | < |
| - | | \ \ \ \ \ \ **Data** {} | object | + | | < |
| - | | \ \ \ \ \ \ **IsThinProvisioned** | boolean | + | | < |
| - | | \ \ \ \ \ \ **Metadata** {} | object | + | | < |
| - | | \ \ \ \ \ \ **Snapshot** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **CapacityBytes** | number | + | | < |
| - | | **CapacitySources** [ { | array | | read-write | An array of space allocations to this volume. | | + | | < |
| - | | \ \ \ \ \ \ **ProvidedCapacity** {} | object | + | | < |
| - | | \ \ \ \ \ \ **ProvidedClassOfService** {} | object | + | | < |
| - | | \ \ \ \ \ \ **ProvidingDrives** {} | object | + | | < |
| - | | \ \ \ \ \ \ **ProvidingPools** {} | object | + | | < |
| - | | \ \ \ \ \ \ **ProvidingVolumes** {} | object | + | | < |
| - | | } ] | | | | + | | < |
| - | | **Description** | string | + | | } ] | |
| - | | **Encrypted** | boolean | + | | **[email protected]** *(v1.1+)* | string\\ \\ *read-write* | | |
| - | | **EncryptionTypes** [ {} ] | array | | read-write | The types of encryption used by this Volume | | + | | **BlockSizeBytes** | number, null\\ (By)\\ \\ *read-only* |
| - | | **Id** | string | + | | **Capacity** *(v1.1+)* { | object, null\\ \\ *read-write* | Capacity utilization. | |
| - | | **Identifiers** [ { | array | | read-only | The Durable names for the volume | | + | | < |
| - | | \ \ \ \ \ \ **DurableName** | string | + | | < |
| - | | \ \ \ \ \ \ **DurableNameFormat** | string | + | | < |
| - | | } ] | | | | + | | < |
| - | | **Links** { | object | + | | } | |
| - | | \ \ \ \ \ \ **ClassOfService** {} | object | + | | **CapacityBytes** | number, null\\ (By)\\ \\ *read-only* | The size in bytes of this Volume | |
| - | | \ \ \ \ \ \ **Drives** [ {} ] | array | | read-only | An array of references to the drives which contain this volume. This will reference Drives that either wholly or only partly contain this volume. | | + | | **CapacitySources** *(v1.1+)* [ { | array\\ \\ *read-write* | An array of space allocations to this volume. | |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **LowSpaceWarningThresholdPercents** [ {} ] | array | | read-write | Low space warning. | | + | | < |
| - | | **Manufacturer** | string | + | | < |
| - | | **MaxBlockSizeBytes** | number | + | | < |
| - | | **Model** | string | + | | } ] | |
| - | | **Name** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Oem** {} | object | + | | **Encrypted** | boolean, null\\ \\ *read-write* | Is this Volume encrypted | |
| - | | **Operations** [ { | array | | read-only | The operations currently running on the Volume | | + | | **EncryptionTypes** [ {} ] | array\\ \\ *read-write* | The types of encryption used by this Volume | |
| - | | \ \ \ \ \ \ **AssociatedTask** {} | object | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **OperationName** | string | + | | **Identifiers** [ { | array\\ \\ *read-only* | The Durable names for the volume | |
| - | | \ \ \ \ \ \ **PercentageComplete** | number | + | | < |
| - | | } ] | | | | + | | < |
| - | | **OptimumIOSizeBytes** | number | + | | } ] | |
| - | | **ReplicaInfos** [ { | array | | read-only | Describes this storage volume in its role as a source and/or target replica. | | + | | **Links** { | object\\ \\ *read-only* | Contains references to other resources that are related to this resource. | |
| - | | \ \ \ \ \ \ **ConsistencyEnabled** | boolean | + | | < |
| - | | \ \ \ \ \ \ **ConsistencyState** | string | + | | < |
| - | | \ \ \ \ \ \ **ConsistencyStatus** | string | + | | < |
| - | | \ \ \ \ \ \ **ConsistencyType** | string | + | | < |
| - | | \ \ \ \ \ \ **FailedCopyStopsHostIO** | boolean | + | | } | |
| - | | \ \ \ \ \ \ **PercentSynced** | number | + | | **LowSpaceWarningThresholdPercents** *(v1.1+)* [ {} ] | array\\ \\ *read-write* | Low space warning. | |
| - | | \ \ \ \ \ \ **Replica** | | Yes | read-write | The resource that is the source of this replica. | | + | | **Manufacturer** *(v1.1+)* | string, null\\ \\ *read-only* | The manufacturer or OEM of this storage volume. | |
| - | | \ \ \ \ \ \ **ReplicaPriority** | string | + | | **MaxBlockSizeBytes** *(v1.1+)* | number, null\\ (By)\\ \\ *read-only* | Max Block size in bytes . | |
| - | | \ \ \ \ \ \ **ReplicaProgressStatus** | string | + | | **Model** *(v1.1+)* | string, null\\ \\ *read-only* | The model number for this storage volume | |
| - | | \ \ \ \ \ \ **ReplicaReadOnlyAccess** | string | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | \ \ \ \ \ \ **ReplicaRecoveryMode** | string | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | \ \ \ \ \ \ **ReplicaRole** | string | + | | **Operations** [ { | array\\ \\ *read-only* | The operations currently running on the Volume | |
| - | | \ \ \ \ \ \ **ReplicaSkewBytes** | number | + | | < |
| - | | \ \ \ \ \ \ **ReplicaState** | string | + | | < |
| - | | \ \ \ \ \ \ **ReplicaType** | string | + | | < |
| - | | \ \ \ \ \ \ **ReplicaUpdateMode** | string | + | | } ] | |
| - | | \ \ \ \ \ \ **RequestedReplicaState** | string | + | | **OptimumIOSizeBytes** | number, null\\ (By)\\ \\ *read-only* | The size in bytes of this Volume' |
| - | | \ \ \ \ \ \ **SyncMaintained** | boolean | + | | **ReplicaInfos** *(v1.1+)* [ { | array\\ \\ *read-only* | Describes this storage volume in its role as a source and/or target replica. | |
| - | | \ \ \ \ \ \ **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** | + | | < |
| - | | **VolumeType** | string | Yes | read-write | The type of this volume\\ //See Property Details, below, for more information about this property.// | | + | | < |
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } ] | | ||
| + | | **Status** { | object\\ \\ *read-only* | Indicates the status of the file share. | | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| + | | **StorageGroups** | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | < | ||
| + | | } ] | | ||
| + | | **[email protected]** *(v1.1+)* | string\\ \\ *read-write* | | | ||
| + | | **VolumeType** | string, null\\ \\ *read-write* | The type of this volume *See Property Details, below, for more information about this property.* | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == ConsistencyState == | + | ==== ConsistencyState: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Consistent | Consistent. | | | Consistent | Consistent. | | ||
| | Inconsistent | Not consistent. | | | Inconsistent | Not consistent. | | ||
| - | == ConsistencyStatus == | + | ==== ConsistencyStatus: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Consistent | Consistent. | | | Consistent | Consistent. | | ||
| | Disabled | Consistency disabled. | | | Disabled | Consistency disabled. | | ||
| Line 5406: | Line 6160: | ||
| | InProgress | Becoming consistent. | | | InProgress | Becoming consistent. | | ||
| - | == ConsistencyType == | + | ==== ConsistencyType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | SequentiallyConsistent | Sequentially consistent. | | | SequentiallyConsistent | Sequentially consistent. | | ||
| - | == DurableNameFormat == | + | ==== DurableNameFormat: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | EUI | IEEE-defined 64-bit Extended Unique Identifier | | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
| | FC_WWN | Fibre Channel World Wide Name | | | FC_WWN | Fibre Channel World Wide Name | | ||
| Line 5420: | Line 6176: | ||
| | iQN | iSCSI Qualified Name | | | iQN | iSCSI Qualified Name | | ||
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == ReplicaPriority == | + | ==== ReplicaPriority: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | High | Copy engine I/O has higher priority than host I/O. | | | High | Copy engine I/O has higher priority than host I/O. | | ||
| | Low | Copy engine I/O lower priority than host I/O. | | | Low | Copy engine I/O lower priority than host I/O. | | ||
| Line 5442: | Line 6201: | ||
| | Urgent | Copy operation to be performed as soon as possible, regardless of the host I/O requests. | | | Urgent | Copy operation to be performed as soon as possible, regardless of the host I/O requests. | | ||
| - | == ReplicaProgressStatus == | + | ==== ReplicaProgressStatus: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Aborting | Abort in progress. | | | Aborting | Abort in progress. | | ||
| | Completed | The request is completed. Data flow is idle. | | | Completed | The request is completed. Data flow is idle. | | ||
| Line 5469: | Line 6229: | ||
| | Terminating | The relationship is in the process of terminating. | | | Terminating | The relationship is in the process of terminating. | | ||
| - | == ReplicaReadOnlyAccess == | + | ==== ReplicaReadOnlyAccess: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Both | Both the source and the target elements are read only to the host. | | | Both | Both the source and the target elements are read only to the host. | | ||
| | ReplicaElement | The replica element. | | ReplicaElement | The replica element. | ||
| | SourceElement | The source element. | | | SourceElement | The source element. | | ||
| - | == ReplicaRecoveryMode == | + | ==== ReplicaRecoveryMode: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Automatic | Copy operation resumes automatically. | | | Automatic | Copy operation resumes automatically. | | ||
| | Manual | ReplicaState is set to Suspended after the link is restored. It is required to issue the Resume operation to continue. | | | Manual | ReplicaState is set to Suspended after the link is restored. It is required to issue the Resume operation to continue. | | ||
| - | == ReplicaRole == | + | ==== ReplicaRole: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Source | The source element. | | | Source | The source element. | | ||
| | Target | The target element. | | Target | The target element. | ||
| - | == ReplicaState == | + | ==== ReplicaState: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Aborted | The copy operation is aborted with the Abort operation. Use the Resync Replica operation to restart the copy operation. | | Aborted | The copy operation is aborted with the Abort operation. Use the Resync Replica operation to restart the copy operation. | ||
| | Broken | The relationship is non-functional due to errors in the source, the target, the path between the two or space constraints. | | Broken | The relationship is non-functional due to errors in the source, the target, the path between the two or space constraints. | ||
| Line 5508: | Line 6272: | ||
| | Unsynchronized | Not all the source element data has been copied to the target element. | | Unsynchronized | Not all the source element data has been copied to the target element. | ||
| - | == ReplicaType == | + | ==== ReplicaType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Clone | Create a point in time, full copy the source. | | | Clone | Create a point in time, full copy the source. | | ||
| | Mirror | Create and maintain a copy of the source. | | | Mirror | Create and maintain a copy of the source. | | ||
| Line 5516: | Line 6281: | ||
| | TokenizedClone | Create a token based clone. | | | TokenizedClone | Create a token based clone. | | ||
| - | == ReplicaUpdateMode == | + | ==== ReplicaUpdateMode: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Active | Active-Active (i.e. bidirectional) synchronous updates. | | | Active | Active-Active (i.e. bidirectional) synchronous updates. | | ||
| | Adaptive | Allows implementation to switch between synchronous and asynchronous modes. | | | Adaptive | Allows implementation to switch between synchronous and asynchronous modes. | | ||
| Line 5524: | Line 6290: | ||
| | Synchronous | Synchronous updates. | | | Synchronous | Synchronous updates. | | ||
| - | == RequestedReplicaState == | + | ==== RequestedReplicaState: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Aborted | The copy operation is aborted with the Abort operation. Use the Resync Replica operation to restart the copy operation. | | Aborted | The copy operation is aborted with the Abort operation. Use the Resync Replica operation to restart the copy operation. | ||
| | Broken | The relationship is non-functional due to errors in the source, the target, the path between the two or space constraints. | | Broken | The relationship is non-functional due to errors in the source, the target, the path between the two or space constraints. | ||
| Line 5544: | Line 6311: | ||
| | Unsynchronized | Not all the source element data has been copied to the target element. | | Unsynchronized | Not all the source element data has been copied to the target element. | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 5559: | Line 6327: | ||
| | Updating | The element is updating and may be unavailable or degraded. | | | Updating | The element is updating and may be unavailable or degraded. | | ||
| - | == UndiscoveredElement == | + | ==== UndiscoveredElement: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | ReplicaElement | The replica element is undiscovered. | | | ReplicaElement | The replica element is undiscovered. | | ||
| | SourceElement | The source element is undiscovered. | | | SourceElement | The source element is undiscovered. | | ||
| - | == VolumeType == | + | ==== VolumeType: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Mirrored | The volume is a mirrored device | | | Mirrored | The volume is a mirrored device | | ||
| | NonRedundant | The volume is a non-redundant storage device | | | NonRedundant | The volume is a non-redundant storage device | | ||
| Line 5576: | Line 6346: | ||
| - | ===== VolumeCollection | + | ====== |
| - | + | ||
| - | A Collection of Volume resource instances. | + | |
| - | + | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | |
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | + | |
| - | | **Members** | array(reference([[documentation: | + | |
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | + | |
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | + | |
| - | + | ||
| - | ===== Zone ===== | + | |
| Switch contains properties describing a simple fabric zone. | Switch contains properties describing a simple fabric zone. | ||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | + | | |
| - | | **Description** | string | + | | --- | --- | --- | |
| - | | **Id** | string | + | | **Description** | string, null\\ \\ *read-write* | Provides a description of this resource and is used for commonality |
| - | | **Links** { | object | + | | **Id** | string\\ \\ *read-write* | Uniquely identifies the resource within the collection of like resources. | |
| - | | \ \ \ \ \ \ **Endpoints** [ {} ] | array | | read-only | An array of references to the endpoints that are contained in this zone. | | + | | **Links** { | object\\ \\ *read-write* | Contains references to other resources that are related to this resource. | |
| - | | \ \ \ \ \ \ **InvolvedSwitches** [ {} ] | array | | read-only | An array of references to the switchs that are utilized in this zone. | | + | | < |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | < |
| - | | } | | | | + | | < |
| - | | **Name** | string | + | | < |
| - | | **Oem** {} | object | + | | < |
| - | | **Status** { | object | + | | } | |
| - | | \ \ \ \ \ \ **Health** | string | + | | **Name** | string\\ \\ *read-write* | A friendly name for this line of service. | |
| - | | \ \ \ \ \ \ **HealthRollup** | string | + | | **Oem** {} | object\\ \\ *read-write* | This is the manufacturer/ |
| - | | \ \ \ \ \ \ **Oem** {} | object | + | | **Status** { | object\\ \\ *read-only* | Indicates the status of the file share. | |
| - | | \ \ \ \ \ \ **State** | string | + | | < |
| - | | } | | | | + | | < |
| + | | < | ||
| + | | < | ||
| + | | } | | ||
| - | === Property Details === | + | ===== Property Details |
| - | == Health == | + | ==== Health: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == HealthRollup == | + | ==== HealthRollup: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Critical | A critical condition exists that requires immediate attention. | | | Critical | A critical condition exists that requires immediate attention. | | ||
| | OK | Normal. | | | OK | Normal. | | ||
| | Warning | A condition exists that requires attention. | | | Warning | A condition exists that requires attention. | | ||
| - | == State == | + | ==== State: ==== |
| - | ^ string | + | | string |
| + | | --- | --- | | ||
| | Absent | This function or resource is not present or not detected. | | | Absent | This function or resource is not present or not detected. | | ||
| | Deferring | The element will not process any commands but will queue new requests. | | | Deferring | The element will not process any commands but will queue new requests. | | ||
| Line 5637: | Line 6403: | ||
| | UnavailableOffline | This function or resource is present but cannot be used. | | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
| | Updating | The element is updating and may be unavailable or degraded. | | | Updating | The element is updating and may be unavailable or degraded. | | ||
| - | |||
| - | |||
| - | ===== ZoneCollection ===== | ||
| - | |||
| - | A Collection of Zone resource instances. | ||
| - | |||
| - | ^ Property ^ Type ^ Nullable ^ Permission ^ Description ^ | ||
| - | | **Description** | string | Yes | read-write | Provides a description of this resource and is used for commonality | ||
| - | | **Members** | array(reference([[documentation: | ||
| - | | **Name** | string | | read-write | A friendly name for this line of service. | | ||
| - | | **Oem** {} | object | | read-write | This is the manufacturer/ | ||