Skip to content

network

Configuration for Setting of Management Network resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
nsm_id<String>Read-writeId of the nsm client corresponding to the tenant.
subnet_id<String>Read-writeId of the subnet of the network.
subnet_cidr<String>Read-writesubnet range.
segmentation_id<String>Read-writeSegmentation id of the network.
name<String>Read-writename of the network.
subnet_gateway_ip<String>Read-writeThe IP of the gateway of subnet.
network_type<String>Read-writenetwork type of the network.
network_id<String>Read-writeId of the network.

Operations

(click to see Properties)

ADD| DELETE| GET (ALL)| GET

Some options that you can use for each operations:

  • Getting warnings in response:NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations:NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add

URL: https://<MGMT-IP>/nitro/v1/config/network?onerror=<String_value>

HTTP Method: null

Request Payload:

{network: {
<b>"subnet_id":<String_value></b>,
"name":<String_value>,
"network_type":<String_value>,
"subnet_gateway_ip":<String_value>,
"network_id":<String_value>,
"nsm_id":<String_value>,
"subnet_cidr":<String_value>,
"segmentation_id":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "network":[{
"nsm_id":<String_value>,
"subnet_id":<String_value>,
"subnet_cidr":<String_value>,
"segmentation_id":<String_value>,
"name":<String_value>,
"subnet_gateway_ip":<String_value>,
"network_type":<String_value>,
"network_id":<String_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v1/config/network/network_id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/network

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "network":[{
"nsm_id":<String_value>,
"subnet_id":<String_value>,
"subnet_cidr":<String_value>,
"segmentation_id":<String_value>,
"name":<String_value>,
"subnet_gateway_ip":<String_value>,
"network_type":<String_value>,
"network_id":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/network/network_id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "network":[{
"nsm_id":<String_value>,
"subnet_id":<String_value>,
"subnet_cidr":<String_value>,
"segmentation_id":<String_value>,
"name":<String_value>,
"subnet_gateway_ip":<String_value>,
"network_type":<String_value>,
"network_id":<String_value>}]}