REST endpoints: Resources: network

These endpoints mirror the CLI commands described in N, 0Network. Each endpoint runs the CLI command named under its heading, so the behavior, defaults, and restrictions are the same; this page lists how to call it over REST.

Conventions that apply to every endpoint (request format, the async and outputType parameters, and the response envelope) are in Requests and responses. In the tables below, Required is Yes when the parameter must always be supplied, No when it is optional, and Depends when it is required only in some combinations (for example, either an application and volume, or a consistency group ID); the CLI chapter for the same command explains the combinations.

`PUT /resources/network/iscsi/add`

Enable iSCSI traffic on specific IPs.

CLI command: resources network iscsi add

Body fields (JSON)

Name	Type	Required	Description
`Ips`	array of string	Yes	The IPs to enable iSCSI traffic on.

`GET /resources/network/iscsi/list`

List iSCSI IPs.

CLI command: resources network iscsi list

This endpoint takes no parameters.

Response: a list of NodeToIpElements objects in Result.NodeToIpElements, each with: NodeName (string), Ips (array of IPElement).

`PUT /resources/network/iscsi/remove`

Disable iSCSI traffic on specific IPs.

CLI command: resources network iscsi remove

Body fields (JSON)

Name	Type	Required	Description
`Ips`	array of string	Yes	The IPs to disable iSCSI traffic on.
`Force`	boolean	No	Skip the confirmation prompt.

`GET /resources/network/list`

List all available network interface cards.

CLI command: resources network list

Query parameters

Name	Type	Required	Description
`errors`	boolean	No	Show only components with errors.
`details`	boolean	No	Show advanced information.
`ids`	array of integer	No	Filter by resource ID.

Response: a list of NodeElement objects in Result.

`PUT /resources/network/nvmeof/edit`

Enable or disable NVMeOF traffic on an IP.

CLI command: resources network nvmeof edit

Query parameters

Name	Type	Required	Description
`ip`	string	Yes	The IP address to enable/disable NVMeOF traffic on.

Body fields (JSON)

Name	Type	Required	Description
`Port`	integer	Yes	The port to enable/disable NVMeOF traffic on.
`Enable`	boolean	Depends	Enable NVMeOF traffic. In REST one field covers a pair of CLI flags: `true` applies `--enable`, `false` applies `--disable`, and omitting the field applies neither.
`Rdma`	boolean	Depends	Use RDMA as the transport for NVMeOF traffic.
`Tcp`	boolean	Depends	Use TCP as the transport for NVMeOF traffic.

`GET /resources/network/nvmeof/list`

List NVMeOF IPs.

CLI command: resources network nvmeof list

This endpoint takes no parameters.

Response: a list of NodeToIpElements objects in Result.NodeToIpElements, each with: NodeName (string), Ips (array of IPElement).

`GET /resources/network/ping`

Run a ping test.

CLI command: resources network ping

Query parameters

Name	Type	Required	Description
`ip`	string	Yes	The IP address to ping.

Response: a list of NodeElement objects in Result.Nodes.