com.citrix.sdx.nitro.resource.config.ns

Class ns_conf

java.lang.Object

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

com.citrix.sdx.nitro.resource.config.ns.ns_conf

public class ns_conf
extends base_resource

Configuration for ns.conf file on NetScaler resource

Field Summary

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

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
ns_conf()

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 ns_conf resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of ns_conf resources.
static long	count(nitro_service service) Use this API to count the ns_conf resources configured on NetScaler SDX.
String	get_device_name() Name of the device
String	get_diff_status() Tells whether a diff exists between running and saved configuration on NS
static ns_conf[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of ns_conf resources.
static ns_conf[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of ns_conf resources.
String	get_id() Id is system generated key for all ns.conf files
Integer	get_last_updated_time() Last Updated Time
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_ip_address() List of NetScaler IP Address
protected String	get_object_id() Returns the value of object identifier argument.
protected String	get_object_type() Gets the resource type.
static ns_conf[]	get(nitro_service client) Get ns.conf information from NS Instance(s).
void	set_diff_status(String diff_status) Tells whether a diff exists between running and saved configuration on NS
void	set_id(String id) Id is system generated key for all ns.conf files
void	set_last_updated_time(Integer last_updated_time) Last Updated Time
void	set_ns_ip_address(String ns_ip_address) List of NetScaler IP Address
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

ns_conf

public ns_conf()

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_last_updated_time

public void set_last_updated_time(Integer last_updated_time)

 Last Updated Time
 

get_last_updated_time

public Integer get_last_updated_time()

 Last Updated Time
 

get_device_name

public String get_device_name()

 Name of the device
 

set_diff_status

public void set_diff_status(String diff_status)

 Tells whether a diff exists between running and saved configuration on NS
 

get_diff_status

public String get_diff_status()

 Tells whether a diff exists between running and saved configuration on NS
 

set_id

public void set_id(String id)

 Id is system generated key for all ns.conf files
 

get_id

public String get_id()

 Id is system generated key for all ns.conf files
 

set_ns_ip_address

public void set_ns_ip_address(String ns_ip_address)

 List of NetScaler IP Address
 

get_ns_ip_address

public String get_ns_ip_address()

 List of NetScaler IP Address
 

get

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

 Get ns.conf information from NS Instance(s).
 

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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