meta data for this page
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
documentation:redfish_api:schema_definition [2017/04/24 12:46] – bil | documentation:redfish_api:schema_definition [2017/10/13 12:51] (current) – removed vor | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Schema Definition ====== | ||
- | |||
- | ===== AccountService ===== | ||
- | |||
- | Account Service contains properties common to all user accounts, such as password requirements, | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **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 | | ||
- | | **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 | | ||
- | | **AccountLockoutThreshold** | number, null | read-write | The number of failed login attempts before a user account is locked for a specified duration (0=never locked). | | ||
- | | **[[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. | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **MaxPasswordLength** | number | read-only | This is the maximum password length for this service. | | ||
- | | **MinPasswordLength** | number | read-only | This is the minimum password length for this service. | | ||
- | | **Name** | string | read-write | The name of the resource or array element. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **[[documentation: | ||
- | | **[[documentation: | ||
- | | **ServiceEnabled** | boolean, null | read-write | This indicates whether this service is enabled. | | ||
- | | **Status** { | object | read-only | | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== ActionInfo ===== | ||
- | |||
- | ActionInfo describes the parameters and other information necessary to perform a Redfish Action to a particular Action target. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Name** | string | read-write | The name of the resource or array element. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **Parameters** [ {} ] | array | read-write | The parameters associated with the specified Redfish Action. | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == DataType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Boolean | A boolean (true or false). | | ||
- | | Number | A number. | | ||
- | | NumberArray | An array of numbers. | | ||
- | | Object | An embedded JSON object. | | ||
- | | ObjectArray | An array of JSON objects. | | ||
- | | String | A string. | | ||
- | | StringArray | An array of strings. | | ||
- | |||
- | |||
- | ===== AttributeRegistry ===== | ||
- | |||
- | An Attribute Registry is a set of key-value pairs which are specific to a particular implementation or product, such that creating standardized property names would be impractical. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Language** | string | read-only | This is the RFC 5646 compliant language code for the registry. | | ||
- | | **Name** | string | read-write | The name of the resource or array element. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **OwningEntity** | string | read-only | This is the organization or company that publishes this registry. | | ||
- | | **RegistryEntries** { | object | read-write | List of all attributes and their metadata for this component. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **RegistryVersion** | string | read-only | This is the attribute registry version which is used in the middle portion of a AttributeRegistry. | | ||
- | | **SupportedSystems** [ {} ] | array | read-write | Array of systems supported by this attribute registry. | | ||
- | |||
- | ===== Bios ===== | ||
- | |||
- | 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 ^ | ||
- | | **Actions** { | object | read-write | The available actions for this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **AttributeRegistry** | string, null | read-only | The Resource ID of the Attribute Registry for the BIOS Attributes resource. | | ||
- | | **Attributes** {} | object | read-write | This is the manufacturer/ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Name** | string | read-write | The name of the resource or array element. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== Chassis ===== | ||
- | |||
- | A Chassis represents the physical components for any system. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Actions** { | object | read-write | The available actions for this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **AssetTag** | string, null | read-write | The user assigned asset tag for this chassis. | | ||
- | | **ChassisType** | string | read-write | This property indicates the type of physical form factor of this resource.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **DepthMm** | number, null | read-only | The depth of the chassis.\\ unit: mm | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **HeightMm** | number, null | read-only | The height of the chassis.\\ unit: mm | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **IndicatorLED** | string, null | read-write | The state of the indicator LED, used to identify the chassis.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Location** { | object | read-only | | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **[[documentation: | ||
- | | **Manufacturer** | string, null | read-only | This is the manufacturer of this chassis. | | ||
- | | **Model** | string, null | read-only | This is the model number for the chassis. | | ||
- | | **Name** | string | read-write | The name of the resource or array element. | | ||
- | | **[[documentation: | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **PartNumber** | string, null | read-only | The part number for this chassis. | | ||
- | | **PhysicalSecurity** { | object | read-write | The state of the physical security sensor. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **[[documentation: | ||
- | | **PowerState** | string, null | read-write | This is the current power state of the chassis.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **SKU** | string, null | read-only | This is the SKU for this chassis. | | ||
- | | **SerialNumber** | string, null | read-only | The serial number for this chassis. | | ||
- | | **Status** { | object | read-only | | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **[[documentation: | ||
- | | **WeightKg** | number, null | read-only | The weight of the chassis.\\ unit: kg | | ||
- | | **WidthMm** | number, null | read-only | The width of the chassis.\\ unit: mm | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == ChassisType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Blade | An enclosed or semi-enclosed, | ||
- | | Card | A loose device or circuit board intended to be installed in a system or other enclosure. | | ||
- | | Cartridge | A small self-contained system intended to be plugged into a multi-system chassis. | | ||
- | | Component | A small chassis, card, or device which contains devices for a particular subsystem or function. | | ||
- | | Drawer | An enclosed or semi-enclosed, | ||
- | | Enclosure | A generic term for a chassis that does not fit any other description. | | ||
- | | Expansion | A chassis which expands the capabilities or capacity of another chassis. | | ||
- | | IPBasedDrive | A chassis in a drive form factor with IP-based network connections. | | ||
- | | Module | A small, typically removable, chassis or card which contains devices for a particular subsystem or function. | | ||
- | | Other | A chassis that does not fit any of these definitions. | | ||
- | | Pod | A collection of equipment racks in a large, likely transportable, | ||
- | | Rack | An equipment rack, typically a 19-inch wide freestanding unit. | | ||
- | | RackGroup | A group of racks which form a single entity or share infrastructure. | | ||
- | | RackMount | A single system chassis designed specifically for mounting in an equipment rack. | | ||
- | | Row | A collection of equipment racks. | | ||
- | | Shelf | An enclosed or semi-enclosed, | ||
- | | Sidecar | A chassis that mates mechanically with another chassis to expand its capabilities or capacity. | | ||
- | | Sled | An enclosed or semi-enclosed, | ||
- | | StandAlone | A single, free-standing system, commonly called a tower or desktop chassis. | | ||
- | | Zone | A logical division or portion of a physical chassis that contains multiple devices or systems that cannot be physically separated. | | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == IndicatorLED == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Blinking | The Indicator LED is blinking. | | ||
- | | Lit | The Indicator LED is lit. | | ||
- | | Off | The Indicator LED is off. | | ||
- | | Unknown | The state of the Indicator LED cannot be determined. Deprecated: Return null if state is unknown. | | ||
- | |||
- | == IntrusionSensor == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | HardwareIntrusion | A door, lock, or other mechanism protecting the internal system hardware from being accessed is detected as being in an insecure state. | | ||
- | | Normal | No abnormal physical security conditions are detected at this time. | | ||
- | | TamperingDetected | Physical tampering of the monitored entity is detected. | | ||
- | |||
- | == IntrusionSensorReArm == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Automatic | This sensor would be restored to the Normal state automatically as no abnormal physical security conditions are detected. | | ||
- | | Manual | This sensor would be restored to the Normal state by a manual re-arm. | | ||
- | |||
- | == PowerState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Off | The components within the chassis has no power, except some components may continue to have AUX power such as management controller. | | ||
- | | On | The components within the chassis has power on. | | ||
- | | PoweringOff | A temporary state between On and Off. The components within the chassis can take time to process the power off action. | | ||
- | | PoweringOn | A temporary state between Off and On. The components within the chassis can take time to process the power on action. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== ChassisCollection ===== | ||
- | |||
- | A Collection of Chassis resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | The name of the resource or array element. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == ChassisType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Blade | An enclosed or semi-enclosed, | ||
- | | Card | A loose device or circuit board intended to be installed in a system or other enclosure. | | ||
- | | Cartridge | A small self-contained system intended to be plugged into a multi-system chassis. | | ||
- | | Component | A small chassis, card, or device which contains devices for a particular subsystem or function. | | ||
- | | Drawer | An enclosed or semi-enclosed, | ||
- | | Enclosure | A generic term for a chassis that does not fit any other description. | | ||
- | | Expansion | A chassis which expands the capabilities or capacity of another chassis. | | ||
- | | IPBasedDrive | A chassis in a drive form factor with IP-based network connections. | | ||
- | | Module | A small, typically removable, chassis or card which contains devices for a particular subsystem or function. | | ||
- | | Other | A chassis that does not fit any of these definitions. | | ||
- | | Pod | A collection of equipment racks in a large, likely transportable, | ||
- | | Rack | An equipment rack, typically a 19-inch wide freestanding unit. | | ||
- | | RackGroup | A group of racks which form a single entity or share infrastructure. | | ||
- | | RackMount | A single system chassis designed specifically for mounting in an equipment rack. | | ||
- | | Row | A collection of equipment racks. | | ||
- | | Shelf | An enclosed or semi-enclosed, | ||
- | | Sidecar | A chassis that mates mechanically with another chassis to expand its capabilities or capacity. | | ||
- | | Sled | An enclosed or semi-enclosed, | ||
- | | StandAlone | A single, free-standing system, commonly called a tower or desktop chassis. | | ||
- | | Zone | A logical division or portion of a physical chassis that contains multiple devices or systems that cannot be physically separated. | | ||
- | |||
- | == IndicatorLED == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Blinking | The Indicator LED is blinking. | | ||
- | | Lit | The Indicator LED is lit. | | ||
- | | Off | The Indicator LED is off. | | ||
- | | Unknown | The state of the Indicator LED cannot be determined. Deprecated: Return null if state is unknown. | | ||
- | |||
- | == PowerState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Off | The components within the chassis has no power, except some components may continue to have AUX power such as management controller. | | ||
- | | On | The components within the chassis has power on. | | ||
- | | PoweringOff | A temporary state between On and Off. The components within the chassis can take time to process the power off action. | | ||
- | | PoweringOn | A temporary state between Off and On. The components within the chassis can take time to process the power on action. | | ||
- | |||
- | |||
- | ===== ClassOfService ===== | ||
- | |||
- | A service option composed of one or more service options. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **ClassOfServiceVersion** | string, null | read-write | The value identifies the current version of this class of service definition. | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Identifier** { | object, null | read-only | The value identifies this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **LinesOfService** { | object, null | read-write | Lines of Service that define the required choices of utility or warranty. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Name** | string | read-write | The name of the resource or array element. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == DurableNameFormat == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
- | | FC_WWN | Fibre Channel World Wide Name | | ||
- | | NAA | Name Address Authority Format | | ||
- | | UUID | Universally Unique Identifier | | ||
- | | iQN | iSCSI Qualified Name | | ||
- | |||
- | |||
- | ===== ClassOfServiceCollection ===== | ||
- | |||
- | A Collection of ClassOfService resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | The value of each member references a ClassOfService resource. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | The name of the resource or array element. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== ComputerSystem ===== | ||
- | |||
- | This schema defines a computer system and its respective properties. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Actions** { | object | read-write | The available actions for this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **AssetTag** | string, null | read-write | The user definable tag that can be used to track this computer system for inventory or other client purposes. | | ||
- | | **[[documentation: | ||
- | | **BiosVersion** | string, null | read-only | The version of the system BIOS or primary system firmware. | | ||
- | | **Boot** { | object | read-write | Information about the boot settings for this system. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **[[documentation: | ||
- | | **HostName** | string, null | read-write | The DNS Host Name, without any domain information. | | ||
- | | **HostedServices** { | object | read-write | The services that this computer system supports. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **HostingRoles** [ {} ] | array | read-only | The hosing roles that this computer system supports. | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **IndicatorLED** | string, null | read-write | The state of the indicator LED, used to identify the system.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **[[documentation: | ||
- | | **Manufacturer** | string, null | read-only | The manufacturer or OEM of this system. | | ||
- | | **[[documentation: | ||
- | | **[[documentation: | ||
- | | **MemorySummary** { | object | read-write | This object describes the central memory of the system in general detail. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Model** | string, null | read-only | The model number for this system. | | ||
- | | **Name** | string | read-write | The name of the resource or array element. | | ||
- | | **[[documentation: | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **PCIeDevices** [ {} ] | array | read-only | A reference to a collection of PCIe Devices used by this computer system. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **PCIeFunctions** [ {} ] | array | read-only | A reference to a collection of PCIe Functions used by this computer system. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **PartNumber** | string, null | read-only | The part number for this system. | | ||
- | | **PowerState** | string, null | read-write | This is the current power state of the system.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **ProcessorSummary** { | object | read-write | This object describes the central processors of the system in general detail. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **[[documentation: | ||
- | | **SKU** | string, null | read-only | The manufacturer SKU for this system. | | ||
- | | **[[documentation: | ||
- | | **SerialNumber** | string, null | read-only | The serial number for this system. | | ||
- | | **[[documentation: | ||
- | | **Status** { | object | read-only | | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **[[documentation: | ||
- | | **SystemType** | string | read-write | The type of computer system represented by this resource.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **TrustedModules** [ {} ] | array | read-write | This object describes the array of Trusted Modules in the system. | | ||
- | | **UUID** | string, null | read-write | The universal unique identifier (UUID) for this system.\\ pattern: ([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}) | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == BootSourceOverrideEnabled == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Continuous | The system will boot to the target specified in the BootSourceOverrideTarget until this property is set to Disabled. | | ||
- | | Disabled | The system will boot normally. | | ||
- | | Once | On its next boot cycle, the system will boot (one time) to the Boot Source Override Target. The value of BootSourceOverrideEnabled is then reset back to Disabled. | | ||
- | |||
- | == BootSourceOverrideMode == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Legacy | The system will boot in non-UEFI boot mode to the Boot Source Override Target. | | ||
- | | UEFI | The system will boot in UEFI boot mode to the Boot Source Override Target. | | ||
- | |||
- | == BootSourceOverrideTarget == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | BiosSetup | Boot to the BIOS Setup Utility. | | ||
- | | Cd | Boot from the CD/DVD disc. | | ||
- | | Diags | Boot the manufacturer' | ||
- | | Floppy | Boot from the floppy disk drive. | | ||
- | | Hdd | Boot from a hard drive. | | ||
- | | None | Boot from the normal boot device. | | ||
- | | Pxe | Boot from the Pre-Boot EXecution (PXE) environment. | | ||
- | | RemoteDrive | Boot from a remote drive (e.g. iSCSI). | | ||
- | | SDCard | Boot from an SD Card. | | ||
- | | UefiHttp | Boot from a UEFI HTTP network location. | | ||
- | | UefiShell | Boot to the UEFI Shell. | | ||
- | | UefiTarget | Boot to the UEFI Device specified in the UefiTargetBootSourceOverride property. | | ||
- | | Usb | Boot from a USB device as specified by the system BIOS. | | ||
- | | Utilities | Boot the manufacturer' | ||
- | |||
- | == DeviceClass == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Bridge | A bridge. | | ||
- | | CommunicationController | A communication controller. | | ||
- | | Coprocessor | A coprocessor. | | ||
- | | DisplayController | A display controller. | | ||
- | | DockingStation | A docking station. | | ||
- | | EncryptionController | An encryption controller. | | ||
- | | GenericSystemPeripheral | A generic system peripheral. | | ||
- | | InputDeviceController | An input device controller. | | ||
- | | IntelligentController | An intelligent controller. | | ||
- | | MassStorageController | A mass storage controller. | | ||
- | | MemoryController | A memory controller. | | ||
- | | MultimediaController | A multimedia controller. | | ||
- | | NetworkController | A network controller. | | ||
- | | NonEssentialInstrumentation | A non-essential instrumentation. | | ||
- | | Other | A other class. The function Device Class Id needs to be verified. | | ||
- | | ProcessingAccelerators | A processing accelerators. | | ||
- | | Processor | A processor. | | ||
- | | SatelliteCommunicationsController | A satellite communications controller. | | ||
- | | SerialBusController | A serial bus controller. | | ||
- | | SignalProcessingController | A signal processing controller. | | ||
- | | UnassignedClass | An unassigned class. | | ||
- | | UnclassifiedDevice | An unclassified device. | | ||
- | | WirelessController | A wireless controller. | | ||
- | |||
- | == DeviceType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | MultiFunction | A multi-function PCIe device. | | ||
- | | Simulated | A PCIe device which is not currently physically present, but is being simulated by the PCIe infrastructure. | | ||
- | | SingleFunction | A single-function PCIe device. | | ||
- | |||
- | == FunctionType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Physical | A physical PCie function. | | ||
- | | Virtual | A virtual PCIe function. | | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == IndicatorLED == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Blinking | The Indicator LED is blinking. | | ||
- | | Lit | The Indicator LED is lit. | | ||
- | | Off | The Indicator LED is off. | | ||
- | | Unknown | The state of the Indicator LED cannot be determined. Deprecated: Return null if state is unknown. | | ||
- | |||
- | == InterfaceType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | TCM1_0 | Trusted Cryptography Module (TCM) 1.0. | | ||
- | | TPM1_2 | Trusted Platform Module (TPM) 1.2. | | ||
- | | TPM2_0 | Trusted Platform Module (TPM) 2.0. | | ||
- | |||
- | == InterfaceTypeSelection == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | BiosSetting | The TrustedModule supports switching InterfaceType via platform software, such as a BIOS configuration Attribute. | | ||
- | | FirmwareUpdate | The TrustedModule supports switching InterfaceType via a firmware update. | | ||
- | | None | The TrustedModule does not support switching the InterfaceType. | | ||
- | | OemMethod | The TrustedModule supports switching InterfaceType via an OEM proprietary mechanism. | | ||
- | |||
- | == MemoryMirroring == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | DIMM | The system supports DIMM mirroring at the DIMM level. | ||
- | | Hybrid | The system supports a hybrid mirroring at the system and DIMM levels. | ||
- | | None | The system does not support DIMM mirroring. | | ||
- | | System | The system supports DIMM mirroring at the System level. | ||
- | |||
- | == PowerState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Off | The system is powered off, although some components may continue to have AUX power such as management controller. | | ||
- | | On | The system is powered on. | | ||
- | | PoweringOff | A temporary state between On and Off. The power off action can take time while the OS is in the shutdown process. | | ||
- | | PoweringOn | A temporary state between Off and On. This temporary state can be very short. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | == SystemType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | OS | An operating system instance. | | ||
- | | Physical | A computer system. | | ||
- | | PhysicallyPartitioned | A hardware-based partition of a computer system. | | ||
- | | Virtual | A virtual machine instance running on this system. | | ||
- | | VirtuallyPartitioned | A virtual or software-based partition of a computer system. | | ||
- | |||
- | |||
- | ===== ComputerSystemCollection ===== | ||
- | |||
- | A Collection of ComputerSystem resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | The name of the resource or array element. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == IndicatorLED == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Blinking | The Indicator LED is blinking. | | ||
- | | Lit | The Indicator LED is lit. | | ||
- | | Off | The Indicator LED is off. | | ||
- | | Unknown | The state of the Indicator LED cannot be determined. Deprecated: Return null if state is unknown. | | ||
- | |||
- | == PowerState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Off | The system is powered off, although some components may continue to have AUX power such as management controller. | | ||
- | | On | The system is powered on. | | ||
- | | PoweringOff | A temporary state between On and Off. The power off action can take time while the OS is in the shutdown process. | | ||
- | | PoweringOn | A temporary state between Off and On. This temporary state can be very short. | | ||
- | |||
- | == SystemType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | OS | An operating system instance. | | ||
- | | Physical | A computer system. | | ||
- | | PhysicallyPartitioned | A hardware-based partition of a computer system. | | ||
- | | Virtual | A virtual machine instance running on this system. | | ||
- | | VirtuallyPartitioned | A virtual or software-based partition of a computer system. | | ||
- | |||
- | |||
- | ===== DataProtectionLoSCapabilities ===== | ||
- | |||
- | Describe data protection capabilities | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Identifier** { | object, null | read-only | The value identifies this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Links** { | object | read-only | Contains links to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Name** | string | read-write | The name of the resource or array element. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **SupportedDataProtectionLinesOfService** [ {} ] | array | read-write | Collection of known and supported DataProtectionLinesOfService. | | ||
- | | **SupportedMinLifetime** [ {} ] | array | read-write | Supported minimum lifetime that replica must be maintained. | | ||
- | | **SupportedRecoveryGeographicObjectives** [ {} ] | array | read-write | Supported types of failure domains. | | ||
- | | **SupportedRecoveryPointObjectiveSeconds** [ {} ] | array | read-write | Supported time intervals defining how much source information can be lost on failure. | | ||
- | | **SupportedRecoveryTimeObjectives** [ {} ] | array | read-write | Supported expectations for time to access an alternate replica. | | ||
- | | **SupportedReplicaTypes** [ {} ] | array | read-write | Supported replica types. | | ||
- | | **SupportsIsolated** | boolean, null | read-write | Allocating a replica in a separate fault domain is supported. | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == DurableNameFormat == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
- | | FC_WWN | Fibre Channel World Wide Name | | ||
- | | NAA | Name Address Authority Format | | ||
- | | UUID | Universally Unique Identifier | | ||
- | | iQN | iSCSI Qualified Name | | ||
- | |||
- | == RecoveryGeographicObjective == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Datacenter | A co-located set of servers, including network and storage that share communication, | ||
- | | Rack | A container for Servers, Networking, and Storage. | | ||
- | | RackGroup | A set of Racks that share common infrastructure. | | ||
- | | Region | A geographical or politically isolated set of resources. | | ||
- | | Row | An adjacent set of racks. | | ||
- | | Server | A CPU/memory complex. | | ||
- | |||
- | == RecoveryTimeObjective == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Immediate | Active access to synchronous replicas. | | ||
- | | Nearline | Access to replica via a different front-end interconnect. A restore step is required before recovery can commence. | | ||
- | | Offline | No direct connection to the replica. (i.e. To a bunker containing backup media.) | | ||
- | | Online | Passive access to replicas via the same front-end interconnect. | | ||
- | |||
- | == ReplicaType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Clone | Create a point in time, full copy the source. | | ||
- | | Mirror | Create and maintain a copy of the source. | | ||
- | | Snapshot | Create a point in time, virtual copy of the source. | | ||
- | | TokenizedClone | Create a token based clone. | | ||
- | |||
- | |||
- | ===== DataSecurityLoSCapabilities ===== | ||
- | |||
- | Describe data security capabilities. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Identifier** { | object, null | read-only | The value identifies this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **SupportedAntivirusEngineProviders** [ {} ] | array | read-write | Supported AntiVirus providers. | | ||
- | | **SupportedAntivirusScanPolicies** [ {} ] | array | read-write | Supported policies that trigger an AntiVirus scan. | | ||
- | | **SupportedChannelEncryptionStrengths** [ {} ] | array | read-write | Supported key sizes for transport channel encryption. | | ||
- | | **SupportedDataSanitizationPolicies** [ {} ] | array | read-write | Supported data sanitization policies. | | ||
- | | **SupportedDataSecurityLinesOfService** [ {} ] | array | read-write | Collection of known and supported DataSecurityLinesOfService. | | ||
- | | **SupportedHostAuthenticationTypes** [ {} ] | array | read-write | Supported authentication types for hosts (servers) or initiator endpoints. | | ||
- | | **SupportedMediaEncryptionStrengths** [ {} ] | array | read-write | Supported key sizes for media encryption. | | ||
- | | **SupportedSecureChannelProtocols** [ {} ] | array | read-write | Supported protocols that provide encrypted communication. | | ||
- | | **SupportedUserAuthenticationTypes** [ {} ] | array | read-write | Supported authentication types for users (or programs). | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == ChannelEncryptionStrength == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Bits_0 | No key. | | ||
- | | Bits_112 | 3DES 112 bit key. | | ||
- | | Bits_128 | AES 128 bit key. | | ||
- | | Bits_192 | AES 192 bit key. | | ||
- | | Bits_256 | AES 256 bit key. | | ||
- | |||
- | == DataSanitizationPolicy == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Clear | Sanitize data in all user-addressable storage locations for protection against simple non-invasive data recovery techniques. | | ||
- | | CryptographicErase | Leverages the encryption of target data by enabling sanitization of the target data's encryption key. This leaves only the ciphertext remaining on the media, effectively sanitizing the data by preventing read-access. For more information, | ||
- | | None | No sanitization. | | ||
- | |||
- | == DurableNameFormat == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
- | | FC_WWN | Fibre Channel World Wide Name | | ||
- | | NAA | Name Address Authority Format | | ||
- | | UUID | Universally Unique Identifier | | ||
- | | iQN | iSCSI Qualified Name | | ||
- | |||
- | == HostAuthenticationType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | None | No authentication. | | ||
- | | PKI | Public Key Infrastructure. | | ||
- | | Password | Password/ | ||
- | | Ticket | Ticket-based (e.g., Kerberos) | | ||
- | |||
- | == MediaEncryptionStrength == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Bits_0 | No key. | | ||
- | | Bits_112 | 3DES 112 bit key. | | ||
- | | Bits_128 | AES 128 bit key. | | ||
- | | Bits_192 | AES 192 bit key. | | ||
- | | Bits_256 | AES 256 bit key. | | ||
- | |||
- | == SecureChannelProtocol == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | IPsec | Internet Protocol Security (IPsec), as defined by IETF RFC 2401. | | ||
- | | None | No encryption. | | ||
- | | RPCSEC_GSS | RPC access to the Generic Security Services Application Programming Interface (GSS-API), as defined by IETF RPC 2203. | | ||
- | | TLS | Transport Layer Security (TLS), as defined by IETF RFC 5246. | | ||
- | |||
- | == UserAuthenticationType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | None | No authentication. | | ||
- | | PKI | Public Key Infrastructure. | | ||
- | | Password | Password/ | ||
- | | Ticket | Ticket-based (e.g., Kerberos) | | ||
- | |||
- | |||
- | ===== DataStorageLoSCapabilities ===== | ||
- | |||
- | Describe data storage capabilities. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Identifier** { | object, null | read-only | The value identifies this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **SupportedAccessCapabilities** [ {} ] | array | read-write | Supported access capabilities. | | ||
- | | **SupportedDataStorageLinesOfService** [ {} ] | array | read-write | Collection of known and supported DataStorageLinesOfService. | | ||
- | | **SupportedProvisioningPolicies** [ {} ] | array | read-write | Thin allows over allocation of storage. | | ||
- | | **SupportedRecoveryTimeObjectives** [ {} ] | array | read-write | Supported expectations for time to access the primary store after recovery. | | ||
- | | **SupportsSpaceEfficiency** | boolean, null | read-write | Allows compression or deduplication of storage. | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == DurableNameFormat == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
- | | FC_WWN | Fibre Channel World Wide Name | | ||
- | | NAA | Name Address Authority Format | | ||
- | | UUID | Universally Unique Identifier | | ||
- | | iQN | iSCSI Qualified Name | | ||
- | |||
- | == ProvisioningPolicy == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Fixed | Storage is fully allocated | | ||
- | | Thin | Storage may be over allocated. | | ||
- | |||
- | |||
- | ===== Drive ===== | ||
- | |||
- | Drive contains properties describing a single physical disk drive for any system, along with links to associated Volumes. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Actions** { | object | read-write | The available actions for this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **AssetTag** | string, null | read-write | The user assigned asset tag for this drive. | | ||
- | | **BlockSizeBytes** | number, null | read-only | The size of the smallest addressible unit (Block) of this drive in bytes.\\ unit: By | | ||
- | | **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 | | ||
- | | **CapacityBytes** | number, null | read-only | The size in bytes of this Drive.\\ unit: By | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **EncryptionAbility** | string, null | read-write | The encryption abilities of this drive.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **EncryptionStatus** | string, null | read-write | The status of the encrytion of this drive.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **FailurePredicted** | boolean, null | read-only | Is this drive currently predicting a failure in the near future. | | ||
- | | **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.* | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Identifiers** [ {} ] | array | read-write | The Durable names for the drive. | | ||
- | | **IndicatorLED** | string, null | read-write | The state of the indicator LED, used to identify the drive.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Location** [ {} ] | array | read-write | The Location of the drive. | | ||
- | | **Manufacturer** | string, null | read-only | This is the manufacturer of this drive. | | ||
- | | **MediaType** | string, null | read-write | The type of media contained in this drive.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Model** | string, null | read-only | This is the model number for the drive. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **NegotiatedSpeedGbs** | number, null | read-only | The speed which this drive is currently communicating to the storage controller in Gigabits per second.\\ unit: Gbit/s | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **Operations** [ {} ] | array | read-write | The operations currently running on the Drive. | | ||
- | | **PartNumber** | string, null | read-only | The part number for this drive. | | ||
- | | **PredictedMediaLifeLeftPercent** | number, null | read-only | The percentage of reads and writes that are predicted to still be available for the media. | | ||
- | | **Protocol** | null | read-write | The protocol this drive is using to communicate to the storage controller. | | ||
- | | **Revision** | string, null | read-only | The revision of this Drive. This is typically the firmware/ | ||
- | | **RotationSpeedRPM** | number, null | read-only | The rotation speed of this Drive in Revolutions per Minute (RPM).\\ unit: RPM | | ||
- | | **SKU** | string, null | read-only | This is the SKU for this drive. | | ||
- | | **SerialNumber** | string, null | read-only | The serial number for this drive. | | ||
- | | **Status** { | object | read-only | | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **StatusIndicator** | string, null | read-write | The state of the status indicator, used to communicate status information about this drive.\\ *See Property Details, below, for more information about this property.* | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == DurableNameFormat == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
- | | FC_WWN | Fibre Channel World Wide Name | | ||
- | | NAA | Name Address Authority Format | | ||
- | | UUID | Universally Unique Identifier | | ||
- | | iQN | iSCSI Qualified Name | | ||
- | |||
- | == EncryptionAbility == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | None | The drive is not capable of self encryption. | | ||
- | | Other | The drive is capable of self encryption through some other means. | | ||
- | | SelfEncryptingDrive | The drive is capable of self encryption per the Trusted Computing Group' | ||
- | |||
- | == EncryptionStatus == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Foreign | The drive is currently encrypted, the data is not accessible to the user, and the system requires user intervention to expose the data. | | ||
- | | Locked | The drive is currently encrypted and the data is not accessible to the user, however the system has the ability to unlock the drive automatically. | | ||
- | | Unecrypted | The drive is not currently encrypted. Deprecated: Use Unencrypted. | | ||
- | | Unencrypted | The drive is not currently encrypted. | | ||
- | | Unlocked | The drive is currently encrypted but the data is accessible to the user unencrypted. | | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HotspareType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Chassis | The drive is currently serving as a hotspare for all other drives in the chassis. | | ||
- | | Dedicated | The drive is currently serving as a hotspare for a user defined set of drives. | | ||
- | | Global | The drive is currently serving as a hotspare for all other drives in the storage system. | | ||
- | | None | The drive is not currently a hotspare. | | ||
- | |||
- | == IndicatorLED == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Blinking | The Indicator LED is blinking. | | ||
- | | Lit | The Indicator LED is lit. | | ||
- | | Off | The Indicator LED is off. | | ||
- | |||
- | == MediaType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | HDD | The drive media type is traditional magnetic platters. | | ||
- | | SMR | The drive media type is shingled magnetic recording. | | ||
- | | SSD | The drive media type is solid state or flash memory. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | == StatusIndicator == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Fail | The drive has failed. | | ||
- | | Hotspare | The drive is marked to be automatically rebuilt and used as a replacement for a failed drive. | | ||
- | | InACriticalArray | The array that this drive is a part of is degraded. | | ||
- | | InAFailedArray | The array that this drive is a part of is failed. | | ||
- | | OK | The drive is OK. | | ||
- | | PredictiveFailureAnalysis | The drive is still working but predicted to fail soon. | | ||
- | | Rebuild | The drive is being rebuilt. | | ||
- | |||
- | |||
- | ===== DriveCollection ===== | ||
- | |||
- | A Collection of Drive resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this drive collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == EncryptionAbility == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | None | The drive is not capable of self encryption. | | ||
- | | Other | The drive is capable of self encryption through some other means. | | ||
- | | SelfEncryptingDrive | The drive is capable of self encryption per the Trusted Computing Group' | ||
- | |||
- | == EncryptionStatus == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Foreign | The drive is currently encrypted, the data is not accessible to the user, and the system requires user intervention to expose the data. | | ||
- | | Locked | The drive is currently encrypted and the data is not accessible to the user, however the system has the ability to unlock the drive automatically. | | ||
- | | Unecrypted | The drive is not currently encrypted. Deprecated: Use Unencrypted. | | ||
- | | Unencrypted | The drive is not currently encrypted. | | ||
- | | Unlocked | The drive is currently encrypted but the data is accessible to the user unencrypted. | | ||
- | |||
- | == HotspareType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Chassis | The drive is currently serving as a hotspare for all other drives in the chassis. | | ||
- | | Dedicated | The drive is currently serving as a hotspare for a user defined set of drives. | | ||
- | | Global | The drive is currently serving as a hotspare for all other drives in the storage system. | | ||
- | | None | The drive is not currently a hotspare. | | ||
- | |||
- | == IndicatorLED == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Blinking | The Indicator LED is blinking. | | ||
- | | Lit | The Indicator LED is lit. | | ||
- | | Off | The Indicator LED is off. | | ||
- | |||
- | == MediaType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | HDD | The drive media type is traditional magnetic platters. | | ||
- | | SMR | The drive media type is shingled magnetic recording. | | ||
- | | SSD | The drive media type is solid state or flash memory. | | ||
- | |||
- | == StatusIndicator == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Fail | The drive has failed. | | ||
- | | Hotspare | The drive is marked to be automatically rebuilt and used as a replacement for a failed drive. | | ||
- | | InACriticalArray | The array that this drive is a part of is degraded. | | ||
- | | InAFailedArray | The array that this drive is a part of is failed. | | ||
- | | OK | The drive is OK. | | ||
- | | PredictiveFailureAnalysis | The drive is still working but predicted to fail soon. | | ||
- | | Rebuild | The drive is being rebuilt. | | ||
- | |||
- | |||
- | ===== Endpoint ===== | ||
- | |||
- | 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 ^ | ||
- | | **Actions** { | object | read-write | The Actions object contains the available custom actions on this resource. | | ||
- | | < | ||
- | | } | | ||
- | | **ConnectedEntities** [ {} ] | array | read-write | All the entities connected to this endpoint. | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **EndpointProtocol** | null | read-write | The protocol supported by this endpoint. | | ||
- | | **HostReservationMemoryBytes** | number, null | read-only | The amount of memory in Bytes that the Host should allocate to connect to this endpoint.\\ unit: By | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Identifiers** [ {} ] | array | read-write | Identifiers for this endpoint. | | ||
- | | **Links** { | object | read-write | The links object contains the links to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **PciId** { | object, null | read-write | The PCI ID of the endpoint. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Redundancy** [ {} ] | array | read-write | Redundancy information for the lower level endpoints supporting this endpoint. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Status** { | object, null | read-only | | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == DurableNameFormat == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
- | | FC_WWN | Fibre Channel World Wide Name | | ||
- | | NAA | Name Address Authority Format | | ||
- | | UUID | Universally Unique Identifier | | ||
- | | iQN | iSCSI Qualified Name | | ||
- | |||
- | == EntityRole == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Both | The entity is acting as both an initiator and a target. | | ||
- | | Initiator | The entity is acting as an initiator. | | ||
- | | Target | The entity is acting as a target. | | ||
- | |||
- | == EntityType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Bridge | The entity is a PCI(e) bridge. | | ||
- | | DisplayController | The entity is a display controller. | | ||
- | | Drive | The entity is a disk drive. The EntityLink property (if present) should be a Drive.Drive entity. | | ||
- | | NetworkController | The entity is a network controller. The EntityLink property (if present) should be an EthernetInterface.EthernetInterface entity. | | ||
- | | Processor | The entity is a processor device. | | ||
- | | RootComplex | The entity is a PCI(e) root complex. The EntityLink property (if present) should be a ComputerSystem.ComputerSystem entity. | | ||
- | | StorageExpander | The entity is a storage expander. The EntityLink property (if present) should be a Chassis.Chassis entity. | | ||
- | | StorageInitiator | The entity is a storage initator. The EntityLink property (if present) should be a Storage.StorageController entity. | | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == Mode == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Failover | Failure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set. | | ||
- | | N+m | Multiple units are available and active such that normal operation will continue if one or more units fail. | | ||
- | | Sharing | Multiple units contribute or share such that operation will continue, but at a reduced capacity, if one or more units fail. | | ||
- | | Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== EndpointCollection ===== | ||
- | |||
- | A Collection of Endpoint resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | The value of each member references an Endpoint resource. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== EndpointGroup ===== | ||
- | |||
- | A group of endpoints that are managed as a unit. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **AccessState** | string, null | read-write | Access State for this group.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **[[documentation: | ||
- | | **GroupType** | string, null | read-write | Endpoint group type.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Identifier** { | object, null | read-only | The value identifies this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Links** { | object | read-only | Contains links to other resources that are related to this resource. | | ||
- | | < | ||
- | | } | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **Preferred** | boolean, null | read-write | Access to resource is preferred. | | ||
- | | **TargetEndpointGroupIdentifier** | number, null | read-write | A defined identifier for this group. | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == AccessState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | NonOptimized | The endpoint(s) are in an Active/ | ||
- | | Optimized | The endpoint(s) are in an Active/ | ||
- | | Standby | The endpoint(s) are in a Standby state. | | ||
- | | Transitioning | The endpoint(s) are transitioning to a new AccesState. | | ||
- | | Unavailable | The endpoint(s) are unavailable. | | ||
- | |||
- | == DurableNameFormat == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
- | | FC_WWN | Fibre Channel World Wide Name | | ||
- | | NAA | Name Address Authority Format | | ||
- | | UUID | Universally Unique Identifier | | ||
- | | iQN | iSCSI Qualified Name | | ||
- | |||
- | == GroupType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Client | The group contains the client (initiator) endpoints. | | ||
- | | Server | The group contains the server (target) endpoints. | | ||
- | |||
- | |||
- | ===== EndpointGroupCollection ===== | ||
- | |||
- | A Collection of endpoint group resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | The value of each member references an endpoint group resource. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == AccessState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | NonOptimized | The endpoint(s) are in an Active/ | ||
- | | Optimized | The endpoint(s) are in an Active/ | ||
- | | Standby | The endpoint(s) are in a Standby state. | | ||
- | | Transitioning | The endpoint(s) are transitioning to a new AccesState. | | ||
- | | Unavailable | The endpoint(s) are unavailable. | | ||
- | |||
- | == GroupType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Client | The group contains the client (initiator) endpoints. | | ||
- | | Server | The group contains the server (target) endpoints. | | ||
- | |||
- | |||
- | ===== EthernetInterface ===== | ||
- | |||
- | This schema defines a simple ethernet NIC resource. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **AutoNeg** | boolean, null | read-write | This indicates if the speed and duplex are automatically negotiated and configured on this interface. | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **FQDN** | string, null | read-write | This is the complete, fully qualified domain name obtained by DNS for this interface. | | ||
- | | **FullDuplex** | boolean, null | read-write | This indicates if the interface is in Full Duplex mode or not. | | ||
- | | **HostName** | string, null | read-write | The DNS Host Name, without any domain information. | | ||
- | | **IPv4Addresses** [ {} ] | array | read-write | The IPv4 addresses assigned to this interface. | | ||
- | | **IPv6AddressPolicyTable** [ {} ] | array | read-write | An array representing the RFC 6724 Address Selection Policy Table. | | ||
- | | **IPv6Addresses** [ {} ] | array | read-write | This array of objects enumerates all of the currently assigned IPv6 addresses on this interface. | | ||
- | | **IPv6DefaultGateway** | string, null | read-only | This is the IPv6 default gateway address that is currently in use on this interface. | | ||
- | | **IPv6StaticAddresses** [ {} ] | array | read-write | This array of objects represents all of the IPv6 static addresses to be assigned on this interface. | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **InterfaceEnabled** | boolean, null | read-write | This indicates whether this interface is enabled. | | ||
- | | **LinkStatus** | string, null | read-write | The link status of this interface (port).\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **MACAddress** | string, null | read-write | This is the currently configured MAC address of the (logical port) interface.\\ pattern: ^([0-9A-Fa-f]{2}[: | ||
- | | **MTUSize** | number, null | read-write | This is the currently configured Maximum Transmission Unit (MTU) in bytes on this interface. | | ||
- | | **MaxIPv6StaticAddresses** | number, null | read-only | This indicates the maximum number of Static IPv6 addresses that can be configured on this interface. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **NameServers** [ {} ] | array | read-only | This represents DNS name servers that are currently in use on this interface. | | ||
- | | **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}[: | ||
- | | **SpeedMbps** | number, null | read-write | This is the current speed in Mbps of this interface.\\ unit: Mbit/s | | ||
- | | **Status** { | object, null | read-only | | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **UefiDevicePath** | string, null | read-only | The UEFI device path for this interface. | | ||
- | | **VLAN** | null | read-write | If this Network Interface supports more than one VLAN, this property will not be present and the client should look for VLANs collection in the link section of this resource. | | ||
- | | **[[documentation: | ||
- | |||
- | === Property Details === | ||
- | |||
- | == AddressOrigin == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | DHCPv6 | Address is provided by a DHCPv6 service | | ||
- | | LinkLocal | Address is valid only for this network segment (link) | | ||
- | | SLAAC | Address is provided by a Stateless Address AutoConfiguration (SLAAC) service | | ||
- | | Static | A static address as configured by the user | | ||
- | |||
- | == AddressState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Deprecated | This address is currently within it's valid lifetime, but is now outside of it's preferred lifetime as defined in RFC 4862. | | ||
- | | Failed | This address has failed Duplicate Address Detection testing as defined in RFC 4862 section 5.4 and is not currently in use. | | ||
- | | Preferred | This address is currently within both it's valid and preferred lifetimes as defined in RFC 4862. | | ||
- | | Tentative | This address is currently undergoing Duplicate Address Detection testing as defined in RFC 4862 section 5.4. | | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == 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 == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== EthernetInterfaceCollection ===== | ||
- | |||
- | A Collection of EthernetInterface resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == LinkStatus == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | LinkDown | There is no link on this interface, but the interface is connected. | | ||
- | | LinkUp | The link is available for communication on this interface. | | ||
- | | NoLink | There is no link or connection detected on this interface. | | ||
- | |||
- | |||
- | ===== Event ===== | ||
- | |||
- | 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 ^ | ||
- | | **Context** | string | read-only | A context can be supplied at subscription time. This property is the context value supplied by the subscriber. | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Events** [ {} ] | array | read-write | Each event in this array has a set of properties that describe the event. | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == EventType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Alert | A condition exists which requires attention. | | ||
- | | ResourceAdded | A resource has been added. | | ||
- | | ResourceRemoved | A resource has been removed. | | ||
- | | ResourceUpdated | The value of this resource has been updated. | | ||
- | | StatusChange | The status of this resource has changed. | | ||
- | |||
- | |||
- | ===== EventDestination ===== | ||
- | |||
- | An Event Destination desribes the target of an event subscription, | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Context** | string | read-write | A client-supplied string that is stored with the event destination subscription. | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Destination** | string | read-only | The URI of the destination Event Service. | | ||
- | | **EventTypes** [ {} ] | array | read-only | This property shall contain the types of events that shall be sent to the desination. | | ||
- | | **HttpHeaders** [ {} ] | array | read-write | This is for setting HTTP headers, such as authorization information. | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **MessageIds** [ {} ] | array | read-only | A list of MessageIds that the service will only send. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **OriginResources** [ {} ] | array | read-only | A list of resources for which the service will only send related events. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Protocol** | string | read-write | The protocol type of the event connection.\\ *See Property Details, below, for more information about this property.* | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == Protocol == | ||
- | |||
- | ^ string ^ | ||
- | | Redfish | | ||
- | |||
- | |||
- | ===== EventDestinationCollection ===== | ||
- | |||
- | A Collection of EventDestination resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == Protocol == | ||
- | |||
- | ^ string ^ | ||
- | | Redfish | | ||
- | |||
- | |||
- | ===== EventService ===== | ||
- | |||
- | The Event Service resource contains properties for managing event subcriptions and generates the events sent to subscribers. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Actions** { | object | read-write | The available actions for this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **DeliveryRetryAttempts** | number | read-only | This is the number of attempts an event posting is retried before the subscription is terminated. | | ||
- | | **DeliveryRetryIntervalSeconds** | number | read-only | This represents the number of seconds between retry attempts for sending any given Event.\\ unit: s | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **EventTypesForSubscription** [ {} ] | array | read-only | This is the types of Events that can be subscribed to. | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **ServiceEnabled** | boolean, null | read-write | This indicates whether this service is enabled. | | ||
- | | **Status** { | object | read-only | | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **[[documentation: | ||
- | |||
- | === Property Details === | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== Fabric ===== | ||
- | |||
- | 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 ^ | ||
- | | **Actions** { | object | read-write | The available actions for this resource. | | ||
- | | < | ||
- | | } | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **[[documentation: | ||
- | | **FabricType** | null | read-write | The protocol being sent over this fabric. | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | ||
- | | < | ||
- | | } | | ||
- | | **MaxZones** | number, null | read-only | The value of this property shall contain the maximum number of zones the switch can currently configure. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **Status** { | object | read-only | | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **[[documentation: | ||
- | | **[[documentation: | ||
- | |||
- | === Property Details === | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== FabricCollection ===== | ||
- | |||
- | A Collection of Fabric resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== FileShare ===== | ||
- | |||
- | An instance of a shared set of files with a common directory structure. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **CASupported** | boolean, null | read-write | Continuous Availability is supported. Client/ | ||
- | | **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. | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **[[documentation: | ||
- | | **ExecuteSupport** | boolean, null | read-only | Execute access is supported by the file share. | | ||
- | | **FileSharePath** | string, null | read-only | A path to an exported file or directory on the file system where this file share is hosted. | | ||
- | | **FileShareQuotaType** | string, null | read-write | Specifies the type of quota enforcement.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **FileShareRemainingQuotaBytes** | number, null | read-write | The number of remaining bytes that may be used by this file share.\\ unit: By | | ||
- | | **FileShareTotalQuotaBytes** | number, null | read-write | The maximum number of bytes that may be used by this file share.\\ unit: By | | ||
- | | **FileSharingProtocols** [ {} ] | array | read-only | An array of file sharing protocols supported by this file share. | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Links** { | object | read-only | Contains links to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **LowSpaceWarningThresholdPercents** [ {} ] | array | read-write | An array of low space warning threshold percentages for the file share. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **RootAccess** | boolean, null | read-only | Root access is allowed by the file share. | | ||
- | | **Status** { | object, null | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **WritePolicy** | string, null | read-write | Defines how writes are replicated to the shared source.\\ *See Property Details, below, for more information about this property.* | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == FileShareQuotaType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Hard | Quotas are enabled and enforced. | | ||
- | | Soft | Quotas are enabled but not enforced. | | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | == WritePolicy == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Active | Active-Active (i.e. bidirectional) synchronous updates. | | ||
- | | Adaptive | Allows implementation to switch between synchronous and asynchronous modes. | | ||
- | | Asynchronous | Asynchronous updates. | | ||
- | | Synchronous | Synchronous updates. | | ||
- | |||
- | |||
- | ===== FileSystem ===== | ||
- | |||
- | An instance of a hierarchical namespace of files. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **AccessCapabilities** [ {} ] | array | read-write | An array of supported IO access capabilities. | | ||
- | | **BlockSizeBytes** | number, null | read-only | Block size of the file system in bytes.\\ unit: By | | ||
- | | **Capacity** { | object, null | read-write | Capacity allocated to the file system. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **CapacitySources** [ {} ] | array | read-write | An array of capacity sources for the file system. | | ||
- | | **CasePreserved** | boolean, null | read-write | The case of file names is preserved by the file system. | | ||
- | | **CaseSensitive** | boolean, null | read-write | Case sensitive file names are supported by the file system. | | ||
- | | **CharacterCodeSet** [ {} ] | array | read-write | An array of the character sets or encodings supported by the file system. | | ||
- | | **ClusterSizeBytes** | number, null | read-write | A value indicating the minimum file allocation size imposed by the file system.\\ unit: By\\ minimum: 1 | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **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. | | ||
- | | **Links** { | object | read-only | Contains links to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **LowSpaceWarningThresholdPercents** [ {} ] | array | read-write | An array of low space warning threshold percentages for the file system. | | ||
- | | **MaxFileNameLengthBytes** | number, null | read-write | A value indicating the maximum length of a file name within the file system.\\ unit: By\\ minimum: 1 | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **RemainingCapacity** { | object, null | read-write | Remaining capacity allocated to the file system. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **ReplicaInfo** { | object, null | read-write | This value describes the replica attributes if this file system is a replica. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == ConsistencyState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Consistent | Consistent. | | ||
- | | Inconsistent | Not consistent. | | ||
- | |||
- | == ConsistencyStatus == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Consistent | Consistent. | | ||
- | | Disabled | Consistency disabled. | | ||
- | | InError | Consistency error. | | ||
- | | InProgress | Becoming consistent. | | ||
- | |||
- | == ConsistencyType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | SequentiallyConsistent | Sequentially consistent. | | ||
- | |||
- | == FileShareQuotaType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Hard | Quotas are enabled and enforced. | | ||
- | | Soft | Quotas are enabled but not enforced. | | ||
- | |||
- | == ReplicaPriority == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | High | Copy engine I/O has higher priority than host I/O. | | ||
- | | Low | Copy engine I/O lower priority than host I/O. | | ||
- | | Same | Copy engine I/O has the same priority as host I/O. | | ||
- | | Urgent | Copy operation to be performed as soon as possible, regardless of the host I/O requests. | | ||
- | |||
- | == ReplicaProgressStatus == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Aborting | Abort in progress. | | ||
- | | Completed | The request is completed. Data flow is idle. | | ||
- | | Detaching | Detach in progress. | | ||
- | | Dormant | Indicates that the data flow is inactive, suspended or quiesced. | | ||
- | | FailingBack | Undoing the result of failover. | | ||
- | | FailingOver | In the process of switching source and target. | | ||
- | | Fracturing | Fracture in progress. | | ||
- | | Initializing | In the process of establishing source/ | ||
- | | Mixed | Applies to groups with element pairs with different statuses. Generally, the individual statuses need to be examined. | | ||
- | | Pending | The flow of data has stopped momentarily due to limited bandwidth or a busy system. | | ||
- | | Preparing | Preparation in progress. | | ||
- | | RequiresActivate | The requested operation has completed, however, the synchronization relationship needs to be activated before further copy operations can be issued. | | ||
- | | RequiresDetach | The requested operation has completed, however, the synchronization relationship needs to be detached before further copy operations can be issued. | | ||
- | | RequiresFracture | The requested operation has completed, however, the synchronization relationship needs to be fractured before further copy operations can be issued. | | ||
- | | RequiresResume | The requested operation has completed, however, the synchronization relationship needs to be resumed before further copy operations can be issued. | | ||
- | | RequiresResync | The requested operation has completed, however, the synchronization relationship needs to be resynced before further copy operations can be issued. | | ||
- | | RequiresSplit | The requested operation has completed, however, the synchronization relationship needs to be split before further copy operations can be issued. | | ||
- | | Restoring | Restore in progress. | | ||
- | | Resyncing | Resync in progess. | | ||
- | | Splitting | Split in progress. | | ||
- | | Suspending | The copy operation is in the process of being suspended. | | ||
- | | Synchronizing | Sync in progress. | | ||
- | | Terminating | The relationship is in the process of terminating. | | ||
- | |||
- | == ReplicaReadOnlyAccess == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Both | Both the source and the target elements are read only to the host. | | ||
- | | ReplicaElement | The replica element. | ||
- | | SourceElement | The source element. | | ||
- | |||
- | == ReplicaRecoveryMode == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Automatic | Copy operation resumes automatically. | | ||
- | | Manual | ReplicaState is set to Suspended after the link is restored. It is required to issue the Resume operation to continue. | | ||
- | |||
- | == ReplicaRole == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Source | The source element. | | ||
- | | Target | The target element. | ||
- | |||
- | == ReplicaState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Aborted | The copy operation is aborted with the Abort operation. Use the Resync Replica operation to restart the copy operation. | ||
- | | Broken | The relationship is non-functional due to errors in the source, the target, the path between the two or space constraints. | ||
- | | Failedover | Reads and writes are sent to the target element. Source element is not reachable. | ||
- | | Fractured | Target is split from the source. | ||
- | | Inactive | Data flow has stopped, writes to source element will not be sent to target element. | ||
- | | Initialized | The link to enable replication is established and source/ | ||
- | | Invalid | The array is unable to determine the state of the replication relationship, | ||
- | | Mixed | Applies to the ReplicaState of GroupSynchronized. It indicates the StorageSynchronized relationships of the elements in the groups have different ReplicaState values. | ||
- | | Partitioned | State of replication relationship can not be determined, for example, due to a connection problem. | ||
- | | Prepared | Initialization is completed, however, the data flow has not started. | ||
- | | Restored | It indicates the source element was restored from the target element. | | ||
- | | Skewed | The target has been modified and is no longer synchronized with the source element or the point-in-time view. | | ||
- | | Split | The target element was gracefully (or systematically) split from its source element -- consistency is guaranteed. | ||
- | | Suspended | Data flow between the source and target elements has stopped. Writes to source element are held until the relationship is Resumed. | ||
- | | Synchronized | For the Mirror, Snapshot, or Clone replication, | ||
- | | Unsynchronized | Not all the source element data has been copied to the target element. | ||
- | |||
- | == ReplicaType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Clone | Create a point in time, full copy the source. | | ||
- | | Mirror | Create and maintain a copy of the source. | | ||
- | | Snapshot | Create a point in time, virtual copy of the source. | | ||
- | | TokenizedClone | Create a token based clone. | | ||
- | |||
- | == ReplicaUpdateMode == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Active | Active-Active (i.e. bidirectional) synchronous updates. | | ||
- | | Adaptive | Allows implementation to switch between synchronous and asynchronous modes. | | ||
- | | Asynchronous | Asynchronous updates. | | ||
- | | Synchronous | Synchronous updates. | | ||
- | |||
- | == RequestedReplicaState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Aborted | The copy operation is aborted with the Abort operation. Use the Resync Replica operation to restart the copy operation. | ||
- | | Broken | The relationship is non-functional due to errors in the source, the target, the path between the two or space constraints. | ||
- | | Failedover | Reads and writes are sent to the target element. Source element is not reachable. | ||
- | | Fractured | Target is split from the source. | ||
- | | Inactive | Data flow has stopped, writes to source element will not be sent to target element. | ||
- | | Initialized | The link to enable replication is established and source/ | ||
- | | Invalid | The array is unable to determine the state of the replication relationship, | ||
- | | Mixed | Applies to the ReplicaState of GroupSynchronized. It indicates the StorageSynchronized relationships of the elements in the groups have different ReplicaState values. | ||
- | | Partitioned | State of replication relationship can not be determined, for example, due to a connection problem. | ||
- | | Prepared | Initialization is completed, however, the data flow has not started. | ||
- | | Restored | It indicates the source element was restored from the target element. | | ||
- | | Skewed | The target has been modified and is no longer synchronized with the source element or the point-in-time view. | | ||
- | | Split | The target element was gracefully (or systematically) split from its source element -- consistency is guaranteed. | ||
- | | Suspended | Data flow between the source and target elements has stopped. Writes to source element are held until the relationship is Resumed. | ||
- | | Synchronized | For the Mirror, Snapshot, or Clone replication, | ||
- | | Unsynchronized | Not all the source element data has been copied to the target element. | ||
- | |||
- | == UndiscoveredElement == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | ReplicaElement | The replica element is undiscovered. | | ||
- | | SourceElement | The source element is undiscovered. | | ||
- | |||
- | == WritePolicy == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Active | Active-Active (i.e. bidirectional) synchronous updates. | | ||
- | | Adaptive | Allows implementation to switch between synchronous and asynchronous modes. | | ||
- | | Asynchronous | Asynchronous updates. | | ||
- | | Synchronous | Synchronous updates. | | ||
- | |||
- | |||
- | ===== FileSystemCollection ===== | ||
- | |||
- | Contains a collection of references to FileSystem resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | References to the members of this FileSystem collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== HostInterface ===== | ||
- | |||
- | This schema defines a Host Interface resource. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **AuthenticationModes** [ {} ] | array | read-write | This indicates the authentication modes available on this interface. | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **ExternallyAccessible** | boolean, null | read-only | This indicates whether this interface is accessible by external entities. | | ||
- | | **FirmwareAuthEnabled** | boolean, null | read-write | This indicates whether this firmware authentication is enabled for this interface. | | ||
- | | **FirmwareAuthRoleId** | string | read-write | This property contains the Role for firmware authentication on this interface. | | ||
- | | **[[documentation: | ||
- | | **HostInterfaceType** | string, null | read-write | This indicates the Host Interface type for this interface.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **InterfaceEnabled** | boolean, null | read-write | This indicates whether this interface is enabled. | | ||
- | | **KernelAuthEnabled** | boolean, null | read-write | This indicates whether this kernel authentication is enabled for this interface. | | ||
- | | **KernelAuthRoleId** | string | read-write | This property contains the Role for kernel authentication on this interface. | | ||
- | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **[[documentation: | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **[[documentation: | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **Status** { | object, null | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HostInterfaceType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | NetworkHostInterface | This interface is a Network Host Interface. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== HostInterfaceCollection ===== | ||
- | |||
- | A Collection of HostInterface resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == HostInterfaceType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | NetworkHostInterface | This interface is a Network Host Interface. | | ||
- | |||
- | |||
- | ===== HostedStorageServices ===== | ||
- | |||
- | A Collection of Hosted Storage Service resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-write | The value of each member references a StorageService resource. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== IOConnectivityLoSCapabilities ===== | ||
- | |||
- | Describe IO Connectivity capabilities. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Identifier** { | object, null | read-only | The value identifies this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **MaxSupportedIOPS** | number, null | read-write | The maximum IOPS that a connection can support. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **SupportedAccessProtocols** [ {} ] | array | read-write | SupportedAccessProtocols. | | ||
- | | **SupportedIOConnectivityLinesOfService** [ {} ] | array | read-write | Collection of known and supported IOConnectivityLinesOfService. | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == AccessProtocol == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | FC | FC2 | | ||
- | | FCOE | FC2 over Ethernet | | ||
- | | FCP | FC4 SCSI Protocol | | ||
- | | FICON | FICON | | ||
- | | FTP | File Transfer Protocol | | ||
- | | FTPS | Secure FTP | | ||
- | | HTTP | Hypertext Transfer Protocol | | ||
- | | HTTPS | Secure HTTP | | ||
- | | NFSv3 | NFSv3 | | ||
- | | NFSv4 | NFSv4 | | ||
- | | SAS | Serial Attached SCSI | | ||
- | | SMB | SMB | | ||
- | | SMBAndNFS | Both SMB and an NFS protocol | | ||
- | | SecureNFS | Secure NFS | | ||
- | | iSCSI | Internet SCSI | | ||
- | |||
- | == DurableNameFormat == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
- | | FC_WWN | Fibre Channel World Wide Name | | ||
- | | NAA | Name Address Authority Format | | ||
- | | UUID | Universally Unique Identifier | | ||
- | | iQN | iSCSI Qualified Name | | ||
- | |||
- | |||
- | ===== IOPerformanceLoSCapabilities ===== | ||
- | |||
- | Describe io performance capabilities. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **IOLimitingIsSupported** | boolean, null | read-write | Limiting IOPS is supported. | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Identifier** { | object, null | read-only | The value identifies this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **MaxSamplePeriod** | string, null | read-write | Maximum sampling period over which average values are calculated.\\ unit: s | | ||
- | | **MinSamplePeriod** | string, null | read-write | Minimum sampling period over which average values are calculated.\\ unit: s | | ||
- | | **MinSupportedIoOperationLatencyMicroseconds** | number, null | read-write | Minimum supported average IO latency.\\ unit: us | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **SupportedIOPerformanceLinesOfService** [ {} ] | array | read-write | Collection of known and supported IOPerformanceLinesOfService. | | ||
- | | **SupportedIOWorkloads** [ {} ] | array | read-write | A collection of supported workloads. | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == DurableNameFormat == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
- | | FC_WWN | Fibre Channel World Wide Name | | ||
- | | NAA | Name Address Authority Format | | ||
- | | UUID | Universally Unique Identifier | | ||
- | | iQN | iSCSI Qualified Name | | ||
- | |||
- | |||
- | ===== JsonSchemaFile ===== | ||
- | |||
- | This is the schema definition for the Schema File locator resource. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Languages** [ {} ] | array | read-only | Language codes for the schemas available. | | ||
- | | **Location** [ {} ] | array | read-write | Location information for this schema file. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **Schema** | string | read-only | The @odata.type name this schema describes. | | ||
- | |||
- | ===== JsonSchemaFileCollection ===== | ||
- | |||
- | A Collection of JsonSchemaFile resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== LogEntry ===== | ||
- | |||
- | This resource defines the record format for a log. It is designed to be used for SEL logs (from IPMI) as well as Event Logs and OEM-specific log formats. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Created** | string | read-only | The time the log entry was created. | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **EntryCode** | string, null | read-write | If the EntryType is SEL, this will have the entry code for the log entry.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **EntryType** | string | read-write | his is the type of log entry.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **EventId** | string | read-only | This is a unique instance identifier of an event. | | ||
- | | **EventTimestamp** | string | read-only | This is time the event occurred. | | ||
- | | **EventType** | | read-only | This indicates the type of an event recorded in this log. | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Message** | string, null | read-only | This property decodes from EntryType: | ||
- | | **MessageArgs** [ {} ] | array | read-only | The values of this property shall be any arguments for the message. | | ||
- | | **MessageId** | string | read-only | This property decodes from EntryType: | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **OemRecordFormat** | string, null | read-only | If the entry type is Oem, this will contain more information about the record format from the Oem. | | ||
- | | **SensorNumber** | number, null | read-only | This property decodes from EntryType: | ||
- | | **SensorType** | string, null | read-write | If the EntryType is SEL, this will have the sensor type that the log entry pertains to.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Severity** | string, null | read-write | This is the severity of the log entry.\\ *See Property Details, below, for more information about this property.* | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == EntryCode == | ||
- | |||
- | ^ string ^ | ||
- | | Assert | | ||
- | | Deassert | | ||
- | | Lower Non-critical - going low | | ||
- | | Lower Non-critical - going high | | ||
- | | Lower Critical - going low | | ||
- | | Lower Critical - going high | | ||
- | | Lower Non-recoverable - going low | | ||
- | | Lower Non-recoverable - going high | | ||
- | | Upper Non-critical - going low | | ||
- | | Upper Non-critical - going high | | ||
- | | Upper Critical - going low | | ||
- | | Upper Critical - going high | | ||
- | | Upper Non-recoverable - going low | | ||
- | | Upper Non-recoverable - going high | | ||
- | | Transition to Idle | | ||
- | | Transition to Active | | ||
- | | Transition to Busy | | ||
- | | State Deasserted | | ||
- | | State Asserted | | ||
- | | Predictive Failure deasserted | | ||
- | | Predictive Failure asserted | | ||
- | | Limit Not Exceeded | | ||
- | | Limit Exceeded | | ||
- | | Performance Met | | ||
- | | Performance Lags | | ||
- | | Transition to OK | | ||
- | | Transition to Non-Critical from OK | | ||
- | | Transition to Critical from less severe | | ||
- | | Transition to Non-recoverable from less severe | | ||
- | | Transition to Non-Critical from more severe | | ||
- | | Transition to Critical from Non-recoverable | | ||
- | | Transition to Non-recoverable | | ||
- | | Monitor | | ||
- | | Informational | | ||
- | | Device Removed / Device Absent | | ||
- | | Device Inserted / Device Present | | ||
- | | Device Disabled | | ||
- | | Device Enabled | | ||
- | | Transition to Running | | ||
- | | Transition to In Test | | ||
- | | Transition to Power Off | | ||
- | | Transition to On Line | | ||
- | | Transition to Off Line | | ||
- | | Transition to Off Duty | | ||
- | | Transition to Degraded | | ||
- | | Transition to Power Save | | ||
- | | Install Error | | ||
- | | Fully Redundant | | ||
- | | Redundancy Lost | | ||
- | | Redundancy Degraded | | ||
- | | Non-redundant: | ||
- | | Non-redundant: | ||
- | | Non-redundant: | ||
- | | Redundancy Degraded from Fully Redundant | | ||
- | | Redundancy Degraded from Non-redundant | | ||
- | | D0 Power State | | ||
- | | D1 Power State | | ||
- | | D2 Power State | | ||
- | | D3 Power State | | ||
- | |||
- | == EntryType == | ||
- | |||
- | ^ string ^ | ||
- | | Event | | ||
- | | SEL | | ||
- | | Oem | | ||
- | |||
- | == SensorType == | ||
- | |||
- | ^ string ^ | ||
- | | Platform Security Violation Attempt | | ||
- | | Temperature | | ||
- | | Voltage | | ||
- | | Current | | ||
- | | Fan | | ||
- | | Physical Chassis Security | | ||
- | | Processor | | ||
- | | Power Supply / Converter | | ||
- | | PowerUnit | | ||
- | | CoolingDevice | | ||
- | | Other Units-based Sensor | | ||
- | | Memory | | ||
- | | Drive Slot/Bay | | ||
- | | POST Memory Resize | | ||
- | | System Firmware Progress | | ||
- | | Event Logging Disabled | | ||
- | | System Event | | ||
- | | Critical Interrupt | | ||
- | | Button/ | ||
- | | Module/ | ||
- | | Microcontroller/ | ||
- | | Add-in Card | | ||
- | | Chassis | | ||
- | | ChipSet | | ||
- | | Other FRU | | ||
- | | Cable/ | ||
- | | Terminator | | ||
- | | SystemBoot/ | ||
- | | Boot Error | | ||
- | | BaseOSBoot/ | ||
- | | OS Stop/ | ||
- | | Slot/ | ||
- | | System ACPI PowerState | | ||
- | | Watchdog | | ||
- | | Platform Alert | | ||
- | | Entity Presence | | ||
- | | Monitor ASIC/IC | | ||
- | | LAN | | ||
- | | Management Subsystem Health | | ||
- | | Battery | | ||
- | | Session Audit | | ||
- | | Version Change | | ||
- | | FRUState | | ||
- | |||
- | == Severity == | ||
- | |||
- | ^ string ^ | ||
- | | OK | | ||
- | | Warning | | ||
- | | Critical | | ||
- | |||
- | |||
- | ===== LogEntryCollection ===== | ||
- | |||
- | A Collection of LogEntry resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == EntryCode == | ||
- | |||
- | ^ string ^ | ||
- | | Assert | | ||
- | | Deassert | | ||
- | | Lower Non-critical - going low | | ||
- | | Lower Non-critical - going high | | ||
- | | Lower Critical - going low | | ||
- | | Lower Critical - going high | | ||
- | | Lower Non-recoverable - going low | | ||
- | | Lower Non-recoverable - going high | | ||
- | | Upper Non-critical - going low | | ||
- | | Upper Non-critical - going high | | ||
- | | Upper Critical - going low | | ||
- | | Upper Critical - going high | | ||
- | | Upper Non-recoverable - going low | | ||
- | | Upper Non-recoverable - going high | | ||
- | | Transition to Idle | | ||
- | | Transition to Active | | ||
- | | Transition to Busy | | ||
- | | State Deasserted | | ||
- | | State Asserted | | ||
- | | Predictive Failure deasserted | | ||
- | | Predictive Failure asserted | | ||
- | | Limit Not Exceeded | | ||
- | | Limit Exceeded | | ||
- | | Performance Met | | ||
- | | Performance Lags | | ||
- | | Transition to OK | | ||
- | | Transition to Non-Critical from OK | | ||
- | | Transition to Critical from less severe | | ||
- | | Transition to Non-recoverable from less severe | | ||
- | | Transition to Non-Critical from more severe | | ||
- | | Transition to Critical from Non-recoverable | | ||
- | | Transition to Non-recoverable | | ||
- | | Monitor | | ||
- | | Informational | | ||
- | | Device Removed / Device Absent | | ||
- | | Device Inserted / Device Present | | ||
- | | Device Disabled | | ||
- | | Device Enabled | | ||
- | | Transition to Running | | ||
- | | Transition to In Test | | ||
- | | Transition to Power Off | | ||
- | | Transition to On Line | | ||
- | | Transition to Off Line | | ||
- | | Transition to Off Duty | | ||
- | | Transition to Degraded | | ||
- | | Transition to Power Save | | ||
- | | Install Error | | ||
- | | Fully Redundant | | ||
- | | Redundancy Lost | | ||
- | | Redundancy Degraded | | ||
- | | Non-redundant: | ||
- | | Non-redundant: | ||
- | | Non-redundant: | ||
- | | Redundancy Degraded from Fully Redundant | | ||
- | | Redundancy Degraded from Non-redundant | | ||
- | | D0 Power State | | ||
- | | D1 Power State | | ||
- | | D2 Power State | | ||
- | | D3 Power State | | ||
- | |||
- | == EntryType == | ||
- | |||
- | ^ string ^ | ||
- | | Event | | ||
- | | SEL | | ||
- | | Oem | | ||
- | |||
- | == SensorType == | ||
- | |||
- | ^ string ^ | ||
- | | Platform Security Violation Attempt | | ||
- | | Temperature | | ||
- | | Voltage | | ||
- | | Current | | ||
- | | Fan | | ||
- | | Physical Chassis Security | | ||
- | | Processor | | ||
- | | Power Supply / Converter | | ||
- | | PowerUnit | | ||
- | | CoolingDevice | | ||
- | | Other Units-based Sensor | | ||
- | | Memory | | ||
- | | Drive Slot/Bay | | ||
- | | POST Memory Resize | | ||
- | | System Firmware Progress | | ||
- | | Event Logging Disabled | | ||
- | | System Event | | ||
- | | Critical Interrupt | | ||
- | | Button/ | ||
- | | Module/ | ||
- | | Microcontroller/ | ||
- | | Add-in Card | | ||
- | | Chassis | | ||
- | | ChipSet | | ||
- | | Other FRU | | ||
- | | Cable/ | ||
- | | Terminator | | ||
- | | SystemBoot/ | ||
- | | Boot Error | | ||
- | | BaseOSBoot/ | ||
- | | OS Stop/ | ||
- | | Slot/ | ||
- | | System ACPI PowerState | | ||
- | | Watchdog | | ||
- | | Platform Alert | | ||
- | | Entity Presence | | ||
- | | Monitor ASIC/IC | | ||
- | | LAN | | ||
- | | Management Subsystem Health | | ||
- | | Battery | | ||
- | | Session Audit | | ||
- | | Version Change | | ||
- | | FRUState | | ||
- | |||
- | == Severity == | ||
- | |||
- | ^ string ^ | ||
- | | OK | | ||
- | | Warning | | ||
- | | Critical | | ||
- | |||
- | |||
- | ===== LogService ===== | ||
- | |||
- | This resource represents the log service for the resource or service to which it is associated. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Actions** { | object | read-write | The available actions for this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **DateTime** | string, null | read-write | The current DateTime (with offset) for the log service, used to set or read time. | | ||
- | | **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]: | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **[[documentation: | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **MaxNumberOfRecords** | number | read-only | The maximum number of log entries this service can have. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **OverWritePolicy** | string | read-write | The overwrite policy for this service that takes place when the log is full.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **ServiceEnabled** | boolean, null | read-write | This indicates whether this service is enabled. | | ||
- | | **Status** { | object, null | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == OverWritePolicy == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | NeverOverWrites | When full, new entries to the Log will be discarded. | | ||
- | | Unknown | The overwrite policy is not known or is undefined. | | ||
- | | WrapsWhenFull | When full, new entries to the Log will overwrite previous entries. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== LogServiceCollection ===== | ||
- | |||
- | A Collection of LogService resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == OverWritePolicy == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | NeverOverWrites | When full, new entries to the Log will be discarded. | | ||
- | | Unknown | The overwrite policy is not known or is undefined. | | ||
- | | WrapsWhenFull | When full, new entries to the Log will overwrite previous entries. | | ||
- | |||
- | |||
- | ===== Manager ===== | ||
- | |||
- | This is the schema definition for a Manager. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Actions** { | object | read-write | The available actions for this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **CommandShell** { | object | read-write | Information about the Command Shell service provided by this manager. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **DateTime** | string, null | read-write | The current DateTime (with offset) for the manager, used to set or read time. | | ||
- | | **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]: | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **[[documentation: | ||
- | | **FirmwareVersion** | string, null | read-only | The firmware version of this Manager. | | ||
- | | **GraphicalConsole** { | object | read-write | The value of this property shall contain the information about the Graphical Console (KVM-IP) service of this manager. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **[[documentation: | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **[[documentation: | ||
- | | **ManagerType** | string | read-write | This property represents the type of manager that this resource represents.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Model** | string, null | read-only | The model information of this Manager as defined by the manufacturer. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **[[documentation: | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **PowerState** | string, null | read-write | This is the current power state of the Manager.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Redundancy** [ {} ] | array | read-write | Redundancy information for the managers of this system. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **SerialConsole** { | object | read-write | Information about the Serial Console service provided by this manager. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **[[documentation: | ||
- | | **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}) | | ||
- | | **Status** { | object | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **UUID** | string, null | read-write | The Universal Unique Identifier (UUID) for this Manager.\\ pattern: ([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}) | | ||
- | | **[[documentation: | ||
- | |||
- | === Property Details === | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == ManagerType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | AuxiliaryController | A controller which provides management functions for a particular subsystem or group of devices. | | ||
- | | BMC | A controller which provides management functions for a single computer system. | | ||
- | | EnclosureManager | A controller which provides management functions for a chassis or group of devices or systems. | | ||
- | | ManagementController | A controller used primarily to monitor or manage the operation of a device or system. | | ||
- | | RackManager | A controller which provides management functions for a whole or part of a rack. | | ||
- | |||
- | == Mode == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Failover | Failure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set. | | ||
- | | N+m | Multiple units are available and active such that normal operation will continue if one or more units fail. | | ||
- | | Sharing | Multiple units contribute or share such that operation will continue, but at a reduced capacity, if one or more units fail. | | ||
- | | Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. | | ||
- | |||
- | == PowerState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Off | The state is powered Off. | | ||
- | | On | The state is powered On. | | ||
- | | PoweringOff | A temporary state between On and Off. | | ||
- | | PoweringOn | A temporary state between Off and On. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== ManagerAccount ===== | ||
- | |||
- | The user accounts, owned by a Manager, are defined in this resource. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Enabled** | boolean | read-write | This property is used by a User Administrator to disable an account w/o having to delet the user information. | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Locked** | boolean | read-write | This property indicates that the account has been auto-locked by the account service because the lockout threshold has been exceeded. | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **Password** | string, null | read-write | This property is used with a PATCH or PUT to write the password for the account. | ||
- | | **RoleId** | string | read-write | This property contains the Role for this account. | | ||
- | | **UserName** | string | read-write | This property contains the user name for the account. | | ||
- | |||
- | ===== ManagerAccountCollection ===== | ||
- | |||
- | A Collection of ManagerAccount resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== ManagerCollection ===== | ||
- | |||
- | A Collection of Manager resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == ManagerType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | AuxiliaryController | A controller which provides management functions for a particular subsystem or group of devices. | | ||
- | | BMC | A controller which provides management functions for a single computer system. | | ||
- | | EnclosureManager | A controller which provides management functions for a chassis or group of devices or systems. | | ||
- | | ManagementController | A controller used primarily to monitor or manage the operation of a device or system. | | ||
- | | RackManager | A controller which provides management functions for a whole or part of a rack. | | ||
- | |||
- | == PowerState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Off | The state is powered Off. | | ||
- | | On | The state is powered On. | | ||
- | | PoweringOff | A temporary state between On and Off. | | ||
- | | PoweringOn | A temporary state between Off and On. | | ||
- | |||
- | |||
- | ===== ManagerNetworkProtocol ===== | ||
- | |||
- | This resource is used to obtain or modify the network services managed by a given manager. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **DHCP** { | object | read-write | Settings for this Manager' | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **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. | | ||
- | | **HTTP** { | object | read-write | Settings for this Manager' | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **HTTPS** { | object | read-write | Settings for this Manager' | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **HostName** | string, null | read-only | The DNS Host Name of this manager, without any domain information. | | ||
- | | **IPMI** { | object | read-write | Settings for this Manager' | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **KVMIP** { | object | read-write | Settings for this Manager' | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **SNMP** { | object | read-write | Settings for this Manager' | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **SSDP** { | object | read-write | Settings for this Manager' | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **SSH** { | object | read-write | Settings for this Manager' | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Status** { | object | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Telnet** { | object | read-write | Settings for this Manager' | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **VirtualMedia** { | object | read-write | Settings for this Manager' | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == NotifyIPv6Scope == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Link | SSDP Notify messages are sent to addresses in the IPv6 Local Link scope. | | ||
- | | Organization | SSDP Notify messages are sent to addresses in the IPv6 Local Organization scope. | | ||
- | | Site | SSDP Notify messages are sent to addresses in the IPv6 Local Site scope. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== Memory ===== | ||
- | |||
- | This is the schema definition for definition of a Memory and its configuration. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Actions** { | object | read-write | The available actions for this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **AllowedSpeedsMHz** [ {} ] | array | read-only | Speed bins supported by this Memory. | | ||
- | | **BaseModuleType** | string, null | read-write | The base module type of Memory.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **BusWidthBits** | number, null | read-only | Bus Width in bits. | | ||
- | | **CapacityMiB** | number, null | read-only | Memory Capacity in MiB.\\ unit: MiBy | | ||
- | | **DataWidthBits** | number, null | read-only | Data Width in bits. | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **DeviceID** | string, null | read-only | Device ID. | | ||
- | | **DeviceLocator** | string, null | read-only | Location of the Memory in the platform. | | ||
- | | **ErrorCorrection** | string, null | read-write | Error correction scheme supported for this memory.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **FirmwareApiVersion** | string, null | read-only | Version of API supported by the firmware. | | ||
- | | **FirmwareRevision** | string, null | read-only | Revision of firmware on the Memory controller. | | ||
- | | **FunctionClasses** [ {} ] | array | read-only | Function Classes by the Memory. | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **IsRankSpareEnabled** | boolean, null | read-only | Rank spare enabled status. | | ||
- | | **IsSpareDeviceEnabled** | boolean, null | read-only | Spare device enabled status. | | ||
- | | **Manufacturer** | string, null | read-only | The Memory manufacturer. | | ||
- | | **MaxTDPMilliWatts** [ {} ] | array | read-only | Maximum TDPs in milli Watts. | | ||
- | | **MemoryDeviceType** | string, null | read-write | Type details of the Memory.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **MemoryLocation** { | object | read-write | Memory connection information to sockets and memory controllers. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **MemoryMedia** [ {} ] | array | read-only | Media of this Memory. | | ||
- | | **MemoryType** | string, null | read-write | The type of Memory.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **[[documentation: | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **OperatingMemoryModes** [ {} ] | array | read-only | Memory modes supported by the Memory. | | ||
- | | **OperatingSpeedMhz** | number, null | read-only | Operating speed of Memory in MHz. | | ||
- | | **PartNumber** | string, null | read-only | The product part number of this device. | | ||
- | | **PersistentRegionSizeLimitMiB** | number, null | read-only | Total size of persistent regions in MiB. | | ||
- | | **PowerManagementPolicy** { | object | read-write | Power management policy information. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **RankCount** | number, null | read-only | Number of ranks available in the Memory. | | ||
- | | **Regions** [ {} ] | array | read-write | Memory regions information within the Memory. | | ||
- | | **SecurityCapabilities** { | object | read-write | This object contains security capabilities of the Memory. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **SerialNumber** | string, null | read-only | The product serial number of this device. | | ||
- | | **SpareDeviceCount** | number, null | read-only | Number of unused spare devices available in the Memory. | | ||
- | | **Status** { | object | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **SubsystemDeviceID** | string, null | read-only | Subsystem Device ID. | | ||
- | | **SubsystemVendorID** | string, null | read-only | SubSystem Vendor ID. | | ||
- | | **VendorID** | string, null | read-only | Vendor ID. | | ||
- | | **VolatileRegionSizeLimitMiB** | number, null | read-only | Total size of volatile regions in MiB. | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == BaseModuleType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | LRDIMM | Load Reduced. | | ||
- | | Mini_RDIMM | Mini_RDIMM. | | ||
- | | Mini_UDIMM | Mini_UDIMM. | | ||
- | | RDIMM | Registered DIMM. | | ||
- | | SO_DIMM | SO_DIMM. | | ||
- | | SO_DIMM_16b | SO_DIMM_16b. | | ||
- | | SO_DIMM_32b | SO_DIMM_32b. | | ||
- | | SO_RDIMM_72b | SO_RDIMM_72b. | | ||
- | | SO_UDIMM_72b | SO_UDIMM_72b. | | ||
- | | UDIMM | UDIMM. | | ||
- | |||
- | == ErrorCorrection == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | AddressParity | Address Parity errors can be corrected. | | ||
- | | MultiBitECC | Multi-bit Data errors can be corrected by ECC. | | ||
- | | NoECC | No ECC available. | | ||
- | | SingleBitECC | Single bit Data error can be corrected by ECC. | | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == MemoryClassification == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Block | Block accesible memory. | | ||
- | | ByteAccessiblePersistent | Byte accessible persistent memory. | | ||
- | | Volatile | Volatile memory. | | ||
- | |||
- | == MemoryDeviceType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | DDR | DDR. | | ||
- | | DDR2 | DDR2. | | ||
- | | DDR2_SDRAM | DDR2 SDRAM. | | ||
- | | DDR2_SDRAM_FB_DIMM | DDR2 SDRAM FB_DIMM. | | ||
- | | DDR2_SDRAM_FB_DIMM_PROBE | DDR2 SDRAM FB_DIMM PROBE. | | ||
- | | DDR3 | DDR3. | | ||
- | | DDR3_SDRAM | DDR3 SDRAM. | | ||
- | | DDR4 | DDR4. | | ||
- | | DDR4E_SDRAM | DDR4E SDRAM. | | ||
- | | DDR4_SDRAM | DDR4 SDRAM. | | ||
- | | DDR_SDRAM | DDR SDRAM. | | ||
- | | DDR_SGRAM | DDR SGRAM. | | ||
- | | EDO | EDO. | | ||
- | | FastPageMode | Fast Page Mode. | | ||
- | | LPDDR3_SDRAM | LPDDR3 SDRAM. | | ||
- | | LPDDR4_SDRAM | LPDDR4 SDRAM. | | ||
- | | PipelinedNibble | Pipelined Nibble. | | ||
- | | ROM | ROM. | | ||
- | | SDRAM | SDRAM. | | ||
- | |||
- | == MemoryType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | DRAM | DRAM. | | ||
- | | NVDIMM_F | NVDIMM_F as defined by JEDEC. | | ||
- | | NVDIMM_N | NVDIMM_N as defined by JEDEC. | | ||
- | | NVDIMM_P | NVDIMM_P as defined by JEDEC. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== MemoryChunks ===== | ||
- | |||
- | This is the schema definition of a Memory Chunk and its configuration. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **AddressRangeType** | string, null | read-write | Memory type of this memory chunk.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **InterleaveSets** [ {} ] | array | read-write | This is the interleave sets for the memory chunk. | | ||
- | | **IsMirrorEnabled** | boolean, null | read-only | Mirror Enabled status. | | ||
- | | **IsSpare** | boolean, null | read-only | Spare enabled status. | | ||
- | | **MemoryChunkSizeMiB** | number, null | read-only | Size of the memory chunk in MiB. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == AddressRangeType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Block | Block accesible memory. | | ||
- | | PMEM | Byte accessible persistent memory. | | ||
- | | Volatile | Volatile memory. | | ||
- | |||
- | |||
- | ===== MemoryChunksCollection ===== | ||
- | |||
- | A Collection of MemoryChunks resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == AddressRangeType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Block | Block accesible memory. | | ||
- | | PMEM | Byte accessible persistent memory. | | ||
- | | Volatile | Volatile memory. | | ||
- | |||
- | |||
- | ===== MemoryCollection ===== | ||
- | |||
- | A Collection of Memory resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == BaseModuleType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | LRDIMM | Load Reduced. | | ||
- | | Mini_RDIMM | Mini_RDIMM. | | ||
- | | Mini_UDIMM | Mini_UDIMM. | | ||
- | | RDIMM | Registered DIMM. | | ||
- | | SO_DIMM | SO_DIMM. | | ||
- | | SO_DIMM_16b | SO_DIMM_16b. | | ||
- | | SO_DIMM_32b | SO_DIMM_32b. | | ||
- | | SO_RDIMM_72b | SO_RDIMM_72b. | | ||
- | | SO_UDIMM_72b | SO_UDIMM_72b. | | ||
- | | UDIMM | UDIMM. | | ||
- | |||
- | == ErrorCorrection == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | AddressParity | Address Parity errors can be corrected. | | ||
- | | MultiBitECC | Multi-bit Data errors can be corrected by ECC. | | ||
- | | NoECC | No ECC available. | | ||
- | | SingleBitECC | Single bit Data error can be corrected by ECC. | | ||
- | |||
- | == MemoryDeviceType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | DDR | DDR. | | ||
- | | DDR2 | DDR2. | | ||
- | | DDR2_SDRAM | DDR2 SDRAM. | | ||
- | | DDR2_SDRAM_FB_DIMM | DDR2 SDRAM FB_DIMM. | | ||
- | | DDR2_SDRAM_FB_DIMM_PROBE | DDR2 SDRAM FB_DIMM PROBE. | | ||
- | | DDR3 | DDR3. | | ||
- | | DDR3_SDRAM | DDR3 SDRAM. | | ||
- | | DDR4 | DDR4. | | ||
- | | DDR4E_SDRAM | DDR4E SDRAM. | | ||
- | | DDR4_SDRAM | DDR4 SDRAM. | | ||
- | | DDR_SDRAM | DDR SDRAM. | | ||
- | | DDR_SGRAM | DDR SGRAM. | | ||
- | | EDO | EDO. | | ||
- | | FastPageMode | Fast Page Mode. | | ||
- | | LPDDR3_SDRAM | LPDDR3 SDRAM. | | ||
- | | LPDDR4_SDRAM | LPDDR4 SDRAM. | | ||
- | | PipelinedNibble | Pipelined Nibble. | | ||
- | | ROM | ROM. | | ||
- | | SDRAM | SDRAM. | | ||
- | |||
- | == MemoryType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | DRAM | DRAM. | | ||
- | | NVDIMM_F | NVDIMM_F as defined by JEDEC. | | ||
- | | NVDIMM_N | NVDIMM_N as defined by JEDEC. | | ||
- | | NVDIMM_P | NVDIMM_P as defined by JEDEC. | | ||
- | |||
- | |||
- | ===== MemoryDomain ===== | ||
- | |||
- | 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 ^ | ||
- | | **AllowsBlockProvisioning** | boolean, null | read-only | Indicates if this Memory Domain supports the provisioning of blocks of memory. | | ||
- | | **AllowsMemoryChunkCreation** | boolean, null | read-only | Indicates if this Memory Domain supports the creation of Memory Chunks. | | ||
- | | **AllowsMirroring** | boolean, null | read-only | Indicates if this Memory Domain supports the creation of Memory Chunks with mirroring enabled. | | ||
- | | **AllowsSparing** | boolean, null | read-only | Indicates if this Memory Domain supports the creation of Memory Chunks with sparing enabled. | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **InterleavableMemorySets** [ {} ] | array | read-write | This is the interleave sets for the memory chunk. | | ||
- | | **[[documentation: | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== MemoryDomainCollection ===== | ||
- | |||
- | A Collection of MemoryDomain resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== MemoryMetrics ===== | ||
- | |||
- | MemoryMetrics contains usage and health statistics for a single Memory module or device instance. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Actions** { | object | read-write | The available actions for this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **BlockSizeBytes** | number, null | read-only | Block size in bytes.\\ unit: By | | ||
- | | **CurrentPeriod** { | object | read-write | This object describes the central memory of the system in general detail. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **HealthData** { | object | read-write | This object describes the central memory of the system in general detail. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **LifeTime** { | object | read-write | This object describes the central memory of the system in general detail. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== MessageRegistry ===== | ||
- | |||
- | This is the schema definition for all Message Registries. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Language** | string | read-only | This is the RFC 5646 compliant language code for the registry. | | ||
- | | **Messages** {} | object | read-write | The pattern property indicates that a free-form string is the unique identifier for the message within the registry. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **OwningEntity** | string | read-only | This is the organization or company that publishes this registry. | | ||
- | | **RegistryPrefix** | string | read-only | This is the single word prefix used to form a messageID structure. | | ||
- | | **RegistryVersion** | string | read-only | This is the message registry version which is used in the middle portion of a messageID. | | ||
- | |||
- | ===== MessageRegistryCollection ===== | ||
- | |||
- | A Collection of MessageRegistry resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== MessageRegistryFile ===== | ||
- | |||
- | This is the schema definition for the Schema File locator resource. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Languages** [ {} ] | array | read-only | Language codes for the schemas available. | | ||
- | | **Location** [ {} ] | array | read-write | Location information for this schema file. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **Registry** | string | read-only | The Registry Name, Major and Minor version used in MessageID construction. | | ||
- | |||
- | ===== MessageRegistryFileCollection ===== | ||
- | |||
- | A Collection of MessageRegistryFile resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== NetworkAdapter ===== | ||
- | |||
- | A NetworkAdapter represents the physical network adapter capable of connecting to a computer network. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Actions** { | object | read-write | The available actions for this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Controllers** [ {} ] | array | read-write | The set of network controllers ASICs that make up this NetworkAdapter. | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Manufacturer** | string, null | read-only | The manufacturer or OEM of this network adapter. | | ||
- | | **Model** | string, null | read-only | The model string for this network adapter. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **[[documentation: | ||
- | | **[[documentation: | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **PartNumber** | string, null | read-only | Part number for this network adapter. | | ||
- | | **SKU** | string, null | read-only | The manufacturer SKU for this network adapter. | | ||
- | | **SerialNumber** | string, null | read-only | The serial number for this network adapter. | | ||
- | | **Status** { | object, null | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== NetworkAdapterCollection ===== | ||
- | |||
- | A Collection of NetworkAdapter resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== NetworkDeviceFunction ===== | ||
- | |||
- | A Network Device Function represents a logical interface exposed by the network adapter. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **AssignablePhysicalPorts** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **BootMode** | string, null | read-write | The boot mode configured for this network device function.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **DeviceEnabled** | boolean, null | read-write | Whether the network device function is enabled. | | ||
- | | **Ethernet** { | object, null | read-write | Ethernet. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **FibreChannel** { | object, null | read-write | Fibre Channel. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Links** { | object | read-write | Links. | | ||
- | | < | ||
- | | } | | ||
- | | **MaxVirtualFunctions** | number, null | read-only | The number of virtual functions (VFs) that are available for this Network Device Function. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **NetDevFuncCapabilities** [ {} ] | array | read-only | Capabilities of this network device function. | | ||
- | | **NetDevFuncType** | string, null | read-write | The configured capability of this network device function.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **[[documentation: | ||
- | | **Status** { | object, null | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **VirtualFunctionsEnabled** | boolean, null | read-only | Whether Single Root I/O Virtualization (SR-IOV) Virual Functions (VFs) are enabled for this Network Device Function. | | ||
- | | **iSCSIBoot** { | object, null | read-write | iSCSI Boot. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == ActiveLinkTechnology == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Ethernet | The port is capable of connecting to an Ethernet network. | | ||
- | | FibreChannel | The port is capable of connecting to a Fibre Channel network. | | ||
- | | InfiniBand | The port is capable of connecting to an InfiniBand network. | | ||
- | |||
- | == AuthenticationMethod == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | CHAP | iSCSI Challenge Handshake Authentication Protocol (CHAP) authentication is used. | | ||
- | | MutualCHAP | iSCSI Mutual Challenge Handshake Authentication Protocol (CHAP) authentication is used. | | ||
- | | None | No iSCSI authentication is used. | | ||
- | |||
- | == BootMode == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Disabled | Do not indicate to UEFI/BIOS that this device is bootable. | | ||
- | | FibreChannel | Boot this device using the embedded Fibre Channel support and configuration. | ||
- | | FibreChannelOverEthernet | Boot this device using the embedded Fibre Channel over Ethernet (FCoE) boot support and configuration. | ||
- | | PXE | Boot this device using the embedded PXE support. | ||
- | | iSCSI | Boot this device using the embedded iSCSI boot support and configuration. | ||
- | |||
- | == FlowControlConfiguration == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | None | No IEEE 802.3x flow control is enabled on this port. | | ||
- | | RX | IEEE 802.3x flow control may be initiated by the link partner. | | ||
- | | TX | IEEE 802.3x flow control may be initiated by this station. | | ||
- | | TX_RX | IEEE 802.3x flow control may be initiated by this station or the link partner. | | ||
- | |||
- | == FlowControlStatus == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | None | No IEEE 802.3x flow control is enabled on this port. | | ||
- | | RX | IEEE 802.3x flow control may be initiated by the link partner. | | ||
- | | TX | IEEE 802.3x flow control may be initiated by this station. | | ||
- | | TX_RX | IEEE 802.3x flow control may be initiated by this station or the link partner. | | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == IPAddressType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | IPv4 | IPv4 addressing is used for all IP-fields in this object. | | ||
- | | IPv6 | IPv6 addressing is used for all IP-fields in this object. | | ||
- | |||
- | == LinkStatus == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Down | The port is enabled but link is down. | | ||
- | | Up | The port is enabled and link is good (up). | | ||
- | |||
- | == NetDevFuncType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Disabled | Neither enumerated nor visible to the operating system. | | ||
- | | Ethernet | Appears to the operating system as an Ethernet device. | | ||
- | | FibreChannel | Appears to the operating system as a Fibre Channel device. | | ||
- | | FibreChannelOverEthernet | Appears to the operating system as an FCoE device. | | ||
- | | iSCSI | Appears to the operating system as an iSCSI device. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | == WWNSource == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | ConfiguredLocally | The set of FC/FCoE boot targets was applied locally through API or UI. | | ||
- | | ProvidedByFabric | The set of FC/FCoE boot targets was applied by the Fibre Channel fabric. | | ||
- | |||
- | |||
- | ===== NetworkDeviceFunctionCollection ===== | ||
- | |||
- | A Collection of NetworkDeviceFunction resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == BootMode == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Disabled | Do not indicate to UEFI/BIOS that this device is bootable. | | ||
- | | FibreChannel | Boot this device using the embedded Fibre Channel support and configuration. | ||
- | | FibreChannelOverEthernet | Boot this device using the embedded Fibre Channel over Ethernet (FCoE) boot support and configuration. | ||
- | | PXE | Boot this device using the embedded PXE support. | ||
- | | iSCSI | Boot this device using the embedded iSCSI boot support and configuration. | ||
- | |||
- | == NetDevFuncType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Disabled | Neither enumerated nor visible to the operating system. | | ||
- | | Ethernet | Appears to the operating system as an Ethernet device. | | ||
- | | FibreChannel | Appears to the operating system as a Fibre Channel device. | | ||
- | | FibreChannelOverEthernet | Appears to the operating system as an FCoE device. | | ||
- | | iSCSI | Appears to the operating system as an iSCSI device. | | ||
- | |||
- | |||
- | ===== NetworkInterface ===== | ||
- | |||
- | A NetworkInterface contains references linking NetworkAdapter, | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Links** { | object | read-write | Links. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **[[documentation: | ||
- | | **[[documentation: | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **Status** { | object, null | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== NetworkInterfaceCollection ===== | ||
- | |||
- | A Collection of NetworkInterface resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== NetworkPort ===== | ||
- | |||
- | A Network Port represents a discrete physical port capable of connecting to a network. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **ActiveLinkTechnology** | string, null | read-write | Network Port Active Link Technology.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **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. | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **EEEEnabled** | boolean, null | read-write | Whether IEEE 802.3az Energy Efficient Ethernet (EEE) is enabled for this network port. | | ||
- | | **FlowControlConfiguration** | string, null | read-write | The locally configured 802.3x flow control setting for this network port.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **FlowControlStatus** | string, null | read-write | The 802.3x flow control behavior negotiated with the link partner for this network port (Ethernet-only).\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **LinkStatus** | string, null | read-write | The status of the link between this port and its link partner.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **NetDevFuncMaxBWAlloc** [ {} ] | array | read-write | The array of maximum bandwidth allocation percentages for the Network Device Functions associated with this port. | | ||
- | | **NetDevFuncMinBWAlloc** [ {} ] | array | read-write | The array of minimum bandwidth allocation percentages for the Network Device Functions associated with this port. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **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. | | ||
- | | **SignalDetected** | boolean, null | read-only | Whether or not the port has detected enough signal on enough lanes to establish link. | | ||
- | | **Status** { | object, null | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **SupportedEthernetCapabilities** [ {} ] | array | read-only | The set of Ethernet capabilities that this port supports. | | ||
- | | **SupportedLinkCapabilities** [ {} ] | array | read-write | The self-described link capabilities of this port. | | ||
- | | **WakeOnLANEnabled** | boolean, null | read-write | Whether Wake on LAN (WoL) is enabled for this network port. | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == ActiveLinkTechnology == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Ethernet | The port is capable of connecting to an Ethernet network. | | ||
- | | FibreChannel | The port is capable of connecting to a Fibre Channel network. | | ||
- | | InfiniBand | The port is capable of connecting to an InfiniBand network. | | ||
- | |||
- | == FlowControlConfiguration == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | None | No IEEE 802.3x flow control is enabled on this port. | | ||
- | | RX | IEEE 802.3x flow control may be initiated by the link partner. | | ||
- | | TX | IEEE 802.3x flow control may be initiated by this station. | | ||
- | | TX_RX | IEEE 802.3x flow control may be initiated by this station or the link partner. | | ||
- | |||
- | == FlowControlStatus == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | None | No IEEE 802.3x flow control is enabled on this port. | | ||
- | | RX | IEEE 802.3x flow control may be initiated by the link partner. | | ||
- | | TX | IEEE 802.3x flow control may be initiated by this station. | | ||
- | | TX_RX | IEEE 802.3x flow control may be initiated by this station or the link partner. | | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == LinkNetworkTechnology == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Ethernet | The port is capable of connecting to an Ethernet network. | | ||
- | | FibreChannel | The port is capable of connecting to a Fibre Channel network. | | ||
- | | InfiniBand | The port is capable of connecting to an InfiniBand network. | | ||
- | |||
- | == LinkStatus == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Down | The port is enabled but link is down. | | ||
- | | Up | The port is enabled and link is good (up). | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== NetworkPortCollection ===== | ||
- | |||
- | A Collection of NetworkPort resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == ActiveLinkTechnology == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Ethernet | The port is capable of connecting to an Ethernet network. | | ||
- | | FibreChannel | The port is capable of connecting to a Fibre Channel network. | | ||
- | | InfiniBand | The port is capable of connecting to an InfiniBand network. | | ||
- | |||
- | == FlowControlConfiguration == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | None | No IEEE 802.3x flow control is enabled on this port. | | ||
- | | RX | IEEE 802.3x flow control may be initiated by the link partner. | | ||
- | | TX | IEEE 802.3x flow control may be initiated by this station. | | ||
- | | TX_RX | IEEE 802.3x flow control may be initiated by this station or the link partner. | | ||
- | |||
- | == FlowControlStatus == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | None | No IEEE 802.3x flow control is enabled on this port. | | ||
- | | RX | IEEE 802.3x flow control may be initiated by the link partner. | | ||
- | | TX | IEEE 802.3x flow control may be initiated by this station. | | ||
- | | TX_RX | IEEE 802.3x flow control may be initiated by this station or the link partner. | | ||
- | |||
- | == LinkStatus == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Down | The port is enabled but link is down. | | ||
- | | Up | The port is enabled and link is good (up). | | ||
- | |||
- | |||
- | ===== PCIeDevice ===== | ||
- | |||
- | This is the schema definition for the PCIeDevice resource. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **AssetTag** | string, null | read-write | The user assigned asset tag for this PCIe device. | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **DeviceType** | string | read-write | The device type for this PCIe device.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **FirmwareVersion** | string, null | read-only | The version of firmware for this PCIe device. | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Links** { | object | read-write | The links object contains the links to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Manufacturer** | string, null | read-only | This is the manufacturer of this PCIe device. | | ||
- | | **Model** | string, null | read-only | This is the model number for the PCIe device. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **PartNumber** | string, null | read-only | The part number for this PCIe device. | | ||
- | | **SKU** | string, null | read-only | This is the SKU for this PCIe device. | | ||
- | | **SerialNumber** | string, null | read-only | The serial number for this PCIe device. | | ||
- | | **Status** { | object, null | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == DeviceType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | MultiFunction | A multi-function PCIe device. | | ||
- | | Simulated | A PCIe device which is not currently physically present, but is being simulated by the PCIe infrastructure. | | ||
- | | SingleFunction | A single-function PCIe device. | | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== PCIeFunction ===== | ||
- | |||
- | This is the schema definition for the PCIeFunction resource. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **ClassCode** | string, null | read-only | The Class Code of this PCIe function.\\ pattern: / | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **DeviceClass** | string | read-write | The class for this PCIe Function.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **DeviceId** | string, null | read-only | The Device ID of this PCIe function.\\ pattern: / | ||
- | | **FunctionId** | number, null | read-only | The the PCIe Function identifier. | | ||
- | | **FunctionType** | string | read-write | The type of the PCIe Function.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Links** { | object | read-write | The links object contains the links to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **RevisionId** | string, null | read-only | The Revision ID of this PCIe function.\\ pattern: / | ||
- | | **Status** { | object, null | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **SubsystemId** | string, null | read-only | The Subsystem ID of this PCIe function.\\ pattern: / | ||
- | | **SubsystemVendorId** | string, null | read-only | The Subsystem Vendor ID of this PCIe function.\\ pattern: / | ||
- | | **VendorId** | string, null | read-only | The Vendor ID of this PCIe function.\\ pattern: / | ||
- | |||
- | === Property Details === | ||
- | |||
- | == DeviceClass == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Bridge | A bridge. | | ||
- | | CommunicationController | A communication controller. | | ||
- | | Coprocessor | A coprocessor. | | ||
- | | DisplayController | A display controller. | | ||
- | | DockingStation | A docking station. | | ||
- | | EncryptionController | An encryption controller. | | ||
- | | GenericSystemPeripheral | A generic system peripheral. | | ||
- | | InputDeviceController | An input device controller. | | ||
- | | IntelligentController | An intelligent controller. | | ||
- | | MassStorageController | A mass storage controller. | | ||
- | | MemoryController | A memory controller. | | ||
- | | MultimediaController | A multimedia controller. | | ||
- | | NetworkController | A network controller. | | ||
- | | NonEssentialInstrumentation | A non-essential instrumentation. | | ||
- | | Other | A other class. The function Device Class Id needs to be verified. | | ||
- | | ProcessingAccelerators | A processing accelerators. | | ||
- | | Processor | A processor. | | ||
- | | SatelliteCommunicationsController | A satellite communications controller. | | ||
- | | SerialBusController | A serial bus controller. | | ||
- | | SignalProcessingController | A signal processing controller. | | ||
- | | UnassignedClass | An unassigned class. | | ||
- | | UnclassifiedDevice | An unclassified device. | | ||
- | | WirelessController | A wireless controller. | | ||
- | |||
- | == FunctionType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Physical | A physical PCie function. | | ||
- | | Virtual | A virtual PCIe function. | | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== Port ===== | ||
- | |||
- | Port contains properties describing a port of a switch. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Actions** { | object | read-write | The available actions for this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **CurrentSpeedGbps** | number, null | read-only | The current speed of this port.\\ unit: Gbit/s | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **MaxSpeedGbps** | number, null | read-only | The maximum speed of this port as currently configured.\\ unit: Gbit/s | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **PortId** | string, null | read-only | This is the label of this port on the physical switch package. | | ||
- | | **PortProtocol** | null | read-write | The protocol being sent over this port. | | ||
- | | **PortType** | string, null | read-write | This is the type of this port.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Status** { | object | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Width** | number, null | read-only | The number of lanes, phys, or other physical transport links that this port contains. | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == PortType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | BidirectionalPort | This port connects to any type of device. | | ||
- | | DownstreamPort | This port connects to a target device. | | ||
- | | InterswitchPort | This port connects to another switch. | | ||
- | | ManagementPort | This port connects to a switch manager. | | ||
- | | UnconfiguredPort | This port has not yet been configured. | | ||
- | | UpstreamPort | This port connects to a host device. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== PortCollection ===== | ||
- | |||
- | A Collection of Port resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == PortType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | BidirectionalPort | This port connects to any type of device. | | ||
- | | DownstreamPort | This port connects to a target device. | | ||
- | | InterswitchPort | This port connects to another switch. | | ||
- | | ManagementPort | This port connects to a switch manager. | | ||
- | | UnconfiguredPort | This port has not yet been configured. | | ||
- | | UpstreamPort | This port connects to a host device. | | ||
- | |||
- | |||
- | ===== Power ===== | ||
- | |||
- | This is the schema definition for the Power Metrics. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **PowerControl** [ {} ] | array | read-write | This is the definition for power control function (power reading/ | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **PowerSupplies** [ {} ] | array | read-write | Details of the power supplies associated with this system or device. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Redundancy** [ {} ] | array | read-write | Redundancy information for the power subsystem of this system or device. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Voltages** [ {} ] | array | read-write | This is the definition for voltage sensors. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == IndicatorLED == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Blinking | The Indicator LED is blinking. | | ||
- | | Lit | The Indicator LED is lit. | | ||
- | | Off | The Indicator LED is off. | | ||
- | |||
- | == LineInputVoltageType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | AC120V | AC 120V nominal input. | | ||
- | | AC240V | AC 240V nominal input. | | ||
- | | AC277V | AC 277V nominal input. | | ||
- | | ACHighLine | 277V AC input. Deprecated: Use AC277V. | | ||
- | | ACLowLine | 100-127V AC input. Deprecated: Use AC120V. | | ||
- | | ACMidLine | 200-240V AC input. Deprecated: Use AC240V. | | ||
- | | ACWideRange | Wide range AC input. | | ||
- | | ACandDCWideRange | Wide range AC or DC input. | | ||
- | | DC240V | DC 240V nominal input. | | ||
- | | DC380V | High Voltage DC input (380V). | | ||
- | | DCNeg48V | -48V DC input. | | ||
- | | Unknown | The power supply line input voltage type cannot be determined. | | ||
- | |||
- | == Mode == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Failover | Failure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set. | | ||
- | | N+m | Multiple units are available and active such that normal operation will continue if one or more units fail. | | ||
- | | Sharing | Multiple units contribute or share such that operation will continue, but at a reduced capacity, if one or more units fail. | | ||
- | | Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. | | ||
- | |||
- | == PhysicalContext == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Back | The back of the chassis | | ||
- | | Backplane | A backplane within the chassis | | ||
- | | CPU | A Processor (CPU) | | ||
- | | ComputeBay | Within a compute bay | | ||
- | | Exhaust | The exhaust point of the chassis | | ||
- | | ExpansionBay | Within an expansion bay | | ||
- | | Front | The front of the chassis | | ||
- | | GPU | A Graphics Processor (GPU) | | ||
- | | Intake | The intake point of the chassis | | ||
- | | Lower | The lower portion of the chassis | | ||
- | | NetworkBay | Within a networking bay | | ||
- | | NetworkingDevice | A networking device | | ||
- | | PowerSupply | A power supply | | ||
- | | PowerSupplyBay | Within a power supply bay | | ||
- | | Room | The room | | ||
- | | StorageBay | Within a storage bay | | ||
- | | StorageDevice | A storage device | | ||
- | | SystemBoard | The system board (PCB) | | ||
- | | Upper | The upper portion of the chassis | | ||
- | | VoltageRegulator | A voltage regulator device | | ||
- | |||
- | == PowerSupplyType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | AC | Alternating Current (AC) power supply. | | ||
- | | ACorDC | Power Supply supports both DC or AC. | | ||
- | | DC | Direct Current (DC) power supply. | | ||
- | | Unknown | The power supply type cannot be determined. | | ||
- | |||
- | |||
- | ===== PrivilegeRegistry ===== | ||
- | |||
- | This is the schema definition for Operation to Privilege mapping. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Mappings** [ {} ] | array | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **OEMPrivilegesUsed** [ {} ] | array | read-only | Lists the set of OEM Priviliges used in building this mapping. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **PrivilegesUsed** [ {} ] | array | read-only | Lists the set of Redfish standard priviliges used in building this mapping. | | ||
- | |||
- | ===== Processor ===== | ||
- | |||
- | This is the schema definition for the Processor resource. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **InstructionSet** | string, null | read-write | The instruction set of the processor.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Manufacturer** | string, null | read-only | The processor manufacturer. | | ||
- | | **MaxSpeedMHz** | number, null | read-only | The maximum clock speed of the processor. | | ||
- | | **Model** | string, null | read-only | The product model number of this device. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **ProcessorArchitecture** | string, null | read-write | The architecture of the processor.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **ProcessorId** { | object | read-write | Identification information for this processor. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **ProcessorType** | string, null | read-write | The type of processor.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Socket** | string, null | read-only | The socket or location of the processor. | | ||
- | | **Status** { | object | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **TotalCores** | number, null | read-only | The total number of cores contained in this processor. | | ||
- | | **TotalThreads** | number, null | read-only | The total number of execution threads supported by this processor. | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == InstructionSet == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | ARM-A32 | ARM 32-bit. | | ||
- | | ARM-A64 | ARM 64-bit. | | ||
- | | IA-64 | Intel IA-64. | | ||
- | | MIPS32 | MIPS 32-bit. | | ||
- | | MIPS64 | MIPS 64-bit. | | ||
- | | OEM | OEM-defined. | | ||
- | | x86 | x86 32-bit. | | ||
- | | x86-64 | x86 64-bit. | | ||
- | |||
- | == ProcessorArchitecture == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | ARM | ARM. | | ||
- | | IA-64 | Intel Itanium. | | ||
- | | MIPS | MIPS. | | ||
- | | OEM | OEM-defined. | | ||
- | | x86 | x86 or x86-64. | | ||
- | |||
- | == ProcessorType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Accelerator | An Accelerator. | | ||
- | | CPU | A Central Processing Unit. | | ||
- | | DSP | A Digital Signal Processor. | | ||
- | | FPGA | A Field Programmable Gate Array. | | ||
- | | GPU | A Graphics Processing Unit. | | ||
- | | OEM | An OEM-defined Processing Unit. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== ProcessorCollection ===== | ||
- | |||
- | A Collection of Processor resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == InstructionSet == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | ARM-A32 | ARM 32-bit. | | ||
- | | ARM-A64 | ARM 64-bit. | | ||
- | | IA-64 | Intel IA-64. | | ||
- | | MIPS32 | MIPS 32-bit. | | ||
- | | MIPS64 | MIPS 64-bit. | | ||
- | | OEM | OEM-defined. | | ||
- | | x86 | x86 32-bit. | | ||
- | | x86-64 | x86 64-bit. | | ||
- | |||
- | == ProcessorArchitecture == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | ARM | ARM. | | ||
- | | IA-64 | Intel Itanium. | | ||
- | | MIPS | MIPS. | | ||
- | | OEM | OEM-defined. | | ||
- | | x86 | x86 or x86-64. | | ||
- | |||
- | == ProcessorType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Accelerator | An Accelerator. | | ||
- | | CPU | A Central Processing Unit. | | ||
- | | DSP | A Digital Signal Processor. | | ||
- | | FPGA | A Field Programmable Gate Array. | | ||
- | | GPU | A Graphics Processing Unit. | | ||
- | | OEM | An OEM-defined Processing Unit. | | ||
- | |||
- | |||
- | ===== Role ===== | ||
- | |||
- | This resource defines a user role to be used in conjunction with a Manager Account. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **AssignedPrivileges** [ {} ] | array | read-write | The redfish privileges that this role includes. | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **IsPredefined** | boolean | read-only | This property is used to indicate if the Role is one of the Redfish Predefined Roles vs a Custom role. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **OemPrivileges** [ {} ] | array | read-write | The OEM privileges that this role includes. | | ||
- | |||
- | ===== RoleCollection ===== | ||
- | |||
- | A Collection of Role resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== SecureBoot ===== | ||
- | |||
- | This resource contains UEFI Secure Boot information. It represents properties for managing the UEFI Secure Boot functionality of a system. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Actions** { | object | read-write | The available actions for this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **SecureBootCurrentBoot** | string, null | read-write | Secure Boot state during the current boot cycle.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **SecureBootEnable** | boolean, null | read-write | Enable or disable UEFI Secure Boot (takes effect on next boot). | | ||
- | | **SecureBootMode** | string, null | read-write | Current Secure Boot Mode.\\ *See Property Details, below, for more information about this property.* | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == 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. | | ||
- | |||
- | |||
- | ===== SerialInterface ===== | ||
- | |||
- | This schema defines an asynchronous serial interface resource. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **BitRate** | string | read-write | The receive and transmit rate of data flow, typically in bits-per-second (bps), over the serial connection.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **ConnectorType** | string | read-write | The type of connector used for this interface.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **DataBits** | string | read-write | The number of data bits that will follow the start bit over the serial connection.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **FlowControl** | string | read-write | The type of flow control, if any, that will be imposed on the serial connection.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **InterfaceEnabled** | boolean, null | read-write | This indicates whether this interface is enabled. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **Parity** | string | read-write | The type of parity used by the sender and receiver in order to detect errors over the serial connection.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **PinOut** | string, null | read-write | The physical pin configuration needed for a serial connector.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **SignalType** | string | read-write | The type of signal used for the communication connection - RS232 or RS485.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **StopBits** | string | read-write | The period of time before the next start bit is transmitted.\\ *See Property Details, below, for more information about this property.* | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == BitRate == | ||
- | |||
- | ^ string ^ | ||
- | | 1200 | | ||
- | | 2400 | | ||
- | | 4800 | | ||
- | | 9600 | | ||
- | | 19200 | | ||
- | | 38400 | | ||
- | | 57600 | | ||
- | | 115200 | | ||
- | | 230400 | | ||
- | |||
- | == ConnectorType == | ||
- | |||
- | ^ string ^ | ||
- | | RJ45. | | ||
- | | RJ11. | | ||
- | | DB9 Female. | | ||
- | | DB9 Male. | | ||
- | | DB25 Female. | | ||
- | | DB25 Male. | | ||
- | | USB. | | ||
- | | mUSB. | | ||
- | | uUSB. | | ||
- | |||
- | == DataBits == | ||
- | |||
- | ^ string ^ | ||
- | | 5 | | ||
- | | 6 | | ||
- | | 7 | | ||
- | | 8 | | ||
- | |||
- | == FlowControl == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Hardware | Out of band flow control imposed. | | ||
- | | None | No flow control imposed. | | ||
- | | Software | XON/XOFF in-band flow control imposed. | | ||
- | |||
- | == Parity == | ||
- | |||
- | ^ string ^ | ||
- | | None | | ||
- | | Even | | ||
- | | Odd | | ||
- | | Mark | | ||
- | | Space | | ||
- | |||
- | == PinOut == | ||
- | |||
- | ^ string ^ | ||
- | | Cisco | | ||
- | | Cyclades | | ||
- | | Digi | | ||
- | |||
- | == SignalType == | ||
- | |||
- | ^ string ^ | ||
- | | Rs232 | | ||
- | | Rs485 | | ||
- | |||
- | == StopBits == | ||
- | |||
- | ^ string ^ | ||
- | | 1 | | ||
- | | 2 | | ||
- | |||
- | |||
- | ===== SerialInterfaceCollection ===== | ||
- | |||
- | A Collection of SerialInterface resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == BitRate == | ||
- | |||
- | ^ string ^ | ||
- | | 1200 | | ||
- | | 2400 | | ||
- | | 4800 | | ||
- | | 9600 | | ||
- | | 19200 | | ||
- | | 38400 | | ||
- | | 57600 | | ||
- | | 115200 | | ||
- | | 230400 | | ||
- | |||
- | == ConnectorType == | ||
- | |||
- | ^ string ^ | ||
- | | RJ45. | | ||
- | | RJ11. | | ||
- | | DB9 Female. | | ||
- | | DB9 Male. | | ||
- | | DB25 Female. | | ||
- | | DB25 Male. | | ||
- | | USB. | | ||
- | | mUSB. | | ||
- | | uUSB. | | ||
- | |||
- | == DataBits == | ||
- | |||
- | ^ string ^ | ||
- | | 5 | | ||
- | | 6 | | ||
- | | 7 | | ||
- | | 8 | | ||
- | |||
- | == FlowControl == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Hardware | Out of band flow control imposed. | | ||
- | | None | No flow control imposed. | | ||
- | | Software | XON/XOFF in-band flow control imposed. | | ||
- | |||
- | == Parity == | ||
- | |||
- | ^ string ^ | ||
- | | None | | ||
- | | Even | | ||
- | | Odd | | ||
- | | Mark | | ||
- | | Space | | ||
- | |||
- | == PinOut == | ||
- | |||
- | ^ string ^ | ||
- | | Cisco | | ||
- | | Cyclades | | ||
- | | Digi | | ||
- | |||
- | == SignalType == | ||
- | |||
- | ^ string ^ | ||
- | | Rs232 | | ||
- | | Rs485 | | ||
- | |||
- | == StopBits == | ||
- | |||
- | ^ string ^ | ||
- | | 1 | | ||
- | | 2 | | ||
- | |||
- | |||
- | ===== ServiceRoot ===== | ||
- | |||
- | This object represents the root Redfish service. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **[[documentation: | ||
- | | **[[documentation: | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **[[documentation: | ||
- | | **[[documentation: | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **[[documentation: | ||
- | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **[[documentation: | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **RedfishVersion** | string | read-only | The version of the Redfish service.\\ pattern: ^\d+\.\d+\.\d+$ | | ||
- | | **[[documentation: | ||
- | | **[[documentation: | ||
- | | **[[documentation: | ||
- | | **[[documentation: | ||
- | | **[[documentation: | ||
- | | **[[documentation: | ||
- | | **UUID** | string, null | read-write | Unique identifier for a service instance. When SSDP is used, this value should be an exact match of the UUID value returned in a 200OK from an SSDP M-SEARCH request during discovery.\\ pattern: ([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}) | | ||
- | | **[[documentation: | ||
- | |||
- | ===== Session ===== | ||
- | |||
- | The Session resource describes a single connection (session) between a client and a Redfish service instance. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **Password** | string, null | read-only | This property is used in a POST to specify a password when creating a new session. | ||
- | | **UserName** | string, null | read-only | The UserName for the account for this session. | | ||
- | |||
- | ===== SessionCollection ===== | ||
- | |||
- | A Collection of Session resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== SessionService ===== | ||
- | |||
- | This is the schema definition for the Session Service. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Actions** { | object | read-write | The Actions object contains the available custom actions on this resource. | | ||
- | | < | ||
- | | } | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **ServiceEnabled** | boolean, null | read-write | This indicates whether this service is enabled. | | ||
- | | **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 | | ||
- | | **[[documentation: | ||
- | | **Status** { | object | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== SimpleStorage ===== | ||
- | |||
- | This is the schema definition for the Simple Storage resource. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Devices** [ {} ] | array | read-write | The storage devices associated with this resource. | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **Status** { | object | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **UefiDevicePath** | string, null | read-only | The UEFI device path used to access this storage controller. | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== SimpleStorageCollection ===== | ||
- | |||
- | A Collection of SimpleStorage resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== SoftwareInventory ===== | ||
- | |||
- | This schema defines an inventory of software components. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Actions** { | object | read-write | The Actions object contains the available custom actions on this resource. | | ||
- | | < | ||
- | | } | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **LowestSupportedVersion** | string, null | read-only | A string representing the lowest supported version of this software. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **RelatedItem** [ {} ] | array | read-only | The ID(s) of the resources associated with this software inventory item. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **SoftwareId** | string | read-only | A string representing the implementation-specific ID for identifying this software. | | ||
- | | **Status** { | object, null | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **UefiDevicePaths** [ {} ] | array | read-only | A list of strings representing the UEFI Device Path(s) of the component(s) associated with this software inventory item. | | ||
- | | **Updateable** | boolean, null | read-only | Indicates whether this software can be updated by the update service. | | ||
- | | **Version** | string, null | read-only | A string representing the version of this software. | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== SoftwareInventoryCollection ===== | ||
- | |||
- | A Collection of SoftwareInventory resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== Storage ===== | ||
- | |||
- | This schema defines a storage subsystem and its respective properties. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Actions** { | object | read-write | The available actions for this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Drives** [ {} ] | array | read-only | The set of drives attached to the storage controllers represented by this resource. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **Redundancy** [ {} ] | array | read-write | Redundancy information for the storage subsystem. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Status** { | object | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **StorageControllers** [ {} ] | array | read-only | The set of storage controllers represented by this resource. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **[[documentation: | ||
- | |||
- | === Property Details === | ||
- | |||
- | == EncryptionAbility == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | None | The drive is not capable of self encryption. | | ||
- | | Other | The drive is capable of self encryption through some other means. | | ||
- | | SelfEncryptingDrive | The drive is capable of self encryption per the Trusted Computing Group' | ||
- | |||
- | == EncryptionStatus == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Foreign | The drive is currently encrypted, the data is not accessible to the user, and the system requires user intervention to expose the data. | | ||
- | | Locked | The drive is currently encrypted and the data is not accessible to the user, however the system has the ability to unlock the drive automatically. | | ||
- | | Unecrypted | The drive is not currently encrypted. Deprecated: Use Unencrypted. | | ||
- | | Unencrypted | The drive is not currently encrypted. | | ||
- | | Unlocked | The drive is currently encrypted but the data is accessible to the user unencrypted. | | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HotspareType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Chassis | The drive is currently serving as a hotspare for all other drives in the chassis. | | ||
- | | Dedicated | The drive is currently serving as a hotspare for a user defined set of drives. | | ||
- | | Global | The drive is currently serving as a hotspare for all other drives in the storage system. | | ||
- | | None | The drive is not currently a hotspare. | | ||
- | |||
- | == IndicatorLED == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Blinking | The Indicator LED is blinking. | | ||
- | | Lit | The Indicator LED is lit. | | ||
- | | Off | The Indicator LED is off. | | ||
- | |||
- | == MediaType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | HDD | The drive media type is traditional magnetic platters. | | ||
- | | SMR | The drive media type is shingled magnetic recording. | | ||
- | | SSD | The drive media type is solid state or flash memory. | | ||
- | |||
- | == Mode == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Failover | Failure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set. | | ||
- | | N+m | Multiple units are available and active such that normal operation will continue if one or more units fail. | | ||
- | | Sharing | Multiple units contribute or share such that operation will continue, but at a reduced capacity, if one or more units fail. | | ||
- | | Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | == StatusIndicator == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Fail | The drive has failed. | | ||
- | | Hotspare | The drive is marked to be automatically rebuilt and used as a replacement for a failed drive. | | ||
- | | InACriticalArray | The array that this drive is a part of is degraded. | | ||
- | | InAFailedArray | The array that this drive is a part of is failed. | | ||
- | | OK | The drive is OK. | | ||
- | | PredictiveFailureAnalysis | The drive is still working but predicted to fail soon. | | ||
- | | Rebuild | The drive is being rebuilt. | | ||
- | |||
- | |||
- | ===== StorageCollection ===== | ||
- | |||
- | A Collection of Storage resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== StorageGroup ===== | ||
- | |||
- | Collection of resources that are managed and exposed to hosts as a group. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **AccessState** | null | read-write | AccessState for this storage group. | | ||
- | | **Actions** { | object | read-only | The available actions for this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **[[documentation: | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Identifier** { | object, null | read-only | The value identifies this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Links** { | object | read-only | Contains links to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **MembersAreConsistent** | boolean, null | read-only | Members are kept in a consistent state. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **ReplicaInfos** [ {} ] | array | read-only | Describes this storage group in its role as a source and/or target for replication. | | ||
- | | **[[documentation: | ||
- | | **Status** { | object, null | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **[[documentation: | ||
- | | **VolumesAreExposed** | boolean, null | read-only | Storage volumes are exposed to the Client Endpoints. | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == ConsistencyState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Consistent | Consistent. | | ||
- | | Inconsistent | Not consistent. | | ||
- | |||
- | == ConsistencyStatus == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Consistent | Consistent. | | ||
- | | Disabled | Consistency disabled. | | ||
- | | InError | Consistency error. | | ||
- | | InProgress | Becoming consistent. | | ||
- | |||
- | == ConsistencyType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | SequentiallyConsistent | Sequentially consistent. | | ||
- | |||
- | == DurableNameFormat == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
- | | FC_WWN | Fibre Channel World Wide Name | | ||
- | | NAA | Name Address Authority Format | | ||
- | | UUID | Universally Unique Identifier | | ||
- | | iQN | iSCSI Qualified Name | | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == ReplicaPriority == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | High | Copy engine I/O has higher priority than host I/O. | | ||
- | | Low | Copy engine I/O lower priority than host I/O. | | ||
- | | Same | Copy engine I/O has the same priority as host I/O. | | ||
- | | Urgent | Copy operation to be performed as soon as possible, regardless of the host I/O requests. | | ||
- | |||
- | == ReplicaProgressStatus == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Aborting | Abort in progress. | | ||
- | | Completed | The request is completed. Data flow is idle. | | ||
- | | Detaching | Detach in progress. | | ||
- | | Dormant | Indicates that the data flow is inactive, suspended or quiesced. | | ||
- | | FailingBack | Undoing the result of failover. | | ||
- | | FailingOver | In the process of switching source and target. | | ||
- | | Fracturing | Fracture in progress. | | ||
- | | Initializing | In the process of establishing source/ | ||
- | | Mixed | Applies to groups with element pairs with different statuses. Generally, the individual statuses need to be examined. | | ||
- | | Pending | The flow of data has stopped momentarily due to limited bandwidth or a busy system. | | ||
- | | Preparing | Preparation in progress. | | ||
- | | RequiresActivate | The requested operation has completed, however, the synchronization relationship needs to be activated before further copy operations can be issued. | | ||
- | | RequiresDetach | The requested operation has completed, however, the synchronization relationship needs to be detached before further copy operations can be issued. | | ||
- | | RequiresFracture | The requested operation has completed, however, the synchronization relationship needs to be fractured before further copy operations can be issued. | | ||
- | | RequiresResume | The requested operation has completed, however, the synchronization relationship needs to be resumed before further copy operations can be issued. | | ||
- | | RequiresResync | The requested operation has completed, however, the synchronization relationship needs to be resynced before further copy operations can be issued. | | ||
- | | RequiresSplit | The requested operation has completed, however, the synchronization relationship needs to be split before further copy operations can be issued. | | ||
- | | Restoring | Restore in progress. | | ||
- | | Resyncing | Resync in progess. | | ||
- | | Splitting | Split in progress. | | ||
- | | Suspending | The copy operation is in the process of being suspended. | | ||
- | | Synchronizing | Sync in progress. | | ||
- | | Terminating | The relationship is in the process of terminating. | | ||
- | |||
- | == ReplicaReadOnlyAccess == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Both | Both the source and the target elements are read only to the host. | | ||
- | | ReplicaElement | The replica element. | ||
- | | SourceElement | The source element. | | ||
- | |||
- | == ReplicaRecoveryMode == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Automatic | Copy operation resumes automatically. | | ||
- | | Manual | ReplicaState is set to Suspended after the link is restored. It is required to issue the Resume operation to continue. | | ||
- | |||
- | == ReplicaRole == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Source | The source element. | | ||
- | | Target | The target element. | ||
- | |||
- | == ReplicaState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Aborted | The copy operation is aborted with the Abort operation. Use the Resync Replica operation to restart the copy operation. | ||
- | | Broken | The relationship is non-functional due to errors in the source, the target, the path between the two or space constraints. | ||
- | | Failedover | Reads and writes are sent to the target element. Source element is not reachable. | ||
- | | Fractured | Target is split from the source. | ||
- | | Inactive | Data flow has stopped, writes to source element will not be sent to target element. | ||
- | | Initialized | The link to enable replication is established and source/ | ||
- | | Invalid | The array is unable to determine the state of the replication relationship, | ||
- | | Mixed | Applies to the ReplicaState of GroupSynchronized. It indicates the StorageSynchronized relationships of the elements in the groups have different ReplicaState values. | ||
- | | Partitioned | State of replication relationship can not be determined, for example, due to a connection problem. | ||
- | | Prepared | Initialization is completed, however, the data flow has not started. | ||
- | | Restored | It indicates the source element was restored from the target element. | | ||
- | | Skewed | The target has been modified and is no longer synchronized with the source element or the point-in-time view. | | ||
- | | Split | The target element was gracefully (or systematically) split from its source element -- consistency is guaranteed. | ||
- | | Suspended | Data flow between the source and target elements has stopped. Writes to source element are held until the relationship is Resumed. | ||
- | | Synchronized | For the Mirror, Snapshot, or Clone replication, | ||
- | | Unsynchronized | Not all the source element data has been copied to the target element. | ||
- | |||
- | == ReplicaType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Clone | Create a point in time, full copy the source. | | ||
- | | Mirror | Create and maintain a copy of the source. | | ||
- | | Snapshot | Create a point in time, virtual copy of the source. | | ||
- | | TokenizedClone | Create a token based clone. | | ||
- | |||
- | == ReplicaUpdateMode == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Active | Active-Active (i.e. bidirectional) synchronous updates. | | ||
- | | Adaptive | Allows implementation to switch between synchronous and asynchronous modes. | | ||
- | | Asynchronous | Asynchronous updates. | | ||
- | | Synchronous | Synchronous updates. | | ||
- | |||
- | == RequestedReplicaState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Aborted | The copy operation is aborted with the Abort operation. Use the Resync Replica operation to restart the copy operation. | ||
- | | Broken | The relationship is non-functional due to errors in the source, the target, the path between the two or space constraints. | ||
- | | Failedover | Reads and writes are sent to the target element. Source element is not reachable. | ||
- | | Fractured | Target is split from the source. | ||
- | | Inactive | Data flow has stopped, writes to source element will not be sent to target element. | ||
- | | Initialized | The link to enable replication is established and source/ | ||
- | | Invalid | The array is unable to determine the state of the replication relationship, | ||
- | | Mixed | Applies to the ReplicaState of GroupSynchronized. It indicates the StorageSynchronized relationships of the elements in the groups have different ReplicaState values. | ||
- | | Partitioned | State of replication relationship can not be determined, for example, due to a connection problem. | ||
- | | Prepared | Initialization is completed, however, the data flow has not started. | ||
- | | Restored | It indicates the source element was restored from the target element. | | ||
- | | Skewed | The target has been modified and is no longer synchronized with the source element or the point-in-time view. | | ||
- | | Split | The target element was gracefully (or systematically) split from its source element -- consistency is guaranteed. | ||
- | | Suspended | Data flow between the source and target elements has stopped. Writes to source element are held until the relationship is Resumed. | ||
- | | Synchronized | For the Mirror, Snapshot, or Clone replication, | ||
- | | Unsynchronized | Not all the source element data has been copied to the target element. | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | == UndiscoveredElement == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | ReplicaElement | The replica element is undiscovered. | | ||
- | | SourceElement | The source element is undiscovered. | | ||
- | |||
- | |||
- | ===== StorageGroupCollection ===== | ||
- | |||
- | A Collection of StorageGroup resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | The value of each member references a StorageGroup resource. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== StoragePool ===== | ||
- | |||
- | A container of data storage. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **[[documentation: | ||
- | | **[[documentation: | ||
- | | **BlockSizeBytes** | number, null | read-only | Maximum Block size in bytes.\\ unit: By | | ||
- | | **Capacity** { | object, null | read-write | Capacity utilization. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **CapacitySources** [ {} ] | array | read-only | An array of space allocations to this store. | | ||
- | | **[[documentation: | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Identifier** { | object, null | read-only | The value identifies this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Links** { | object | read-only | Contains links to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **LowSpaceWarningThresholdPercents** [ {} ] | array | read-write | Low space warning threshold specified in percents. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **Status** { | object, null | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == DurableNameFormat == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
- | | FC_WWN | Fibre Channel World Wide Name | | ||
- | | NAA | Name Address Authority Format | | ||
- | | UUID | Universally Unique Identifier | | ||
- | | iQN | iSCSI Qualified Name | | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== StoragePoolCollection ===== | ||
- | |||
- | A Collection of StoragePool resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | The value of each member references a StoragePool resource. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== StorageService ===== | ||
- | |||
- | Collection of resources that are managed and exposed to hosts as a group. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Actions** { | object | read-only | The available actions for this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **[[documentation: | ||
- | | **[[documentation: | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **[[documentation: | ||
- | | **[[documentation: | ||
- | | **[[documentation: | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Identifier** { | object, null | read-only | The value identifies this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Links** { | object | read-only | Contains links to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **Redundancy** [ {} ] | array | read-only | Redundancy information for the storage subsystem | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **[[documentation: | ||
- | | **Status** { | object, null | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **[[documentation: | ||
- | | **[[documentation: | ||
- | | **[[documentation: | ||
- | |||
- | === Property Details === | ||
- | |||
- | == DurableNameFormat == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
- | | FC_WWN | Fibre Channel World Wide Name | | ||
- | | NAA | Name Address Authority Format | | ||
- | | UUID | Universally Unique Identifier | | ||
- | | iQN | iSCSI Qualified Name | | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == Mode == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Failover | Failure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set. | | ||
- | | N+m | Multiple units are available and active such that normal operation will continue if one or more units fail. | | ||
- | | Sharing | Multiple units contribute or share such that operation will continue, but at a reduced capacity, if one or more units fail. | | ||
- | | Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== StorageServiceCollection ===== | ||
- | |||
- | A collection of references to Storage Service resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | The value of each member references a StorageService resource. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== StorageSystemCollection ===== | ||
- | |||
- | A Collection of ComputerSystem resource instances that each have an entry in HostingRoles set to ' | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | The value of each member references a Storage System resource. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == IndicatorLED == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Blinking | The Indicator LED is blinking. | | ||
- | | Lit | The Indicator LED is lit. | | ||
- | | Off | The Indicator LED is off. | | ||
- | | Unknown | The state of the Indicator LED cannot be determined. Deprecated: Return null if state is unknown. | | ||
- | |||
- | == PowerState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Off | The system is powered off, although some components may continue to have AUX power such as management controller. | | ||
- | | On | The system is powered on. | | ||
- | | PoweringOff | A temporary state between On and Off. The power off action can take time while the OS is in the shutdown process. | | ||
- | | PoweringOn | A temporary state between Off and On. This temporary state can be very short. | | ||
- | |||
- | == SystemType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | OS | An operating system instance. | | ||
- | | Physical | A computer system. | | ||
- | | PhysicallyPartitioned | A hardware-based partition of a computer system. | | ||
- | | Virtual | A virtual machine instance running on this system. | | ||
- | | VirtuallyPartitioned | A virtual or software-based partition of a computer system. | | ||
- | |||
- | |||
- | ===== Switch ===== | ||
- | |||
- | Switch contains properties describing a simple fabric switch. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Actions** { | object | read-write | The available actions for this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **AssetTag** | string, null | read-write | The user assigned asset tag for this switch. | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **DomainID** | number, null | read-only | The Domain ID for this switch. | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **IndicatorLED** | string, null | read-write | The state of the indicator LED, used to identify the switch.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **IsManaged** | boolean, null | read-write | This indicates whether the switch is in a managed or unmanaged state. | | ||
- | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **[[documentation: | ||
- | | **Manufacturer** | string, null | read-only | This is the manufacturer of this switch. | | ||
- | | **Model** | string, null | read-only | The product model number of this switch. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **PartNumber** | string, null | read-only | The part number for this switch. | | ||
- | | **[[documentation: | ||
- | | **PowerState** | string, null | read-write | This is the current power state of the switch.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Redundancy** [ {} ] | array | read-write | Redundancy information for the switches. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **SKU** | string, null | read-only | This is the SKU for this switch. | | ||
- | | **SerialNumber** | string, null | read-only | The serial number for this switch. | | ||
- | | **Status** { | object | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **SwitchType** | null | read-write | The protocol being sent over this switch. | | ||
- | | **TotalSwitchWidth** | number, null | read-only | The total number of lanes, phys, or other physical transport links that this switch contains. | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == IndicatorLED == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Blinking | The Indicator LED is blinking. | | ||
- | | Lit | The Indicator LED is lit. | | ||
- | | Off | The Indicator LED is off. | | ||
- | |||
- | == Mode == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Failover | Failure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set. | | ||
- | | N+m | Multiple units are available and active such that normal operation will continue if one or more units fail. | | ||
- | | Sharing | Multiple units contribute or share such that operation will continue, but at a reduced capacity, if one or more units fail. | | ||
- | | Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. | | ||
- | |||
- | == PowerState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Off | The state is powered Off. | | ||
- | | On | The state is powered On. | | ||
- | | PoweringOff | A temporary state between On and Off. | | ||
- | | PoweringOn | A temporary state between Off and On. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== SwitchCollection ===== | ||
- | |||
- | A Collection of Switch resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == IndicatorLED == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Blinking | The Indicator LED is blinking. | | ||
- | | Lit | The Indicator LED is lit. | | ||
- | | Off | The Indicator LED is off. | | ||
- | |||
- | == PowerState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Off | The state is powered Off. | | ||
- | | On | The state is powered On. | | ||
- | | PoweringOff | A temporary state between On and Off. | | ||
- | | PoweringOn | A temporary state between Off and On. | | ||
- | |||
- | |||
- | ===== Task ===== | ||
- | |||
- | This resource contains information about a specific Task scheduled by or being executed by a Redfish service' | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **EndTime** | string | read-only | The date-time stamp that the task was last completed. | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Messages** [ {} ] | array | read-write | This is an array of messages associated with the task. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **StartTime** | string | read-only | The date-time stamp that the task was last started. | | ||
- | | **TaskState** | string | read-write | The state of the task.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **TaskStatus** | string | read-write | This is the completion status of the task.\\ *See Property Details, below, for more information about this property.* | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == TaskState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Completed | Task has completed. | | ||
- | | Exception | Task has stopped due to an exception condition. | | ||
- | | Interrupted | Task has been interrupted. | | ||
- | | Killed | Task was terminated. | | ||
- | | New | A new task. | | ||
- | | Pending | Task is pending and has not started. | | ||
- | | Running | Task is running normally. | | ||
- | | Service | Task is running as a service. | | ||
- | | Starting | Task is starting. | | ||
- | | Stopping | Task is in the process of stopping. | | ||
- | | Suspended | Task has been suspended. | | ||
- | |||
- | == TaskStatus == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | |||
- | ===== TaskCollection ===== | ||
- | |||
- | A Collection of Task resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == TaskState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Completed | Task has completed. | | ||
- | | Exception | Task has stopped due to an exception condition. | | ||
- | | Interrupted | Task has been interrupted. | | ||
- | | Killed | Task was terminated. | | ||
- | | New | A new task. | | ||
- | | Pending | Task is pending and has not started. | | ||
- | | Running | Task is running normally. | | ||
- | | Service | Task is running as a service. | | ||
- | | Starting | Task is starting. | | ||
- | | Stopping | Task is in the process of stopping. | | ||
- | | Suspended | Task has been suspended. | | ||
- | |||
- | == TaskStatus == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | |||
- | ===== TaskService ===== | ||
- | |||
- | This is the schema definition for the Task Service. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **CompletedTaskOverWritePolicy** | string | read-write | Overwrite policy of completed tasks.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **DateTime** | string, null | read-only | The current DateTime (with offset) setting that the task service is using. | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **LifeCycleEventOnTaskStateChange** | boolean | read-only | Send an Event upon Task State Change. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **ServiceEnabled** | boolean, null | read-write | This indicates whether this service is enabled. | | ||
- | | **Status** { | object | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **[[documentation: | ||
- | |||
- | === Property Details === | ||
- | |||
- | == CompletedTaskOverWritePolicy == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Manual | Completed tasks are not automatically overwritten. | | ||
- | | Oldest | Oldest completed tasks are overwritten. | | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== Thermal ===== | ||
- | |||
- | This is the schema definition for the Thermal properties. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Fans** [ {} ] | array | read-write | This is the definition for fans. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **Redundancy** [ {} ] | array | read-write | This structure is used to show redundancy for fans. The Component ids will reference the members of the redundancy groups. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Status** { | object | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Temperatures** [ {} ] | array | read-write | This is the definition for temperature sensors. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == IndicatorLED == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Blinking | The Indicator LED is blinking. | | ||
- | | Lit | The Indicator LED is lit. | | ||
- | | Off | The Indicator LED is off. | | ||
- | |||
- | == Mode == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Failover | Failure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set. | | ||
- | | N+m | Multiple units are available and active such that normal operation will continue if one or more units fail. | | ||
- | | Sharing | Multiple units contribute or share such that operation will continue, but at a reduced capacity, if one or more units fail. | | ||
- | | Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. | | ||
- | |||
- | == PhysicalContext == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Back | The back of the chassis | | ||
- | | Backplane | A backplane within the chassis | | ||
- | | CPU | A Processor (CPU) | | ||
- | | ComputeBay | Within a compute bay | | ||
- | | Exhaust | The exhaust point of the chassis | | ||
- | | ExpansionBay | Within an expansion bay | | ||
- | | Front | The front of the chassis | | ||
- | | GPU | A Graphics Processor (GPU) | | ||
- | | Intake | The intake point of the chassis | | ||
- | | Lower | The lower portion of the chassis | | ||
- | | NetworkBay | Within a networking bay | | ||
- | | NetworkingDevice | A networking device | | ||
- | | PowerSupply | A power supply | | ||
- | | PowerSupplyBay | Within a power supply bay | | ||
- | | Room | The room | | ||
- | | StorageBay | Within a storage bay | | ||
- | | StorageDevice | A storage device | | ||
- | | SystemBoard | The system board (PCB) | | ||
- | | Upper | The upper portion of the chassis | | ||
- | | VoltageRegulator | A voltage regulator device | | ||
- | |||
- | == ReadingUnits == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Percent | Indicates that the fan reading and thresholds are measured in percentage. | | ||
- | | RPM | Indicates that the fan reading and thresholds are measured in rotations per minute. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== UpdateService ===== | ||
- | |||
- | This is the schema definition for the Update Service. It represents the properties for the service itself and has links to collections of firmware and software inventory. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Actions** { | object | read-write | The Actions object contains the available custom actions on this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **[[documentation: | ||
- | | **HttpPushUri** | string | read-only | The URI used to perform an HTTP or HTTPS push update to the Update Service. | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **ServiceEnabled** | boolean, null | read-write | This indicates whether this service is enabled. | | ||
- | | **[[documentation: | ||
- | | **Status** { | object, null | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== VLanNetworkInterface ===== | ||
- | |||
- | This resource contains information for a Virtual LAN (VLAN) network instance available on a manager, system or other device. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **VLANEnable** | boolean, null | read-write | This indicates if this VLAN is enabled. | | ||
- | | **VLANId** | number, null | read-write | This indicates the VLAN identifier for this VLAN.\\ maximum: 4094 | | ||
- | |||
- | ===== VLanNetworkInterfaceCollection ===== | ||
- | |||
- | A Collection of VLanNetworkInterface resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | ===== VirtualMedia ===== | ||
- | |||
- | This resource allows monitoring and control of an instance of virtual media (e.g. a remote CD, DVD, or USB device) functionality provided by a Manager for a system or device. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **ConnectedVia** | string, null | read-write | Current virtual media connection methods.\\ *See Property Details, below, for more information about this property.* | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Image** | string, null | read-only | A URI providing the location of the selected image. | | ||
- | | **ImageName** | string, null | read-only | The current image name. | | ||
- | | **Inserted** | boolean, null | read-only | Indicates if virtual media is inserted in the virtual device. | | ||
- | | **MediaTypes** [ {} ] | array | read-only | This is the media types supported as virtual media. | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **WriteProtected** | boolean, null | read-only | Indicates the media is write protected. | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == ConnectedVia == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Applet | Connected to a client application. | | ||
- | | NotConnected | No current connection. | | ||
- | | Oem | Connected via an OEM-defined method. | | ||
- | | URI | Connected to a URI location. | | ||
- | |||
- | |||
- | ===== VirtualMediaCollection ===== | ||
- | |||
- | A Collection of VirtualMedia resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == ConnectedVia == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Applet | Connected to a client application. | | ||
- | | NotConnected | No current connection. | | ||
- | | Oem | Connected via an OEM-defined method. | | ||
- | | URI | Connected to a URI location. | | ||
- | |||
- | |||
- | ===== Volume ===== | ||
- | |||
- | Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **AccessCapabilities** [ {} ] | array | read-write | Supported IO access capabilities. | | ||
- | | **Actions** { | object | read-only | The available actions for this resource. | | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **AllocatedPools** [ {} ] | array | read-only | An array of references to StoragePools allocated from this Volume. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **BlockSizeBytes** | number, null | read-only | The size of the smallest addressable unit (Block) of this volume in bytes\\ unit: By | | ||
- | | **Capacity** { | object, null | read-write | Capacity utilization. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **CapacityBytes** | number, null | read-only | The size in bytes of this Volume\\ unit: By | | ||
- | | **CapacitySources** [ {} ] | array | read-write | An array of space allocations to this volume. | | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Encrypted** | boolean, null | read-write | Is this Volume encrypted | | ||
- | | **EncryptionTypes** [ {} ] | array | read-write | The types of encryption used by this Volume | | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Identifiers** [ {} ] | array | read-only | The Durable names for the volume | | ||
- | | **Links** { | object | read-only | Contains references to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **LowSpaceWarningThresholdPercents** [ {} ] | array | read-write | Low space warning. | | ||
- | | **Manufacturer** | string, null | read-only | The manufacturer or OEM of this storage volume. | | ||
- | | **MaxBlockSizeBytes** | number, null | read-only | Max Block size in bytes .\\ unit: By | | ||
- | | **Model** | string, null | read-only | The model number for this storage volume | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **Operations** [ {} ] | array | read-only | The operations currently running on the Volume | | ||
- | | **OptimumIOSizeBytes** | number, null | read-only | The size in bytes of this Volume' | ||
- | | **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. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **StorageGroups** [ {} ] | array | read-only | An array of references to Storage Groups that includes this volume. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **VolumeType** | string, null | read-write | The type of this volume\\ *See Property Details, below, for more information about this property.* | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == ConsistencyState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Consistent | Consistent. | | ||
- | | Inconsistent | Not consistent. | | ||
- | |||
- | == ConsistencyStatus == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Consistent | Consistent. | | ||
- | | Disabled | Consistency disabled. | | ||
- | | InError | Consistency error. | | ||
- | | InProgress | Becoming consistent. | | ||
- | |||
- | == ConsistencyType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | SequentiallyConsistent | Sequentially consistent. | | ||
- | |||
- | == DurableNameFormat == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | EUI | IEEE-defined 64-bit Extended Unique Identifier | | ||
- | | FC_WWN | Fibre Channel World Wide Name | | ||
- | | NAA | Name Address Authority Format | | ||
- | | UUID | Universally Unique Identifier | | ||
- | | iQN | iSCSI Qualified Name | | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == ReplicaPriority == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | High | Copy engine I/O has higher priority than host I/O. | | ||
- | | Low | Copy engine I/O lower priority than host I/O. | | ||
- | | Same | Copy engine I/O has the same priority as host I/O. | | ||
- | | Urgent | Copy operation to be performed as soon as possible, regardless of the host I/O requests. | | ||
- | |||
- | == ReplicaProgressStatus == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Aborting | Abort in progress. | | ||
- | | Completed | The request is completed. Data flow is idle. | | ||
- | | Detaching | Detach in progress. | | ||
- | | Dormant | Indicates that the data flow is inactive, suspended or quiesced. | | ||
- | | FailingBack | Undoing the result of failover. | | ||
- | | FailingOver | In the process of switching source and target. | | ||
- | | Fracturing | Fracture in progress. | | ||
- | | Initializing | In the process of establishing source/ | ||
- | | Mixed | Applies to groups with element pairs with different statuses. Generally, the individual statuses need to be examined. | | ||
- | | Pending | The flow of data has stopped momentarily due to limited bandwidth or a busy system. | | ||
- | | Preparing | Preparation in progress. | | ||
- | | RequiresActivate | The requested operation has completed, however, the synchronization relationship needs to be activated before further copy operations can be issued. | | ||
- | | RequiresDetach | The requested operation has completed, however, the synchronization relationship needs to be detached before further copy operations can be issued. | | ||
- | | RequiresFracture | The requested operation has completed, however, the synchronization relationship needs to be fractured before further copy operations can be issued. | | ||
- | | RequiresResume | The requested operation has completed, however, the synchronization relationship needs to be resumed before further copy operations can be issued. | | ||
- | | RequiresResync | The requested operation has completed, however, the synchronization relationship needs to be resynced before further copy operations can be issued. | | ||
- | | RequiresSplit | The requested operation has completed, however, the synchronization relationship needs to be split before further copy operations can be issued. | | ||
- | | Restoring | Restore in progress. | | ||
- | | Resyncing | Resync in progess. | | ||
- | | Splitting | Split in progress. | | ||
- | | Suspending | The copy operation is in the process of being suspended. | | ||
- | | Synchronizing | Sync in progress. | | ||
- | | Terminating | The relationship is in the process of terminating. | | ||
- | |||
- | == ReplicaReadOnlyAccess == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Both | Both the source and the target elements are read only to the host. | | ||
- | | ReplicaElement | The replica element. | ||
- | | SourceElement | The source element. | | ||
- | |||
- | == ReplicaRecoveryMode == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Automatic | Copy operation resumes automatically. | | ||
- | | Manual | ReplicaState is set to Suspended after the link is restored. It is required to issue the Resume operation to continue. | | ||
- | |||
- | == ReplicaRole == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Source | The source element. | | ||
- | | Target | The target element. | ||
- | |||
- | == ReplicaState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Aborted | The copy operation is aborted with the Abort operation. Use the Resync Replica operation to restart the copy operation. | ||
- | | Broken | The relationship is non-functional due to errors in the source, the target, the path between the two or space constraints. | ||
- | | Failedover | Reads and writes are sent to the target element. Source element is not reachable. | ||
- | | Fractured | Target is split from the source. | ||
- | | Inactive | Data flow has stopped, writes to source element will not be sent to target element. | ||
- | | Initialized | The link to enable replication is established and source/ | ||
- | | Invalid | The array is unable to determine the state of the replication relationship, | ||
- | | Mixed | Applies to the ReplicaState of GroupSynchronized. It indicates the StorageSynchronized relationships of the elements in the groups have different ReplicaState values. | ||
- | | Partitioned | State of replication relationship can not be determined, for example, due to a connection problem. | ||
- | | Prepared | Initialization is completed, however, the data flow has not started. | ||
- | | Restored | It indicates the source element was restored from the target element. | | ||
- | | Skewed | The target has been modified and is no longer synchronized with the source element or the point-in-time view. | | ||
- | | Split | The target element was gracefully (or systematically) split from its source element -- consistency is guaranteed. | ||
- | | Suspended | Data flow between the source and target elements has stopped. Writes to source element are held until the relationship is Resumed. | ||
- | | Synchronized | For the Mirror, Snapshot, or Clone replication, | ||
- | | Unsynchronized | Not all the source element data has been copied to the target element. | ||
- | |||
- | == ReplicaType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Clone | Create a point in time, full copy the source. | | ||
- | | Mirror | Create and maintain a copy of the source. | | ||
- | | Snapshot | Create a point in time, virtual copy of the source. | | ||
- | | TokenizedClone | Create a token based clone. | | ||
- | |||
- | == ReplicaUpdateMode == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Active | Active-Active (i.e. bidirectional) synchronous updates. | | ||
- | | Adaptive | Allows implementation to switch between synchronous and asynchronous modes. | | ||
- | | Asynchronous | Asynchronous updates. | | ||
- | | Synchronous | Synchronous updates. | | ||
- | |||
- | == RequestedReplicaState == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Aborted | The copy operation is aborted with the Abort operation. Use the Resync Replica operation to restart the copy operation. | ||
- | | Broken | The relationship is non-functional due to errors in the source, the target, the path between the two or space constraints. | ||
- | | Failedover | Reads and writes are sent to the target element. Source element is not reachable. | ||
- | | Fractured | Target is split from the source. | ||
- | | Inactive | Data flow has stopped, writes to source element will not be sent to target element. | ||
- | | Initialized | The link to enable replication is established and source/ | ||
- | | Invalid | The array is unable to determine the state of the replication relationship, | ||
- | | Mixed | Applies to the ReplicaState of GroupSynchronized. It indicates the StorageSynchronized relationships of the elements in the groups have different ReplicaState values. | ||
- | | Partitioned | State of replication relationship can not be determined, for example, due to a connection problem. | ||
- | | Prepared | Initialization is completed, however, the data flow has not started. | ||
- | | Restored | It indicates the source element was restored from the target element. | | ||
- | | Skewed | The target has been modified and is no longer synchronized with the source element or the point-in-time view. | | ||
- | | Split | The target element was gracefully (or systematically) split from its source element -- consistency is guaranteed. | ||
- | | Suspended | Data flow between the source and target elements has stopped. Writes to source element are held until the relationship is Resumed. | ||
- | | Synchronized | For the Mirror, Snapshot, or Clone replication, | ||
- | | Unsynchronized | Not all the source element data has been copied to the target element. | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | == UndiscoveredElement == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | ReplicaElement | The replica element is undiscovered. | | ||
- | | SourceElement | The source element is undiscovered. | | ||
- | |||
- | == VolumeType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Mirrored | The volume is a mirrored device | | ||
- | | NonRedundant | The volume is a non-redundant storage device | | ||
- | | RawDevice | The volume is a raw physical device without any RAID or other virtualization applied | | ||
- | | SpannedMirrors | The volume is a spanned set of mirrored devices | | ||
- | | SpannedStripesWithParity | The volume is a spanned set of devices which uses parity to retain redundant information | | ||
- | | StripedWithParity | The volume is a device which uses parity to retain redundant information | | ||
- | |||
- | |||
- | ===== VolumeCollection ===== | ||
- | |||
- | A Collection of Volume resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-write | The value of each member references a Volume resource. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | |||
- | === Property Details === | ||
- | |||
- | == VolumeType == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Mirrored | The volume is a mirrored device | | ||
- | | NonRedundant | The volume is a non-redundant storage device | | ||
- | | RawDevice | The volume is a raw physical device without any RAID or other virtualization applied | | ||
- | | SpannedMirrors | The volume is a spanned set of mirrored devices | | ||
- | | SpannedStripesWithParity | The volume is a spanned set of devices which uses parity to retain redundant information | | ||
- | | StripedWithParity | The volume is a device which uses parity to retain redundant information | | ||
- | |||
- | |||
- | ===== Zone ===== | ||
- | |||
- | Switch contains properties describing a simple fabric zone. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Id** | string | read-write | Uniquely identifies the resource within the collection of like resources. | | ||
- | | **Links** { | object | read-write | Contains references to other resources that are related to this resource. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||
- | | **Status** { | object | read-only | Indicates the status of the file share. | | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | < | ||
- | | } | | ||
- | |||
- | === Property Details === | ||
- | |||
- | == Health == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == HealthRollup == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Critical | A critical condition exists that requires immediate attention. | | ||
- | | OK | Normal. | | ||
- | | Warning | A condition exists that requires attention. | | ||
- | |||
- | == State == | ||
- | |||
- | ^ string ^ Description ^ | ||
- | | Absent | This function or resource is not present or not detected. | | ||
- | | Deferring | The element will not process any commands but will queue new requests. | | ||
- | | Disabled | This function or resource has been disabled. | | ||
- | | Enabled | This function or resource has been enabled. | | ||
- | | InTest | This function or resource is undergoing testing. | | ||
- | | Quiesced | The element is enabled but only processes a restricted set of commands. | | ||
- | | StandbyOffline | This function or resource is enabled, but awaiting an external action to activate it. | | ||
- | | StandbySpare | This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. | | ||
- | | Starting | This function or resource is starting. | | ||
- | | UnavailableOffline | This function or resource is present but cannot be used. | | ||
- | | Updating | The element is updating and may be unavailable or degraded. | | ||
- | |||
- | |||
- | ===== ZoneCollection ===== | ||
- | |||
- | A Collection of Zone resource instances. | ||
- | |||
- | ^ Property ^ Type ^ Permission ^ Description ^ | ||
- | | **Description** | string, null | read-write | Provides a description of this resource and is used for commonality | ||
- | | **Members** [ {} ] | array | read-only | Contains the members of this collection. | | ||
- | | **[email protected]** | string | read-write | | | ||
- | | **Name** | string | read-write | A friendly name for this line of service. | | ||
- | | **Oem** {} | object | read-write | This is the manufacturer/ | ||