shutdown

Documentation

Index

• Constants
• type Config
• type Manager
  • func NewManager(client *rest.Client) *Manager
  • func (m *Manager) Cancel(ctx context.Context) error
  • func (m *Manager) Get(ctx context.Context) (Config, error)
  • func (m *Manager) PowerOff(ctx context.Context, reason string, delay int) error
  • func (m *Manager) Reboot(ctx context.Context, reason string, delay int) error
• type Spec

Constants

const (
	Path     = "/api/appliance/shutdown"
	Action   = "action"
	Cancel   = "cancel"
	PowerOff = "poweroff"
	Reboot   = "reboot"
)

Types

type Config

type Config struct {
	Action       string `json:"action"`
	Reason       string `json:"reason"`
	ShutdownTime string `json:"shutdown_time"`
}

Config defines shutdown configuration returned by the Shutdown.get operation

type Manager

type Manager struct {
	*rest.Client
}

Manager provides convenience methods for shutdown Action

func NewManager

func NewManager(client *rest.Client) *Manager

NewManager creates a new Manager

func (*Manager) Cancel

func (m *Manager) Cancel(ctx context.Context) error

Cancel cancels pending shutdown action.

func (*Manager) Get

func (m *Manager) Get(ctx context.Context) (Config, error)

Get returns details about the pending shutdown action.

func (*Manager) PowerOff

func (m *Manager) PowerOff(ctx context.Context, reason string, delay int) error

PowerOff powers off the appliance.

func (*Manager) Reboot

func (m *Manager) Reboot(ctx context.Context, reason string, delay int) error

Reboot reboots the appliance

type Spec

type Spec struct {
	Delay  int    `json:"delay"`
	Reason string `json:"reason"`
}

Spec represents request body class for an operation.