client

Documentation

Index

• type Client
  • func NewClient(remoteAddress string, psk string) (c *Client, err error)
  • func (c *Client) BackupVolume(volumeName string, force bool) (err error)
  • func (c *Client) GetInformations() (informations map[string]string, err error)
  • func (c *Client) GetVolumes() (volumes []volume.Volume, err error)
  • func (c *Client) RestoreVolume(volumeName string, force bool, snapshotName string) (err error)
  • func (c *Client) RunRawCommand(volumeID string, cmd []string) (output string, err error)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client contains informations needed to connect to a Volback API

func NewClient

func NewClient(remoteAddress string, psk string) (c *Client, err error)

NewClient returns a Volback client

func (*Client) BackupVolume

func (c *Client) BackupVolume(volumeName string, force bool) (err error)

BackupVolume requests a backup of a volume

func (*Client) GetInformations

func (c *Client) GetInformations() (informations map[string]string, err error)

GetInformations returns informations about the Volback manager

func (*Client) GetVolumes

func (c *Client) GetVolumes() (volumes []volume.Volume, err error)

GetVolumes returns the list of the volumes managed by Volback

func (*Client) RestoreVolume

func (c *Client) RestoreVolume(
	volumeName string,
	force bool,
	snapshotName string,
) (err error)

RestoreVolume requests a restore of a volume

func (*Client) RunRawCommand

func (c *Client) RunRawCommand(volumeID string, cmd []string) (output string, err error)

RunRawCommand runs a custom Restic command on a volume's repository and returns the output