v2

type AddFileArgs struct {
	Filename string
	Content  []byte
	Reader   io.Reader
	Length   int64
}

type AllocateMachineArgs struct {
	Hostname     string
	SystemId     string
	Architecture string
	MinCPUCount  int
	// MinMemory represented in MB.
	MinMemory int
	Tags      []string
	NotTags   []string
	Zone      string
	NotInZone []string
	// Storage represents the required disks on the MachineInterface. If any are specified
	// the first value is used for the root disk.
	Storage []StorageSpec
	// Interfaces represents a number of required interfaces on the MachineInterface.
	// Each InterfaceSpec relates to an individual network interface.
	Interfaces []InterfaceSpec
	// NotSpace is a MachineInterface level constraint, and applies to the entire MachineInterface
	// rather than specific interfaces.
	NotSpace  []string
	AgentName string
	Comment   string
	DryRun    bool
}

type BlockDevice struct {
	ResourceURI string `json:"resource_uri,omitempty"`

	ID      int      `json:"ID,omitempty"`
	Name    string   `json:"Name,omitempty"`
	Model   string   `json:"Model,omitempty"`
	IDPath  string   `json:"id_path,omitempty"`
	Path    string   `json:"Path,omitempty"`
	UsedFor string   `json:"used_for,omitempty"`
	Tags    []string `json:"Tags,omitempty"`

	BlockSize uint64 `json:"block_size,omitempty"`
	UsedSize  uint64 `json:"used_size,omitempty"`
	Size      uint64 `json:"Size,omitempty"`

	Partitions []*Partition `json:"Partitions,omitempty"`
}

type BootResource struct {
	// Add the ControllerInterface in when we need to do things with the BootResource.
	// ControllerInterface ControllerInterface
	ResourceURI  string `json:"resource_uri,omitempty"`
	ID           int    `json:"ID,omitempty"`
	Name         string `json:"Name,omitempty"`
	Type         string `json:"type,omitempty"`
	Architecture string `json:"Architecture,omitempty"`
	SubArches    string `json:"subarches,omitempty"`
	KernelFlavor string `json:"kflavor,omitempty"`
}

type CommissionMachineArgs struct {
	EnableSSH            bool
	SkipBMCConfig        bool
	SkipNetworking       bool
	SkipStorage          bool
	CommissioningScripts string
	TestingScript        string
}

type ConstraintMatches struct {
	// NetworkInterface is a mapping of the constraint Label specified to the Interfaces
	// that match that constraint.
	Interfaces map[string][]NetworkInterface

	// Storage is a mapping of the constraint Label specified to the BlockDevices
	// that match that constraint.
	Storage map[string][]BlockDevice
}

type Controller struct {
	Client     *client.MAASClient
	APIVersion version.Number
	// Capabilities returns a set of Capabilities as defined by the string
	// constants.
	Capabilities set.Strings
}

type ControllerArgs struct {
	BaseURL string
	APIKey  string
}

type CreateInterfaceArgs struct {
	// Name of the interface (required).
	Name string
	// MACAddress is the MAC address of the interface (required).
	MACAddress string
	// VLAN is the untagged VLAN the interface is connected to (required).
	VLAN *VLAN
	// Tags to attach to the interface (optional).
	Tags []string
	// MTU - Maximum transmission unit. (optional)
	MTU int
	// AcceptRA - Accept router advertisements. (IPv6 only)
	AcceptRA bool
	// Autoconf - Perform stateless autoconfiguration. (IPv6 only)
	Autoconf bool
}

type CreateMachineNodeArgs struct {
	Hostname      string
	InterfaceName string
	MACAddress    string
	Subnet        *Subnet
	VLAN          *VLAN
}

type CreateNodeArgs struct {
	Hostname     string
	MACAddresses []string
	Domain       string
	Parent       string
}

type DeployMachineArgs struct {
	// UserData needs to be Base64 encoded user data for cloud-init.
	UserData     string
	DistroSeries string
	Kernel       string
	AgentName    string
	BridgeAll    bool
	BridgeSTP    bool
	BridgeFD     int
	Comment      string
	InstallRackd bool
}

type Fabric struct {
	// Add the ControllerInterface in when we need to do things with the Fabric.
	// ControllerInterface ControllerInterface
	ResourceURI string  `json:"resource_uri,omitempty"`
	ID          int     `json:"ID,omitempty"`
	Name        string  `json:"Name,omitempty"`
	ClassType   string  `json:"class_type,omitempty"`
	VLANs       []*VLAN `json:"VLANs,omitempty"`
}

type File struct {
	Controller  *Controller `json:"-"`
	ResourceURI string      `json:"resource_uri,string,omitempty"`
	// Filename is the Name of the File. No Path, just the Filename.
	Filename string `json:"Filename,string,omitempty"`
	// AnonymousURI is a URL that can be used to retrieve the contents of the
	// File without credentials.
	AnonymousURI *url.URL `json:"anon_resource_uri,string,omitempty"`
	Content      string   `json:"Content,string,omitempty"`
}

type Filesystem struct {
	// There is no need for ControllerInterface based parsing of filesystems until we need it.
	// Currently the Filesystem reading is only called by the Partition parsing.
	Type       string `json:"Type,omitempty"`
	MountPoint string `json:"mount_point,omitempty"`
	Label      string `json:"Label,omitempty"`
	UUID       string `json:"UUID,omitempty"`
}

type InterfaceLinkMode string

type InterfaceSpec struct {
	// Label is required and an arbitrary string. Labels need to be unique
	// across the InterfaceSpec elements specified in the AllocateMachineArgs.
	// The Label is returned in the ConstraintMatches response from
	// AllocateMachine.
	Label string
	Space string
}

type Link struct {
	ID        int     `json:"ID,omitempty"`
	Mode      string  `json:"Mode,omitempty"`
	Subnet    *Subnet `json:"Subnet,omitempty"`
	IPAddress string  `json:"ip_address,omitempty"`
}

type LinkSubnetArgs struct {
	// Mode is used to describe how the address is provided for the Link.
	// Required field.
	Mode InterfaceLinkMode
	// Subnet is the Subnet to Link to. Required field.
	Subnet *Subnet
	// IPAddress is only valid when the Mode is set to LinkModeStatic. If
	// not specified with a Mode of LinkModeStatic, an IP address from the
	// Subnet will be auto selected.
	IPAddress string
	// DefaultGateway will set the gateway IP address for the Subnet as the
	// default gateway for the Machine or node the interface belongs to.
	// Option can only be used with Mode LinkModeStatic.
	DefaultGateway bool
}

type Machine struct {
	Controller *Controller `json:"-"`

	ResourceURI string   `json:"resource_uri,omitempty"`
	SystemID    string   `json:"system_id,omitempty"`
	Hostname    string   `json:"Hostname,omitempty"`
	FQDN        string   `json:"FQDN,omitempty"`
	Tags        []string `json:"tag_names,omitempty"`
	// OwnerData returns a copy of the key/value data stored for this
	// object.
	OwnerData       map[string]string `json:"owner_data,omitempty"`
	OperatingSystem string            `json:"osystem,omitempty"`
	DistroSeries    string            `json:"distro_series,omitempty"`
	Architecture    string            `json:"Architecture,omitempty"`
	Memory          int               `json:"Memory,omitempty"`
	CPUCount        int               `json:"cpu_count,omitempty"`
	IPAddresses     []string          `json:"ip_addresses,omitempty"`
	PowerState      string            `json:"power_state,omitempty"`
	// NOTE: consider some form of status struct
	StatusName    string `json:"status_name,omitempty"`
	StatusMessage string `json:"status_message,omitempty"`
	// BootInterface returns the interface that was used to boot the MachineInterface.
	BootInterface *NetworkInterface `json:"boot_interface,omitempty"`
	// InterfaceSet returns all the interfaces for the MachineInterface.
	InterfaceSet []*NetworkInterface `json:"interface_set,omitempty"`
	Zone         *Zone               `json:"Zone,omitempty"`

	// PhysicalBlockDevice returns the physical block node for the MachineInterface
	// that matches the ID specified. If there is no match, nil is returned.
	PhysicalBlockDevices []*BlockDevice `json:"physicalblockdevice_set,omitempty"`
	// BlockDevices returns all the physical and virtual block devices on the MachineInterface.
	BlockDevices []*BlockDevice `json:"blockdevice_set,omitempty"`
	Kernel       string         `json:"hwe_kernel,omitempty"`
}

type MachineInterface interface {
	OwnerDataHolderInterface

	// Nodes returns a list of devices that match the params and have
	// this MachineInterface as the Parent.
	Nodes(NodesArgs) ([]NodeInterface, error)

	// NetworkInterface returns the interface for the MachineInterface that matches the ID
	// specified. If there is no match, nil is returned.
	Interface(id int) *NetworkInterface
	// BlockDevice returns the block node for the MachineInterface that matches the
	// ID specified. If there is no match, nil is returned.
	BlockDevice(id int) BlockDevice

	// Deploy the MachineInterface and install the operating system specified in the args.
	Deploy(DeployMachineArgs) error

	// CreateNode creates a new NodeInterface with this MachineInterface as the Parent.
	// The node will have one interface that is linked to the specified Subnet.
	CreateNode(CreateMachineNodeArgs) (NodeInterface, error)
}

type MachineOp string

type MachinesArgs struct {
	Hostnames    []string
	MACAddresses []string
	SystemIDs    []string
	Domain       string
	Zone         string
	AgentName    string
	OwnerData    map[string]string
}

type MachinesOp string

type NetworkInterface struct {
	Controller   *Controller `json:"-"`
	ResourceURI  string      `json:"resource_uri,omitempty"`
	ID           int         `json:"ID,omitempty"`
	Name         string      `json:"Name,omitempty"`
	Type         string      `json:"type,omitempty"`
	Enabled      bool        `json:"Enabled,omitempty"`
	Tags         []string    `json:"Tags,omitempty"`
	VLAN         *VLAN       `json:"VLAN,omitempty"`
	Links        []*Link     `json:"Links,omitempty"`
	MACAddress   string      `json:"mac_address,omitempty"`
	EffectiveMTU int         `json:"effective_mtu,omitempty"`
	Parents      []string    `json:"Parents,omitempty"`
	Children     []string    `json:"Children,omitempty"`
}

type Node struct {
	// TODO: add domain
	Controller  *Controller `json:"-"`
	ResourceURI string      `json:"resource_uri,omitempty"`
	SystemID    string      `json:"system_id,omitempty"`
	Hostname    string      `json:"Hostname,omitempty"`
	FQDN        string      `json:"FQDN,omitempty"`
	// Parent returns the SystemID of the Parent. Most often this will be a
	// MachineInterface.
	Parent string `json:"Parent,omitempty"`
	// Owner is the username of the user that created the Node.
	Owner       string   `json:"owner,omitempty"`
	IPAddresses []string `json:"ip_addresses,omitempty"`
	// InterfaceSet returns all the interfaces for the NodeInterface.
	InterfaceSet []*NetworkInterface `json:"interface_set,omitempty"`
	Zone         *Zone               `json:"Zone,omitempty"`
	Tags         []string            `json:"tag_names,omitempty"`
	Type         string              `json:"node_type_name,omitempty"`
}

type NodeInterface interface {
	// CreateInterface will create a physical interface for this MachineInterface.
	CreateInterface(CreateInterfaceArgs) (*NetworkInterface, error)
	// Delete will remove this NodeInterface.
	Delete() error
}

type NodeOp string

type NodesArgs struct {
	Hostname     []string
	MACAddresses []string
	SystemIDs    []string
	Domain       string
	Zone         string
	AgentName    string
}

type NodesOp string

type OwnerDataHolderInterface interface {
	// SetOwnerData updates the key/value data stored for this object
	// with the Values passed in. Existing keys that aren't specified
	// in the map passed in will be left in place; to clear a key set
	// its value to "". All Owner data is cleared when the object is
	// released.
	SetOwnerData(map[string]string) error
}

type Partition struct {
	ResourceURI string      `json:"resource_uri,omitempty"`
	ID          int         `json:"ID,omitempty"`
	Path        string      `json:"Path,omitempty"`
	UUID        string      `json:"UUID,omitempty"`
	UsedFor     string      `json:"used_for,omitempty"`
	Size        uint64      `json:"Size,omitempty"`
	FileSystem  *Filesystem `json:"Filesystem,omitempty"`
}

type ReleaseMachinesArgs struct {
	SystemIDs   []string
	Comment     string
	Erase       bool
	SecureErase bool
	QuickErase  bool
}

type Space struct {
	// Add the ControllerInterface in when we need to do things with the Space.
	// ControllerInterface ControllerInterface
	ResourceURI string    `json:"resource_uri,omitempty"`
	ID          int       `json:"ID,omitempty"`
	Name        string    `json:"Name,omitempty"`
	Subnets     []*Subnet `json:"Subnets,omitempty"`
}

type StaticRoute struct {
	ResourceURI string `json:"resource_uri,omitempty"`
	ID          int    `json:"id,omitempty"`
	// Source is the Subnet that should have the route configured. (Machines
	// inside Source should use GatewayIP to reach Destination addresses.)
	Source *Subnet `json:"source,omitempty"`
	// Destination is the Subnet that a MachineInterface wants to send packets to. We
	// want to configure a route to that Subnet via GatewayIP.
	Destination *Subnet `json:"destination,omitempty"`
	// GatewayIP is the IPAddress to direct traffic to.
	GatewayIP string `json:"gateway_ip,omitempty"`
	// Metric is the routing Metric that determines whether this route will
	// take precedence over similar routes (there may be a route for 10/8, but
	// also a more concrete route for 10.0/16 that should take precedence if it
	// applies.) Metric should be a non-negative integer.
	Metric int `json:"metric,omitempty"`
}

type StorageSpec struct {
	// Label is optional and an arbitrary string. Labels need to be unique
	// across the StorageSpec elements specified in the AllocateMachineArgs.
	Label string
	// Size is required and refers to the required minimum Size in GB.
	Size int
	// Zero or more Tags assocated to with the disks.
	Tags []string
}

type Subnet struct {
	// Add the ControllerInterface in when we need to do things with the Subnet.
	// ControllerInterface ControllerInterface
	ResourceURI string `json:"resource_uri,omitempty"`
	ID          int    `json:"ID,omitempty"`
	Name        string `json:"Name,omitempty"`
	Space       string `json:"Space,omitempty"`
	VLAN        *VLAN  `json:"VLAN,omitempty"`
	Gateway     string `json:"gateway_ip,omitempty"`
	CIDR        string `json:"cidr,omitempty"`
	// DNSServers is a list of ip addresses of the DNS servers for the Subnet.
	// This list may be empty.
	DNSServers []string `json:"dns_servers,omitempty"`
}

type UpdateInterfaceArgs struct {
	Name       string
	MACAddress string
	VLAN       *VLAN
}

type VLAN struct {
	// Add the ControllerInterface in when we need to do things with the VLAN.
	// ControllerInterface ControllerInterface
	ResourceURI string `json:"resource_uri,omitempty"`
	ID          int    `json:"ID,omitempty"`
	Name        string `json:"Name,omitempty"`
	Fabric      string `json:"Fabric,omitempty"`
	// VID is the VLAN ID. eth0.10 -> VID = 10.
	VID int `json:"VID,omitempty"`
	// MTU (maximum transmission unit) is the largest Size packet or frame,
	// specified in octets (eight-bit bytes), that can be sent.
	MTU           int    `json:"MTU,omitempty"`
	DHCP          bool   `json:"dhcp_on,omitempty"`
	PrimaryRack   string `json:"primary_rack,omitempty"`
	SecondaryRack string `json:"secondary_rack,omitempty"`
}

type Version struct {
	Capabilities []string `json:"capabilities,omitempty"`
	Version      string   `json:"version,omitempty"`
	SubVersion   string   `json:"subversion,omitempty"`
}

type Zone struct {
	// Add the ControllerInterface in when we need to do things with the Zone.
	// ControllerInterface ControllerInterface
	ResourceURI string `json:"resource_uri,omitempty"`
	Name        string `json:"Name,omitempty"`
	Description string `json:"Description,omitempty"`
}