sdx_network_config

Last published : Oct 30, 2026
Configuration for SDX Network Configuration resource.

Properties

(click to see Operations )
Name Data Type Permissions Description
dns <String> Read-write DNS Server.
Minimum length = 1
Maximum length = 64
gateway <String> Read-write Gateway .
Minimum length = 1
Maximum length = 64
svm_ipv6_address <String> Read-write Management Service IPv6 Address.
additional_dns2 <String> Read-write Additional DNS Server. Can be IPv4 or IPv6.
additional_dns1 <String> Read-write Additional DNS Server. Can be IPv4 or IPv6.
config_type <Integer> Read-write Configuration Type. Values: 0: IPv4, 1: IPv6, 2: Both.
Maximum value =
svm_ip_address <String> Read-write Management Service IP Address.
Minimum length = 1
Maximum length = 64
gateway_ipv6 <String> Read-write Gateway IPv6 Address.
host_ip_address <String> Read-write Host IP Address.
Minimum length = 1
Maximum length = 64
netmask <String> Read-write Netmask.
Minimum length = 1
Maximum length = 64
xen_netmask <String> Read-write Xen Netmask.
Minimum length = 1
Maximum length = 64
xen_gateway <String> Read-write XEN Gateway.
Minimum length = 1
Maximum length = 64
xen_dns <String> Read-write Xen Netmask.
Minimum length = 1
Maximum length = 64
dns_v6 <String> Read-write DNS Server IPv6 Address.
xen_ip_address <String> Read-write XenServer IP Address.
Minimum length = 1
Maximum length = 64
apply_svm_ip <Boolean> Read-write Apply SVM IP.
network_interface <String> Read-write Interface on which management needs to be enabled.
Minimum length = 1
Maximum length = 15
is_xen_reachable <Boolean> Read-write Flag to set/unset external access to Xen.
sync_to_vm <Boolean> Read-write Set option to sync or not to sync with CB.
skip_reboot <Boolean> Read-write Set Citrix SD-WAN reboot required option during PUT.
init_status <Integer> Read-write System initialize status.
act_id <String> Read-only Activity Id.

Operations

(click to see Properties )
  • GET
  • UPDATE
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
The following parameters can be used in the nitro request : onerror <String_value>
Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE

get

URL: https://<MGMT-IP>/nitro/v2/config/sdx_network_config HTTPS Method: GET
Request Headers: Accept: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Headers:
Content-Type:application/json
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "sdx_network_config":[{
"dns":<String_value>,
"gateway":<String_value>,
"actual_network_interface":<String_value>,
"svm_ipv6_address":<String_value>,
"additional_dns2":<String_value>,
"additional_dns1":<String_value>,
"config_type":<Integer_value>,
"svm_ip_address":<String_value>,
"gateway_ipv6":<String_value>,
"host_ip_address":<String_value>,
"netmask":<String_value>,
"xen_netmask":<String_value>,
"xen_gateway":<String_value>,
"xen_dns":<String_value>,
"dns_v6":<String_value>,
"xen_ip_address":<String_value>,
"apply_svm_ip":<Boolean_value>,
"network_interface":<String_value>,
"is_xen_reachable":<Boolean_value>,
"sync_to_vm":<Boolean_value>,
"skip_reboot":<Boolean_value>,
"act_id":<String_value>,
"sync_operation":<Boolean_value>,
"init_status":<Integer_value>}]}

update

URL: https://<MGMT-IP>/nitro/v2/config/sdx_network_config/ HTTPS Method: PUT
Request Headers: Content-Type: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"sdx_network_config":{
<b>"gateway":<String_value></b>,
<b>"config_type":<Integer_value></b>,
<b>"netmask":<String_value></b>,
<b>"xen_netmask":<String_value></b>,
<b>"xen_gateway":<String_value></b>,
<b>"xen_ip_address":<String_value></b>,
<b>"network_interface":<String_value></b>,
"skip_reboot":<Boolean_value>,
"sync_to_vm":<Boolean_value>,
"dns":<String_value>,
"init_status":<Integer_value>,
"xen_dns":<String_value>,
"svm_ipv6_address":<String_value>,
"svm_ip_address":<String_value>,
"additional_dns1":<String_value>,
"additional_dns2":<String_value>,
"dns_v6":<String_value>,
"gateway_ipv6":<String_value>,
"apply_svm_ip":<Boolean_value>,
"host_ip_address":<String_value>,
"is_xen_reachable":<Boolean_value>}}
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "sdx_network_config":[{
"dns":<String_value>,
"gateway":<String_value>,
"actual_network_interface":<String_value>,
"svm_ipv6_address":<String_value>,
"additional_dns2":<String_value>,
"additional_dns1":<String_value>,
"config_type":<Integer_value>,
"svm_ip_address":<String_value>,
"gateway_ipv6":<String_value>,
"host_ip_address":<String_value>,
"netmask":<String_value>,
"xen_netmask":<String_value>,
"xen_gateway":<String_value>,
"xen_dns":<String_value>,
"dns_v6":<String_value>,
"xen_ip_address":<String_value>,
"apply_svm_ip":<Boolean_value>,
"network_interface":<String_value>,
"is_xen_reachable":<Boolean_value>,
"sync_to_vm":<Boolean_value>,
"skip_reboot":<Boolean_value>,
"act_id":<String_value>,
"sync_operation":<Boolean_value>,
"init_status":<Integer_value>}]}