https://github.com/fred78290/vmrest-go-client

Client API for vmrest
https://github.com/fred78290/vmrest-go-client

api golang-api golang-library vmrest vmware vmware-fusion vmware-tools vmware-workstation

Last synced: about 1 year ago
JSON representation

Client API for vmrest

• Host: GitHub
• URL: https://github.com/fred78290/vmrest-go-client
• Owner: Fred78290
• License: apache-2.0
• Created: 2023-02-01T13:59:24.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-01-25T17:07:37.000Z (over 2 years ago)
• Last Synced: 2024-06-22T02:13:21.509Z (about 2 years ago)
• Topics: api, golang-api, golang-library, vmrest, vmware, vmware-fusion, vmware-tools, vmware-workstation
• Language: Go
• Homepage:
• Size: 91.8 KB
• Stars: 3
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![All builds](https://github.com/Fred78290/vmrest-go-client/actions/workflows/main.yml/badge.svg)](https://github.com/Fred78290/vmrest-go-client/actions/workflows/main.yml)[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Fred78290_vmrest-go-glient&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Fred78290_vmrest-go-glient)

[![Licence](https://img.shields.io/hexpm/l/plug.svg)](https://github.com/Fred78290/vmrest-go-client/blob/master/LICENSE)

# Go API client for vmrest

vmrest 1.3.0 build-20800274

## Overview

This API client was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project.  By using the [swagger-spec](https://github.com/swagger-api/swagger-spec) from a remote server, you can easily generate an API client.

- API version: 1.3.0

- Package version: 1.0.0

- Build package: io.swagger.codegen.languages.GoClientCodegen

## Installation

go get github.com/Fred78290/vmrest-go-client

## Documentation for API Endpoints

Class | Method | HTTP request | Description

------------ | ------------- | ------------- | -------------

*HostNetworksManagementApi* | [**CreateNetwork**](docs/HostNetworksManagementApi.md#createnetwork) | **Post** /vmnets | Creates a virtual network

*HostNetworksManagementApi* | [**DeletePortforward**](docs/HostNetworksManagementApi.md#deleteportforward) | **Delete** /vmnet/{vmnet}/portforward/{protocol}/{port} | Deletes port forwarding

*HostNetworksManagementApi* | [**GetAllNetworks**](docs/HostNetworksManagementApi.md#getallnetworks) | **Get** /vmnet | Returns all virtual networks

*HostNetworksManagementApi* | [**GetMACToIPs**](docs/HostNetworksManagementApi.md#getmactoips) | **Get** /vmnet/{vmnet}/mactoip | Returns all MAC-to-IP settings for DHCP service

*HostNetworksManagementApi* | [**GetPortforwards**](docs/HostNetworksManagementApi.md#getportforwards) | **Get** /vmnet/{vmnet}/portforward | Returns all port forwardings

*HostNetworksManagementApi* | [**UpdateMacToIP**](docs/HostNetworksManagementApi.md#updatemactoip) | **Put** /vmnet/{vmnet}/mactoip/{mac} | Updates the MAC-to-IP binding

*HostNetworksManagementApi* | [**UpdatePortforward**](docs/HostNetworksManagementApi.md#updateportforward) | **Put** /vmnet/{vmnet}/portforward/{protocol}/{port} | Updates port forwarding

*VMManagementApi* | [**ConfigVMParams**](docs/VMManagementApi.md#configvmparams) | **Put** /vms/{id}/configparams | update the vm config params

*VMManagementApi* | [**CreateVM**](docs/VMManagementApi.md#createvm) | **Post** /vms | Creates a copy of the VM

*VMManagementApi* | [**DeleteVM**](docs/VMManagementApi.md#deletevm) | **Delete** /vms/{id} | Deletes a VM

*VMManagementApi* | [**GetAllVMs**](docs/VMManagementApi.md#getallvms) | **Get** /vms | Returns a list of VM IDs and paths for all VMs

*VMManagementApi* | [**GetVM**](docs/VMManagementApi.md#getvm) | **Get** /vms/{id} | Returns the VM setting information of a VM

*VMManagementApi* | [**GetVMParams**](docs/VMManagementApi.md#getvmparams) | **Get** /vms/{id}/params/{name} | Get the VM config params

*VMManagementApi* | [**GetVMRestrictions**](docs/VMManagementApi.md#getvmrestrictions) | **Get** /vms/{id}/restrictions | Returns the restrictions information of the VM

*VMManagementApi* | [**RegisterVM**](docs/VMManagementApi.md#registervm) | **Post** /vms/registration | Register VM to VM Library

*VMManagementApi* | [**UpdateVM**](docs/VMManagementApi.md#updatevm) | **Put** /vms/{id} | Updates the VM settings

*VMNetworkAdaptersManagementApi* | [**CreateNICDevice**](docs/VMNetworkAdaptersManagementApi.md#createnicdevice) | **Post** /vms/{id}/nic | Creates a network adapter in the VM

*VMNetworkAdaptersManagementApi* | [**DeleteNICDevice**](docs/VMNetworkAdaptersManagementApi.md#deletenicdevice) | **Delete** /vms/{id}/nic/{index} | Deletes a VM network adapter

*VMNetworkAdaptersManagementApi* | [**GetAllNICDevices**](docs/VMNetworkAdaptersManagementApi.md#getallnicdevices) | **Get** /vms/{id}/nic | Returns all network adapters in the VM

*VMNetworkAdaptersManagementApi* | [**GetIPAddress**](docs/VMNetworkAdaptersManagementApi.md#getipaddress) | **Get** /vms/{id}/ip | Returns the IP address of a VM

*VMNetworkAdaptersManagementApi* | [**GetNicInfo**](docs/VMNetworkAdaptersManagementApi.md#getnicinfo) | **Get** /vms/{id}/nicips | Returns the IP stack configuration of all NICs of a VM

*VMNetworkAdaptersManagementApi* | [**UpdateNICDevice**](docs/VMNetworkAdaptersManagementApi.md#updatenicdevice) | **Put** /vms/{id}/nic/{index} | Updates a network adapter in the VM

*VMPowerManagementApi* | [**ChangePowerState**](docs/VMPowerManagementApi.md#changepowerstate) | **Put** /vms/{id}/power | Changes the VM power state

*VMPowerManagementApi* | [**GetPowerState**](docs/VMPowerManagementApi.md#getpowerstate) | **Get** /vms/{id}/power | Returns the power state of the VM

*VMSharedFoldersManagementApi* | [**CreateSharedFolder**](docs/VMSharedFoldersManagementApi.md#createsharedfolder) | **Post** /vms/{id}/sharedfolders | Mounts a new shared folder in the VM

*VMSharedFoldersManagementApi* | [**DeleteSharedFolder**](docs/VMSharedFoldersManagementApi.md#deletesharedfolder) | **Delete** /vms/{id}/sharedfolders/{folder id} | Deletes a shared folder

*VMSharedFoldersManagementApi* | [**GetAllSharedFolders**](docs/VMSharedFoldersManagementApi.md#getallsharedfolders) | **Get** /vms/{id}/sharedfolders | Returns all shared folders mounted in the VM

*VMSharedFoldersManagementApi* | [**UpdataSharedFolder**](docs/VMSharedFoldersManagementApi.md#updatasharedfolder) | **Put** /vms/{id}/sharedfolders/{folder id} | Updates a shared folder mounted in the VM

## Documentation For Models

- [ConfigVmParamsParameter](docs/ConfigVmParamsParameter.md)

- [CreateVmnetParameter](docs/CreateVmnetParameter.md)

- [DaemonState](docs/DaemonState.md)

- [DhcpConfig](docs/DhcpConfig.md)

- [DnsConfig](docs/DnsConfig.md)

- [ErrorModel](docs/ErrorModel.md)

- [InlineResponse200](docs/InlineResponse200.md)

- [IpAddress](docs/IpAddress.md)

- [IpNetAddress](docs/IpNetAddress.md)

- [MacAddress](docs/MacAddress.md)

- [MacToIpParameter](docs/MacToIpParameter.md)

- [MactoIp](docs/MactoIp.md)

- [MactoIps](docs/MactoIps.md)

- [Network](docs/Network.md)

- [Networks](docs/Networks.md)

- [NicDevice](docs/NicDevice.md)

- [NicDeviceParameter](docs/NicDeviceParameter.md)

- [NicDevices](docs/NicDevices.md)

- [NicIndex](docs/NicIndex.md)

- [NicIpStack](docs/NicIpStack.md)

- [NicIpStackAll](docs/NicIpStackAll.md)

- [NicNumber](docs/NicNumber.md)

- [Number](docs/Number.md)

- [Port](docs/Port.md)

- [Portforward](docs/Portforward.md)

- [PortforwardGuest](docs/PortforwardGuest.md)

- [PortforwardParameter](docs/PortforwardParameter.md)

- [Portforwards](docs/Portforwards.md)

- [RouteEntry](docs/RouteEntry.md)

- [SharedFolder](docs/SharedFolder.md)

- [SharedFolderParameter](docs/SharedFolderParameter.md)

- [SharedFolders](docs/SharedFolders.md)

- [VmApplianceView](docs/VmApplianceView.md)

- [VmCloneParameter](docs/VmCloneParameter.md)

- [VmConnectedDevice](docs/VmConnectedDevice.md)

- [VmConnectedDeviceList](docs/VmConnectedDeviceList.md)

- [VmGuestIsolation](docs/VmGuestIsolation.md)

- [VmInformation](docs/VmInformation.md)

- [VmMemory](docs/VmMemory.md)

- [VmParameter](docs/VmParameter.md)

- [VmPowerOperation](docs/VmPowerOperation.md)

- [VmPowerState](docs/VmPowerState.md)

- [VmProcessors](docs/VmProcessors.md)

- [VmRegisterParameter](docs/VmRegisterParameter.md)

- [VmRemoteVnc](docs/VmRemoteVnc.md)

- [VmRestrictionsInformation](docs/VmRestrictionsInformation.md)

- [VmRrgistrationInformation](docs/VmRrgistrationInformation.md)

- [VmUsbDevice](docs/VmUsbDevice.md)

- [VmUsbList](docs/VmUsbList.md)

- [Vmcpu](docs/Vmcpu.md)

- [Vmid](docs/Vmid.md)

- [WinsConfig](docs/WinsConfig.md)

## Example

``` go

import (

  "github.com/Fred78290/vmrest-go-client/client"

)

func main() {

  cfg := client.NewConfiguration("username", "password", 8697, true)

  if client, err := client.NewAPIClient(cfg); err == nil {

    vms, _ := client.GetAllVMs()

  }

}

```