com.citrix.sdx.nitro.resource.config.mps

Class network_interface

java.lang.Object

com.citrix.sdx.nitro.resource.base.base_resource

com.citrix.sdx.nitro.resource.config.mps.network_interface

public class network_interface
extends base_resource

Configuration for VM device network interface resource

Field Summary

Fields inherited from class com.citrix.sdx.nitro.resource.base.base_resource

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
network_interface()

Method Summary

Methods

Modifier and Type	Method and Description
String	get_device_channel_name() LA Name on the actual VM
String	get_gateway() gateway
String	get_ip_address() IP Address
Boolean	get_is_member_ifc() True if this interface is member of a channel
Boolean	get_is_mgmt_ifc() True if this is the management interface
Boolean	get_is_vlan_applied() Is VLAN added on NetworkInterface of VM Instance
Boolean	get_l2_enabled() L2 mode status of Interface
String	get_mac_address() Mac Address
String	get_mac_mode() Mac Mode, default for XenServer generated, generated for SVM generated, custom for User assigned
String	get_managed_device_id() managed_device_id
String	get_name_server() Name Server
String	get_netmask() netmask
protected base_resource[]	get_nitro_bulk_response(nitro_service service, String response) Converts API response of bulk operation into object and returns the object array in case of get request.
protected base_resource[]	get_nitro_response(nitro_service service, String response) Converts API response into object and returns the object array in case of get request.
protected String	get_object_id() Returns the value of object identifier argument.
protected String	get_object_type() Gets the resource type.
String	get_port_name() Port name of the interface on the host machine
Boolean	get_receiveuntagged() Receive Untagged Packets on Interface/Channel
Integer	get_vf_index() Index given by Xen when assigning free virtual function
String[]	get_vlan_whitelist_array() VLAN Whitelist for Interface on VM Instance
String	get_vlan_whitelist() VLAN Whitelist for Interface/Channel on VM Instance
Integer	get_vlan() VLAN Id
String[]	get_vrid_list_ipv4_array() VRID List for Interface for IPV4 VMAC Generation
String	get_vrid_list_ipv4() VRID List for Interface/Channel for IPV4 VMAC Generation
String[]	get_vrid_list_ipv6_array() VRID List for Interface for IPV6 VMAC Generation
String	get_vrid_list_ipv6() VRID List for Interface/Channel for IPV6 VMAC Generation
void	set_gateway(String gateway) gateway
void	set_ip_address(String ip_address) IP Address
void	set_is_member_ifc(Boolean is_member_ifc) True if this interface is member of a channel
void	set_is_mgmt_ifc(Boolean is_mgmt_ifc) True if this is the management interface
void	set_is_vlan_applied(Boolean is_vlan_applied) Is VLAN added on NetworkInterface of VM Instance
void	set_l2_enabled(Boolean l2_enabled) L2 mode status of Interface
void	set_mac_address(String mac_address) Mac Address
void	set_mac_mode(String mac_mode) Mac Mode, default for XenServer generated, generated for SVM generated, custom for User assigned
void	set_managed_device_id(String managed_device_id) managed_device_id
void	set_name_server(String name_server) Name Server
void	set_netmask(String netmask) netmask
void	set_port_name(String port_name) Port name of the interface on the host machine
void	set_receiveuntagged(Boolean receiveuntagged) Receive Untagged Packets on Interface/Channel
void	set_vf_index(Integer vf_index) Index given by Xen when assigning free virtual function
void	set_vlan_whitelist_array(String[] vlan_whitelist_array) VLAN Whitelist for Interface on VM Instance
void	set_vlan_whitelist(String vlan_whitelist) VLAN Whitelist for Interface/Channel on VM Instance
void	set_vlan(Integer vlan) VLAN Id
void	set_vrid_list_ipv4_array(String[] vrid_list_ipv4_array) VRID List for Interface for IPV4 VMAC Generation
void	set_vrid_list_ipv4(String vrid_list_ipv4) VRID List for Interface/Channel for IPV4 VMAC Generation
void	set_vrid_list_ipv6_array(String[] vrid_list_ipv6_array) VRID List for Interface for IPV6 VMAC Generation
void	set_vrid_list_ipv6(String vrid_list_ipv6) VRID List for Interface/Channel for IPV6 VMAC Generation
protected void	validate(String operationType) Performs generic data validation for the operation to be performed

Methods inherited from class com.citrix.sdx.nitro.resource.base.base_resource

add_resource, add_resource, delete_bulk_request, delete_resource, get_resource, get_resource, get_resources, get_resources, getfiltered, perform_operation_bulk_request, perform_operation, perform_operation, perform_operation, resource_to_string, resource_to_string, update_bulk_request, update_resource, update_resource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

network_interface

public network_interface()

Method Detail

get_object_type

protected String get_object_type()

Description copied from class: base_resource

Gets the resource type.

Overrides:

get_object_type in class base_resource

Returns:

Resource Type.

get_object_id

protected String get_object_id()

Returns the value of object identifier argument.

Specified by:

get_object_id in class base_resource

get_device_channel_name

public String get_device_channel_name()

 LA Name on the actual VM
 

set_is_mgmt_ifc

public void set_is_mgmt_ifc(Boolean is_mgmt_ifc)

 True if this is the management interface
 

get_is_mgmt_ifc

public Boolean get_is_mgmt_ifc()

 True if this is the management interface
 

set_name_server

public void set_name_server(String name_server)

 Name Server
 

get_name_server

public String get_name_server()

 Name Server
 

set_vrid_list_ipv6

public void set_vrid_list_ipv6(String vrid_list_ipv6)

 VRID List for Interface/Channel for IPV6 VMAC Generation
 

get_vrid_list_ipv6

public String get_vrid_list_ipv6()

 VRID List for Interface/Channel for IPV6 VMAC Generation
 

set_gateway

public void set_gateway(String gateway)

 gateway
 

get_gateway

public String get_gateway()

 gateway
 

set_vrid_list_ipv4

public void set_vrid_list_ipv4(String vrid_list_ipv4)

 VRID List for Interface/Channel for IPV4 VMAC Generation
 

get_vrid_list_ipv4

public String get_vrid_list_ipv4()

 VRID List for Interface/Channel for IPV4 VMAC Generation
 

set_is_member_ifc

public void set_is_member_ifc(Boolean is_member_ifc)

 True if this interface is member of a channel
 

get_is_member_ifc

public Boolean get_is_member_ifc()

 True if this interface is member of a channel
 

set_mac_address

public void set_mac_address(String mac_address)

 Mac Address
 

get_mac_address

public String get_mac_address()

 Mac Address
 

set_l2_enabled

public void set_l2_enabled(Boolean l2_enabled)

 L2 mode status of Interface
 

get_l2_enabled

public Boolean get_l2_enabled()

 L2 mode status of Interface
 

set_ip_address

public void set_ip_address(String ip_address)

 IP Address
 

get_ip_address

public String get_ip_address()

 IP Address
 

set_netmask

public void set_netmask(String netmask)

 netmask
 

get_netmask

public String get_netmask()

 netmask
 

set_vf_index

public void set_vf_index(Integer vf_index)

 Index given by Xen when assigning free virtual function
 

get_vf_index

public Integer get_vf_index()

 Index given by Xen when assigning free virtual function
 

set_port_name

public void set_port_name(String port_name)

 Port name of the interface on the host machine
 

get_port_name

public String get_port_name()

 Port name of the interface on the host machine
 

set_mac_mode

public void set_mac_mode(String mac_mode)

 Mac Mode, default for XenServer generated, generated for SVM generated, custom for User assigned
 

get_mac_mode

public String get_mac_mode()

 Mac Mode, default for XenServer generated, generated for SVM generated, custom for User assigned
 

set_managed_device_id

public void set_managed_device_id(String managed_device_id)

 managed_device_id
 

get_managed_device_id

public String get_managed_device_id()

 managed_device_id
 

set_vlan

public void set_vlan(Integer vlan)

 VLAN Id
 

get_vlan

public Integer get_vlan()

 VLAN Id
 

set_receiveuntagged

public void set_receiveuntagged(Boolean receiveuntagged)

 Receive Untagged Packets on Interface/Channel
 

get_receiveuntagged

public Boolean get_receiveuntagged()

 Receive Untagged Packets on Interface/Channel
 

set_vlan_whitelist

public void set_vlan_whitelist(String vlan_whitelist)

 VLAN Whitelist for Interface/Channel on VM Instance
 

get_vlan_whitelist

public String get_vlan_whitelist()

 VLAN Whitelist for Interface/Channel on VM Instance
 

set_vrid_list_ipv4_array

public void set_vrid_list_ipv4_array(String[] vrid_list_ipv4_array)

 VRID List for Interface for IPV4 VMAC Generation
 

get_vrid_list_ipv4_array

public String[] get_vrid_list_ipv4_array()

 VRID List for Interface for IPV4 VMAC Generation
 

set_vrid_list_ipv6_array

public void set_vrid_list_ipv6_array(String[] vrid_list_ipv6_array)

 VRID List for Interface for IPV6 VMAC Generation
 

get_vrid_list_ipv6_array

public String[] get_vrid_list_ipv6_array()

 VRID List for Interface for IPV6 VMAC Generation
 

set_vlan_whitelist_array

public void set_vlan_whitelist_array(String[] vlan_whitelist_array)

 VLAN Whitelist for Interface on VM Instance
 

get_vlan_whitelist_array

public String[] get_vlan_whitelist_array()

 VLAN Whitelist for Interface on VM Instance
 

set_is_vlan_applied

public void set_is_vlan_applied(Boolean is_vlan_applied)

 Is VLAN added on NetworkInterface of VM Instance
 

get_is_vlan_applied

public Boolean get_is_vlan_applied()

 Is VLAN added on NetworkInterface of VM Instance
 

get_nitro_response

protected base_resource[] get_nitro_response(nitro_service service,
                                 String response)
                                      throws Exception

 Converts API response into object and returns the object array in case of get request.
 

Specified by:

get_nitro_response in class base_resource

Throws:

Exception

get_nitro_bulk_response

protected base_resource[] get_nitro_bulk_response(nitro_service service,
                                      String response)
                                           throws Exception

 Converts API response of bulk operation into object and returns the object array in case of get request.
 

Specified by:

get_nitro_bulk_response in class base_resource

Throws:

Exception

validate

protected void validate(String operationType)
                 throws Exception

 Performs generic data validation for the operation to be performed
 

Overrides:

validate in class base_resource

Parameters:

operationType - : add,delete,modify,get etc.

Throws:

Exception