network_interface
Configuration for VM device network interface resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| is_mgmt_ifc | <Boolean> | Read-write | True if this is the management interface. |
| name_server | <String> | Read-write | Name Server. Minimum length = 1 Maximum length = 64 |
| vrid_list_ipv6 | <String> | Read-write | VRID List for Interface/Channel for IPV6 VMAC Generation. |
| gateway | <String> | Read-write | gateway. Minimum length = 1 Maximum length = 64 |
| parent_id | <String> | Read-write | . |
| vrid_list_ipv4 | <String> | Read-write | VRID List for Interface/Channel for IPV4 VMAC Generation. |
| is_member_ifc | <Boolean> | Read-write | True if this interface is member of a channel. |
| mac_address | <String> | Read-write | Mac Address. Minimum length = 1 Maximum length = 32 |
| l2_enabled | <Boolean> | Read-write | L2 mode status of Interface. |
| id | <String> | Read-write | . |
| ip_address | <String> | Read-write | IP Address. Minimum length = 1 Maximum length = 64 |
| netmask | <String> | Read-write | netmask. Minimum length = 1 Maximum length = 64 |
| port_name | <String> | Read-write | Port name of the interface on the host machine. Minimum length = 1 Maximum length = 128 |
| parent_name | <String> | Read-write | . |
| mac_mode | <String> | Read-write | Mac Mode, default for XenServer generated, generated for SVM generated, custom for User assigned. Minimum length = 1 Maximum length = 255 |
| managed_device_id | <String> | Read-write | managed_device_id. |
| vlan | <Integer> | Read-write | This property is not supported.Use vlan_whitelist for vlan configuration;ltbr;gtVLAN Id. Maximum value = |
| receiveuntagged | <Boolean> | Read-write | Receive Untagged Packets on Interface/Channel. |
| sdx_formation_network_id | <String> | Read-write | This property is deprecated;ltbr;gtSDX Formation Network Id of which this Interface is part of. Minimum length = 1 Maximum length = 128 |
| vlan_whitelist | <String> | Read-write | VLAN Whitelist for Interface/Channel on VM Instance. |
| interface_name | <String> | Read-write | Name of this interface. |
| vrid_list_ipv4_array | <String[]> | Read-write | VRID List for Interface for IPV4 VMAC Generation. |
| vrid_list_ipv6_array | <String[]> | Read-write | VRID List for Interface for IPV6 VMAC Generation. |
| vlan_whitelist_array | <String[]> | Read-write | VLAN Whitelist for Interface on VM Instance. |
| is_vlan_applied | <Boolean> | Read-write | Is VLAN added on NetworkInterface of VM Instance. |
| device_channel_name | <String> | Read-only | LA Name on the actual VM. |
| xen_vf_index | <Integer> | Read-only | Index given by Xen when assigning free virtual function. |
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>.