@nutanix-scratch/microseg-js-client v4.0.1-alpha.1

Javascript Client For Nutanix Microseg Versioned APIs

The Javascript client for Nutanix Microseg Versioned APIs is designed for Javascript client application developers offering them simple and flexible access to APIs that manage Network Security Policy configuration of Nutanix clusters.

Features

• Invoke Nutanix APIs with a simple interface.
• Handle Authentication seamlessly.
• Reduce boilerplate code implementation.
• Use standard methods for installation.

Version

• API version: v4.0.a1
• Package version: 4.0.1-alpha.1

Requirements.

Node.JS 14, 15, 16, 17 and 18 are fully supported and tested.

Installation & Usage

Installation

This library is distributed on npm. In order to add it as a dependency, run the following command:

$ npm install @nutanix-api/microseg-js-client

Configuration

The javascript client for Nutanix Microseg Versioned APIs can be configured with the following parameters

This module can be used in the CommonJS (CJS) , ECMAScript6(ES6) and Universal Module Definition(UMD) syntax While using the module in browser frameworks like React or Vue.JS , you can use import/export. Older Node.js versions can continue to use the require ().

For CommonJs:

const sdk = require("@nutanix-api/microseg-js-client/dist/lib/index");
let client = new sdk.ApiClient();

For ES6 modules:

import ApiClient from "@nutanix-api/microseg-js-client/dist/es/ApiClient";

Sample Configuration

import ApiClient from "@nutanix-api/microseg-js-client/dist/es/ApiClient";

let client = new ApiClient();
client.host = '10.19.50.27'; // IPv4/IPv6 address or FQDN of the cluster
client.port = 9440; // Port to which to connect to
client.username = 'admin'; // UserName to connect to the cluster
client.password = 'password'; // Password to connect to the cluster

Authentication

Nutanix APIs currently support HTTP Basic Authentication only, and the client can be configured using the username and password parameters to send Basic headers along with every request.

Retry Mechanism

The client can be configured to retry requests that fail with the following status codes. The numbers of seconds before which the next retry is attempted is determined by the retryInterval:

• 408 - Request Timeout
• 502 - Bad Gateway
• 503 - Service Unavailable

import ApiClient from "@nutanix-api/microseg-js-client/dist/es/ApiClient";

let client = new ApiClient();
client.maxRetryAttempts = 5 // Max retry attempts while reconnecting on a loss of connection
client.retryInterval = 5000 // Interval in ms to use during retry attempts

Usage

Invoking an operation

import ApiClient from "@nutanix-api/microseg-js-client/dist/es/ApiClient";
import AddressGroupsApi from "@nutanix-api/microseg-js-client/dist/es/apis/addressgroups-endpoints";
// Configure the client
// ...
let client = new ApiClient();
// Initialize the API
let addressGroupsApi = new AddressGroupsApi(client);
let extId = "string_sample_data";

addressGroupsApi.getAddressGroupByExtId(extId).then(({data, response}) => {
    console.log(`API returned the following status code: ${response.status}`);
}).catch((err) =>  {
    console.log(`Error is: ${err}`);
});

Request Options

The library provides the ability to specify additional options that can be applied directly on the 'ApiClient' object used to make network calls to the API. The library also provides a mechanism to specify operation specific headers.

Client headers

The 'ApiClient' can be configured to send additional headers on each request.

import ApiClient from "@nutanix-api/microseg-js-client/dist/es/ApiClient";

let client = new ApiClient();
client.addDefaultHeader('Accept-Encoding','gzip, deflate, br');

You can also modify the headers sent with each individual operation:

Operation specific headers

Nutanix APIs require that concurrent updates are protected using ETag headers. This would mean that the ETag header received in the response of a fetch (GET) operation should be used as an If-Match header for the modification (PUT) operation.

import ApiClient from "@nutanix-api/microseg-js-client/dist/es/ApiClient";
import AddressGroupsApi from "@nutanix-api/microseg-js-client/dist/es/apis/addressgroups-endpoints";
// Configure the client
// ...
let client = new ApiClient();
// Initialize the API
let addressGroupsApi = new AddressGroupsApi(client);
let extId = "string_sample_data";

// Perform Get call
addressGroupsApi.getAddressGroupByExtId(extId).then(({data, response}) => {
console.log(`API returned the following status code: ${response.status}`);
// Extract E-Tag Header
let etagValue = ApiClient.getEtag(data)
// ...
let addressGroup = data.data;
// initialize/change parameters for update

// Perform Update
addressGroupsApi.updateAddressGroupByExtId(addressGroup, extId, {"If-Match" : etagValue}).then(({data, response}) => {
    console.log(`API returned the following status code: ${response.status}`);
}).catch((err) => {
    console.log(`Error is: ${err}`);
});

List Operations

List Operations for Nutanix APIs support pagination, filtering, sorting and projections. The table below details the parameters that can be used to set the options for pagination etc.

List Options can be passed to list operations in order to perform pagination, filtering etc.

import ApiClient from "@nutanix-api/microseg-js-client/dist/es/ApiClient";
import AddressGroupsApi from "@nutanix-api/microseg-js-client/dist/es/apis/addressgroups-endpoints";
// Configure the client
// ...
let client = new ApiClient();
// Initialize the API
let addressGroupsApi = new AddressGroupsApi(client);

//Construct List Options
var listOptions = new Object();
listOptions.page = 0;
listOptions.limit = 50;

addressGroupsApi.listAddressGroups(listOptions).then(({data, response}) => {
    console.log(`API returned the following status code: ${response.status}`);
}).catch((err) =>  {
    console.log(`Error is: ${err}`);
});

The list of filterable and sortable fields with expansion keys can be found in the documentation here.

API Reference

This library has a full set of API Reference Documentation. This documentation is auto-generated, and the location may change.

License

This library is licensed under Nutanix proprietary license. Full license text is available in LICENSE.

Contact us

In case of issues please reach out to us at the mailing list