Skip to content

ManageIQ/nutanix_vmm-sdk-ruby

nutanix_vmm

NutanixVmm - the Ruby gem for the Nutanix Virtual Machine Management APIs

Manage the life-cycle of virtual machines hosted on Nutanix

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 4.0
  • 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_vmm.gemspec

Then either install the gem locally:

gem install ./nutanix_vmm-1.0.0.gem

(for development, run gem install --dev ./nutanix_vmm-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_vmm', '~> 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_vmm', :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_vmm'

# Setup authorization
NutanixVmm.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 = NutanixVmm::EsxiStatsApi.new
vm_ext_id = 'cc291767-b6b3-4cb4-8c71-33f55934ae4c' # String | This field specifies the VM external ID when retrieving the stats for a given VM Disk.
ext_id = '04fb3f68-3141-4d46-bbd5-4608dc2c4f53' # String | This field specifies the VM external ID when retrieving the stats for a given VM Disk.
start_time = Time.parse('2009-09-23T14:30-07:00') # Time | The start time of the period for which stats should be reported. The value should be in extended ISO-8601 format. For example, start time of 2022-04-23T01:23:45.678+09:00 would consider all stats starting at 1:23:45.678 on the 23rd of April 2022. Details around ISO-8601 format can be found at https://www.iso.org/standard/70907.html 
end_time = Time.parse('2009-09-23T14:30-07:00') # Time | The end time of the period for which stats should be reported. The value should be in extended ISO-8601 format. For example, end time of 2022-04-23T013:23:45.678+09:00 would consider all stats till 13:23:45 .678 on the 23rd of April 2022. Details around ISO-8601 format can be found at https://www.iso.org/standard/70907.html 
opts = {
  sampling_interval: 83, # Integer | The sampling interval in seconds at which statistical data should be collected. For example, if you want performance statistics every 30 seconds, then provide the value as 30. 
  stat_type: NutanixVmm::CommonV10StatsDownSamplingOperator::SUM, # CommonV10StatsDownSamplingOperator | 
  select: 'select_example' # String | A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. - extId - links - stats - tenantId - vmExtId 
}

begin
  #Get the stats for the specified VM disk
  result = api_instance.get_disk_stats_by_id(vm_ext_id, ext_id, start_time, end_time, opts)
  p result
rescue NutanixVmm::ApiError => e
  puts "Exception when calling EsxiStatsApi->get_disk_stats_by_id: #{e}"
end

Documentation for API Endpoints

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

Class Method HTTP request Description
NutanixVmm::EsxiStatsApi get_disk_stats_by_id GET /vmm/v4.0/esxi/stats/vms/{vmExtId}/disks/{extId} Get the stats for the specified VM disk
NutanixVmm::EsxiStatsApi get_nic_stats_by_id GET /vmm/v4.0/esxi/stats/vms/{vmExtId}/nics/{extId} Get the stats for the specified VM NIC
NutanixVmm::EsxiStatsApi get_vm_stats_by_id GET /vmm/v4.0/esxi/stats/vms/{extId} Get VM stats for a given VM
NutanixVmm::EsxiStatsApi list_vm_stats GET /vmm/v4.0/esxi/stats/vms List VM stats for all VMs
NutanixVmm::EsxiVmApi assign_vm_owner POST /vmm/v4.0/esxi/config/vms/{extId}/$actions/assign-owner Assign owner of a VM
NutanixVmm::EsxiVmApi associate_categories POST /vmm/v4.0/esxi/config/vms/{extId}/$actions/associate-categories Associate categories to a VM
NutanixVmm::EsxiVmApi disassociate_categories POST /vmm/v4.0/esxi/config/vms/{extId}/$actions/disassociate-categories Disassociate categories from a VM
NutanixVmm::EsxiVmApi get_nutanix_guest_tools_by_id GET /vmm/v4.0/esxi/config/vms/{extId}/nutanix-guest-tools Get VM NGT configuration
NutanixVmm::EsxiVmApi get_vm_by_id GET /vmm/v4.0/esxi/config/vms/{extId} Get VM configuration details
NutanixVmm::EsxiVmApi insert_nutanix_guest_tools POST /vmm/v4.0/esxi/config/vms/{extId}/nutanix-guest-tools/$actions/insert-iso Insert NGT ISO into an available CD-ROM for a VM
NutanixVmm::EsxiVmApi install_nutanix_guest_tools POST /vmm/v4.0/esxi/config/vms/{extId}/nutanix-guest-tools/$actions/install Install NGT in a VM
NutanixVmm::EsxiVmApi list_vms GET /vmm/v4.0/esxi/config/vms List VMs
NutanixVmm::EsxiVmApi power_off_vm POST /vmm/v4.0/esxi/config/vms/{extId}/$actions/power-off Force power off a VM
NutanixVmm::EsxiVmApi power_on_vm POST /vmm/v4.0/esxi/config/vms/{extId}/$actions/power-on Power on or resume a VM
NutanixVmm::EsxiVmApi reboot_guest_vm POST /vmm/v4.0/esxi/config/vms/{extId}/$actions/guest-reboot Issue an ESXi guest OS reboot command
NutanixVmm::EsxiVmApi reset_vm POST /vmm/v4.0/esxi/config/vms/{extId}/$actions/reset Reset an ESXi VM by sequentially powering it off and on
NutanixVmm::EsxiVmApi revert_vm POST /vmm/v4.0/esxi/config/vms/{extId}/$actions/revert Revert the ESXi VM.
NutanixVmm::EsxiVmApi shutdown_guest_vm POST /vmm/v4.0/esxi/config/vms/{extId}/$actions/guest-shutdown Shut down services on ESXi guest OS
NutanixVmm::EsxiVmApi suspend_vm POST /vmm/v4.0/esxi/config/vms/{extId}/$actions/suspend Pause/Suspend virtual machine execution
NutanixVmm::EsxiVmApi uninstall_nutanix_guest_tools POST /vmm/v4.0/esxi/config/vms/{extId}/nutanix-guest-tools/$actions/uninstall Uninstall NGT from a VM
NutanixVmm::EsxiVmApi update_nutanix_guest_tools_by_id PUT /vmm/v4.0/esxi/config/vms/{extId}/nutanix-guest-tools Update NGT configuration for a VM
NutanixVmm::EsxiVmApi upgrade_nutanix_guest_tools POST /vmm/v4.0/esxi/config/vms/{extId}/nutanix-guest-tools/$actions/upgrade Upgrade NGT inside a VM
NutanixVmm::ImagePlacementPoliciesApi create_placement_policy POST /vmm/v4.0/images/config/placement-policies Create an image placement policy
NutanixVmm::ImagePlacementPoliciesApi delete_placement_policy_by_id DELETE /vmm/v4.0/images/config/placement-policies/{extId} Delete an image placement policy
NutanixVmm::ImagePlacementPoliciesApi get_placement_policy_by_id GET /vmm/v4.0/images/config/placement-policies/{extId} Get an image placement policy
NutanixVmm::ImagePlacementPoliciesApi list_placement_policies GET /vmm/v4.0/images/config/placement-policies List image placement policies
NutanixVmm::ImagePlacementPoliciesApi resume_placement_policy POST /vmm/v4.0/images/config/placement-policies/{extId}/$actions/resume Resume an image placement policy
NutanixVmm::ImagePlacementPoliciesApi suspend_placement_policy POST /vmm/v4.0/images/config/placement-policies/{extId}/$actions/suspend Suspend an image placement policy
NutanixVmm::ImagePlacementPoliciesApi update_placement_policy_by_id PUT /vmm/v4.0/images/config/placement-policies/{extId} Update an image placement policy
NutanixVmm::ImageRateLimitPoliciesApi create_rate_limit_policy POST /vmm/v4.0/images/config/rate-limit-policies Create an image rate limit policy
NutanixVmm::ImageRateLimitPoliciesApi delete_rate_limit_policy_by_id DELETE /vmm/v4.0/images/config/rate-limit-policies/{extId} Delete an image rate limit policy
NutanixVmm::ImageRateLimitPoliciesApi get_rate_limit_policy_by_id GET /vmm/v4.0/images/config/rate-limit-policies/{extId} Get an image rate limit policy
NutanixVmm::ImageRateLimitPoliciesApi list_effective_rate_limit_policies GET /vmm/v4.0/images/config/effective-rate-limit-policies Resolve the effective rate limit for Prism Elements
NutanixVmm::ImageRateLimitPoliciesApi list_rate_limit_policies GET /vmm/v4.0/images/config/rate-limit-policies List image rate limit policies
NutanixVmm::ImageRateLimitPoliciesApi update_rate_limit_policy_by_id PUT /vmm/v4.0/images/config/rate-limit-policies/{extId} Update the image rate limit policy
NutanixVmm::ImagesApi create_image POST /vmm/v4.0/content/images Create an image
NutanixVmm::ImagesApi delete_image_by_id DELETE /vmm/v4.0/content/images/{extId} Delete an image
NutanixVmm::ImagesApi get_file_by_image_id GET /vmm/v4.0/content/images/{imageExtId}/file Download an image
NutanixVmm::ImagesApi get_image_by_id GET /vmm/v4.0/content/images/{extId} Get an image
NutanixVmm::ImagesApi import_image POST /vmm/v4.0/content/images/$actions/import Import images from Prism Element
NutanixVmm::ImagesApi list_images GET /vmm/v4.0/content/images List images
NutanixVmm::ImagesApi update_image_by_id PUT /vmm/v4.0/content/images/{extId} Update an image
NutanixVmm::StatsApi get_disk_stats_by_id_0 GET /vmm/v4.0/ahv/stats/vms/{vmExtId}/disks/{extId} Get the stats for the specified VM disk
NutanixVmm::StatsApi get_nic_stats_by_id_0 GET /vmm/v4.0/ahv/stats/vms/{vmExtId}/nics/{extId} Get the stats for the specified VM NIC
NutanixVmm::StatsApi get_vm_stats_by_id_0 GET /vmm/v4.0/ahv/stats/vms/{extId} Get VM stats for a given VM
NutanixVmm::StatsApi list_vm_stats_0 GET /vmm/v4.0/ahv/stats/vms List VM stats for all VMs
NutanixVmm::TemplatesApi cancel_guest_update POST /vmm/v4.0/content/templates/{extId}/$actions/cancel-guest-update Cancel guest OS update
NutanixVmm::TemplatesApi complete_guest_update POST /vmm/v4.0/content/templates/{extId}/$actions/complete-guest-update Complete guest OS update
NutanixVmm::TemplatesApi create_template POST /vmm/v4.0/content/templates Create template from a VM
NutanixVmm::TemplatesApi delete_template_by_id DELETE /vmm/v4.0/content/templates/{extId} Delete a template and its associated versions
NutanixVmm::TemplatesApi delete_template_version_by_id DELETE /vmm/v4.0/content/templates/{templateExtId}/versions/{extId} Delete a template version
NutanixVmm::TemplatesApi deploy_template POST /vmm/v4.0/content/templates/{extId}/$actions/deploy Deploy VMs from a template
NutanixVmm::TemplatesApi get_template_by_id GET /vmm/v4.0/content/templates/{extId} Get template details
NutanixVmm::TemplatesApi get_template_version_by_id GET /vmm/v4.0/content/templates/{templateExtId}/versions/{extId} Get the template version detail
NutanixVmm::TemplatesApi initiate_guest_update POST /vmm/v4.0/content/templates/{extId}/$actions/initiate-guest-update Initiate guest OS updates
NutanixVmm::TemplatesApi list_template_versions GET /vmm/v4.0/content/templates/{templateExtId}/versions List all versions in a template
NutanixVmm::TemplatesApi list_templates GET /vmm/v4.0/content/templates List all templates
NutanixVmm::TemplatesApi publish_template POST /vmm/v4.0/content/templates/{extId}/$actions/publish Set an active version
NutanixVmm::TemplatesApi update_template_by_id PUT /vmm/v4.0/content/templates/{extId} Update a template
NutanixVmm::VmApi assign_ip_by_id POST /vmm/v4.0/ahv/config/vms/{vmExtId}/nics/{extId}/$actions/assign-ip Assign an IP address to the provided network device
NutanixVmm::VmApi assign_vm_owner_0 POST /vmm/v4.0/ahv/config/vms/{extId}/$actions/assign-owner Assign owner of a VM
NutanixVmm::VmApi associate_categories_0 POST /vmm/v4.0/ahv/config/vms/{extId}/$actions/associate-categories Associate categories to a VM
NutanixVmm::VmApi clone_vm POST /vmm/v4.0/ahv/config/vms/{extId}/$actions/clone Clone a VM
NutanixVmm::VmApi create_cd_rom POST /vmm/v4.0/ahv/config/vms/{vmExtId}/cd-roms Create a CD-ROM device for a VM
NutanixVmm::VmApi create_disk POST /vmm/v4.0/ahv/config/vms/{vmExtId}/disks Create a disk device for a VM
NutanixVmm::VmApi create_gpu POST /vmm/v4.0/ahv/config/vms/{vmExtId}/gpus Attach a GPU device to a VM
NutanixVmm::VmApi create_nic POST /vmm/v4.0/ahv/config/vms/{vmExtId}/nics Create a network device for a VM
NutanixVmm::VmApi create_pcie_device POST /vmm/v4.0/ahv/config/vms/{vmExtId}/pcie-devices Create a PCIe device for a VM
NutanixVmm::VmApi create_serial_port POST /vmm/v4.0/ahv/config/vms/{vmExtId}/serial-ports Create a serial port for a VM
NutanixVmm::VmApi create_vm POST /vmm/v4.0/ahv/config/vms Create a VM
NutanixVmm::VmApi cross_cluster_migrate_vm POST /vmm/v4.0/ahv/config/vms/{extId}/$actions/migrate Migrate a VM across clusters
NutanixVmm::VmApi customize_guest_vm POST /vmm/v4.0/ahv/config/vms/{extId}/$actions/customize-guest Stage guest customization configuration details
NutanixVmm::VmApi delete_cd_rom_by_id DELETE /vmm/v4.0/ahv/config/vms/{vmExtId}/cd-roms/{extId} Remove a CD-ROM device from a VM
NutanixVmm::VmApi delete_disk_by_id DELETE /vmm/v4.0/ahv/config/vms/{vmExtId}/disks/{extId} Removes the specified disk device from a virtual machine.
NutanixVmm::VmApi delete_gpu_by_id DELETE /vmm/v4.0/ahv/config/vms/{vmExtId}/gpus/{extId} Remove a GPU device from a VM
NutanixVmm::VmApi delete_nic_by_id DELETE /vmm/v4.0/ahv/config/vms/{vmExtId}/nics/{extId} Remove a network device from a VM
NutanixVmm::VmApi delete_pcie_device_by_id DELETE /vmm/v4.0/ahv/config/vms/{vmExtId}/pcie-devices/{extId} Remove a PCIe device from a VM
NutanixVmm::VmApi delete_serial_port_by_id DELETE /vmm/v4.0/ahv/config/vms/{vmExtId}/serial-ports/{extId} Remove a serial port from a VM
NutanixVmm::VmApi delete_vm_by_id DELETE /vmm/v4.0/ahv/config/vms/{extId} Delete a VM
NutanixVmm::VmApi disassociate_categories_0 POST /vmm/v4.0/ahv/config/vms/{extId}/$actions/disassociate-categories Disassociate categories from a VM
NutanixVmm::VmApi eject_cd_rom_by_id POST /vmm/v4.0/ahv/config/vms/{vmExtId}/cd-roms/{extId}/$actions/eject Ejects an ISO from the provided CD-ROM device
NutanixVmm::VmApi get_cd_rom_by_id GET /vmm/v4.0/ahv/config/vms/{vmExtId}/cd-roms/{extId} Get configuration details for the provided CD-ROM
NutanixVmm::VmApi get_disk_by_id GET /vmm/v4.0/ahv/config/vms/{vmExtId}/disks/{extId} Get configuration details for the provided disk device
NutanixVmm::VmApi get_gpu_by_id GET /vmm/v4.0/ahv/config/vms/{vmExtId}/gpus/{extId} Get configuration details for the provided GPU device
NutanixVmm::VmApi get_guest_tools_by_id GET /vmm/v4.0/ahv/config/vms/{extId}/guest-tools Get VM NGT configuration
NutanixVmm::VmApi get_nic_by_id GET /vmm/v4.0/ahv/config/vms/{vmExtId}/nics/{extId} Get configuration details for the provided network device
NutanixVmm::VmApi get_pcie_device_by_id GET /vmm/v4.0/ahv/config/vms/{vmExtId}/pcie-devices/{extId} Get configuration details for the provided PCIe device
NutanixVmm::VmApi get_serial_port_by_id GET /vmm/v4.0/ahv/config/vms/{vmExtId}/serial-ports/{extId} Get configuration details for the provided serial port
NutanixVmm::VmApi get_vm_by_id_0 GET /vmm/v4.0/ahv/config/vms/{extId} Get VM configuration details
NutanixVmm::VmApi insert_cd_rom_by_id POST /vmm/v4.0/ahv/config/vms/{vmExtId}/cd-roms/{extId}/$actions/insert Inserts an ISO in the provided CD-ROM device
NutanixVmm::VmApi insert_vm_guest_tools POST /vmm/v4.0/ahv/config/vms/{extId}/guest-tools/$actions/insert-iso Insert NGT ISO into an available CD-ROM for a VM
NutanixVmm::VmApi install_vm_guest_tools POST /vmm/v4.0/ahv/config/vms/{extId}/guest-tools/$actions/install Install NGT in a VM
NutanixVmm::VmApi list_cd_roms_by_vm_id GET /vmm/v4.0/ahv/config/vms/{vmExtId}/cd-roms List CD-ROMs attached to a VM
NutanixVmm::VmApi list_disks_by_vm_id GET /vmm/v4.0/ahv/config/vms/{vmExtId}/disks List disks attached to a VM
NutanixVmm::VmApi list_gpus_by_vm_id GET /vmm/v4.0/ahv/config/vms/{vmExtId}/gpus List GPUs attached to a VM
NutanixVmm::VmApi list_nics_by_vm_id GET /vmm/v4.0/ahv/config/vms/{vmExtId}/nics List network devices attached to a VM
NutanixVmm::VmApi list_pcie_devices_by_vm_id GET /vmm/v4.0/ahv/config/vms/{vmExtId}/pcie-devices List PCIe devices attached to a VM
NutanixVmm::VmApi list_serial_ports_by_vm_id GET /vmm/v4.0/ahv/config/vms/{vmExtId}/serial-ports List serial ports attached to a VM
NutanixVmm::VmApi list_vms_0 GET /vmm/v4.0/ahv/config/vms List VMs
NutanixVmm::VmApi migrate_nic_by_id POST /vmm/v4.0/ahv/config/vms/{vmExtId}/nics/{extId}/$actions/migrate Migrate a network device to another subnet
NutanixVmm::VmApi migrate_vm_disks POST /vmm/v4.0/ahv/config/vms/{extId}/$actions/migrate-vm-disks VmDisk migration between storage containers
NutanixVmm::VmApi migrate_vm_to_host POST /vmm/v4.0/ahv/config/vms/{extId}/$actions/migrate-to-host Host to host VM migration
NutanixVmm::VmApi power_cycle_vm POST /vmm/v4.0/ahv/config/vms/{extId}/$actions/power-cycle Force a power cycle for a VM
NutanixVmm::VmApi power_off_vm_0 POST /vmm/v4.0/ahv/config/vms/{extId}/$actions/power-off Force power off a VM
NutanixVmm::VmApi power_on_vm_0 POST /vmm/v4.0/ahv/config/vms/{extId}/$actions/power-on Turn on a VM
NutanixVmm::VmApi reboot_guest_vm_0 POST /vmm/v4.0/ahv/config/vms/{extId}/$actions/guest-reboot Restart the VM using NGT
NutanixVmm::VmApi reboot_vm POST /vmm/v4.0/ahv/config/vms/{extId}/$actions/reboot Reboot a VM using ACPI
NutanixVmm::VmApi release_ip_by_id POST /vmm/v4.0/ahv/config/vms/{vmExtId}/nics/{extId}/$actions/release-ip Release an assigned IP address from the provided network device
NutanixVmm::VmApi reset_vm_0 POST /vmm/v4.0/ahv/config/vms/{extId}/$actions/reset Reset a VM immediately
NutanixVmm::VmApi revert_vm_0 POST /vmm/v4.0/ahv/config/vms/{extId}/$actions/revert Revert the AHV VM.
NutanixVmm::VmApi shutdown_guest_vm_0 POST /vmm/v4.0/ahv/config/vms/{extId}/$actions/guest-shutdown Shutdown the VM using NGT
NutanixVmm::VmApi shutdown_vm POST /vmm/v4.0/ahv/config/vms/{extId}/$actions/shutdown Shutdown the VM using ACPI
NutanixVmm::VmApi uninstall_vm_guest_tools POST /vmm/v4.0/ahv/config/vms/{extId}/guest-tools/$actions/uninstall Uninstall NGT from a VM
NutanixVmm::VmApi update_disk_by_id PUT /vmm/v4.0/ahv/config/vms/{vmExtId}/disks/{extId} Update the configuration for the provided disk device
NutanixVmm::VmApi update_guest_tools_by_id PUT /vmm/v4.0/ahv/config/vms/{extId}/guest-tools Update NGT configuration for a VM
NutanixVmm::VmApi update_nic_by_id PUT /vmm/v4.0/ahv/config/vms/{vmExtId}/nics/{extId} Update the configuration for the provided network device
NutanixVmm::VmApi update_serial_port_by_id PUT /vmm/v4.0/ahv/config/vms/{vmExtId}/serial-ports/{extId} Update the configuration for the provided serial port
NutanixVmm::VmApi update_vm_by_id PUT /vmm/v4.0/ahv/config/vms/{extId} Update configuration for a VM
NutanixVmm::VmApi upgrade_vm_guest_tools POST /vmm/v4.0/ahv/config/vms/{extId}/guest-tools/$actions/upgrade Upgrade NGT inside a VM
NutanixVmm::VmAntiAffinityPoliciesApi create_vm_anti_affinity_policy POST /vmm/v4.0/ahv/policies/vm-anti-affinity-policies Create VM-VM anti-affinity policy
NutanixVmm::VmAntiAffinityPoliciesApi delete_legacy_vm_anti_affinity_policy_by_id DELETE /vmm/v4.0/ahv/policies/legacy-vm-anti-affinity-policies/{extId} Delete legacy VM-VM anti-affinity policy
NutanixVmm::VmAntiAffinityPoliciesApi delete_vm_anti_affinity_policy_by_id DELETE /vmm/v4.0/ahv/policies/vm-anti-affinity-policies/{extId} Delete VM-VM anti-affinity policy
NutanixVmm::VmAntiAffinityPoliciesApi get_vm_anti_affinity_policy_by_id GET /vmm/v4.0/ahv/policies/vm-anti-affinity-policies/{extId} Get VM-VM anti-affinity policy based on the provided external identifier
NutanixVmm::VmAntiAffinityPoliciesApi list_legacy_vm_anti_affinity_policies GET /vmm/v4.0/ahv/policies/legacy-vm-anti-affinity-policies List legacy VM-VM anti-affinity policies
NutanixVmm::VmAntiAffinityPoliciesApi list_vm_anti_affinity_policies GET /vmm/v4.0/ahv/policies/vm-anti-affinity-policies List VM-VM anti-affinity policies
NutanixVmm::VmAntiAffinityPoliciesApi list_vm_anti_affinity_policy_vm_compliance_states GET /vmm/v4.0/ahv/policies/vm-anti-affinity-policies/{vmAntiAffinityPolicyExtId}/vm-compliance-states List compliance states of VMs in the VM-VM anti-affinity policy based on the provided external identifier
NutanixVmm::VmAntiAffinityPoliciesApi update_vm_anti_affinity_policy_by_id PUT /vmm/v4.0/ahv/policies/vm-anti-affinity-policies/{extId} Update VM-VM anti-affinity policy
NutanixVmm::VmHostAffinityPoliciesApi create_vm_host_affinity_policy POST /vmm/v4.0/ahv/policies/vm-host-affinity-policies Create a new VM-host affinity policy
NutanixVmm::VmHostAffinityPoliciesApi delete_vm_host_affinity_policy_by_id DELETE /vmm/v4.0/ahv/policies/vm-host-affinity-policies/{extId} Delete a VM-host affinity policy
NutanixVmm::VmHostAffinityPoliciesApi get_vm_host_affinity_policy_by_id GET /vmm/v4.0/ahv/policies/vm-host-affinity-policies/{extId} Get the VM-host affinity policy details
NutanixVmm::VmHostAffinityPoliciesApi list_vm_host_affinity_policies GET /vmm/v4.0/ahv/policies/vm-host-affinity-policies List all the VM-Host Affinity policies
NutanixVmm::VmHostAffinityPoliciesApi list_vm_host_affinity_policy_vm_compliance_states GET /vmm/v4.0/ahv/policies/vm-host-affinity-policies/{vmHostAffinityPolicyExtId}/vm-compliance-states List the VM compliance states of the VM-host affinity policy
NutanixVmm::VmHostAffinityPoliciesApi re_enforce_vm_host_affinity_policy_by_id POST /vmm/v4.0/ahv/policies/vm-host-affinity-policies/{extId}/$actions/re-enforce Re-enforce the VM-host affinity policy
NutanixVmm::VmHostAffinityPoliciesApi update_vm_host_affinity_policy_by_id PUT /vmm/v4.0/ahv/policies/vm-host-affinity-policies/{extId} Update the VM-host affinity policy

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

NutanixVmm - the Ruby gem for the Nutanix Virtual Machine Management APIs

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages