5 Working with Hosts
This chapter describes how to manage hosts. The sections apply to creation, modification, removal,
and query operations on hosts.
Creating a Host
Create a host using the HTTP POST method. Use the following URI:
https://<storage system>:8080/api/v1/hosts
Table 40 (page 52)
NOTE:
Any user with Super or Edit role, or any role granted the host_create right, can perform
this operation. Access to all domains is required for this operation.
Table 40 Message Body JSON Objects for Host Creation
Member
name
persona
FCWWNs
iSCSINames
domain
forceTearDown
descriptors
When creating a host, the name is required. Other members are optional.
Host Creation Success
Upon successful creation of the host, the location portion of the response header contains the URI
for the newly created host in the following format:
52
Working with Hosts
shows the members that the message body can include.
JSON Type
Value Range
string
name31
number
HostPersona Enum
array of string
WWN
array of string
name223
string
name31
Boolean
HostDescriptors
descriptors object
Mandatory
Ignored Values
Yes
Null
No
Zero and negative
values
No
Null
No
Null
No
Null
No
None
No
Null
Description
Specifies the name
of the host.
(Since WSAPI 1.2)
ID of the persona
to assign to the
host.
(Since WSAPI 1.2)
One or more
WWN to set for
the host.
(Since WSAPI 1.2)
One or more iSCSI
names to set for
the host.
(Since WSAPI 1.2)
Create the host in
the specified
domain, or default
domain if
unspecified.
(Since WSAPI 1.2)
If True, force to
tear down
low-priority VLUN
exports.
(Since WSAPI 1.2)
See
HostDescriptors.
(Since WSAPI 1.2)