cluster

Documentation

Index

• type Client
  • func (c *Client) ExpandPath(path string) string
  • func (c *Client) Firewall() clusterfirewall.API
  • func (c *Client) GetNextID(ctx context.Context, vmID *int) (*int, error)
  • func (c *Client) GetVMID(ctx context.Context) (*int, error)
• type NextIDRequestBody
• type NextIDResponseBody

Types

type Client

type Client struct {
	api.Client
}

Client is an interface for accessing the Proxmox cluster API.

func (*Client) ExpandPath

func (c *Client) ExpandPath(path string) string

ExpandPath expands a relative path to a full cluster API path.

func (*Client) Firewall

func (c *Client) Firewall() clusterfirewall.API

Firewall returns a client for managing the cluster firewall.

func (*Client) GetNextID

func (c *Client) GetNextID(ctx context.Context, vmID *int) (*int, error)

GetNextID retrieves the next free VM identifier for the cluster.

func (*Client) GetVMID

func (c *Client) GetVMID(ctx context.Context) (*int, error)

GetVMID retrieves the next available VM identifier.

type NextIDRequestBody

type NextIDRequestBody struct {
	VMID *int `json:"vmid,omitempty" url:"vmid,omitempty"`
}

NextIDRequestBody contains the data for a cluster next id request.

type NextIDResponseBody

type NextIDResponseBody struct {
	Data *types.CustomInt `json:"data,omitempty"`
}

NextIDResponseBody contains the body from a cluster next id response.