remote

Documentation

Index

• func InitHost(e config.Env, conn remote.ConnectionOutput, osDesc os.Descriptor, ...) error
• func NewConnection(host pulumi.StringInput, user string, options ...ConnectionOption) (*remote.ConnectionArgs, error)
• type ConnectionOption
  • func WithPort(port int) ConnectionOption
  • func WithPrivateKeyPassword(password string) ConnectionOption
  • func WithPrivateKeyPath(path string) ConnectionOption
  • func WithSSHAgentPath(path string) ConnectionOption
• type Host
  • func (h *Host) Export(ctx *pulumi.Context, out *HostOutput) error
• type HostOutput

Functions

func InitHost

func InitHost(e config.Env, conn remote.ConnectionOutput, osDesc os.Descriptor, osUser string, password pulumi.StringOutput, readyFunc command.ReadyFunc, host *Host) error

InitHost initializes all fields of a Host component with the given connection and OS descriptor.

func NewConnection

func NewConnection(host pulumi.StringInput, user string, options ...ConnectionOption) (*remote.ConnectionArgs, error)

NewConnection creates a remote connection to a host. Host and user are mandatory.

Types

type ConnectionOption

type ConnectionOption = func(*connectionArgs) error

func WithPort

func WithPort(port int) ConnectionOption

WithPort [optional] sets the port to use for the connection. Default to 22.

func WithPrivateKeyPassword

func WithPrivateKeyPassword(password string) ConnectionOption

WithPrivateKeyPassword [optional] sets the password to use in case the private key is encrypted

func WithPrivateKeyPath

func WithPrivateKeyPath(path string) ConnectionOption

WithPrivateKeyPath [optional] sets the path to the private key to use for the connection

func WithSSHAgentPath

func WithSSHAgentPath(path string) ConnectionOption

WithSSHAgentPath [optional] sets the path to the SSH Agent socket. Default to environment variable SSH_AUTH_SOCK if present.

type Host

type Host struct {
	pulumi.ResourceState
	components.Component

	OS os.OS

	Address       pulumi.StringOutput `pulumi:"address"`
	Port          pulumi.IntOutput    `pulumi:"port"`
	Username      pulumi.StringOutput `pulumi:"username"`
	Password      pulumi.StringOutput `pulumi:"password"`
	Architecture  pulumi.StringOutput `pulumi:"architecture"`
	OSFamily      pulumi.IntOutput    `pulumi:"osFamily"`
	OSFlavor      pulumi.IntOutput    `pulumi:"osFlavor"`
	OSVersion     pulumi.StringOutput `pulumi:"osVersion"`
	CloudProvider pulumi.StringOutput `pulumi:"cloudProvider"`
}

Host represents a remote host (for instance, a VM)

func (*Host) Export

func (h *Host) Export(ctx *pulumi.Context, out *HostOutput) error

type HostOutput

type HostOutput struct {
	components.JSONImporter

	CloudProvider components.CloudProviderIdentifier `json:"cloudProvider"`

	Address   string    `json:"address"`
	Port      int       `json:"port"`
	Username  string    `json:"username"`
	Password  string    `json:"password,omitempty"`
	OSFamily  os.Family `json:"osFamily"`
	OSFlavor  os.Flavor `json:"osFlavor"`
	OSVersion string    `json:"osVersion"`
}

HostOutput is the type that is used to import the Host component