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

Class ns_configtemplate

java.lang.Object

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

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

public class ns_configtemplate
extends base_resource

Configuration for NetScaler configuration template 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_configtemplate()

Method Summary

Methods

Modifier and Type	Method and Description
static ns_configtemplate	add(nitro_service client, ns_configtemplate resource) Use this operation to add NetScaler configuration template.
static ns_configtemplate[]	add(nitro_service client, ns_configtemplate[] resources) Use this operation to add NetScaler configuration template in bulk.
static long	count_filtered(nitro_service service, filtervalue[] filter) Use this API to count the filtered set of ns_configtemplate resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of ns_configtemplate resources.
static long	count(nitro_service service) Use this API to count the ns_configtemplate resources configured on NetScaler SDX.
static ns_configtemplate	delete(nitro_service client, ns_configtemplate resource) Use this operation to delete NetScaler configuration template.
static ns_configtemplate[]	delete(nitro_service client, ns_configtemplate[] resources) Use this operation to delete NetScaler configuration template in bulk.
ns_command[]	get_commands() NS Configuration Commands
String	get_description() Template Description
static ns_configtemplate[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of ns_configtemplate resources.
static ns_configtemplate[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of ns_configtemplate resources.
String	get_id() Id is system generated key for all the system users
Integer	get_last_updated_time() Last Updated Time
String	get_name() Name of the configuration template
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_template_create_user() User who created the template
static ns_configtemplate[]	get(nitro_service client) Get netscaler configuration templates.
static ns_configtemplate	get(nitro_service client, ns_configtemplate resource) Get netscaler configuration templates.
static ns_configtemplate	modify(nitro_service client, ns_configtemplate resource) Use this operation to modify NetScaler configuration template.
static ns_configtemplate[]	modify(nitro_service client, ns_configtemplate[] resources) Use this operation to modify NetScaler configuration template in bulk.
void	set_commands(ns_command[] commands) NS Configuration Commands
void	set_description(String description) Template Description
void	set_id(String id) Id is system generated key for all the system users
void	set_last_updated_time(Integer last_updated_time) Last Updated Time
void	set_name(String name) Name of the configuration template
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_configtemplate

public ns_configtemplate()

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_template_create_user

public String get_template_create_user()

 User who created the template
 

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
 

set_commands

public void set_commands(ns_command[] commands)

 NS Configuration Commands
 

get_commands

public ns_command[] get_commands()

 NS Configuration Commands
 

set_name

public void set_name(String name)

 Name of the configuration template
 

get_name

public String get_name()

 Name of the configuration template
 

set_id

public void set_id(String id)

 Id is system generated key for all the system users
 

get_id

public String get_id()

 Id is system generated key for all the system users
 

set_description

public void set_description(String description)

 Template Description
 

get_description

public String get_description()

 Template Description
 

add

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

 Use this operation to add NetScaler configuration template.
 

Throws:

Exception

add

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

 Use this operation to add NetScaler configuration template in bulk.
 

Throws:

Exception

delete

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

 Use this operation to delete NetScaler configuration template.
 

Throws:

Exception

delete

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

 Use this operation to delete NetScaler configuration template in bulk.
 

Throws:

Exception

get

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

 Get netscaler configuration templates.
 

Throws:

Exception

get

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

Get netscaler configuration templates.

Throws:

Exception

modify

public static ns_configtemplate modify(nitro_service client,
                       ns_configtemplate resource)
                                throws Exception

 Use this operation to modify NetScaler configuration template.
 

Throws:

Exception

modify

public static ns_configtemplate[] modify(nitro_service client,
                         ns_configtemplate[] resources)
                                  throws Exception

 Use this operation to modify NetScaler configuration template in bulk.
 

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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