Module: CemAcpt::Bolt::Cmd

Defined in:
lib/cem_acpt/bolt/cmd.rb,
lib/cem_acpt/bolt/cmd/base.rb,
lib/cem_acpt/bolt/cmd/task.rb,
lib/cem_acpt/bolt/cmd/output.rb

Overview

Namespace for all Bolt command classes

Defined Under Namespace

Classes: Base, Output, OutputError, OutputItem, TaskBase, TaskRun, TaskShow

Class Method Summary collapse

Class Method Details

.new_output(cmd_output, strict: true, **item_defaults) ⇒ Output

Represents the output of a Bolt command

Parameters:

  • cmd_output (String, StandardError)

    the output of a Bolt command or an error

  • strict (Boolean) (defaults to: true)

    whether to raise an error if the output does not match the expected format

  • item_defaults (Hash)

    default values for the item.

Options Hash (**item_defaults):

  • :action (String)

    The action that was performed (ex: ‘task’)

  • :object (String)

    The object that the action was performed on (ex. The Bolt task name)

Returns:

  • (Output)

    a new Output object for the given command output



17
18
19
# File 'lib/cem_acpt/bolt/cmd.rb', line 17

def self.new_output(cmd_output, strict: true, **item_defaults)
  Output.new(cmd_output, strict: strict, **item_defaults)
end