Rust API client for openapi

Local HTTP based API for managing and inspecting a cloud-hypervisor virtual machine.

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

• API version: 0.3.0
• Package version: 0.3.0
• Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named openapi and add the following to Cargo.toml under [dependencies]:

openapi = { path = "./openapi" }

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
DefaultApi	boot_vm	PUT /vm.boot	Boot the previously created VM instance.
DefaultApi	create_vm	PUT /vm.create	Create the cloud-hypervisor Virtual Machine (VM) instance. The instance is not booted, only created.
DefaultApi	delete_vm	PUT /vm.delete	Delete the cloud-hypervisor Virtual Machine (VM) instance.
DefaultApi	pause_vm	PUT /vm.pause	Pause a previously booted VM instance.
DefaultApi	power_button_vm	PUT /vm.power-button	Trigger a power button in the VM
DefaultApi	reboot_vm	PUT /vm.reboot	Reboot the VM instance.
DefaultApi	resume_vm	PUT /vm.resume	Resume a previously paused VM instance.
DefaultApi	shutdown_vm	PUT /vm.shutdown	Shut the VM instance down.
DefaultApi	shutdown_vmm	PUT /vmm.shutdown	Shuts the cloud-hypervisor VMM.
DefaultApi	vm_add_device_put	PUT /vm.add-device	Add a new device to the VM
DefaultApi	vm_add_disk_put	PUT /vm.add-disk	Add a new disk to the VM
DefaultApi	vm_add_fs_put	PUT /vm.add-fs	Add a new virtio-fs device to the VM
DefaultApi	vm_add_net_put	PUT /vm.add-net	Add a new network device to the VM
DefaultApi	vm_add_pmem_put	PUT /vm.add-pmem	Add a new pmem device to the VM
DefaultApi	vm_add_user_device_put	PUT /vm.add-user-device	Add a new userspace device to the VM
DefaultApi	vm_add_vdpa_put	PUT /vm.add-vdpa	Add a new vDPA device to the VM
DefaultApi	vm_add_vsock_put	PUT /vm.add-vsock	Add a new vsock device to the VM
DefaultApi	vm_coredump_put	PUT /vm.coredump	Takes a VM coredump.
DefaultApi	vm_counters_get	GET /vm.counters	Get counters from the VM
DefaultApi	vm_info_get	GET /vm.info	Returns general information about the cloud-hypervisor Virtual Machine (VM) instance.
DefaultApi	vm_receive_migration_put	PUT /vm.receive-migration	Receive a VM migration from URL
DefaultApi	vm_remove_device_put	PUT /vm.remove-device	Remove a device from the VM
DefaultApi	vm_resize_put	PUT /vm.resize	Resize the VM
DefaultApi	vm_resize_zone_put	PUT /vm.resize-zone	Resize a memory zone
DefaultApi	vm_restore_put	PUT /vm.restore	Restore a VM from a snapshot.
DefaultApi	vm_send_migration_put	PUT /vm.send-migration	Send a VM migration to URL
DefaultApi	vm_snapshot_put	PUT /vm.snapshot	Returns a VM snapshot.
DefaultApi	vmm_ping_get	GET /vmm.ping	Ping the VMM to check for API server availability

Documentation For Models

• BalloonConfig
• ConsoleConfig
• CpuAffinity
• CpuFeatures
• CpuTopology
• CpusConfig
• DebugConsoleConfig
• DeviceConfig
• DeviceNode
• DiskConfig
• FsConfig
• MemoryConfig
• MemoryZoneConfig
• NetConfig
• NumaConfig
• NumaDistance
• PayloadConfig
• PciDeviceInfo
• PlatformConfig
• PmemConfig
• RateLimitGroupConfig
• RateLimiterConfig
• ReceiveMigrationData
• RestoreConfig
• RngConfig
• SendMigrationData
• SgxEpcConfig
• TokenBucket
• TpmConfig
• VdpaConfig
• VirtQueueAffinity
• VmAddUserDevice
• VmConfig
• VmCoredumpData
• VmInfo
• VmRemoveDevice
• VmResize
• VmResizeZone
• VmSnapshotConfig
• VmmPingResponse
• VsockConfig

To get access to the crate's generated documentation, use:

cargo doc --open

Author