package keypairs

import "github.com/rackspace/gophercloud/openstack/compute/v2/extensions/keypairs"

Package keypairs provides information and interaction with the Keypairs extension for the OpenStack Compute service.

Index ¶

• func List(client *gophercloud.ServiceClient) pagination.Pager
• type CreateOpts
• func (opts CreateOpts) ToKeyPairCreateMap() (map[string]interface{}, error)
• type CreateOptsBuilder
• type CreateResult
• func Create(client *gophercloud.ServiceClient, opts CreateOptsBuilder) CreateResult
• func (r CreateResult) Extract() (*KeyPair, error)
• type DeleteResult
• func Delete(client *gophercloud.ServiceClient, name string) DeleteResult
• type GetResult
• func Get(client *gophercloud.ServiceClient, name string) GetResult
• func (r GetResult) Extract() (*KeyPair, error)
• type KeyPair
• func ExtractKeyPairs(page pagination.Page) ([]KeyPair, error)
• type KeyPairPage
• func (page KeyPairPage) IsEmpty() (bool, error)

Functions ¶

func List ¶

func List(client *gophercloud.ServiceClient) pagination.Pager

List returns a Pager that allows you to iterate over a collection of KeyPairs.

Types ¶

type CreateOpts ¶

type CreateOpts struct {
	// Name [required] is a friendly name to refer to this KeyPair in other services.
	Name string

	// PublicKey [optional] is a pregenerated OpenSSH-formatted public key. If provided, this key
	// will be imported and no new key will be created.
	PublicKey string
}

CreateOpts species keypair creation or import parameters.

func (CreateOpts) ToKeyPairCreateMap ¶

func (opts CreateOpts) ToKeyPairCreateMap() (map[string]interface{}, error)

ToKeyPairCreateMap constructs a request body from CreateOpts.

type CreateOptsBuilder ¶

type CreateOptsBuilder interface {
	ToKeyPairCreateMap() (map[string]interface{}, error)
}

CreateOptsBuilder describes struct types that can be accepted by the Create call. Notable, the CreateOpts struct in this package does.

type CreateResult ¶

type CreateResult struct {
	// contains filtered or unexported fields
}

CreateResult is the response from a Create operation. Call its Extract method to interpret it as a KeyPair.

func Create ¶

func Create(client *gophercloud.ServiceClient, opts CreateOptsBuilder) CreateResult

Create requests the creation of a new keypair on the server, or to import a pre-existing keypair.

func (CreateResult) Extract ¶

func (r CreateResult) Extract() (*KeyPair, error)

Extract is a method that attempts to interpret any KeyPair resource response as a KeyPair struct.

type DeleteResult ¶

type DeleteResult struct {
	gophercloud.ErrResult
}

DeleteResult is the response from a Delete operation. Call its Extract method to determine if the call succeeded or failed.

func Delete ¶

func Delete(client *gophercloud.ServiceClient, name string) DeleteResult

Delete requests the deletion of a previous stored KeyPair from the server.

type GetResult ¶

type GetResult struct {
	// contains filtered or unexported fields
}

GetResult is the response from a Get operation. Call its Extract method to interpret it as a KeyPair.

func Get ¶

func Get(client *gophercloud.ServiceClient, name string) GetResult

Get returns public data about a previously uploaded KeyPair.

func (GetResult) Extract ¶

func (r GetResult) Extract() (*KeyPair, error)

Extract is a method that attempts to interpret any KeyPair resource response as a KeyPair struct.

type KeyPair ¶

type KeyPair struct {
	// Name is used to refer to this keypair from other services within this region.
	Name string `mapstructure:"name"`

	// Fingerprint is a short sequence of bytes that can be used to authenticate or validate a longer
	// public key.
	Fingerprint string `mapstructure:"fingerprint"`

	// PublicKey is the public key from this pair, in OpenSSH format. "ssh-rsa AAAAB3Nz..."
	PublicKey string `mapstructure:"public_key"`

	// PrivateKey is the private key from this pair, in PEM format.
	// "-----BEGIN RSA PRIVATE KEY-----\nMIICXA..." It is only present if this keypair was just
	// returned from a Create call
	PrivateKey string `mapstructure:"private_key"`

	// UserID is the user who owns this keypair.
	UserID string `mapstructure:"user_id"`
}

KeyPair is an SSH key known to the OpenStack cluster that is available to be injected into servers.

func ExtractKeyPairs ¶

func ExtractKeyPairs(page pagination.Page) ([]KeyPair, error)

ExtractKeyPairs interprets a page of results as a slice of KeyPairs.

type KeyPairPage ¶

type KeyPairPage struct {
	pagination.SinglePageBase
}

KeyPairPage stores a single, only page of KeyPair results from a List call.

func (KeyPairPage) IsEmpty ¶

func (page KeyPairPage) IsEmpty() (bool, error)

IsEmpty determines whether or not a KeyPairPage is empty.

Source Files ¶

doc.go requests.go results.go urls.go