Java Client Libraries for Nutanix APIs

This project contains steps for installing and using Java Client Libraries for Nutanix APIs grouped together by their namespace. Clients are currently available for the following namespaces.

Namespace	Description
aiops	Manage Nutanix infrastructure using Analysis, Reporting, Capacity Planning, What if Analysis, VM Rightsizing, Troubleshooting, App Discovery, Broad Observability, and Ops Automation through Playbooks.
clustermgmt	Manage Hosts, Clusters, and other Nutanix infrastructure.
datapolicies	Manage Policies for Disaster Recovery and Storage.
dataprotection	Manage business continuity with a full spectrum of disaster recovery and backup solutions to manage the protection and recovery of entities spanning one or many on-premises and cloud locations.
files	Manage virtual file servers, create and configure shares for client access, protect them using DR and sync policies, provision storage space and administer security controls.
iam	Manage User Identity and Access.
licensing	Manage licenses for your clusters and Prism Central, get information on applied licenses, license compliance details and feature entitlements.
lcm	Deprecated: Manage Infrastructure, Software and Firmware Upgrades.
lifecycle	Manage Infrastructure, Software and Firmware Upgrades.
microseg	Manage Network Security Policy configuration on Nutanix clusters. Configure and get details of service-groups, address-groups, ID based security.
monitoring	Manage Alerts, Alert policies, Events and Audits.
multidomain	Manage all Nutanix services running on the Nutanix Cloud Platform (NCP) deployed in on-prem data centers ,Nutanix Cloud Clusters (NC2) or edge sites.
networking	Manage networking configuration on Nutanix clusters, including AHV and advanced networking.
objects	Manage Nutanix Object Store Service.
opsmgmt	Manage shared functionality common in the aiops, devops, secops, and finops domains.
prism	Manage Tasks, Category Associations and Submit Batch Operations.
security	Manage security features, such as encryption, certificates, or platform hardening.
storage	Deprecated: Manages volume groups and storage containers in Nutanix cluster.
vmm	Manage the life-cycle of virtual machines hosted on Nutanix clusters.
volumes	Manage volume groups in Nutanix clusters.

Project Structure

Project contains a top level directory corresponding to each namespace as listed above. Each namespace directory contains a README with instructions for getting started with that client.

Getting Started

The libraries are distributed on Maven Central. In order to add it as a dependency, please do the following:

Using Maven

In order to use the aiops java client

<dependency>
  <groupId>com.nutanix.api</groupId>
  <artifactId>aiops-java-client</artifactId>
  <version>4.2.1-beta-1</version>
</dependency>

and to use the vmm java client

<dependency>
  <groupId>com.nutanix.api</groupId>
  <artifactId>vmm-java-client</artifactId>
  <version>4.2.1</version>
</dependency>

and so on...

Using Gradle

In order to use the aiops java client

dependencies {
    implementation("com.nutanix.api:aiops-java-client:4.2.1-beta-1")
}

and to use the vmm java client

dependencies {
    implementation("com.nutanix.api:vmm-java-client:4.2.1")
}

and so on...

and consume them as:

import com.nutanix.aio.java.client.ApiClient;

public class Sample {
  public void configureClient() {
    ApiClient client = new ApiClient();
    client.setHost("10.19.50.27"); // IPv4/IPv6 address or FQDN of the cluster
    client.setPort(9440); // Port to which to connect to
    client.setUsername("admin"); // UserName to connect to the cluster
    client.setPassword("password"); // Password to connect to the cluster
  }
}

For detailed instructions on installing individual clients, please refer to the README documentation for the respective clients in the namespace directories.

API Reference

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

License

This library is licensed under Apache 2.0 license. Full license text is available in LICENSE.

Contact us

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