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
Index ¶
- type ImagesApi
- func (api *ImagesApi) CreateImage(body *import1.Image, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
- func (api *ImagesApi) DeleteImageByExtId(extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
- func (api *ImagesApi) GetImageByExtId(extId *string, args ...map[string]interface{}) (*import1.ImageApiResponse, error)
- func (api *ImagesApi) GetImageCategories(extId *string, args ...map[string]interface{}) (*import1.ImageCategoriesApiResponse, error)
- func (api *ImagesApi) GetImageClusterLocations(extId *string, args ...map[string]interface{}) (*import1.ImageClusterLocationListApiResponse, error)
- func (api *ImagesApi) GetImagePlacementPolicies(extId *string, args ...map[string]interface{}) (*import1.ImagePlacementPolicyListApiResponse, error)
- func (api *ImagesApi) GetImagesList(page_ *int, limit_ *int, filter_ *string, orderby_ *string, ...) (*import1.ImageListApiResponse, error)
- func (api *ImagesApi) ImportImage(body *import1.ClusterImages, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
- func (api *ImagesApi) RemoteCopyImage(body *[]import1.ImageReference, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
- func (api *ImagesApi) UpdateImageByExtId(body *import1.Image, extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
- func (api *ImagesApi) UpdateImageCategories(body *[]import1.CategoryReference, extId *string, ...) (*import1.ImagesTaskApiResponse, error)
- type PlacementPoliciesApi
- func (api *PlacementPoliciesApi) CreatePlacementPolicy(body *import1.PlacementPolicy, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
- func (api *PlacementPoliciesApi) DeletePlacementPolicyByExtId(extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
- func (api *PlacementPoliciesApi) GetPlacementPoliciesList(page_ *int, limit_ *int, filter_ *string, orderby_ *string, ...) (*import1.PlacementPolicyListApiResponse, error)
- func (api *PlacementPoliciesApi) GetPlacementPolicyByExtId(extId *string, args ...map[string]interface{}) (*import1.PlacementPolicyApiResponse, error)
- func (api *PlacementPoliciesApi) ResumePlacementPolicyExtId(extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
- func (api *PlacementPoliciesApi) SuspendPlacementPolicyExtId(body *import1.CancelPlacementTasks, extId *string, ...) (*import1.ImagesTaskApiResponse, error)
- func (api *PlacementPoliciesApi) UpdatePlacementPolicyByExtId(body *import1.PlacementPolicy, extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
- type RateLimitsApi
- func (api *RateLimitsApi) CreateRateLimit(body *import1.RateLimit, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
- func (api *RateLimitsApi) DeleteMultipleRateLimits(body *import1.RateLimitIdList, args ...map[string]interface{}) (*import1.RateLimitTaskListApiResponse, error)
- func (api *RateLimitsApi) DeleteRateLimitByExtId(extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
- func (api *RateLimitsApi) GetRateLimitByExtId(extId *string, args ...map[string]interface{}) (*import1.RateLimitApiResponse, error)
- func (api *RateLimitsApi) GetRateLimitsList(page_ *int, limit_ *int, filter_ *string, orderby_ *string, ...) (*import1.RateLimitListApiResponse, error)
- func (api *RateLimitsApi) ResolveRateLimits(body *import1.ClusterIdList, args ...map[string]interface{}) (*import1.ResolveRateLimitsApiResponse, error)
- func (api *RateLimitsApi) UpdateRateLimitByExtId(body *import1.RateLimit, extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
- type VmApi
- func (api *VmApi) AssignIp(body *import2.AssignIp, vmExtId *string, extId *string, ...) (*import2.AssignIpResponse, error)
- func (api *VmApi) AttachVmCategory(body *import2.CategoryReference, extId *string, args ...map[string]interface{}) (*import2.AttachVmCategoryResponse, error)
- func (api *VmApi) CloneVm(extId *string, body *import2.CloneOverride, args ...map[string]interface{}) (*import2.CloneVmResponse, error)
- func (api *VmApi) CreateCdrom(body *import2.Cdrom, vmExtId *string, args ...map[string]interface{}) (*import2.CreateCdromResponse, error)
- func (api *VmApi) CreateDisk(body *import2.Disk, vmExtId *string, args ...map[string]interface{}) (*import2.CreateDiskResponse, error)
- func (api *VmApi) CreateGpu(body *import2.Gpu, vmExtId *string, args ...map[string]interface{}) (*import2.CreateGpuResponse, error)
- func (api *VmApi) CreateNic(body *import2.Nic, vmExtId *string, args ...map[string]interface{}) (*import2.CreateNicResponse, error)
- func (api *VmApi) CreateSerialPort(body *import2.SerialPort, vmExtId *string, args ...map[string]interface{}) (*import2.CreateSerialPortResponse, error)
- func (api *VmApi) CreateVm(body *import2.Vm, args ...map[string]interface{}) (*import2.CreateVmResponse, error)
- func (api *VmApi) CustomizeGuestVm(body *import2.GuestCustomization, extId *string, ...) (*import2.CustomizeGuestVmResponse, error)
- func (api *VmApi) DeleteCdrom(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.DeleteCdromResponse, error)
- func (api *VmApi) DeleteDisk(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.DeleteDiskResponse, error)
- func (api *VmApi) DeleteGpu(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.DeleteGpuResponse, error)
- func (api *VmApi) DeleteNic(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.DeleteNicResponse, error)
- func (api *VmApi) DeleteSerialPort(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.DeleteSerialPortResponse, error)
- func (api *VmApi) DeleteVm(extId *string, args ...map[string]interface{}) (*import2.DeleteVmResponse, error)
- func (api *VmApi) DetachVmCategory(body *import2.CategoryReference, extId *string, args ...map[string]interface{}) (*import2.DetachVmCategoryResponse, error)
- func (api *VmApi) EjectCdrom(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.EjectCdromResponse, error)
- func (api *VmApi) GetCdromByExtId(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.GetCdromResponse, error)
- func (api *VmApi) GetDiskByExtId(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.GetDiskResponse, error)
- func (api *VmApi) GetGpuByExtId(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.GetGpuResponse, error)
- func (api *VmApi) GetGuestTools(extId *string, args ...map[string]interface{}) (*import2.GetGuestToolsResponse, error)
- func (api *VmApi) GetNicByExtId(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.GetNicResponse, error)
- func (api *VmApi) GetSerialPortByExtId(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.GetSerialPortResponse, error)
- func (api *VmApi) GetVmByExtId(extId *string, args ...map[string]interface{}) (*import2.GetVmResponse, error)
- func (api *VmApi) GetVmCategories(extId *string, args ...map[string]interface{}) (*import2.GetVmCategoriesResponse, error)
- func (api *VmApi) GetVmOwnershipInfo(extId *string, args ...map[string]interface{}) (*import2.GetVmOwnershipInfoResponse, error)
- func (api *VmApi) GuestRebootVm(body *import2.GuestPowerOptions, extId *string, args ...map[string]interface{}) (*import2.RebootVmResponse, error)
- func (api *VmApi) GuestShutdownVm(body *import2.GuestPowerOptions, extId *string, args ...map[string]interface{}) (*import2.ShutdownVmResponse, error)
- func (api *VmApi) InsertCdrom(body *import2.CdromInsert, vmExtId *string, extId *string, ...) (*import2.InsertCdromResponse, error)
- func (api *VmApi) InsertVmGuestTools(body *import2.GuestToolsInsertConfig, extId *string, ...) (*import2.InsertVmGuestToolsResponse, error)
- func (api *VmApi) InstallVmGuestTools(body *import2.GuestToolsInstallConfig, extId *string, ...) (*import2.InstallVmGuestToolsResponse, error)
- func (api *VmApi) ListCdroms(vmExtId *string, page_ *int, limit_ *int, args ...map[string]interface{}) (*import2.ListCdromsResponse, error)
- func (api *VmApi) ListDisks(vmExtId *string, page_ *int, limit_ *int, args ...map[string]interface{}) (*import2.ListDisksResponse, error)
- func (api *VmApi) ListGpus(vmExtId *string, page_ *int, limit_ *int, args ...map[string]interface{}) (*import2.ListGpusResponse, error)
- func (api *VmApi) ListNics(vmExtId *string, page_ *int, limit_ *int, args ...map[string]interface{}) (*import2.ListNicsResponse, error)
- func (api *VmApi) ListSerialPorts(vmExtId *string, page_ *int, limit_ *int, args ...map[string]interface{}) (*import2.ListSerialPortsResponse, error)
- func (api *VmApi) ListVms(page_ *int, limit_ *int, filter_ *string, orderby_ *string, ...) (*import2.ListVmsResponse, error)
- func (api *VmApi) MigrateNic(body *import2.MigrateNicConfig, vmExtId *string, extId *string, ...) (*import2.MigrateNicResponse, error)
- func (api *VmApi) PowerCycleVm(extId *string, args ...map[string]interface{}) (*import2.PowerCycleVmResponse, error)
- func (api *VmApi) PowerOffVm(extId *string, args ...map[string]interface{}) (*import2.PowerOffVmResponse, error)
- func (api *VmApi) PowerOnVm(extId *string, args ...map[string]interface{}) (*import2.PowerOnVmResponse, error)
- func (api *VmApi) RebootVm(body *import2.ACPIPowerOptions, extId *string, args ...map[string]interface{}) (*import2.RebootVmResponse, error)
- func (api *VmApi) ReleaseIp(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.ReleaseIpResponse, error)
- func (api *VmApi) ResetVm(extId *string, args ...map[string]interface{}) (*import2.ResetVmResponse, error)
- func (api *VmApi) ShutdownVm(body *import2.ACPIPowerOptions, extId *string, args ...map[string]interface{}) (*import2.ShutdownVmResponse, error)
- func (api *VmApi) UninstallVmGuestTools(extId *string, args ...map[string]interface{}) (*import2.UninstallVmGuestToolsResponse, error)
- func (api *VmApi) UpdateCdrom(body *import2.Cdrom, vmExtId *string, extId *string, ...) (*import2.UpdateCdromResponse, error)
- func (api *VmApi) UpdateDisk(body *import2.Disk, vmExtId *string, extId *string, ...) (*import2.UpdateDiskResponse, error)
- func (api *VmApi) UpdateGuestTools(body *import2.GuestTools, extId *string, args ...map[string]interface{}) (*import2.UpdateGuestToolsResponse, error)
- func (api *VmApi) UpdateNic(body *import2.Nic, vmExtId *string, extId *string, ...) (*import2.UpdateNicResponse, error)
- func (api *VmApi) UpdateSerialPort(body *import2.SerialPort, vmExtId *string, extId *string, ...) (*import2.UpdateSerialPortResponse, error)
- func (api *VmApi) UpdateVm(body *import2.Vm, extId *string, args ...map[string]interface{}) (*import2.UpdateVmResponse, error)
- func (api *VmApi) UpdateVmCategories(body *[]import2.CategoryReference, extId *string, ...) (*import2.UpdateVmCategoriesResponse, error)
- func (api *VmApi) UpdateVmOwnershipInfo(body *import2.OwnershipInfo, extId *string, args ...map[string]interface{}) (*import2.UpdateVmOwnershipInfoResponse, error)
- func (api *VmApi) UpgradeVmGuestTools(body *import2.GuestToolsUpgradeConfig, extId *string, ...) (*import2.UpgradeVmGuestToolsResponse, error)
- type VmDataProtectionApi
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ImagesApi ¶
func NewImagesApi ¶
func (*ImagesApi) CreateImage ¶
func (api *ImagesApi) CreateImage(body *import1.Image, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
*
Create an image. Create an image. parameters:- -> body (vmm.v4.images.Image) (required) : Create image request. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.ImagesTaskApiResponse, error)
func (*ImagesApi) DeleteImageByExtId ¶
func (api *ImagesApi) DeleteImageByExtId(extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
*
Delete an image. Delete the image with the given extId. parameters:- -> extId (string) (required) -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.ImagesTaskApiResponse, error)
func (*ImagesApi) GetImageByExtId ¶
func (api *ImagesApi) GetImageByExtId(extId *string, args ...map[string]interface{}) (*import1.ImageApiResponse, error)
*
Get an image. Get image details with the given extId. parameters:- -> extId (string) (required) -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.ImageApiResponse, error)
func (*ImagesApi) GetImageCategories ¶
func (api *ImagesApi) GetImageCategories(extId *string, args ...map[string]interface{}) (*import1.ImageCategoriesApiResponse, error)
*
Get image categories. Get image categories for a given extId. parameters:- -> extId (string) (required) -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.ImageCategoriesApiResponse, error)
func (*ImagesApi) GetImageClusterLocations ¶
func (api *ImagesApi) GetImageClusterLocations(extId *string, args ...map[string]interface{}) (*import1.ImageClusterLocationListApiResponse, error)
*
Get Prism Element locations for an image. Get the Prism Element locations where the image is currently available. parameters:- -> extId (string) (required) -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.ImageClusterLocationListApiResponse, error)
func (*ImagesApi) GetImagePlacementPolicies ¶
func (api *ImagesApi) GetImagePlacementPolicies(extId *string, args ...map[string]interface{}) (*import1.ImagePlacementPolicyListApiResponse, error)
*
Get placement policies for an image. Get the current image placement policies for an image. parameters:- -> extId (string) (required) -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.ImagePlacementPolicyListApiResponse, error)
func (*ImagesApi) GetImagesList ¶
func (api *ImagesApi) GetImagesList(page_ *int, limit_ *int, filter_ *string, orderby_ *string, args ...map[string]interface{}) (*import1.ImageListApiResponse, error)
*
List images. List images. parameters:- -> page_ (int) (optional) : A URL query parameter that specifies the page number of the result set. Must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range will lead to no results being returned. -> limit_ (int) (optional) : A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set. -> filter_ (string) (optional) : A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions. The filter can be applied on the following fields: - description - name - sizeBytes -> orderby_ (string) (optional) : A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified the resources will be sorted in ascending order by default. For example, 'orderby=templateName desc' would get all templates sorted by templateName in desc order. The orderby can be applied to the following fields: - description - name - sizeBytes -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.ImageListApiResponse, error)
func (*ImagesApi) ImportImage ¶
func (api *ImagesApi) ImportImage(body *import1.ClusterImages, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
*
Import images from Prism Element. Import images owned by a registered Prism Element cluster to the current Prism Central. parameters:- -> body (vmm.v4.images.ClusterImages) (required) : Reference to the Prism Element cluster and its images to import. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.ImagesTaskApiResponse, error)
func (*ImagesApi) RemoteCopyImage ¶
func (api *ImagesApi) RemoteCopyImage(body *[]import1.ImageReference, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
*
Copy images to a remote Prism Central. Copy the given images to a remote paired Prism Central. parameters:- -> body ([]vmm.v4.images.ImageReference) (required) : Ids of the images to copy to the paired Prism Central. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.ImagesTaskApiResponse, error)
func (*ImagesApi) UpdateImageByExtId ¶
func (api *ImagesApi) UpdateImageByExtId(body *import1.Image, extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
*
Update an image. Update the image with the given extId. parameters:- -> body (vmm.v4.images.Image) (required) : Updated image with the given extId. -> extId (string) (required) -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.ImagesTaskApiResponse, error)
func (*ImagesApi) UpdateImageCategories ¶
func (api *ImagesApi) UpdateImageCategories(body *[]import1.CategoryReference, extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
*
Update image categories. Replace the attached image categories with the given extId. parameters:- -> body ([]vmm.v4.images.CategoryReference) (required) : The desired categories for the image. -> extId (string) (required) -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.ImagesTaskApiResponse, error)
type PlacementPoliciesApi ¶
func NewPlacementPoliciesApi ¶
func NewPlacementPoliciesApi(apiClient *client.ApiClient) *PlacementPoliciesApi
func (*PlacementPoliciesApi) CreatePlacementPolicy ¶
func (api *PlacementPoliciesApi) CreatePlacementPolicy(body *import1.PlacementPolicy, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
*
Create an image placement policy. Create an image placement policy. parameters:- -> body (vmm.v4.images.PlacementPolicy) (required) : Image placement policy to create. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.ImagesTaskApiResponse, error)
func (*PlacementPoliciesApi) DeletePlacementPolicyByExtId ¶
func (api *PlacementPoliciesApi) DeletePlacementPolicyByExtId(extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
*
Delete an image placement policy. Delete the image placement policy with the given extId. parameters:- -> extId (string) (required) -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.ImagesTaskApiResponse, error)
func (*PlacementPoliciesApi) GetPlacementPoliciesList ¶
func (api *PlacementPoliciesApi) GetPlacementPoliciesList(page_ *int, limit_ *int, filter_ *string, orderby_ *string, args ...map[string]interface{}) (*import1.PlacementPolicyListApiResponse, error)
*
List image placement policies. List of image placement policies. parameters:- -> page_ (int) (optional) : A URL query parameter that specifies the page number of the result set. Must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range will lead to no results being returned. -> limit_ (int) (optional) : A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set. -> filter_ (string) (optional) : A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions. The filter can be applied on the following fields: - description - name -> orderby_ (string) (optional) : A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified the resources will be sorted in ascending order by default. For example, 'orderby=templateName desc' would get all templates sorted by templateName in desc order. The orderby can be applied to the following fields: - description - name -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.PlacementPolicyListApiResponse, error)
func (*PlacementPoliciesApi) GetPlacementPolicyByExtId ¶
func (api *PlacementPoliciesApi) GetPlacementPolicyByExtId(extId *string, args ...map[string]interface{}) (*import1.PlacementPolicyApiResponse, error)
*
Get an image placement policy. Get the image placement policy with the given extId. parameters:- -> extId (string) (required) -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.PlacementPolicyApiResponse, error)
func (*PlacementPoliciesApi) ResumePlacementPolicyExtId ¶
func (api *PlacementPoliciesApi) ResumePlacementPolicyExtId(extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
*
Resume an image placement policy. Resume a suspended image placement policy to be considered for enforcement. parameters:- -> extId (string) (required) : Image placement policy extId. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.ImagesTaskApiResponse, error)
func (*PlacementPoliciesApi) SuspendPlacementPolicyExtId ¶
func (api *PlacementPoliciesApi) SuspendPlacementPolicyExtId(body *import1.CancelPlacementTasks, extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
*
Suspend an image placement policy. Suspend an active image placement policy, active policy is one that is being considered for enforcement. parameters:- -> body (vmm.v4.images.CancelPlacementTasks) (required) : Indicates whether the tasks running to enforce policy should be canceled. These would be checkout and uncheckout tasks to placement remove images from the cluster(s). -> extId (string) (required) : Image placement policy extId. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.ImagesTaskApiResponse, error)
func (*PlacementPoliciesApi) UpdatePlacementPolicyByExtId ¶
func (api *PlacementPoliciesApi) UpdatePlacementPolicyByExtId(body *import1.PlacementPolicy, extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
*
Update an image placement policy. Update the image placement policy with the given extId. parameters:- -> body (vmm.v4.images.PlacementPolicy) (required) : Updated image placement policy. -> extId (string) (required) -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.ImagesTaskApiResponse, error)
type RateLimitsApi ¶
func NewRateLimitsApi ¶
func NewRateLimitsApi(apiClient *client.ApiClient) *RateLimitsApi
func (*RateLimitsApi) CreateRateLimit ¶
func (api *RateLimitsApi) CreateRateLimit(body *import1.RateLimit, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
*
Create an image rate limit. Create an image rate limit. parameters:- -> body (vmm.v4.images.RateLimit) (required) : Image rate limit to create. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.ImagesTaskApiResponse, error)
func (*RateLimitsApi) DeleteMultipleRateLimits ¶
func (api *RateLimitsApi) DeleteMultipleRateLimits(body *import1.RateLimitIdList, args ...map[string]interface{}) (*import1.RateLimitTaskListApiResponse, error)
*
Delete multiple image rate limits. Delete the image rate limits with the specified extIds. parameters:- -> body (vmm.v4.images.RateLimitIdList) (required) : ExtIds of the image rate limits to delete. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.RateLimitTaskListApiResponse, error)
func (*RateLimitsApi) DeleteRateLimitByExtId ¶
func (api *RateLimitsApi) DeleteRateLimitByExtId(extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
*
Delete an image rate limit. Delete the image rate limit with the given extId. parameters:- -> extId (string) (required) : Image rate limit extId. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.ImagesTaskApiResponse, error)
func (*RateLimitsApi) GetRateLimitByExtId ¶
func (api *RateLimitsApi) GetRateLimitByExtId(extId *string, args ...map[string]interface{}) (*import1.RateLimitApiResponse, error)
*
Get an image rate limit. Get the image rate limit with the given extId. parameters:- -> extId (string) (required) : Image rate limit extId. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.RateLimitApiResponse, error)
func (*RateLimitsApi) GetRateLimitsList ¶
func (api *RateLimitsApi) GetRateLimitsList(page_ *int, limit_ *int, filter_ *string, orderby_ *string, args ...map[string]interface{}) (*import1.RateLimitListApiResponse, error)
*
List image rate limits. List image rate limits. parameters:- -> page_ (int) (optional) : A URL query parameter that specifies the page number of the result set. Must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range will lead to no results being returned. -> limit_ (int) (optional) : A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set. -> filter_ (string) (optional) : A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions. The filter can be applied on the following fields: - name - rateLimitKbps -> orderby_ (string) (optional) : A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified the resources will be sorted in ascending order by default. For example, 'orderby=templateName desc' would get all templates sorted by templateName in desc order. The orderby can be applied to the following fields: - name - rateLimitKbps -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.RateLimitListApiResponse, error)
func (*RateLimitsApi) ResolveRateLimits ¶
func (api *RateLimitsApi) ResolveRateLimits(body *import1.ClusterIdList, args ...map[string]interface{}) (*import1.ResolveRateLimitsApiResponse, error)
*
Resolve effective rate limit for the Prism Elements. Resolve the effective image rate limit for the given Prism Elements when multiple image rate limits apply. parameters:- -> body (vmm.v4.images.ClusterIdList) (required) : List of cluster extIds for resolving effective rate limits. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.ResolveRateLimitsApiResponse, error)
func (*RateLimitsApi) UpdateRateLimitByExtId ¶
func (api *RateLimitsApi) UpdateRateLimitByExtId(body *import1.RateLimit, extId *string, args ...map[string]interface{}) (*import1.ImagesTaskApiResponse, error)
*
Update the image rate limit with the given extId. Update an image rate limit. parameters:- -> body (vmm.v4.images.RateLimit) (required) : Image rate limit to update. -> extId (string) (required) : Image rate limit extId. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.images.ImagesTaskApiResponse, error)
type VmApi ¶
func (*VmApi) AssignIp ¶
func (api *VmApi) AssignIp(body *import2.AssignIp, vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.AssignIpResponse, error)
*
IP address assignment to a VM NIC. IP address assignment to a VM NIC. parameters:- -> body (vmm.v4.ahv.config.AssignIp) (required) -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> extId (string) (required) : Globally unique identifier of a VM NIC. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.AssignIpResponse, error)
func (*VmApi) AttachVmCategory ¶
func (api *VmApi) AttachVmCategory(body *import2.CategoryReference, extId *string, args ...map[string]interface{}) (*import2.AttachVmCategoryResponse, error)
*
Attach a category for the VM. Attach a category for the VM. parameters:- -> body (vmm.v4.ahv.config.CategoryReference) (required) -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.AttachVmCategoryResponse, error)
func (*VmApi) CloneVm ¶
func (api *VmApi) CloneVm(extId *string, body *import2.CloneOverride, args ...map[string]interface{}) (*import2.CloneVmResponse, error)
*
Clone a VM Clone a VM parameters:- -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> body (vmm.v4.ahv.config.CloneOverride) (optional) -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.CloneVmResponse, error)
func (*VmApi) CreateCdrom ¶
func (api *VmApi) CreateCdrom(body *import2.Cdrom, vmExtId *string, args ...map[string]interface{}) (*import2.CreateCdromResponse, error)
*
Create a CD-ROM for the VM. Create a CD-ROM for the VM. parameters:- -> body (vmm.v4.ahv.config.Cdrom) (required) -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.CreateCdromResponse, error)
func (*VmApi) CreateDisk ¶
func (api *VmApi) CreateDisk(body *import2.Disk, vmExtId *string, args ...map[string]interface{}) (*import2.CreateDiskResponse, error)
*
Create a Disk for the VM. Create a Disk for the VM. parameters:- -> body (vmm.v4.ahv.config.Disk) (required) -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.CreateDiskResponse, error)
func (*VmApi) CreateGpu ¶
func (api *VmApi) CreateGpu(body *import2.Gpu, vmExtId *string, args ...map[string]interface{}) (*import2.CreateGpuResponse, error)
*
Create a GPU for the VM. Create a GPU for the VM. parameters:- -> body (vmm.v4.ahv.config.Gpu) (required) -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.CreateGpuResponse, error)
func (*VmApi) CreateNic ¶
func (api *VmApi) CreateNic(body *import2.Nic, vmExtId *string, args ...map[string]interface{}) (*import2.CreateNicResponse, error)
*
Create a NIC for the VM. Create a NIC for the VM. parameters:- -> body (vmm.v4.ahv.config.Nic) (required) -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.CreateNicResponse, error)
func (*VmApi) CreateSerialPort ¶
func (api *VmApi) CreateSerialPort(body *import2.SerialPort, vmExtId *string, args ...map[string]interface{}) (*import2.CreateSerialPortResponse, error)
*
Create a SerialPort for the VM. Create a SerialPort for the VM. parameters:- -> body (vmm.v4.ahv.config.SerialPort) (required) -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.CreateSerialPortResponse, error)
func (*VmApi) CreateVm ¶
func (api *VmApi) CreateVm(body *import2.Vm, args ...map[string]interface{}) (*import2.CreateVmResponse, error)
*
Create a VM. Create a VM. parameters:- -> body (vmm.v4.ahv.config.Vm) (required) -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.CreateVmResponse, error)
func (*VmApi) CustomizeGuestVm ¶
func (api *VmApi) CustomizeGuestVm(body *import2.GuestCustomization, extId *string, args ...map[string]interface{}) (*import2.CustomizeGuestVmResponse, error)
*
Customize a guest VM. Customize a guest VM. parameters:- -> body (vmm.v4.ahv.config.GuestCustomization) (required) -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.CustomizeGuestVmResponse, error)
func (*VmApi) DeleteCdrom ¶
func (api *VmApi) DeleteCdrom(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.DeleteCdromResponse, error)
*
Delete CD-ROM for the VM. Delete CD-ROM for the VM. parameters:- -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> extId (string) (required) : Globally unique identifier of a CD-ROM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.DeleteCdromResponse, error)
func (*VmApi) DeleteDisk ¶
func (api *VmApi) DeleteDisk(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.DeleteDiskResponse, error)
*
Delete Disk for the VM. Delete Disk for the VM. parameters:- -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> extId (string) (required) : Globally unique identifier of a VM disk. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.DeleteDiskResponse, error)
func (*VmApi) DeleteGpu ¶
func (api *VmApi) DeleteGpu(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.DeleteGpuResponse, error)
*
Delete GPU for the VM. Delete GPU for the VM. parameters:- -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> extId (string) (required) : Globally unique identifier of a VM GPU. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.DeleteGpuResponse, error)
func (*VmApi) DeleteNic ¶
func (api *VmApi) DeleteNic(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.DeleteNicResponse, error)
*
Delete NIC for the VM. Delete NIC for the VM. parameters:- -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> extId (string) (required) : Globally unique identifier of a VM NIC. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.DeleteNicResponse, error)
func (*VmApi) DeleteSerialPort ¶
func (api *VmApi) DeleteSerialPort(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.DeleteSerialPortResponse, error)
*
Delete SerialPort for the VM. Delete SerialPort for the VM. parameters:- -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> extId (string) (required) : Globally unique identifier of a serial port. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.DeleteSerialPortResponse, error)
func (*VmApi) DeleteVm ¶
func (api *VmApi) DeleteVm(extId *string, args ...map[string]interface{}) (*import2.DeleteVmResponse, error)
*
Delete a VM. Delete a VM. parameters:- -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.DeleteVmResponse, error)
func (*VmApi) DetachVmCategory ¶
func (api *VmApi) DetachVmCategory(body *import2.CategoryReference, extId *string, args ...map[string]interface{}) (*import2.DetachVmCategoryResponse, error)
*
Detach a category from the VM. Detach a category from the VM. parameters:- -> body (vmm.v4.ahv.config.CategoryReference) (required) -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.DetachVmCategoryResponse, error)
func (*VmApi) EjectCdrom ¶
func (api *VmApi) EjectCdrom(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.EjectCdromResponse, error)
*
Update CD-ROM for the VM. Update CD-ROM for the VM. parameters:- -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> extId (string) (required) : Globally unique identifier of a CD-ROM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.EjectCdromResponse, error)
func (*VmApi) GetCdromByExtId ¶
func (api *VmApi) GetCdromByExtId(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.GetCdromResponse, error)
*
Get CD-ROM for the VM. Get CD-ROM for the VM. parameters:- -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> extId (string) (required) : Globally unique identifier of a CD-ROM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.GetCdromResponse, error)
func (*VmApi) GetDiskByExtId ¶
func (api *VmApi) GetDiskByExtId(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.GetDiskResponse, error)
*
Get Disk for the VM. Get Disk for the VM. parameters:- -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> extId (string) (required) : Globally unique identifier of a VM disk. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.GetDiskResponse, error)
func (*VmApi) GetGpuByExtId ¶
func (api *VmApi) GetGpuByExtId(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.GetGpuResponse, error)
*
Get GPU for the VM. Get GPU for the VM. parameters:- -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> extId (string) (required) : Globally unique identifier of a VM GPU. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.GetGpuResponse, error)
func (*VmApi) GetGuestTools ¶
func (api *VmApi) GetGuestTools(extId *string, args ...map[string]interface{}) (*import2.GetGuestToolsResponse, error)
*
Get Nutanix Guest Tools information for a VM. Get Nutanix Guest Tools information for a VM. parameters:- -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.GetGuestToolsResponse, error)
func (*VmApi) GetNicByExtId ¶
func (api *VmApi) GetNicByExtId(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.GetNicResponse, error)
*
Get NIC for the VM identified by the VM external Id. Get NIC for the VM identified by the VM external Id. parameters:- -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> extId (string) (required) : Globally unique identifier of a VM NIC. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.GetNicResponse, error)
func (*VmApi) GetSerialPortByExtId ¶
func (api *VmApi) GetSerialPortByExtId(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.GetSerialPortResponse, error)
*
Get SerialPort for the VM. Get SerialPort for the VM. parameters:- -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> extId (string) (required) : Globally unique identifier of a serial port. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.GetSerialPortResponse, error)
func (*VmApi) GetVmByExtId ¶
func (api *VmApi) GetVmByExtId(extId *string, args ...map[string]interface{}) (*import2.GetVmResponse, error)
*
Get VM of the provided VM external Id. Get VM of the provided VM external Id. parameters:- -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.GetVmResponse, error)
func (*VmApi) GetVmCategories ¶
func (api *VmApi) GetVmCategories(extId *string, args ...map[string]interface{}) (*import2.GetVmCategoriesResponse, error)
*
Get categories for the VM. Get categories for the VM. parameters:- -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.GetVmCategoriesResponse, error)
func (*VmApi) GetVmOwnershipInfo ¶
func (api *VmApi) GetVmOwnershipInfo(extId *string, args ...map[string]interface{}) (*import2.GetVmOwnershipInfoResponse, error)
*
Get ownership information for the VM identified by the VM external Id. Get ownership information for the VM identified by the VM external Id. parameters:- -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.GetVmOwnershipInfoResponse, error)
func (*VmApi) GuestRebootVm ¶
func (api *VmApi) GuestRebootVm(body *import2.GuestPowerOptions, extId *string, args ...map[string]interface{}) (*import2.RebootVmResponse, error)
*
Restart the VM using Nutanix Guest Tools. Restart the VM using Nutanix Guest Tools. parameters:- -> body (vmm.v4.ahv.config.GuestPowerOptions) (required) -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.RebootVmResponse, error)
func (*VmApi) GuestShutdownVm ¶
func (api *VmApi) GuestShutdownVm(body *import2.GuestPowerOptions, extId *string, args ...map[string]interface{}) (*import2.ShutdownVmResponse, error)
*
Shutdown the VM using Nutanix Guest Tools. Shutdown the VM using Nutanix Guest Tools. parameters:- -> body (vmm.v4.ahv.config.GuestPowerOptions) (required) -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.ShutdownVmResponse, error)
func (*VmApi) InsertCdrom ¶
func (api *VmApi) InsertCdrom(body *import2.CdromInsert, vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.InsertCdromResponse, error)
*
Insert an ISO image or VM disk to a CD-ROM for the VM. Insert an ISO image or VM disk to a CD-ROM for the VM. parameters:- -> body (vmm.v4.ahv.config.CdromInsert) (required) -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> extId (string) (required) : Globally unique identifier of a CD-ROM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.InsertCdromResponse, error)
func (*VmApi) InsertVmGuestTools ¶
func (api *VmApi) InsertVmGuestTools(body *import2.GuestToolsInsertConfig, extId *string, args ...map[string]interface{}) (*import2.InsertVmGuestToolsResponse, error)
*
Insert Nutanix Guest Tools ISO into an available slot. Insert Nutanix Guest Tools ISO into an available slot. parameters:- -> body (vmm.v4.ahv.config.GuestToolsInsertConfig) (required) -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.InsertVmGuestToolsResponse, error)
func (*VmApi) InstallVmGuestTools ¶
func (api *VmApi) InstallVmGuestTools(body *import2.GuestToolsInstallConfig, extId *string, args ...map[string]interface{}) (*import2.InstallVmGuestToolsResponse, error)
*
Install Nutanix Guest Tools. Install Nutanix Guest Tools. parameters:- -> body (vmm.v4.ahv.config.GuestToolsInstallConfig) (required) -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.InstallVmGuestToolsResponse, error)
func (*VmApi) ListCdroms ¶
func (api *VmApi) ListCdroms(vmExtId *string, page_ *int, limit_ *int, args ...map[string]interface{}) (*import2.ListCdromsResponse, error)
*
List CD-ROMs for the VM. List CD-ROMs for the VM. parameters:- -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> page_ (int) (optional) : A URL query parameter that specifies the page number of the result set. Must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range will lead to no results being returned. -> limit_ (int) (optional) : A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.ListCdromsResponse, error)
func (*VmApi) ListDisks ¶
func (api *VmApi) ListDisks(vmExtId *string, page_ *int, limit_ *int, args ...map[string]interface{}) (*import2.ListDisksResponse, error)
*
List Disks for the VM. List Disks for the VM. parameters:- -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> page_ (int) (optional) : A URL query parameter that specifies the page number of the result set. Must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range will lead to no results being returned. -> limit_ (int) (optional) : A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.ListDisksResponse, error)
func (*VmApi) ListGpus ¶
func (api *VmApi) ListGpus(vmExtId *string, page_ *int, limit_ *int, args ...map[string]interface{}) (*import2.ListGpusResponse, error)
*
List GPUs for the VM. List GPUs for the VM. parameters:- -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> page_ (int) (optional) : A URL query parameter that specifies the page number of the result set. Must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range will lead to no results being returned. -> limit_ (int) (optional) : A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.ListGpusResponse, error)
func (*VmApi) ListNics ¶
func (api *VmApi) ListNics(vmExtId *string, page_ *int, limit_ *int, args ...map[string]interface{}) (*import2.ListNicsResponse, error)
*
List NICs for the VM. List NICs for the VM. parameters:- -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> page_ (int) (optional) : A URL query parameter that specifies the page number of the result set. Must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range will lead to no results being returned. -> limit_ (int) (optional) : A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.ListNicsResponse, error)
func (*VmApi) ListSerialPorts ¶
func (api *VmApi) ListSerialPorts(vmExtId *string, page_ *int, limit_ *int, args ...map[string]interface{}) (*import2.ListSerialPortsResponse, error)
*
List SerialPort for the VM. List SerialPort for the VM. parameters:- -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> page_ (int) (optional) : A URL query parameter that specifies the page number of the result set. Must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range will lead to no results being returned. -> limit_ (int) (optional) : A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.ListSerialPortsResponse, error)
func (*VmApi) ListVms ¶
func (api *VmApi) ListVms(page_ *int, limit_ *int, filter_ *string, orderby_ *string, args ...map[string]interface{}) (*import2.ListVmsResponse, error)
*
List VMs. List VMs. parameters:- -> page_ (int) (optional) : A URL query parameter that specifies the page number of the result set. Must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range will lead to no results being returned. -> limit_ (int) (optional) : A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set. -> filter_ (string) (optional) : A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions. The filter can be applied on the following fields: - cluster/extId - cpuPassthroughEnabled - gpuConsoleEnabled - hardwareClockTimezone - host/extId - isAgentVm - liveMigrateCapable - machineType - memoryOvercommitEnabled - memorySizeBytes - name - numCoresPerSocket - numSockets - numThreadsPerCore - numVnumaNodes - powerState - vgaConsoleEnabled -> orderby_ (string) (optional) : A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified the resources will be sorted in ascending order by default. For example, 'orderby=templateName desc' would get all templates sorted by templateName in desc order. The orderby can be applied to the following fields: - memorySizeBytes - name - numCoresPerSocket - numSockets - numThreadsPerCore - numVnumaNodes -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.ListVmsResponse, error)
func (*VmApi) MigrateNic ¶
func (api *VmApi) MigrateNic(body *import2.MigrateNicConfig, vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.MigrateNicResponse, error)
*
Migrate a VM NIC. Migrate a VM NIC. parameters:- -> body (vmm.v4.ahv.config.MigrateNicConfig) (required) -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> extId (string) (required) : Globally unique identifier of a VM NIC. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.MigrateNicResponse, error)
func (*VmApi) PowerCycleVm ¶
func (api *VmApi) PowerCycleVm(extId *string, args ...map[string]interface{}) (*import2.PowerCycleVmResponse, error)
*
Restart the VM. Restart the VM. parameters:- -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.PowerCycleVmResponse, error)
func (*VmApi) PowerOffVm ¶
func (api *VmApi) PowerOffVm(extId *string, args ...map[string]interface{}) (*import2.PowerOffVmResponse, error)
*
Turn off the VM. Turn off the VM. parameters:- -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.PowerOffVmResponse, error)
func (*VmApi) PowerOnVm ¶
func (api *VmApi) PowerOnVm(extId *string, args ...map[string]interface{}) (*import2.PowerOnVmResponse, error)
*
Turn on the VM. Turn on the VM. parameters:- -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.PowerOnVmResponse, error)
func (*VmApi) RebootVm ¶
func (api *VmApi) RebootVm(body *import2.ACPIPowerOptions, extId *string, args ...map[string]interface{}) (*import2.RebootVmResponse, error)
*
Restart the VM using ACPI. Restart the VM using ACPI. parameters:- -> body (vmm.v4.ahv.config.ACPIPowerOptions) (required) -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.RebootVmResponse, error)
func (*VmApi) ReleaseIp ¶
func (api *VmApi) ReleaseIp(vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.ReleaseIpResponse, error)
*
Release an IP address from a VM NIC. Release an IP address from a VM NIC. parameters:- -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> extId (string) (required) : Globally unique identifier of a VM NIC. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.ReleaseIpResponse, error)
func (*VmApi) ResetVm ¶
func (api *VmApi) ResetVm(extId *string, args ...map[string]interface{}) (*import2.ResetVmResponse, error)
*
Reset the VM immediately without waiting for the guest VM to shutdown itself. Reset the VM immediately without waiting for the guest VM to shutdown itself. parameters:- -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.ResetVmResponse, error)
func (*VmApi) ShutdownVm ¶
func (api *VmApi) ShutdownVm(body *import2.ACPIPowerOptions, extId *string, args ...map[string]interface{}) (*import2.ShutdownVmResponse, error)
*
Shutdown the VM using ACPI. Shutdown the VM using ACPI. parameters:- -> body (vmm.v4.ahv.config.ACPIPowerOptions) (required) -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.ShutdownVmResponse, error)
func (*VmApi) UninstallVmGuestTools ¶
func (api *VmApi) UninstallVmGuestTools(extId *string, args ...map[string]interface{}) (*import2.UninstallVmGuestToolsResponse, error)
*
Uninstall Nutanix Guest Tools. Uninstall Nutanix Guest Tools. parameters:- -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.UninstallVmGuestToolsResponse, error)
func (*VmApi) UpdateCdrom ¶
func (api *VmApi) UpdateCdrom(body *import2.Cdrom, vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.UpdateCdromResponse, error)
*
Update CD-ROM for the VM. Update CD-ROM for the VM. parameters:- -> body (vmm.v4.ahv.config.Cdrom) (required) -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> extId (string) (required) : Globally unique identifier of a CD-ROM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.UpdateCdromResponse, error)
func (*VmApi) UpdateDisk ¶
func (api *VmApi) UpdateDisk(body *import2.Disk, vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.UpdateDiskResponse, error)
*
Update Disk for the VM. Update Disk for the VM. parameters:- -> body (vmm.v4.ahv.config.Disk) (required) -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> extId (string) (required) : Globally unique identifier of a VM disk. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.UpdateDiskResponse, error)
func (*VmApi) UpdateGuestTools ¶
func (api *VmApi) UpdateGuestTools(body *import2.GuestTools, extId *string, args ...map[string]interface{}) (*import2.UpdateGuestToolsResponse, error)
*
Update Nutanix Guest Tools information for a VM. Update Nutanix Guest Tools information for a VM. parameters:- -> body (vmm.v4.ahv.config.GuestTools) (required) -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.UpdateGuestToolsResponse, error)
func (*VmApi) UpdateNic ¶
func (api *VmApi) UpdateNic(body *import2.Nic, vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.UpdateNicResponse, error)
*
Update NIC for the VM. Update NIC for the VM. parameters:- -> body (vmm.v4.ahv.config.Nic) (required) -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> extId (string) (required) : Globally unique identifier of a VM NIC. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.UpdateNicResponse, error)
func (*VmApi) UpdateSerialPort ¶
func (api *VmApi) UpdateSerialPort(body *import2.SerialPort, vmExtId *string, extId *string, args ...map[string]interface{}) (*import2.UpdateSerialPortResponse, error)
*
Update SerialPort for the VM. Update SerialPort for the VM. parameters:- -> body (vmm.v4.ahv.config.SerialPort) (required) -> vmExtId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> extId (string) (required) : Globally unique identifier of a serial port. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.UpdateSerialPortResponse, error)
func (*VmApi) UpdateVm ¶
func (api *VmApi) UpdateVm(body *import2.Vm, extId *string, args ...map[string]interface{}) (*import2.UpdateVmResponse, error)
*
Update VM. Update VM. parameters:- -> body (vmm.v4.ahv.config.Vm) (required) -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.UpdateVmResponse, error)
func (*VmApi) UpdateVmCategories ¶
func (api *VmApi) UpdateVmCategories(body *[]import2.CategoryReference, extId *string, args ...map[string]interface{}) (*import2.UpdateVmCategoriesResponse, error)
*
Update categories for the VM. Update categories for the VM. parameters:- -> body ([]vmm.v4.ahv.config.CategoryReference) (required) -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.UpdateVmCategoriesResponse, error)
func (*VmApi) UpdateVmOwnershipInfo ¶
func (api *VmApi) UpdateVmOwnershipInfo(body *import2.OwnershipInfo, extId *string, args ...map[string]interface{}) (*import2.UpdateVmOwnershipInfoResponse, error)
*
Update ownership information for the VM. Update ownership information for the VM. parameters:- -> body (vmm.v4.ahv.config.OwnershipInfo) (required) -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.UpdateVmOwnershipInfoResponse, error)
func (*VmApi) UpgradeVmGuestTools ¶
func (api *VmApi) UpgradeVmGuestTools(body *import2.GuestToolsUpgradeConfig, extId *string, args ...map[string]interface{}) (*import2.UpgradeVmGuestToolsResponse, error)
*
Upgrade Nutanix Guest Tools. Upgrade Nutanix Guest Tools. parameters:- -> body (vmm.v4.ahv.config.GuestToolsUpgradeConfig) (required) -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.UpgradeVmGuestToolsResponse, error)
type VmDataProtectionApi ¶
func NewVmDataProtectionApi ¶
func NewVmDataProtectionApi(apiClient *client.ApiClient) *VmDataProtectionApi
func (*VmDataProtectionApi) RevertVm ¶
func (api *VmDataProtectionApi) RevertVm(body *import2.VmRevert, extId *string, args ...map[string]interface{}) (*import2.RevertVmResponse, error)
*
Revert VM identified by {extId}. This does an in-place VM restore from a specified VM Recovery Point. Revert VM identified by {extId}. This does an in-place VM restore from a specified VM Recovery Point. parameters:- -> body (vmm.v4.ahv.config.VmRevert) (required) : Specify the VM Recovery Point Id to which the VM would be reverted. -> extId (string) (required) : Globally unique identifier of a VM. It should be of type UUID. -> args (map[string]interface{}) (optional) : Additional Arguments returns: (*vmm.v4.ahv.config.RevertVmResponse, error)
Click to show internal directories.
Click to hide internal directories.