github/kata-containers
1
0
Fork 2
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-09-28 20:15:51 +00:00
Code Issues Projects Releases Wiki Activity
Files
4887ce059c648d000b22fd86373f29fc90a44e80
kata-containers/src/runtime/virtcontainers/pkg/cloud-hypervisor/client/docs/DefaultApi.md
Bo Chen 4887ce059c versions: Move to cloud-hypervisor v0.7.0 
Changes:

96be8229 release: Release v0.7.0
5115ad6e vmm: config: Support on/off/true/false for all booleans
d5bfa2df vmm, vhost_user_block: Make parameter names match --disk
2f0bc06b vmm: Update default devices names as "internal"
aaba6e77 vmm: Add virtio-console to the list of Migratable devices
9ab4bb1a devices: serial: Expect an identifier upon device creation
06487131 vm-virtio: pci: Expect an identifier upon device creation
eeb7e10d vm-virtio: mmio: Expect an identifier upon device creation
9d84ef50 vmm: Make the virtio identifier mandatory
14350f5d devices: ioapic: Expect an identifier upon device creation
55687157 vm-virtio: iommu: Expect an identifier upon device creation
052eff1c vm-virtio: console: Expect an identifier upon device creation
354c2a4b vm-virtio: vhost-user-net: Expect an identifier upon device creation
46e0b3ff vm-virtio: vhost-user-blk: Expect an identifier upon device creation
bb7fa71f vm-virtio: vhost-user-fs: Expect an identifier upon device creation
ec5ff395 vm-virtio: vsock: Expect an identifier upon device creation
9b53044a vm-virtio: mem: Expect an identifier upon device creation
1592a929 vm-virtio: pmem: Expect an identifier upon device creation
2e91b738 vm-virtio: rng: Expect an identifier upon device creation
9eb7413f vm-virtio: net: Expect an identifier upon device creation
be946caf vm-virtio: blk: Expect an identifier upon device creation
ff9c8b84 vmm: Always generate the next device name
81831413 vmm: Add an identifier to the ioapic device
e4386c8b vmm: Add an identifier to the virtio-iommu device
75ddd2a2 vmm: Add an identifier to the --console device
eac350c4 vmm: Add an identifier to the virtio-mem device
6802ef54 vmm: Add an identifier to the --rng device
d71d52e9 vmm: Fix virtio-console creation with virtual IOMMU
b08fde59 vmm: Fix virtio-rng creation with virtual IOMMU
8031ac33 vmm: Fix virtio-vsock creation with virtual IOMMU
50134969 Jenkins: Run musl unit and integration tests on master branch
ce794f78 ci: Pass target triple to the test scripts
33b0e158 resources: Add musl tools and toolchain to the Dockerfile
ad9374bd dev_cli: Add --libc to the build and test commands
8cef3574 vmm: seccomp: Add fork, gettid and pipe2 syscalls to permitted list
ce7678f2 vmm: seccomp: Add tkill syscall to permitted list
12758d7f vmm: seccomp: Add epoll_pwait syscall to permitted list
86fcd19b build: Initial musl support
a5de4955 vmm: Only allow removal of specific types of virtio device
9ed880d7 vmm: Add an identifier to the --fs device
7e0ab6b5 vmm: Fix pmem device creation
3012975c tests: Enhance vsock integration test to support hotplug
6c2bca5f bin: ch-remote: Add support for adding vsock devices
8de7448d vmm: api: Add "add-vsock" API entry point
bf09a1e6 openapi: Add "id" field to VsockConfig
a76cf086 vmm: vm: Remove vsock device from config
99422324 vmm: vm: Add "add_vsock()"
1d61c476 vmm: device_manager: Add support for hotplugging virtio-vsock devices
f8501a3b vmm: config: Move --vsock syntax to VsockConfig
6e049e0d vmm: Add an identifier to the --vsock device
10348f73 vmm, main: Support only zero or one vsock devices
9d1f95a3 openapi: Add missing "id" field
30e2e515 build(deps): bump serde_json from 1.0.51 to 1.0.52
dd9d0d04 build(deps): bump micro_http from `0d87a94` to `c9ffb90`
cdc8493a build(deps): bump thiserror from 1.0.15 to 1.0.16

Fixes: kata-containers/runtime#2658
Signed-off-by: Bo Chen <chen.bo@intel.com>
Signed-off-by: Peng Tao <bergwolf@hyper.sh>
2020-05-26 00:51:01 -07:00

15 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
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
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

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

(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]

VmAddDiskPut

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

(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]

VmAddFsPut

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

(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]

VmAddNetPut

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

(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]

VmAddPmemPut

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

(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]

VmAddVsockPut

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

(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]

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]

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]