Download full document:


Configuration for VM device network interface resource.

(click to see Operations)


(click to see Operations)

NameData TypePermissionsDescription
is_mgmt_ifc<Boolean>Read-writeTrue if this is the management interface.
name_server<String>Read-writeName Server.
Minimum length = 1
Maximum length = 64
vrid_list_ipv6<String>Read-writeVRID List for Interface/Channel for IPV6 VMAC Generation.
Minimum length = 1
Maximum length = 64
vrid_list_ipv4<String>Read-writeVRID List for Interface/Channel for IPV4 VMAC Generation.
is_member_ifc<Boolean>Read-writeTrue if this interface is member of a channel.
mac_address<String>Read-writeMac Address.
Minimum length = 1
Maximum length = 32
l2_enabled<Boolean>Read-writeL2 mode status of Interface.
ip_address<String>Read-writeIP Address.
Minimum length = 1
Maximum length = 64
Minimum length = 1
Maximum length = 64
port_name<String>Read-writePort name of the interface on the host machine.
Minimum length = 1
Maximum length = 128
mac_mode<String>Read-writeMac Mode, default for XenServer generated, generated for SVM generated, custom for User assigned.
Minimum length = 1
Maximum length = 255
vlan<Integer>Read-writeThis property is not supported.Use vlan_whitelist for vlan configuration;ltbr;gtVLAN Id.
Maximum value =
receiveuntagged<Boolean>Read-writeReceive Untagged Packets on Interface/Channel.
sdx_formation_network_id<String>Read-writeThis 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-writeVLAN Whitelist for Interface/Channel on VM Instance.
interface_name<String>Read-writeName of this interface.
vrid_list_ipv4_array<String[]>Read-writeVRID List for Interface for IPV4 VMAC Generation.
vrid_list_ipv6_array<String[]>Read-writeVRID List for Interface for IPV6 VMAC Generation.
vlan_whitelist_array<String[]>Read-writeVLAN Whitelist for Interface on VM Instance.
is_vlan_applied<Boolean>Read-writeIs VLAN added on NetworkInterface of VM Instance.
device_channel_name<String>Read-onlyLA Name on the actual VM.
xen_vf_index<Integer>Read-onlyIndex given by Xen when assigning free virtual function.


(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:


    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:



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



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