Module `sysbot.modules.virtualization.harvester`

Harvester Module

This module provides methods for interacting with Rancher Harvester HCI (Hyper-Converged Infrastructure) via REST API. It supports operations such as virtual machine management, image management, volume management, and cluster information retrieval.

Note: This module uses the HTTP connector with API Key or Basic authentication. Sessions should be opened with protocol="http" and product="apikey" or "basicauth".

Classes

class Harvester

Harvester module for hyper-converged infrastructure management.

This class provides methods to interact with Rancher Harvester systems using REST API via the HTTP connector with API Key or Basic authentication. All methods require an alias to identify the established HTTP session.

Example

Basic usage with API key authentication::

import sysbot

bot = sysbot.Sysbot(['modules.virtualization.harvester'])

# Open session with API key
bot.open_session(
    "harvester",
    "http",
    "apikey",
    "harvester.example.com",
    443,
    apikey="your-api-key-here"
)

# Get cluster version
version = bot.modules.virtualization.harvester.get_version("harvester")

# List virtual machines
vms = bot.modules.virtualization.harvester.list_virtual_machines("harvester")

# Get specific VM
vm = bot.modules.virtualization.harvester.get_virtual_machine("harvester", "my-vm")

bot.close_session("harvester")

Ancestors

ComponentBase

Methods

def get_cluster_info(self, alias: str, **kwargs) ‑> dict

Get cluster information.

Args

alias : str: The session alias for the Harvester connection.

Returns

dict: Cluster information.

def get_image(self, alias: str, name: str, namespace: str = 'default', **kwargs) ‑> dict

Get details of a specific VM image.

Args

alias : str: The session alias for the Harvester connection.
name : str: Image name.
namespace : str: Kubernetes namespace (default: "default").

Returns

dict: Image details.

def get_network(self, alias: str, name: str, namespace: str = 'default', **kwargs) ‑> dict

Get details of a specific network.

Args

alias : str: The session alias for the Harvester connection.
name : str: Network name.
namespace : str: Kubernetes namespace (default: "default").

Returns

dict: Network details.

def get_node(self, alias: str, name: str, **kwargs) ‑> dict

Get details of a specific cluster node.

Args

alias : str: The session alias for the Harvester connection.
name : str: Node name.

Returns

dict: Node details.

def get_setting(self, alias: str, name: str, **kwargs) ‑> dict

Get a specific Harvester setting.

Args

alias : str: The session alias for the Harvester connection.
name : str: Setting name.

Returns

dict: Setting details.

def get_version(self, alias: str, **kwargs) ‑> dict

Get Harvester version information.

Args

alias : str: The session alias for the Harvester connection.

Returns

dict: Version information.

def get_virtual_machine(self, alias: str, name: str, namespace: str = 'default', **kwargs) ‑> dict

Get details of a specific virtual machine.

Args

alias : str: The session alias for the Harvester connection.
name : str: Virtual machine name.
namespace : str: Kubernetes namespace (default: "default").

Returns

dict: Virtual machine details.

def get_vm_instance(self, alias: str, name: str, namespace: str = 'default', **kwargs) ‑> dict

Get details of a specific virtual machine instance.

Args

alias : str: The session alias for the Harvester connection.
name : str: Virtual machine instance name.
namespace : str: Kubernetes namespace (default: "default").

Returns

dict: Virtual machine instance details.

def get_volume_claim(self, alias: str, name: str, namespace: str = 'default', **kwargs) ‑> dict

Get details of a specific persistent volume claim.

Args

alias : str: The session alias for the Harvester connection.
name : str: Volume claim name.
namespace : str: Kubernetes namespace (default: "default").

Returns

dict: Volume claim details.

def list_images(self, alias: str, namespace: str = 'default', **kwargs) ‑> dict

List all VM images in a namespace.

Args

alias : str: The session alias for the Harvester connection.
namespace : str: Kubernetes namespace (default: "default").

Returns

dict: List of VM images.

def list_namespaces(self, alias: str, **kwargs) ‑> dict

List all namespaces in the cluster.

Args

alias : str: The session alias for the Harvester connection.

Returns

dict: List of namespaces.

def list_networks(self, alias: str, namespace: str = 'default', **kwargs) ‑> dict

List all networks in a namespace.

Args

alias : str: The session alias for the Harvester connection.
namespace : str: Kubernetes namespace (default: "default").

Returns

dict: List of networks.

def list_nodes(self, alias: str, **kwargs) ‑> dict

List all cluster nodes.

Args

alias : str: The session alias for the Harvester connection.

Returns

dict: List of cluster nodes.

def list_settings(self, alias: str, **kwargs) ‑> dict

List all Harvester settings.

Args

alias : str: The session alias for the Harvester connection.

Returns

dict: List of Harvester settings.

def list_virtual_machines(self, alias: str, namespace: str = 'default', **kwargs) ‑> dict

List all virtual machines in a namespace.

Args

alias : str: The session alias for the Harvester connection.
namespace : str: Kubernetes namespace (default: "default").

Returns

dict: List of virtual machines.

def list_vm_instances(self, alias: str, namespace: str = 'default', **kwargs) ‑> dict

List all virtual machine instances in a namespace.

Args

alias : str: The session alias for the Harvester connection.
namespace : str: Kubernetes namespace (default: "default").

Returns

dict: List of virtual machine instances.

def list_volume_claims(self, alias: str, namespace: str = 'default', **kwargs) ‑> dict

List all persistent volume claims in a namespace.

Args

alias : str: The session alias for the Harvester connection.
namespace : str: Kubernetes namespace (default: "default").

Returns

dict: List of persistent volume claims.