Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 38 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,69 +1,76 @@
# 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. |

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 |
|--------------|-----------------------------------------------------------------------------------------------------|
| vmm | Manage the life-cycle of virtual machines hosted on Nutanix clusters. |
| prism | Manage Tasks, Category Associations, Alerts, Alert policies, Events and Audits.|
| clustermgmt | Manage Hosts, Clusters, and other Nutanix infrastructure. |
| aiops | Manage Nutanix infrastructure using Analysis, Reporting, Capacity Planning, What if Analysis, VM Rightsizing, Troubleshooting, App Discovery, Broad Observability, and Ops Automation through Playbooks.|
| storage | Manage Volume Groups and Storage Containers hosted on Nutanix clusters. |
| iam | Manage User Identity and Access. |
| lcm | Manage Infrastructure, Software and Firmware Upgrades. |
| 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.|
| networking | Manage networking configuration on Nutanix clusters, including AHV and advanced networking.|
# 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.
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](https://mvnrepository.com/repos/central). In order to add it as a dependency, please do the following:

#### Using Maven

In order to use the aiops java client
In order to use the aiops java client

```xml
<dependency>
<groupId>com.nutanix.api</groupId>
<artifactId>aiops-java-client</artifactId>
<version>4.0.2-alpha-1</version>
<version>4.2.1-beta-1</version>
</dependency>
```
and to use the vmm client
and to use the vmm java client

```xml
<dependency>
<groupId>com.nutanix.api</groupId>
<artifactId>vmm-java-client</artifactId>
<version>4.0.2-alpha-1</version>
<version>4.2.1</version>
</dependency>
```
and so on...

#### Using Gradle
In order to use the aiops java client

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

and to use the vmm client

```
and to use the vmm java client
```groovy
dependencies {
implementation("com.nutanix.api:vmm-java-client:4.0.1-alpha-1")
implementation("com.nutanix.api:vmm-java-client:4.2.1")
}
```

and so on...


and consume them as:

```java
Expand All @@ -83,16 +90,12 @@ public class Sample {
For detailed instructions on installing individual clients, please refer to the README documentation for the respective clients in the namespace directories.


## Status
These are auto generated Java clients generated from Open API v3.0 yaml specification documents.
Due to the auto-generated nature of these clients, they may contain breaking changes from one release to
the next.

## API Reference
These clients have a full set of [API Reference Documentation](https://developers.nutanix.com/). 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](https://developers.nutanix.com/license).
This library is licensed under Apache 2.0 license. Full license text is available in [LICENSE](https://developers.nutanix.com/license).

## Contact us
In case of issues please reach out to us at the [mailing list](mailto:sdk@nutanix.com).
In case of issues, please reach out to us at the [mailing list](mailto:sdk@nutanix.com).

Loading