Modifying a Host
Modify a host using the HTTP POST method. Use the following URI:
https://<storage system>:8080/api/v1/hosts/<host name>
NOTE: Any user with Super or Edit role, or any role granted the host_set right, can perform
this operation. Access to all domains is required for this operation.
Table 42 (page 54) shows the members that the message body can include to make a
host-modification request.
Table 42 Message Body JSON Objects for Host Modification Request
DescriptionIgnored ValuesAPI TypeJSON TypeMember
New name of the hostNullname31stringnewName
(Since WSAPI 1.2)
If adding, adds the
WWN or iSCSI name
to the existing host.
Zero and negative
values
hostEditOperation
Enum
numberpathOperation
If removing, removes
the WWN or iSCSI
names from the
existing host.
(Since WSAPI 1.2)
One or more WWN
to set for the host.
NullWWNarray of stringFCWWNs
(Since WSAPI 1.2)
One or more iSCSI
names to set for the
host.
Nullname223array of stringiSCSINames
(Since WSAPI 1.2)
If True, Remove
WWN(s) or iSCSI(s)
NoneBooleanforcePathRemoval
even if there are
VLUNs exported to the
host.
(Since WSAPI 1.2)
The ID of the persona
to modify the host’s
persona to.
Zero and negative
values
hostPersona Enumnumberpersona
(Since WSAPI 1.2)
The description of the
host.
Nulldescriptors objectHostDescriptorsdescriptors
(Since WSAPI 1.2)
Add or remove.Zero and negative
values
hostEditOperation
Enum
numberchapOperation
(Since WSAPI 1.2)
Initiator or target.Zero and negative
values
hostChapOperationModeEnumnumberchapOperationMode
(Since WSAPI 1.2)
The chap name.NullName223stringchapName
(Since WSAPI 1.2)
54 Working with Hosts