psmodule

Documentation

Index

• Variables
• func Name() string
• type PSModulePluginInput
• type PSModulePluginOutput
  • func (out *PSModulePluginOutput) MarkAsFailed(log log.T, err error)
• type Plugin
  • func NewPlugin(pluginConfig pluginutil.PluginConfig) (*Plugin, error)
  • func (p *Plugin) Execute(context context.T, config contracts.Configuration, cancelFlag task.CancelFlag) (res contracts.PluginResult)

Variables

var PowerShellModulesDirectory = filepath.Join(os.Getenv("SystemRoot"), "System32", "WindowsPowerShell", "v1.0", "Modules")

PowerShellModulesDirectory is the directory where PowerShell Modules are installed

Functions

func Name

func Name() string

Name returns the name of the plugin

Types

type PSModulePluginInput

type PSModulePluginInput struct {
	contracts.PluginInput
	RunCommand       []string
	ID               string
	WorkingDirectory string
	TimeoutSeconds   interface{}
	Source           string
	SourceHash       string
	SourceHashType   string
}

RunCommandPluginInput represents one set of commands executed by the RunCommand plugin.

type PSModulePluginOutput

type PSModulePluginOutput struct {
	contracts.PluginOutput
}

PSModulePluginOutput represents the output of the plugin

func (*PSModulePluginOutput) MarkAsFailed

func (out *PSModulePluginOutput) MarkAsFailed(log log.T, err error)

Failed marks plugin as Failed

type Plugin

type Plugin struct {
	pluginutil.DefaultPlugin
}

Plugin is the type for the psmodule plugin.

func NewPlugin

func NewPlugin(pluginConfig pluginutil.PluginConfig) (*Plugin, error)

NewPlugin returns a new instance of the plugin.

func (*Plugin) Execute

func (p *Plugin) Execute(context context.T, config contracts.Configuration, cancelFlag task.CancelFlag) (res contracts.PluginResult)

Execute runs multiple sets of commands and returns their outputs. res.Output will contain a slice of RunCommandPluginOutput.