Skip to main content

PUT /storage/{uuid}

Use this method to modify properties or perform management actions on a specific storage devices.

The request body differs depending on the action that you want to perform. You can use this PUT method to perform the following management actions.
Note
To power on or off canisters in the storage device, use PUT /storage/{uuid}/{controller}
If you specify this attribute, this method starts a job that runs in the background to perform the operation. The response header includes a URI in the form /tasks/{task_id} (for example, /tasks/12) that represents the job that is created to perform this request. You can use GET /tasks/{job_list} to monitor the status and progress of the job. If a job was not successfully started, refer to the response code and response body for details.
Attention
A successful response indicates that the request was successfully created and accepted by the management server. It does not indicate that the operation that is associated with the job was successful.

Authentication​

Authentication with username and password is required.

Request URL​

PUT https://{management_server_IP}/storage/{uuid}

where {uuid} is the UUID of the storage device to be retrieved. To obtain the node UUID, use the GET /storage method.

Query parameters​

AttributesRequired / OptionalDescription
synchronous={value}OptionalWhen modifying attributes, indicates when the job ID is returned
  • true. (default) Returns the job ID and job status after the job is complete.
  • false. Returns the job ID immediately. You can use GET /tasks/{job_list} to monitor the status and progress of the job.
Note
This query parameter applies only when one or more property parameters are specified in the request body.

Request body​

Table 1. Modify storage properties
AttributesRequired / OptionalTypeDescription
contactOptionalStringThe contact information
nameOptionalStringStorage-device name
userDescriptionOptionalStringThe storage-device description
The following example modifies the hostname, location, and contact information for the target storage device:
{
   "contact":"new contact",
   "name":"new name",
   "userDescription":"new userDescription"
}
Table 2. Collect and export service data
AttributesRequired / OptionalTypeDescription
sftpURIRequiredStringCollects and exports service data to the specified Secure FTP site.
The following example collects and exports an FFDC archive to sftp://SYSMGR:JhdJshf922nms@10.241.53.50.
{
   "sftpURI":"sftp://SYSMGR:JhdJshf922nms@10.241.53.50"
}
Table 3. Configure device authentication and access control.
Note
Only users with lxc-supervisor or lxc-security-admin authority can modify the access-control settings.
AttributesRequired / OptionalTypeDescription
securityDescriptorRequiredObjectInformation about the authentication enablement and support the associated stored credentials for a managed device.
 managedAuthEnabledOptionalBooleanIndicates whether the device uses managed authentication. This can be one of the following values.

  • true. The device uses managed authentication.

  • false. The device uses local authentication

 publicAccessOptionalBooleanIndicates whether the resource can be accessed by all role groups. This can be one of the following values.

  • true. The resource is can be access by all role group.

  • false. The resource is restricted to specific role groups.

 roleGroupsOptionalArray of stringsList of role groups that are permitted to view and manage this device.
 storedCredentialsRequired if managedAuthEnabled is set to trueObjectInformation about the stored credential that is associated with this device, if applicable.
  idRequired if managedAuthEnabled is set to trueStringID of the stored credential to associated with the device
The following example restricts access to the managed device to members of the specified role groups:
{
   "securityDescriptor" : {
      "publicAccess": false,
      "roleGroups": ["sales-os-admin","corp_fw_admin"]
   }
}

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
401UnauthorizedThe user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
403ForbiddenThe orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request.
404Not foundA specified resource cannot be found. A descriptive error message is returned in the response body.
409ConflictThere is a conflict with the current state of the resource. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

None