meta data for this page
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
| documentation:redfish_api:schema_definition [2017/04/24 13:27] – bil | documentation:redfish_api:schema_definition [2017/04/27 12:26] – bil | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | |||
| ====== Schema Definition ====== | ====== Schema Definition ====== | ||
| + | |||
| ===== AccountService ===== | ===== AccountService ===== | ||
| Line 5: | Line 7: | ||
| Account Service contains properties common to all user accounts, such as password requirements, | Account Service contains properties common to all user accounts, such as password requirements, | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AccountLockoutCounterResetAfter** | number | read-write | The interval of time in seconds since the last failed login attempt at which point the lockout threshold counter for the account is reset to zero. Must be less than or equal to AccountLockoutDuration.\\ unit: s | | + | | **AccountLockoutCounterResetAfter** | number |
| - | | **AccountLockoutDuration** | number, null | read-write | The time in seconds an account is locked after the account lockout threshold is met. Must be >= AccountLockoutResetAfter. If set to 0, no lockout will occur.\\ unit: s | | + | | **AccountLockoutDuration** | number |
| - | | **AccountLockoutThreshold** | number, null | read-write | The number of failed login attempts before a user account is locked for a specified duration (0=never locked). | | + | | **AccountLockoutThreshold** | number |
| - | | **[[documentation: | + | | **Accounts** | reference([[documentation: |
| - | | **AuthFailureLoggingThreshold** | number | read-write | This is the number of authorization failures that need to occur before the failure attempt is logged to the manager log. | | + | | **AuthFailureLoggingThreshold** | number |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **MaxPasswordLength** | number | read-only | This is the maximum password length for this service. | | + | | **MaxPasswordLength** | number |
| - | | **MinPasswordLength** | number | read-only | This is the minimum password length for this service. | | + | | **MinPasswordLength** | number |
| - | | **Name** | string | read-write | The name of the resource or array element. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **[[documentation: | + | | **PrivilegeMap** | reference([[documentation: |
| - | | **[[documentation: | + | | **Roles** | reference([[documentation: |
| - | | **ServiceEnabled** | boolean, null | read-write | This indicates whether this service is enabled. | | + | | **ServiceEnabled** | boolean |
| - | | **Status** { | object | read-only | | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| === Property Details === | === Property Details === | ||
| Line 63: | Line 65: | ||
| ActionInfo describes the parameters and other information necessary to perform a Redfish Action to a particular Action target. | ActionInfo describes the parameters and other information necessary to perform a Redfish Action to a particular Action target. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Name** | string | read-write | The name of the resource or array element. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Parameters** [ {} ] | array | read-write | The parameters associated with the specified Redfish Action. | | + | | **Parameters** [ { | array | |
| + | | \ \ \ \ \ \ **AllowableValues** [ {} ] | array | | read-only | A list of values for this parameter supported by this Action target. | | ||
| + | | \ \ \ \ \ \ **DataType** | string | Yes | read-write | The JSON property type used for this parameter.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **Name** | string | | read-only | The name of the parameter for this Action. | | ||
| + | | \ \ \ \ \ \ **ObjectDataType** | string | Yes | read-only | The OData Type of an object-based parameter. | | ||
| + | | \ \ \ \ \ \ **Required** | boolean | | read-only | Indicates whether the parameter is required to perform this Action. | | ||
| + | | } ] | | | ||
| === Property Details === | === Property Details === | ||
| Line 88: | Line 96: | ||
| An Attribute Registry is a set of key-value pairs which are specific to a particular implementation or product, such that creating standardized property names would be impractical. | An Attribute Registry is a set of key-value pairs which are specific to a particular implementation or product, such that creating standardized property names would be impractical. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Language** | string | read-only | This is the RFC 5646 compliant language code for the registry. | | + | | **Language** | string |
| - | | **Name** | string | read-write | The name of the resource or array element. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **OwningEntity** | string | read-only | This is the organization or company that publishes this registry. | | + | | **OwningEntity** | string |
| - | | **RegistryEntries** { | object | read-write | List of all attributes and their metadata for this component. | | + | | **RegistryEntries** { | object |
| - | | < | + | | \ \ \ \ \ \ **Attributes** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Dependencies** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Menus** [ {} ] | array | |
| - | | } | | + | | } | | | |
| - | | **RegistryVersion** | string | read-only | This is the attribute registry version which is used in the middle portion of a AttributeRegistry. | | + | | **RegistryVersion** | string |
| - | | **SupportedSystems** [ {} ] | array | read-write | Array of systems supported by this attribute registry. | | + | | **SupportedSystems** [ { | array | |
| + | | \ \ \ \ \ \ **ProductName** | string | Yes | read-only | Firmware version. | | ||
| + | | \ \ \ \ \ \ **SystemId** | string | Yes | read-only | The system ID of the system.\\ pattern: %%^%%[A-Za-z0-9]+$ | | ||
| + | | } ] | | | ||
| ===== Bios ===== | ===== Bios ===== | ||
| Line 107: | Line 118: | ||
| Bios contains properties surrounding a BIOS Attribute Registry (where the system-specific BIOS attributes are described) and the Actions needed to perform changes to BIOS settings, which typically require a system reset to apply. | Bios contains properties surrounding a BIOS Attribute Registry (where the system-specific BIOS attributes are described) and the Actions needed to perform changes to BIOS settings, which typically require a system reset to apply. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **AttributeRegistry** | string, null | read-only | The Resource ID of the Attribute Registry for the BIOS Attributes resource. | | + | | **AttributeRegistry** | string |
| - | | **Attributes** {} | object | read-write | This is the manufacturer/ | + | | **Attributes** {} | object |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Name** | string | read-write | The name of the resource or array element. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== Chassis ===== | ===== Chassis ===== | ||
| Line 124: | Line 135: | ||
| A Chassis represents the physical components for any system. | A Chassis represents the physical components for any system. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **AssetTag** | string, null | read-write | The user assigned asset tag for this chassis. | | + | | **AssetTag** | string |
| - | | **ChassisType** | string | read-write | This property indicates the type of physical form factor of this resource.\\ | + | | **ChassisType** | string |
| - | | **DepthMm** | number, null | read-only | The depth of the chassis.\\ unit: mm | | + | | **DepthMm** | number |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **HeightMm** | number, null | read-only | The height of the chassis.\\ unit: mm | | + | | **HeightMm** | number |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **IndicatorLED** | string, null | read-write | The state of the indicator LED, used to identify the chassis.\\ | + | | **IndicatorLED** | string |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **ComputerSystems** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **ContainedBy** |
| - | | < | + | | \ \ \ \ \ \ **Contains** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **CooledBy** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Drives** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **ManagedBy** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **ManagersInChassis** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **PCIeDevices** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **PoweredBy** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Storage** [ {} ] | array | |
| - | | } | | + | | } | | | |
| - | | **Location** { | object | read-only | | | + | | **Location** { | object |
| - | | < | + | | \ \ \ \ \ \ **Info** | string |
| - | | < | + | | \ \ \ \ \ \ **InfoFormat** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **[[documentation: | + | | **LogServices** | reference([[documentation: |
| - | | **Manufacturer** | string, null | read-only | This is the manufacturer of this chassis. | | + | | **Manufacturer** | string |
| - | | **Model** | string, null | read-only | This is the model number for the chassis. | | + | | **Model** | string |
| - | | **Name** | string | read-write | The name of the resource or array element. | | + | | **Name** | string |
| - | | **[[documentation: | + | | **NetworkAdapters** | reference([[documentation: |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **PartNumber** | string, null | read-only | The part number for this chassis. | | + | | **PartNumber** | string |
| - | | **PhysicalSecurity** { | object | read-write | The state of the physical security sensor. | | + | | **PhysicalSecurity** { | object |
| - | | < | + | | \ \ \ \ \ \ **IntrusionSensor** | string |
| - | | < | + | | \ \ \ \ \ \ **IntrusionSensorNumber** | number |
| - | | < | + | | \ \ \ \ \ \ **IntrusionSensorReArm** | string |
| - | | } | | + | | } | | | |
| - | | **[[documentation: | + | | **Power** | reference([[documentation: |
| - | | **PowerState** | string, null | read-write | This is the current power state of the chassis.\\ | + | | **PowerState** | string |
| - | | **SKU** | string, null | read-only | This is the SKU for this chassis. | | + | | **SKU** | string |
| - | | **SerialNumber** | string, null | read-only | The serial number for this chassis. | | + | | **SerialNumber** | string |
| - | | **Status** { | object | read-only | | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| - | | **[[documentation: | + | | **Thermal** | reference([[documentation: |
| - | | **WeightKg** | number, null | read-only | The weight of the chassis.\\ unit: kg | | + | | **WeightKg** | number |
| - | | **WidthMm** | number, null | read-only | The width of the chassis.\\ unit: mm | | + | | **WidthMm** | number |
| === Property Details === | === Property Details === | ||
| Line 269: | Line 280: | ||
| A Collection of Chassis resource instances. | A Collection of Chassis resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | The name of the resource or array element. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== ClassOfService ===== | ===== ClassOfService ===== | ||
| Line 279: | Line 290: | ||
| A service option composed of one or more service options. | A service option composed of one or more service options. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **ClassOfServiceVersion** | string, null | read-write | The value identifies the current version of this class of service definition. | | + | | **ClassOfServiceVersion** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Identifier** { | object, null | read-only | The value identifies this resource. | | + | | **Identifier** { | object |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | } | | + | | } | | | |
| - | | **LinesOfService** { | object, null | read-write | Lines of Service that define the required choices of utility or warranty. | | + | | **LinesOfService** { | object |
| - | | < | + | | \ \ \ \ \ \ **DataProtectionLinesOfService** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **DataSecurityLinesOfService** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **DataStorageLinesOfService** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **IOConnectivityLinesOfService** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **IOPerformanceLinesOfService** [ {} ] | array | |
| - | | } | | + | | } | | | |
| - | | **Name** | string | read-write | The name of the resource or array element. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| === Property Details === | === Property Details === | ||
| Line 313: | Line 324: | ||
| A Collection of ClassOfService resource instances. | A Collection of ClassOfService resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | The value of each member references a ClassOfService resource. | | + | | **Members** |
| - | | **Name** | string | read-write | The name of the resource or array element. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== ComputerSystem ===== | ===== ComputerSystem ===== | ||
| Line 323: | Line 334: | ||
| This schema defines a computer system and its respective properties. | This schema defines a computer system and its respective properties. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **AssetTag** | string, null | read-write | The user definable tag that can be used to track this computer system for inventory or other client purposes. | | + | | **AssetTag** | string |
| - | | **[[documentation: | + | | **Bios** | reference([[documentation: |
| - | | **BiosVersion** | string, null | read-only | The version of the system BIOS or primary system firmware. | | + | | **BiosVersion** | string |
| - | | **Boot** { | object | read-write | Information about the boot settings for this system. | | + | | **Boot** { | object |
| - | | < | + | | \ \ \ \ \ \ **BootSourceOverrideEnabled** | string |
| - | | < | + | | \ \ \ \ \ \ **BootSourceOverrideMode** | string |
| - | | < | + | | \ \ \ \ \ \ **BootSourceOverrideTarget** | string |
| - | | < | + | | \ \ \ \ \ \ **UefiTargetBootSourceOverride** | string |
| - | | } | | + | | } | | | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **[[documentation: | + | | **EthernetInterfaces** | reference([[documentation: |
| - | | **HostName** | string, null | read-write | The DNS Host Name, without any domain information. | | + | | **HostName** | string |
| - | | **HostedServices** { | object | read-write | The services that this computer system supports. | | + | | **HostedServices** { | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **StorageServices** |
| - | | } | | + | | } | | | |
| - | | **HostingRoles** [ {} ] | array | read-only | The hosing roles that this computer system supports. | | + | | **HostingRoles** [ {} ] | array | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **IndicatorLED** | string, null | read-write | The state of the indicator LED, used to identify the system.\\ | + | | **IndicatorLED** | string |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Chassis** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **CooledBy** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Endpoints** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **ManagedBy** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **PoweredBy** [ {} ] | array | |
| - | | } | | + | | } | | | |
| - | | **[[documentation: | + | | **LogServices** | reference([[documentation: |
| - | | **Manufacturer** | string, null | read-only | The manufacturer or OEM of this system. | | + | | **Manufacturer** | string |
| - | | **[[documentation: | + | | **Memory** | reference([[documentation: |
| - | | **[[documentation: | + | | **MemoryDomains** | object | Yes | read-write | A reference to the collection of Memory Domains associated with this system. | |
| - | | **MemorySummary** { | object | read-write | This object describes the central memory of the system in general detail. | | + | | **MemorySummary** { | object |
| - | | < | + | | \ \ \ \ \ \ **MemoryMirroring** | string |
| - | | < | + | | \ \ \ \ \ \ **Status** {} | object |
| - | | < | + | | \ \ \ \ \ \ **TotalSystemMemoryGiB** | number |
| - | | } | | + | | } | | | |
| - | | **Model** | string, null | read-only | The model number for this system. | | + | | **Model** | string |
| - | | **Name** | string | read-write | The name of the resource or array element. | | + | | **Name** | string |
| - | | **[[documentation: | + | | **NetworkInterfaces** | reference([[documentation: |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **PCIeDevices** [ {} ] | array | read-only | A reference to a collection of PCIe Devices used by this computer system. | | + | | **PCIeDevices** |
| - | | **PCIeFunctions** [ {} ] | array | read-only | A reference to a collection of PCIe Functions used by this computer system. | | + | | **PCIeFunctions** |
| - | | **PartNumber** | string, null | read-only | The part number for this system. | | + | | **PartNumber** | string |
| - | | **PowerState** | string, null | read-write | This is the current power state of the system.\\ | + | | **PowerState** | string |
| - | | **ProcessorSummary** { | object | read-write | This object describes the central processors of the system in general detail. | | + | | **ProcessorSummary** { | object |
| - | | < | + | | \ \ \ \ \ \ **Count** | number |
| - | | < | + | | \ \ \ \ \ \ **Model** | string |
| - | | < | + | | \ \ \ \ \ \ **Status** {} | object |
| - | | } | | + | | } | | | |
| - | | **[[documentation: | + | | **Processors** | reference([[documentation: |
| - | | **SKU** | string, null | read-only | The manufacturer SKU for this system. | | + | | **SKU** | string |
| - | | **[[documentation: | + | | **SecureBoot** | reference([[documentation: |
| - | | **SerialNumber** | string, null | read-only | The serial number for this system. | | + | | **SerialNumber** | string |
| - | | **[[documentation: | + | | **SimpleStorage** | reference([[documentation: |
| - | | **Status** { | object | read-only | | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| - | | **[[documentation: | + | | **Storage** | reference([[documentation: |
| - | | **SystemType** | string | read-write | The type of computer system represented by this resource.\\ | + | | **SystemType** | string |
| - | | **TrustedModules** [ {} ] | array | read-write | This object describes the array of Trusted Modules in the system. | | + | | **TrustedModules** [ { | array | |
| - | | **UUID** | string, | + | | \ \ \ \ \ \ **FirmwareVersion** | string |
| + | | \ \ \ \ \ \ **FirmwareVersion2** | string | Yes | read-only | The 2nd firmware version of this Trusted Module, if applicable. | | ||
| + | | \ \ \ \ \ \ **InterfaceType** | string | Yes | read-write | This property indicates the interface type of the Trusted Module.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **InterfaceTypeSelection** | string | Yes | read-write | The Interface Type selection supported by this Trusted Module.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **Oem** {} | object | | read-write | This is the manufacturer/ | ||
| + | | \ \ \ \ \ \ **Status** {} | object | | read-only | | | ||
| + | | } ] | | | | ||
| + | | **UUID** | string | Yes | read-write | The universal unique identifier (UUID) for this system.\\ pattern: ([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}) | | ||
| === Property Details === | === Property Details === | ||
| Line 518: | Line 536: | ||
| | PoweringOff | A temporary state between On and Off. The power off action can take time while the OS is in the shutdown process. | | | PoweringOff | A temporary state between On and Off. The power off action can take time while the OS is in the shutdown process. | | ||
| | PoweringOn | A temporary state between Off and On. This temporary state can be very short. | | | PoweringOn | A temporary state between Off and On. This temporary state can be very short. | | ||
| + | |||
| + | == SecureBootCurrentBoot == | ||
| + | |||
| + | ^ string ^ Description ^ | ||
| + | | Disabled | Secure Boot is currently disabled. | | ||
| + | | Enabled | Secure Boot is currently enabled. | | ||
| + | |||
| + | == SecureBootMode == | ||
| + | |||
| + | ^ string ^ Description ^ | ||
| + | | AuditMode | Secure Boot is currently in Audit Mode. | | ||
| + | | DeployedMode | Secure Boot is currently in Deployed Mode. | | ||
| + | | SetupMode | Secure Boot is currently in Setup Mode. | | ||
| + | | UserMode | Secure Boot is currently in User Mode. | | ||
| == State == | == State == | ||
| Line 548: | Line 580: | ||
| A Collection of ComputerSystem resource instances. | A Collection of ComputerSystem resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | The name of the resource or array element. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== DataProtectionLoSCapabilities ===== | ===== DataProtectionLoSCapabilities ===== | ||
| Line 558: | Line 590: | ||
| Describe data protection capabilities | Describe data protection capabilities | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Identifier** { | object, null | read-only | The value identifies this resource. | | + | | **Identifier** { | object |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | } | | + | | } | | | |
| - | | **Links** { | object | read-only | Contains links to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **SupportedReplicaOptions** [ {} ] | array | |
| - | | } | | + | | } | | | |
| - | | **Name** | string | read-write | The name of the resource or array element. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **SupportedDataProtectionLinesOfService** [ {} ] | array | read-write | Collection of known and supported DataProtectionLinesOfService. | | + | | **SupportedDataProtectionLinesOfService** [ { | array | |
| - | | **SupportedMinLifetime** [ {} ] | array | read-write | Supported minimum lifetime that replica must be maintained. | | + | | \ \ \ \ \ \ **IsIsolated** | boolean | Yes | read-write | The replica is in a separate fault domain. | |
| - | | **SupportedRecoveryGeographicObjectives** [ {} ] | array | read-write | Supported types of failure domains. | | + | | \ \ \ \ \ \ **MinLifetime** | number | Yes | read-write | Minimum lifetime (seconds) that replica must be maintained. | |
| - | | **SupportedRecoveryPointObjectiveSeconds** [ {} ] | array | read-write | Supported time intervals defining how much source information can be lost on failure. | | + | | \ \ \ \ \ \ **Name** | string | Yes | read-write | A friendly name for this line of service. | |
| - | | **SupportedRecoveryTimeObjectives** [ {} ] | array | read-write | Supported expectations for time to access an alternate replica. | | + | | \ \ \ \ \ \ **RecoveryGeographicObjective** | string | Yes | read-write | Geographic distribution scopes\\ //See Property Details, below, for more information about this property.// | |
| - | | **SupportedReplicaTypes** [ {} ] | array | read-write | Supported replica types. | | + | | \ \ \ \ \ \ **RecoveryPointObjective** | string | Yes | read-write | Time interval defining how much source data that can be lost on failure. | |
| - | | **SupportsIsolated** | boolean, null | read-write | Allocating a replica in a separate fault domain is supported. | | + | | \ \ \ \ \ \ **RecoveryTimeObjective** | string | Yes | read-write | Time to access an alternate replica.\\ //See Property Details, below, for more information about this property.// | |
| + | | \ \ \ \ \ \ **ReplicaAccessLocation** {} | object | Yes | read-write | Location that supplies data access to the replica. | | ||
| + | | \ \ \ \ \ \ **ReplicaClassOfService** {} | object | Yes | read-write | The replica' | ||
| + | | \ \ \ \ \ \ **ReplicaType** | string | Yes | read-write | Type of replica.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **Schedule** {} | object | Yes | read-write | A schedule for making periodic point in time replicas. | | ||
| + | | } ] | | | ||
| + | | **SupportedMinLifetime** [ {} ] | array | | ||
| + | | **SupportedRecoveryGeographicObjectives** [ {} ] | array | | ||
| + | | **SupportedRecoveryPointObjectiveSeconds** [ {} ] | array | | ||
| + | | **SupportedRecoveryTimeObjectives** [ {} ] | array | | ||
| + | | **SupportedReplicaTypes** [ {} ] | array | | ||
| + | | **SupportsIsolated** | boolean | ||
| === Property Details === | === Property Details === | ||
| Line 621: | Line 664: | ||
| Describe data security capabilities. | Describe data security capabilities. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Identifier** { | object, null | read-only | The value identifies this resource. | | + | | **Identifier** { | object |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | } | | + | | } | | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **SupportedAntivirusEngineProviders** [ {} ] | array | read-write | Supported AntiVirus providers. | | + | | **SupportedAntivirusEngineProviders** [ {} ] | array | |
| - | | **SupportedAntivirusScanPolicies** [ {} ] | array | read-write | Supported policies that trigger an AntiVirus scan. | | + | | **SupportedAntivirusScanPolicies** [ {} ] | array | |
| - | | **SupportedChannelEncryptionStrengths** [ {} ] | array | read-write | Supported key sizes for transport channel encryption. | | + | | **SupportedChannelEncryptionStrengths** [ {} ] | array | |
| - | | **SupportedDataSanitizationPolicies** [ {} ] | array | read-write | Supported data sanitization policies. | | + | | **SupportedDataSanitizationPolicies** [ {} ] | array | |
| - | | **SupportedDataSecurityLinesOfService** [ {} ] | array | read-write | Collection of known and supported DataSecurityLinesOfService. | | + | | **SupportedDataSecurityLinesOfService** [ { | array | |
| - | | **SupportedHostAuthenticationTypes** [ {} ] | array | read-write | Supported authentication types for hosts (servers) or initiator endpoints. | | + | | \ \ \ \ \ \ **AntivirusEngineProvider** | string | Yes | read-write | AntiVirus provider. | |
| - | | **SupportedMediaEncryptionStrengths** [ {} ] | array | read-write | Supported key sizes for media encryption. | | + | | \ \ \ \ \ \ **AntivirusScanPolicies** [ {} ] | array | | read-write | Policy for triggering an AntiVirus scan. | |
| - | | **SupportedSecureChannelProtocols** [ {} ] | array | read-write | Supported protocols that provide encrypted communication. | | + | | \ \ \ \ \ \ **ChannelEncryptionStrength** | string | Yes | read-write | Key size for transport channel encryption.\\ //See Property Details, below, for more information about this property.// | |
| - | | **SupportedUserAuthenticationTypes** [ {} ] | array | read-write | Supported authentication types for users (or programs). | | + | | \ \ \ \ \ \ **DataSanitizationPolicy** | string | Yes | read-write | Data sanitization policy.\\ //See Property Details, below, for more information about this property.// | |
| + | | \ \ \ \ \ \ **HostAuthenticationType** | string | Yes | read-write | Authentication type for hosts (servers) or initiator endpoints.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **MediaEncryptionStrength** | string | Yes | read-write | Key size for media encryption.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **Name** | string | Yes | read-write | A friendly name for this line of service. | | ||
| + | | \ \ \ \ \ \ **SecureChannelProtocol** | string | Yes | read-write | Protocol that provide encrypted communication.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **UserAuthenticationType** | string | Yes | read-write | Authentication type for users (or programs).\\ //See Property Details, below, for more information about this property.// | | ||
| + | | } ] | | | ||
| + | | **SupportedHostAuthenticationTypes** [ {} ] | array | | ||
| + | | **SupportedMediaEncryptionStrengths** [ {} ] | array | | ||
| + | | **SupportedSecureChannelProtocols** [ {} ] | array | | ||
| + | | **SupportedUserAuthenticationTypes** [ {} ] | array | | ||
| === Property Details === | === Property Details === | ||
| Line 705: | Line 758: | ||
| Describe data storage capabilities. | Describe data storage capabilities. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Identifier** { | object, null | read-only | The value identifies this resource. | | + | | **Identifier** { | object |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | } | | + | | } | | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **SupportedAccessCapabilities** [ {} ] | array | read-write | Supported access capabilities. | | + | | **SupportedAccessCapabilities** [ {} ] | array | |
| - | | **SupportedDataStorageLinesOfService** [ {} ] | array | read-write | Collection of known and supported DataStorageLinesOfService. | | + | | **SupportedDataStorageLinesOfService** [ { | array | |
| - | | **SupportedProvisioningPolicies** [ {} ] | array | read-write | Thin allows over allocation of storage. | | + | | \ \ \ \ \ \ **IsSpaceEfficient** | boolean | Yes | read-write | True implies compression or deduplication of storage. | |
| - | | **SupportedRecoveryTimeObjectives** [ {} ] | array | read-write | Supported expectations for time to access the primary store after recovery. | | + | | \ \ \ \ \ \ **Name** | string | Yes | read-write | A friendly name for this line of service. | |
| - | | **SupportsSpaceEfficiency** | boolean, null | read-write | Allows compression or deduplication of storage. | | + | | \ \ \ \ \ \ **ProvisioningPolicy** | string | Yes | read-write | Provisioning policy for storage.\\ //See Property Details, below, for more information about this property.// | |
| + | | \ \ \ \ \ \ **RecoveryTimeObjectives** | | Yes | read-write | Expectations for time to access the primary store after disaster recover. | | ||
| + | | } ] | | | ||
| + | | **SupportedProvisioningPolicies** [ {} ] | array | | ||
| + | | **SupportedRecoveryTimeObjectives** [ {} ] | array | | ||
| + | | **SupportsSpaceEfficiency** | boolean | ||
| === Property Details === | === Property Details === | ||
| Line 742: | Line 800: | ||
| Drive contains properties describing a single physical disk drive for any system, along with links to associated Volumes. | Drive contains properties describing a single physical disk drive for any system, along with links to associated Volumes. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **AssetTag** | string, null | read-write | The user assigned asset tag for this drive. | | + | | **AssetTag** | string |
| - | | **BlockSizeBytes** | number, null | read-only | The size of the smallest addressible unit (Block) of this drive in bytes.\\ unit: By | | + | | **BlockSizeBytes** | number |
| - | | **CapableSpeedGbs** | number, null | read-only | The speed which this drive can communicate to a storage controller in ideal conditions in Gigabits per second.\\ unit: Gbit/s | | + | | **CapableSpeedGbs** | number |
| - | | **CapacityBytes** | number, null | read-only | The size in bytes of this Drive.\\ unit: By | | + | | **CapacityBytes** | number |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **EncryptionAbility** | string, null | read-write | The encryption abilities of this drive.\\ | + | | **EncryptionAbility** | string |
| - | | **EncryptionStatus** | string, null | read-write | The status of the encrytion of this drive.\\ | + | | **EncryptionStatus** | string |
| - | | **FailurePredicted** | boolean, null | read-only | Is this drive currently predicting a failure in the near future. | | + | | **FailurePredicted** | boolean |
| - | | **HotspareType** | string, null | read-write | The type of hotspare this drive is currently serving as.\\ *See Property Details, below, for more information about this property.* | | + | | **HotspareType** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Identifiers** [ {} ] | array | read-write | The Durable names for the drive. | | + | | **Identifiers** [ { | array | |
| - | | **IndicatorLED** | string, | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | \ \ \ \ \ \ **DurableNameFormat** | string | Yes | read-write | This represents the format of the DurableName property.\\ //See Property Details, below, for more information about this property.// | |
| - | | < | + | | } ] | | | |
| - | | < | + | | **IndicatorLED** | string | Yes | read-write | The state of the indicator LED, used to identify the drive.\\ |
| - | | < | + | | **Links** { | object |
| - | | } | | + | | \ \ \ \ \ \ **Endpoints** [ {} ] | array | |
| - | | **Location** [ {} ] | array | read-write | The Location of the drive. | | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | **Manufacturer** | string, null | read-only | This is the manufacturer of this drive. | | + | | \ \ \ \ \ \ **Volumes** [ {} ] | array | |
| - | | **MediaType** | string, null | read-write | The type of media contained in this drive.\\ | + | | } | | | |
| - | | **Model** | string, null | read-only | This is the model number for the drive. | | + | | **Location** [ { | array | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | \ \ \ \ \ \ **Info** | string | Yes | read-only | This indicates the location of the resource. | |
| - | | **NegotiatedSpeedGbs** | number, null | read-only | The speed which this drive is currently communicating to the storage controller in Gigabits per second.\\ unit: Gbit/s | | + | | \ \ \ \ \ \ **InfoFormat** | string | Yes | read-only | This represents the format of the Info property. | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | \ \ \ \ \ \ **Oem** {} | object | | read-write | Oem extension object. | |
| - | | **Operations** [ {} ] | array | read-write | The operations currently running on the Drive. | | + | | } ] | | |
| - | | **PartNumber** | string, null | read-only | The part number for this drive. | | + | | **Manufacturer** | string |
| - | | **PredictedMediaLifeLeftPercent** | number, null | read-only | The percentage of reads and writes that are predicted to still be available for the media. | | + | | **MediaType** | string |
| - | | **Protocol** | null | read-write | The protocol this drive is using to communicate to the storage controller. | | + | | **Model** | string |
| - | | **Revision** | string, null | read-only | The revision of this Drive. This is typically the firmware/ | + | | **Name** | string |
| - | | **RotationSpeedRPM** | number, null | read-only | The rotation speed of this Drive in Revolutions per Minute (RPM).\\ unit: RPM | | + | | **NegotiatedSpeedGbs** | number |
| - | | **SKU** | string, null | read-only | This is the SKU for this drive. | | + | | **Oem** {} | object |
| - | | **SerialNumber** | string, null | read-only | The serial number for this drive. | | + | | **Operations** [ {} ] | array | |
| - | | **Status** { | object | read-only | | | + | | **PartNumber** | string |
| - | | < | + | | **PredictedMediaLifeLeftPercent** | number |
| - | | < | + | | **Protocol** | | Yes | read-write | The protocol this drive is using to communicate to the storage controller. | |
| - | | < | + | | **Revision** | string |
| - | | < | + | | **RotationSpeedRPM** | number |
| - | | } | | + | | **SKU** | string |
| - | | **StatusIndicator** | string, null | read-write | The state of the status indicator, used to communicate status information about this drive.\\ | + | | **SerialNumber** | string |
| + | | **Status** { | object | ||
| + | | \ \ \ \ \ \ **Health** | string | ||
| + | | \ \ \ \ \ \ **HealthRollup** | string | ||
| + | | \ \ \ \ \ \ **Oem** {} | object | ||
| + | | \ \ \ \ \ \ **State** | string | ||
| + | | } | | | | ||
| + | | **StatusIndicator** | string | ||
| === Property Details === | === Property Details === | ||
| Line 881: | Line 946: | ||
| A Collection of Drive resource instances. | A Collection of Drive resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this drive collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== Endpoint ===== | ===== Endpoint ===== | ||
| Line 891: | Line 956: | ||
| This is the schema definition for the Endpoint resource. It represents the properties of an entity that sends or receives protocol defined messages over a transport. | This is the schema definition for the Endpoint resource. It represents the properties of an entity that sends or receives protocol defined messages over a transport. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The Actions object contains the available custom actions on this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **ConnectedEntities** [ {} ] | array | read-write | All the entities connected to this endpoint. | | + | | **ConnectedEntities** [ { | array | |
| - | | **Description** | string, | + | | \ \ \ \ \ \ **EntityLink** {} | object | Yes | read-write | A link to the associated entity. | |
| - | | **EndpointProtocol** | null | read-write | The protocol supported by this endpoint. | | + | | \ \ \ \ \ \ **EntityPciId** {} | object | Yes | read-write | The PCI ID of the connected entity. | |
| - | | **HostReservationMemoryBytes** | number, null | read-only | The amount of memory in Bytes that the Host should allocate to connect to this endpoint.\\ unit: By | | + | | \ \ \ \ \ \ **EntityRole** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | \ \ \ \ \ \ **EntityType** | string | Yes | read-write | The type of the connected entity.\\ //See Property Details, below, for more information about this property.// | |
| - | | **Identifiers** [ {} ] | array | read-write | Identifiers for this endpoint. | | + | | \ \ \ \ \ \ **Identifiers** [ {} ] | array | | read-write | Identifiers for the remote entity. | |
| - | | **Links** { | object | read-write | The links object contains the links to other resources that are related to this resource. | | + | | \ \ \ \ \ \ **Oem** {} | object | Yes | read-write | This is the manufacturer/ |
| - | | < | + | | \ \ \ \ \ \ **PciClassCode** | string | Yes | read-only | The Class Code and Subclass code of this PCIe function.\\ pattern: / |
| - | | < | + | | \ \ \ \ \ \ **PciFunctionNumber** | number | Yes | read-only | The PCI ID of the connected entity. | |
| - | | < | + | | } ] | | | |
| - | | } | | + | | **Description** | string | Yes | 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. | | + | | **EndpointProtocol** | | Yes | read-write | The protocol supported by this endpoint. | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **HostReservationMemoryBytes** | number |
| - | | **PciId** { | object, null | read-write | The PCI ID of the endpoint. | | + | | **Id** | string |
| - | | < | + | | **Identifiers** [ { | array | |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string | Yes | read-only | This indicates the world wide, persistent name of the resource. | |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string | Yes | read-write | This represents the format of the DurableName property.\\ //See Property Details, below, for more information about this property.// | |
| - | | < | + | | } ] | | |
| - | | } | | + | | **Links** { | object |
| - | | **Redundancy** [ {} ] | array | read-write | Redundancy information for the lower level endpoints supporting this endpoint. | | + | | \ \ \ \ \ \ **MutuallyExclusiveEndpoints** [ {} ] | array | |
| - | | **Status** { | object, null | read-only | | | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **Ports** [ {} ] | array | |
| - | | < | + | | } | | | |
| - | | < | + | | **Name** | string |
| - | | < | + | | **Oem** {} | object |
| - | | } | | + | | **PciId** { | object |
| + | | \ \ \ \ \ \ **DeviceId** | string | ||
| + | | \ \ \ \ \ \ **SubsystemId** | string | ||
| + | | \ \ \ \ \ \ **SubsystemVendorId** | string | ||
| + | | \ \ \ \ \ \ **VendorId** | string | ||
| + | | } | | | | ||
| + | | **Redundancy** [ { | array | | ||
| + | | \ \ \ \ \ \ **MaxNumSupported** | number | Yes | read-only | This is the maximum number of members allowable for this particular redundancy group. | | ||
| + | | \ \ \ \ \ \ **MemberId** | string | | read-write | This is the identifier for the member within the collection. | | ||
| + | | \ \ \ \ \ \ **MinNumNeeded** | number | Yes | read-only | This is the minumum number of members needed for this group to be redundant. | | ||
| + | | \ \ \ \ \ \ **Mode** | string | Yes | read-write | This is the redundancy mode of the group.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **Name** | string | | read-only | The name of the resource or array element. | | ||
| + | | \ \ \ \ \ \ **Oem** {} | object | | read-write | This is the manufacturer/ | ||
| + | | \ \ \ \ \ \ **RedundancySet** [ {} ] | array | | read-only | Contains any ids that represent components of this redundancy set. | | ||
| + | | \ \ \ \ \ \ **Status** {} | object | ||
| + | | \ \ \ \ \ \ **MemberId** | string | | read-only | This is the identifier for the member within the collection. | | ||
| + | | \ \ \ \ \ \ **RedundancyEnabled** | boolean | Yes | read-write | This indicates whether redundancy is enabled. | | ||
| + | | } ] | | | | ||
| + | | **Status** { | object | Yes | read-only | | | ||
| + | | \ \ \ \ \ \ **Health** | string | ||
| + | | \ \ \ \ \ \ **HealthRollup** | string | ||
| + | | \ \ \ \ \ \ **Oem** {} | object | ||
| + | | \ \ \ \ \ \ **State** | string | ||
| + | | } | | | | ||
| === Property Details === | === Property Details === | ||
| Line 994: | Line 1082: | ||
| A Collection of Endpoint resource instances. | A Collection of Endpoint resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | The value of each member references an Endpoint resource. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== EndpointGroup ===== | ===== EndpointGroup ===== | ||
| Line 1004: | Line 1092: | ||
| A group of endpoints that are managed as a unit. | A group of endpoints that are managed as a unit. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AccessState** | string, null | read-write | Access State for this group.\\ | + | | **AccessState** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **[[documentation: | + | | **Endpoints** | object | Yes | read-write | The Endpoints. | |
| - | | **GroupType** | string, null | read-write | Endpoint group type.\\ | + | | **GroupType** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Identifier** { | object, null | read-only | The value identifies this resource. | | + | | **Identifier** { | object |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | } | | + | | } | | | |
| - | | **Links** { | object | read-only | Contains links to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Preferred** | boolean, null | read-write | Access to resource is preferred. | | + | | **Preferred** | boolean |
| - | | **TargetEndpointGroupIdentifier** | number, null | read-write | A defined identifier for this group. | | + | | **TargetEndpointGroupIdentifier** | number |
| === Property Details === | === Property Details === | ||
| Line 1053: | Line 1141: | ||
| A Collection of endpoint group resource instances. | A Collection of endpoint group resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | The value of each member references an endpoint group resource. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== EthernetInterface ===== | ===== EthernetInterface ===== | ||
| Line 1063: | Line 1151: | ||
| This schema defines a simple ethernet NIC resource. | This schema defines a simple ethernet NIC resource. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AutoNeg** | boolean, null | read-write | This indicates if the speed and duplex are automatically negotiated and configured on this interface. | | + | | **AutoNeg** | boolean |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **FQDN** | string, null | read-write | This is the complete, fully qualified domain name obtained by DNS for this interface. | | + | | **FQDN** | string |
| - | | **FullDuplex** | boolean, null | read-write | This indicates if the interface is in Full Duplex mode or not. | | + | | **FullDuplex** | boolean |
| - | | **HostName** | string, null | read-write | The DNS Host Name, without any domain information. | | + | | **HostName** | string |
| - | | **IPv4Addresses** [ {} ] | array | read-write | The IPv4 addresses assigned to this interface. | | + | | **IPv4Addresses** [ { | array | |
| - | | **IPv6AddressPolicyTable** [ {} ] | array | read-write | An array representing the RFC 6724 Address Selection Policy Table. | | + | | \ \ \ \ \ \ **Address** | string | Yes | read-write | This is the IPv4 Address.\\ pattern: %%^%%(?:[0-9]{1,3}\.){3}[0-9]{1,3}$ | |
| - | | **IPv6Addresses** [ {} ] | array | read-write | This array of objects enumerates all of the currently assigned IPv6 addresses on this interface. | | + | | \ \ \ \ \ \ **AddressOrigin** | string | Yes | read-write | This indicates how the address was determined.\\ //See Property Details, below, for more information about this property.// | |
| - | | **IPv6DefaultGateway** | string, | + | | \ \ \ \ \ \ **Gateway** | string | Yes | read-write | This is the IPv4 gateway for this address. | |
| - | | **IPv6StaticAddresses** [ {} ] | array | read-write | This array of objects represents all of the IPv6 static addresses to be assigned on this interface. | | + | | \ \ \ \ \ \ **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | \ \ \ \ \ \ **SubnetMask** | string | Yes | read-write | This is the IPv4 Subnet mask.\\ pattern: %%^%%(?: |
| - | | **InterfaceEnabled** | boolean, null | read-write | This indicates whether this interface is enabled. | | + | | } ] | | | |
| - | | **LinkStatus** | string, null | read-write | The link status of this interface (port).\\ | + | | **IPv6AddressPolicyTable** [ { | array | |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | \ \ \ \ \ \ **Label** | number | Yes | read-write | The IPv6 Label (as defined in RFC 6724 section 2.1).\\ maximum: 100 | |
| - | | < | + | | \ \ \ \ \ \ **Precedence** | number | Yes | read-write | The IPv6 Precedence (as defined in RFC 6724 section 2.1.\\ minimum: 1\\ maximum: 100 | |
| - | | < | + | | \ \ \ \ \ \ **Prefix** | string | Yes | read-write | The IPv6 Address Prefix (as defined in RFC 6724 section 2.1). | |
| - | | < | + | | } ] | | |
| - | | } | | + | | **IPv6Addresses** [ { | array | |
| - | | **MACAddress** | string, null | read-write | This is the currently configured MAC address of the (logical port) interface.\\ pattern: ^([0-9A-Fa-f]{2}[: | + | | \ \ \ \ \ \ **Address** | string |
| - | | **MTUSize** | number, null | read-write | This is the currently configured Maximum Transmission Unit (MTU) in bytes on this interface. | | + | | \ \ \ \ \ \ **AddressOrigin** | string | Yes | read-write | This indicates how the address was determined.\\ //See Property Details, below, for more information about this property.// | |
| - | | **MaxIPv6StaticAddresses** | number, null | read-only | This indicates the maximum number of Static IPv6 addresses that can be configured on this interface. | | + | | \ \ \ \ \ \ **AddressState** | string | Yes | read-write | The current state of this address as defined in RFC 4862.\\ //See Property Details, below, for more information about this property.// | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | \ \ \ \ \ \ **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | **NameServers** [ {} ] | array | read-only | This represents DNS name servers that are currently in use on this interface. | | + | | \ \ \ \ \ \ **PrefixLength** | number | Yes | read-write | This is the IPv6 Address Prefix Length.\\ minimum: 1\\ maximum: 128 | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | } ] | | | |
| - | | **PermanentMACAddress** | string, null | read-write | This is the permanent MAC address assigned to this interface (port).\\ pattern: ^([0-9A-Fa-f]{2}[: | + | | **IPv6DefaultGateway** | string | Yes | read-only | This is the IPv6 default gateway address that is currently in use on this interface. | |
| - | | **SpeedMbps** | number, null | read-write | This is the current speed in Mbps of this interface.\\ unit: Mbit/s | | + | | **IPv6StaticAddresses** [ { | array | |
| - | | **Status** { | object, null | read-only | | | + | | \ \ \ \ \ \ **Address** | string | Yes | read-write | A valid IPv6 address. | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | | \ \ \ \ \ \ **PrefixLength** | number | Yes | read-write | The Prefix Length of this IPv6 address.\\ minimum: 1\\ maximum: 128 | |
| - | | < | + | | } ] | | |
| - | | < | + | | **Id** | string |
| - | | } | | + | | **InterfaceEnabled** | boolean |
| - | | **UefiDevicePath** | string, null | read-only | The UEFI device path for this interface. | | + | | **LinkStatus** | string |
| - | | **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. | | + | | **Links** { | object |
| - | | **[[documentation: | + | | \ \ \ \ \ \ **Endpoints** [ {} ] | array | |
| + | | \ \ \ \ \ \ **HostInterface** | ||
| + | | \ \ \ \ \ \ **Oem** {} | object | ||
| + | | } | | | | ||
| + | | **MACAddress** | string | ||
| + | | **MTUSize** | number | ||
| + | | **MaxIPv6StaticAddresses** | number | ||
| + | | **Name** | string | ||
| + | | **NameServers** [ {} ] | array | | ||
| + | | **Oem** {} | object | ||
| + | | **PermanentMACAddress** | string | ||
| + | | **SpeedMbps** | number | ||
| + | | **Status** { | object | ||
| + | | \ \ \ \ \ \ **Health** | string | ||
| + | | \ \ \ \ \ \ **HealthRollup** | string | ||
| + | | \ \ \ \ \ \ **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: | ||
| === Property Details === | === Property Details === | ||
| Line 1159: | Line 1267: | ||
| A Collection of EthernetInterface resource instances. | A Collection of EthernetInterface resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== Event ===== | ===== Event ===== | ||
| Line 1169: | Line 1277: | ||
| The Event schema describes the JSON payload received by an Event Destination (which has subscribed to event notification) when events occurs. | The Event schema describes the JSON payload received by an Event Destination (which has subscribed to event notification) when events occurs. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Context** | string | read-only | A context can be supplied at subscription time. This property is the context value supplied by the subscriber. | | + | | **Context** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Events** [ {} ] | array | read-write | Each event in this array has a set of properties that describe the event. | + | | **Events** [ { | array | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | \ \ \ \ \ \ **Context** | string | | read-only | A context can be supplied at subscription time. This property is the context value supplied by the subscriber. | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | \ \ \ \ \ \ **EventId** | string | | read-only | This is a unique instance identifier of an event. | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | \ \ \ \ \ \ **EventTimestamp** | string | | read-only | This is time the event occurred.\\ format: date-time | |
| + | | \ \ \ \ \ \ **EventType** | string | | read-write | This indicates the type of event sent, according to the definitions in the EventService.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **MemberId** | string | | read-only | This is the identifier for the member within the collection. | | ||
| + | | \ \ \ \ \ \ **Message** | string | | read-only | This is the human readable message, if provided. | | ||
| + | | \ \ \ \ \ \ **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 | | read-only | This is the key for this message which can be used to look up the message in a message registry.\\ pattern: %%^%%[A-Za-z0-9]+\.\d+\.\d+\.[A-Za-z0-9.]+$ | | ||
| + | | \ \ \ \ \ \ **Oem** {} | object | | read-write | This is the manufacturer/ | ||
| + | | \ \ \ \ \ \ **OriginOfCondition** {} | object | | read-write | This indicates the resource that originated the condition that caused the event to be generated. | | ||
| + | | \ \ \ \ \ \ **Severity** | string | | read-only | This is the severity of the event. | | ||
| + | | } ] | | | ||
| + | | **Id** | string | ||
| + | | **Name** | string | ||
| + | | **Oem** {} | object | ||
| === Property Details === | === Property Details === | ||
| Line 1193: | Line 1313: | ||
| An Event Destination desribes the target of an event subscription, | An Event Destination desribes the target of an event subscription, | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Context** | string | read-write | A client-supplied string that is stored with the event destination subscription. | | + | | **Context** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Destination** | string | read-only | The URI of the destination Event Service.\\ format: uri | | + | | **Destination** | string |
| - | | **EventTypes** [ {} ] | array | read-only | This property shall contain the types of events that shall be sent to the desination. | | + | | **EventTypes** [ {} ] | array | |
| - | | **HttpHeaders** [ {} ] | array | read-write | This is for setting HTTP headers, such as authorization information. | + | | **HttpHeaders** [ {} ] | array | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **MessageIds** [ {} ] | array | read-only | A list of MessageIds that the service will only send. | | + | | **MessageIds** [ {} ] | array | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **OriginResources** [ {} ] | array | read-only | A list of resources for which the service will only send related events. | | + | | **OriginResources** [ {} ] | array | |
| - | | **Protocol** | string | read-write | The protocol type of the event connection.\\ | + | | **Protocol** | string |
| === Property Details === | === Property Details === | ||
| Line 1211: | Line 1331: | ||
| ^ string ^ | ^ string ^ | ||
| - | | Redfish | | + | | Redfish | |
| Line 1218: | Line 1338: | ||
| A Collection of EventDestination resource instances. | A Collection of EventDestination resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== EventService ===== | ===== EventService ===== | ||
| Line 1228: | Line 1348: | ||
| The Event Service resource contains properties for managing event subcriptions and generates the events sent to subscribers. | The Event Service resource contains properties for managing event subcriptions and generates the events sent to subscribers. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **DeliveryRetryAttempts** | number | read-only | This is the number of attempts an event posting is retried before the subscription is terminated. | | + | | **DeliveryRetryAttempts** | number |
| - | | **DeliveryRetryIntervalSeconds** | number | read-only | This represents the number of seconds between retry attempts for sending any given Event.\\ unit: s | | + | | **DeliveryRetryIntervalSeconds** | number |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **EventTypesForSubscription** [ {} ] | array | read-only | This is the types of Events that can be subscribed to. | | + | | **EventTypesForSubscription** [ {} ] | array | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **ServiceEnabled** | boolean, null | read-write | This indicates whether this service is enabled. | | + | | **ServiceEnabled** | boolean |
| - | | **Status** { | object | read-only | | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| - | | **[[documentation: | + | | **Subscriptions** | reference([[documentation: |
| === Property Details === | === Property Details === | ||
| Line 1285: | Line 1405: | ||
| Fabric contains properties describing a simple fabric consisting of one or more switches, zero or more endpoints, and zero or more zones. | Fabric contains properties describing a simple fabric consisting of one or more switches, zero or more endpoints, and zero or more zones. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **[[documentation: | + | | **Endpoints** | reference([[documentation: |
| - | | **FabricType** | null | read-write | The protocol being sent over this fabric. | | + | | **FabricType** | | Yes | read-write | The protocol being sent over this fabric. | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **MaxZones** | number, null | read-only | The value of this property shall contain the maximum number of zones the switch can currently configure. | | + | | **MaxZones** | number |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Status** { | object | read-only | | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| - | | **[[documentation: | + | | **Switches** | reference([[documentation: |
| - | | **[[documentation: | + | | **Zones** | reference([[documentation: |
| === Property Details === | === Property Details === | ||
| Line 1344: | Line 1464: | ||
| A Collection of Fabric resource instances. | A Collection of Fabric resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== FileShare ===== | ===== FileShare ===== | ||
| Line 1354: | Line 1474: | ||
| An instance of a shared set of files with a common directory structure. | An instance of a shared set of files with a common directory structure. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **CASupported** | boolean, null | read-write | Continuous Availability is supported. Client/ | + | | **CASupported** | boolean |
| - | | **DefaultAccessPrivileges** [ {} ] | array | read-only | An array of default access privileges for the file share. The types of default access can include Read, Write, and/or Execute. | | + | | **DefaultAccessPrivileges** [ {} ] | array | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **[[documentation: | + | | **EthernetInterfaces** | reference([[documentation: |
| - | | **ExecuteSupport** | boolean, null | read-only | Execute access is supported by the file share. | | + | | **ExecuteSupport** | boolean |
| - | | **FileSharePath** | string, null | read-only | A path to an exported file or directory on the file system where this file share is hosted. | | + | | **FileSharePath** | string |
| - | | **FileShareQuotaType** | string, null | read-write | Specifies the type of quota enforcement.\\ | + | | **FileShareQuotaType** | string |
| - | | **FileShareRemainingQuotaBytes** | number, null | read-write | The number of remaining bytes that may be used by this file share.\\ unit: By | | + | | **FileShareRemainingQuotaBytes** | number |
| - | | **FileShareTotalQuotaBytes** | number, null | read-write | The maximum number of bytes that may be used by this file share.\\ unit: By | | + | | **FileShareTotalQuotaBytes** | number |
| - | | **FileSharingProtocols** [ {} ] | array | read-only | An array of file sharing protocols supported by this file share. | | + | | **FileSharingProtocols** [ {} ] | array | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Links** { | object | read-only | Contains links to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **ClassOfService** |
| - | | < | + | | \ \ \ \ \ \ **FileSystem** |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **LowSpaceWarningThresholdPercents** [ {} ] | array | read-write | An array of low space warning threshold percentages for the file share. | | + | | **LowSpaceWarningThresholdPercents** [ {} ] | array | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **RootAccess** | boolean, null | read-only | Root access is allowed by the file share. | | + | | **RootAccess** | boolean |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| - | | **WritePolicy** | string, null | read-write | Defines how writes are replicated to the shared source.\\ | + | | **WritePolicy** | string |
| === Property Details === | === Property Details === | ||
| Line 1433: | Line 1553: | ||
| An instance of a hierarchical namespace of files. | An instance of a hierarchical namespace of files. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AccessCapabilities** [ {} ] | array | read-write | An array of supported IO access capabilities. | | + | | **AccessCapabilities** [ {} ] | array | |
| - | | **BlockSizeBytes** | number, null | read-only | Block size of the file system in bytes.\\ unit: By | | + | | **BlockSizeBytes** | number |
| - | | **Capacity** { | object, null | read-write | Capacity allocated to the file system. | | + | | **Capacity** { | object |
| - | | < | + | | \ \ \ \ \ \ **Data** {} | object |
| - | | < | + | | \ \ \ \ \ \ **IsThinProvisioned** | boolean |
| - | | < | + | | \ \ \ \ \ \ **Metadata** {} | object |
| - | | < | + | | \ \ \ \ \ \ **Snapshot** {} | object |
| - | | } | | + | | } | | | |
| - | | **CapacitySources** [ {} ] | array | read-write | An array of capacity sources for the file system. | | + | | **CapacitySources** [ { | array | |
| - | | **CasePreserved** | boolean, null | read-write | The case of file names is preserved by the file system. | | + | | \ \ \ \ \ \ **ProvidedCapacity** {} | object | Yes | read-write | The amount of space that has been provided from the ProvidingDrives, |
| - | | **CaseSensitive** | boolean, null | read-write | Case sensitive file names are supported by the file system. | | + | | \ \ \ \ \ \ **ProvidedClassOfService** {} | object | Yes | read-write | The ClassOfService provided from the ProvidingDrives, |
| - | | **CharacterCodeSet** [ {} ] | array | read-write | An array of the character sets or encodings supported by the file system. | | + | | \ \ \ \ \ \ **ProvidingDrives** {} | object | Yes | read-write | The drive or drives that provide this space. | |
| - | | **ClusterSizeBytes** | number, null | read-write | A value indicating the minimum file allocation size imposed by the file system.\\ unit: By\\ minimum: 1 | | + | | \ \ \ \ \ \ **ProvidingPools** {} | object | Yes | read-write | The pool or pools that provide this space. | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | \ \ \ \ \ \ **ProvidingVolumes** {} | object | Yes | read-write | The volume or volumes that provide this space. | |
| - | | **ExportedShares** [ {} ] | array | read-only | An array of exported file shares of this file system. | | + | | } ] | | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **CasePreserved** | boolean |
| - | | **Links** { | object | read-only | Contains links to other resources that are related to this resource. | | + | | **CaseSensitive** | boolean |
| - | | < | + | | **CharacterCodeSet** [ {} ] | array | |
| - | | < | + | | **ClusterSizeBytes** | number |
| - | | < | + | | **Description** | string |
| - | | } | | + | | **ExportedShares** |
| - | | **LowSpaceWarningThresholdPercents** [ {} ] | array | read-write | An array of low space warning threshold percentages for the file system. | | + | | **Id** | string |
| - | | **MaxFileNameLengthBytes** | number, null | read-write | A value indicating the maximum length of a file name within the file system.\\ unit: By\\ minimum: 1 | | + | | **Links** { | object |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | \ \ \ \ \ \ **ClassOfService** |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | **RemainingCapacity** { | object, null | read-write | Remaining capacity allocated to the file system. | | + | | \ \ \ \ \ \ **ReplicaCollection** [ {} ] | array | |
| - | | < | + | | } | | | |
| - | | < | + | | **LowSpaceWarningThresholdPercents** [ {} ] | array | |
| - | | < | + | | **MaxFileNameLengthBytes** | number |
| - | | < | + | | **Name** | string |
| - | | } | | + | | **Oem** {} | object |
| - | | **ReplicaInfo** { | object, null | read-write | This value describes the replica attributes if this file system is a replica. | | + | | **RemainingCapacity** { | object |
| - | | < | + | | \ \ \ \ \ \ **Data** {} | object |
| - | | < | + | | \ \ \ \ \ \ **IsThinProvisioned** | boolean |
| - | | < | + | | \ \ \ \ \ \ **Metadata** {} | object |
| - | | < | + | | \ \ \ \ \ \ **Snapshot** {} | object |
| - | | < | + | | } | | | |
| - | | < | + | | **ReplicaInfo** { | object |
| - | | < | + | | \ \ \ \ \ \ **ConsistencyEnabled** | boolean |
| - | | < | + | | \ \ \ \ \ \ **ConsistencyState** | string |
| - | | < | + | | \ \ \ \ \ \ **ConsistencyStatus** | string |
| - | | < | + | | \ \ \ \ \ \ **ConsistencyType** | string |
| - | | < | + | | \ \ \ \ \ \ **FailedCopyStopsHostIO** | boolean |
| - | | < | + | | \ \ \ \ \ \ **PercentSynced** | number |
| - | | < | + | | \ \ \ \ \ \ **Replica** | | Yes | read-write | The resource that is the source of this replica. | |
| - | | < | + | | \ \ \ \ \ \ **ReplicaPriority** | string |
| - | | < | + | | \ \ \ \ \ \ **ReplicaProgressStatus** | string |
| - | | < | + | | \ \ \ \ \ \ **ReplicaReadOnlyAccess** | string |
| - | | < | + | | \ \ \ \ \ \ **ReplicaRecoveryMode** | string |
| - | | < | + | | \ \ \ \ \ \ **ReplicaRole** | string |
| - | | < | + | | \ \ \ \ \ \ **ReplicaSkewBytes** | number |
| - | | < | + | | \ \ \ \ \ \ **ReplicaState** | string |
| - | | < | + | | \ \ \ \ \ \ **ReplicaType** | string |
| - | | < | + | | \ \ \ \ \ \ **ReplicaUpdateMode** | string |
| - | | < | + | | \ \ \ \ \ \ **RequestedReplicaState** | string |
| - | | < | + | | \ \ \ \ \ \ **SyncMaintained** | boolean |
| - | | < | + | | \ \ \ \ \ \ **UndiscoveredElement** | string |
| - | | } | | + | | \ \ \ \ \ \ **WhenActivated** | string |
| + | | \ \ \ \ \ \ **WhenDeactivated** | string | ||
| + | | \ \ \ \ \ \ **WhenEstablished** | string | ||
| + | | \ \ \ \ \ \ **WhenSuspended** | string | ||
| + | | \ \ \ \ \ \ **WhenSynced** | string | ||
| + | | \ \ \ \ \ \ **WhenSynchronized** | string | ||
| + | | } | | | | ||
| === Property Details === | === Property Details === | ||
| Line 1649: | Line 1775: | ||
| Contains a collection of references to FileSystem resource instances. | Contains a collection of references to FileSystem resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | References to the members of this FileSystem collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== HostInterface ===== | ===== HostInterface ===== | ||
| Line 1659: | Line 1785: | ||
| This schema defines a Host Interface resource. | This schema defines a Host Interface resource. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AuthenticationModes** [ {} ] | array | read-write | This indicates the authentication modes available on this interface. | | + | | **AuthenticationModes** [ {} ] | array | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **ExternallyAccessible** | boolean, null | read-only | This indicates whether this interface is accessible by external entities. | | + | | **ExternallyAccessible** | boolean |
| - | | **FirmwareAuthEnabled** | boolean, null | read-write | This indicates whether this firmware authentication is enabled for this interface. | | + | | **FirmwareAuthEnabled** | boolean |
| - | | **FirmwareAuthRoleId** | string | read-write | This property contains the Role for firmware authentication on this interface. | | + | | **FirmwareAuthRoleId** | string |
| - | | **[[documentation: | + | | **HostEthernetInterfaces** | reference([[documentation: |
| - | | **HostInterfaceType** | string, null | read-write | This indicates the Host Interface type for this interface.\\ | + | | **HostInterfaceType** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **InterfaceEnabled** | boolean, null | read-write | This indicates whether this interface is enabled. | | + | | **InterfaceEnabled** | boolean |
| - | | **KernelAuthEnabled** | boolean, null | read-write | This indicates whether this kernel authentication is enabled for this interface. | | + | | **KernelAuthEnabled** | boolean |
| - | | **KernelAuthRoleId** | string | read-write | This property contains the Role for kernel authentication on this interface. | | + | | **KernelAuthRoleId** | string |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **ComputerSystems** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **FirmwareAuthRole** |
| - | | < | + | | \ \ \ \ \ \ **KernelAuthRole** |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **[[documentation: | + | | **ManagerEthernetInterface** | reference([[documentation: |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **[[documentation: | + | | **NetworkProtocol** | reference([[documentation: |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| === Property Details === | === Property Details === | ||
| Line 1708: | Line 1834: | ||
| ^ string ^ Description ^ | ^ string ^ Description ^ | ||
| | NetworkHostInterface | This interface is a Network Host Interface. | | | NetworkHostInterface | This interface is a Network Host Interface. | | ||
| + | |||
| + | == LinkStatus == | ||
| + | |||
| + | ^ string ^ Description ^ | ||
| + | | LinkDown | There is no link on this interface, but the interface is connected. | | ||
| + | | LinkUp | The link is available for communication on this interface. | | ||
| + | | NoLink | There is no link or connection detected on this interface. | | ||
| == State == | == State == | ||
| Line 1729: | Line 1862: | ||
| A Collection of HostInterface resource instances. | A Collection of HostInterface resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== HostedStorageServices ===== | ===== HostedStorageServices ===== | ||
| Line 1739: | Line 1872: | ||
| A Collection of Hosted Storage Service resource instances. | A Collection of Hosted Storage Service resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-write | The value of each member references a StorageService resource. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== IOConnectivityLoSCapabilities ===== | ===== IOConnectivityLoSCapabilities ===== | ||
| Line 1749: | Line 1882: | ||
| Describe IO Connectivity capabilities. | Describe IO Connectivity capabilities. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Identifier** { | object, null | read-only | The value identifies this resource. | | + | | **Identifier** { | object |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | } | | + | | } | | | |
| - | | **MaxSupportedIOPS** | number, null | read-write | The maximum IOPS that a connection can support. | | + | | **MaxSupportedIOPS** | number |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **SupportedAccessProtocols** [ {} ] | array | read-write | SupportedAccessProtocols. | | + | | **SupportedAccessProtocols** [ {} ] | array | |
| - | | **SupportedIOConnectivityLinesOfService** [ {} ] | array | read-write | Collection of known and supported IOConnectivityLinesOfService. | | + | | **SupportedIOConnectivityLinesOfService** [ { | array | |
| + | | \ \ \ \ \ \ **AccessProtocol** | string | Yes | read-write | SupportedAccessProtocols.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **MaxIOPS** | number | Yes | read-write | The maximum supported IOs per second that the connection will support for the selected access protocol. | | ||
| + | | \ \ \ \ \ \ **Name** | string | Yes | read-write | A friendly name for this line of service. | | ||
| + | | } ] | | | ||
| === Property Details === | === Property Details === | ||
| Line 1797: | Line 1934: | ||
| Describe io performance capabilities. | Describe io performance capabilities. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **IOLimitingIsSupported** | boolean, null | read-write | Limiting IOPS is supported. | | + | | **IOLimitingIsSupported** | boolean |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Identifier** { | object, null | read-only | The value identifies this resource. | | + | | **Identifier** { | object |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | } | | + | | } | | | |
| - | | **MaxSamplePeriod** | string, null | read-write | Maximum sampling period over which average values are calculated.\\ unit: s | | + | | **MaxSamplePeriod** | string |
| - | | **MinSamplePeriod** | string, null | read-write | Minimum sampling period over which average values are calculated.\\ unit: s | | + | | **MinSamplePeriod** | string |
| - | | **MinSupportedIoOperationLatencyMicroseconds** | number, null | read-write | Minimum supported average IO latency.\\ unit: us | | + | | **MinSupportedIoOperationLatencyMicroseconds** | number |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **SupportedIOPerformanceLinesOfService** [ {} ] | array | read-write | Collection of known and supported IOPerformanceLinesOfService. | | + | | **SupportedIOPerformanceLinesOfService** [ { | array | |
| - | | **SupportedIOWorkloads** [ {} ] | array | read-write | A collection of supported workloads. | | + | | \ \ \ \ \ \ **AverageIOOperationLatencyMicroseconds** | number | Yes | read-write | Expected average IO latency.\\ unit: us | |
| + | | \ \ \ \ \ \ **IOOperationsPerSecondIsLimited** | boolean | Yes | read-write | Limit the IOPS. | | ||
| + | | \ \ \ \ \ \ **IOWorkload** {} | object | Yes | read-write | A description of the expected workload. | | ||
| + | | \ \ \ \ \ \ **MaxIOOperationsPerSecondPerTerabyte** | number | Yes | read-write | The amount of IOPS a volume of a given committed size can support.\\ unit: 1/s/TBy | | ||
| + | | \ \ \ \ \ \ **Name** | string | Yes | read-write | A friendly name for this line of service. | | ||
| + | | \ \ \ \ \ \ **SamplePeriod** | string | Yes | read-write | Sampling period over which average values are calculated. | | ||
| + | | } ] | | | | ||
| + | | **SupportedIOWorkloads** [ { | array | | ||
| + | | \ \ \ \ \ \ **Components** [ {} ] | array | | read-write | An array of IO workload component descriptions. | | ||
| + | | \ \ \ \ \ \ **Name** | string | Yes | read-write | The workload name. | | ||
| + | | } ] | | | ||
| === Property Details === | === Property Details === | ||
| Line 1829: | Line 1976: | ||
| This is the schema definition for the Schema File locator resource. | This is the schema definition for the Schema File locator resource. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Languages** [ {} ] | array | read-only | Language codes for the schemas available. | | + | | **Languages** [ {} ] | array | |
| - | | **Location** [ {} ] | array | read-write | Location information for this schema file. | | + | | **Location** [ { | array | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | \ \ \ \ \ \ **ArchiveFile** | string | | read-only | If the schema is hosted on the service in an archive file, this is the name of the file within the archive. | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | \ \ \ \ \ \ **ArchiveUri** | string | | read-only | If the schema is hosted on the service in an archive file, this is the link to the archive file.\\ format: uri | |
| - | | **Schema** | string | read-only | The @odata.type name this schema describes. | | + | | \ \ \ \ \ \ **Language** | string | | read-only | The language code for the file the schema is in. | |
| + | | \ \ \ \ \ \ **PublicationUri** | string | | read-only | Link to publicly available (canonical) URI for schema.\\ format: uri | | ||
| + | | \ \ \ \ \ \ **Uri** | string | | read-only | Link to locally available URI for schema.\\ format: uri | | ||
| + | | } ] | | | ||
| + | | **Name** | string | ||
| + | | **Oem** {} | object | ||
| + | | **Schema** | string | ||
| ===== JsonSchemaFileCollection ===== | ===== JsonSchemaFileCollection ===== | ||
| Line 1842: | Line 1995: | ||
| A Collection of JsonSchemaFile resource instances. | A Collection of JsonSchemaFile resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== LogEntry ===== | ===== LogEntry ===== | ||
| Line 1852: | Line 2005: | ||
| This resource defines the record format for a log. It is designed to be used for SEL logs (from IPMI) as well as Event Logs and OEM-specific log formats. | This resource defines the record format for a log. It is designed to be used for SEL logs (from IPMI) as well as Event Logs and OEM-specific log formats. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Created** | string | read-only | The time the log entry was created.\\ format: date-time | | + | | **Created** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **EntryCode** | string, null | read-write | If the EntryType is SEL, this will have the entry code for the log entry.\\ | + | | **EntryCode** | string |
| - | | **EntryType** | string | read-write | his is the type of log entry.\\ | + | | **EntryType** | string |
| - | | **EventId** | string | read-only | This is a unique instance identifier of an event. | | + | | **EventId** | string |
| - | | **EventTimestamp** | string | read-only | This is time the event occurred.\\ format: date-time | | + | | **EventTimestamp** | string |
| - | | **EventType** | | read-only | This indicates the type of an event recorded in this log. | | + | | **EventType** |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **OriginOfCondition** |
| - | | } | | + | | } | | | |
| - | | **Message** | string, null | read-only | This property decodes from EntryType: | + | | **Message** | string |
| - | | **MessageArgs** [ {} ] | array | read-only | The values of this property shall be any arguments for the message. | | + | | **MessageArgs** [ {} ] | array | |
| - | | **MessageId** | string | read-only | This property decodes from EntryType: | + | | **MessageId** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **OemRecordFormat** | string, null | read-only | If the entry type is Oem, this will contain more information about the record format from the Oem. | | + | | **OemRecordFormat** | string |
| - | | **SensorNumber** | number, null | read-only | This property decodes from EntryType: | + | | **SensorNumber** | number |
| - | | **SensorType** | string, null | read-write | If the EntryType is SEL, this will have the sensor type that the log entry pertains to.\\ *See Property Details, below, for more information about this property.* | | + | | **SensorType** | string |
| - | | **Severity** | string, null | read-write | This is the severity of the log entry.\\ | + | | **Severity** | string |
| === Property Details === | === Property Details === | ||
| Line 1880: | Line 2033: | ||
| ^ string ^ | ^ string ^ | ||
| - | | Assert | | + | | Assert | |
| - | | Deassert | | + | | Deassert | |
| - | | Lower Non-critical - going low | | + | | Lower Non-critical - going low | |
| - | | Lower Non-critical - going high | | + | | Lower Non-critical - going high | |
| - | | Lower Critical - going low | | + | | Lower Critical - going low | |
| - | | Lower Critical - going high | | + | | Lower Critical - going high | |
| - | | Lower Non-recoverable - going low | | + | | Lower Non-recoverable - going low | |
| - | | Lower Non-recoverable - going high | | + | | Lower Non-recoverable - going high | |
| - | | Upper Non-critical - going low | | + | | Upper Non-critical - going low | |
| - | | Upper Non-critical - going high | | + | | Upper Non-critical - going high | |
| - | | Upper Critical - going low | | + | | Upper Critical - going low | |
| - | | Upper Critical - going high | | + | | Upper Critical - going high | |
| - | | Upper Non-recoverable - going low | | + | | Upper Non-recoverable - going low | |
| - | | Upper Non-recoverable - going high | | + | | Upper Non-recoverable - going high | |
| - | | Transition to Idle | | + | | Transition to Idle | |
| - | | Transition to Active | | + | | Transition to Active | |
| - | | Transition to Busy | | + | | Transition to Busy | |
| - | | State Deasserted | | + | | State Deasserted | |
| - | | State Asserted | | + | | State Asserted | |
| - | | Predictive Failure deasserted | | + | | Predictive Failure deasserted | |
| - | | Predictive Failure asserted | | + | | Predictive Failure asserted | |
| - | | Limit Not Exceeded | | + | | Limit Not Exceeded | |
| - | | Limit Exceeded | | + | | Limit Exceeded | |
| - | | Performance Met | | + | | Performance Met | |
| - | | Performance Lags | | + | | Performance Lags | |
| - | | Transition to OK | | + | | Transition to OK | |
| - | | Transition to Non-Critical from OK | | + | | Transition to Non-Critical from OK | |
| - | | Transition to Critical from less severe | | + | | Transition to Critical from less severe | |
| - | | Transition to Non-recoverable from less severe | | + | | Transition to Non-recoverable from less severe | |
| - | | Transition to Non-Critical from more severe | | + | | Transition to Non-Critical from more severe | |
| - | | Transition to Critical from Non-recoverable | | + | | Transition to Critical from Non-recoverable | |
| - | | Transition to Non-recoverable | | + | | Transition to Non-recoverable | |
| - | | Monitor | | + | | Monitor | |
| - | | Informational | | + | | Informational | |
| - | | Device Removed / Device Absent | | + | | Device Removed / Device Absent | |
| - | | Device Inserted / Device Present | | + | | Device Inserted / Device Present | |
| - | | Device Disabled | | + | | Device Disabled | |
| - | | Device Enabled | | + | | Device Enabled | |
| - | | Transition to Running | | + | | Transition to Running | |
| - | | Transition to In Test | | + | | Transition to In Test | |
| - | | Transition to Power Off | | + | | Transition to Power Off | |
| - | | Transition to On Line | | + | | Transition to On Line | |
| - | | Transition to Off Line | | + | | Transition to Off Line | |
| - | | Transition to Off Duty | | + | | Transition to Off Duty | |
| - | | Transition to Degraded | | + | | Transition to Degraded | |
| - | | Transition to Power Save | | + | | Transition to Power Save | |
| - | | Install Error | | + | | Install Error | |
| - | | Fully Redundant | | + | | Fully Redundant | |
| - | | Redundancy Lost | | + | | Redundancy Lost | |
| - | | Redundancy Degraded | | + | | Redundancy Degraded | |
| - | | Non-redundant: | + | | Non-redundant: |
| - | | Non-redundant: | + | | Non-redundant: |
| - | | Non-redundant: | + | | Non-redundant: |
| - | | Redundancy Degraded from Fully Redundant | | + | | Redundancy Degraded from Fully Redundant | |
| - | | Redundancy Degraded from Non-redundant | | + | | Redundancy Degraded from Non-redundant | |
| - | | D0 Power State | | + | | D0 Power State | |
| - | | D1 Power State | | + | | D1 Power State | |
| - | | D2 Power State | | + | | D2 Power State | |
| - | | D3 Power State | | + | | D3 Power State | |
| == EntryType == | == EntryType == | ||
| ^ string ^ | ^ string ^ | ||
| - | | Event | | + | | Event | |
| - | | SEL | | + | | SEL | |
| - | | Oem | | + | | Oem | |
| == SensorType == | == SensorType == | ||
| ^ string ^ | ^ string ^ | ||
| - | | Platform Security Violation Attempt | | + | | Platform Security Violation Attempt | |
| - | | Temperature | | + | | Temperature | |
| - | | Voltage | | + | | Voltage | |
| - | | Current | | + | | Current | |
| - | | Fan | | + | | Fan | |
| - | | Physical Chassis Security | | + | | Physical Chassis Security | |
| - | | Processor | | + | | Processor | |
| - | | Power Supply / Converter | | + | | Power Supply / Converter | |
| - | | PowerUnit | | + | | PowerUnit | |
| - | | CoolingDevice | | + | | CoolingDevice | |
| - | | Other Units-based Sensor | | + | | Other Units-based Sensor | |
| - | | Memory | | + | | Memory | |
| - | | Drive Slot/Bay | | + | | Drive Slot/Bay | |
| - | | POST Memory Resize | | + | | POST Memory Resize | |
| - | | System Firmware Progress | | + | | System Firmware Progress | |
| - | | Event Logging Disabled | | + | | Event Logging Disabled | |
| - | | System Event | | + | | System Event | |
| - | | Critical Interrupt | | + | | Critical Interrupt | |
| - | | Button/ | + | | Button/ |
| - | | Module/ | + | | Module/ |
| - | | Microcontroller/ | + | | Microcontroller/ |
| - | | Add-in Card | | + | | Add-in Card | |
| - | | Chassis | | + | | Chassis | |
| - | | ChipSet | | + | | ChipSet | |
| - | | Other FRU | | + | | Other FRU | |
| - | | Cable/ | + | | Cable/ |
| - | | Terminator | | + | | Terminator | |
| - | | SystemBoot/ | + | | SystemBoot/ |
| - | | Boot Error | | + | | Boot Error | |
| - | | BaseOSBoot/ | + | | BaseOSBoot/ |
| - | | OS Stop/ | + | | OS Stop/ |
| - | | Slot/ | + | | Slot/ |
| - | | System ACPI PowerState | | + | | System ACPI PowerState | |
| - | | Watchdog | | + | | Watchdog | |
| - | | Platform Alert | | + | | Platform Alert | |
| - | | Entity Presence | | + | | Entity Presence | |
| - | | Monitor ASIC/IC | | + | | Monitor ASIC/IC | |
| - | | LAN | | + | | LAN | |
| - | | Management Subsystem Health | | + | | Management Subsystem Health | |
| - | | Battery | | + | | Battery | |
| - | | Session Audit | | + | | Session Audit | |
| - | | Version Change | | + | | Version Change | |
| - | | FRUState | | + | | FRUState | |
| == Severity == | == Severity == | ||
| ^ string ^ | ^ string ^ | ||
| - | | OK | | + | | OK | |
| - | | Warning | | + | | Warning | |
| - | | Critical | | + | | Critical | |
| Line 2006: | Line 2159: | ||
| A Collection of LogEntry resource instances. | A Collection of LogEntry resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== LogService ===== | ===== LogService ===== | ||
| Line 2016: | Line 2169: | ||
| This resource represents the log service for the resource or service to which it is associated. | This resource represents the log service for the resource or service to which it is associated. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **DateTime** | string, null | read-write | The current DateTime (with offset) for the log service, used to set or read time.\\ format: date-time | | + | | **DateTime** | string |
| - | | **DateTimeLocalOffset** | string, null | read-write | The time offset from UTC that the DateTime property is set to in format: +06:00 .\\ pattern: ([-+][0-1][0-9]: | + | | **DateTimeLocalOffset** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **[[documentation: | + | | **Entries** | reference([[documentation: |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **MaxNumberOfRecords** | number | read-only | The maximum number of log entries this service can have. | | + | | **MaxNumberOfRecords** | number |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **OverWritePolicy** | string | read-write | The overwrite policy for this service that takes place when the log is full.\\ | + | | **OverWritePolicy** | string |
| - | | **ServiceEnabled** | boolean, null | read-write | This indicates whether this service is enabled. | | + | | **ServiceEnabled** | boolean |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| === Property Details === | === Property Details === | ||
| Line 2081: | Line 2234: | ||
| A Collection of LogService resource instances. | A Collection of LogService resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== Manager ===== | ===== Manager ===== | ||
| Line 2091: | Line 2244: | ||
| This is the schema definition for a Manager. | This is the schema definition for a Manager. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **CommandShell** { | object | read-write | Information about the Command Shell service provided by this manager. | | + | | **CommandShell** { | object |
| - | | < | + | | \ \ \ \ \ \ **ConnectTypesSupported** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **MaxConcurrentSessions** | number |
| - | | < | + | | \ \ \ \ \ \ **ServiceEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **DateTime** | string, null | read-write | The current DateTime (with offset) for the manager, used to set or read time.\\ format: date-time | | + | | **DateTime** | string |
| - | | **DateTimeLocalOffset** | string, null | read-write | The time offset from UTC that the DateTime property is set to in format: +06:00 .\\ pattern: ([-+][0-1][0-9]: | + | | **DateTimeLocalOffset** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **[[documentation: | + | | **EthernetInterfaces** | reference([[documentation: |
| - | | **FirmwareVersion** | string, null | read-only | The firmware version of this Manager. | | + | | **FirmwareVersion** | string |
| - | | **GraphicalConsole** { | object | read-write | The value of this property shall contain the information about the Graphical Console (KVM-IP) service of this manager. | | + | | **GraphicalConsole** { | object |
| - | | < | + | | \ \ \ \ \ \ **ConnectTypesSupported** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **MaxConcurrentSessions** | number |
| - | | < | + | | \ \ \ \ \ \ **ServiceEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **[[documentation: | + | | **HostInterfaces** | reference([[documentation: |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **ManagerForChassis** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **ManagerForServers** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **ManagerInChassis** |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **[[documentation: | + | | **LogServices** | reference([[documentation: |
| - | | **ManagerType** | string | read-write | This property represents the type of manager that this resource represents.\\ | + | | **ManagerType** | string |
| - | | **Model** | string, null | read-only | The model information of this Manager as defined by the manufacturer. | | + | | **Model** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **[[documentation: | + | | **NetworkProtocol** | reference([[documentation: |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **PowerState** | string, null | read-write | This is the current power state of the Manager.\\ | + | | **PowerState** | string |
| - | | **Redundancy** [ {} ] | array | read-write | Redundancy information for the managers of this system. | | + | | **Redundancy** [ { | array | |
| - | | **SerialConsole** { | object | read-write | Information about the Serial Console service provided by this manager. | | + | | \ \ \ \ \ \ **MaxNumSupported** | number | Yes | read-only | This is the maximum number of members allowable for this particular redundancy group. | |
| - | | < | + | | \ \ \ \ \ \ **MemberId** | string | | read-write | This is the identifier for the member within the collection. | |
| - | | < | + | | \ \ \ \ \ \ **MinNumNeeded** | number | Yes | read-only | This is the minumum number of members needed for this group to be redundant. | |
| - | | < | + | | \ \ \ \ \ \ **Mode** | string | Yes | read-write | This is the redundancy mode of the group.\\ //See Property Details, below, for more information about this property.// | |
| - | | } | | + | | \ \ \ \ \ \ **Name** | string | | read-only | The name of the resource or array element. | |
| - | | **[[documentation: | + | | \ \ \ \ \ \ **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | **ServiceEntryPointUUID** | string | read-write | The UUID of the Redfish Service provided by this manager.\\ pattern: ([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}) | | + | | \ \ \ \ \ \ **RedundancySet** [ {} ] | array | | read-only | Contains any ids that represent components of this redundancy set. | |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | \ \ \ \ \ \ **Status** {} | object | | read-only | Indicates the status of the file share. | |
| - | | < | + | | \ \ \ \ \ \ **MemberId** | string | | read-only | This is the identifier for the member within the collection. | |
| - | | < | + | | \ \ \ \ \ \ **RedundancyEnabled** | boolean | Yes | read-write | This indicates whether redundancy is enabled. | |
| - | | < | + | | } ] | | |
| - | | < | + | | **SerialConsole** { | object |
| - | | } | | + | | \ \ \ \ \ \ **ConnectTypesSupported** [ {} ] | array | |
| - | | **UUID** | string, null | read-write | The Universal Unique Identifier (UUID) for this Manager.\\ pattern: ([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}) | | + | | \ \ \ \ \ \ **MaxConcurrentSessions** | number |
| - | | **[[documentation: | + | | \ \ \ \ \ \ **ServiceEnabled** | boolean |
| + | | } | | | | ||
| + | | **SerialInterfaces** | reference([[documentation: | ||
| + | | **ServiceEntryPointUUID** | string | ||
| + | | **Status** { | object | ||
| + | | \ \ \ \ \ \ **Health** | string | ||
| + | | \ \ \ \ \ \ **HealthRollup** | string | ||
| + | | \ \ \ \ \ \ **Oem** {} | object | ||
| + | | \ \ \ \ \ \ **State** | string | ||
| + | | } | | | | ||
| + | | **UUID** | string | ||
| + | | **VirtualMedia** | reference([[documentation: | ||
| === Property Details === | === Property Details === | ||
| Line 2206: | Line 2370: | ||
| The user accounts, owned by a Manager, are defined in this resource. | The user accounts, owned by a Manager, are defined in this resource. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Enabled** | boolean | read-write | This property is used by a User Administrator to disable an account w/o having to delet the user information. | + | | **Enabled** | boolean |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **Role** |
| - | | } | | + | | } | | | |
| - | | **Locked** | boolean | read-write | This property indicates that the account has been auto-locked by the account service because the lockout threshold has been exceeded. | + | | **Locked** | boolean |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Password** | string, null | read-write | This property is used with a PATCH or PUT to write the password for the account. | + | | **Password** | string |
| - | | **RoleId** | string | read-write | This property contains the Role for this account. | | + | | **RoleId** | string |
| - | | **UserName** | string | read-write | This property contains the user name for the account. | | + | | **UserName** | string |
| ===== ManagerAccountCollection ===== | ===== ManagerAccountCollection ===== | ||
| Line 2225: | Line 2389: | ||
| A Collection of ManagerAccount resource instances. | A Collection of ManagerAccount resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== ManagerCollection ===== | ===== ManagerCollection ===== | ||
| Line 2235: | Line 2399: | ||
| A Collection of Manager resource instances. | A Collection of Manager resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== ManagerNetworkProtocol ===== | ===== ManagerNetworkProtocol ===== | ||
| Line 2245: | Line 2409: | ||
| This resource is used to obtain or modify the network services managed by a given manager. | This resource is used to obtain or modify the network services managed by a given manager. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **DHCP** { | object | read-write | Settings for this Manager' | + | | **DHCP** { | object |
| - | | < | + | | \ \ \ \ \ \ **Port** | number |
| - | | < | + | | \ \ \ \ \ \ **ProtocolEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **FQDN** | string, null | read-only | This is the fully qualified domain name for the manager obtained by DNS including the host name and top-level domain name. | | + | | **FQDN** | string |
| - | | **HTTP** { | object | read-write | Settings for this Manager' | + | | **HTTP** { | object |
| - | | < | + | | \ \ \ \ \ \ **Port** | number |
| - | | < | + | | \ \ \ \ \ \ **ProtocolEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **HTTPS** { | object | read-write | Settings for this Manager' | + | | **HTTPS** { | object |
| - | | < | + | | \ \ \ \ \ \ **Port** | number |
| - | | < | + | | \ \ \ \ \ \ **ProtocolEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **HostName** | string, null | read-only | The DNS Host Name of this manager, without any domain information. | | + | | **HostName** | string |
| - | | **IPMI** { | object | read-write | Settings for this Manager' | + | | **IPMI** { | object |
| - | | < | + | | \ \ \ \ \ \ **Port** | number |
| - | | < | + | | \ \ \ \ \ \ **ProtocolEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **KVMIP** { | object | read-write | Settings for this Manager' | + | | **KVMIP** { | object |
| - | | < | + | | \ \ \ \ \ \ **Port** | number |
| - | | < | + | | \ \ \ \ \ \ **ProtocolEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **SNMP** { | object | read-write | Settings for this Manager' | + | | **SNMP** { | object |
| - | | < | + | | \ \ \ \ \ \ **Port** | number |
| - | | < | + | | \ \ \ \ \ \ **ProtocolEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **SSDP** { | object | read-write | Settings for this Manager' | + | | **SSDP** { | object |
| - | | < | + | | \ \ \ \ \ \ **NotifyIPv6Scope** | string |
| - | | < | + | | \ \ \ \ \ \ **NotifyMulticastIntervalSeconds** | number |
| - | | < | + | | \ \ \ \ \ \ **NotifyTTL** | number |
| - | | < | + | | \ \ \ \ \ \ **Port** | number |
| - | | < | + | | \ \ \ \ \ \ **ProtocolEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **SSH** { | object | read-write | Settings for this Manager' | + | | **SSH** { | object |
| - | | < | + | | \ \ \ \ \ \ **Port** | number |
| - | | < | + | | \ \ \ \ \ \ **ProtocolEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| - | | **Telnet** { | object | read-write | Settings for this Manager' | + | | **Telnet** { | object |
| - | | < | + | | \ \ \ \ \ \ **Port** | number |
| - | | < | + | | \ \ \ \ \ \ **ProtocolEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **VirtualMedia** { | object | read-write | Settings for this Manager' | + | | **VirtualMedia** { | object |
| - | | < | + | | \ \ \ \ \ \ **Port** | number |
| - | | < | + | | \ \ \ \ \ \ **ProtocolEnabled** | boolean |
| - | | } | | + | | } | | | |
| === Property Details === | === Property Details === | ||
| Line 2345: | Line 2509: | ||
| This is the schema definition for definition of a Memory and its configuration. | This is the schema definition for definition of a Memory and its configuration. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **AllowedSpeedsMHz** [ {} ] | array | read-only | Speed bins supported by this Memory. | | + | | **AllowedSpeedsMHz** [ {} ] | array | |
| - | | **BaseModuleType** | string, null | read-write | The base module type of Memory.\\ | + | | **BaseModuleType** | string |
| - | | **BusWidthBits** | number, null | read-only | Bus Width in bits. | | + | | **BusWidthBits** | number |
| - | | **CapacityMiB** | number, null | read-only | Memory Capacity in MiB.\\ unit: MiBy | | + | | **CapacityMiB** | number |
| - | | **DataWidthBits** | number, null | read-only | Data Width in bits. | | + | | **DataWidthBits** | number |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **DeviceID** | string, null | read-only | Device ID. | | + | | **DeviceID** | string |
| - | | **DeviceLocator** | string, null | read-only | Location of the Memory in the platform. | | + | | **DeviceLocator** | string |
| - | | **ErrorCorrection** | string, null | read-write | Error correction scheme supported for this memory.\\ | + | | **ErrorCorrection** | string |
| - | | **FirmwareApiVersion** | string, null | read-only | Version of API supported by the firmware. | | + | | **FirmwareApiVersion** | string |
| - | | **FirmwareRevision** | string, null | read-only | Revision of firmware on the Memory controller. | | + | | **FirmwareRevision** | string |
| - | | **FunctionClasses** [ {} ] | array | read-only | Function Classes by the Memory. | | + | | **FunctionClasses** [ {} ] | array | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **IsRankSpareEnabled** | boolean, null | read-only | Rank spare enabled status. | | + | | **IsRankSpareEnabled** | boolean |
| - | | **IsSpareDeviceEnabled** | boolean, null | read-only | Spare device enabled status. | | + | | **IsSpareDeviceEnabled** | boolean |
| - | | **Manufacturer** | string, null | read-only | The Memory manufacturer. | | + | | **Manufacturer** | string |
| - | | **MaxTDPMilliWatts** [ {} ] | array | read-only | Maximum TDPs in milli Watts. | | + | | **MaxTDPMilliWatts** [ {} ] | array | |
| - | | **MemoryDeviceType** | string, null | read-write | Type details of the Memory.\\ | + | | **MemoryDeviceType** | string |
| - | | **MemoryLocation** { | object | read-write | Memory connection information to sockets and memory controllers. | | + | | **MemoryLocation** { | object |
| - | | < | + | | \ \ \ \ \ \ **Channel** | number |
| - | | < | + | | \ \ \ \ \ \ **MemoryController** | number |
| - | | < | + | | \ \ \ \ \ \ **Slot** | number |
| - | | < | + | | \ \ \ \ \ \ **Socket** | number |
| - | | } | | + | | } | | | |
| - | | **MemoryMedia** [ {} ] | array | read-only | Media of this Memory. | | + | | **MemoryMedia** [ {} ] | array | |
| - | | **MemoryType** | string, null | read-write | The type of Memory.\\ | + | | **MemoryType** | string |
| - | | **[[documentation: | + | | **Metrics** | reference([[documentation: |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **OperatingMemoryModes** [ {} ] | array | read-only | Memory modes supported by the Memory. | | + | | **OperatingMemoryModes** [ {} ] | array | |
| - | | **OperatingSpeedMhz** | number, null | read-only | Operating speed of Memory in MHz. | | + | | **OperatingSpeedMhz** | number |
| - | | **PartNumber** | string, null | read-only | The product part number of this device. | | + | | **PartNumber** | string |
| - | | **PersistentRegionSizeLimitMiB** | number, null | read-only | Total size of persistent regions in MiB. | | + | | **PersistentRegionSizeLimitMiB** | number |
| - | | **PowerManagementPolicy** { | object | read-write | Power management policy information. | | + | | **PowerManagementPolicy** { | object |
| - | | < | + | | \ \ \ \ \ \ **AveragePowerBudgetMilliWatts** | number |
| - | | < | + | | \ \ \ \ \ \ **MaxTDPMilliWatts** | number |
| - | | < | + | | \ \ \ \ \ \ **PeakPowerBudgetMilliWatts** | number |
| - | | < | + | | \ \ \ \ \ \ **PolicyEnabled** | boolean |
| - | | } | | + | | } | | | |
| - | | **RankCount** | number, null | read-only | Number of ranks available in the Memory. | | + | | **RankCount** | number |
| - | | **Regions** [ {} ] | array | read-write | Memory regions information within the Memory. | | + | | **Regions** [ { | array | |
| - | | **SecurityCapabilities** { | object | read-write | This object contains security capabilities of the Memory. | | + | | \ \ \ \ \ \ **MemoryClassification** | string | Yes | read-write | Classification of memory occupied by the given memory region.\\ //See Property Details, below, for more information about this property.// | |
| - | | < | + | | \ \ \ \ \ \ **OffsetMiB** | number | Yes | read-only | Offset with in the Memory that corresponds to the starting of this memory region in MiB.\\ unit: MiBy | |
| - | | < | + | | \ \ \ \ \ \ **PassphraseState** | boolean | Yes | read-only | State of the passphrase for this region. | |
| - | | < | + | | \ \ \ \ \ \ **RegionId** | string | Yes | read-only | Unique region ID representing a specific region within the Memory. | |
| - | | } | | + | | \ \ \ \ \ \ **SizeMiB** | number | Yes | read-only | Size of this memory region in MiB.\\ unit: MiBy | |
| - | | **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. | | + | | **SecurityCapabilities** { | object |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | \ \ \ \ \ \ **MaxPassphraseCount** | number |
| - | | < | + | | \ \ \ \ \ \ **PassphraseCapable** | boolean |
| - | | < | + | | \ \ \ \ \ \ **SecurityStates** [ {} ] | array | |
| - | | < | + | | } | | | |
| - | | < | + | | **SerialNumber** | string |
| - | | } | | + | | **SpareDeviceCount** | number |
| - | | **SubsystemDeviceID** | string, null | read-only | Subsystem Device ID. | | + | | **Status** { | object |
| - | | **SubsystemVendorID** | string, null | read-only | SubSystem Vendor ID. | | + | | \ \ \ \ \ \ **Health** | string |
| - | | **VendorID** | string, null | read-only | Vendor ID. | | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | **VolatileRegionSizeLimitMiB** | number, null | read-only | Total size of volatile regions in MiB. | | + | | \ \ \ \ \ \ **Oem** {} | object |
| + | | \ \ \ \ \ \ **State** | string | ||
| + | | } | | | | ||
| + | | **SubsystemDeviceID** | string | ||
| + | | **SubsystemVendorID** | string | ||
| + | | **VendorID** | string | ||
| + | | **VolatileRegionSizeLimitMiB** | number | ||
| === Property Details === | === Property Details === | ||
| Line 2508: | Line 2678: | ||
| This is the schema definition of a Memory Chunk and its configuration. | This is the schema definition of a Memory Chunk and its configuration. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AddressRangeType** | string, null | read-write | Memory type of this memory chunk.\\ | + | | **AddressRangeType** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **InterleaveSets** [ {} ] | array | read-write | This is the interleave sets for the memory chunk. | | + | | **InterleaveSets** [ { | array | |
| - | | **IsMirrorEnabled** | boolean, null | read-only | Mirror Enabled status. | | + | | \ \ \ \ \ \ **Memory** {} | object | | read-write | Describes a memory device of the interleave set. | |
| - | | **IsSpare** | boolean, null | read-only | Spare enabled status. | | + | | \ \ \ \ \ \ **MemoryLevel** | number | Yes | read-only | Level of the interleave set for multi-level tiered memory. | |
| - | | **MemoryChunkSizeMiB** | number, null | read-only | Size of the memory chunk in MiB. | | + | | \ \ \ \ \ \ **OffsetMiB** | number | Yes | read-only | Offset within the DIMM that corresponds to the start of this memory region, with units in MiB. | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | \ \ \ \ \ \ **RegionId** | string | Yes | read-only | DIMM region identifier. | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | \ \ \ \ \ \ **SizeMiB** | number | Yes | read-only | Size of this memory region in MiB. | |
| + | | } ] | | | ||
| + | | **IsMirrorEnabled** | boolean | ||
| + | | **IsSpare** | boolean | ||
| + | | **MemoryChunkSizeMiB** | number | ||
| + | | **Name** | string | ||
| + | | **Oem** {} | object | ||
| === Property Details === | === Property Details === | ||
| Line 2533: | Line 2709: | ||
| A Collection of MemoryChunks resource instances. | A Collection of MemoryChunks resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== MemoryCollection ===== | ===== MemoryCollection ===== | ||
| Line 2543: | Line 2719: | ||
| A Collection of Memory resource instances. | A Collection of Memory resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== MemoryDomain ===== | ===== MemoryDomain ===== | ||
| Line 2553: | Line 2729: | ||
| This is the schema definition of a Memory Domain and its configuration. Memory Domains are used to indicate to the client which Memory (DIMMs) can be grouped together in Memory Chunks to form interleave sets or otherwise grouped together. | This is the schema definition of a Memory Domain and its configuration. Memory Domains are used to indicate to the client which Memory (DIMMs) can be grouped together in Memory Chunks to form interleave sets or otherwise grouped together. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AllowsBlockProvisioning** | boolean, null | read-only | Indicates if this Memory Domain supports the provisioning of blocks of memory. | | + | | **AllowsBlockProvisioning** | boolean |
| - | | **AllowsMemoryChunkCreation** | boolean, null | read-only | Indicates if this Memory Domain supports the creation of Memory Chunks. | | + | | **AllowsMemoryChunkCreation** | boolean |
| - | | **AllowsMirroring** | boolean, null | read-only | Indicates if this Memory Domain supports the creation of Memory Chunks with mirroring enabled. | | + | | **AllowsMirroring** | boolean |
| - | | **AllowsSparing** | boolean, null | read-only | Indicates if this Memory Domain supports the creation of Memory Chunks with sparing enabled. | | + | | **AllowsSparing** | boolean |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **InterleavableMemorySets** [ {} ] | array | read-write | This is the interleave sets for the memory chunk. | | + | | **InterleavableMemorySets** [ { | array | |
| - | | **[[documentation: | + | | \ \ \ \ \ \ **MemorySet** [ {} ] | array | | read-only | This is the collection of memory for a particular interleave set. | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | } ] | | | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **MemoryChunks** | object | Yes | read-write | A reference to the collection of Memory Chunks associated with this Memory Domain. | |
| + | | **Name** | string | ||
| + | | **Oem** {} | object | ||
| ===== MemoryDomainCollection ===== | ===== MemoryDomainCollection ===== | ||
| Line 2569: | Line 2747: | ||
| A Collection of MemoryDomain resource instances. | A Collection of MemoryDomain resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== MemoryMetrics ===== | ===== MemoryMetrics ===== | ||
| Line 2579: | Line 2757: | ||
| MemoryMetrics contains usage and health statistics for a single Memory module or device instance. | MemoryMetrics contains usage and health statistics for a single Memory module or device instance. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **BlockSizeBytes** | number, null | read-only | Block size in bytes.\\ unit: By | | + | | **BlockSizeBytes** | number |
| - | | **CurrentPeriod** { | object | read-write | This object describes the central memory of the system in general detail. | | + | | **CurrentPeriod** { | object |
| - | | < | + | | \ \ \ \ \ \ **BlocksRead** | number |
| - | | < | + | | \ \ \ \ \ \ **BlocksWritten** | string |
| - | | } | | + | | } | | | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **HealthData** { | object | read-write | This object describes the central memory of the system in general detail. | | + | | **HealthData** { | object |
| - | | < | + | | \ \ \ \ \ \ **AlarmTrips** {} | object |
| - | | < | + | | \ \ \ \ \ \ **DataLossDetected** | boolean |
| - | | < | + | | \ \ \ \ \ \ **LastShutdownSuccess** | boolean |
| - | | < | + | | \ \ \ \ \ \ **PerformanceDegraded** | boolean |
| - | | < | + | | \ \ \ \ \ \ **PredictedMediaLifeLeftPercent** | number |
| - | | < | + | | \ \ \ \ \ \ **RemainingSpareBlockPercentage** | number |
| - | | } | | + | | } | | | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **LifeTime** { | object | read-write | This object describes the central memory of the system in general detail. | | + | | **LifeTime** { | object |
| - | | < | + | | \ \ \ \ \ \ **BlocksRead** | number |
| - | | < | + | | \ \ \ \ \ \ **BlocksWritten** | string |
| - | | } | | + | | } | | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== MessageRegistry ===== | ===== MessageRegistry ===== | ||
| Line 2610: | Line 2788: | ||
| This is the schema definition for all Message Registries. | This is the schema definition for all Message Registries. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Language** | string | read-only | This is the RFC 5646 compliant language code for the registry. | | + | | **Language** | string |
| - | | **Messages** {} | object | read-write | The pattern property indicates that a free-form string is the unique identifier for the message within the registry. | | + | | **Messages** {} | object |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **OwningEntity** | string | read-only | This is the organization or company that publishes this registry. | | + | | **OwningEntity** | string |
| - | | **RegistryPrefix** | string | read-only | This is the single word prefix used to form a messageID structure. | | + | | **RegistryPrefix** | string |
| - | | **RegistryVersion** | string | read-only | This is the message registry version which is used in the middle portion of a messageID. | | + | | **RegistryVersion** | string |
| ===== MessageRegistryCollection ===== | ===== MessageRegistryCollection ===== | ||
| Line 2625: | Line 2803: | ||
| A Collection of MessageRegistry resource instances. | A Collection of MessageRegistry resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== MessageRegistryFile ===== | ===== MessageRegistryFile ===== | ||
| Line 2635: | Line 2813: | ||
| This is the schema definition for the Schema File locator resource. | This is the schema definition for the Schema File locator resource. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Languages** [ {} ] | array | read-only | Language codes for the schemas available. | | + | | **Languages** [ {} ] | array | |
| - | | **Location** [ {} ] | array | read-write | Location information for this schema file. | | + | | **Location** [ { | array | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | \ \ \ \ \ \ **ArchiveFile** | string | | read-only | If the schema is hosted on the service in an archive file, this is the name of the file within the archive. | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | \ \ \ \ \ \ **ArchiveUri** | string | | read-only | If the schema is hosted on the service in an archive file, this is the link to the archive file.\\ format: uri | |
| - | | **Registry** | string | read-only | The Registry Name, Major and Minor version used in MessageID construction. | | + | | \ \ \ \ \ \ **Language** | string | | read-only | The language code for the file the schema is in. | |
| + | | \ \ \ \ \ \ **PublicationUri** | string | | read-only | Link to publicly available (canonical) URI for schema.\\ format: uri | | ||
| + | | \ \ \ \ \ \ **Uri** | string | | read-only | Link to locally available URI for schema.\\ format: uri | | ||
| + | | } ] | | | ||
| + | | **Name** | string | ||
| + | | **Oem** {} | object | ||
| + | | **Registry** | string | ||
| ===== MessageRegistryFileCollection ===== | ===== MessageRegistryFileCollection ===== | ||
| Line 2648: | Line 2832: | ||
| A Collection of MessageRegistryFile resource instances. | A Collection of MessageRegistryFile resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== NetworkAdapter ===== | ===== NetworkAdapter ===== | ||
| Line 2658: | Line 2842: | ||
| A NetworkAdapter represents the physical network adapter capable of connecting to a computer network. | A NetworkAdapter represents the physical network adapter capable of connecting to a computer network. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **Controllers** [ {} ] | array | read-write | The set of network controllers ASICs that make up this NetworkAdapter. | | + | | **Controllers** [ { | array | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | \ \ \ \ \ \ **ControllerCapabilities** {} | object | Yes | read-write | The capabilities of this controller. | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | \ \ \ \ \ \ **FirmwarePackageVersion** | string | Yes | read-only | The version of the user-facing firmware package. | |
| - | | **Manufacturer** | string, null | read-only | The manufacturer or OEM of this network adapter. | | + | | \ \ \ \ \ \ **Links** {} | object | | read-write | Links. | |
| - | | **Model** | string, null | read-only | The model string for this network adapter. | | + | | } ] | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Description** | string |
| - | | **[[documentation: | + | | **Id** | string |
| - | | **[[documentation: | + | | **Manufacturer** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Model** | string |
| - | | **PartNumber** | string, null | read-only | Part number for this network adapter. | | + | | **Name** | string |
| - | | **SKU** | string, null | read-only | The manufacturer SKU for this network adapter. | | + | | **NetworkDeviceFunctions** | reference([[documentation: |
| - | | **SerialNumber** | string, null | read-only | The serial number for this network adapter. | | + | | **NetworkPorts** | reference([[documentation: |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | **Oem** {} | object |
| - | | < | + | | **PartNumber** | string |
| - | | < | + | | **SKU** | string |
| - | | < | + | | **SerialNumber** | string |
| - | | < | + | | **Status** { | object |
| - | | } | | + | | \ \ \ \ \ \ **Health** | string |
| + | | \ \ \ \ \ \ **HealthRollup** | string | ||
| + | | \ \ \ \ \ \ **Oem** {} | object | ||
| + | | \ \ \ \ \ \ **State** | string | ||
| + | | } | | | | ||
| === Property Details === | === Property Details === | ||
| Line 2718: | Line 2906: | ||
| A Collection of NetworkAdapter resource instances. | A Collection of NetworkAdapter resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== NetworkDeviceFunction ===== | ===== NetworkDeviceFunction ===== | ||
| Line 2728: | Line 2916: | ||
| A Network Device Function represents a logical interface exposed by the network adapter. | A Network Device Function represents a logical interface exposed by the network adapter. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AssignablePhysicalPorts** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **AssignablePhysicalPorts** |
| - | | **BootMode** | string, null | read-write | The boot mode configured for this network device function.\\ | + | | **BootMode** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **DeviceEnabled** | boolean, null | read-write | Whether the network device function is enabled. | | + | | **DeviceEnabled** | boolean |
| - | | **Ethernet** { | object, null | read-write | Ethernet. | | + | | **Ethernet** { | object |
| - | | < | + | | \ \ \ \ \ \ **MACAddress** | string |
| - | | < | + | | \ \ \ \ \ \ **MTUSize** | number |
| - | | < | + | | \ \ \ \ \ \ **PermanentMACAddress** | string |
| - | | } | | + | | } | | | |
| - | | **FibreChannel** { | object, null | read-write | Fibre Channel. | | + | | **FibreChannel** { | object |
| - | | < | + | | \ \ \ \ \ \ **AllowFIPVLANDiscovery** | boolean |
| - | | < | + | | \ \ \ \ \ \ **BootTargets** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **FCoEActiveVLANId** | number |
| - | | < | + | | \ \ \ \ \ \ **FCoELocalVLANId** | number |
| - | | < | + | | \ \ \ \ \ \ **PermanentWWNN** | string |
| - | | < | + | | \ \ \ \ \ \ **PermanentWWPN** | string |
| - | | < | + | | \ \ \ \ \ \ **WWNN** | string |
| - | | < | + | | \ \ \ \ \ \ **WWNSource** | string |
| - | | < | + | | \ \ \ \ \ \ **WWPN** | string |
| - | | } | | + | | } | | | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Links** { | object | read-write | Links. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **PCIeFunction** |
| - | | } | | + | | } | | | |
| - | | **MaxVirtualFunctions** | number, null | read-only | The number of virtual functions (VFs) that are available for this Network Device Function. | | + | | **MaxVirtualFunctions** | number |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **NetDevFuncCapabilities** [ {} ] | array | read-only | Capabilities of this network device function. | | + | | **NetDevFuncCapabilities** [ {} ] | array | |
| - | | **NetDevFuncType** | string, null | read-write | The configured capability of this network device function.\\ | + | | **NetDevFuncType** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **[[documentation: | + | | **PhysicalPortAssignment** | reference([[documentation: |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| - | | **VirtualFunctionsEnabled** | boolean, null | read-only | Whether Single Root I/O Virtualization (SR-IOV) Virual Functions (VFs) are enabled for this Network Device Function. | | + | | **VirtualFunctionsEnabled** | boolean |
| - | | **iSCSIBoot** { | object, null | read-write | iSCSI Boot. | | + | | **iSCSIBoot** { | object |
| - | | < | + | | \ \ \ \ \ \ **AuthenticationMethod** | string |
| - | | < | + | | \ \ \ \ \ \ **CHAPSecret** | string |
| - | | < | + | | \ \ \ \ \ \ **CHAPUsername** | string |
| - | | < | + | | \ \ \ \ \ \ **IPAddressType** | string |
| - | | < | + | | \ \ \ \ \ \ **IPMaskDNSViaDHCP** | boolean |
| - | | < | + | | \ \ \ \ \ \ **InitiatorDefaultGateway** | string |
| - | | < | + | | \ \ \ \ \ \ **InitiatorIPAddress** | string |
| - | | < | + | | \ \ \ \ \ \ **InitiatorName** | string |
| - | | < | + | | \ \ \ \ \ \ **InitiatorNetmask** | string |
| - | | < | + | | \ \ \ \ \ \ **MutualCHAPSecret** | string |
| - | | < | + | | \ \ \ \ \ \ **MutualCHAPUsername** | string |
| - | | < | + | | \ \ \ \ \ \ **PrimaryDNS** | string |
| - | | < | + | | \ \ \ \ \ \ **PrimaryLUN** | number |
| - | | < | + | | \ \ \ \ \ \ **PrimaryTargetIPAddress** | string |
| - | | < | + | | \ \ \ \ \ \ **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 |
| - | | } | | + | | } | | | |
| === Property Details === | === Property Details === | ||
| Line 2898: | Line 3086: | ||
| A Collection of NetworkDeviceFunction resource instances. | A Collection of NetworkDeviceFunction resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== NetworkInterface ===== | ===== NetworkInterface ===== | ||
| Line 2908: | Line 3096: | ||
| A NetworkInterface contains references linking NetworkAdapter, | A NetworkInterface contains references linking NetworkAdapter, | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Links** { | object | read-write | Links. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **NetworkAdapter** |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **[[documentation: | + | | **NetworkDeviceFunctions** | reference([[documentation: |
| - | | **[[documentation: | + | | **NetworkPorts** | reference([[documentation: |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| === Property Details === | === Property Details === | ||
| Line 2962: | Line 3150: | ||
| A Collection of NetworkInterface resource instances. | A Collection of NetworkInterface resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== NetworkPort ===== | ===== NetworkPort ===== | ||
| Line 2972: | Line 3160: | ||
| A Network Port represents a discrete physical port capable of connecting to a network. | A Network Port represents a discrete physical port capable of connecting to a network. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **ActiveLinkTechnology** | string, null | read-write | Network Port Active Link Technology.\\ | + | | **ActiveLinkTechnology** | string |
| - | | **AssociatedNetworkAddresses** [ {} ] | array | read-only | The array of configured network addresses (MAC or WWN) that are associated with this Network Port, including the programmed address of the lowest numbered Network Device Function, the configured but not active address if applicable, the address for hardware port teaming, or other network addresses. | | + | | **AssociatedNetworkAddresses** [ {} ] | array | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **EEEEnabled** | boolean, null | read-write | Whether IEEE 802.3az Energy Efficient Ethernet (EEE) is enabled for this network port. | | + | | **EEEEnabled** | boolean |
| - | | **FlowControlConfiguration** | string, null | read-write | The locally configured 802.3x flow control setting for this network port.\\ | + | | **FlowControlConfiguration** | string |
| - | | **FlowControlStatus** | string, null | read-write | The 802.3x flow control behavior negotiated with the link partner for this network port (Ethernet-only).\\ | + | | **FlowControlStatus** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **LinkStatus** | string, null | read-write | The status of the link between this port and its link partner.\\ | + | | **LinkStatus** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **NetDevFuncMaxBWAlloc** [ {} ] | array | read-write | The array of maximum bandwidth allocation percentages for the Network Device Functions associated with this port. | | + | | **NetDevFuncMaxBWAlloc** [ { | array | |
| - | | **NetDevFuncMinBWAlloc** [ {} ] | array | read-write | The array of minimum bandwidth allocation percentages for the Network Device Functions associated with this port. | | + | | \ \ \ \ \ \ **MaxBWAllocPercent** | number | Yes | read-write | The maximum bandwidth allocation percentage allocated to the corresponding network device function instance. | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | \ \ \ \ \ \ **NetworkDeviceFunction** {} | object | | read-write | Contains the members of this collection. | |
| - | | **PhysicalPortNumber** | string, null | read-only | The physical port number label for this port. | | + | | } ] | | | |
| - | | **PortMaximumMTU** | number, null | read-only | The largest maximum transmission unit (MTU) that can be configured for this network port. | | + | | **NetDevFuncMinBWAlloc** [ { | array | |
| - | | **SignalDetected** | boolean, null | read-only | Whether or not the port has detected enough signal on enough lanes to establish link. | | + | | \ \ \ \ \ \ **MinBWAllocPercent** | number | Yes | read-write | The minimum bandwidth allocation percentage allocated to the corresponding network device function instance. | |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | \ \ \ \ \ \ **NetworkDeviceFunction** {} | object | | read-write | Contains the members of this collection. | |
| - | | < | + | | } ] | | |
| - | | < | + | | **Oem** {} | object |
| - | | < | + | | **PhysicalPortNumber** | string |
| - | | < | + | | **PortMaximumMTU** | number |
| - | | } | | + | | **SignalDetected** | boolean |
| - | | **SupportedEthernetCapabilities** [ {} ] | array | read-only | The set of Ethernet capabilities that this port supports. | | + | | **Status** { | object |
| - | | **SupportedLinkCapabilities** [ {} ] | array | read-write | The self-described link capabilities of this port. | | + | | \ \ \ \ \ \ **Health** | string |
| - | | **WakeOnLANEnabled** | boolean, null | read-write | Whether Wake on LAN (WoL) is enabled for this network port. | | + | | \ \ \ \ \ \ **HealthRollup** | string |
| + | | \ \ \ \ \ \ **Oem** {} | object | ||
| + | | \ \ \ \ \ \ **State** | string | ||
| + | | } | | | | ||
| + | | **SupportedEthernetCapabilities** [ {} ] | array | | ||
| + | | **SupportedLinkCapabilities** [ { | array | | ||
| + | | \ \ \ \ \ \ **LinkNetworkTechnology** | string | Yes | read-write | The self-described link network technology capabilities of this port.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **LinkSpeedMbps** | number | Yes | read-only | The speed of the link in Mbps when this link network technology is active. | | ||
| + | | } ] | | | ||
| + | | **WakeOnLANEnabled** | boolean | ||
| === Property Details === | === Property Details === | ||
| Line 3070: | Line 3267: | ||
| A Collection of NetworkPort resource instances. | A Collection of NetworkPort resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== PCIeDevice ===== | ===== PCIeDevice ===== | ||
| Line 3080: | Line 3277: | ||
| This is the schema definition for the PCIeDevice resource. | This is the schema definition for the PCIeDevice resource. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AssetTag** | string, null | read-write | The user assigned asset tag for this PCIe device. | | + | | **AssetTag** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **DeviceType** | string | read-write | The device type for this PCIe device.\\ | + | | **DeviceType** | string |
| - | | **FirmwareVersion** | string, null | read-only | The version of firmware for this PCIe device. | | + | | **FirmwareVersion** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Links** { | object | read-write | The links object contains the links to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Chassis** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **PCIeFunctions** [ {} ] | array | |
| - | | } | | + | | } | | | |
| - | | **Manufacturer** | string, null | read-only | This is the manufacturer of this PCIe device. | | + | | **Manufacturer** | string |
| - | | **Model** | string, null | read-only | This is the model number for the PCIe device. | | + | | **Model** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **PartNumber** | string, null | read-only | The part number for this PCIe device. | | + | | **PartNumber** | string |
| - | | **SKU** | string, null | read-only | This is the SKU for this PCIe device. | | + | | **SKU** | string |
| - | | **SerialNumber** | string, null | read-only | The serial number for this PCIe device. | | + | | **SerialNumber** | string |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| === Property Details === | === Property Details === | ||
| Line 3148: | Line 3345: | ||
| This is the schema definition for the PCIeFunction resource. | This is the schema definition for the PCIeFunction resource. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **ClassCode** | string, null | read-only | The Class Code of this PCIe function.\\ pattern: / | + | | **ClassCode** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **DeviceClass** | string | read-write | The class for this PCIe Function.\\ | + | | **DeviceClass** | string |
| - | | **DeviceId** | string, null | read-only | The Device ID of this PCIe function.\\ pattern: / | + | | **DeviceId** | string |
| - | | **FunctionId** | number, null | read-only | The the PCIe Function identifier. | | + | | **FunctionId** | number |
| - | | **FunctionType** | string | read-write | The type of the PCIe Function.\\ | + | | **FunctionType** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Links** { | object | read-write | The links object contains the links to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Drives** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **EthernetInterfaces** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **PCIeDevice** |
| - | | < | + | | \ \ \ \ \ \ **StorageControllers** [ {} ] | array | |
| - | | } | | + | | } | | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **RevisionId** | string, null | read-only | The Revision ID of this PCIe function.\\ pattern: / | + | | **RevisionId** | string |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| - | | **SubsystemId** | string, null | read-only | The Subsystem ID of this PCIe function.\\ pattern: / | + | | **SubsystemId** | string |
| - | | **SubsystemVendorId** | string, null | read-only | The Subsystem Vendor ID of this PCIe function.\\ pattern: / | + | | **SubsystemVendorId** | string |
| - | | **VendorId** | string, null | read-only | The Vendor ID of this PCIe function.\\ pattern: / | + | | **VendorId** | string |
| === Property Details === | === Property Details === | ||
| Line 3245: | Line 3442: | ||
| Port contains properties describing a port of a switch. | Port contains properties describing a port of a switch. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **CurrentSpeedGbps** | number, null | read-only | The current speed of this port.\\ unit: Gbit/s | | + | | **CurrentSpeedGbps** | number |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **AssociatedEndpoints** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **ConnectedSwitchPorts** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **ConnectedSwitches** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **MaxSpeedGbps** | number, null | read-only | The maximum speed of this port as currently configured.\\ unit: Gbit/s | | + | | **MaxSpeedGbps** | number |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **PortId** | string, null | read-only | This is the label of this port on the physical switch package. | | + | | **PortId** | string |
| - | | **PortProtocol** | null | read-write | The protocol being sent over this port. | | + | | **PortProtocol** | | Yes | read-write | The protocol being sent over this port. | |
| - | | **PortType** | string, null | read-write | This is the type of this port.\\ | + | | **PortType** | string |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| - | | **Width** | number, null | read-only | The number of lanes, phys, or other physical transport links that this port contains. | | + | | **Width** | number |
| === Property Details === | === Property Details === | ||
| Line 3319: | Line 3516: | ||
| A Collection of Port resource instances. | A Collection of Port resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== Power ===== | ===== Power ===== | ||
| Line 3329: | Line 3526: | ||
| This is the schema definition for the Power Metrics. | This is the schema definition for the Power Metrics. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **PowerControl** [ {} ] | array | read-write | This is the definition for power control function (power reading/ | + | | **PowerControl** [ { | array | |
| - | | **PowerSupplies** [ {} ] | array | read-write | Details of the power supplies associated with this system or device. | | + | | \ \ \ \ \ \ **MemberId** | string | | read-only | This is the identifier for the member within the collection. | |
| - | | **Redundancy** [ {} ] | array | read-write | Redundancy information for the power subsystem of this system or device. | | + | | \ \ \ \ \ \ **Name** | string | Yes | read-only | Power Control Function name. | |
| - | | **Voltages** [ {} ] | array | read-write | This is the definition for voltage sensors. | | + | | \ \ \ \ \ \ **Oem** {} | object | | read-write | This is the manufacturer/ |
| + | | \ \ \ \ \ \ **PowerAllocatedWatts** | number | Yes | read-only | The total amount of power that has been allocated (or budegeted)to | ||
| + | | \ \ \ \ \ \ **PowerAvailableWatts** | number | Yes | read-only | The amount of power not already budgeted and therefore available for additional allocation. (powerCapacity - powerAllocated). | ||
| + | | \ \ \ \ \ \ **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 | Yes | read-only | The actual power being consumed by the chassis.\\ unit: W | | ||
| + | | \ \ \ \ \ \ **PowerLimit** {} | object | | read-write | Power limit status and configuration information for this chassis. | | ||
| + | | \ \ \ \ \ \ **PowerMetrics** {} | object | | read-write | Power readings for this chassis. | | ||
| + | | \ \ \ \ \ \ **PowerRequestedWatts** | number | Yes | read-only | The potential power that the chassis resources are requesting which may be higher than the current level being consumed since requested power includes budget that the chassis resource wants for future use.\\ unit: W | | ||
| + | | \ \ \ \ \ \ **RelatedItem** [ {} ] | array | | read-only | The ID(s) of the resources associated with this Power Limit. | | ||
| + | | \ \ \ \ \ \ **Status** {} | object | | read-only | Indicates the status of the file share. | | ||
| + | | } ] | | | | ||
| + | | **PowerSupplies** [ { | array | | ||
| + | | \ \ \ \ \ \ **FirmwareVersion** | string | Yes | read-only | The firmware version for this Power Supply. | | ||
| + | | \ \ \ \ \ \ **IndicatorLED** | string | Yes | read-write | The state of the indicator LED, used to identify the power supply.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **InputRanges** [ {} ] | array | | read-write | This is the input ranges that the power supply can use. | | ||
| + | | \ \ \ \ \ \ **LastPowerOutputWatts** | number | Yes | read-only | The average power output of this Power Supply.\\ unit: W | | ||
| + | | \ \ \ \ \ \ **LineInputVoltage** | number | Yes | read-only | The line input voltage at which the Power Supply is operating.\\ unit: V | | ||
| + | | \ \ \ \ \ \ **LineInputVoltageType** | string | Yes | read-write | The line voltage type supported as an input to this Power Supply.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **Manufacturer** | string | Yes | read-only | This is the manufacturer of this power supply. | | ||
| + | | \ \ \ \ \ \ **MemberId** | string | | read-only | This is the identifier for the member within the collection. | | ||
| + | | \ \ \ \ \ \ **Model** | string | Yes | read-only | The model number for this Power Supply. | | ||
| + | | \ \ \ \ \ \ **Name** | string | Yes | read-only | The name of the Power Supply. | | ||
| + | | \ \ \ \ \ \ **Oem** {} | object | | read-write | This is the manufacturer/ | ||
| + | | \ \ \ \ \ \ **PartNumber** | string | Yes | read-only | The part number for this Power Supply. | | ||
| + | | \ \ \ \ \ \ **PowerCapacityWatts** | number | Yes | read-only | The maximum capacity of this Power Supply.\\ unit: W | | ||
| + | | \ \ \ \ \ \ **PowerSupplyType** | string | Yes | read-write | The Power Supply type (AC or DC).\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **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 | Yes | read-only | The serial number for this Power Supply. | | ||
| + | | \ \ \ \ \ \ **SparePartNumber** | string | Yes | read-only | The spare part number for this Power Supply. | | ||
| + | | \ \ \ \ \ \ **Status** {} | object | | read-only | Indicates the status of the file share. | | ||
| + | | } ] | | | | ||
| + | | **Redundancy** [ { | array | | ||
| + | | \ \ \ \ \ \ **MaxNumSupported** | number | Yes | read-only | This is the maximum number of members allowable for this particular redundancy group. | | ||
| + | | \ \ \ \ \ \ **MemberId** | string | | read-write | This is the identifier for the member within the collection. | | ||
| + | | \ \ \ \ \ \ **MinNumNeeded** | number | Yes | read-only | This is the minumum number of members needed for this group to be redundant. | | ||
| + | | \ \ \ \ \ \ **Mode** | string | Yes | read-write | This is the redundancy mode of the group.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **Name** | string | | read-only | The name of the resource or array element. | | ||
| + | | \ \ \ \ \ \ **Oem** {} | object | | read-write | This is the manufacturer/ | ||
| + | | \ \ \ \ \ \ **RedundancySet** [ {} ] | array | | read-only | Contains any ids that represent components of this redundancy set. | | ||
| + | | \ \ \ \ \ \ **Status** {} | object | | read-only | Indicates the status of the file share. | | ||
| + | | \ \ \ \ \ \ **MemberId** | string | | read-only | This is the identifier for the member within the collection. | | ||
| + | | \ \ \ \ \ \ **RedundancyEnabled** | boolean | Yes | read-write | This indicates whether redundancy is enabled. | | ||
| + | | } ] | | | | ||
| + | | **Voltages** [ { | array | | ||
| + | | \ \ \ \ \ \ **LowerThresholdCritical** | number | Yes | read-only | Below normal range but not yet fatal.\\ unit: V | | ||
| + | | \ \ \ \ \ \ **LowerThresholdFatal** | number | Yes | read-only | Below normal range and is fatal.\\ unit: V | | ||
| + | | \ \ \ \ \ \ **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 | | read-only | This is the identifier for the member within the collection. | | ||
| + | | \ \ \ \ \ \ **MinReadingRange** | number | Yes | read-only | Minimum value for this Voltage sensor.\\ unit: V | | ||
| + | | \ \ \ \ \ \ **Name** | string | Yes | read-only | Voltage sensor name. | | ||
| + | | \ \ \ \ \ \ **Oem** {} | object | | read-write | This is the manufacturer/ | ||
| + | | \ \ \ \ \ \ **PhysicalContext** | string | | read-write | Describes the area or device to which this voltage measurement applies.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **ReadingVolts** | number | Yes | read-only | The present reading of the voltage sensor.\\ unit: V | | ||
| + | | \ \ \ \ \ \ **RelatedItem** [ {} ] | array | | read-only | Describes the areas or devices to which this voltage measurement applies. | | ||
| + | | \ \ \ \ \ \ **SensorNumber** | number | Yes | read-only | A numerical identifier to represent the voltage sensor. | | ||
| + | | \ \ \ \ \ \ **Status** {} | object | | read-only | Indicates the status of the file share. | | ||
| + | | \ \ \ \ \ \ **UpperThresholdCritical** | number | Yes | read-only | Above normal range but not yet fatal.\\ unit: V | | ||
| + | | \ \ \ \ \ \ **UpperThresholdFatal** | number | Yes | read-only | Above normal range and is fatal.\\ unit: V | | ||
| + | | \ \ \ \ \ \ **UpperThresholdNonCritical** | number | Yes | read-only | Above normal range.\\ unit: V | | ||
| + | | } ] | | | ||
| === Property Details === | === Property Details === | ||
| Line 3409: | Line 3667: | ||
| This is the schema definition for Operation to Privilege mapping. | This is the schema definition for Operation to Privilege mapping. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Mappings** [ {} ] | array | read-write | | | + | | **Mappings** [ { | array | | read-write | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | \ \ \ \ \ \ **Entity** | string | | read-only | Indicates entity name. e.g., Manager. | |
| - | | **OEMPrivilegesUsed** [ {} ] | array | read-only | Lists the set of OEM Priviliges used in building this mapping. | | + | | \ \ \ \ \ \ **OperationMap** {} | object | | read-write | List mapping between HTTP method and privilege required for entity. | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | \ \ \ \ \ \ **PropertyOverrides** [ {} ] | array | |
| - | | **PrivilegesUsed** [ {} ] | array | read-only | Lists the set of Redfish standard priviliges used in building this mapping. | | + | | \ \ \ \ \ \ **ResourceURIOverrides** [ {} ] | array | | read-write | Indicates privilege overrides of Resource URI. | |
| + | | \ \ \ \ \ \ **SubordinateOverrides** [ {} ] | array | | read-write | Indicates privilege overrides of subordinate resource. | | ||
| + | | } ] | | ||
| + | | **Name** | string | ||
| + | | **OEMPrivilegesUsed** [ {} ] | array | | ||
| + | | **Oem** {} | object | ||
| + | | **PrivilegesUsed** [ {} ] | array | | ||
| ===== Processor ===== | ===== Processor ===== | ||
| Line 3422: | Line 3686: | ||
| This is the schema definition for the Processor resource. | This is the schema definition for the Processor resource. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **InstructionSet** | string, null | read-write | The instruction set of the processor.\\ | + | | **InstructionSet** | string |
| - | | **Manufacturer** | string, null | read-only | The processor manufacturer. | | + | | **Manufacturer** | string |
| - | | **MaxSpeedMHz** | number, null | read-only | The maximum clock speed of the processor. | | + | | **MaxSpeedMHz** | number |
| - | | **Model** | string, null | read-only | The product model number of this device. | | + | | **Model** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **ProcessorArchitecture** | string, null | read-write | The architecture of the processor.\\ | + | | **ProcessorArchitecture** | string |
| - | | **ProcessorId** { | object | read-write | Identification information for this processor. | | + | | **ProcessorId** { | object |
| - | | < | + | | \ \ \ \ \ \ **EffectiveFamily** | string |
| - | | < | + | | \ \ \ \ \ \ **EffectiveModel** | string |
| - | | < | + | | \ \ \ \ \ \ **IdentificationRegisters** | string |
| - | | < | + | | \ \ \ \ \ \ **MicrocodeInfo** | string |
| - | | < | + | | \ \ \ \ \ \ **Step** | string |
| - | | < | + | | \ \ \ \ \ \ **VendorId** | string |
| - | | } | | + | | } | | | |
| - | | **ProcessorType** | string, null | read-write | The type of processor.\\ | + | | **ProcessorType** | string |
| - | | **Socket** | string, null | read-only | The socket or location of the processor. | | + | | **Socket** | string |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| - | | **TotalCores** | number, null | read-only | The total number of cores contained in this processor. | | + | | **TotalCores** | number |
| - | | **TotalThreads** | number, null | read-only | The total number of execution threads supported by this processor. | | + | | **TotalThreads** | number |
| === Property Details === | === Property Details === | ||
| Line 3518: | Line 3782: | ||
| A Collection of Processor resource instances. | A Collection of Processor resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== Role ===== | ===== Role ===== | ||
| Line 3528: | Line 3792: | ||
| This resource defines a user role to be used in conjunction with a Manager Account. | This resource defines a user role to be used in conjunction with a Manager Account. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AssignedPrivileges** [ {} ] | array | read-write | The redfish privileges that this role includes. | | + | | **AssignedPrivileges** [ {} ] | array | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **IsPredefined** | boolean | read-only | This property is used to indicate if the Role is one of the Redfish Predefined Roles vs a Custom role. | | + | | **IsPredefined** | boolean |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **OemPrivileges** [ {} ] | array | read-write | The OEM privileges that this role includes. | | + | | **OemPrivileges** [ {} ] | array | |
| ===== RoleCollection ===== | ===== RoleCollection ===== | ||
| Line 3541: | Line 3805: | ||
| A Collection of Role resource instances. | A Collection of Role resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== SecureBoot ===== | ===== SecureBoot ===== | ||
| Line 3551: | Line 3815: | ||
| This resource contains UEFI Secure Boot information. It represents properties for managing the UEFI Secure Boot functionality of a system. | This resource contains UEFI Secure Boot information. It represents properties for managing the UEFI Secure Boot functionality of a system. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **SecureBootCurrentBoot** | string, null | read-write | Secure Boot state during the current boot cycle.\\ | + | | **SecureBootCurrentBoot** | string |
| - | | **SecureBootEnable** | boolean, null | read-write | Enable or disable UEFI Secure Boot (takes effect on next boot). | | + | | **SecureBootEnable** | boolean |
| - | | **SecureBootMode** | string, null | read-write | Current Secure Boot Mode.\\ | + | | **SecureBootMode** | string |
| === Property Details === | === Property Details === | ||
| Line 3585: | Line 3849: | ||
| This schema defines an asynchronous serial interface resource. | This schema defines an asynchronous serial interface resource. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **BitRate** | string | read-write | The receive and transmit rate of data flow, typically in bits-per-second (bps), over the serial connection.\\ | + | | **BitRate** | string |
| - | | **ConnectorType** | string | read-write | The type of connector used for this interface.\\ | + | | **ConnectorType** | string |
| - | | **DataBits** | string | read-write | The number of data bits that will follow the start bit over the serial connection.\\ | + | | **DataBits** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **FlowControl** | string | read-write | The type of flow control, if any, that will be imposed on the serial connection.\\ | + | | **FlowControl** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **InterfaceEnabled** | boolean, null | read-write | This indicates whether this interface is enabled. | | + | | **InterfaceEnabled** | boolean |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Parity** | string | read-write | The type of parity used by the sender and receiver in order to detect errors over the serial connection.\\ | + | | **Parity** | string |
| - | | **PinOut** | string, null | read-write | The physical pin configuration needed for a serial connector.\\ | + | | **PinOut** | string |
| - | | **SignalType** | string | read-write | The type of signal used for the communication connection - RS232 or RS485.\\ | + | | **SignalType** | string |
| - | | **StopBits** | string | read-write | The period of time before the next start bit is transmitted.\\ | + | | **StopBits** | string |
| === Property Details === | === Property Details === | ||
| Line 3605: | Line 3869: | ||
| ^ string ^ | ^ string ^ | ||
| - | | 1200 | | + | | 1200 | |
| - | | 2400 | | + | | 2400 | |
| - | | 4800 | | + | | 4800 | |
| - | | 9600 | | + | | 9600 | |
| - | | 19200 | | + | | 19200 | |
| - | | 38400 | | + | | 38400 | |
| - | | 57600 | | + | | 57600 | |
| - | | 115200 | | + | | 115200 | |
| - | | 230400 | | + | | 230400 | |
| == ConnectorType == | == ConnectorType == | ||
| ^ string ^ | ^ string ^ | ||
| - | | RJ45. | | + | | RJ45. | |
| - | | RJ11. | | + | | RJ11. | |
| - | | DB9 Female. | | + | | DB9 Female. | |
| - | | DB9 Male. | | + | | DB9 Male. | |
| - | | DB25 Female. | | + | | DB25 Female. | |
| - | | DB25 Male. | | + | | DB25 Male. | |
| - | | USB. | | + | | USB. | |
| - | | mUSB. | | + | | mUSB. | |
| - | | uUSB. | | + | | uUSB. | |
| == DataBits == | == DataBits == | ||
| ^ string ^ | ^ string ^ | ||
| - | | 5 | | + | | 5 | |
| - | | 6 | | + | | 6 | |
| - | | 7 | | + | | 7 | |
| - | | 8 | | + | | 8 | |
| == FlowControl == | == FlowControl == | ||
| Line 3646: | Line 3910: | ||
| ^ string ^ | ^ string ^ | ||
| - | | None | | + | | None | |
| - | | Even | | + | | Even | |
| - | | Odd | | + | | Odd | |
| - | | Mark | | + | | Mark | |
| - | | Space | | + | | Space | |
| == PinOut == | == PinOut == | ||
| ^ string ^ | ^ string ^ | ||
| - | | Cisco | | + | | Cisco | |
| - | | Cyclades | | + | | Cyclades | |
| - | | Digi | | + | | Digi | |
| == SignalType == | == SignalType == | ||
| ^ string ^ | ^ string ^ | ||
| - | | Rs232 | | + | | Rs232 | |
| - | | Rs485 | | + | | Rs485 | |
| == StopBits == | == StopBits == | ||
| ^ string ^ | ^ string ^ | ||
| - | | 1 | | + | | 1 | |
| - | | 2 | | + | | 2 | |
| Line 3676: | Line 3940: | ||
| A Collection of SerialInterface resource instances. | A Collection of SerialInterface resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== ServiceRoot ===== | ===== ServiceRoot ===== | ||
| Line 3686: | Line 3950: | ||
| This object represents the root Redfish service. | This object represents the root Redfish service. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **[[documentation: | + | | **AccountService** | reference([[documentation: |
| - | | **[[documentation: | + | | **Chassis** | reference([[documentation: |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **[[documentation: | + | | **EventService** | reference([[documentation: |
| - | | **[[documentation: | + | | **Fabrics** | reference([[documentation: |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **[[documentation: | + | | **JsonSchemas** | reference([[documentation: |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **Sessions** |
| - | | } | | + | | } | | | |
| - | | **[[documentation: | + | | **Managers** | reference([[documentation: |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **RedfishVersion** | string | read-only | The version of the Redfish service.\\ pattern: ^\d+\.\d+\.\d+$ | | + | | **RedfishVersion** | string |
| - | | **[[documentation: | + | | **Registries** | reference([[documentation: |
| - | | **[[documentation: | + | | **SessionService** | reference([[documentation: |
| - | | **[[documentation: | + | | **StorageServices** | reference([[documentation: |
| - | | **[[documentation: | + | | **StorageSystems** | reference([[documentation: |
| - | | **[[documentation: | + | | **Systems** | reference([[documentation: |
| - | | **[[documentation: | + | | **Tasks** | reference([[documentation: |
| - | | **UUID** | string, null | read-write | Unique identifier for a service instance. When SSDP is used, this value should be an exact match of the UUID value returned in a 200OK from an SSDP M-SEARCH request during discovery.\\ pattern: ([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}) | | + | | **UUID** | string |
| - | | **[[documentation: | + | | **UpdateService** | reference([[documentation: |
| + | |||
| + | === Property Details === | ||
| + | |||
| + | == CompletedTaskOverWritePolicy == | ||
| + | |||
| + | ^ string ^ Description ^ | ||
| + | | Manual | Completed tasks are not automatically overwritten. | | ||
| + | | Oldest | Oldest completed tasks are overwritten. | | ||
| ===== Session ===== | ===== Session ===== | ||
| Line 3715: | Line 3988: | ||
| The Session resource describes a single connection (session) between a client and a Redfish service instance. | The Session resource describes a single connection (session) between a client and a Redfish service instance. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Password** | string, null | read-only | This property is used in a POST to specify a password when creating a new session. | + | | **Password** | string |
| - | | **UserName** | string, null | read-only | The UserName for the account for this session. | | + | | **UserName** | string |
| ===== SessionCollection ===== | ===== SessionCollection ===== | ||
| Line 3727: | Line 4000: | ||
| A Collection of Session resource instances. | A Collection of Session resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== SessionService ===== | ===== SessionService ===== | ||
| Line 3737: | Line 4010: | ||
| This is the schema definition for the Session Service. | This is the schema definition for the Session Service. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The Actions object contains the available custom actions on this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **ServiceEnabled** | boolean, null | read-write | This indicates whether this service is enabled. | | + | | **ServiceEnabled** | boolean |
| - | | **SessionTimeout** | number | read-write | This is the number of seconds of inactivity that a session may have before the session service closes the session due to inactivity.\\ unit: s\\ minimum: 30\\ maximum: 86400 | | + | | **SessionTimeout** | number |
| - | | **[[documentation: | + | | **Sessions** | reference([[documentation: |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| === Property Details === | === Property Details === | ||
| Line 3791: | Line 4064: | ||
| This is the schema definition for the Simple Storage resource. | This is the schema definition for the Simple Storage resource. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Devices** [ {} ] | array | read-write | The storage devices associated with this resource. | | + | | **Devices** [ { | array | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | \ \ \ \ \ \ **CapacityBytes** | number | Yes | read-only | The size of the storage device.\\ unit: By | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | \ \ \ \ \ \ **Manufacturer** | string | Yes | read-only | The name of the manufacturer of this device. | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | \ \ \ \ \ \ **Model** | string | Yes | read-only | The product model number of this device. | |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | \ \ \ \ \ \ **Name** | string | | read-only | The name of the resource or array element. | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | | \ \ \ \ \ \ **Status** {} | object | | read-only | Indicates the status of the file share. | |
| - | | < | + | | } ] | | |
| - | | < | + | | **Id** | string |
| - | | } | | + | | **Name** | string |
| - | | **UefiDevicePath** | string, null | read-only | The UEFI device path used to access this storage controller. | | + | | **Oem** {} | object |
| + | | **Status** { | object | ||
| + | | \ \ \ \ \ \ **Health** | string | ||
| + | | \ \ \ \ \ \ **HealthRollup** | string | ||
| + | | \ \ \ \ \ \ **Oem** {} | object | ||
| + | | \ \ \ \ \ \ **State** | string | ||
| + | | } | | | | ||
| + | | **UefiDevicePath** | string | ||
| === Property Details === | === Property Details === | ||
| Line 3841: | Line 4121: | ||
| A Collection of SimpleStorage resource instances. | A Collection of SimpleStorage resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== SoftwareInventory ===== | ===== SoftwareInventory ===== | ||
| Line 3851: | Line 4131: | ||
| This schema defines an inventory of software components. | This schema defines an inventory of software components. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The Actions object contains the available custom actions on this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **LowestSupportedVersion** | string, null | read-only | A string representing the lowest supported version of this software. | | + | | **LowestSupportedVersion** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **RelatedItem** [ {} ] | array | read-only | The ID(s) of the resources associated with this software inventory item. | | + | | **RelatedItem** [ {} ] | array | |
| - | | **SoftwareId** | string | read-only | A string representing the implementation-specific ID for identifying this software. | | + | | **SoftwareId** | string |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **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. | | + | | **UefiDevicePaths** [ {} ] | array | |
| - | | **Updateable** | boolean, null | read-only | Indicates whether this software can be updated by the update service. | | + | | **Updateable** | boolean |
| - | | **Version** | string, null | read-only | A string representing the version of this software. | | + | | **Version** | string |
| === Property Details === | === Property Details === | ||
| Line 3908: | Line 4188: | ||
| A Collection of SoftwareInventory resource instances. | A Collection of SoftwareInventory resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== Storage ===== | ===== Storage ===== | ||
| Line 3918: | Line 4198: | ||
| This schema defines a storage subsystem and its respective properties. | This schema defines a storage subsystem and its respective properties. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Drives** [ {} ] | array | read-only | The set of drives attached to the storage controllers represented by this resource. | | + | | **Drives** |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Enclosures** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Redundancy** [ {} ] | array | read-write | Redundancy information for the storage subsystem. | | + | | **Redundancy** [ { | array | |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | \ \ \ \ \ \ **MaxNumSupported** | number | Yes | read-only | This is the maximum number of members allowable for this particular redundancy group. | |
| - | | < | + | | \ \ \ \ \ \ **MemberId** | string | | read-write | This is the identifier for the member within the collection. | |
| - | | < | + | | \ \ \ \ \ \ **MinNumNeeded** | number | Yes | read-only | This is the minumum number of members needed for this group to be redundant. | |
| - | | < | + | | \ \ \ \ \ \ **Mode** | string | Yes | read-write | This is the redundancy mode of the group.\\ //See Property Details, below, for more information about this property.// | |
| - | | < | + | | \ \ \ \ \ \ **Name** | string | | read-only | The name of the resource or array element. | |
| - | | } | | + | | \ \ \ \ \ \ **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | **StorageControllers** [ {} ] | array | read-only | The set of storage controllers represented by this resource. | | + | | \ \ \ \ \ \ **RedundancySet** [ {} ] | array | | read-only | Contains any ids that represent components of this redundancy set. | |
| - | | **[[documentation: | + | | \ \ \ \ \ \ **Status** {} | object |
| + | | \ \ \ \ \ \ **MemberId** | string | | read-only | This is the identifier for the member within the collection. | | ||
| + | | \ \ \ \ \ \ **RedundancyEnabled** | boolean | Yes | read-write | This indicates whether redundancy is enabled. | | ||
| + | | } ] | | | | ||
| + | | **Status** { | object | | read-only | Indicates the status of the file share. | | ||
| + | | \ \ \ \ \ \ **Health** | string | ||
| + | | \ \ \ \ \ \ **HealthRollup** | string | ||
| + | | \ \ \ \ \ \ **Oem** {} | object | ||
| + | | \ \ \ \ \ \ **State** | string | ||
| + | | } | | | | ||
| + | | **StorageControllers** [ { | array | | ||
| + | | \ \ \ \ \ \ **AssetTag** | string | Yes | read-write | The user assigned asset tag for this storage controller. | | ||
| + | | \ \ \ \ \ \ **FirmwareVersion** | string | Yes | read-only | The firmware version of this storage Controller. | | ||
| + | | \ \ \ \ \ \ **Identifiers** [ {} ] | array | | read-write | The Durable names for the storage controller. | | ||
| + | | \ \ \ \ \ \ **Links** {} | object | | read-write | Contains references to other resources that are related to this resource. | | ||
| + | | \ \ \ \ \ \ **Manufacturer** | string | Yes | read-only | This is the manufacturer of this storage controller. | | ||
| + | | \ \ \ \ \ \ **MemberId** | string | | read-only | This is the identifier for the member within the collection. | | ||
| + | | \ \ \ \ \ \ **Model** | string | Yes | read-only | This is the model number for the storage controller. | | ||
| + | | \ \ \ \ \ \ **Oem** {} | object | | read-write | This is the manufacturer/ | ||
| + | | \ \ \ \ \ \ **PartNumber** | string | Yes | read-only | The part number for this storage controller. | | ||
| + | | \ \ \ \ \ \ **SKU** | string | Yes | read-only | This is the SKU for this storage controller. | | ||
| + | | \ \ \ \ \ \ **SerialNumber** | string | Yes | read-only | The serial number for this storage controller. | | ||
| + | | \ \ \ \ \ \ **SpeedGbps** | number | Yes | read-only | The speed of the storage controller interface.\\ unit: Gbit/s | | ||
| + | | \ \ \ \ \ \ **Status** {} | object | | read-only | Indicates the status of the file share. | | ||
| + | | \ \ \ \ \ \ **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. | | ||
| + | | } ] | | | | ||
| + | | **Volumes** | reference([[documentation: | ||
| === Property Details === | === Property Details === | ||
| Line 4035: | Line 4342: | ||
| A Collection of Storage resource instances. | A Collection of Storage resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== StorageGroup ===== | ===== StorageGroup ===== | ||
| Line 4045: | Line 4352: | ||
| Collection of resources that are managed and exposed to hosts as a group. | Collection of resources that are managed and exposed to hosts as a group. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AccessState** | null | read-write | AccessState for this storage group. | | + | | **AccessState** | | Yes | read-write | AccessState for this storage group. | |
| - | | **Actions** { | object | read-only | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **[[documentation: | + | | **ClientEndpointGroups** | object | Yes | read-write | ClientEndpointGroup in this StorageGroup. | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Identifier** { | object, null | read-only | The value identifies this resource. | | + | | **Identifier** { | object |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | } | | + | | } | | | |
| - | | **Links** { | object | read-only | Contains links to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **ChildStorageGroups** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **ClassOfService** |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **ParentStorageGroups** [ {} ] | array | |
| - | | } | | + | | } | | | |
| - | | **MembersAreConsistent** | boolean, null | read-only | Members are kept in a consistent state. | | + | | **MembersAreConsistent** | boolean |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **ReplicaInfos** [ {} ] | array | read-only | Describes this storage group in its role as a source and/or target for replication. | | + | | **ReplicaInfos** [ { | array | |
| - | | **[[documentation:redfish_api:schema_definition# | + | | \ \ \ \ \ \ **ConsistencyEnabled** | boolean | Yes | read-only | True if consistency is enabled. | |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | \ \ \ \ \ \ **ConsistencyState** | string | Yes | read-write | The current state of consistency.\\ //See Property Details, below, for more information about this property.// | |
| - | | < | + | | \ \ \ \ \ \ **ConsistencyStatus** | string | Yes | read-write | The current status of consistency.\\ //See Property Details, below, for more information about this property.// | |
| - | | < | + | | \ \ \ \ \ \ **ConsistencyType** | string | Yes | read-write | Indicates the consistency type used by the source and its associated target group.\\ //See Property Details, below, for more information about this property.// | |
| - | | < | + | | \ \ \ \ \ \ **FailedCopyStopsHostIO** | boolean | Yes | read-only | If true, the storage array tells host to stop sending data to source element if copying to a remote element fails. | |
| - | | < | + | | \ \ \ \ \ \ **PercentSynced** | number | Yes | read-only | Specifies the percent of the work completed to reach synchronization.\\ unit: % | |
| - | | } | | + | | \ \ \ \ \ \ **Replica** | | Yes | read-write | The resource that is the source of this replica. | |
| - | | **[[documentation: | + | | \ \ \ \ \ \ **ReplicaPriority** | string | Yes | read-write | The priority of background copy engine I/O to be managed relative to host I/O operations during a sequential background copy operation.\\ //See Property Details, below, for more information about this property.// | |
| - | | **VolumesAreExposed** | boolean, null | read-only | Storage volumes are exposed to the Client Endpoints. | | + | | \ \ \ \ \ \ **ReplicaProgressStatus** | string | Yes | read-write | The status of the session with respect to Replication activity.\\ //See Property Details, below, for more information about this property.// | |
| + | | \ \ \ \ \ \ **ReplicaReadOnlyAccess** | string | Yes | read-write | This property specifies whether the source, the target, or both elements are read only to the host.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **ReplicaRecoveryMode** | string | Yes | read-write | Describes whether the copy operation continues after a broken link is restored.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **ReplicaRole** | string | Yes | read-write | The source or target role of this replica.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **ReplicaSkewBytes** | number | Yes | read-only | Applies to Adaptive mode and it describes maximum number of bytes the SyncedElement (target) can be out of sync.\\ unit: By | | ||
| + | | \ \ \ \ \ \ **ReplicaState** | string | Yes | read-write | ReplicaState describes the state of the relationship with respect to Replication activity.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **ReplicaType** | string | Yes | read-write | ReplicaType describes the intended outcome of the replication.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **ReplicaUpdateMode** | string | Yes | read-write | Describes whether the target elements will be updated synchronously or asynchronously.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **RequestedReplicaState** | string | Yes | read-write | The last requested or desired state for the relationship.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **SyncMaintained** | boolean | Yes | read-only | Synchronization is maintained. | | ||
| + | | \ \ \ \ \ \ **UndiscoveredElement** | string | Yes | read-write | This property specifies whether the source, the target, or both elements involved in a copy operation are undiscovered.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **WhenActivated** | string | Yes | read-only | Specifies when point-in-time copy was taken or when the replication relationship is activated, reactivated, | ||
| + | | \ \ \ \ \ \ **WhenDeactivated** | string | Yes | read-only | Specifies when the replication relationship is deactivated.\\ unit: % | | ||
| + | | \ \ \ \ \ \ **WhenEstablished** | string | Yes | read-only | Specifies when the replication relationship is established.\\ unit: % | | ||
| + | | \ \ \ \ \ \ **WhenSuspended** | string | Yes | read-only | Specifies when the replication relationship is suspended.\\ unit: % | | ||
| + | | \ \ \ \ \ \ **WhenSynced** | string | Yes | read-only | The point in time that the Elements were synchronized. | | ||
| + | | \ \ \ \ \ \ **WhenSynchronized** | string | Yes | read-only | Specifies when the replication relationship is synchronized.\\ unit: % | | ||
| + | | } ] | | | | ||
| + | | **ServerEndpointGroups** | object | Yes | read-write | ServerEndpointGroups in this StorageGroup. | | ||
| + | | **Status** { | object | ||
| + | | \ \ \ \ \ \ **Health** | string | ||
| + | | \ \ \ \ \ \ **HealthRollup** | string | ||
| + | | \ \ \ \ \ \ **Oem** {} | object | ||
| + | | \ \ \ \ \ \ **State** | string | ||
| + | | } | | | | ||
| + | | **Volumes** | object | Yes | read-write | Volumes in this StorageGroup. | | ||
| + | | **VolumesAreExposed** | boolean | ||
| === Property Details === | === Property Details === | ||
| Line 4259: | Line 4592: | ||
| A Collection of StorageGroup resource instances. | A Collection of StorageGroup resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | The value of each member references a StorageGroup resource. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== StoragePool ===== | ===== StoragePool ===== | ||
| Line 4269: | Line 4602: | ||
| A container of data storage. | A container of data storage. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **[[documentation: | + | | **AllocatedPools** | object | Yes | read-write | A reference to the collection of storage pools allocated from this storage pool. | |
| - | | **[[documentation: | + | | **AllocatedVolumes** | object | Yes | read-write | A reference to the collection of volumes allocated from this storage pool. | |
| - | | **BlockSizeBytes** | number, null | read-only | Maximum Block size in bytes.\\ unit: By | | + | | **BlockSizeBytes** | number |
| - | | **Capacity** { | object, null | read-write | Capacity utilization. | | + | | **Capacity** { | object |
| - | | < | + | | \ \ \ \ \ \ **Data** {} | object |
| - | | < | + | | \ \ \ \ \ \ **IsThinProvisioned** | boolean |
| - | | < | + | | \ \ \ \ \ \ **Metadata** {} | object |
| - | | < | + | | \ \ \ \ \ \ **Snapshot** {} | object |
| - | | } | | + | | } | | | |
| - | | **CapacitySources** [ {} ] | array | read-only | An array of space allocations to this store. | | + | | **CapacitySources** [ { | array | |
| - | | **[[documentation: | + | | \ \ \ \ \ \ **ProvidedCapacity** {} | object | Yes | read-write | The amount of space that has been provided from the ProvidingDrives, |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | \ \ \ \ \ \ **ProvidedClassOfService** {} | object | Yes | read-write | The ClassOfService provided from the ProvidingDrives, ProvidingVolumes or ProvidingPools. | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | \ \ \ \ \ \ **ProvidingDrives** {} | object | Yes | read-write | The drive or drives that provide this space. | |
| - | | **Identifier** { | object, null | read-only | The value identifies this resource. | | + | | \ \ \ \ \ \ **ProvidingPools** {} | object | Yes | read-write | The pool or pools that provide this space. | |
| - | | < | + | | \ \ \ \ \ \ **ProvidingVolumes** {} | object | Yes | read-write | The volume or volumes that provide this space. | |
| - | | < | + | | } ] | | | |
| - | | } | | + | | **ClassesOfService** | object | Yes | read-write | The ClassesOfService supported by this storage pool. | |
| - | | **Links** { | object | read-only | Contains links to other resources that are related to this resource. | | + | | **Description** | string |
| - | | < | + | | **Id** | string |
| - | | < | + | | **Identifier** { | object |
| - | | } | | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | **LowSpaceWarningThresholdPercents** [ {} ] | array | read-write | Low space warning threshold specified in percents. | | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | } | | | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Links** { | object |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | \ \ \ \ \ \ **DefaultClassOfService** |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | } | | | |
| - | | < | + | | **LowSpaceWarningThresholdPercents** [ {} ] | array | |
| - | | < | + | | **Name** | string |
| - | | } | | + | | **Oem** {} | object |
| + | | **Status** { | object | ||
| + | | \ \ \ \ \ \ **Health** | string | ||
| + | | \ \ \ \ \ \ **HealthRollup** | string | ||
| + | | \ \ \ \ \ \ **Oem** {} | object | ||
| + | | \ \ \ \ \ \ **State** | string | ||
| + | | } | | | | ||
| === Property Details === | === Property Details === | ||
| Line 4346: | Line 4685: | ||
| A Collection of StoragePool resource instances. | A Collection of StoragePool resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | The value of each member references a StoragePool resource. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== StorageService ===== | ===== StorageService ===== | ||
| Line 4356: | Line 4695: | ||
| Collection of resources that are managed and exposed to hosts as a group. | Collection of resources that are managed and exposed to hosts as a group. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-only | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **[[documentation: | + | | **ClassesOfService** | object | Yes | read-write | The ClassesOfService that all storage in this StorageService can support. | |
| - | | **[[documentation: | + | | **ClientEndpointGroups** | object | Yes | read-write | Client endpoint groups. | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **[[documentation: | + | | **Drives** | reference([[documentation: |
| - | | **[[documentation: | + | | **Endpoints** | object | Yes | read-write | Endpoints. | |
| - | | **[[documentation: | + | | **FileSystems** | reference([[documentation: |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Identifier** { | object, null | read-only | The value identifies this resource. | | + | | **Identifier** { | object |
| - | | < | + | | \ \ \ \ \ \ **DurableName** | string |
| - | | < | + | | \ \ \ \ \ \ **DurableNameFormat** | string |
| - | | } | | + | | } | | | |
| - | | **Links** { | object | read-only | Contains links to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **DataProtectionLoSCapabilities** |
| - | | < | + | | \ \ \ \ \ \ **DataSecurityLoSCapabilities** |
| - | | < | + | | \ \ \ \ \ \ **DataStorageLoSCapabilities** |
| - | | < | + | | \ \ \ \ \ \ **DefaultClassOfService** |
| - | | < | + | | \ \ \ \ \ \ **HostingSystem** |
| - | | < | + | | \ \ \ \ \ \ **IOConnectivityLoSCapabilities** |
| - | | < | + | | \ \ \ \ \ \ **IOPerformanceLoSCapabilities** |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Redundancy** [ {} ] | array | read-only | Redundancy information for the storage subsystem | | + | | **Redundancy** [ { | array | |
| - | | **[[documentation: | + | | \ \ \ \ \ \ **MaxNumSupported** | number | Yes | read-only | This is the maximum number of members allowable for this particular redundancy group. | |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | \ \ \ \ \ \ **MemberId** | string | | read-write | This is the identifier for the member within the collection. | |
| - | | < | + | | \ \ \ \ \ \ **MinNumNeeded** | number | Yes | read-only | This is the minumum number of members needed for this group to be redundant. | |
| - | | < | + | | \ \ \ \ \ \ **Mode** | string | Yes | read-write | This is the redundancy mode of the group.\\ //See Property Details, below, for more information about this property.// | |
| - | | < | + | | \ \ \ \ \ \ **Name** | string | | read-only | The name of the resource or array element. | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | } | | + | | \ \ \ \ \ \ **RedundancySet** [ {} ] | array | | read-only | Contains any ids that represent components of this redundancy set. | |
| - | | **[[documentation: | + | | \ \ \ \ \ \ **Status** {} | object | | read-only | Indicates the status of the file share. | |
| - | | **[[documentation: | + | | \ \ \ \ \ \ **MemberId** | string | | read-only | This is the identifier for the member within the collection. | |
| - | | **[[documentation: | + | | \ \ \ \ \ \ **RedundancyEnabled** | boolean | Yes | read-write | This indicates whether redundancy is enabled. | |
| + | | } ] | | | | ||
| + | | **ServerEndpointGroups** | object | Yes | read-write | Server endpoint groups. | | ||
| + | | **Status** { | object | ||
| + | | \ \ \ \ \ \ **Health** | string | ||
| + | | \ \ \ \ \ \ **HealthRollup** | string | ||
| + | | \ \ \ \ \ \ **Oem** {} | object | ||
| + | | \ \ \ \ \ \ **State** | string | ||
| + | | } | | | | ||
| + | | **StorageGroups** | object | Yes | read-write | StorageGroups. | | ||
| + | | **StoragePools** | reference([[documentation: | ||
| + | | **Volumes** | reference([[documentation: | ||
| === Property Details === | === Property Details === | ||
| Line 4449: | Line 4799: | ||
| A collection of references to Storage Service resource instances. | A collection of references to Storage Service resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | The value of each member references a StorageService resource. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== StorageSystemCollection ===== | ===== StorageSystemCollection ===== | ||
| Line 4459: | Line 4809: | ||
| A Collection of ComputerSystem resource instances that each have an entry in HostingRoles set to ' | A Collection of ComputerSystem resource instances that each have an entry in HostingRoles set to ' | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | The value of each member references a Storage System resource. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== Switch ===== | ===== Switch ===== | ||
| Line 4469: | Line 4819: | ||
| Switch contains properties describing a simple fabric switch. | Switch contains properties describing a simple fabric switch. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **AssetTag** | string, null | read-write | The user assigned asset tag for this switch. | | + | | **AssetTag** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **DomainID** | number, null | read-only | The Domain ID for this switch. | | + | | **DomainID** | number |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **IndicatorLED** | string, null | read-write | The state of the indicator LED, used to identify the switch.\\ | + | | **IndicatorLED** | string |
| - | | **IsManaged** | boolean, null | read-write | This indicates whether the switch is in a managed or unmanaged state. | | + | | **IsManaged** | boolean |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Chassis** |
| - | | < | + | | \ \ \ \ \ \ **ManagedBy** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **[[documentation: | + | | **LogServices** | object | Yes | read-write | A reference to the collection of Log Services associated with this system. | |
| - | | **Manufacturer** | string, null | read-only | This is the manufacturer of this switch. | | + | | **Manufacturer** | string |
| - | | **Model** | string, null | read-only | The product model number of this switch. | | + | | **Model** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **PartNumber** | string, null | read-only | The part number for this switch. | | + | | **PartNumber** | string |
| - | | **[[documentation: | + | | **Ports** | reference([[documentation: |
| - | | **PowerState** | string, null | read-write | This is the current power state of the switch.\\ | + | | **PowerState** | string |
| - | | **Redundancy** [ {} ] | array | read-write | Redundancy information for the switches. | | + | | **Redundancy** [ { | array | |
| - | | **SKU** | string, | + | | \ \ \ \ \ \ **MaxNumSupported** | number | Yes | read-only | This is the maximum number of members allowable for this particular redundancy group. | |
| - | | **SerialNumber** | string, null | read-only | The serial number for this switch. | | + | | \ \ \ \ \ \ **MemberId** | string |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | \ \ \ \ \ \ **MinNumNeeded** | number | Yes | read-only | This is the minumum number of members needed for this group to be redundant. | |
| - | | < | + | | \ \ \ \ \ \ **Mode** | string | Yes | read-write | This is the redundancy mode of the group.\\ //See Property Details, below, for more information about this property.// | |
| - | | < | + | | \ \ \ \ \ \ **Name** | string | | read-only | The name of the resource or array element. | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object | | read-write | This is the manufacturer/ |
| - | | < | + | | \ \ \ \ \ \ **RedundancySet** [ {} ] | array | | read-only | Contains any ids that represent components of this redundancy set. | |
| - | | } | | + | | \ \ \ \ \ \ **Status** {} | object | | read-only | Indicates the status of the file share. | |
| - | | **SwitchType** | null | read-write | The protocol being sent over this switch. | | + | | \ \ \ \ \ \ **MemberId** | string | | read-only | This is the identifier for the member within the collection. | |
| - | | **TotalSwitchWidth** | number, null | read-only | The total number of lanes, phys, or other physical transport links that this switch contains. | | + | | \ \ \ \ \ \ **RedundancyEnabled** | boolean | Yes | read-write | This indicates whether redundancy is enabled. | |
| + | | } ] | | | | ||
| + | | **SKU** | string | Yes | read-only | This is the SKU for this switch. | | ||
| + | | **SerialNumber** | string | ||
| + | | **Status** { | object | ||
| + | | \ \ \ \ \ \ **Health** | string | ||
| + | | \ \ \ \ \ \ **HealthRollup** | string | ||
| + | | \ \ \ \ \ \ **Oem** {} | object | ||
| + | | \ \ \ \ \ \ **State** | string | ||
| + | | } | | | | ||
| + | | **SwitchType** | | Yes | read-write | The protocol being sent over this switch. | | ||
| + | | **TotalSwitchWidth** | number | ||
| === Property Details === | === Property Details === | ||
| Line 4564: | Line 4925: | ||
| A Collection of Switch resource instances. | A Collection of Switch resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== Task ===== | ===== Task ===== | ||
| Line 4574: | Line 4935: | ||
| This resource contains information about a specific Task scheduled by or being executed by a Redfish service' | This resource contains information about a specific Task scheduled by or being executed by a Redfish service' | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **EndTime** | string | read-only | The date-time stamp that the task was last completed.\\ format: date-time | | + | | **EndTime** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Messages** [ {} ] | array | read-write | This is an array of messages associated with the task. | | + | | **Messages** [ {} ] | array | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **StartTime** | string | read-only | The date-time stamp that the task was last started.\\ format: date-time | | + | | **StartTime** | string |
| - | | **TaskState** | string | read-write | The state of the task.\\ | + | | **TaskState** | string |
| - | | **TaskStatus** | string | read-write | This is the completion status of the task.\\ | + | | **TaskStatus** | string |
| === Property Details === | === Property Details === | ||
| Line 4614: | Line 4975: | ||
| A Collection of Task resource instances. | A Collection of Task resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== TaskService ===== | ===== TaskService ===== | ||
| Line 4624: | Line 4985: | ||
| This is the schema definition for the Task Service. | This is the schema definition for the Task Service. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **CompletedTaskOverWritePolicy** | string | read-write | Overwrite policy of completed tasks.\\ | + | | **CompletedTaskOverWritePolicy** | string |
| - | | **DateTime** | string, null | read-only | The current DateTime (with offset) setting that the task service is using.\\ format: date-time | | + | | **DateTime** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **LifeCycleEventOnTaskStateChange** | boolean | read-only | Send an Event upon Task State Change. | | + | | **LifeCycleEventOnTaskStateChange** | boolean |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **ServiceEnabled** | boolean, null | read-write | This indicates whether this service is enabled. | | + | | **ServiceEnabled** | boolean |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| - | | **[[documentation: | + | | **Tasks** | reference([[documentation: |
| === Property Details === | === Property Details === | ||
| Line 4683: | Line 5044: | ||
| This is the schema definition for the Thermal properties. | This is the schema definition for the Thermal properties. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Fans** [ {} ] | array | read-write | This is the definition for fans. | | + | | **Fans** [ { | array | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | \ \ \ \ \ \ **FanName** | string | Yes | read-only | Name of the fan. | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | \ \ \ \ \ \ **IndicatorLED** | string | Yes | read-write | The state of the indicator LED, used to identify this Fan.\\ //See Property Details, below, for more information about this property.// | |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | \ \ \ \ \ \ **LowerThresholdCritical** | number | Yes | read-only | Below normal range but not yet fatal. | |
| - | | **Redundancy** [ {} ] | array | read-write | This structure is used to show redundancy for fans. The Component ids will reference the members of the redundancy groups. | | + | | \ \ \ \ \ \ **LowerThresholdFatal** | number | Yes | read-only | Below normal range and is fatal. | |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | \ \ \ \ \ \ **LowerThresholdNonCritical** | number | Yes | read-only | Below normal range. | |
| - | | < | + | | \ \ \ \ \ \ **Manufacturer** | string | Yes | read-only | This is the manufacturer of this Fan. | |
| - | | < | + | | \ \ \ \ \ \ **MaxReadingRange** | number | Yes | read-only | Maximum value for Reading. | |
| - | | < | + | | \ \ \ \ \ \ **MemberId** | string | | read-only | This is the identifier for the member within the collection. | |
| - | | < | + | | \ \ \ \ \ \ **MinReadingRange** | number | Yes | read-only | Minimum value for Reading. | |
| - | | } | | + | | \ \ \ \ \ \ **Model** | string | Yes | read-only | The model number for this Fan. | |
| - | | **Temperatures** [ {} ] | array | read-write | This is the definition for temperature sensors. | | + | | \ \ \ \ \ \ **Name** | string | Yes | read-only | Name of the fan. | |
| + | | \ \ \ \ \ \ **Oem** {} | object | | read-write | This is the manufacturer/ | ||
| + | | \ \ \ \ \ \ **PartNumber** | string | Yes | read-only | The part number for this Fan. | | ||
| + | | \ \ \ \ \ \ **PhysicalContext** | string | | read-write | Describes the area or device associated with this fan.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **Reading** | number | Yes | read-only | Current fan speed. | | ||
| + | | \ \ \ \ \ \ **ReadingUnits** | string | Yes | read-write | Units in which the reading and thresholds are measured.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **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 | Yes | read-only | The serial number for this Fan. | | ||
| + | | \ \ \ \ \ \ **SparePartNumber** | string | Yes | read-only | The spare part number for this Fan. | | ||
| + | | \ \ \ \ \ \ **Status** {} | object | | read-only | Indicates the status of the file share. | | ||
| + | | \ \ \ \ \ \ **UpperThresholdCritical** | number | Yes | read-only | Above normal range but not yet fatal. | | ||
| + | | \ \ \ \ \ \ **UpperThresholdFatal** | number | Yes | read-only | Above normal range and is fatal. | | ||
| + | | \ \ \ \ \ \ **UpperThresholdNonCritical** | number | Yes | read-only | Above normal range. | | ||
| + | | } ] | | | ||
| + | | **Id** | string | ||
| + | | **Name** | string | ||
| + | | **Oem** {} | object | ||
| + | | **Redundancy** [ { | array | | ||
| + | | \ \ \ \ \ \ **MaxNumSupported** | number | Yes | read-only | This is the maximum number of members allowable for this particular redundancy group. | | ||
| + | | \ \ \ \ \ \ **MemberId** | string | | read-write | This is the identifier for the member within the collection. | | ||
| + | | \ \ \ \ \ \ **MinNumNeeded** | number | Yes | read-only | This is the minumum number of members needed for this group to be redundant. | | ||
| + | | \ \ \ \ \ \ **Mode** | string | Yes | read-write | This is the redundancy mode of the group.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **Name** | string | | read-only | The name of the resource or array element. | | ||
| + | | \ \ \ \ \ \ **Oem** {} | object | | read-write | This is the manufacturer/ | ||
| + | | \ \ \ \ \ \ **RedundancySet** [ {} ] | array | | read-only | Contains any ids that represent components of this redundancy set. | | ||
| + | | \ \ \ \ \ \ **Status** {} | object | ||
| + | | \ \ \ \ \ \ **MemberId** | string | | read-only | This is the identifier for the member within the collection. | | ||
| + | | \ \ \ \ \ \ **RedundancyEnabled** | boolean | Yes | read-write | This indicates whether redundancy is enabled. | | ||
| + | | } ] | | | | ||
| + | | **Status** { | object | | read-only | Indicates the status of the file share. | | ||
| + | | \ \ \ \ \ \ **Health** | string | ||
| + | | \ \ \ \ \ \ **HealthRollup** | string | ||
| + | | \ \ \ \ \ \ **Oem** {} | object | ||
| + | | \ \ \ \ \ \ **State** | string | ||
| + | | } | | | | ||
| + | | **Temperatures** [ { | array | | ||
| + | | \ \ \ \ \ \ **LowerThresholdCritical** | number | Yes | read-only | Below normal range but not yet fatal.\\ unit: Cel | | ||
| + | | \ \ \ \ \ \ **LowerThresholdFatal** | number | Yes | read-only | Below normal range and is fatal.\\ unit: Cel | | ||
| + | | \ \ \ \ \ \ **LowerThresholdNonCritical** | number | Yes | read-only | Below normal range.\\ unit: Cel | | ||
| + | | \ \ \ \ \ \ **MaxReadingRangeTemp** | number | Yes | read-only | Maximum value for ReadingCelsius.\\ unit: Cel | | ||
| + | | \ \ \ \ \ \ **MemberId** | string | | read-only | This is the identifier for the member within the collection. | | ||
| + | | \ \ \ \ \ \ **MinReadingRangeTemp** | number | Yes | read-only | Minimum value for ReadingCelsius.\\ unit: Cel | | ||
| + | | \ \ \ \ \ \ **Name** | string | Yes | read-only | Temperature sensor name. | | ||
| + | | \ \ \ \ \ \ **Oem** {} | object | | read-write | This is the manufacturer/ | ||
| + | | \ \ \ \ \ \ **PhysicalContext** | string | | read-write | Describes the area or device to which this temperature measurement applies.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **ReadingCelsius** | number | Yes | read-only | Temperature.\\ unit: Cel | | ||
| + | | \ \ \ \ \ \ **RelatedItem** [ {} ] | array | | read-only | Describes the areas or devices to which this temperature measurement applies. | | ||
| + | | \ \ \ \ \ \ **SensorNumber** | number | Yes | read-only | A numerical identifier to represent the temperature sensor. | | ||
| + | | \ \ \ \ \ \ **Status** {} | object | | read-only | Indicates the status of the file share. | | ||
| + | | \ \ \ \ \ \ **UpperThresholdCritical** | number | Yes | read-only | Above normal range but not yet fatal.\\ unit: Cel | | ||
| + | | \ \ \ \ \ \ **UpperThresholdFatal** | number | Yes | read-only | Above normal range and is fatal.\\ unit: Cel | | ||
| + | | \ \ \ \ \ \ **UpperThresholdNonCritical** | number | Yes | read-only | Above normal range.\\ unit: Cel | | ||
| + | | } ] | | | ||
| === Property Details === | === Property Details === | ||
| Line 4779: | Line 5193: | ||
| This is the schema definition for the Update Service. It represents the properties for the service itself and has links to collections of firmware and software inventory. | This is the schema definition for the Update Service. It represents the properties for the service itself and has links to collections of firmware and software inventory. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Actions** { | object | read-write | The Actions object contains the available custom actions on this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **[[documentation: | + | | **FirmwareInventory** | object | Yes | read-write | An inventory of firmware. | |
| - | | **HttpPushUri** | string | read-only | The URI used to perform an HTTP or HTTPS push update to the Update Service.\\ format: uri | | + | | **HttpPushUri** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **ServiceEnabled** | boolean, null | read-write | This indicates whether this service is enabled. | | + | | **ServiceEnabled** | boolean |
| - | | **[[documentation: | + | | **SoftwareInventory** | object | Yes | read-write | An inventory of software. | |
| - | | **Status** { | object, null | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| === Property Details === | === Property Details === | ||
| Line 4835: | Line 5249: | ||
| This resource contains information for a Virtual LAN (VLAN) network instance available on a manager, system or other device. | This resource contains information for a Virtual LAN (VLAN) network instance available on a manager, system or other device. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **VLANEnable** | boolean, null | read-write | This indicates if this VLAN is enabled. | | + | | **VLANEnable** | boolean |
| - | | **VLANId** | number, null | read-write | This indicates the VLAN identifier for this VLAN.\\ maximum: 4094 | | + | | **VLANId** | number |
| ===== VLanNetworkInterfaceCollection ===== | ===== VLanNetworkInterfaceCollection ===== | ||
| Line 4847: | Line 5261: | ||
| A Collection of VLanNetworkInterface resource instances. | A Collection of VLanNetworkInterface resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== VirtualMedia ===== | ===== VirtualMedia ===== | ||
| Line 4857: | Line 5271: | ||
| This resource allows monitoring and control of an instance of virtual media (e.g. a remote CD, DVD, or USB device) functionality provided by a Manager for a system or device. | This resource allows monitoring and control of an instance of virtual media (e.g. a remote CD, DVD, or USB device) functionality provided by a Manager for a system or device. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **ConnectedVia** | string, null | read-write | Current virtual media connection methods.\\ | + | | **ConnectedVia** | string |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Image** | string, null | read-only | A URI providing the location of the selected image.\\ format: uri | | + | | **Image** | string |
| - | | **ImageName** | string, null | read-only | The current image name. | | + | | **ImageName** | string |
| - | | **Inserted** | boolean, null | read-only | Indicates if virtual media is inserted in the virtual device. | | + | | **Inserted** | boolean |
| - | | **MediaTypes** [ {} ] | array | read-only | This is the media types supported as virtual media. | | + | | **MediaTypes** [ {} ] | array | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **WriteProtected** | boolean, null | read-only | Indicates the media is write protected. | | + | | **WriteProtected** | boolean |
| === Property Details === | === Property Details === | ||
| Line 4884: | Line 5298: | ||
| A Collection of VirtualMedia resource instances. | A Collection of VirtualMedia resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== Volume ===== | ===== Volume ===== | ||
| Line 4894: | Line 5308: | ||
| Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system. | Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **AccessCapabilities** [ {} ] | array | read-write | Supported IO access capabilities. | | + | | **AccessCapabilities** [ {} ] | array | |
| - | | **Actions** { | object | read-only | The available actions for this resource. | | + | | **Actions** { | object |
| - | | < | + | | \ \ \ \ \ \ **# |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **AllocatedPools** [ {} ] | array | read-only | An array of references to StoragePools allocated from this Volume. | | + | | **AllocatedPools** |
| - | | **BlockSizeBytes** | number, null | read-only | The size of the smallest addressable unit (Block) of this volume in bytes\\ unit: By | | + | | **BlockSizeBytes** | number |
| - | | **Capacity** { | object, null | read-write | Capacity utilization. | | + | | **Capacity** { | object |
| - | | < | + | | \ \ \ \ \ \ **Data** {} | object |
| - | | < | + | | \ \ \ \ \ \ **IsThinProvisioned** | boolean |
| - | | < | + | | \ \ \ \ \ \ **Metadata** {} | object |
| - | | < | + | | \ \ \ \ \ \ **Snapshot** {} | object |
| - | | } | | + | | } | | | |
| - | | **CapacityBytes** | number, null | read-only | The size in bytes of this Volume\\ unit: By | | + | | **CapacityBytes** | number |
| - | | **CapacitySources** [ {} ] | array | read-write | An array of space allocations to this volume. | | + | | **CapacitySources** [ { | array | |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | \ \ \ \ \ \ **ProvidedCapacity** {} | object | Yes | read-write | The amount of space that has been provided from the ProvidingDrives, |
| - | | **Encrypted** | boolean, null | read-write | Is this Volume encrypted | | + | | \ \ \ \ \ \ **ProvidedClassOfService** {} | object | Yes | read-write | The ClassOfService provided from the ProvidingDrives, |
| - | | **EncryptionTypes** [ {} ] | array | read-write | The types of encryption used by this Volume | | + | | \ \ \ \ \ \ **ProvidingDrives** {} | object | Yes | read-write | The drive or drives that provide this space. | |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | \ \ \ \ \ \ **ProvidingPools** {} | object | Yes | read-write | The pool or pools that provide this space. | |
| - | | **Identifiers** [ {} ] | array | read-only | The Durable names for the volume | | + | | \ \ \ \ \ \ **ProvidingVolumes** {} | object | Yes | read-write | The volume or volumes that provide this space. | |
| - | | **Links** { | object | read-only | Contains references to other resources that are related to this resource. | | + | | } ] | | |
| - | | < | + | | **Description** | string |
| - | | < | + | | **Encrypted** | boolean |
| - | | < | + | | **EncryptionTypes** [ {} ] | array | |
| - | | } | | + | | **Id** | string |
| - | | **LowSpaceWarningThresholdPercents** [ {} ] | array | read-write | Low space warning. | | + | | **Identifiers** [ { | array | |
| - | | **Manufacturer** | string, null | read-only | The manufacturer or OEM of this storage volume. | | + | | \ \ \ \ \ \ **DurableName** | string | Yes | read-only | This indicates the world wide, persistent name of the resource. | |
| - | | **MaxBlockSizeBytes** | number, null | read-only | Max Block size in bytes .\\ unit: By | | + | | \ \ \ \ \ \ **DurableNameFormat** | string | Yes | read-write | This represents the format of the DurableName property.\\ //See Property Details, below, for more information about this property.// | |
| - | | **Model** | string, null | read-only | The model number for this storage volume | | + | | } ] | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Links** { | object |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | \ \ \ \ \ \ **ClassOfService** |
| - | | **Operations** [ {} ] | array | read-only | The operations currently running on the Volume | | + | | \ \ \ \ \ \ **Drives** [ {} ] | array | |
| - | | **OptimumIOSizeBytes** | number, null | read-only | The size in bytes of this Volume' | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | **ReplicaInfos** [ {} ] | array | read-only | Describes this storage volume in its role as a source and/or target replica. | | + | | } | | | |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | **LowSpaceWarningThresholdPercents** [ {} ] | array | |
| - | | < | + | | **Manufacturer** | string |
| - | | < | + | | **MaxBlockSizeBytes** | number |
| - | | < | + | | **Model** | string |
| - | | < | + | | **Name** | string |
| - | | } | | + | | **Oem** {} | object |
| - | | **StorageGroups** [ {} ] | array | read-only | An array of references to Storage Groups that includes this volume. | | + | | **Operations** [ { | array | |
| - | | **VolumeType** | string, null | read-write | The type of this volume\\ | + | | \ \ \ \ \ \ **AssociatedTask** {} | object | | read-write | A reference to the task associated with the operation if any. | |
| + | | \ \ \ \ \ \ **OperationName** | string | Yes | read-only | The name of the operation. | | ||
| + | | \ \ \ \ \ \ **PercentageComplete** | number | Yes | read-only | The percentage of the operation that has been completed. | | ||
| + | | } ] | | | ||
| + | | **OptimumIOSizeBytes** | number | ||
| + | | **ReplicaInfos** [ { | array | | ||
| + | | \ \ \ \ \ \ **ConsistencyEnabled** | boolean | Yes | read-only | True if consistency is enabled. | | ||
| + | | \ \ \ \ \ \ **ConsistencyState** | string | Yes | read-write | The current state of consistency.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **ConsistencyStatus** | string | Yes | read-write | The current status of consistency.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **ConsistencyType** | string | Yes | read-write | Indicates the consistency type used by the source and its associated target group.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **FailedCopyStopsHostIO** | boolean | Yes | read-only | If true, the storage array tells host to stop sending data to source element if copying to a remote element fails. | | ||
| + | | \ \ \ \ \ \ **PercentSynced** | number | Yes | read-only | Specifies the percent of the work completed to reach synchronization.\\ unit: % | | ||
| + | | \ \ \ \ \ \ **Replica** | | Yes | read-write | The resource that is the source of this replica. | | ||
| + | | \ \ \ \ \ \ **ReplicaPriority** | string | Yes | read-write | The priority of background copy engine I/O to be managed relative to host I/O operations during a sequential background copy operation.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **ReplicaProgressStatus** | string | Yes | read-write | The status of the session with respect to Replication activity.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **ReplicaReadOnlyAccess** | string | Yes | read-write | This property specifies whether the source, the target, or both elements are read only to the host.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **ReplicaRecoveryMode** | string | Yes | read-write | Describes whether the copy operation continues after a broken link is restored.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **ReplicaRole** | string | Yes | read-write | The source or target role of this replica.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **ReplicaSkewBytes** | number | Yes | read-only | Applies to Adaptive mode and it describes maximum number of bytes the SyncedElement (target) can be out of sync.\\ unit: By | | ||
| + | | \ \ \ \ \ \ **ReplicaState** | string | Yes | read-write | ReplicaState describes the state of the relationship with respect to Replication activity.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **ReplicaType** | string | Yes | read-write | ReplicaType describes the intended outcome of the replication.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **ReplicaUpdateMode** | string | Yes | read-write | Describes whether the target elements will be updated synchronously or asynchronously.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **RequestedReplicaState** | string | Yes | read-write | The last requested or desired state for the relationship.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **SyncMaintained** | boolean | Yes | read-only | Synchronization is maintained. | | ||
| + | | \ \ \ \ \ \ **UndiscoveredElement** | string | Yes | read-write | This property specifies whether the source, the target, or both elements involved in a copy operation are undiscovered.\\ //See Property Details, below, for more information about this property.// | | ||
| + | | \ \ \ \ \ \ **WhenActivated** | string | Yes | read-only | Specifies when point-in-time copy was taken or when the replication relationship is activated, reactivated, | ||
| + | | \ \ \ \ \ \ **WhenDeactivated** | string | Yes | read-only | Specifies when the replication relationship is deactivated.\\ unit: % | | ||
| + | | \ \ \ \ \ \ **WhenEstablished** | string | Yes | read-only | Specifies when the replication relationship is established.\\ unit: % | | ||
| + | | \ \ \ \ \ \ **WhenSuspended** | string | Yes | read-only | Specifies when the replication relationship is suspended.\\ unit: % | | ||
| + | | \ \ \ \ \ \ **WhenSynced** | string | Yes | read-only | The point in time that the Elements were synchronized. | | ||
| + | | \ \ \ \ \ \ **WhenSynchronized** | string | Yes | read-only | Specifies when the replication relationship is synchronized.\\ unit: % | | ||
| + | | } ] | | | ||
| + | | **Status** { | object | ||
| + | | \ \ \ \ \ \ **Health** | string | ||
| + | | \ \ \ \ \ \ **HealthRollup** | string | ||
| + | | \ \ \ \ \ \ **Oem** {} | object | ||
| + | | \ \ \ \ \ \ **State** | string | ||
| + | | } | | | | ||
| + | | **StorageGroups** | ||
| + | | **VolumeType** | string | ||
| === Property Details === | === Property Details === | ||
| Line 5128: | Line 5581: | ||
| A Collection of Volume resource instances. | A Collection of Volume resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-write | The value of each member references a Volume resource. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| ===== Zone ===== | ===== Zone ===== | ||
| Line 5138: | Line 5591: | ||
| Switch contains properties describing a simple fabric zone. | Switch contains properties describing a simple fabric zone. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | + | | **Id** | string |
| - | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | + | | **Links** { | object |
| - | | < | + | | \ \ \ \ \ \ **Endpoints** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **InvolvedSwitches** [ {} ] | array | |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | } | | + | | } | | | |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |
| - | | **Status** { | object | read-only | Indicates the status of the file share. | | + | | **Status** { | object |
| - | | < | + | | \ \ \ \ \ \ **Health** | string |
| - | | < | + | | \ \ \ \ \ \ **HealthRollup** | string |
| - | | < | + | | \ \ \ \ \ \ **Oem** {} | object |
| - | | < | + | | \ \ \ \ \ \ **State** | string |
| - | | } | | + | | } | | | |
| === Property Details === | === Property Details === | ||
| Line 5191: | Line 5644: | ||
| A Collection of Zone resource instances. | A Collection of Zone resource instances. | ||
| - | ^ Property ^ Type ^ Permission ^ Description ^ | + | ^ Property ^ Type ^ Nullable |
| - | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | + | | **Description** | string |
| - | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | + | | **Members** |
| - | | **Name** | string | read-write | A friendly name for this line of service. | | + | | **Name** | string |
| - | | **Oem** {} | object | read-write | This is the manufacturer/ | + | | **Oem** {} | object |