public class nitro_service extends Object
| Modifier and Type | Class and Description |
|---|---|
static class |
nitro_service.OnerrorEnum |
| Constructor and Description |
|---|
nitro_service(String ip)
nitro_service class constructor specifying ip.
|
nitro_service(String ip,
ipayload_formatter format)
nitro_service class constructor specifying ip and format.
|
nitro_service(String ip,
ipayload_formatter format,
String protocol)
nitro_service class constructor specifying ip, format and protocol.
|
nitro_service(String ip,
String protocol)
nitro_service class constructor specifying ip and protocol.
|
| Modifier and Type | Method and Description |
|---|---|
void |
clear_session()
Use this API to clear the current session.
|
String |
get_ipaddress()
Gets the IPaddress of the NetScaler SDX.
|
String |
get_onerror()
Gets the onerror status of the MPS Resource.
|
ipayload_formatter |
get_payload_formatter()
Returns payload format.
|
String |
get_protocol()
Gets the protocol.
|
String |
get_sessionid()
Gets the sessionId.
|
String |
get_version()
Gets the nitro version.
|
boolean |
isLogin()
Checks login status.
|
login |
login()
Use this API to login into NetScaler SDX.
|
login |
login(String username,
String password)
Use this API to login into NetScaler SDX.
|
login |
login(String username,
String password,
Integer timeout)
Use this API to login into NetScaler SDX.
|
login |
logout()
Use this API to logout from current session.
|
login |
relogin()
Use this to API to re login into NetScaler SDX.
|
void |
set_credential(String username,
String password)
sets the credentials for the NetScaler SDX.
|
void |
set_onerror(nitro_service.OnerrorEnum val)
Sets the onerror status of the MPS Resources.
|
void |
set_protocol(String protocol)
Sets the protocol.
|
void |
set_sessionid(String id)
sets the session id.
|
void |
set_timeout(int timeout)
sets the credentials for the NetScaler SDX.
|
void |
set_timeout(Integer timeout)
sets the credentials for the NetScaler SDX.
|
public nitro_service(String ip) throws nitro_exception
ip - IPAddress of the NetScaler SDX on which configuration is to be run.nitro_exceptionpublic nitro_service(String ip, String protocol) throws nitro_exception
ip - IPaddress of the NetScaler SDX on which configuration is to be run.protocol - Protocol.nitro_exceptionpublic nitro_service(String ip, ipayload_formatter format) throws nitro_exception
ip - IPAdress of the NetScaler SDX on which configuration is to be run.format - payload format, eg: Json, XMLnitro_exceptionpublic nitro_service(String ip, ipayload_formatter format, String protocol) throws nitro_exception
ip - IPaddress of the NetScaler SDX on which configuration is to be run.format - format wire language to be used. eg: Json, XMLprotocol - Protocol.nitro_exceptionpublic void set_sessionid(String id)
id - session idpublic void set_credential(String username, String password)
username - Username of the NetScaler SDXpassword - Password for the NetScaler SDX.public void set_timeout(int timeout)
timeout - session timeout of the NetScaler SDX. Default is 30 mins.public void set_timeout(Integer timeout)
timeout - session timeout of the NetScaler SDX. Default is 30 mins.public boolean isLogin()
public String get_ipaddress()
public String get_version()
public String get_sessionid()
public String get_protocol()
public void set_protocol(String protocol) throws nitro_exception
protocol - The protocol to be set.nitro_exceptionpublic String get_onerror()
public void set_onerror(nitro_service.OnerrorEnum val)
val - This option is applicable for bulk requests.
possible values: EXIT, CONTINUE.
if set with EXIT: exists on the first encountered error.
if set with CONTINUE: executes all the requests irrespective of individual response status.public ipayload_formatter get_payload_formatter()
public login login() throws Exception
Use this API to login into NetScaler SDX.
nitro_exception - nitro exception is thrown.
Exceptionpublic void clear_session()
public login relogin() throws Exception
Exception - nitro exception is thrown.public login login(String username, String password) throws Exception
username - Usernamepassword - Password for the NetScaler SDX.Exception - nitro exception is thrown.public login login(String username, String password, Integer timeout) throws Exception
username - Usernamepassword - Password for the NetScaler SDX.timeout - timeout for NetScaler SDX session. Default is 30minsException - nitro exception is thrown.Copyright © 2013 Citrix Systems, Inc.. All Rights Reserved.