homeassistant.components.proxmoxve Namespace Reference

Namespaces
	binary_sensor
	const
	entity

Classes
class	ProxmoxClient

Functions
bool	async_setup (HomeAssistant hass, ConfigType config)
dict[str, Any]|None	call_api_container_vm (ProxmoxAPI proxmox, str node_name, int vm_id, int machine_type)
DataUpdateCoordinator[dict[str, Any]|None]	create_coordinator_container_vm (HomeAssistant hass, ProxmoxAPI proxmox, str host_name, str node_name, int vm_id, int vm_type)
dict[str, Any]	parse_api_container_vm (dict[str, Any] status)

Variables
	CONFIG_SCHEMA
list	PLATFORMS = [Platform.BINARY_SENSOR]

Detailed Description

Support for Proxmox VE.

Function Documentation

async_setup()

bool homeassistant.components.proxmoxve.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up the platform.

Definition at line 88 of file __init__.py.

call_api_container_vm()

dict[str, Any] | None homeassistant.components.proxmoxve.call_api_container_vm	(	ProxmoxAPI	proxmox,
		str	node_name,
		int	vm_id,
		int	machine_type
	)

Make proper api calls.

Definition at line 234 of file __init__.py.

create_coordinator_container_vm()

DataUpdateCoordinator[dict[str, Any] | None] homeassistant.components.proxmoxve.create_coordinator_container_vm	(	HomeAssistant	hass,
		ProxmoxAPI	proxmox,
		str	host_name,
		str	node_name,
		int	vm_id,
		int	vm_type
	)

Create and return a DataUpdateCoordinator for a vm/container.

Definition at line 188 of file __init__.py.

parse_api_container_vm()

dict[str, Any] homeassistant.components.proxmoxve.parse_api_container_vm

(

dict[str, Any]

status

)

Get the container or vm api data and return it formatted in a dictionary.

It is implemented in this way to allow for more data to be added for sensors
in the future.

Definition at line 224 of file __init__.py.

Variable Documentation

CONFIG_SCHEMA

homeassistant.components.proxmoxve.CONFIG_SCHEMA

Definition at line 48 of file __init__.py.

PLATFORMS

list homeassistant.components.proxmoxve.PLATFORMS = [Platform.BINARY_SENSOR]

Definition at line 46 of file __init__.py.