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

Class techsupport

java.lang.Object

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

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

public class techsupport
extends base_resource

Configuration for Technical Support resource

Field Summary

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

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
techsupport()

Method Summary

Methods

Modifier and Type	Method and Description
static long	count_filtered(nitro_service service, filtervalue[] filter) Use this API to count the filtered set of techsupport resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of techsupport resources.
static long	count(nitro_service service) Use this API to count the techsupport resources configured on NetScaler SDX.
static techsupport	delete(nitro_service client, techsupport resource) Use this operation to delete technical support file.
static techsupport[]	delete(nitro_service client, techsupport[] resources) Use this operation to delete technical support file in bulk.
String	get_act_id() Activity Id
String	get_file_last_modified() Last Modified Time
String	get_file_name() Technical support File Name
Integer	get_file_size() File Size
static techsupport[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of techsupport resources.
static techsupport[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of techsupport resources.
String	get_mode() Technical support Mode, Possible values Appliance | XenServer | Management Service | NetScaler Insight | Appliance_full | Instances
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_vpx_list_for_techsupport() List of VPX for which the techsupport is required
static techsupport[]	get(nitro_service client) Use this operation to get technical support file.
static techsupport	get(nitro_service client, techsupport resource) Use this operation to get technical support file.
void	set_file_name(String file_name) Technical support File Name
void	set_mode(String mode) Technical support Mode, Possible values Appliance | XenServer | Management Service | NetScaler Insight | Appliance_full | Instances
void	set_vpx_list_for_techsupport(String[] vpx_list_for_techsupport) List of VPX for which the techsupport is required
static techsupport[]	start(nitro_service client, techsupport resource) Use this operation to generate technical support archive.
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

techsupport

public techsupport()

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_file_size

public Integer get_file_size()

 File Size
 

set_vpx_list_for_techsupport

public void set_vpx_list_for_techsupport(String[] vpx_list_for_techsupport)

 List of VPX for which the techsupport is required
 

get_vpx_list_for_techsupport

public String[] get_vpx_list_for_techsupport()

 List of VPX for which the techsupport is required
 

get_act_id

public String get_act_id()

 Activity Id
 

set_file_name

public void set_file_name(String file_name)

 Technical support File Name
 

get_file_name

public String get_file_name()

 Technical support File Name
 

set_mode

public void set_mode(String mode)

 Technical support Mode, Possible values Appliance | XenServer | Management Service | NetScaler Insight | Appliance_full | Instances
 

get_mode

public String get_mode()

 Technical support Mode, Possible values Appliance | XenServer | Management Service | NetScaler Insight | Appliance_full | Instances
 

get_file_last_modified

public String get_file_last_modified()

 Last Modified Time
 

start

public static techsupport[] start(nitro_service client,
                  techsupport resource)
                           throws Exception

 Use this operation to generate technical support archive.
 

Throws:

Exception

delete

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

 Use this operation to delete technical support file.
 

Throws:

Exception

delete

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

 Use this operation to delete technical support file in bulk.
 

Throws:

Exception

get

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

 Use this operation to get technical support file.
 

Throws:

Exception

get

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

Use this operation to get technical support file.

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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