© 1999-2017 Citrix Systems, Inc. All rights reserved. p.221https://docs.citrix.com
Java SDK
Jan 28 , 2011
System APIs
Updated: 2013-05-13
The first step towards using NITRO is to establish a session with the NetScaler SDX appliance and then authenticate the
session by using the administrator's credentials.
You must create an object of the nitro_service class by specifying the IP address of the appliance and the protocol to
connect to the appliance (HTTP or HTTPS). You then use this object and log on to the appliance by specifying the user
name and the password of the administrator.
Note: You must have a user account on that appliance. The configuration operations that you can perform are limited by
the administrative role assigned to your account.
The following sample code connects to a NetScaler SDX appliance with IP address 10.102.31.16 by using HT TPS protocol:
//Specify the IP address of the appliance and service type
nitro_service nitroservice = new nitro_service ("10.102.31.16", "https");
//Specify the login credentials
nitroservice.login("nsroot", "verysecret");
Note: You must use the nitro_service object in all further NITRO operations on the appliance.
To disconnect from the appliance, invoke the logout() method as follows:
nitroservice.logout();
Configuration APIs
The NITRO protocol can be used to configure resources of the NetScaler SDX appliance.
The APIs to configure a resource are grouped into packages or namespaces that have the format
com.citrix.sdx.nitro.resource.config.<resource_type>. Each of these packages or namespaces contain a class named
<resource_type> that provides the APIs to configure the resource.
For example, the NetScaler resource has the com.citrix.sdx.nitro.resource.config.ns package or namespace.
A resource class provides APIs to perform other operations such as creating a resource, retrieving resource details and
statistics, updating a resource, deleting resources, and performing bulk operations on resources.
Creating a Resource
To create a new resource (for example, a NetScaler instance) on the NetScaler SDX appliance, do the following:
1. Set the value for the required properties of the resource by using the corresponding property name. The result is a
resource object that contains the details required for the resource.
Note: These values are set locally on the client. The values are not reflected on the appliance till the object is uploaded.
2. Upload the resource object to the appliance, using the static add() method.
The following sample code creates a NetScaler instance named "ns_instance" on the NetScaler SDX appliance:
To Next Page
Loading...
Need help?
General
