Metadata-Version: 2.4
Name: kubevim_client
Version: 1.0.0a1
Summary: Kube-VIM API
Home-page: 
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,OpenAPI-Generator,Kube-VIM API
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.7.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# kubevim-client
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0-alpha.1
- Package version: 1.0.0a1
- Generator version: 7.26.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.10+

Packaging uses standard `[project]` metadata and `[dependency-groups]` (PEP 621/735).
Install the package with `python -m pip install .`; install development dependencies
with Poetry 2.2 or newer using `poetry install`, or pip 25.1 or newer using
`python -m pip install --group dev`. The latter installs the group, not the package.

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import kubevim_client
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import kubevim_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import kubevim_client
from kubevim_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubevim_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
with kubevim_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kubevim_client.ComputeServiceApi(api_client)
    compute_id = 'compute_id_example' # str | Identifier of the compute resource.
    attach_volume_request = kubevim_client.AttachVolumeRequest() # AttachVolumeRequest | 

    try:
        # Attaches a volume to a compute resource.
        api_response = api_instance.attach_volume(compute_id, attach_volume_request)
        print("The response of ComputeServiceApi->attach_volume:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ComputeServiceApi->attach_volume: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ComputeServiceApi* | [**attach_volume**](docs/ComputeServiceApi.md#attach_volume) | **POST** /compute/v1/computes/{compute_id}/attachVolume | Attaches a volume to a compute resource.
*ComputeServiceApi* | [**create_compute**](docs/ComputeServiceApi.md#create_compute) | **POST** /compute/v1/computes | Creates a compute resource.
*ComputeServiceApi* | [**create_compute_snapshot**](docs/ComputeServiceApi.md#create_compute_snapshot) | **POST** /compute/v1/computes/{compute_id}/snapshots | Creates a snapshot of a compute resource.
*ComputeServiceApi* | [**create_placement_group**](docs/ComputeServiceApi.md#create_placement_group) | **POST** /compute/v1/placementGroups | Creates a placement group.
*ComputeServiceApi* | [**delete_compute**](docs/ComputeServiceApi.md#delete_compute) | **DELETE** /compute/v1/computes/{compute_id} | Deletes a compute resource with its boot disk and the disks from its flavour. Attached volumes are detached and kept unless delete_volumes is set; snapshots are kept.
*ComputeServiceApi* | [**delete_compute_snapshot**](docs/ComputeServiceApi.md#delete_compute_snapshot) | **DELETE** /compute/v1/computes/{compute_id}/snapshots/{snapshot_id} | Deletes a snapshot of a compute resource.
*ComputeServiceApi* | [**delete_placement_group**](docs/ComputeServiceApi.md#delete_placement_group) | **DELETE** /compute/v1/placementGroups/{placement_group_id} | Deletes a placement group that has no members.
*ComputeServiceApi* | [**detach_volume**](docs/ComputeServiceApi.md#detach_volume) | **POST** /compute/v1/computes/{compute_id}/detachVolume | Detaches a volume from a compute resource.
*ComputeServiceApi* | [**get_compute**](docs/ComputeServiceApi.md#get_compute) | **GET** /compute/v1/computes/{compute_id} | Returns one compute resource.
*ComputeServiceApi* | [**get_compute_snapshot**](docs/ComputeServiceApi.md#get_compute_snapshot) | **GET** /compute/v1/computes/{compute_id}/snapshots/{snapshot_id} | Returns one snapshot of a compute resource, also after the compute resource is deleted.
*ComputeServiceApi* | [**get_placement_group**](docs/ComputeServiceApi.md#get_placement_group) | **GET** /compute/v1/placementGroups/{placement_group_id} | Returns one placement group.
*ComputeServiceApi* | [**list_compute_snapshots**](docs/ComputeServiceApi.md#list_compute_snapshots) | **GET** /compute/v1/computes/{compute_id}/snapshots | Returns the snapshots of a compute resource, or of all compute resources with compute_id \&quot;-\&quot;.
*ComputeServiceApi* | [**list_computes**](docs/ComputeServiceApi.md#list_computes) | **GET** /compute/v1/computes | Returns the compute resources matching a filter.
*ComputeServiceApi* | [**list_placement_groups**](docs/ComputeServiceApi.md#list_placement_groups) | **GET** /compute/v1/placementGroups | Returns the placement groups.
*ComputeServiceApi* | [**migrate_compute**](docs/ComputeServiceApi.md#migrate_compute) | **POST** /compute/v1/computes/{compute_id}/migrate | Moves a running compute resource to another host (live migration).
*ComputeServiceApi* | [**operate_compute**](docs/ComputeServiceApi.md#operate_compute) | **POST** /compute/v1/computes/{compute_id}/operate | Changes the running state of a compute resource, e.g. start, stop or reboot.
*ComputeServiceApi* | [**revert_compute_snapshot**](docs/ComputeServiceApi.md#revert_compute_snapshot) | **POST** /compute/v1/computes/{compute_id}/snapshots/{snapshot_id}/revert | Reverts a stopped compute resource to a snapshot; not possible once the compute resource is deleted.
*ComputeServiceApi* | [**scale_compute**](docs/ComputeServiceApi.md#scale_compute) | **POST** /compute/v1/computes/{compute_id}/scale | Changes the flavour of a compute resource; live where KubeVirt can hotplug, otherwise restart_required is set. Disks that are larger in the new flavour are grown; shrinking a disk or changing the number, type, boot flag or storage class of the disks is rejected.
*ComputeServiceApi* | [**update_compute**](docs/ComputeServiceApi.md#update_compute) | **PATCH** /compute/v1/computes/{compute_id} | Updates a compute resource: its name and metadata, and adds or removes network interfaces.
*FlavourServiceApi* | [**create_flavour**](docs/FlavourServiceApi.md#create_flavour) | **POST** /flavour/v1/flavours | Creates a compute flavour.
*FlavourServiceApi* | [**delete_flavour**](docs/FlavourServiceApi.md#delete_flavour) | **DELETE** /flavour/v1/flavours/{flavour_id} | Deletes a compute flavour. Compute resources already created from it are not affected.
*FlavourServiceApi* | [**get_flavour**](docs/FlavourServiceApi.md#get_flavour) | **GET** /flavour/v1/flavours/{flavour_id} | Returns one compute flavour.
*FlavourServiceApi* | [**list_flavours**](docs/FlavourServiceApi.md#list_flavours) | **GET** /flavour/v1/flavours | Returns the compute flavours matching a filter.
*ImageServiceApi* | [**create_image**](docs/ImageServiceApi.md#create_image) | **POST** /image/v1/images | Adds a software image to the image repository managed by the VIM.
*ImageServiceApi* | [**delete_image**](docs/ImageServiceApi.md#delete_image) | **DELETE** /image/v1/images/{image_id} | Deletes a software image and its imported copies; compute resources created from it keep their disks.
*ImageServiceApi* | [**get_image**](docs/ImageServiceApi.md#get_image) | **GET** /image/v1/images/{image_id} | Returns one software image.
*ImageServiceApi* | [**list_image_sources**](docs/ImageServiceApi.md#list_image_sources) | **GET** /image/v1/imageSources | Returns the image source types this VIM accepts.
*ImageServiceApi* | [**list_images**](docs/ImageServiceApi.md#list_images) | **GET** /image/v1/images | Returns the software images matching a filter, including images of catalog backends.
*ImageServiceApi* | [**update_image**](docs/ImageServiceApi.md#update_image) | **PATCH** /image/v1/images/{image_id} | Updates the name and metadata of a software image.
*NetworkServiceApi* | [**create_network**](docs/NetworkServiceApi.md#create_network) | **POST** /network/v1/networks | Creates a network.
*NetworkServiceApi* | [**create_subnet**](docs/NetworkServiceApi.md#create_subnet) | **POST** /network/v1/subnets | Creates a subnet.
*NetworkServiceApi* | [**delete_network**](docs/NetworkServiceApi.md#delete_network) | **DELETE** /network/v1/networks/{network_id} | Deletes a network and its subnets; may fail with RESOURCE_IN_USE while interfaces use the network.
*NetworkServiceApi* | [**delete_subnet**](docs/NetworkServiceApi.md#delete_subnet) | **DELETE** /network/v1/subnets/{subnet_id} | Deletes a subnet: one IP version of a network. May fail with RESOURCE_IN_USE while interfaces use the network; the last subnet of a Kube-OVN network cannot be deleted (delete the network instead).
*NetworkServiceApi* | [**get_network**](docs/NetworkServiceApi.md#get_network) | **GET** /network/v1/networks/{network_id} | Returns one network.
*NetworkServiceApi* | [**get_subnet**](docs/NetworkServiceApi.md#get_subnet) | **GET** /network/v1/subnets/{subnet_id} | Returns one subnet.
*NetworkServiceApi* | [**list_networks**](docs/NetworkServiceApi.md#list_networks) | **GET** /network/v1/networks | Returns the networks matching a filter.
*NetworkServiceApi* | [**list_subnets**](docs/NetworkServiceApi.md#list_subnets) | **GET** /network/v1/subnets | Returns the subnets matching a filter.
*NetworkServiceApi* | [**update_network**](docs/NetworkServiceApi.md#update_network) | **PATCH** /network/v1/networks/{network_id} | Updates the name and metadata of a network.
*NetworkServiceApi* | [**update_subnet**](docs/NetworkServiceApi.md#update_subnet) | **PATCH** /network/v1/subnets/{subnet_id} | Updates the name and metadata of a subnet.
*StorageServiceApi* | [**create_volume**](docs/StorageServiceApi.md#create_volume) | **POST** /storage/v1/volumes | Creates a volume.
*StorageServiceApi* | [**create_volume_snapshot**](docs/StorageServiceApi.md#create_volume_snapshot) | **POST** /storage/v1/volumes/{volume_id}/snapshots | Creates a snapshot of a volume.
*StorageServiceApi* | [**delete_volume**](docs/StorageServiceApi.md#delete_volume) | **DELETE** /storage/v1/volumes/{volume_id} | Deletes a volume; may fail with RESOURCE_IN_USE while the volume is attached. Snapshots are kept.
*StorageServiceApi* | [**delete_volume_snapshot**](docs/StorageServiceApi.md#delete_volume_snapshot) | **DELETE** /storage/v1/volumes/{volume_id}/snapshots/{snapshot_id} | Deletes a snapshot of a volume.
*StorageServiceApi* | [**get_volume**](docs/StorageServiceApi.md#get_volume) | **GET** /storage/v1/volumes/{volume_id} | Returns one volume.
*StorageServiceApi* | [**get_volume_snapshot**](docs/StorageServiceApi.md#get_volume_snapshot) | **GET** /storage/v1/volumes/{volume_id}/snapshots/{snapshot_id} | Returns one snapshot of a volume, also after the volume is deleted.
*StorageServiceApi* | [**list_volume_snapshots**](docs/StorageServiceApi.md#list_volume_snapshots) | **GET** /storage/v1/volumes/{volume_id}/snapshots | Returns the snapshots of a volume, or of all volumes with volume_id \&quot;-\&quot;.
*StorageServiceApi* | [**list_volumes**](docs/StorageServiceApi.md#list_volumes) | **GET** /storage/v1/volumes | Returns the volumes matching a filter; the own disks of compute resources are not volumes (see Compute.disks).
*StorageServiceApi* | [**migrate_volume**](docs/StorageServiceApi.md#migrate_volume) | **POST** /storage/v1/volumes/{volume_id}/migrate | Moves a volume to another storage class.
*StorageServiceApi* | [**revert_volume_snapshot**](docs/StorageServiceApi.md#revert_volume_snapshot) | **POST** /storage/v1/volumes/{volume_id}/snapshots/{snapshot_id}/revert | Reverts a volume that no running compute resource uses to a snapshot; not possible once the volume is deleted.
*StorageServiceApi* | [**scale_volume**](docs/StorageServiceApi.md#scale_volume) | **POST** /storage/v1/volumes/{volume_id}/scale | Grows a volume.
*StorageServiceApi* | [**update_volume**](docs/StorageServiceApi.md#update_volume) | **PATCH** /storage/v1/volumes/{volume_id} | Updates the name and metadata of a volume.


## Documentation For Models

 - [AttachVolumeRequest](docs/AttachVolumeRequest.md)
 - [BasicAuth](docs/BasicAuth.md)
 - [Compute](docs/Compute.md)
 - [ComputeOperation](docs/ComputeOperation.md)
 - [ComputeRunningState](docs/ComputeRunningState.md)
 - [ComputeSnapshot](docs/ComputeSnapshot.md)
 - [ComputeUpdate](docs/ComputeUpdate.md)
 - [ContainerFormat](docs/ContainerFormat.md)
 - [CpuArchitecture](docs/CpuArchitecture.md)
 - [CpuTopology](docs/CpuTopology.md)
 - [CreateComputeRequest](docs/CreateComputeRequest.md)
 - [CreateComputeSnapshotRequest](docs/CreateComputeSnapshotRequest.md)
 - [CreateFlavourRequest](docs/CreateFlavourRequest.md)
 - [CreateImageRequest](docs/CreateImageRequest.md)
 - [CreateNetworkRequest](docs/CreateNetworkRequest.md)
 - [CreatePlacementGroupRequest](docs/CreatePlacementGroupRequest.md)
 - [CreateSubnetRequest](docs/CreateSubnetRequest.md)
 - [CreateVolumeRequest](docs/CreateVolumeRequest.md)
 - [CreateVolumeSnapshotRequest](docs/CreateVolumeSnapshotRequest.md)
 - [DetachVolumeRequest](docs/DetachVolumeRequest.md)
 - [DiskBus](docs/DiskBus.md)
 - [DiskFormat](docs/DiskFormat.md)
 - [Firmware](docs/Firmware.md)
 - [Flavour](docs/Flavour.md)
 - [GlanceSource](docs/GlanceSource.md)
 - [HttpSource](docs/HttpSource.md)
 - [Image](docs/Image.md)
 - [ImageSource](docs/ImageSource.md)
 - [ImageSourceGlance](docs/ImageSourceGlance.md)
 - [ImageSourceHttp](docs/ImageSourceHttp.md)
 - [ImageSourceLocal](docs/ImageSourceLocal.md)
 - [ImageSourceRegistry](docs/ImageSourceRegistry.md)
 - [ImageSourceS3](docs/ImageSourceS3.md)
 - [ImageSourceType](docs/ImageSourceType.md)
 - [ImageSourceUpload](docs/ImageSourceUpload.md)
 - [ImageStatus](docs/ImageStatus.md)
 - [ImageUpdate](docs/ImageUpdate.md)
 - [ImportPolicy](docs/ImportPolicy.md)
 - [IpAddressPool](docs/IpAddressPool.md)
 - [IpAssignment](docs/IpAssignment.md)
 - [IpVersion](docs/IpVersion.md)
 - [LocalSource](docs/LocalSource.md)
 - [MigrateVolumeRequest](docs/MigrateVolumeRequest.md)
 - [Network](docs/Network.md)
 - [NetworkInterfaceData](docs/NetworkInterfaceData.md)
 - [NetworkType](docs/NetworkType.md)
 - [NetworkUpdate](docs/NetworkUpdate.md)
 - [NicModel](docs/NicModel.md)
 - [OperateComputeRequest](docs/OperateComputeRequest.md)
 - [OperationalState](docs/OperationalState.md)
 - [PlacementEnforcement](docs/PlacementEnforcement.md)
 - [PlacementGroup](docs/PlacementGroup.md)
 - [PlacementScope](docs/PlacementScope.md)
 - [PlacementType](docs/PlacementType.md)
 - [ProblemDetails](docs/ProblemDetails.md)
 - [RegistrySource](docs/RegistrySource.md)
 - [RegistrySourcePullMethod](docs/RegistrySourcePullMethod.md)
 - [S3AccessKey](docs/S3AccessKey.md)
 - [S3Source](docs/S3Source.md)
 - [ScaleComputeRequest](docs/ScaleComputeRequest.md)
 - [ScaleVolumeRequest](docs/ScaleVolumeRequest.md)
 - [SnapshotStatus](docs/SnapshotStatus.md)
 - [Subnet](docs/Subnet.md)
 - [SubnetData](docs/SubnetData.md)
 - [SubnetUpdate](docs/SubnetUpdate.md)
 - [TypeOfStorage](docs/TypeOfStorage.md)
 - [TypeVirtualNic](docs/TypeVirtualNic.md)
 - [UploadSource](docs/UploadSource.md)
 - [UserData](docs/UserData.md)
 - [UserDataTransportationMethod](docs/UserDataTransportationMethod.md)
 - [VirtualCpu](docs/VirtualCpu.md)
 - [VirtualCpuData](docs/VirtualCpuData.md)
 - [VirtualCpuPinning](docs/VirtualCpuPinning.md)
 - [VirtualCpuPinningData](docs/VirtualCpuPinningData.md)
 - [VirtualCpuPinningPolicy](docs/VirtualCpuPinningPolicy.md)
 - [VirtualMemory](docs/VirtualMemory.md)
 - [VirtualMemoryData](docs/VirtualMemoryData.md)
 - [VirtualNetworkInterface](docs/VirtualNetworkInterface.md)
 - [VirtualStorageData](docs/VirtualStorageData.md)
 - [Volume](docs/Volume.md)
 - [VolumeSnapshot](docs/VolumeSnapshot.md)
 - [VolumeUpdate](docs/VolumeUpdate.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="oauth2"></a>
### oauth2

- **Type**: OAuth
- **Flow**: application
- **Authorization URL**: 
- **Scopes**: 
 - **compute:v1:allocate**: Allocate compute resources
 - **compute:v1:migrate**: Migrate compute resources
 - **compute:v1:operate**: Operate compute resources
 - **compute:v1:query**: Query compute resources
 - **compute:v1:scale**: Scale compute resources
 - **compute:v1:terminate**: Terminate compute resources
 - **compute:v1:update**: Update compute resources and attach or detach volumes
 - **flavour:v1:create**: Create compute flavours
 - **flavour:v1:delete**: Delete compute flavours
 - **flavour:v1:query**: Query compute flavours
 - **image:v1:add**: Add software images
 - **image:v1:delete**: Delete software images
 - **image:v1:query**: Query software images
 - **image:v1:update**: Update software images
 - **network:v1:allocate**: Allocate network resources
 - **network:v1:query**: Query network resources
 - **network:v1:terminate**: Terminate network resources
 - **network:v1:update**: Update network resources
 - **storage:v1:allocate**: Allocate volumes
 - **storage:v1:migrate**: Migrate volumes
 - **storage:v1:operate**: Snapshot volumes
 - **storage:v1:query**: Query volumes
 - **storage:v1:scale**: Resize volumes
 - **storage:v1:terminate**: Terminate volumes
 - **storage:v1:update**: Update volumes


## Author



