put_storage

(PUT)/storage

Description

Modifies the specified storage. There is one special case involving "internal" storage of type "stateless", the user can specify one ore more disks to attach, and internally, a logical volume is expanded to extend across these devices. PUT storage cannot add devices to any other type of existing storage. Type or usage of an existing storage cannot be changed.

Request

Syntax

PUT /api/storage/{id}/?sid={sid}
Host: <server host name>
Accept: application/json
AuthToken: <authentication token returned from authenticate>

Parameters

Index	Value	Type	Required
name	storage name	string	optional
max_concurrent_backups	the maximum number of concurrent backups for this device	int	optional

• | only applies to backups or stateless storage | is_default | the default storage for backup jobs | boolean | optional
• | can only be true for a single backups storage per appliance | properties | properties of the storage being modified | array | optional

iSCSI properties (if type = "iscsi")

Index	Value	Type	Required
hostname	IP address or hostname	string	optional
port	port on which listening	long	optional
target	fully-qualified iSCSI target name	string	optional
lun	LUN (logical unit number)	long	optional
username	Name of the SAN user	string	optional
password	Password of the SAN user	string	optional

NAS Properties (if type = "nas")

Index	Value	Type	Required
hostname	IP address or hostname	string	optional
share_name	port on which listening	long	optional
protocol	mounting protocol, "nfs", "cifs", or "cloud"	string	optional
username	NAS username	string	optional
password	Password to the NAS	string	optional
max_size	Size in GB which user wants to use for backup	string	(required only for usage = "backup") NOT required for other usages

FC Properties (if type = "fc")

Index	Value	Type	Required
wwpn	World-wide port number	string	optional
model	target card model/vendor	string	optional
lun	LUN (logical unit number)	long	optional
vendor	appliance vendor name	string	optional
username	Name of the FC user	string	optional
password	Password of the FC user	string	optional

Attached Disk properties

Index	Value	Type	Required
internal_name	name of disk(s) to be added to this storage	string	optional

• | if "internal" storage, the LVM is expanded across these disks. |
• | currently only one disk is supported at a time. In the future, will allow for comma-separated list of devices. |

Response

200 success

Examples

Sample Request

PUT /api/storage/23/?sid=1
Host: <server host name>
Accept: application/json
AuthToken: 8a00sjerhterqerjlqkjlk443l4j56869h4f_)(fjdkasHHHHHkdal324

    {
        "properties": {
           "internal_name": "/dev/sdc"
        },
        "type": 5
    }

Sample Response

Successful modification of storage, showing current status.

HTTP Status: 200 (OK)

Sample Response

{
    "result": [
        {
            "code": "0",
            "status": "pending"
        }
    ]
}

Failed storage update will return HTTP Status 500 with a result object with an error message and KB link.