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

Class mps

java.lang.Object

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

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

public class mps
extends base_resource

Configuration for Management Service resource

Field Summary

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

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
mps()

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 mps resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of mps resources.
static long	count(nitro_service service) Use this API to count the mps resources configured on NetScaler SDX.
String	get_bios_version() BIOS Version
String	get_build_number_short() Build Number without Date
String	get_build_number() Build Number
String	get_current_time_formatted() Current Time (Formatted)
Integer	get_current_time() Current Time
String	get_current_user_permission() This property will show the permission type for current user
static mps[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of mps resources.
static mps[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of mps resources.
String	get_host() Host IP Address on which system is running, this will set for each client session only
String	get_hostid() Host Id
String	get_hostname() Host name on which system is running
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_platform() Platform
String	get_product_build_number() Product Build Number
String	get_product_version() Product Version
String	get_product() Product Name
String	get_serial() Serial Number
String	get_sysid() Serial Number
String	get_uptime() Uptime
String	get_username() User Name who is currently connected to the system
static mps	get(nitro_service client) Use this operation to get Management Service Information.
static mps	reboot(nitro_service client, mps resource) Use this operation to reboot Management Service.
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

mps

public mps()

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_build_number_short

public String get_build_number_short()

 Build Number without Date
 

get_current_time

public Integer get_current_time()

 Current Time
 

get_sysid

public String get_sysid()

 Serial Number
 

get_hostname

public String get_hostname()

 Host name on which system is running
 

get_bios_version

public String get_bios_version()

 BIOS Version
 

get_hostid

public String get_hostid()

 Host Id
 

get_product_version

public String get_product_version()

 Product Version
 

get_uptime

public String get_uptime()

 Uptime
 

get_current_user_permission

public String get_current_user_permission()

 This property will show the permission type for current user
 

get_platform

public String get_platform()

 Platform
 

get_product_build_number

public String get_product_build_number()

 Product Build Number
 

get_serial

public String get_serial()

 Serial Number
 

get_host

public String get_host()

 Host IP Address on which system is running, this will set for each client session only
 

get_username

public String get_username()

 User Name who is currently connected to the system
 

get_current_time_formatted

public String get_current_time_formatted()

 Current Time (Formatted)
 

get_build_number

public String get_build_number()

 Build Number
 

get_product

public String get_product()

 Product Name
 

reboot

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

 Use this operation to reboot Management Service.
 

Throws:

Exception

get

public static mps get(nitro_service client)
               throws Exception

Use this operation to get Management Service Information.

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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