sdx_network_config
Configuration for SDX Network Configuration resource.
(click to see Operations)
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 |
| dns_v6 | <String> | Read-write | DNS Server IPv6 Address. |
| gateway_ipv6 | <String> | Read-write | Gateway IPv6 Address. |
| apply_svm_ip | <Boolean> | Read-write | Apply SVM IP. |
| host_ip_address | <String> | Read-write | Host IP Address. Minimum length = 1 Maximum length = 64 |
| xen_ip_address | <String> | Read-write | XenServer IP Address. Minimum length = 1 Maximum length = 64 |
| netmask | <String> | Read-write | Netmask. Minimum length = 1 Maximum length = 64 |
| network_interface | <String> | Read-write | Interface on which management needs to be enabled. Minimum length = 1 Maximum length = 15 |
| sync_to_vm | <Boolean> | Read-write | Set option to sync or not to sync with CB. |
| skip_reboot | <Boolean> | Read-write | Set CB 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)
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>.
get
URL: https://<MGMT-IP>/nitro/v1/config/sdx_network_config
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>,
"dns_v6":<String_value>,
"gateway_ipv6":<String_value>,
"apply_svm_ip":<Boolean_value>,
"host_ip_address":<String_value>,
"xen_ip_address":<String_value>,
"netmask":<String_value>,
"network_interface":<String_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/v1/config/sdx_network_config/
HTTP Method: null
Request Payload:
{sdx_network_config:{
<b>"gateway":<String_value></b>,
<b>"config_type":<Integer_value></b>,
<b>"xen_ip_address":<String_value></b>,
<b>"netmask":<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>,
"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>,
"host_ip_address":<String_value>,
"apply_svm_ip":<Boolean_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>,
"dns_v6":<String_value>,
"gateway_ipv6":<String_value>,
"apply_svm_ip":<Boolean_value>,
"host_ip_address":<String_value>,
"xen_ip_address":<String_value>,
"netmask":<String_value>,
"network_interface":<String_value>,
"sync_to_vm":<Boolean_value>,
"skip_reboot":<Boolean_value>,
"act_id":<String_value>,
"sync_operation":<Boolean_value>,
"init_status":<Integer_value>}]}