Storage node management
POST /v1/objects/storage/actions/stop-removing-storage-nodes/invoke
Required Role: Service
Requests storage node removal to stop. When this API is executed, the job that requests storage node removal is performed. When the stop request is completed, the state of this job becomes "Succeeded", and the state of the storage node removal job to be stopped becomes "Stopping". Depending on the timing when the API is executed, it might take time until the state of the target storage node removal job becomes "Stopping".
When the target storage node removal job is stopped successfully, the state of the job becomes "Stopped". Depending on the timing when the API is executed, the target storage node removal job might not be stopped and might be executed to the end. In this case, the state of the target storage node removal job does not become "Stopped", and instead becomes "Succeeded" if storage node removal is successful, or "Failed" if removal did not succeed.
You can verify the storage node removal job to be stopped in attribute "affectedResources" in the response data for the API.
None
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X POST -H "Content-Length: 0" https://192.168.1.100/ConfigurationManager/simple/v1/objects/storage/actions/stop-removing-storage-nodes/invoke
Uses default content-types: application/json
Indicates that an asynchronous process request was accepted.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the Content-Length header must be specified. It is returned when the request body was not specified and "Content-Length: 0" was not specified as the header parameter.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
GET /v1/objects/storage-nodes
Required Role: Security, Storage, Monitor, Service, Audit, or Resource
Obtains a list of information about storage nodes.
|
Name |
Description |
Type |
Data type |
|
faultDomainId |
Fault domain ID. |
query |
string (uuid) |
|
name |
Storage node name (partial match). |
query |
string |
|
clusterRole |
The role of a storage node in a storage cluster. |
query |
string , x ∈ { "Master" , "Worker" } |
|
protectionDomainId |
Protection domain ID. |
query |
string (uuid) |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -i -u admin:password -X GET https://192.168.1.100/ConfigurationManager/simple/v1/objects/storage-nodes
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: private, no-store, no-cache, must-revalidate
Content-Security-Policy: default-src 'self'; style-src 'self' 'unsafe-inline';
Access-Control-Allow-Methods: GET, POST, DELETE, PATCH
Access-Control-Allow-Headers: Content-Type
Content-Type: application/json
Content-Length: 4312
Date: Fri, 30 Jul 2021 07:55:59 GMT
{"data":[{"id":"44f1d113-405e-448f-ad77-fd5554971c36","biosUuid":"423db8d0-c54b-4d81-eac9-fccc6f05a965","protectionDomainId":"0778a123-42e5-43ff-8fbc-c8580b79f2cf","faultSetId":"4f538215-e568-4cc0-8bcc-16bc0b71b386","faultSetName":"SC01-PD01-FS01","name":"PTFM-ENV21-SN04","clusterRole":"Worker","storageNodeAttributes":[],"statusSummary":"Normal","status":"Ready","driveDataRelocationStatus":"Stopped","controlPortIpv4Address":"192.168.1.214","internodePortIpv4Address":"192.168.73.214","softwareVersion":"01.10.02.00","modelName":"HA8000V/DL360 Gen10","serialNumber":"SGH829X4XQ","memory":131072,"insufficientResourcesForRebuildCapacity":{"capacityOfDrive":0,"numberOfDrives":0},"rebuildableResources":{"numberOfDrives":1}},{"id":"8fdbc008-ec6c-42b3-b930-146c94c5cef9","biosUuid":"423d1d1c-e470-c10c-c1e2-0b6ab8f8b19e","protectionDomainId":"0778a123-42e5-43ff-8fbc-c8580b79f2cf","faultSetId":"4f538215-e568-4cc0-8bcc-16bc0b71b386","faultSetName":"SC01-PD01-FS01","name":"PTFM-ENV21-SN06","clusterRole":"Worker","storageNodeAttributes":[],"statusSummary":"Normal","status":"Ready","driveDataRelocationStatus":"Stopped","controlPortIpv4Address":"192.168.1.216","internodePortIpv4Address":"192.168.73.216","softwareVersion":"01.10.02.00","modelName":"HA8000V/DL360 Gen10","serialNumber":"SGH829X4Y4","memory":131072,"insufficientResourcesForRebuildCapacity":{"capacityOfDrive":0,"numberOfDrives":0},"rebuildableResources":{"numberOfDrives":1}},{"id":"9d36c162-e379-4c85-bcc2-ccf98fe774a6","biosUuid":"423d3f78-56e6-194e-0d0f-2f0507902b53","protectionDomainId":"0778a123-42e5-43ff-8fbc-c8580b79f2cf","faultSetId":"4f538215-e568-4cc0-8bcc-16bc0b71b386","faultSetName":"SC01-PD01-FS01","name":"PTFM-ENV21-SN05","clusterRole":"Worker","storageNodeAttributes":[],"statusSummary":"Normal","status":"Ready","driveDataRelocationStatus":"Stopped","controlPortIpv4Address":"192.168.1.215","internodePortIpv4Address":"192.168.73.215","softwareVersion":"01.10.02.00","modelName":"HA8000V/DL360 Gen10","serialNumber":"SGH829X4XN","memory":131072,"insufficientResourcesForRebuildCapacity":{"capacityOfDrive":0,"numberOfDrives":0},"rebuildableResources":{"numberOfDrives":1}},{"id":"9f29d742-9a75-4cef-9539-35b3e76c8a20","biosUuid":"423d1534-ee45-f92d-f3b0-662595e47bd7","protectionDomainId":"0778a123-42e5-43ff-8fbc-c8580b79f2cf","faultSetId":"4f538215-e568-4cc0-8bcc-16bc0b71b386","faultSetName":"SC01-PD01-FS01","name":"PTFM-ENV21-SN01","clusterRole":"Master","storageNodeAttributes":[],"statusSummary":"Normal","status":"Ready","driveDataRelocationStatus":"Stopped","controlPortIpv4Address":"192.168.1.211","internodePortIpv4Address":"192.168.73.211","softwareVersion":"01.10.02.00","modelName":"HA8000V/DL360 Gen10","serialNumber":"SGH829X6MJ","memory":131072,"insufficientResourcesForRebuildCapacity":{"capacityOfDrive":0,"numberOfDrives":0},"rebuildableResources":{"numberOfDrives":1}},{"id":"a5b19d19-ca5d-4d19-988d-d625850c85de","biosUuid":"423d0e42-fcec-5725-a6f9-165cc98907da","protectionDomainId":"0778a123-42e5-43ff-8fbc-c8580b79f2cf","faultSetId":"4f538215-e568-4cc0-8bcc-16bc0b71b386","faultSetName":"SC01-PD01-FS01","name":"PTFM-ENV21-SN03","clusterRole":"Master","storageNodeAttributes":[],"statusSummary":"Normal","status":"Ready","driveDataRelocationStatus":"Stopped","controlPortIpv4Address":"192.168.1.213","internodePortIpv4Address":"192.168.73.213","softwareVersion":"01.10.02.00","modelName":"HA8000V/DL360 Gen10","serialNumber":"SGH829X4XC","memory":131072,"insufficientResourcesForRebuildCapacity":{"capacityOfDrive":0,"numberOfDrives":0},"rebuildableResources":{"numberOfDrives":1}},{"id":"dd5ed12b-cf39-47da-9a30-5ba53404050e","biosUuid":"423d271b-2866-16ca-62f5-578f7f8d9b30","protectionDomainId":"0778a123-42e5-43ff-8fbc-c8580b79f2cf","faultSetId":"4f538215-e568-4cc0-8bcc-16bc0b71b386","faultSetName":"SC01-PD01-FS01","name":"PTFM-ENV21-SN02","clusterRole":"Master","storageNodeAttributes":[],"statusSummary":"Normal","status":"Ready","driveDataRelocationStatus":"Stopped","controlPortIpv4Address":"192.168.1.212","internodePortIpv4Address":"192.168.73.212","softwareVersion":"01.10.02.00","modelName":"HA8000V/DL360 Gen10","serialNumber":"SGH829X4X9","memory":131072,"insufficientResourcesForRebuildCapacity":{"capacityOfDrive":0,"numberOfDrives":0},"rebuildableResources":{"numberOfDrives":1}}]}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when no information is obtained.
DESCRIPTION
A list of storage node information.
PROPERTIES
data: object[]
ITEMS
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
DELETE /v1/objects/storage-nodes/<id>
Required Role: Service
Deletes a storage node.
|
Name |
Description |
Type |
Data type |
|
id |
Storage node ID. |
path |
string (uuid) required |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -X DELETE -u admin:password https://192.168.1.100/ConfigurationManager/simple/v1/objects/storage-nodes/8fdbc008-ec6c-42b3-b930-146c94c5cef9
Uses default content-types: application/json
Indicates that an asynchronous process request was accepted.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that the resource specified by the URL was not found, or you are not authorized to see the resource.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
GET /v1/objects/storage-nodes/<id>
Required Role: Security, Storage, Monitor, Service, Audit, or Resource
Obtains the information about storage nodes.
|
Name |
Description |
Type |
Data type |
|
id |
Storage node ID. |
path |
string (uuid) required |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -i -u admin:password -X GET https://192.168.1.100/ConfigurationManager/simple/v1/objects/storage-nodes/dd5ed12b-cf39-47da-9a30-5ba53404050e
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: private, no-store, no-cache, must-revalidate
Content-Security-Policy: default-src 'self'; style-src 'self' 'unsafe-inline';
Access-Control-Allow-Methods: GET, POST, DELETE, PATCH
Access-Control-Allow-Headers: Content-Type
Content-Type: application/json
Content-Length: 716
Date: Fri, 30 Jul 2021 07:56:39 GMT
{"id":"dd5ed12b-cf39-47da-9a30-5ba53404050e","biosUuid":"423d271b-2866-16ca-62f5-578f7f8d9b30","protectionDomainId":"0778a123-42e5-43ff-8fbc-c8580b79f2cf","faultSetId":"4f538215-e568-4cc0-8bcc-16bc0b71b386","faultSetName":"SC01-PD01-FS01","name":"PTFM-ENV21-SN02","clusterRole":"Master","storageNodeAttributes":[],"statusSummary":"Normal","status":"Ready","driveDataRelocationStatus":"Stopped","controlPortIpv4Address":"192.168.1.212","internodePortIpv4Address":"192.168.73.212","softwareVersion":"01.10.02.00","modelName":"HA8000V/DL360 Gen10","serialNumber":"SGH829X4X9","memory":131072,"insufficientResourcesForRebuildCapacity":{"capacityOfDrive":0,"numberOfDrives":0},"rebuildableResources":{"numberOfDrives":1}}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when the deletion request was executed successfully.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that the resource specified by the URL was not found, or you are not authorized to see the resource.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
POST /v1/objects/storage-nodes/<id>/actions/block-for-maintenance/invoke
Required Role: Service
Places the storage node into the blockade state for maintenance operation.
|
Name |
Description |
Type |
Data type |
|
id |
Storage node ID. |
path |
string (uuid) required |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X POST -H "Content-Length: 0" https://192.168.1.100/ConfigurationManager/simple/v1/objects/storage-nodes/9014efa1-3a11-4687-8be4-2d28d43200c9/actions/block-for-maintenance/invoke
Uses default content-types: application/json
Indicates that an asynchronous process request was accepted.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that the resource specified by the URL was not found, or you are not authorized to see the resource.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the Content-Length header must be specified. It is returned when the request body was not specified and "Content-Length: 0" was not specified as the header parameter.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
POST /v1/objects/storage-nodes/<id>/actions/recover/invoke
Required Role: Service
Restores the storage node from the blockade state caused by maintenance operation.
|
Name |
Description |
Type |
Data type |
|
id |
Storage node ID. |
path |
string (uuid) required |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X POST -H "Content-Length: 0" https://192.168.1.100/ConfigurationManager/simple/v1/objects/storage-nodes/7ba34e51-327e-4f28-b56b-1e9930cc481e/actions/recover/invoke
Uses default content-types: application/json
Indicates that an asynchronous process request was accepted.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that the resource specified by the URL was not found, or you are not authorized to see the resource.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the Content-Length header must be specified. It is returned when the request body was not specified and "Content-Length: 0" was not specified as the header parameter.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
POST /v1/objects/storage-nodes/<id>/actions/replace/invoke (Bare metal)
Required Role: Service
Replaces a storage node.
|
Name |
Description |
Type |
Data type |
|
id |
Storage node ID. |
path |
string (uuid) required |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X POST -H "Content-Type: application/json" -H "Expect:" -d '{"setupUserPassword": "hitachino1"}' https://192.168.1.100/ConfigurationManager/simple/v1/objects/storage-nodes/021b437b-ce44-4a3c-b9d6-ef3ce9e0e406/actions/replace/invoke
The following shows an example using a json body.
curl -u admin:password -i -X POST -H "Content-Type: application/json" -H "Expect:" -d @example.json https://192.168.1.100/ConfigurationManager/simple/v1/objects/storage-nodes/021b437b-ce44-4a3c-b9d6-ef3ce9e0e406/actions/replace/invoke
example.json is defined as follows:
{
"setupUserPassword":"hitachino1"
}
Uses default content-types: application/json
Indicates that an asynchronous process request was accepted.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that the resource specified by the URL was not found, or you are not authorized to see the resource.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the Content-Length header must be specified. It is returned when the request body was not specified and "Content-Length: 0" was not specified as the header parameter.
Indicates that the conditions for executing the API are not met.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
POST /v1/objects/storage-nodes (Bare metal)
Required Role: Service
Adds a storage node.
You can run this API only for the cluster master node (primary).
If you run this API for a node other than the cluster master node (primary), HTTP status code 412 (Precondition Failed) is returned.
multipart/form-data
|
Name |
Description |
Type |
Data type |
|
configurationFile |
The configuration definition file to be transferred to the storage cluster. |
formData |
file required |
|
setupUserPassword |
Setup user password. |
formData |
string (1 to 256 chars) , must match /^[\-A-Za-z0-9!#\$%&"'\(\)\*\+,\.\/:;<>=\?@\[\]\\\^_`\{\}\|~]{1,256}$/ required |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X POST -H "Content-Type: multipart/form-data" -H "Expect: " -F "setupUserPassword=hitachino1" -F configurationFile=@SystemConfigurationFile.csv https://192.168.1.100/ConfigurationManager/simple/v1/objects/storage-nodes
Uses default content-types: application/json
Indicates that an asynchronous process request was accepted.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the Content-Length header must be specified. It is returned when the request body was not specified and "Content-Length: 0" was not specified as the header parameter.
Indicates that the conditions for executing the API are not met.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
GET /v1/objects/storage-node-bmc-access-settings (Bare metal)
Required Role: Service
Obtains a list of BMC connection information about storage nodes.
None
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -i -u admin:password -X GET https://192.168.1.100/ConfigurationManager/simple/v1/objects/storage-node-bmc-access-settings
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: private, no-store, no-cache, must-revalidate
Content-Security-Policy: default-src 'self'; style-src 'self' 'unsafe-inline';
Access-Control-Allow-Methods: GET, POST, DELETE, PATCH
Access-Control-Allow-Headers: Content-Type
Content-Type: application/json
Content-Length: 410
Date: Fri, 07 Oct 2022 11:55:19 GMT
{"data":[{"id":"6ca229e4-4a60-45a3-aaa4-fa2ae5ed71cf","bmcName":"10.164.118.96","bmcUser":"administrator@local,10.164.118.96-ptfm-endo_SN03"},{"id":"9323fe40-5cad-4cf6-b8a5-fdf6a0cb69b9","bmcName":"10.164.118.96","bmcUser":"administrator@local,10.164.118.96-ptfm-endo_SN02"},{"id":"ad4f2244-0fac-45c6-af8e-15f2df52984f","bmcName":"10.164.118.96","bmcUser":"administrator@local,10.164.118.96-ptfm-endo_SN01"}]}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when the deletion request was executed successfully.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the conditions for executing the API are not met.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
GET /v1/objects/storage-node-bmc-access-settings/<id> (Bare metal)
Required Role: Service
Obtains the BMC connection information about a storage node.
|
Name |
Description |
Type |
Data type |
|
id |
Storage node ID. |
path |
string (uuid) required |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -i -u admin:password -X GET https://192.168.1.100/ConfigurationManager/simple/v1/objects/storage-node-bmc-access-settings/ad4f2244-0fac-45c6-af8e-15f2df52984f
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: private, no-store, no-cache, must-revalidate
Content-Security-Policy: default-src 'self'; style-src 'self' 'unsafe-inline';
Access-Control-Allow-Methods: GET, POST, DELETE, PATCH
Access-Control-Allow-Headers: Content-Type
Content-Type: application/json
Content-Length: 133
Date: Fri, 07 Oct 2022 11:56:25 GMT
{"id":"ad4f2244-0fac-45c6-af8e-15f2df52984f","bmcName":"10.164.118.96","bmcUser":"administrator@local,10.164.118.96-ptfm-endo_SN01"}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when the deletion request was executed successfully.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the conditions for executing the API are not met.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
PATCH /v1/objects/storage-node-bmc-access-settings/<id> (Bare metal)
Required Role: Service
Allows you to edit BMC connection information about a storage node.
Uses default content-types: application/json
|
Name |
Description |
Type |
Data type |
|
id |
Storage node ID. |
path |
string (uuid) required |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X PATCH -H "Content-Type: application/json" -H "Expect:" -d '{ "bmcName":"10.1.12.123", "bmcUser":"username", "bmcPassword":"password" }' https://192.168.1.100/ConfigurationManager/simple/v1/objects/storage-node-bmc-access-settings/ad4f2244-0fac-45c6-af8e-15f2df52984f
The following shows an example using a json body.
curl -u admin:password -i -X PATCH -H "Content-Type: application/json" -H "Expect:" -d @example.json https://192.168.1.100/ConfigurationManager/simple/v1/objects/storage-node-bmc-access-settings/ad4f2244-0fac-45c6-af8e-15f2df52984f
example.json is defined as follows:
{
"bmcName":"10.1.12.123",
"bmcUser":"username",
"bmcPassword":"password"
}
Uses default content-types: application/json
Indicates that an asynchronous process request was accepted.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the conditions for executing the API are not met.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication