Hosts

post__hosts_create

Code samples

POST /hosts/create HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

POST /hosts/create

Create a host.

Body parameter

{
  "Name": "string",
  "Ip": "string",
  "Wwns": [
    "string"
  ],
  "Iqn": "string",
  "ChapSecret": "string",
  "Nqn": "string"
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	HostElementCreate	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

delete__hosts_delete

Code samples

DELETE /hosts/delete HTTP/1.1

Accept: application/json

DELETE /hosts/delete

Delete an host.

Parameters

Name	In	Type	Required	Description
name	query	string	false	The name of initiator to delete.
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

put__hosts_edit

Code samples

PUT /hosts/edit HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /hosts/edit

Reconfigure host.

Body parameter

{
  "Name": "string",
  "Ip": "string",
  "Wwns": [
    "string"
  ],
  "Iqn": "string",
  "ChapSecret": "string",
  "Nqn": "string"
}

Parameters

Name	In	Type	Required	Description
name	query	string	false	none
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	HostElementEdit	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

get__hosts_list

Code samples

GET /hosts/list HTTP/1.1

Accept: application/json

GET /hosts/list

List all available hosts.

Parameters

Name	In	Type	Required	Description
name	query	string	false	Limit results by name.
wwn	query	boolean	false	Show FC world wide names.
iqn	query	boolean	false	Show iSCSI qualified Name.
nqn	query	boolean	false	Show NVMe qualified names.
mapping	query	boolean	false	Show volumes that are mapped to those hosts.
ip	query	boolean	false	Show the IP of the hosts.

Example responses

200 Response

{
  "Data": [
    {
      "Name": "string",
      "Ip": "string",
      "Wwns": [
        "string"
      ],
      "Iqn": "string",
      "Nqn": "string",
      "ChapSecret": "string",
      "Mappings": [
        {
          "Application": "string",
          "Volume": "string",
          "LunId": 0
        }
      ],
      "Pairs": [
        {
          "RemoteSystem": "string",
          "RemoteHost": "string"
        }
      ]
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	HostElementApiResult
400	Bad Request	Bad Request	string

post__hosts_pair

Code samples

POST /hosts/pair HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

POST /hosts/pair

Pair a host to a host on a remote system.

Body parameter

{
  "Name": "string",
  "TargetSystem": "string",
  "TargetHost": "string"
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	HostsPair	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

delete__hosts_unpair

Code samples

DELETE /hosts/unpair HTTP/1.1

Accept: application/json

DELETE /hosts/unpair

Unpair a host from a host on a remote system.

Parameters

Name	In	Type	Required	Description
name	query	string	false	Local host.
targetSystem	query	string	false	Target system.
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

post__hosts_mappings_add

Code samples

POST /hosts/mappings/add HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

POST /hosts/mappings/add

Add mapping between a volume and an iSCSi/FC/NVMeOF host.

Body parameter

{
  "Application": "string",
  "Hosts": [
    "string"
  ],
  "Volumes": [
    "string"
  ],
  "LunIds": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	HostsMappingsAdd	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

delete__hosts_mappings_delete

Code samples

DELETE /hosts/mappings/delete HTTP/1.1

Accept: application/json

DELETE /hosts/mappings/delete

Delete mapping.

Parameters

Name	In	Type	Required	Description
application	query	string	false	The name of the application.
hosts	query	array[string]	false	The name of the hosts who will be unmapped from the volume.
volumes	query	array[string]	false	The name of the volumes you will remove the connectivity to. If not specified, all volumes within the application will be unmapped.
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

put__hosts_mappings_edit

Code samples

PUT /hosts/mappings/edit HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /hosts/mappings/edit

Add/Remove mapping between a volume and an iSCSi/FC/NVMeOF host.

Body parameter

{
  "Volumes": [
    "string"
  ],
  "LunIds": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
application	query	string	false	none
host	query	string	false	none
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	MappingElementHostPerspectiveEdit	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

get__hosts_mappings_list

Code samples

GET /hosts/mappings/list HTTP/1.1

Accept: application/json

GET /hosts/mappings/list

List mappings.

Parameters

Name	In	Type	Required	Description
application	query	string	false	Application.
host	query	string	false	Host name.

Example responses

200 Response

{
  "Data": [
    {
      "Application": "string",
      "Host": "string",
      "Volumes": [
        "string"
      ],
      "LunIds": [
        "string"
      ]
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	MappingElementHostPerspectiveApiResult
400	Bad Request	Bad Request	string

put__hosts_wwn_add

Code samples

PUT /hosts/wwn/add HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /hosts/wwn/add

Add wwns to an host.

Body parameter

{
  "Name": "string",
  "Wwns": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	HostsWwnAdd	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

delete__hosts_wwn_delete

Code samples

DELETE /hosts/wwn/delete HTTP/1.1

Accept: application/json

DELETE /hosts/wwn/delete

Delete a wwn address.

Parameters

Name	In	Type	Required	Description
name	query	string	false	The name of the initiator.
wwns	query	array[string]	false	List of FC world wide names to remove.
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string