vcenter-lookup-bridge-client 1.3.0

vCenter Lookup Bridge API Client

vcenter-lookup-bridge-client

vCenter Lookup Bridge API

This Python package is automatically generated by the OpenAPI Generator 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:

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:

import vcenter_lookup_bridge_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import vcenter_lookup_bridge_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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 for details.

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	POST /admins/cache/flush	Flush Caches
AdminsApi	reset_ws_session	POST /admins/ws_session/reset	Reset Ws Session
AlarmsApi	list_alarms	GET /alarms/	List Alarms
ClustersApi	list_clusters	GET /clusters/	List Clusters
DatastoresApi	list_datastores	GET /datastores/	List Datastores
EventsApi	list_events	GET /events/	List Events
HealthcheckApi	get_service_status	GET /healthcheck/	Get Service Status
HostsApi	get_host	GET /hosts/{host_uuid}	Get Host
HostsApi	list_hosts	GET /hosts/	List Hosts
PortgroupsApi	list_portgroups	GET /portgroups/	List Portgroups
VcentersApi	list_vcenters	GET /vcenters/	List Vcenters
VmFoldersApi	list_vm_folders	GET /vm_folders/	List Vm Folders
VmSnapshotsApi	get_vm_snapshots	GET /vm_snapshots/{vm_instance_uuid}	Get Vm Snapshots
VmSnapshotsApi	list_vm_snapshots	GET /vm_snapshots/	List Vm Snapshots
VmsApi	get_vm	GET /vms/{vm_instance_uuid}	Get Vm
VmsApi	list_vms	GET /vms/	List Vms

Documentation For Models

• AdminResponseSchema
• AlarmListResponseSchema
• AlarmResponseSchema
• ClusterListResponseSchema
• ClusterResponseSchema
• DatastoreListResponseSchema
• DatastoreResponseSchema
• EventListResponseSchema
• EventResponseSchema
• HTTPValidationError
• HealthcheckResponseSchema
• HealthcheckSchema
• HostDetailResponseSchema
• HostGetResponseSchema
• HostListResponseSchema
• HostResponseSchema
• PaginationInfo
• PortgroupListResponseSchema
• PortgroupResponseSchema
• VCenterListResponseSchema
• VCenterResponseSchema
• ValidationError
• ValidationErrorLocInner
• VmDetailResponseSchema
• VmFolderListResponseSchema
• VmFolderResponseSchema
• VmGetResponseSchema
• VmListResponseSchema
• VmResponseSchema
• VmSnapshotListResponseSchema
• VmSnapshotResponseSchema

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

• Type: HTTP basic authentication

Author