vsphere

Documentation

Index

• Variables
• func DecodeError(info types.LicenseManagerLicenseInfo) error
• func Provider() terraform.ResourceProvider
• func UpdateLabel(ctx context.Context, m *license.Manager, licenseKey string, key string, ...) error
• type Config
  • func (c *Config) Client() (*VSphereClient, error)
  • func (c *Config) EnableDebug() error
• type VSphereClient
  • func (c *VSphereClient) TagsClient() (*tags.RestClient, error)

Variables

var (
	// ErrNoSuchKeyFound is an error primarily thrown by the Read method of the resource.
	// The error doesn't display the key itself for security reasons.
	ErrNoSuchKeyFound = errors.New("The key was not found")
	// ErrKeyCannotBeDeleted is an error which occurs when a key that is used by VMs is
	// being removed
	ErrKeyCannotBeDeleted = errors.New("The key wasn't deleted")
)

var DefaultDNSServers = []string{
	"8.8.8.8",
	"8.8.4.4",
}

var DefaultDNSSuffixes = []string{
	"vsphere.local",
}

var DiskControllerTypes = []string{
	"scsi",
	"scsi-lsi-parallel",
	"scsi-buslogic",
	"scsi-paravirtual",
	"scsi-lsi-sas",
	"ide",
}

Functions

func DecodeError

func DecodeError(info types.LicenseManagerLicenseInfo) error

DecodeError tries to find a specific error which occurs when an invalid key is passed to the server

func Provider

func Provider() terraform.ResourceProvider

Provider returns a terraform.ResourceProvider.

func UpdateLabel

func UpdateLabel(ctx context.Context, m *license.Manager, licenseKey string, key string, val string) error

UpdateLabel provides a wrapper around the UpdateLabel data objects

Types

type Config

type Config struct {
	User          string
	Password      string
	VSphereServer string
	InsecureFlag  bool
	Debug         bool
	DebugPath     string
	DebugPathRun  string
}

Config holds the provider configuration, and delivers a populated VSphereClient based off the contained settings.

func (*Config) Client

func (c *Config) Client() (*VSphereClient, error)

Client returns a new client for accessing VMWare vSphere.

func (*Config) EnableDebug

func (c *Config) EnableDebug() error

EnableDebug turns on govmomi API operation logging, if appropriate settings are set on the provider.

type VSphereClient

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

VSphereClient is the client connection manager for the vSphere provider. It holds the connections to the various API endpoints we need to interface with, such as the VMODL API through govmomi, and the REST SDK through alternate libraries.

func (*VSphereClient) TagsClient

func (c *VSphereClient) TagsClient() (*tags.RestClient, error)

TagsClient returns the embedded REST client used for tags, after determining if the connection is eligible:

* The connection information in vimClient is valid vCenter connection * The provider has a connection to the CIS REST client. This is true if tagsClient != nil.

This function should be used whenever possible to return the client from the provider meta variable for use, to determine if it can be used at all.

The nil value that is returned on an unsupported connection can be considered stable behavior for read purposes on resources that need to be able to read tags if they are present. You can use the snippet below in a Read call to determine if tags are supported on this connection, and if they are, read them from the object and save them in the resource:

if tagsClient, _ := meta.(*VSphereClient).TagsClient(); tagsClient != nil {
  if err := readTagsForResource(tagsClient, obj, d); err != nil {
    return err
  }
}