groups

Documentation

Index

• type GetRequest
  • func (g GetRequest) Get() (GetResponseList, error)
  • func (g GetRequest) GetAll() ([]byte, error)
  • func (g GetRequest) ParseParams(apiURL *url.URL) error
• type GetResponse
• type GetResponseList
  • func (l *GetResponseList) FindByName(name string) *GetResponse
• type ItemDeleteRequest
  • func (g ItemDeleteRequest) Delete() error
• type ItemGetRequest
  • func (g ItemGetRequest) Get() (*ItemGetResponse, error)
  • func (g ItemGetRequest) GetItem() ([]byte, error)
• type ItemGetResponse
• type ItemGetResponseLog
• type PostRequest
  • func (p PostRequest) ParseParams(apiURL *url.URL) error
  • func (p PostRequest) Post() error
  • func (p PostRequest) PostItem() ([]byte, error)

Types

type GetRequest

type GetRequest struct {
	Client *api.Client
}

func (GetRequest) Get

func (g GetRequest) Get() (GetResponseList, error)

func (GetRequest) GetAll

func (g GetRequest) GetAll() ([]byte, error)

func (GetRequest) ParseParams

func (g GetRequest) ParseParams(apiURL *url.URL) error

type GetResponse

type GetResponse struct {
	Name    string  `json:"name"`
	Digest  string  `json:"digest"`
	Group   string  `json:"group"`
	Comment *string `json:"comment,omitempty"`
}

type GetResponseList

type GetResponseList []GetResponse

func (*GetResponseList) FindByName

func (l *GetResponseList) FindByName(name string) *GetResponse

type ItemDeleteRequest

type ItemDeleteRequest struct {
	Client *api.Client
	Group  string
}

func (ItemDeleteRequest) Delete

func (g ItemDeleteRequest) Delete() error

type ItemGetRequest

type ItemGetRequest struct {
	Client *api.Client
	Group  string
}

func (ItemGetRequest) Get

func (g ItemGetRequest) Get() (*ItemGetResponse, error)

func (ItemGetRequest) GetItem

func (g ItemGetRequest) GetItem() ([]byte, error)

GetItem satisfies the ItemGetter interface Not to be used directly. Use Get() instead.

type ItemGetResponse

type ItemGetResponse []struct {
	Action string `json:"action"`
	Pos    int    `json:"pos"`
	Type   string `json:"type"`

	// Optional
	Comment   string             `json:"comment"`
	Dest      string             `json:"dest"`
	DPort     string             `json:"dport"`
	Enable    types.PVEBool      `json:"enable"`
	ICMPType  string             `json:"icmp-type"`
	Iface     string             `json:"iface"`
	IPVersion int                `json:"ipversion"`
	Log       ItemGetResponseLog `json:"log"`
	Macro     string             `json:"macro"`
	Proto     string             `json:"proto"`
	Source    string             `json:"source"`
	SPort     string             `json:"sport"`
}

type ItemGetResponseLog

type ItemGetResponseLog string

const (
	ItemGetResponseLogEmerg   ItemGetResponseLog = "emerg"
	ItemGetResponseLogAlert   ItemGetResponseLog = "alert"
	ItemGetResponseLogCrit    ItemGetResponseLog = "crit"
	ItemGetResponseLogErr     ItemGetResponseLog = "err"
	ItemGetResponseLogWarning ItemGetResponseLog = "warning"
	ItemGetResponseLogNotice  ItemGetResponseLog = "notice"
	ItemGetResponseLogInfo    ItemGetResponseLog = "info"
	ItemGetResponseLogDebug   ItemGetResponseLog = "debug"
	ItemGetResponseLogNoLog   ItemGetResponseLog = "nolog"
)

type PostRequest

type PostRequest struct {
	Client *api.Client

	// Required fields
	Group string

	// Optional fields
	Comment *string
	Digest  *string
	Rename  *string
}

func (PostRequest) ParseParams

func (p PostRequest) ParseParams(apiURL *url.URL) error

ParseParams satisfies the ItemPutter interface. Not to be used directly. Use Post() instead.

func (PostRequest) Post

func (p PostRequest) Post() error

func (PostRequest) PostItem

func (p PostRequest) PostItem() ([]byte, error)

PostItem satisfies the ItemPutter interface. Not to be used directly. Use Post() instead.