api

package
v4.0.1-beta.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 16, 2024 License: UNKNOWN not legal advice Imports: 12 Imported by: 0

Documentation

Overview

Api classes for vmm's golang SDK

Api classes for vmm's golang SDK

Api classes for vmm's golang SDK

Api classes for vmm's golang SDK

Api classes for vmm's golang SDK

Api classes for vmm's golang SDK

Api classes for vmm's golang SDK

Api classes for vmm's golang SDK

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type EsxiStatsApi 

type EsxiStatsApi struct {
	ApiClient *client.ApiClient
	// contains filtered or unexported fields
}

func NewEsxiStatsApi 

func NewEsxiStatsApi(apiClient *client.ApiClient) *EsxiStatsApi

func (*EsxiStatsApi) GetVmStatsById 

func (api *EsxiStatsApi) GetVmStatsById(extId *string, startTime_ *string, endTime_ *string, samplingInterval_ *int, statType_ *import1.DownSamplingOperator, select_ *string, args ...map[string]interface{}) (*import2.GetVmStatsApiResponse, error)

Get VM stats for a given VM. Users can include the following in the request query: 1) '$select': comma-separated attributes with the prefix 'stats/', e.g. 'stats/controllerNumIo,stats/hypervisorNumIo'. 2) '$startTime': the start time of the period for which stats should be reported, where the value should be in extended ISO-8601 format, e.g. '2023-01-01T12:00:00.000-08:00'; 3) '$endTime': the end time of the period for which stats should be reported, where the value should be in extended ISO-8601 format; 4) '$samplingInterval': the sampling interval in seconds at which statistical data should be collected; 5) '$statType': the down-sampling operator to use while performing down-sampling on stats data, where the allowed values are SUM, MIN, MAX, AVG, COUNT and LAST.

func (*EsxiStatsApi) ListVmStats 

func (api *EsxiStatsApi) ListVmStats(startTime_ *string, endTime_ *string, samplingInterval_ *int, statType_ *import1.DownSamplingOperator, page_ *int, limit_ *int, filter_ *string, orderby_ *string, select_ *string, args ...map[string]interface{}) (*import2.ListVmStatsApiResponse, error)

List VM stats for all VMs. Users can include the following in the request query: 1) '$select': comma-separated attributes with the prefix 'stats/', e.g. 'stats/controllerNumIo,stats/hypervisorNumIo'. 2) '$startTime': the start time of the period for which stats should be reported, where the value should be in extended ISO-8601 format, e.g. '2023-01-01T12:00:00.000-08:00'; 3) '$endTime': the end time of the period for which stats should be reported, where the value should be in extended ISO-8601 format; 4) '$samplingInterval': the sampling interval in seconds at which statistical data should be collected; 5) '$statType': the down-sampling operator to use while performing down-sampling on stats data, where the allowed values are SUM, MIN, MAX, AVG, COUNT and LAST; 6) '$orderby'; 7) '$page'; 8) '$limit'; and 9) '$filter': the OData filter to use, e.g. 'stats/hypervisorCpuUsagePpm gt 100000 and stats/guestMemoryUsagePpm lt 2000000.'

type EsxiVmApi 

type EsxiVmApi struct {
	ApiClient *client.ApiClient
	// contains filtered or unexported fields
}

func NewEsxiVmApi 

func NewEsxiVmApi(apiClient *client.ApiClient) *EsxiVmApi

func (*EsxiVmApi) AssignVmOwner 

func (api *EsxiVmApi) AssignVmOwner(extId *string, body *import3.OwnershipInfo, args ...map[string]interface{}) (*import3.AssignVmOwnerApiResponse, error)

Assign the owner of a Virtual Machine.

func (*EsxiVmApi) AssociateCategories 

func (api *EsxiVmApi) AssociateCategories(extId *string, body *import3.AssociateVmCategoriesParams, args ...map[string]interface{}) (*import3.AssociateCategoriesApiResponse, error)

Associate categories to a Virtual Machine.

func (*EsxiVmApi) DisassociateCategories 

func (api *EsxiVmApi) DisassociateCategories(extId *string, body *import3.DisassociateVmCategoriesParams, args ...map[string]interface{}) (*import3.DisassociateCategoriesApiResponse, error)

Disassociate categories from a Virtual Machine.

func (*EsxiVmApi) GetNutanixGuestToolsById 

func (api *EsxiVmApi) GetNutanixGuestToolsById(extId *string, args ...map[string]interface{}) (*import3.GetNutanixGuestToolsApiResponse, error)

Retrieves the Nutanix Guest Tools configuration for a Virtual Machine.

func (*EsxiVmApi) GetVmById 

func (api *EsxiVmApi) GetVmById(extId *string, args ...map[string]interface{}) (*import3.GetVmApiResponse, error)

Retrieves configuration details for a Virtual Machine.

func (*EsxiVmApi) InsertNutanixGuestTools 

func (api *EsxiVmApi) InsertNutanixGuestTools(extId *string, body *import3.NutanixGuestToolsInsertConfig, args ...map[string]interface{}) (*import3.InsertNutanixGuestToolsApiResponse, error)

Inserts the Nutanix Guest Tools installation and configuration ISO into a virtual machine.

func (*EsxiVmApi) InstallNutanixGuestTools 

func (api *EsxiVmApi) InstallNutanixGuestTools(extId *string, body *import3.NutanixGuestToolsInstallConfig, args ...map[string]interface{}) (*import3.InstallNutanixGuestToolsApiResponse, error)

Installs Nutanix Guest Tools in a Virtual Machine by using the provided credentials.

func (*EsxiVmApi) ListVms 

func (api *EsxiVmApi) ListVms(page_ *int, limit_ *int, filter_ *string, orderby_ *string, select_ *string, args ...map[string]interface{}) (*import3.ListVmsApiResponse, error)

Lists the Virtual Machines defined on the system. List of Virtual Machines can be further filtered out using various filtering options.

func (*EsxiVmApi) RevertVm 

func (api *EsxiVmApi) RevertVm(extId *string, body *import3.RevertParams, args ...map[string]interface{}) (*import3.RevertVmApiResponse, error)

Revert VM identified by {extId}. This does an in-place VM restore from a specified VM Recovery Point.

func (*EsxiVmApi) UninstallNutanixGuestTools 

func (api *EsxiVmApi) UninstallNutanixGuestTools(extId *string, args ...map[string]interface{}) (*import3.UninstallNutanixGuestToolsApiResponse, error)

Trigger an in-guest uninstallation of Nutanix Guest Tools.

func (*EsxiVmApi) UpdateNutanixGuestToolsById 

func (api *EsxiVmApi) UpdateNutanixGuestToolsById(extId *string, body *import3.NutanixGuestTools, args ...map[string]interface{}) (*import3.UpdateNutanixGuestToolsApiResponse, error)

Updates the Nutanix Guest Tools configuration for a Virtual Machine.

func (*EsxiVmApi) UpgradeNutanixGuestTools 

func (api *EsxiVmApi) UpgradeNutanixGuestTools(extId *string, body *import3.NutanixGuestToolsUpgradeConfig, args ...map[string]interface{}) (*import3.UpgradeNutanixGuestToolsApiResponse, error)

Trigger an in-guest upgrade of Nutanix Guest Tools.

type ImagePlacementPoliciesApi 

type ImagePlacementPoliciesApi struct {
	ApiClient *client.ApiClient
	// contains filtered or unexported fields
}

func NewImagePlacementPoliciesApi 

func NewImagePlacementPoliciesApi(apiClient *client.ApiClient) *ImagePlacementPoliciesApi

func (*ImagePlacementPoliciesApi) CreatePlacementPolicy 

func (api *ImagePlacementPoliciesApi) CreatePlacementPolicy(body *import4.PlacementPolicy, args ...map[string]interface{}) (*import4.CreatePlacementPolicyApiResponse, error)

Create an image placement policy using the provided request body. Name, placementType, clusterEntityFilter & imageEntityFilter are mandatory fields to create an image placement policy.

func (*ImagePlacementPoliciesApi) DeletePlacementPolicyById 

func (api *ImagePlacementPoliciesApi) DeletePlacementPolicyById(extId *string, args ...map[string]interface{}) (*import4.DeletePlacementPolicyApiResponse, error)

Delete the image placement policy with the given external identifier.

func (*ImagePlacementPoliciesApi) GetPlacementPolicyById 

func (api *ImagePlacementPoliciesApi) GetPlacementPolicyById(extId *string, args ...map[string]interface{}) (*import4.GetPlacementPolicyApiResponse, error)

Retrieve the image placement policy details for the provided external identifier.

func (*ImagePlacementPoliciesApi) ListPlacementPolicies 

func (api *ImagePlacementPoliciesApi) ListPlacementPolicies(page_ *int, limit_ *int, filter_ *string, orderby_ *string, select_ *string, args ...map[string]interface{}) (*import4.ListPlacementPoliciesApiResponse, error)

List image placement policies created on the Prism Central along with the details like, name, description etc. The API supports operations like filtering, sorting, selection & pagination.

func (*ImagePlacementPoliciesApi) ResumePlacementPolicy 

func (api *ImagePlacementPoliciesApi) ResumePlacementPolicy(extId *string, args ...map[string]interface{}) (*import4.ResumePlacementPolicyApiResponse, error)

Resume a suspended image placement policy. A suspended image placement policy is the one that is not being considered for enforcement.

func (*ImagePlacementPoliciesApi) SuspendPlacementPolicy 

func (api *ImagePlacementPoliciesApi) SuspendPlacementPolicy(extId *string, body *import4.SuspendPlacementPolicyConfig, args ...map[string]interface{}) (*import4.SuspendPlacementPolicyApiResponse, error)

Suspend an active image placement policy. An active image placement policy is the one that is being considered for enforcement.

func (*ImagePlacementPoliciesApi) UpdatePlacementPolicyById 

func (api *ImagePlacementPoliciesApi) UpdatePlacementPolicyById(extId *string, body *import4.PlacementPolicy, args ...map[string]interface{}) (*import4.UpdatePlacementPolicyApiResponse, error)

Update the image placement policy with the given external identifier using the provided request body. To make sure the correct ETag is used, it is always recommended to do a GET on a resource before doing a PUT.

type ImageRateLimitPoliciesApi 

type ImageRateLimitPoliciesApi struct {
	ApiClient *client.ApiClient
	// contains filtered or unexported fields
}

func NewImageRateLimitPoliciesApi 

func NewImageRateLimitPoliciesApi(apiClient *client.ApiClient) *ImageRateLimitPoliciesApi

func (*ImageRateLimitPoliciesApi) CreateRateLimitPolicy 

func (api *ImageRateLimitPoliciesApi) CreateRateLimitPolicy(body *import4.RateLimitPolicy, args ...map[string]interface{}) (*import4.CreateRateLimitPolicyApiResponse, error)

Create an image rate limit policy using the provided request body. Name, rateLimitKbps & clusterEntityFilter are mandatory fields to create an image rate limit.

func (*ImageRateLimitPoliciesApi) DeleteRateLimitPolicyById 

func (api *ImageRateLimitPoliciesApi) DeleteRateLimitPolicyById(extId *string, args ...map[string]interface{}) (*import4.DeleteRateLimitPolicyApiResponse, error)

Delete the image rate limit policy with the given external identifier.

func (*ImageRateLimitPoliciesApi) GetRateLimitPolicyById 

func (api *ImageRateLimitPoliciesApi) GetRateLimitPolicyById(extId *string, args ...map[string]interface{}) (*import4.GetRateLimitPolicyApiResponse, error)

Retrieve an image rate limit policy details for the provided external identifier.

func (*ImageRateLimitPoliciesApi) ListEffectiveRateLimitPolicies 

func (api *ImageRateLimitPoliciesApi) ListEffectiveRateLimitPolicies(page_ *int, limit_ *int, filter_ *string, orderby_ *string, select_ *string, args ...map[string]interface{}) (*import4.ListEffectiveRateLimitPoliciesApiResponse, error)

The effective rate limit for the Prism Elements. If no rate limit applies to a given cluster, an entry for it will not be returned. The API supports operations like filtering, sorting, selection & pagination.

func (*ImageRateLimitPoliciesApi) ListRateLimitPolicies 

func (api *ImageRateLimitPoliciesApi) ListRateLimitPolicies(page_ *int, limit_ *int, filter_ *string, orderby_ *string, select_ *string, args ...map[string]interface{}) (*import4.ListRateLimitPoliciesApiResponse, error)

List image rate limit policies created on the Prism Central along with the details like, name, description etc. The API supports operations like filtering, sorting, selection & pagination.

func (*ImageRateLimitPoliciesApi) UpdateRateLimitPolicyById 

func (api *ImageRateLimitPoliciesApi) UpdateRateLimitPolicyById(extId *string, body *import4.RateLimitPolicy, args ...map[string]interface{}) (*import4.UpdateRateLimitPolicyApiResponse, error)

Update the image rate limit policy with the given external identifier using the provided request body. To make sure the correct ETag is used, it is always recommended to do a GET on a resource before doing a PUT.

type ImagesApi 

type ImagesApi struct {
	ApiClient *client.ApiClient
	// contains filtered or unexported fields
}

func NewImagesApi 

func NewImagesApi(apiClient *client.ApiClient) *ImagesApi

func (*ImagesApi) CreateImage 

func (api *ImagesApi) CreateImage(body *import5.Image, args ...map[string]interface{}) (*import5.CreateImageApiResponse, error)

Create an image using the provided request body. Name, type and source are mandatory fields to create an image.

func (*ImagesApi) DeleteImageById 

func (api *ImagesApi) DeleteImageById(extId *string, args ...map[string]interface{}) (*import5.DeleteImageApiResponse, error)

Delete the image with the given external identifier.

func (*ImagesApi) GetImageById 

func (api *ImagesApi) GetImageById(extId *string, args ...map[string]interface{}) (*import5.GetImageApiResponse, error)

Retrieve the image details for the provided external identifier.

func (*ImagesApi) ImportImage 

func (api *ImagesApi) ImportImage(body *import5.ImageImportConfig, args ...map[string]interface{}) (*import5.ImportImageApiResponse, error)

Import images owned by a registered Prism Element cluster to the current Prism Central.

func (*ImagesApi) ListImages 

func (api *ImagesApi) ListImages(page_ *int, limit_ *int, filter_ *string, orderby_ *string, select_ *string, args ...map[string]interface{}) (*import5.ListImagesApiResponse, error)

List images owned by Prism Central along with the image details like name, description, type, etc. This operation supports filtering, sorting, selection & pagination.

func (*ImagesApi) UpdateImageById 

func (api *ImagesApi) UpdateImageById(extId *string, body *import5.Image, args ...map[string]interface{}) (*import5.UpdateImageApiResponse, error)

Update the image with the given external identifier. To make sure the correct ETag is used, it is always recommended to do a GET on a resource before doing a PUT.

type StatsApi 

type StatsApi struct {
	ApiClient *client.ApiClient
	// contains filtered or unexported fields
}

func NewStatsApi 

func NewStatsApi(apiClient *client.ApiClient) *StatsApi

func (*StatsApi) GetDiskStatsById 

func (api *StatsApi) GetDiskStatsById(vmExtId *string, extId *string, startTime_ *string, endTime_ *string, samplingInterval_ *int, statType_ *import1.DownSamplingOperator, select_ *string, args ...map[string]interface{}) (*import6.GetDiskStatsApiResponse, error)

Get the stats for the specified VM disk. Users can include the following in the request query: 1) '$select': comma-separated attributes with the prefix 'stats/', e.g. 'stats/controllerNumIo, stats/controllerUserBytes'. 2) '$startTime': the start time of the period for which stats should be reported, where the value should be in extended ISO-8601 format, e.g. '2023-01-01T12:00:00.000-08:00'; 3) '$endTime': the end time of the period for which stats should be reported, where the value should be in extended ISO-8601 format; 4) '$samplingInterval': the sampling interval in seconds at which statistical data should be collected; 5) '$statType': the down-sampling operator to use while performing down-sampling on stats data, where the allowed values are SUM, MIN, MAX, AVG, COUNT and LAST.

func (*StatsApi) GetVmStatsById 

func (api *StatsApi) GetVmStatsById(extId *string, startTime_ *string, endTime_ *string, samplingInterval_ *int, statType_ *import1.DownSamplingOperator, select_ *string, args ...map[string]interface{}) (*import6.GetVmStatsApiResponse, error)

Get VM stats for a given VM. Users can include the following in the request query: 1) '$select': comma-separated attributes with the prefix 'stats/', e.g. 'stats/controllerNumIo,stats/hypervisorNumIo'. 2) '$startTime': the start time of the period for which stats should be reported, where the value should be in extended ISO-8601 format, e.g. '2023-01-01T12:00:00.000-08:00'; 3) '$endTime': the end time of the period for which stats should be reported, where the value should be in extended ISO-8601 format; 4) '$samplingInterval': the sampling interval in seconds at which statistical data should be collected; 5) '$statType': the down-sampling operator to use while performing down-sampling on stats data, where the allowed values are SUM, MIN, MAX, AVG, COUNT and LAST.

func (*StatsApi) ListVmStats 

func (api *StatsApi) ListVmStats(startTime_ *string, endTime_ *string, samplingInterval_ *int, statType_ *import1.DownSamplingOperator, page_ *int, limit_ *int, filter_ *string, orderby_ *string, select_ *string, args ...map[string]interface{}) (*import6.ListVmStatsApiResponse, error)

List VM stats for all VMs. Users can include the following in the request query: 1) '$select': comma-separated attributes with the prefix 'stats/', e.g. 'stats/controllerNumIo,stats/hypervisorNumIo'. 2) '$startTime': the start time of the period for which stats should be reported, where the value should be in extended ISO-8601 format, e.g. '2023-01-01T12:00:00.000-08:00'; 3) '$endTime': the end time of the period for which stats should be reported, where the value should be in extended ISO-8601 format; 4) '$samplingInterval': the sampling interval in seconds at which statistical data should be collected; 5) '$statType': the down-sampling operator to use while performing down-sampling on stats data, where the allowed values are SUM, MIN, MAX, AVG, COUNT and LAST; 6) '$orderby'; 7) '$page'; 8) '$limit'; and 9) '$filter': the OData filter to use, e.g. 'stats/hypervisorCpuUsagePpm gt 100000 and stats/guestMemoryUsagePpm lt 2000000.'

type TemplatesApi 

type TemplatesApi struct {
	ApiClient *client.ApiClient
	// contains filtered or unexported fields
}

func NewTemplatesApi 

func NewTemplatesApi(apiClient *client.ApiClient) *TemplatesApi

func (*TemplatesApi) CancelGuestUpdate 

func (api *TemplatesApi) CancelGuestUpdate(extId *string, args ...map[string]interface{}) (*import5.CancelGuestUpdateApiResponse, error)

Cancel updating the Guest OS for the given Template Version identifier. The temporary VM created during \"Initiate Guest OS Update\" is deleted and the pending update state is cleared. Please note that any modifications made to the temporary VM will be lost upon successful cancelation of update operation.

func (*TemplatesApi) CompleteGuestUpdate 

func (api *TemplatesApi) CompleteGuestUpdate(extId *string, body *import5.CompleteGuestUpdateSpec, args ...map[string]interface{}) (*import5.CompleteGuestUpdateApiResponse, error)

This operation concludes the previously ongoing update since issuing the \"Initiate Guest OS Update\" operation for the Template. A new Version is added to the Template, the temporary VM created during \"Initiate Guest OS Update\" is deleted and the pending update state is cleared.

func (*TemplatesApi) CreateTemplate 

func (api *TemplatesApi) CreateTemplate(body *import5.Template, args ...map[string]interface{}) (*import5.CreateTemplateApiResponse, error)

Create a Template from the given VM identifier. A Template stores the VM configuration and disks from the source VM.

func (*TemplatesApi) DeleteTemplateById 

func (api *TemplatesApi) DeleteTemplateById(extId *string, args ...map[string]interface{}) (*import5.DeleteTemplateApiResponse, error)

Delete the Template along with all its Versions for a given Template identifier.

func (*TemplatesApi) DeleteTemplateVersionById 

func (api *TemplatesApi) DeleteTemplateVersionById(templateExtId *string, extId *string, args ...map[string]interface{}) (*import5.DeleteTemplateVersionApiResponse, error)

Delete a Version for a given Template Version identifier.

func (*TemplatesApi) DeployTemplate 

func (api *TemplatesApi) DeployTemplate(extId *string, body *import5.TemplateDeployment, args ...map[string]interface{}) (*import5.DeployTemplateApiResponse, error)

Deploy one or more VMs from a Template. Number of VMs to be deployed and their corresponding VM configuration overrides can be provided.

func (*TemplatesApi) GetTemplateById 

func (api *TemplatesApi) GetTemplateById(extId *string, args ...map[string]interface{}) (*import5.GetTemplateApiResponse, error)

Retrieve the Template details for the given Template identifier.

func (*TemplatesApi) GetTemplateVersionById 

func (api *TemplatesApi) GetTemplateVersionById(templateExtId *string, extId *string, args ...map[string]interface{}) (*import5.GetTemplateVersionApiResponse, error)

Retrieve the Template Version details for the given Template Version identifier.

func (*TemplatesApi) InitiateGuestUpdate 

func (api *TemplatesApi) InitiateGuestUpdate(extId *string, body *import5.InitiateGuestUpdateSpec, args ...map[string]interface{}) (*import5.InitiateGuestUpdateApiResponse, error)

Initiates updating the Guest OS from a given Template Version identifier. Only a single Guest OS Update can be initiated on a Template at a time. A temporary VM is set up where the Guest OS Updates shall be applied. The necessary modifications should be performed on the temporary VM by the user. Once done with the modifications, the user should issue \"Complete Guest OS Update\" to finish the update. The \"Cancel Guest OS Update\" operation can be issued any time to abort an ongoing Guest OS Update.

func (*TemplatesApi) ListTemplateVersions 

func (api *TemplatesApi) ListTemplateVersions(extId *string, page_ *int, limit_ *int, filter_ *string, orderby_ *string, args ...map[string]interface{}) (*import5.ListTemplateVersionsApiResponse, error)

List Versions with details like name, description, VM configuration, etc. This operation supports filtering, sorting & pagination.

func (*TemplatesApi) ListTemplates 

func (api *TemplatesApi) ListTemplates(page_ *int, limit_ *int, filter_ *string, orderby_ *string, args ...map[string]interface{}) (*import5.ListTemplatesApiResponse, error)

List Templates with details like name, description, VM configuration, etc. This operation supports filtering, sorting & pagination.

func (*TemplatesApi) PublishTemplate 

func (api *TemplatesApi) PublishTemplate(extId *string, body *import5.TemplatePublishSpec, args ...map[string]interface{}) (*import5.PublishTemplateApiResponse, error)

Designate the Template Version identified by the given identifier as the Active Version. The Active version is the default version for creating VMs from the Template and for starting the Guest OS Update.

func (*TemplatesApi) UpdateTemplateById 

func (api *TemplatesApi) UpdateTemplateById(extId *string, body *import5.Template, args ...map[string]interface{}) (*import5.UpdateTemplateApiResponse, error)

Update the Template with the given Template identifier. This operation results in updating the Template configuration and/or a new Version being added to the Template. The newly created Version is set as the Active Version unless specified otherwise.

type VmApi 

type VmApi struct {
	ApiClient *client.ApiClient
	// contains filtered or unexported fields
}

func NewVmApi 

func NewVmApi(apiClient *client.ApiClient) *VmApi

func (*VmApi) AssignIpById 

func (api *VmApi) AssignIpById(vmExtId *string, extId *string, body *import7.AssignIpParams, args ...map[string]interface{}) (*import7.AssignIpApiResponse, error)

Assigns a specific IP address to a network device attached to a managed network.

func (*VmApi) AssignVmOwner 

func (api *VmApi) AssignVmOwner(extId *string, body *import7.OwnershipInfo, args ...map[string]interface{}) (*import7.AssignVmOwnerApiResponse, error)

Assign the owner of a Virtual Machine.

func (*VmApi) AssociateCategories 

func (api *VmApi) AssociateCategories(extId *string, body *import7.AssociateVmCategoriesParams, args ...map[string]interface{}) (*import7.AssociateCategoriesApiResponse, error)

Associate categories to a Virtual Machine.

func (*VmApi) CloneVm 

func (api *VmApi) CloneVm(extId *string, body *import7.CloneOverrideParams, args ...map[string]interface{}) (*import7.CloneVmApiResponse, error)

Clones an existing Virtual Machine. This operation also includes updating the existing configuration during the clone operation.

func (*VmApi) CreateCdRom 

func (api *VmApi) CreateCdRom(vmExtId *string, body *import7.CdRom, args ...map[string]interface{}) (*import7.CreateCdRomApiResponse, error)

Creates and attaches a CD-ROM device to a Virtual Machine.

func (*VmApi) CreateDisk 

func (api *VmApi) CreateDisk(vmExtId *string, body *import7.Disk, args ...map[string]interface{}) (*import7.CreateDiskApiResponse, error)

Creates and attaches a disk device to a Virtual Machine.

func (*VmApi) CreateGpu 

func (api *VmApi) CreateGpu(vmExtId *string, body *import7.Gpu, args ...map[string]interface{}) (*import7.CreateGpuApiResponse, error)

Attaches a GPU device to a Virtual Machine.

func (*VmApi) CreateNic 

func (api *VmApi) CreateNic(vmExtId *string, body *import7.Nic, args ...map[string]interface{}) (*import7.CreateNicApiResponse, error)

Creates and attaches a network device to a Virtual Machine.

func (*VmApi) CreateSerialPort 

func (api *VmApi) CreateSerialPort(vmExtId *string, body *import7.SerialPort, args ...map[string]interface{}) (*import7.CreateSerialPortApiResponse, error)

Creates and attaches a serial port device to a Virtual Machine.

func (*VmApi) CreateVm 

func (api *VmApi) CreateVm(body *import7.Vm, args ...map[string]interface{}) (*import7.CreateVmApiResponse, error)

Creates a Virtual Machine with the provided configuration.

func (*VmApi) CrossClusterMigrateVm 

func (api *VmApi) CrossClusterMigrateVm(extId *string, body *import7.VmCrossClusterMigrateParams, args ...map[string]interface{}) (*import7.CrossClusterMigrateVmApiResponse, error)

Migrates a VM (including its storage) from the current cluster to a new target cluster.

func (*VmApi) CustomizeGuestVm 

func (api *VmApi) CustomizeGuestVm(extId *string, body *import7.GuestCustomizationParams, args ...map[string]interface{}) (*import7.CustomizeGuestVmApiResponse, error)

Stage a Sysprep or cloud-init configuration file to be used by the guest for the next boot. Note that the Sysprep command must be used to generalize the Windows VMs before triggering this API call.

func (*VmApi) DeleteCdRomById 

func (api *VmApi) DeleteCdRomById(vmExtId *string, extId *string, args ...map[string]interface{}) (*import7.DeleteCdRomApiResponse, error)

Removes the specified CD-ROM device from a Virtual Machine.

func (*VmApi) DeleteDiskById 

func (api *VmApi) DeleteDiskById(vmExtId *string, extId *string, args ...map[string]interface{}) (*import7.DeleteDiskApiResponse, error)

Removes the specified disk device from a Virtual Machine.

func (*VmApi) DeleteGpuById 

func (api *VmApi) DeleteGpuById(vmExtId *string, extId *string, args ...map[string]interface{}) (*import7.DeleteGpuApiResponse, error)

Removes the specified GPU device from a Virtual Machine.

func (*VmApi) DeleteNicById 

func (api *VmApi) DeleteNicById(vmExtId *string, extId *string, args ...map[string]interface{}) (*import7.DeleteNicApiResponse, error)

Removes the specified network device from a Virtual Machine.

func (*VmApi) DeleteSerialPortById 

func (api *VmApi) DeleteSerialPortById(vmExtId *string, extId *string, args ...map[string]interface{}) (*import7.DeleteSerialPortApiResponse, error)

Removes the specified serial port from a Virtual Machine.

func (*VmApi) DeleteVmById 

func (api *VmApi) DeleteVmById(extId *string, args ...map[string]interface{}) (*import7.DeleteVmApiResponse, error)

Delete the specified Virtual Machine.

func (*VmApi) DisassociateCategories 

func (api *VmApi) DisassociateCategories(extId *string, body *import7.DisassociateVmCategoriesParams, args ...map[string]interface{}) (*import7.DisassociateCategoriesApiResponse, error)

Disassociate categories from a Virtual Machine.

func (*VmApi) EjectCdRomById 

func (api *VmApi) EjectCdRomById(vmExtId *string, extId *string, args ...map[string]interface{}) (*import7.EjectCdRomApiResponse, error)

Ejects the ISO currently inserted into a CD-ROM device on a Virtual Machine.

func (*VmApi) GetCdRomById 

func (api *VmApi) GetCdRomById(vmExtId *string, extId *string, args ...map[string]interface{}) (*import7.GetCdRomApiResponse, error)

Retrieves configuration details for the provided CD-ROM device attached to a Virtual Machine.

func (*VmApi) GetDiskById 

func (api *VmApi) GetDiskById(vmExtId *string, extId *string, args ...map[string]interface{}) (*import7.GetDiskApiResponse, error)

Retrieves configuration details for the provided disk device attached to a Virtual Machine.

func (*VmApi) GetGpuById 

func (api *VmApi) GetGpuById(vmExtId *string, extId *string, args ...map[string]interface{}) (*import7.GetGpuApiResponse, error)

Retrieves configuration details for the provided GPU device attached to a Virtual Machine.

func (*VmApi) GetGuestToolsById 

func (api *VmApi) GetGuestToolsById(extId *string, args ...map[string]interface{}) (*import7.GetGuestToolsApiResponse, error)

Retrieves the Nutanix Guest Tools configuration for a Virtual Machine.

func (*VmApi) GetNicById 

func (api *VmApi) GetNicById(vmExtId *string, extId *string, args ...map[string]interface{}) (*import7.GetNicApiResponse, error)

Retrieves configuration details for the provided network device attached to a Virtual Machine.

func (*VmApi) GetSerialPortById 

func (api *VmApi) GetSerialPortById(vmExtId *string, extId *string, args ...map[string]interface{}) (*import7.GetSerialPortApiResponse, error)

Retrieves configuration details for the provided serial port attached to a Virtual Machine.

func (*VmApi) GetVmById 

func (api *VmApi) GetVmById(extId *string, args ...map[string]interface{}) (*import7.GetVmApiResponse, error)

Retrieves configuration details for a Virtual Machine.

func (*VmApi) InsertCdRomById 

func (api *VmApi) InsertCdRomById(vmExtId *string, extId *string, body *import7.CdRomInsertParams, args ...map[string]interface{}) (*import7.InsertCdRomApiResponse, error)

Inserts the defined ISO into a CD-ROM device attached to a Virtual Machine.

func (*VmApi) InsertVmGuestTools 

func (api *VmApi) InsertVmGuestTools(extId *string, body *import7.GuestToolsInsertConfig, args ...map[string]interface{}) (*import7.InsertVmGuestToolsApiResponse, error)

Inserts the Nutanix Guest Tools installation and configuration ISO into a virtual machine.

func (*VmApi) InstallVmGuestTools 

func (api *VmApi) InstallVmGuestTools(extId *string, body *import7.GuestToolsInstallConfig, args ...map[string]interface{}) (*import7.InstallVmGuestToolsApiResponse, error)

Installs Nutanix Guest Tools in a Virtual Machine by using the provided credentials.

func (*VmApi) ListCdRomsByVmId 

func (api *VmApi) ListCdRomsByVmId(vmExtId *string, page_ *int, limit_ *int, args ...map[string]interface{}) (*import7.ListCdRomsApiResponse, error)

Lists the CD-ROM devices attached to a Virtual Machine.

func (*VmApi) ListDisksByVmId 

func (api *VmApi) ListDisksByVmId(vmExtId *string, page_ *int, limit_ *int, args ...map[string]interface{}) (*import7.ListDisksApiResponse, error)

Lists the disk devices attached to a Virtual Machine.

func (*VmApi) ListGpusByVmId 

func (api *VmApi) ListGpusByVmId(vmExtId *string, page_ *int, limit_ *int, filter_ *string, args ...map[string]interface{}) (*import7.ListGpusApiResponse, error)

Lists the GPU devices attached to a Virtual Machine.

func (*VmApi) ListNicsByVmId 

func (api *VmApi) ListNicsByVmId(vmExtId *string, page_ *int, limit_ *int, filter_ *string, args ...map[string]interface{}) (*import7.ListNicsApiResponse, error)

Lists the network devices attached to a Virtual Machine.

func (*VmApi) ListSerialPortsByVmId 

func (api *VmApi) ListSerialPortsByVmId(vmExtId *string, page_ *int, limit_ *int, args ...map[string]interface{}) (*import7.ListSerialPortsApiResponse, error)

Lists the serial ports attached to a Virtual Machine.

func (*VmApi) ListVms 

func (api *VmApi) ListVms(page_ *int, limit_ *int, filter_ *string, orderby_ *string, select_ *string, args ...map[string]interface{}) (*import7.ListVmsApiResponse, error)

Lists the Virtual Machines defined on the system. List of Virtual Machines can be further filtered out using various filtering options.

func (*VmApi) MigrateNicById 

func (api *VmApi) MigrateNicById(vmExtId *string, extId *string, body *import7.MigrateNicConfig, args ...map[string]interface{}) (*import7.MigrateNicApiResponse, error)

Migrates a network device attached to a Virtual Machine to another subnet. This can be used to move network devices between VLAN and VPC subnets.

func (*VmApi) MigrateVmDisks 

func (api *VmApi) MigrateVmDisks(extId *string, body *import7.DiskMigrationParams, args ...map[string]interface{}) (*import7.MigrateVmDisksApiResponse, error)

Specifies the VmDisks of a VM for migration and the migration plan for them. If all the disks of a VM need to be migrated to the same storage container, only a single migration plan with only the external ID of the destination storage container is needed. If the disks are being migrated to different containers, one plan per disk needs to be specified.

func (*VmApi) MigrateVmToHost 

func (api *VmApi) MigrateVmToHost(extId *string, body *import7.VmMigrateToHostParams, args ...map[string]interface{}) (*import7.MigrateVmToHostApiResponse, error)

Migrate a VM to another host within the same cluster.

func (*VmApi) PowerCycleVm 

func (api *VmApi) PowerCycleVm(extId *string, args ...map[string]interface{}) (*import7.PowerCycleVmApiResponse, error)

Force a power-cycle for a Virtual Machine. This operation is equivalent to requesting a VM power-off followed by the VM power-on. Power cycling a VM is slower than resetting it, but it will be creating a fresh instance of the Virtual Machine. When resetting, the same instance is restarted within the context of the running VM instance.

func (*VmApi) PowerOffVm 

func (api *VmApi) PowerOffVm(extId *string, args ...map[string]interface{}) (*import7.PowerOffVmApiResponse, error)

Force shutdown of a Virtual Machine. Equivalent to removing the power cable. Note: If any write operations are being made to any disk when this API is called, it might result in some data loss.

func (*VmApi) PowerOnVm 

func (api *VmApi) PowerOnVm(extId *string, args ...map[string]interface{}) (*import7.PowerOnVmApiResponse, error)

Turns a Virtual Machine on.

func (*VmApi) RebootGuestVm 

func (api *VmApi) RebootGuestVm(extId *string, body *import7.GuestPowerOptions, args ...map[string]interface{}) (*import7.RebootVmApiResponse, error)

Collaborative reboot of a Virtual Machine, requesting Nutanix Guest Tools to trigger a reboot from within the VM.

func (*VmApi) RebootVm 

func (api *VmApi) RebootVm(extId *string, args ...map[string]interface{}) (*import7.RebootVmApiResponse, error)

Collaborative reboot of a Virtual Machine through the ACPI support in the operating system.

func (*VmApi) ReleaseIpById 

func (api *VmApi) ReleaseIpById(vmExtId *string, extId *string, args ...map[string]interface{}) (*import7.ReleaseIpApiResponse, error)

Releases the IP address assignment from a network device attached to a managed network.

func (*VmApi) ResetVm 

func (api *VmApi) ResetVm(extId *string, args ...map[string]interface{}) (*import7.ResetVmApiResponse, error)

Force reset of a Virtual Machine, without waiting for the guest VM to shutdown itself. Resetting a VM is faster than power-cycle as the reset occurs within the context of the running virtual machine instance rather than creating a fresh instance.

func (*VmApi) RevertVm 

func (api *VmApi) RevertVm(extId *string, body *import7.RevertParams, args ...map[string]interface{}) (*import7.RevertVmApiResponse, error)

Revert VM identified by {extId}. This does an in-place VM restore from a specified VM Recovery Point.

func (*VmApi) ShutdownGuestVm 

func (api *VmApi) ShutdownGuestVm(extId *string, body *import7.GuestPowerOptions, args ...map[string]interface{}) (*import7.ShutdownVmApiResponse, error)

Collaborative shutdown of a Virtual Machine, requesting Nutanix Guest Tools to trigger a shutdown from within the VM.

func (*VmApi) ShutdownVm 

func (api *VmApi) ShutdownVm(extId *string, args ...map[string]interface{}) (*import7.ShutdownVmApiResponse, error)

Collaborative shutdown of a Virtual Machine through the ACPI support in the operating system.

func (*VmApi) UninstallVmGuestTools 

func (api *VmApi) UninstallVmGuestTools(extId *string, args ...map[string]interface{}) (*import7.UninstallVmGuestToolsApiResponse, error)

Trigger an in-guest uninstallation of Nutanix Guest Tools.

func (*VmApi) UpdateDiskById 

func (api *VmApi) UpdateDiskById(vmExtId *string, extId *string, body *import7.Disk, args ...map[string]interface{}) (*import7.UpdateDiskApiResponse, error)

Updates the configuration details for the provided disk device.

func (*VmApi) UpdateGuestToolsById 

func (api *VmApi) UpdateGuestToolsById(extId *string, body *import7.GuestTools, args ...map[string]interface{}) (*import7.UpdateGuestToolsApiResponse, error)

Updates the Nutanix Guest Tools configuration for a Virtual Machine.

func (*VmApi) UpdateNicById 

func (api *VmApi) UpdateNicById(vmExtId *string, extId *string, body *import7.Nic, args ...map[string]interface{}) (*import7.UpdateNicApiResponse, error)

Updates the configuration details for the provided network device.

func (*VmApi) UpdateSerialPortById 

func (api *VmApi) UpdateSerialPortById(vmExtId *string, extId *string, body *import7.SerialPort, args ...map[string]interface{}) (*import7.UpdateSerialPortApiResponse, error)

Updates the configuration details for the provided serial port.

func (*VmApi) UpdateVmById 

func (api *VmApi) UpdateVmById(extId *string, body *import7.Vm, args ...map[string]interface{}) (*import7.UpdateVmApiResponse, error)

Updates configuration details for a Virtual Machine.

func (*VmApi) UpgradeVmGuestTools 

func (api *VmApi) UpgradeVmGuestTools(extId *string, body *import7.GuestToolsUpgradeConfig, args ...map[string]interface{}) (*import7.UpgradeVmGuestToolsApiResponse, error)

Trigger an in-guest upgrade of Nutanix Guest Tools.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.