iLO 4 REST API Data Model (HpiSCSISoftwareInitiator Resource Type) - shamimur/hp-proliant-sdk GitHub Wiki
/rest/v1/Systems/{item}/Bios/iScsi
/rest/v1/Systems/{item}/Bios/iScsi/Settings
See Resource Map for more details.
The schema definition of UEFI iSCSI Software Initiator boot configuration.
"HpiSCSISoftwareInitiator" defines the following properties:
This property is a member of HpiSCSISoftwareInitiator
This object represents the type property. It represents the schema used for the resource and indicates the version of the schema in the format <schema>.<majorversion>.<minorversion>.<errataversion>.
JSON type:
String
This property is a member of HpiSCSISoftwareInitiator
ETag of this resource after the settings have been applied.
JSON type:
String
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
This property is a member of HpiSCSISoftwareInitiator
Human-readable message.
JSON type:
String
This property is a member of HpiSCSISoftwareInitiator
Key for this message, which is used to look up the message in a message registry. The key is in the format <registry>.<majorver>.<minorver>:<messagekey>.
JSON type:
String
This property is a member of HpiSCSISoftwareInitiator
Instructions for resolving the issue that caused the error.
JSON type:
String
This property is a member of HpiSCSISoftwareInitiator
This is the severity of the errors.
JSON type:
String containing one of the following supported values:
This property is a member of [HpiSCSISoftwareInitiator](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiSCSISoftwareInitiator-Resource-Type)#hpiscsisoftwareinitiator-resource-type)
"OK" "Warning" "Critical"
Details about the results of applying the settings.
JSON type:
String containing one of the following supported values:
"SettingsApply"
This property is a member of [HpiSCSISoftwareInitiator](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiSCSISoftwareInitiator-Resource-Type)#hpiscsisoftwareinitiator-resource-type)
| GET | Rendered if supported by the implementation or omitted if not. |
Time at which the settings were applied.
JSON type:
String
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
Identifies this iSCSI UEFI boot option within the server.
JSON type:
String
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
Standardized text representation of the UEFI device path for this boot option, in UTF-8 format.
JSON type:
String
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
The iSCSI connection authentication method.
JSON type:
String containing one of the following supported values:
"None"
"CHAP"
This property is a member of [HpiSCSISoftwareInitiator](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiSCSISoftwareInitiator-Resource-Type)#hpiscsisoftwareinitiator-resource-type)
| GET | Rendered if supported by the implementation or omitted if not. |
Uniquely identifies this iSCSI boot attempt within iSCSIBootSources array. If set to zero, all other properties in the boot option object are ignored (which will delete an existing boot attempt).
JSON type:
Integer
from 0 to 4.
Human readable descriptive name for this iSCSI boot attempt configuration
JSON type:
String
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
Enables or Disables iSCSI Boot for a selected iSCSI boot attempt.
JSON type:
String containing one of the following supported values:
"Disabled"
"Enabled"
"EnabledMpio"
This property is a member of [HpiSCSISoftwareInitiator](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiSCSISoftwareInitiator-Resource-Type)#hpiscsisoftwareinitiator-resource-type)
| GET | Rendered if supported by the implementation or omitted if not. |
The iSCSI boot target Logical Unit Number (LUN), if not obtained from DHCP. This value must follow the SAM-2 spec. E.g. 0001-1234-5678-9ABC. If the digit number is less then 5 characters, a dash character is not required. E.g. 0001. If the lun number is 12345, input 1234-5
JSON type:
String
The password needed for CHAP authentication. This is applicable only when the Authentication Method is set to CHAP, and the CHAP Type is set to Mutual.
JSON type:
String
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
The CHAP authentication type. This is applicable only when the Authentication Method is set to CHAP.
JSON type:
String containing one of the following supported values:
"OneWay"
"Mutual"
This property is a member of [HpiSCSISoftwareInitiator](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiSCSISoftwareInitiator-Resource-Type)#hpiscsisoftwareinitiator-resource-type)
| GET | Rendered if supported by the implementation or omitted if not. |
The password needed for CHAP authentication. This is applicable only when the Authentication Method is set to CHAP.
JSON type:
String
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
The number of times to retry the iSCSI connection. Zero means no retries.
JSON type:
Integer
from 0 to 16.
The iSCSI connection timeout value in milliseconds.
JSON type:
Integer
from 100 to 20000.
The gateway address of the iSCSI Initiator, if not configured via DHCP. The address must be an IPv4 or IPv6 address, depending on the IP Address Type.
JSON type:
String
If enabled, the iSCSI Initiator information is configured from DHCP. Otherwise, the iSCSI initiator information must be statically configured.
JSON type:
Boolean ('true' or 'false')
The IP Address of the iSCSI Initiator, if not configured via DHCP. The Initiator IP Address is always auto-assigned if IP address type is IPv6. The address must be an IPv4 or IPv6 address, depending on the IP Address Type.
JSON type:
String
The subnet mask of the iSCSI Initiator, if not configured via DHCP. The address must be an IPv4.
JSON type:
String
The iSCSI IP Address type. If set to Auto, IPv4 will be attempted first, followed by IPv6.
JSON type:
String containing one of the following supported values:
"IPv4"
"IPv6"
"Auto"
This property is a member of [HpiSCSISoftwareInitiator](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiSCSISoftwareInitiator-Resource-Type)#hpiscsisoftwareinitiator-resource-type)
| GET | Rendered if supported by the implementation or omitted if not. |
A BIOS Attribute that describes this selected NIC instance. This must match one of the possible values listed in the iSCSINicSources array.
JSON type:
String
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
The password needed for reverse CHAP authentication (from the target to the initiator). This is applicable only when the Authentication Method is set to CHAP, and the CHAP Type is set to Mutual.
JSON type:
String
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
User Name for reverse CHAP authentication (from the target to the initiator). This is applicable only when the Authentication Method is set to CHAP, and the CHAP Type is set to Mutual.
JSON type:
String
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
This property is a member of [HpiSCSISoftwareInitiator](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(HpiSCSISoftwareInitiator-Resource-Type)#hpiscsisoftwareinitiator-resource-type)
If enabled, the iSCSI target information are configured from DHCP. Otherwise, the iSCSI target information must be statically configured.
JSON type:
Boolean ('true' or 'false')
The IP Address of the iSCSI Target, if not obtained from DHCP. The address must be an IPv4 or IPv6 address, depending on the IP Address Type.
JSON type:
String
The worldwide unique iSCSI Qualified Name (IQN) of this iSCSI target. Only the IQN format is accepted. EUI format is not supported (for example, 'iqn.1991-05.com.microsoft:iscsitarget-iscsidisk-target').
JSON type:
String
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
The iSCSI Target TCP Port number, if not obtained from DHCP.
JSON type:
Integer
from 0 to 65535.
The worldwide unique iSCSI Qualified Name (IQN) of this iSCSI Initiator. Only IQN format is accepted. EUI format is not supported (for example, 'iqn.1986-03.com.hp:init.sn-123456').
JSON type:
String