Skip to content

ManageIQ/nutanix_clustermgmt-sdk-ruby

BranchesTags

Repository files navigation

nutanix_clustermgmt

NutanixClustermgmt - the Ruby gem for the Nutanix Cluster Management APIs

Manage Hosts, Clusters and other Infrastructure.

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 4.0.2
  • Package version: 1.0.0
  • Generator version: 7.9.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build nutanix_clustermgmt.gemspec

Then either install the gem locally:

gem install ./nutanix_clustermgmt-1.0.0.gem

(for development, run gem install --dev ./nutanix_clustermgmt-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'nutanix_clustermgmt', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'nutanix_clustermgmt', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'nutanix_clustermgmt'

# Setup authorization
NutanixClustermgmt.configure do |config|
  # Configure API key authorization: apiKeyAuthScheme
  config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'

  # Configure HTTP basic authorization: basicAuthScheme
  config.username = 'YOUR_USERNAME'
  config.password = 'YOUR_PASSWORD'
end

api_instance = NutanixClustermgmt::BmcApi.new
cluster_ext_id = '960de8e0-115b-4bb8-b263-e69bd907a6f4' # String | Cluster UUID
ext_id = '9241b35f-1ba4-4f8a-b6a1-9ee30de274c6' # String | Host UUID

begin
  #Get BMC details
  result = api_instance.get_bmc_info(cluster_ext_id, ext_id)
  p result
rescue NutanixClustermgmt::ApiError => e
  puts "Exception when calling BmcApi->get_bmc_info: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://:9440/api

Class Method HTTP request Description
NutanixClustermgmt::BmcApi get_bmc_info GET /clustermgmt/v4.0/config/clusters/{clusterExtId}/hosts/{extId}/bmc-info Get BMC details
NutanixClustermgmt::BmcApi update_bmc_info PUT /clustermgmt/v4.0/config/clusters/{clusterExtId}/hosts/{extId}/bmc-info Update BMC info summary
NutanixClustermgmt::ClusterProfilesApi apply_cluster_profile POST /clustermgmt/v4.0/config/cluster-profiles/{extId}/$actions/apply Apply cluster profile
NutanixClustermgmt::ClusterProfilesApi create_cluster_profile POST /clustermgmt/v4.0/config/cluster-profiles Create a cluster profile
NutanixClustermgmt::ClusterProfilesApi delete_cluster_profile_by_id DELETE /clustermgmt/v4.0/config/cluster-profiles/{extId} Delete cluster profile
NutanixClustermgmt::ClusterProfilesApi disassociate_cluster_from_cluster_profile POST /clustermgmt/v4.0/config/cluster-profiles/{extId}/$actions/disassociate-cluster Disassociate cluster from a cluster profile
NutanixClustermgmt::ClusterProfilesApi get_cluster_profile_by_id GET /clustermgmt/v4.0/config/cluster-profiles/{extId} Get cluster profile
NutanixClustermgmt::ClusterProfilesApi list_cluster_profiles GET /clustermgmt/v4.0/config/cluster-profiles List cluster profiles
NutanixClustermgmt::ClusterProfilesApi update_cluster_profile_by_id PUT /clustermgmt/v4.0/config/cluster-profiles/{extId} Update cluster profile
NutanixClustermgmt::ClustersApi add_snmp_transport POST /clustermgmt/v4.0/config/clusters/{clusterExtId}/snmp/$actions/add-transports Add SNMP transport ports and protocol details
NutanixClustermgmt::ClustersApi associate_categories_to_cluster POST /clustermgmt/v4.0/config/clusters/{clusterExtId}/$actions/associate-categories Associate categories to the cluster
NutanixClustermgmt::ClustersApi check_hypervisor_requirements POST /clustermgmt/v4.0/config/clusters/{clusterExtId}/$actions/check-hypervisor-requirements Get hypervisor ISO upload information
NutanixClustermgmt::ClustersApi create_cluster POST /clustermgmt/v4.0/config/clusters Create a cluster
NutanixClustermgmt::ClustersApi create_rsyslog_server POST /clustermgmt/v4.0/config/clusters/{clusterExtId}/rsyslog-servers Add RSYSLOG server configuration
NutanixClustermgmt::ClustersApi create_snmp_trap POST /clustermgmt/v4.0/config/clusters/{clusterExtId}/snmp/traps Add SNMP trap
NutanixClustermgmt::ClustersApi create_snmp_user POST /clustermgmt/v4.0/config/clusters/{clusterExtId}/snmp/users Add SNMP user
NutanixClustermgmt::ClustersApi delete_cluster_by_id DELETE /clustermgmt/v4.0/config/clusters/{extId} Delete a cluster
NutanixClustermgmt::ClustersApi delete_rsyslog_server_by_id DELETE /clustermgmt/v4.0/config/clusters/{clusterExtId}/rsyslog-servers/{extId} Delete RSYSLOG server configuration
NutanixClustermgmt::ClustersApi delete_snmp_trap_by_id DELETE /clustermgmt/v4.0/config/clusters/{clusterExtId}/snmp/traps/{extId} Delete SNMP trap
NutanixClustermgmt::ClustersApi delete_snmp_user_by_id DELETE /clustermgmt/v4.0/config/clusters/{clusterExtId}/snmp/users/{extId} Delete SNMP user
NutanixClustermgmt::ClustersApi disassociate_categories_from_cluster POST /clustermgmt/v4.0/config/clusters/{clusterExtId}/$actions/disassociate-categories Disassociate categories from the cluster
NutanixClustermgmt::ClustersApi discover_unconfigured_nodes POST /clustermgmt/v4.0/config/clusters/{clusterExtId}/$actions/discover-unconfigured-nodes Discover unconfigured nodes
NutanixClustermgmt::ClustersApi enter_host_maintenance POST /clustermgmt/v4.0/operations/clusters/{clusterExtId}/hosts/{extId}/$actions/enter-host-maintenance Enter host into maintenance mode
NutanixClustermgmt::ClustersApi exit_host_maintenance POST /clustermgmt/v4.0/operations/clusters/{clusterExtId}/hosts/{extId}/$actions/exit-host-maintenance Exit host from maintenance mode
NutanixClustermgmt::ClustersApi expand_cluster POST /clustermgmt/v4.0/config/clusters/{clusterExtId}/$actions/expand-cluster Add node on a cluster
NutanixClustermgmt::ClustersApi fetch_node_networking_details POST /clustermgmt/v4.0/config/clusters/{clusterExtId}/$actions/fetch-node-networking-details Get network information of unconfigured nodes
NutanixClustermgmt::ClustersApi fetch_task_response GET /clustermgmt/v4.0/config/task-response/{extId} Get task response based on the type of request
NutanixClustermgmt::ClustersApi get_cluster_by_id GET /clustermgmt/v4.0/config/clusters/{extId} Get details of a cluster
NutanixClustermgmt::ClustersApi get_cluster_stats GET /clustermgmt/v4.0/stats/clusters/{extId} Get cluster statistics
NutanixClustermgmt::ClustersApi get_host_by_id GET /clustermgmt/v4.0/config/clusters/{clusterExtId}/hosts/{extId} Get the details of host associated with the cluster
NutanixClustermgmt::ClustersApi get_host_nic_by_id GET /clustermgmt/v4.0/config/clusters/{clusterExtId}/hosts/{hostExtId}/host-nics/{extId} Get host NIC
NutanixClustermgmt::ClustersApi get_host_stats GET /clustermgmt/v4.0/stats/clusters/{clusterExtId}/hosts/{extId} Get host statistics
NutanixClustermgmt::ClustersApi get_rackable_unit_by_id GET /clustermgmt/v4.0/config/clusters/{clusterExtId}/rackable-units/{extId} Get the rackable unit details
NutanixClustermgmt::ClustersApi get_rsyslog_server_by_id GET /clustermgmt/v4.0/config/clusters/{clusterExtId}/rsyslog-servers/{extId} Get RSYSLOG server configuration
NutanixClustermgmt::ClustersApi get_snmp_config_by_cluster_id GET /clustermgmt/v4.0/config/clusters/{clusterExtId}/snmp Get SNMP config details of a cluster
NutanixClustermgmt::ClustersApi get_snmp_trap_by_id GET /clustermgmt/v4.0/config/clusters/{clusterExtId}/snmp/traps/{extId} Get SNMP trap configuration details
NutanixClustermgmt::ClustersApi get_snmp_user_by_id GET /clustermgmt/v4.0/config/clusters/{clusterExtId}/snmp/users/{extId} Get SNMP user information
NutanixClustermgmt::ClustersApi get_virtual_nic_by_id GET /clustermgmt/v4.0/config/clusters/{clusterExtId}/hosts/{hostExtId}/virtual-nics/{extId} Get virtual NIC
NutanixClustermgmt::ClustersApi list_clusters GET /clustermgmt/v4.0/config/clusters Get the list of clusters
NutanixClustermgmt::ClustersApi list_host_nics_by_host_id GET /clustermgmt/v4.0/config/clusters/{clusterExtId}/hosts/{hostExtId}/host-nics Get the list of host NICs
NutanixClustermgmt::ClustersApi list_hosts GET /clustermgmt/v4.0/config/hosts Get the list of all host entities
NutanixClustermgmt::ClustersApi list_hosts_by_cluster_id GET /clustermgmt/v4.0/config/clusters/{clusterExtId}/hosts Get the list of hosts associated with a cluster
NutanixClustermgmt::ClustersApi list_physical_gpu_profiles GET /clustermgmt/v4.0/config/clusters/{clusterExtId}/physical-gpu-profiles List Physical GPU profiles.
NutanixClustermgmt::ClustersApi list_rackable_units_by_cluster_id GET /clustermgmt/v4.0/config/clusters/{clusterExtId}/rackable-units Get the list of rackable units
NutanixClustermgmt::ClustersApi list_rsyslog_servers_by_cluster_id GET /clustermgmt/v4.0/config/clusters/{clusterExtId}/rsyslog-servers Get the list of RSYSLOG server configurations
NutanixClustermgmt::ClustersApi list_virtual_gpu_profiles GET /clustermgmt/v4.0/config/clusters/{clusterExtId}/virtual-gpu-profiles List Virtual GPU profiles.
NutanixClustermgmt::ClustersApi list_virtual_nics_by_host_id GET /clustermgmt/v4.0/config/clusters/{clusterExtId}/hosts/{hostExtId}/virtual-nics Get the list of virtual NICs
NutanixClustermgmt::ClustersApi remove_node POST /clustermgmt/v4.0/config/clusters/{clusterExtId}/$actions/remove-node Remove nodes from the cluster
NutanixClustermgmt::ClustersApi remove_snmp_transport POST /clustermgmt/v4.0/config/clusters/{clusterExtId}/snmp/$actions/remove-transports Remove SNMP transport ports and protocol details
NutanixClustermgmt::ClustersApi update_cluster_by_id PUT /clustermgmt/v4.0/config/clusters/{extId} Update cluster
NutanixClustermgmt::ClustersApi update_rsyslog_server_by_id PUT /clustermgmt/v4.0/config/clusters/{clusterExtId}/rsyslog-servers/{extId} Update RSYSLOG server configuration
NutanixClustermgmt::ClustersApi update_snmp_status POST /clustermgmt/v4.0/config/clusters/{clusterExtId}/snmp/$actions/update-status Update SNMP status
NutanixClustermgmt::ClustersApi update_snmp_trap_by_id PUT /clustermgmt/v4.0/config/clusters/{clusterExtId}/snmp/traps/{extId} Update SNMP trap
NutanixClustermgmt::ClustersApi update_snmp_user_by_id PUT /clustermgmt/v4.0/config/clusters/{clusterExtId}/snmp/users/{extId} Update SNMP user
NutanixClustermgmt::ClustersApi validate_node POST /clustermgmt/v4.0/config/clusters/{clusterExtId}/$actions/validate-node Validates hypervisor bundle and node uplinks
NutanixClustermgmt::DisksApi add_disk POST /clustermgmt/v4.0/config/clusters/{extId}/$actions/add-disk Adds Disk to a cluster
NutanixClustermgmt::DisksApi delete_disk_by_id DELETE /clustermgmt/v4.0/config/disks/{extId} Removes Disk from a cluster
NutanixClustermgmt::DisksApi get_disk_by_id GET /clustermgmt/v4.0/config/disks/{extId} Get Disk by its external identifier
NutanixClustermgmt::DisksApi get_disk_stats GET /clustermgmt/v4.0/stats/disks/{extId} Get stats for the existing Disk
NutanixClustermgmt::DisksApi list_disks GET /clustermgmt/v4.0/config/disks Get Disks for all the clusters
NutanixClustermgmt::PcieDevicesApi list_pcie_devices GET /clustermgmt/v4.0/ahv/config/pcie-devices Fetch the PCIe devices
NutanixClustermgmt::StorageContainersApi create_storage_container POST /clustermgmt/v4.0/config/storage-containers Create a Storage Container
NutanixClustermgmt::StorageContainersApi delete_storage_container_by_id DELETE /clustermgmt/v4.0/config/storage-containers/{extId} Delete a Storage Container
NutanixClustermgmt::StorageContainersApi get_storage_container_by_id GET /clustermgmt/v4.0/config/storage-containers/{extId} Get Storage Container configuration
NutanixClustermgmt::StorageContainersApi get_storage_container_stats GET /clustermgmt/v4.0/stats/storage-containers/{extId} Get Stats for a Storage Container
NutanixClustermgmt::StorageContainersApi list_data_stores_by_cluster_id GET /clustermgmt/v4.0/config/clusters/{clusterExtId}/storage-containers/datastores List datastores of a cluster
NutanixClustermgmt::StorageContainersApi list_storage_containers GET /clustermgmt/v4.0/config/storage-containers List Storage Containers
NutanixClustermgmt::StorageContainersApi mount_storage_container POST /clustermgmt/v4.0/config/storage-containers/{extId}/$actions/mount Mount Storage Container on ESX datastore
NutanixClustermgmt::StorageContainersApi unmount_storage_container POST /clustermgmt/v4.0/config/storage-containers/{extId}/$actions/unmount Unmount Storage Container from ESX datastore
NutanixClustermgmt::StorageContainersApi update_storage_container_by_id PUT /clustermgmt/v4.0/config/storage-containers/{extId} Update a Storage Container
NutanixClustermgmt::VcenterExtensionsApi get_vcenter_extension_by_id GET /clustermgmt/v4.0/config/vcenter-extensions/{extId} Get vCenter server extension.
NutanixClustermgmt::VcenterExtensionsApi list_vcenter_extensions GET /clustermgmt/v4.0/config/vcenter-extensions List vCenter server extensions.
NutanixClustermgmt::VcenterExtensionsApi register_vcenter_extension POST /clustermgmt/v4.0/config/vcenter-extensions/{extId}/$actions/register Register vCenter server extension.
NutanixClustermgmt::VcenterExtensionsApi unregister_vcenter_extension POST /clustermgmt/v4.0/config/vcenter-extensions/{extId}/$actions/unregister Unregister vCenter server extension.

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

basicAuthScheme

  • Type: HTTP basic authentication

apiKeyAuthScheme

  • Type: API key
  • API key parameter name: X-ntnx-api-key
  • Location: HTTP header

About

NutanixClustermgmt - the Ruby gem for the Nutanix Cluster Management APIs

Resources

Readme

License

Apache-2.0 license

Code of conduct

Code of conduct

Security policy

Security policy
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

2 forks
Report repository

Releases

1 tags

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages