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

Class system_settings

java.lang.Object

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

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

public class system_settings
extends base_resource

Configuration for System Settings resource

Field Summary

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

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
system_settings()

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 system_settings resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of system_settings resources.
static long	count(nitro_service service) Use this API to count the system_settings resources configured on NetScaler SDX.
static system_settings[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of system_settings resources.
static system_settings[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of system_settings resources.
String	get_id() Id is system generated key
Integer	get_init_status() System initialize status
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.
String	get_ns_br_interface_2() Reserved Interface
String	get_ns_br_interface() Load Balancing Interface
protected String	get_object_id() Returns the value of object identifier argument.
protected String	get_object_type() Gets the resource type.
Boolean	get_secure_access_only() Secure Access only
String	get_svm_ns_comm() Management Service to NetScaler Communication
Boolean	get_vm_auto_poweron() Auto Power On
static system_settings	get(nitro_service client) Use this operation to get SDX system settings.
void	set_id(String id) Id is system generated key
void	set_init_status(Integer init_status) System initialize status
void	set_ns_br_interface_2(String ns_br_interface_2) Reserved Interface
void	set_ns_br_interface(String ns_br_interface) Load Balancing Interface
void	set_secure_access_only(Boolean secure_access_only) Secure Access only
void	set_svm_ns_comm(String svm_ns_comm) Management Service to NetScaler Communication
void	set_vm_auto_poweron(Boolean vm_auto_poweron) Auto Power On
static system_settings	update(nitro_service client, system_settings resource) Use this operation to modify SDX system settings.
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

system_settings

public system_settings()

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_svm_ns_comm

public void set_svm_ns_comm(String svm_ns_comm)

 Management Service to NetScaler Communication
 

get_svm_ns_comm

public String get_svm_ns_comm()

 Management Service to NetScaler Communication
 

set_secure_access_only

public void set_secure_access_only(Boolean secure_access_only)

 Secure Access only
 

get_secure_access_only

public Boolean get_secure_access_only()

 Secure Access only
 

set_init_status

public void set_init_status(Integer init_status)

 System initialize status
 

get_init_status

public Integer get_init_status()

 System initialize status
 

set_vm_auto_poweron

public void set_vm_auto_poweron(Boolean vm_auto_poweron)

 Auto Power On
 

get_vm_auto_poweron

public Boolean get_vm_auto_poweron()

 Auto Power On
 

set_ns_br_interface

public void set_ns_br_interface(String ns_br_interface)

 Load Balancing Interface
 

get_ns_br_interface

public String get_ns_br_interface()

 Load Balancing Interface
 

set_id

public void set_id(String id)

 Id is system generated key
 

get_id

public String get_id()

 Id is system generated key
 

set_ns_br_interface_2

public void set_ns_br_interface_2(String ns_br_interface_2)

 Reserved Interface
 

get_ns_br_interface_2

public String get_ns_br_interface_2()

 Reserved Interface
 

get

public static system_settings get(nitro_service client)
                           throws Exception

Use this operation to get SDX system settings.

Throws:

Exception

update

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

 Use this operation to modify SDX system settings.
 

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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