NITRO has changed the game of how you manage and monitor your appliance using programmatic APIs. In last couple of blogs we focused on how to use NITRO with NetScaler and saw all the benefits. Last one explained the efficient and effective usage of HTTP query parameters (/blogs/2011/08/11/nitro-apis-dynamic-behavior-using-http-query/). You would be excited to know that same NITRO framework and model works with our SDX appliances as well. Wow such a relief!! 🙂

With SDX appliance the whole configuration, monitoring and management of multiple VPXs running inside could be more complex and tedious if everything has to be done manually. For SDX as well we support the Java and .NET SDK beyond the REST interface. You can use the APIs over HTTP or HTTPS mode of communication depending on how your client wants to communicate.

Similar to NetScaler model SDX NITRO framework supports the resource based concept and there is hierarchical relationship in between these resources. Each resource has an associated URL and it can be accessed using simple browser based access. The format of URL is http://<sdxip>/nitro/v1/config/<resource type>/<resource id>

The core APIs available are towards:

  1. System Management
  2. Configuring Resources
  3. Viewing Statistics
  4. Exception Handling

You can securely login to SDX appliance using NITRO APIs and play around with the session parameters as well. Simple APIs are available for creating resources like provisioning a new NetScaler VPX. You just need to provide the key arguments to the API and fire it to provision a VPX instance. The key arguments are:

  • name“: “NewVpx”,
  • ip_address“: “”,
  • netmask“: “”,
  • gateway“: “”,
  • image_name“: “nsvpx-9.3-45_nc.xva”,
  • memory_total“: 2,
  • throughput“: 1000,
  • pps“: 1000000,
  • feature_license“: “Standard”,
  • nsroot_profile“: “NS_nsroot_profile”,
  • username“: “admin”,
  • password“: “admin”

On the response you get the errorcode, message and all the parameters which were set on this new provisioned instance. Here are some of the useful request you can send across on NITRO layer.

View all NS instances configured

  • http://<sdxip>/nitro/v1/config/ns/

Total number of NetScaler instances running

  • http://<sdxip>/nitro/v1/config/ns?count=yes

View provisioned NetScaler with instance id

  • http://<sdxip>/nitro/v1/config/ns/13111572661870180/

NetScaler VMs in running state

  • http://<sdxip>/nitro/v1/config/ns?filter=vm_state:Running

NetScalers running with Enterprise license

  • http://<sdxip>/nitro/v1/config/ns?filter=feature_license:Enterprise

View Xen Server details

  • http://<sdxip>/nitro/v1/config/xen

View Service VM network configuration

  • http://<sdxip>/nitro/v1/config/sdx_network_config

SDX license

  • http://<sdxip>/nitro/v1/config/sdx_license

Service VM user

  • http://<sdxip>/nitro/v1/config/mpsuser

Service VM sessions

  • http://<sdxip>/nitro/v1/config/mpssession

Generating techsupport file

  • http://<sdxip>/nitro/v1/config/techsupport

CPU details

  • http://<sdxip>/nitro/v1/config/hostcpu

Xen VPX image

  • http://<sdxip>/nitro/v1/config/xen_vpx_image

NetScaler image

  • http://<sdxip>/nitro/v1/config/ns_image

By now you must have realized power of NITRO framework for SDX appliances. This is the way to go !!