Metadata-Version: 2.4
Name: vcenter-lookup-bridge-client
Version: 1.3.0
Summary: vCenter Lookup Bridge API Client
Home-page: 
Author: OpenAPI Generator community
Author-email: Takeyuki Moriyama <me52405@gmail.com>
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/t-m0riyama/vcenter-lookup-bridge-client-python
Project-URL: Repository, https://github.com/t-m0riyama/vcenter-lookup-bridge-client-python
Project-URL: Issues, https://github.com/t-m0riyama/vcenter-lookup-bridge-client-python/issues
Keywords: OpenAPI,vCenter,VMware,vCenter Lookup Bridge API
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: requests>=2.32.4
Requires-Dist: typing-extensions>=4.7.1
Requires-Dist: click>=8.0
Requires-Dist: tabulate>=0.9
Dynamic: author
Dynamic: license-file

# vcenter-lookup-bridge-client
vCenter Lookup Bridge API

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

- API version: 0.1.0
- Package version: 1.0.0
- Generator version: 7.14.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.12+

## Installation & Usage
### pip install

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

```sh
pip install vcenter-lookup-bridge-client
```
(you may need to run `pip` with root permission: `sudo pip install vcenter-lookup-bridge-client`)

Then import the package:
```python
import vcenter_lookup_bridge_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 vcenter_lookup_bridge_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

import vcenter_lookup_bridge_client
from vcenter_lookup_bridge_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost/vcenter-lookup-bridge/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = vcenter_lookup_bridge_client.Configuration(
    host = "http://localhost/vcenter-lookup-bridge/api/v1"
)

# 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.

# Configure HTTP basic authorization: basicAuth
configuration = vcenter_lookup_bridge_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)


# Enter a context with an instance of the API client
with vcenter_lookup_bridge_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vcenter_lookup_bridge_client.AdminsApi(api_client)

    try:
        # Flush Caches
        api_response = api_instance.flush_caches()
        print("The response of AdminsApi->flush_caches:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AdminsApi->flush_caches: %s\n" % e)

```

## CLI

A `vlb` command-line interface is included. See [docs/CLI.md](docs/CLI.md) for details.

```sh
vlb --help
```

## Documentation for API Endpoints

All URIs are relative to *http://localhost/vcenter-lookup-bridge/api/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AdminsApi* | [**flush_caches**](docs/AdminsApi.md#flush_caches) | **POST** /admins/cache/flush | Flush Caches
*AdminsApi* | [**reset_ws_session**](docs/AdminsApi.md#reset_ws_session) | **POST** /admins/ws_session/reset | Reset Ws Session
*AlarmsApi* | [**list_alarms**](docs/AlarmsApi.md#list_alarms) | **GET** /alarms/ | List Alarms
*ClustersApi* | [**list_clusters**](docs/ClustersApi.md#list_clusters) | **GET** /clusters/ | List Clusters
*DatastoresApi* | [**list_datastores**](docs/DatastoresApi.md#list_datastores) | **GET** /datastores/ | List Datastores
*EventsApi* | [**list_events**](docs/EventsApi.md#list_events) | **GET** /events/ | List Events
*HealthcheckApi* | [**get_service_status**](docs/HealthcheckApi.md#get_service_status) | **GET** /healthcheck/ | Get Service Status
*HostsApi* | [**get_host**](docs/HostsApi.md#get_host) | **GET** /hosts/{host_uuid} | Get Host
*HostsApi* | [**list_hosts**](docs/HostsApi.md#list_hosts) | **GET** /hosts/ | List Hosts
*PortgroupsApi* | [**list_portgroups**](docs/PortgroupsApi.md#list_portgroups) | **GET** /portgroups/ | List Portgroups
*VcentersApi* | [**list_vcenters**](docs/VcentersApi.md#list_vcenters) | **GET** /vcenters/ | List Vcenters
*VmFoldersApi* | [**list_vm_folders**](docs/VmFoldersApi.md#list_vm_folders) | **GET** /vm_folders/ | List Vm Folders
*VmSnapshotsApi* | [**get_vm_snapshots**](docs/VmSnapshotsApi.md#get_vm_snapshots) | **GET** /vm_snapshots/{vm_instance_uuid} | Get Vm Snapshots
*VmSnapshotsApi* | [**list_vm_snapshots**](docs/VmSnapshotsApi.md#list_vm_snapshots) | **GET** /vm_snapshots/ | List Vm Snapshots
*VmsApi* | [**get_vm**](docs/VmsApi.md#get_vm) | **GET** /vms/{vm_instance_uuid} | Get Vm
*VmsApi* | [**list_vms**](docs/VmsApi.md#list_vms) | **GET** /vms/ | List Vms


## Documentation For Models

 - [AdminResponseSchema](docs/AdminResponseSchema.md)
 - [AlarmListResponseSchema](docs/AlarmListResponseSchema.md)
 - [AlarmResponseSchema](docs/AlarmResponseSchema.md)
 - [ClusterListResponseSchema](docs/ClusterListResponseSchema.md)
 - [ClusterResponseSchema](docs/ClusterResponseSchema.md)
 - [DatastoreListResponseSchema](docs/DatastoreListResponseSchema.md)
 - [DatastoreResponseSchema](docs/DatastoreResponseSchema.md)
 - [EventListResponseSchema](docs/EventListResponseSchema.md)
 - [EventResponseSchema](docs/EventResponseSchema.md)
 - [HTTPValidationError](docs/HTTPValidationError.md)
 - [HealthcheckResponseSchema](docs/HealthcheckResponseSchema.md)
 - [HealthcheckSchema](docs/HealthcheckSchema.md)
 - [HostDetailResponseSchema](docs/HostDetailResponseSchema.md)
 - [HostGetResponseSchema](docs/HostGetResponseSchema.md)
 - [HostListResponseSchema](docs/HostListResponseSchema.md)
 - [HostResponseSchema](docs/HostResponseSchema.md)
 - [PaginationInfo](docs/PaginationInfo.md)
 - [PortgroupListResponseSchema](docs/PortgroupListResponseSchema.md)
 - [PortgroupResponseSchema](docs/PortgroupResponseSchema.md)
 - [VCenterListResponseSchema](docs/VCenterListResponseSchema.md)
 - [VCenterResponseSchema](docs/VCenterResponseSchema.md)
 - [ValidationError](docs/ValidationError.md)
 - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
 - [VmDetailResponseSchema](docs/VmDetailResponseSchema.md)
 - [VmFolderListResponseSchema](docs/VmFolderListResponseSchema.md)
 - [VmFolderResponseSchema](docs/VmFolderResponseSchema.md)
 - [VmGetResponseSchema](docs/VmGetResponseSchema.md)
 - [VmListResponseSchema](docs/VmListResponseSchema.md)
 - [VmResponseSchema](docs/VmResponseSchema.md)
 - [VmSnapshotListResponseSchema](docs/VmSnapshotListResponseSchema.md)
 - [VmSnapshotResponseSchema](docs/VmSnapshotResponseSchema.md)


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


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

- **Type**: HTTP basic authentication


## Author




