Module `sysbot.modules.windows.veeam`

Veeam Backup & Replication Module

This module provides methods for managing and querying Veeam Backup & Replication, including backup jobs, repositories, managed servers, backup sessions, and restore operations using PowerShell Veeam cmdlets.

Classes

class Veeam

Veeam Backup & Replication management class using PowerShell Veeam cmdlets.

Ancestors

ComponentBase

Methods

def get_backup_repositories(self, alias: str, name: str = None, **kwargs) ‑> list

Get backup repositories.

Args

alias: Session alias for the connection.
name: Optional repository name to filter by.
**kwargs: Additional command execution options.

Returns

List of dictionaries containing backup repository information including Name, Description, Path, Type, and Extent.

def get_backup_sessions(self, alias: str, job_name: str = None, **kwargs) ‑> list

Get backup sessions.

Args

alias: Session alias for the connection.
job_name: Optional job name to filter sessions by.
**kwargs: Additional command execution options.

Returns

List of dictionaries containing backup session information including Name, JobName, State, Result, CreationTime, and EndTime.

def get_backups(self, alias: str, name: str = None, **kwargs) ‑> list

Get backups.

Args

alias: Session alias for the connection.
name: Optional backup name to filter by.
**kwargs: Additional command execution options.

Returns

List of dictionaries containing backup information including Name, Description, JobName, CreationTime, and JobType.

def get_jobs(self, alias: str, name: str = None, **kwargs) ‑> list

Get backup and replication jobs.

Args

alias: Session alias for the connection.
name: Optional job name to filter by.
**kwargs: Additional command execution options.

Returns

List of dictionaries containing job information including Name, Description, JobType, IsScheduleEnabled, IsRunning, and LastResult.

def get_restore_points(self, alias: str, backup_name: str = None, **kwargs) ‑> list

Get restore points.

Args

alias: Session alias for the connection.
backup_name: Optional backup name to filter restore points by.
**kwargs: Additional command execution options.

Returns

List of dictionaries containing restore point information including Name, CreationTime, Type, and VmName.

def get_server_sessions(self, alias: str, **kwargs) ‑> list

Get server session information.

Args

alias: Session alias for the connection.
**kwargs: Additional command execution options.

Returns

List of dictionaries containing server session information including User, Server, and Port.

def get_servers(self, alias: str, **kwargs) ‑> list

Get managed servers in Veeam Backup & Replication.

Args

alias: Session alias for the connection.
**kwargs: Additional command execution options.

Returns

List of dictionaries containing server information including Name, Description, Type, and Info.

def get_vi_servers(self, alias: str, name: str = None, **kwargs) ‑> list

Get vSphere servers managed by Veeam.

Args

alias: Session alias for the connection.
name: Optional vSphere server name to filter by.
**kwargs: Additional command execution options.

Returns

List of dictionaries containing vSphere server information including Name, Description, Type, ApiVersion, and IsUnavailable.