com.citrix.sdx.nitro.resource.config.xen

Class host_interface

java.lang.Object

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

com.citrix.sdx.nitro.resource.config.xen.host_interface

public class host_interface
extends base_resource

Configuration for XenServer 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
host_interface()

Method Summary

Methods

Modifier and Type	Method and Description
static host_interface	add(nitro_service client, host_interface resource) Use this operation to create channel.
static host_interface[]	add(nitro_service client, host_interface[] resources) Use this operation to create channel in bulk.
static long	count_filtered(nitro_service service, filtervalue[] filter) Use this API to count the filtered set of host_interface resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of host_interface resources.
static long	count(nitro_service service) Use this API to count the host_interface resources configured on NetScaler SDX.
static host_interface	delete(nitro_service client, host_interface resource) Use this operation to delete channels.
static host_interface[]	delete(nitro_service client, host_interface[] resources) Use this operation to delete channels in bulk.
String	get_act_id() Activity Id
Boolean	get_add_mac_address() Add Mac Address
Boolean	get_adv_auto_neg() true if the advertised auto-negotiation for the port is true
String[]	get_adv_link_modes() Advertised Link Modes
Boolean	get_apply_mac_address() Apply Mac Address
String	get_base_mac_address() Mac Address
String	get_channel_alias() Alias name for this channel
Integer	get_channel_bandwidth_high() Higher end threshold of the channel bandwidth usage in Mbps
Integer	get_channel_bandwidth_normal() Lower end threshold of the channel bandwidth usage in Mbps
Boolean	get_channel_ha_monitoring() HA-monitoring control for the channel.
String	get_channel_id() Channel ID if this interface represents a channel (LA/1, LA/2 ...)
String	get_channel_interface_list() Comma separated list of interfaces that are part of this channel if this interface represents a channel (10/1, 10/4)
Boolean	get_channel_tag_all_vlans() If true then all the member interfaces of this channel are tagged.
Integer	get_channel_throughput() Minimum required throughput in Mbps for this channel
String	get_channel_type() Channel type if this interface represents a channel (LACP or Static)
String	get_cpu_socket() CPU Socket to which this interface belong to
String	get_device_name() Device Name
String	get_duplex() Duplex
static host_interface[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of host_interface resources.
static host_interface[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of host_interface resources.
Boolean	get_flow_control_auto_neg() Auto Negotiation For Flow Control
Boolean	get_flow_control_rx() RX Pause
Boolean	get_flow_control_tx() TX Pause
String	get_id() Id is system generated key
String	get_interface_type() Indicates if this is an interface or a channel or a member interface of a channel
Boolean	get_is_mgmt_bond() True if this bond is on management interface
String	get_lacp_channel_mac_address() Mac address of the bond on Xenserver
String	get_lacp_channel_time() LACP time.
String	get_mapped_port() Mapped Port Name Ex: eth0
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_type() Port Type
String	get_port() Port Name Ex: 10/1
String	get_range() Range for Base Mac Address
String	get_speed() Actual speed
String	get_state() State of the port.
Boolean	get_static_channel_state() Static channel state (Enabled/Disabled)
Boolean	get_support_auto_neg() true if the port supports auto-negotiation
String[]	get_supported_link_modes() Supported Link Modes
String[]	get_supported_port_types() Supported Port Types
Boolean	get_sync_operation() sync operation
String	get_xen_bond_uuid() UUID of the corrosponding bond in Xenserver
static host_interface[]	get(nitro_service client) Use this operation to get interface/channel.
static host_interface	get(nitro_service client, host_interface resource) Use this operation to get interface/channel.
static host_interface	reset(nitro_service client, host_interface resource) Use this operation to reset interface settings.
static host_interface[]	reset(nitro_service client, host_interface[] resources) Use this operation to reset interface settings in bulk.
void	set_adv_auto_neg(Boolean adv_auto_neg) true if the advertised auto-negotiation for the port is true
void	set_base_mac_address(String base_mac_address) Mac Address
void	set_channel_alias(String channel_alias) Alias name for this channel
void	set_channel_bandwidth_high(Integer channel_bandwidth_high) Higher end threshold of the channel bandwidth usage in Mbps
void	set_channel_bandwidth_normal(Integer channel_bandwidth_normal) Lower end threshold of the channel bandwidth usage in Mbps
void	set_channel_ha_monitoring(Boolean channel_ha_monitoring) HA-monitoring control for the channel.
void	set_channel_id(String channel_id) Channel ID if this interface represents a channel (LA/1, LA/2 ...)
void	set_channel_interface_list(String channel_interface_list) Comma separated list of interfaces that are part of this channel if this interface represents a channel (10/1, 10/4)
void	set_channel_tag_all_vlans(Boolean channel_tag_all_vlans) If true then all the member interfaces of this channel are tagged.
void	set_channel_throughput(Integer channel_throughput) Minimum required throughput in Mbps for this channel
void	set_channel_type(String channel_type) Channel type if this interface represents a channel (LACP or Static)
void	set_duplex(String duplex) Duplex
void	set_flow_control_auto_neg(Boolean flow_control_auto_neg) Auto Negotiation For Flow Control
void	set_flow_control_rx(Boolean flow_control_rx) RX Pause
void	set_flow_control_tx(Boolean flow_control_tx) TX Pause
void	set_id(String id) Id is system generated key
void	set_lacp_channel_time(String lacp_channel_time) LACP time.
void	set_mapped_port(String mapped_port) Mapped Port Name Ex: eth0
void	set_port(String port) Port Name Ex: 10/1
void	set_range(String range) Range for Base Mac Address
void	set_speed(String speed) Actual speed
void	set_static_channel_state(Boolean static_channel_state) Static channel state (Enabled/Disabled)
void	set_support_auto_neg(Boolean support_auto_neg) true if the port supports auto-negotiation
void	set_sync_operation(Boolean sync_operation) sync operation
static host_interface	update(nitro_service client, host_interface resource) Use this operation to modify interface/channel.
static host_interface[]	update(nitro_service client, host_interface[] resources) Use this operation to modify interface/channel in bulk.
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

host_interface

public host_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

set_range

public void set_range(String range)

 Range for Base Mac Address
 

get_range

public String get_range()

 Range for Base Mac Address
 

set_channel_tag_all_vlans

public void set_channel_tag_all_vlans(Boolean channel_tag_all_vlans)

 If true then all the member interfaces of this channel are tagged. Possible values: true and false
 

get_channel_tag_all_vlans

public Boolean get_channel_tag_all_vlans()

 If true then all the member interfaces of this channel are tagged. Possible values: true and false
 

set_mapped_port

public void set_mapped_port(String mapped_port)

 Mapped Port Name Ex: eth0
 

get_mapped_port

public String get_mapped_port()

 Mapped Port Name Ex: eth0
 

set_lacp_channel_time

public void set_lacp_channel_time(String lacp_channel_time)

 LACP time. Possible values: fast and slow
 

get_lacp_channel_time

public String get_lacp_channel_time()

 LACP time. Possible values: fast and slow
 

get_xen_bond_uuid

public String get_xen_bond_uuid()

 UUID of the corrosponding bond in Xenserver
 

set_channel_interface_list

public void set_channel_interface_list(String channel_interface_list)

 Comma separated list of interfaces that are part of this channel if this interface represents a channel (10/1, 10/4)
 

get_channel_interface_list

public String get_channel_interface_list()

 Comma separated list of interfaces that are part of this channel if this interface represents a channel (10/1, 10/4)
 

set_channel_alias

public void set_channel_alias(String channel_alias)

 Alias name for this channel
 

get_channel_alias

public String get_channel_alias()

 Alias name for this channel
 

get_is_mgmt_bond

public Boolean get_is_mgmt_bond()

 True if this bond is on management interface
 

get_lacp_channel_mac_address

public String get_lacp_channel_mac_address()

 Mac address of the bond on Xenserver
 

set_channel_type

public void set_channel_type(String channel_type)

 Channel type if this interface represents a channel (LACP or Static)
 

get_channel_type

public String get_channel_type()

 Channel type if this interface represents a channel (LACP or Static)
 

set_id

public void set_id(String id)

 Id is system generated key 
 

get_id

public String get_id()

 Id is system generated key 
 

get_add_mac_address

public Boolean get_add_mac_address()

 Add Mac Address
 

get_apply_mac_address

public Boolean get_apply_mac_address()

 Apply Mac Address
 

set_channel_id

public void set_channel_id(String channel_id)

 Channel ID if this interface represents a channel (LA/1, LA/2 ...)
 

get_channel_id

public String get_channel_id()

 Channel ID if this interface represents a channel (LA/1, LA/2 ...)
 

set_port

public void set_port(String port)

 Port Name Ex: 10/1
 

get_port

public String get_port()

 Port Name Ex: 10/1
 

set_static_channel_state

public void set_static_channel_state(Boolean static_channel_state)

 Static channel state (Enabled/Disabled)
 

get_static_channel_state

public Boolean get_static_channel_state()

 Static channel state (Enabled/Disabled)
 

set_channel_ha_monitoring

public void set_channel_ha_monitoring(Boolean channel_ha_monitoring)

 HA-monitoring control for the channel. Possible values: true and false
 

get_channel_ha_monitoring

public Boolean get_channel_ha_monitoring()

 HA-monitoring control for the channel. Possible values: true and false
 

set_base_mac_address

public void set_base_mac_address(String base_mac_address)

 Mac Address
 

get_base_mac_address

public String get_base_mac_address()

 Mac Address
 

get_interface_type

public String get_interface_type()

 Indicates if this is an interface or a channel or a member interface of a channel
 

set_channel_throughput

public void set_channel_throughput(Integer channel_throughput)

 Minimum required throughput in Mbps for this channel
 

get_channel_throughput

public Integer get_channel_throughput()

 Minimum required throughput in Mbps for this channel
 

set_channel_bandwidth_high

public void set_channel_bandwidth_high(Integer channel_bandwidth_high)

 Higher end threshold of the channel bandwidth usage in Mbps
 

get_channel_bandwidth_high

public Integer get_channel_bandwidth_high()

 Higher end threshold of the channel bandwidth usage in Mbps
 

set_channel_bandwidth_normal

public void set_channel_bandwidth_normal(Integer channel_bandwidth_normal)

 Lower end threshold of the channel bandwidth usage in Mbps
 

get_channel_bandwidth_normal

public Integer get_channel_bandwidth_normal()

 Lower end threshold of the channel bandwidth usage in Mbps
 

set_flow_control_tx

public void set_flow_control_tx(Boolean flow_control_tx)

 TX Pause
 

get_flow_control_tx

public Boolean get_flow_control_tx()

 TX Pause
 

get_supported_link_modes

public String[] get_supported_link_modes()

 Supported Link Modes
 

get_state

public String get_state()

 State of the port.
 

get_device_name

public String get_device_name()

 Device Name
 

get_act_id

public String get_act_id()

 Activity Id
 

set_speed

public void set_speed(String speed)

 Actual speed 
 

get_speed

public String get_speed()

 Actual speed 
 

set_support_auto_neg

public void set_support_auto_neg(Boolean support_auto_neg)

 true if the port supports auto-negotiation
 

get_support_auto_neg

public Boolean get_support_auto_neg()

 true if the port supports auto-negotiation
 

get_port_type

public String get_port_type()

 Port Type
 

get_supported_port_types

public String[] get_supported_port_types()

 Supported Port Types
 

set_flow_control_auto_neg

public void set_flow_control_auto_neg(Boolean flow_control_auto_neg)

 Auto Negotiation For Flow Control
 

get_flow_control_auto_neg

public Boolean get_flow_control_auto_neg()

 Auto Negotiation For Flow Control
 

get_cpu_socket

public String get_cpu_socket()

 CPU Socket to which this interface belong to
 

set_duplex

public void set_duplex(String duplex)

 Duplex
 

get_duplex

public String get_duplex()

 Duplex
 

set_sync_operation

public void set_sync_operation(Boolean sync_operation)

 sync operation
 

get_sync_operation

public Boolean get_sync_operation()

 sync operation
 

set_adv_auto_neg

public void set_adv_auto_neg(Boolean adv_auto_neg)

 true if the advertised auto-negotiation for the port is true
 

get_adv_auto_neg

public Boolean get_adv_auto_neg()

 true if the advertised auto-negotiation for the port is true
 

set_flow_control_rx

public void set_flow_control_rx(Boolean flow_control_rx)

 RX Pause
 

get_flow_control_rx

public Boolean get_flow_control_rx()

 RX Pause
 

get_adv_link_modes

public String[] get_adv_link_modes()

 Advertised Link Modes
 

add

public static host_interface add(nitro_service client,
                 host_interface resource)
                          throws Exception

 Use this operation to create channel.
 

Throws:

Exception

add

public static host_interface[] add(nitro_service client,
                   host_interface[] resources)
                            throws Exception

 Use this operation to create channel in bulk.
 

Throws:

Exception

reset

public static host_interface reset(nitro_service client,
                   host_interface resource)
                            throws Exception

Use this operation to reset interface settings.

Throws:

Exception

reset

public static host_interface[] reset(nitro_service client,
                     host_interface[] resources)
                              throws Exception

 Use this operation to reset interface settings in bulk.
 

Throws:

Exception

delete

public static host_interface delete(nitro_service client,
                    host_interface resource)
                             throws Exception

 Use this operation to delete channels.
 

Throws:

Exception

delete

public static host_interface[] delete(nitro_service client,
                      host_interface[] resources)
                               throws Exception

 Use this operation to delete channels in bulk.
 

Throws:

Exception

get

public static host_interface[] get(nitro_service client)
                            throws Exception

 Use this operation to get interface/channel.
 

Throws:

Exception

get

public static host_interface get(nitro_service client,
                 host_interface resource)
                          throws Exception

Use this operation to get interface/channel.

Throws:

Exception

update

public static host_interface update(nitro_service client,
                    host_interface resource)
                             throws Exception

 Use this operation to modify interface/channel.
 

Throws:

Exception

update

public static host_interface[] update(nitro_service client,
                      host_interface[] resources)
                               throws Exception

 Use this operation to modify interface/channel in bulk.
 

Throws:

Exception

get_filtered

public static host_interface[] get_filtered(nitro_service service,
                            String filter)
                                     throws Exception

Use this API to fetch filtered set of host_interface resources. filter string should be in JSON format.eg: "vm_state:DOWN,name:[a-z]+"

Throws:

Exception

get_filtered

public static host_interface[] get_filtered(nitro_service service,
                            filtervalue[] filter)
                                     throws Exception

Use this API to fetch filtered set of host_interface resources. set the filter parameter values in filtervalue object.

Throws:

Exception

count

public static long count(nitro_service service)
                  throws Exception

Use this API to count the host_interface resources configured on NetScaler SDX.

Throws:

Exception

count_filtered

public static long count_filtered(nitro_service service,
                  String filter)
                           throws Exception

Use this API to count the filtered set of host_interface resources. filter string should be in JSON format.eg: "vm_state:DOWN,name:[a-z]+"

Throws:

Exception

count_filtered

public static long count_filtered(nitro_service service,
                  filtervalue[] filter)
                           throws Exception

Use this API to count the filtered set of host_interface resources. set the filter parameter values in filtervalue object.

Throws:

Exception

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