lego/vendor/github.com/exoscale/egoscale/ssh_keypairs.go

package egoscale

import (
	"context"
	"fmt"
)

// SSHKeyPair represents an SSH key pair
//
// See: http://docs.cloudstack.apache.org/projects/cloudstack-administration/en/stable/virtual_machines.html#creating-the-ssh-keypair
type SSHKeyPair struct {
	Fingerprint string `json:"fingerprint,omitempty" doc:"Fingerprint of the public key"`
	Name        string `json:"name,omitempty" doc:"Name of the keypair"`
	PrivateKey  string `json:"privatekey,omitempty" doc:"Private key"`
}

// Delete removes the given SSH key, by Name
func (ssh SSHKeyPair) Delete(ctx context.Context, client *Client) error {
	if ssh.Name == "" {
		return fmt.Errorf("an SSH Key Pair may only be deleted using Name")
	}

	return client.BooleanRequestWithContext(ctx, &DeleteSSHKeyPair{
		Name: ssh.Name,
	})
}

// ListRequest builds the ListSSHKeyPairs request
func (ssh SSHKeyPair) ListRequest() (ListCommand, error) {
	req := &ListSSHKeyPairs{
		Fingerprint: ssh.Fingerprint,
		Name:        ssh.Name,
	}

	return req, nil
}

// CreateSSHKeyPair represents a new keypair to be created
type CreateSSHKeyPair struct {
	Name     string `json:"name" doc:"Name of the keypair"`
	Account  string `json:"account,omitempty" doc:"an optional account for the ssh key. Must be used with domainId."`
	DomainID *UUID  `json:"domainid,omitempty" doc:"an optional domainId for the ssh key. If the account parameter is used, domainId must also be used."`
	_        bool   `name:"createSSHKeyPair" description:"Create a new keypair and returns the private key"`
}

func (CreateSSHKeyPair) response() interface{} {
	return new(SSHKeyPair)
}

// DeleteSSHKeyPair represents a new keypair to be created
type DeleteSSHKeyPair struct {
	Name     string `json:"name" doc:"Name of the keypair"`
	Account  string `json:"account,omitempty" doc:"the account associated with the keypair. Must be used with the domainId parameter."`
	DomainID *UUID  `json:"domainid,omitempty" doc:"the domain ID associated with the keypair"`
	_        bool   `name:"deleteSSHKeyPair" description:"Deletes a keypair by name"`
}

func (DeleteSSHKeyPair) response() interface{} {
	return new(booleanResponse)
}

// RegisterSSHKeyPair represents a new registration of a public key in a keypair
type RegisterSSHKeyPair struct {
	Name      string `json:"name" doc:"Name of the keypair"`
	PublicKey string `json:"publickey" doc:"Public key material of the keypair"`
	Account   string `json:"account,omitempty" doc:"an optional account for the ssh key. Must be used with domainId."`
	DomainID  *UUID  `json:"domainid,omitempty" doc:"an optional domainId for the ssh key. If the account parameter is used, domainId must also be used."`
	_         bool   `name:"registerSSHKeyPair" description:"Register a public key in a keypair under a certain name"`
}

func (RegisterSSHKeyPair) response() interface{} {
	return new(SSHKeyPair)
}

// ListSSHKeyPairs represents a query for a list of SSH KeyPairs
type ListSSHKeyPairs struct {
	Account     string `json:"account,omitempty" doc:"list resources by account. Must be used with the domainId parameter."`
	DomainID    *UUID  `json:"domainid,omitempty" doc:"list only resources belonging to the domain specified"`
	Fingerprint string `json:"fingerprint,omitempty" doc:"A public key fingerprint to look for"`
	IsRecursive *bool  `json:"isrecursive,omitempty" doc:"defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves."`
	Keyword     string `json:"keyword,omitempty" doc:"List by keyword"`
	ListAll     *bool  `json:"listall,omitempty" doc:"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"`
	Name        string `json:"name,omitempty" doc:"A key pair name to look for"`
	Page        int    `json:"page,omitempty"`
	PageSize    int    `json:"pagesize,omitempty"`
	_           bool   `name:"listSSHKeyPairs" description:"List registered keypairs"`
}

// ListSSHKeyPairsResponse represents a list of SSH key pairs
type ListSSHKeyPairsResponse struct {
	Count      int          `json:"count"`
	SSHKeyPair []SSHKeyPair `json:"sshkeypair"`
}

func (ListSSHKeyPairs) response() interface{} {
	return new(ListSSHKeyPairsResponse)
}

// SetPage sets the current page
func (ls *ListSSHKeyPairs) SetPage(page int) {
	ls.Page = page
}

// SetPageSize sets the page size
func (ls *ListSSHKeyPairs) SetPageSize(pageSize int) {
	ls.PageSize = pageSize
}

func (ListSSHKeyPairs) each(resp interface{}, callback IterateItemFunc) {
	sshs, ok := resp.(*ListSSHKeyPairsResponse)
	if !ok {
		callback(nil, fmt.Errorf("wrong type. ListSSHKeyPairsResponse expected, got %T", resp))
		return
	}

	for i := range sshs.SSHKeyPair {
		if !callback(&sshs.SSHKeyPair[i], nil) {
			break
		}
	}
}

// ResetSSHKeyForVirtualMachine (Async) represents a change for the key pairs
type ResetSSHKeyForVirtualMachine struct {
	ID       *UUID  `json:"id" doc:"The ID of the virtual machine"`
	KeyPair  string `json:"keypair" doc:"name of the ssh key pair used to login to the virtual machine"`
	Account  string `json:"account,omitempty" doc:"an optional account for the ssh key. Must be used with domainId."`
	DomainID *UUID  `json:"domainid,omitempty" doc:"an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used."`
	_        bool   `name:"resetSSHKeyForVirtualMachine" description:"Resets the SSH Key for virtual machine. The virtual machine must be in a \"Stopped\" state."`
}

func (ResetSSHKeyForVirtualMachine) response() interface{} {
	return new(AsyncJobResult)
}

func (ResetSSHKeyForVirtualMachine) asyncResponse() interface{} {
	return new(VirtualMachine)
}