com.citrix.sdx.nitro.resource.config.br

Class br

java.lang.Object

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

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

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

com.citrix.sdx.nitro.resource.config.br.br

public class br
extends vm_device

Configuration for Repeater Instance resource

Field Summary

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

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
br()

Method Summary

Methods

Modifier and Type	Method and Description
static br	add(nitro_service client, br resource) Use this operation to add Repeater Instance.
static br[]	add(nitro_service client, br[] resources) Use this operation to add Repeater Instance in bulk.
static long	count_filtered(nitro_service service, filtervalue[] filter) Use this API to count the filtered set of br resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of br resources.
static long	count(nitro_service service) Use this API to count the br resources configured on NetScaler SDX.
static br	delete(nitro_service client, br resource) Use this operation to delete Repeater Instances.
static br[]	delete(nitro_service client, br[] resources) Use this operation to delete Repeater Instances in bulk.
static br	force_reboot(nitro_service client, br resource) Use this operation to force reboot Repeater Instance.
static br[]	force_reboot(nitro_service client, br[] resources) Use this operation to force reboot Repeater Instance in bulk.
static br	force_stop(nitro_service client, br resource) Use this operation to force stop Repeater Instance.
static br[]	force_stop(nitro_service client, br[] resources) Use this operation to force stop Repeater Instance in bulk.
String	get_acl_connections() Accelerated Connections
Double	get_active_connections() Total Active Connections on Repeater Instance
String	get_apa_gateway() aPA Gateway
String	get_apa_ip_address() aPA IP Address
String	get_apa_netmask() aPA Netmask
Double	get_bandwidth_limit() bandwidth limit of Repeater Instance (K-Bits/sec)
String	get_bandwidth_mode() Boost status : Bandwidth Mode of Repeater Instance
Double	get_br_cpu_usage() CPU Usage (%) of Repeater Instance
Double	get_br_memory_usage() Memory Usage (%) of Repeater Instance
String	get_bypass() bypass value of Repeater Instance
String	get_connected_plugins() connected plugins
static br[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of br resources.
static br[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of br resources.
Double	get_ha_peer_id() Id of the Peer in an HA setup
String	get_ha_peer_ip_address() Peer IP Address of Repeater Instance
String	get_ha_peer_state() Peer State of Repeater Instance in HA mode
String	get_ha_state() State of Repeater Instance in HA mode
String	get_havmip() HA VM IPAddress
Double	get_lan_in_prev() Lan In of Repeater Instance in Mbps
Double	get_lan_in() Lan In of Repeater Instance in Mbps
Double	get_lan_out_prev() Lan In of Repeater Instance in Mbps
Double	get_lan_out() LAN Out of Repeater Instance in Mbps
String	get_license() Repeater License
String	get_max_plugins() Maximum plugins
String	get_mgmt_ip_address() Management IP Address for this Repeater
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_operation_status() Operation status of Repeater Instance
String	get_plugin_ip_address() Plugin IP Address
Double	get_prev_poll_time() Previous time
Double	get_system_load() System Load (%) on Repeater Instance
String	get_unacl_connections() non-accelerated connections
String	get_upsince() Upsince of Repeater Instance
Double	get_wan_in_prev() WAN In of Repeater Instance in Mbps
Double	get_wan_in() WAN In of Repeater Instance in Mbps
Double	get_wan_out_prev() WAN In of Repeater Instance in Mbps
Double	get_wan_out() WAN Out of Repeater Instance in Mbps
static br[]	get(nitro_service client) Use this operation to get Repeater Instance.
static br	get(nitro_service client, br resource) Use this operation to get Repeater Instance.
static br	reboot(nitro_service client, br resource) Use this operation to reboot Repeater Instance.
static br[]	reboot(nitro_service client, br[] resources) Use this operation to reboot Repeater Instance in bulk.
void	set_apa_gateway(String apa_gateway) aPA Gateway
void	set_apa_ip_address(String apa_ip_address) aPA IP Address
void	set_apa_netmask(String apa_netmask) aPA Netmask
void	set_mgmt_ip_address(String mgmt_ip_address) Management IP Address for this Repeater
void	set_plugin_ip_address(String plugin_ip_address) Plugin IP Address
static br	start(nitro_service client, br resource) Use this operation to start Repeater Instance.
static br[]	start(nitro_service client, br[] resources) Use this operation to start Repeater Instance in bulk.
static br	stop(nitro_service client, br resource) Use this operation to stop Repeater Instance.
static br[]	stop(nitro_service client, br[] resources) Use this operation to stop Repeater Instance in bulk.
static br	update(nitro_service client, br resource) Use this operation to modify Repeater Instance.
static br[]	update(nitro_service client, br[] resources) Use this operation to modify Repeater Instance 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.config.mps.vm_device

get_assigned_cpu_socket, get_cpu_core_mgmt, get_cpu_core_pe, get_disk_allocation, get_disk_space, get_domain_name, get_domid, get_has_sdxtools, get_if_1_1, get_if_1_2, get_if_1_3, get_if_1_4, get_if_1_5, get_if_1_6, get_if_1_7, get_if_1_8, get_if_10_1, get_if_10_2, get_if_10_3, get_if_10_4, get_if_10_5, get_if_10_6, get_if_10_7, get_if_10_8, get_image_name, get_l2_enabled, get_la_mgmt, get_mac_eth0, get_network_interfaces, get_number_of_cores, get_number_of_ssl_cores, get_preferred_cpu_socket, get_provision_with_xva, get_reboot_vm_on_cpu_change, get_receiveuntagged_1_1, get_receiveuntagged_1_2, get_receiveuntagged_1_3, get_receiveuntagged_1_4, get_receiveuntagged_1_5, get_receiveuntagged_1_6, get_receiveuntagged_1_7, get_receiveuntagged_1_8, get_receiveuntagged_10_1, get_receiveuntagged_10_2, get_receiveuntagged_10_3, get_receiveuntagged_10_4, get_receiveuntagged_10_5, get_receiveuntagged_10_6, get_receiveuntagged_10_7, get_receiveuntagged_10_8, get_sdxtools_http_port, get_sdxtools_public_key, get_sdxtools_version, get_ssl_virtual_functions, get_sync_operation, get_template_name, get_throughput, get_uptime, get_uuid, get_virtual_functions, get_vlan_1_1, get_vlan_1_2, get_vlan_1_3, get_vlan_1_4, get_vlan_1_5, get_vlan_1_6, get_vlan_1_7, get_vlan_1_8, get_vlan_10_1, get_vlan_10_2, get_vlan_10_3, get_vlan_10_4, get_vlan_10_5, get_vlan_10_6, get_vlan_10_7, get_vlan_10_8, get_vlan_id_0_1, get_vlan_id_0_2, get_vm_cpu_usage, get_vm_description, get_vm_memory_free, get_vm_memory_total, get_vm_memory_usage, get_vm_rx, get_vm_state, get_vm_tx, get_vrid_list_ipv4_1_1, get_vrid_list_ipv4_1_2, get_vrid_list_ipv4_1_3, get_vrid_list_ipv4_1_4, get_vrid_list_ipv4_1_5, get_vrid_list_ipv4_1_6, get_vrid_list_ipv4_1_7, get_vrid_list_ipv4_1_8, get_vrid_list_ipv4_10_1, get_vrid_list_ipv4_10_2, get_vrid_list_ipv4_10_3, get_vrid_list_ipv4_10_4, get_vrid_list_ipv4_10_5, get_vrid_list_ipv4_10_6, get_vrid_list_ipv4_10_7, get_vrid_list_ipv4_10_8, get_vrid_list_ipv6_1_1, get_vrid_list_ipv6_1_2, get_vrid_list_ipv6_1_3, get_vrid_list_ipv6_1_4, get_vrid_list_ipv6_1_5, get_vrid_list_ipv6_1_6, get_vrid_list_ipv6_1_7, get_vrid_list_ipv6_1_8, get_vrid_list_ipv6_10_1, get_vrid_list_ipv6_10_2, get_vrid_list_ipv6_10_3, get_vrid_list_ipv6_10_4, get_vrid_list_ipv6_10_5, get_vrid_list_ipv6_10_6, get_vrid_list_ipv6_10_7, get_vrid_list_ipv6_10_8, get, set_domain_name, set_if_1_1, set_if_1_2, set_if_1_3, set_if_1_4, set_if_1_5, set_if_1_6, set_if_1_7, set_if_1_8, set_if_10_1, set_if_10_2, set_if_10_3, set_if_10_4, set_if_10_5, set_if_10_6, set_if_10_7, set_if_10_8, set_image_name, set_l2_enabled, set_la_mgmt, set_network_interfaces, set_number_of_cores, set_number_of_ssl_cores, set_provision_with_xva, set_reboot_vm_on_cpu_change, set_receiveuntagged_1_1, set_receiveuntagged_1_2, set_receiveuntagged_1_3, set_receiveuntagged_1_4, set_receiveuntagged_1_5, set_receiveuntagged_1_6, set_receiveuntagged_1_7, set_receiveuntagged_1_8, set_receiveuntagged_10_1, set_receiveuntagged_10_2, set_receiveuntagged_10_3, set_receiveuntagged_10_4, set_receiveuntagged_10_5, set_receiveuntagged_10_6, set_receiveuntagged_10_7, set_receiveuntagged_10_8, set_sync_operation, set_template_name, set_throughput, set_vlan_1_1, set_vlan_1_2, set_vlan_1_3, set_vlan_1_4, set_vlan_1_5, set_vlan_1_6, set_vlan_1_7, set_vlan_1_8, set_vlan_10_1, set_vlan_10_2, set_vlan_10_3, set_vlan_10_4, set_vlan_10_5, set_vlan_10_6, set_vlan_10_7, set_vlan_10_8, set_vlan_id_0_1, set_vlan_id_0_2, set_vm_memory_total, set_vrid_list_ipv4_1_1, set_vrid_list_ipv4_1_2, set_vrid_list_ipv4_1_3, set_vrid_list_ipv4_1_4, set_vrid_list_ipv4_1_5, set_vrid_list_ipv4_1_6, set_vrid_list_ipv4_1_7, set_vrid_list_ipv4_1_8, set_vrid_list_ipv4_10_1, set_vrid_list_ipv4_10_2, set_vrid_list_ipv4_10_3, set_vrid_list_ipv4_10_4, set_vrid_list_ipv4_10_5, set_vrid_list_ipv4_10_6, set_vrid_list_ipv4_10_7, set_vrid_list_ipv4_10_8, set_vrid_list_ipv6_1_1, set_vrid_list_ipv6_1_2, set_vrid_list_ipv6_1_3, set_vrid_list_ipv6_1_4, set_vrid_list_ipv6_1_5, set_vrid_list_ipv6_1_6, set_vrid_list_ipv6_1_7, set_vrid_list_ipv6_1_8, set_vrid_list_ipv6_10_1, set_vrid_list_ipv6_10_2, set_vrid_list_ipv6_10_3, set_vrid_list_ipv6_10_4, set_vrid_list_ipv6_10_5, set_vrid_list_ipv6_10_6, set_vrid_list_ipv6_10_7, set_vrid_list_ipv6_10_8

Methods inherited from class com.citrix.sdx.nitro.resource.config.mps.managed_device

add, add, delete, delete, get_act_id, get_description, get_device_family, get_gateway, get_hostname, get_id, get_instance_state, get_ip_address, get_name, get_netmask, get_ping_state, get_profile_name, get_profile_password, get_profile_username, get_reason, get_status, get_type, get_user_driven, get_version, set_description, set_device_family, set_gateway, set_hostname, set_id, set_ip_address, set_name, set_netmask, set_profile_name, set_profile_password, set_profile_username, set_type

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

br

public br()

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 vm_device

Returns:

Resource Type.

get_object_id

protected String get_object_id()

Returns the value of object identifier argument.

Overrides:

get_object_id in class vm_device

get_connected_plugins

public String get_connected_plugins()

 connected plugins
 

get_bandwidth_mode

public String get_bandwidth_mode()

 Boost status : Bandwidth Mode of Repeater Instance
 

get_ha_peer_ip_address

public String get_ha_peer_ip_address()

 Peer IP Address of Repeater Instance
 

set_mgmt_ip_address

public void set_mgmt_ip_address(String mgmt_ip_address)

 Management IP Address for this Repeater
 

get_mgmt_ip_address

public String get_mgmt_ip_address()

 Management IP Address for this Repeater
 

get_wan_out_prev

public Double get_wan_out_prev()

 WAN In of Repeater Instance in Mbps
 

get_ha_peer_state

public String get_ha_peer_state()

 Peer State of Repeater Instance in HA mode
 

get_havmip

public String get_havmip()

 HA VM IPAddress
 

get_lan_in_prev

public Double get_lan_in_prev()

 Lan In of Repeater Instance in Mbps
 

get_wan_in_prev

public Double get_wan_in_prev()

 WAN In of Repeater Instance in Mbps
 

get_lan_out_prev

public Double get_lan_out_prev()

 Lan In of Repeater Instance in Mbps
 

get_lan_in

public Double get_lan_in()

 Lan In of Repeater Instance in Mbps
 

get_bypass

public String get_bypass()

 bypass value of Repeater Instance
 

get_ha_peer_id

public Double get_ha_peer_id()

 Id of the Peer in an HA setup
 

get_upsince

public String get_upsince()

 Upsince of Repeater Instance
 

get_lan_out

public Double get_lan_out()

 LAN Out of Repeater Instance in Mbps
 

set_plugin_ip_address

public void set_plugin_ip_address(String plugin_ip_address)

 Plugin IP Address
 

get_plugin_ip_address

public String get_plugin_ip_address()

 Plugin IP Address
 

get_max_plugins

public String get_max_plugins()

 Maximum plugins
 

get_active_connections

public Double get_active_connections()

 Total Active Connections on Repeater Instance
 

get_wan_out

public Double get_wan_out()

 WAN Out of Repeater Instance in Mbps
 

get_wan_in

public Double get_wan_in()

 WAN In of Repeater Instance in Mbps
 

get_br_cpu_usage

public Double get_br_cpu_usage()

 CPU Usage (%) of Repeater Instance
 

get_unacl_connections

public String get_unacl_connections()

 non-accelerated connections
 

get_prev_poll_time

public Double get_prev_poll_time()

 Previous time
 

get_system_load

public Double get_system_load()

 System Load (%) on Repeater Instance
 

get_license

public String get_license()

 Repeater License
 

set_apa_ip_address

public void set_apa_ip_address(String apa_ip_address)

 aPA IP Address
 

get_apa_ip_address

public String get_apa_ip_address()

 aPA IP Address
 

set_apa_netmask

public void set_apa_netmask(String apa_netmask)

 aPA Netmask
 

get_apa_netmask

public String get_apa_netmask()

 aPA Netmask
 

set_apa_gateway

public void set_apa_gateway(String apa_gateway)

 aPA Gateway
 

get_apa_gateway

public String get_apa_gateway()

 aPA Gateway
 

get_acl_connections

public String get_acl_connections()

 Accelerated Connections
 

get_bandwidth_limit

public Double get_bandwidth_limit()

 bandwidth limit of Repeater Instance (K-Bits/sec)
 

get_ha_state

public String get_ha_state()

 State of Repeater Instance in HA mode
 

get_br_memory_usage

public Double get_br_memory_usage()

 Memory Usage (%) of Repeater Instance
 

get_operation_status

public String get_operation_status()

 Operation status of Repeater Instance
 

reboot

public static br reboot(nitro_service client,
        br resource)
                 throws Exception

Use this operation to reboot Repeater Instance.

Throws:

Exception

reboot

public static br[] reboot(nitro_service client,
          br[] resources)
                   throws Exception

 Use this operation to reboot Repeater Instance in bulk.
 

Throws:

Exception

stop

public static br stop(nitro_service client,
      br resource)
               throws Exception

Use this operation to stop Repeater Instance.

Throws:

Exception

stop

public static br[] stop(nitro_service client,
        br[] resources)
                 throws Exception

 Use this operation to stop Repeater Instance in bulk.
 

Throws:

Exception

add

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

 Use this operation to add Repeater Instance.
 

Throws:

Exception

add

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

 Use this operation to add Repeater Instance in bulk.
 

Throws:

Exception

force_reboot

public static br force_reboot(nitro_service client,
              br resource)
                       throws Exception

Use this operation to force reboot Repeater Instance.

Throws:

Exception

force_reboot

public static br[] force_reboot(nitro_service client,
                br[] resources)
                         throws Exception

 Use this operation to force reboot Repeater Instance in bulk.
 

Throws:

Exception

get

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

 Use this operation to get Repeater Instance.
 

Throws:

Exception

get

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

Use this operation to get Repeater Instance.

Throws:

Exception

delete

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

 Use this operation to delete Repeater Instances.
 

Throws:

Exception

delete

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

 Use this operation to delete Repeater Instances in bulk.
 

Throws:

Exception

update

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

 Use this operation to modify Repeater Instance.
 

Throws:

Exception

update

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

 Use this operation to modify Repeater Instance in bulk.
 

Throws:

Exception

force_stop

public static br force_stop(nitro_service client,
            br resource)
                     throws Exception

Use this operation to force stop Repeater Instance.

Throws:

Exception

force_stop

public static br[] force_stop(nitro_service client,
              br[] resources)
                       throws Exception

 Use this operation to force stop Repeater Instance in bulk.
 

Throws:

Exception

start

public static br start(nitro_service client,
       br resource)
                throws Exception

Use this operation to start Repeater Instance.

Throws:

Exception

start

public static br[] start(nitro_service client,
         br[] resources)
                  throws Exception

 Use this operation to start Repeater Instance in bulk.
 

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

Use this API to fetch filtered set of br 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 br 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 br 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 br 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.
 

Overrides:

get_nitro_response in class vm_device

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.
 

Overrides:

get_nitro_bulk_response in class vm_device

Throws:

Exception

validate

protected void validate(String operationType)
                 throws Exception

 Performs generic data validation for the operation to be performed
 

Overrides:

validate in class vm_device

Parameters:

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

Throws:

Exception