winrm

Documentation

Overview

Package winrm implements the WinRM communicator. Plugin maintainers should not import this package directly, instead using the tooling in the "packer-plugin-sdk/communicator" module.

Index

• type Base64Pipe
  • func (d *Base64Pipe) ReadFrom(r io.Reader) (int64, error)
  • func (d *Base64Pipe) Write(p []byte) (int, error)
• type Communicator
  • func New(config *Config) (*Communicator, error)
  • func (c *Communicator) Download(src string, dst io.Writer) error
  • func (c *Communicator) DownloadDir(src string, dst string, exclude []string) error
  • func (c *Communicator) Start(ctx context.Context, rc *packersdk.RemoteCmd) error
  • func (c *Communicator) Upload(path string, input io.Reader, fi *os.FileInfo) error
  • func (c *Communicator) UploadDir(dst string, src string, exclude []string) error
• type Config

Types

type Base64Pipe

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

func (*Base64Pipe) ReadFrom

func (d *Base64Pipe) ReadFrom(r io.Reader) (int64, error)

func (*Base64Pipe) Write

func (d *Base64Pipe) Write(p []byte) (int, error)

type Communicator

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

Communicator represents the WinRM communicator

func New

func New(config *Config) (*Communicator, error)

New creates a new communicator implementation over WinRM.

func (*Communicator) Download

func (c *Communicator) Download(src string, dst io.Writer) error

func (*Communicator) DownloadDir

func (c *Communicator) DownloadDir(src string, dst string, exclude []string) error

func (*Communicator) Start

func (c *Communicator) Start(ctx context.Context, rc *packersdk.RemoteCmd) error

Start implementation of communicator.Communicator interface

func (*Communicator) Upload

func (c *Communicator) Upload(path string, input io.Reader, fi *os.FileInfo) error

Upload implementation of communicator.Communicator interface

func (*Communicator) UploadDir

func (c *Communicator) UploadDir(dst string, src string, exclude []string) error

UploadDir implementation of communicator.Communicator interface

type Config

type Config struct {
	Host               string
	Port               int
	Username           string
	Password           string
	Timeout            time.Duration
	Https              bool
	Insecure           bool
	TransportDecorator func() winrm.Transporter
}

Config is used to configure the WinRM connection