aljaz/kata-containers
1
0
Fork 0
mirror of https://github.com/aljazceru/kata-containers.git synced 2026-01-14 20:04:21 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
36f65ce182fe12ec1577c82db7f747a3ce97537e
kata-containers/src/runtime/virtcontainers/pkg/cloud-hypervisor/client/docs/DefaultApi.md
Julio Montes ea1cb37b59 versions: cloud-hypervisor: bump version 
Use commit c54452c08a467a3e35d8d72f2a91d424e9718c57 as
version for cloud-hypervisor.
Bring openapi fix cloud-hypervisor/cloud-hypervisor#1760 to
support SGX.

Signed-off-by: Julio Montes <julio.montes@intel.com>
2020-10-01 08:24:29 -05:00

17 KiB
Raw Blame History

\DefaultApi

All URIs are relative to http://localhost/api/v1

Method HTTP request Description
BootVM Put /vm.boot Boot the previously created VM instance.
CreateVM Put /vm.create Create the cloud-hypervisor Virtual Machine (VM) instance. The instance is not booted, only created.
DeleteVM Put /vm.delete Delete the cloud-hypervisor Virtual Machine (VM) instance.
PauseVM Put /vm.pause Pause a previously booted VM instance.
RebootVM Put /vm.reboot Reboot the VM instance.
ResumeVM Put /vm.resume Resume a previously paused VM instance.
ShutdownVM Put /vm.shutdown Shut the VM instance down.
ShutdownVMM Put /vmm.shutdown Shuts the cloud-hypervisor VMM.
VmAddDevicePut Put /vm.add-device Add a new device to the VM
VmAddDiskPut Put /vm.add-disk Add a new disk to the VM
VmAddFsPut Put /vm.add-fs Add a new virtio-fs device to the VM
VmAddNetPut Put /vm.add-net Add a new network device to the VM
VmAddPmemPut Put /vm.add-pmem Add a new pmem device to the VM
VmAddVsockPut Put /vm.add-vsock Add a new vsock device to the VM
VmCountersGet Get /vm.counters Get counters from the VM
VmInfoGet Get /vm.info Returns general information about the cloud-hypervisor Virtual Machine (VM) instance.
VmRemoveDevicePut Put /vm.remove-device Remove a device from the VM
VmResizePut Put /vm.resize Resize the VM
VmResizeZonePut Put /vm.resize-zone Resize a memory zone
VmRestorePut Put /vm.restore Restore a VM from a snapshot.
VmSnapshotPut Put /vm.snapshot Returns a VM snapshot.
VmmPingGet Get /vmm.ping Ping the VMM to check for API server availability

BootVM

BootVM(ctx, )

Boot the previously created VM instance.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateVM

CreateVM(ctx, vmConfig)

Create the cloud-hypervisor Virtual Machine (VM) instance. The instance is not booted, only created.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
vmConfig VmConfig The VM configuration

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteVM

DeleteVM(ctx, )

Delete the cloud-hypervisor Virtual Machine (VM) instance.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PauseVM

PauseVM(ctx, )

Pause a previously booted VM instance.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RebootVM

RebootVM(ctx, )

Reboot the VM instance.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ResumeVM

ResumeVM(ctx, )

Resume a previously paused VM instance.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ShutdownVM

ShutdownVM(ctx, )

Shut the VM instance down.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ShutdownVMM

ShutdownVMM(ctx, )

Shuts the cloud-hypervisor VMM.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VmAddDevicePut

PciDeviceInfo VmAddDevicePut(ctx, vmAddDevice)

Add a new device to the VM

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
vmAddDevice VmAddDevice The path of the new device

Return type

PciDeviceInfo

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VmAddDiskPut

PciDeviceInfo VmAddDiskPut(ctx, diskConfig)

Add a new disk to the VM

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
diskConfig DiskConfig The details of the new disk

Return type

PciDeviceInfo

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VmAddFsPut

PciDeviceInfo VmAddFsPut(ctx, fsConfig)

Add a new virtio-fs device to the VM

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
fsConfig FsConfig The details of the new virtio-fs

Return type

PciDeviceInfo

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VmAddNetPut

PciDeviceInfo VmAddNetPut(ctx, netConfig)

Add a new network device to the VM

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
netConfig NetConfig The details of the new network device

Return type

PciDeviceInfo

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VmAddPmemPut

PciDeviceInfo VmAddPmemPut(ctx, pmemConfig)

Add a new pmem device to the VM

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
pmemConfig PmemConfig The details of the new pmem device

Return type

PciDeviceInfo

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VmAddVsockPut

PciDeviceInfo VmAddVsockPut(ctx, vsockConfig)

Add a new vsock device to the VM

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
vsockConfig VsockConfig The details of the new vsock device

Return type

PciDeviceInfo

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VmCountersGet

map[string]map[string]int64 VmCountersGet(ctx, )

Get counters from the VM

Required Parameters

This endpoint does not need any parameter.

Return type

map[string]map[string]int64

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VmInfoGet

VmInfo VmInfoGet(ctx, )

Returns general information about the cloud-hypervisor Virtual Machine (VM) instance.

Required Parameters

This endpoint does not need any parameter.

Return type

VmInfo

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VmRemoveDevicePut

VmRemoveDevicePut(ctx, vmRemoveDevice)

Remove a device from the VM

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
vmRemoveDevice VmRemoveDevice The identifier of the device

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VmResizePut

VmResizePut(ctx, vmResize)

Resize the VM

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
vmResize VmResize The target size for the VM

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VmResizeZonePut

VmResizeZonePut(ctx, vmResizeZone)

Resize a memory zone

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
vmResizeZone VmResizeZone The target size for the memory zone

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VmRestorePut

VmRestorePut(ctx, restoreConfig)

Restore a VM from a snapshot.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
restoreConfig RestoreConfig The restore configuration

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VmSnapshotPut

VmSnapshotPut(ctx, vmSnapshotConfig)

Returns a VM snapshot.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
vmSnapshotConfig VmSnapshotConfig The snapshot configuration

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VmmPingGet

VmmPingResponse VmmPingGet(ctx, )

Ping the VMM to check for API server availability

Required Parameters

This endpoint does not need any parameter.

Return type

VmmPingResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]