common

package

v0.2.0 Latest Latest Go to latest Published: Oct 21, 2018 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/imulab/homelab

Documentation ¶

Index ¶

Constants
func GenericError(err error) error
func HandleError(err error) error
func HttpClient() *http.Client
func ProxmoxError(err error) error
func WithHttpCredentials(r *http.Request) (*http.Request, error)
func WriteSubjectToCache(subject *ProxmoxSubject) error
type CommandError
- func (e *CommandError) Error() string
- func (e *CommandError) ExitCode() int
type ExitCodeAwareError
type ProxmoxSubject
- func ReadSubjectFromCache() (*ProxmoxSubject, error)

Constants ¶

View Source

const (
	GenericErrorExitCode    = 1
	ProxmoxErrorExitCode    = 2
	ValidationErrorExitCode = 3
)

View Source

const (
	ProxmoxCSRFTokenHeader  = "CSRFPreventionToken"
	ProxmoxTicketCookieName = "PVEAuthCookie"
)

View Source

const (
	TicketCache = ".proxmox"
)

Variables ¶

This section is empty.

Functions ¶

func GenericError ¶

func GenericError(err error) error

func HandleError ¶

func HandleError(err error) error

func HttpClient ¶

func HttpClient() *http.Client

Returns an http client. TODO: support secure transport

func ProxmoxError ¶

func ProxmoxError(err error) error

func WithHttpCredentials ¶

func WithHttpCredentials(r *http.Request) (*http.Request, error)

func WriteSubjectToCache ¶

func WriteSubjectToCache(subject *ProxmoxSubject) error

Write session information to ticket cache in (pretty) JSON format.

Types ¶

type CommandError ¶

type CommandError struct {
	Err  error
	Code int
}

func (*CommandError) Error ¶

func (e *CommandError) Error() string

func (*CommandError) ExitCode ¶

func (e *CommandError) ExitCode() int

type ExitCodeAwareError ¶

type ExitCodeAwareError interface {
	error
	ExitCode() int
}

type ProxmoxSubject ¶

type ProxmoxSubject struct {
	Username  string `json:"username"`
	Ticket    string `json:"ticket"`
	CSRFToken string `json:"csrf_token"`
	ApiServer string `json:"api_server"`
}

Session information representing an authenticated Proxmox user

func ReadSubjectFromCache ¶

func ReadSubjectFromCache() (*ProxmoxSubject, error)

Read session subject from ticket cache

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL