Nutanix.VmmSDK 1.0.0

.NET Client For Nutanix Virtual Machine Management APIs

The .NET client for Nutanix Virtual Machine Management APIs is designed for .NET client application developers offering them simple and flexible access to APIs that manage the life-cycle of virtual machines hosted on Nutanix.

Features

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

Version

• API version: v4.2
• Package version: 1.0.0

Version Negotiation

By default, the client negotiates the API version with the server to ensure compatibility. Version negotiation is enabled by default. To disable version negotiation and use a fixed API version, call the DisableVersionNegotiation() method on the ApiClient:

using Nutanix.Vmm.Client;

namespace Sample
{
  class Program
  {
    static void Main(string[] args)
    {
      Configuration _config = new Configuration()
      {
        Host = "10.19.50.27",
        Username = "admin",
        Password = Configuration.CreateSecurePassword("password")
      };

      ApiClient client = new ApiClient(_config);
      client.DisableVersionNegotiation(); // Disables automatic version negotiation
    }
  }
}

When version negotiation is disabled, the client will use the SDK's default API version.

Requirements.

• .NET 8 or higher

Usage

Installation

This library is distributed on Nuget.org. In order to add it as a dependency, please do the following:

In .csproj

<Project Sdk="Microsoft.NET.Sdk">
    <ItemGroup>
        <PackageReference Include="Nutanix.Vmm" Version="1.0.0" />
    </ItemGroup>
</Project>

Configuration

The .NET client for Nutanix Virtual Machine Management APIs can be configured with the following parameters

Sample Configuration

using Nutanix.Vmm.Client;

namespace Sample
{
  class Program
  {
    private static Configuration _config = new Configuration()
    {
      Username = "admin", // UserName to connect to the cluster
      Password = Configuration.CreateSecurePassword("password"), // SecureString password to connect to the cluster
      Host = "10.19.50.27", // IPv4/IPv6 address or FQDN of the cluster
      Port = 9440, // Port to which to connect to
    };

    static void Main(string[] args)
    {
      ApiClient client = new ApiClient(_config);
    }
  }
}

Authentication

Nutanix APIs currently support two type of authentication schemes:

• HTTP Basic Authentication - The .NET client can be configured using the username and password parameters to send Basic headers along with every request.
• API Key Authentication - The .NET client can be configured to set an API key to send "X-ntnx-api-key" header with every request.

  using Nutanix.Vmm.Client;
  
  namespace Sample
  {
    class Program
    {
      static void Main(string[] args)
      {
        Configuration _config = new Configuration();
        _config.AddApiKey("X-ntnx-api-key", "abcde12345");
        ApiClient client = new ApiClient(_config);
      }
    }
  }
  

  Additionally, "X-ntnx-api-key" header can be sent directly to an operation similar to the example explained in Operation specific headers section.

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 power of 2, such as 2, 4, 8, ...

• 408 - Request Timeout
• 429 - Too Many Requests
• 502 - Bad Gateway
• 503 - Service Unavailable

using Nutanix.Vmm.Client;

namespace Sample
{
  class Program
  {
    private static Configuration _config = new Configuration()
    {
      MaxRetryAttempts = 5, // Max retry attempts while reconnecting on a loss of connection
    };

    static void main(string[] args)
    {
      ApiClient client = new ApiClient(_config);
    }
  }
}

Usage

Invoking an operation

using Nutanix.Vmm.Client;
using Nutanix.VmmSDK.Api;
using Nutanix.VmmSDK.Model.Vmm.V4.Content;

namespace Sample
{
  class Program
  {
    // Configure the client
    // ...
    private Configuration _config = new Configuration();

    public void performOperation()
    {
      ApiClient client = new ApiClient(_config);
      ImagesApi imagesApi = new ImagesApi(client);
      String extId = "ae2b15F4-bB60-ab51-EaAD-e4d7ADdd0Be3";
      GetImageApiResponse getImageApiResponse = imagesApi.GetImageById(extId);
    }
  }
}

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.

using Nutanix.Vmm.Client;

namespace Sample
{
  class Program
  {
    static void Main(string[] args)
    {
      Configuration _config = new Configuration();
      ApiClient client = new ApiClient(_config);
      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.

using Nutanix.Vmm.Client;
using Nutanix.VmmSDK.Api;
using Nutanix.VmmSDK.Model.Vmm.V4.Content;

namespace Sample
{
  class Program
  {
    public void performOperation()
    {
      Configuration _config = new Configuration();
      ApiClient client = new ApiClient(_config);
      // perform GET call
      ImagesApi imagesApi = new ImagesApi(client);
      String extId = "ae2b15F4-bB60-ab51-EaAD-e4d7ADdd0Be3";
      GetImageApiResponse getImageApiResponse = imagesApi.GetImageById(extId);
      // Extract E-Tag Header
      string eTagHeader = ApiClient.GetEtag(getImageApiResponse);
      // ...
      // Perform update call with received E-Tag reference
      Image image = (Image) getImageApiResponse.Data;
      // initialize/change parameters for update
      Dictionary<string, object> opts = new Dictionary<string, object>();
      opts["If-Match"] = eTagHeader;
      imagesApi.UpdateImageById(image, extId, , opts);
    }
  }
}

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.

using Nutanix.Vmm.Client;
using Nutanix.VmmSDK.Api;
using Nutanix.VmmSDK.Model.Vmm.V4.Content;

namespace Sample
{
  class Program
  {
    public void performOperation()
    {
      // Configure the client
      // ...
      Configuration _config = new Configuration();
      ApiClient client = new ApiClient(_config);
      ImagesApi imagesApi = new ImagesApi(client);
      int page = 0;
      int limit = 50;
      String filter = "string_sample_data";
      String orderby = "string_sample_data";
      String select = "string_sample_data";
      ListImagesApiResponse listImagesApiResponse = imagesApi.ListImages(page, limit, filter, orderby, select);
    }
  }
}

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 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