remote

Documentation

Index

• func InitHost(e config.CommonEnvironment, conn remote.ConnectionOutput, osDesc os.Descriptor, ...) error
• func NewConnection(host pulumi.StringInput, user, sshKeyPath, sshKeyPassword, sshAgentPath string) (*remote.ConnectionArgs, error)
• type Host
  • func (h *Host) Export(ctx *pulumi.Context, out *HostOutput) error
• type HostOutput

Functions

func InitHost

func InitHost(e config.CommonEnvironment, conn remote.ConnectionOutput, osDesc os.Descriptor, osUser string, 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, sshKeyPath, sshKeyPassword, sshAgentPath string) (*remote.ConnectionArgs, error)

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

Types

type Host

type Host struct {
	pulumi.ResourceState
	components.Component

	OS os.OS

	Address      pulumi.StringOutput `pulumi:"address"`
	Username     pulumi.StringOutput `pulumi:"username"`
	Architecture pulumi.StringOutput `pulumi:"architecture"`
	OSFamily     pulumi.IntOutput    `pulumi:"osFamily"`
	OSFlavor     pulumi.IntOutput    `pulumi:"osFlavor"`
	OSVersion    pulumi.StringOutput `pulumi:"osVersion"`
}

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

	Address   string    `json:"address"`
	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