Class: VagrantBolt::ConfigBuilder::Provisioner

Inherits:
ConfigBuilder::Model::Provisioner::Base
  • Object
show all
Defined in:
lib/vagrant-bolt/config_builder/provisioner.rb

Instance Attribute Summary collapse

Instance Attribute Details

#args ⇒ String

Returns Additional arguments for the bolt command.

Returns:

  • (String) —

    Additional arguments for the bolt command



9
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 9

def_model_attribute :args

#bolt_exe ⇒ String

Returns The full path to the bolt command. If not passed in, the default from PATH will be used.

Returns:

  • (String) —

    The full path to the bolt command. If not passed in, the default from PATH will be used.



13
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 13

def_model_attribute :bolt_exe

#boltdir ⇒ String

Returns DEPRECATED use project. The bolt working directory. Defaults to ..

Returns:

  • (String) —

    DEPRECATED use project. The bolt working directory. Defaults to .



17
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 17

def_model_attribute :boltdir

#command ⇒ Symbol

Returns Whether bolt should use a task or plan.

Returns:

  • (Symbol) —

    Whether bolt should use a task or plan



76
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 76

def_model_attribute :command

#connect_timeout ⇒ String

Returns The ssh connection timeout (linux).

Returns:

  • (String) —

    The ssh connection timeout (linux)



25
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 25

def_model_attribute :connect_timeout

#debug ⇒ Boolean

Returns Shows debug logging.

Returns:

  • (Boolean) —

    Shows debug logging



21
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 21

def_model_attribute :debug

#excludes ⇒ Array<String, Symbol>

Note: The target_list will override this setting. Note: This will be merged with targets, with excludes taking precidence. Valid values are an array of machine names.

Returns:

  • (Array<String, Symbol>) —

    The targets to exclude from running this task or plan on.



63
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 63

def_model_attribute :excludes

#host_key_check ⇒ Boolean

Returns If the connection should check the host key on the remote host (linux).

Returns:

  • (Boolean) —

    If the connection should check the host key on the remote host (linux)



29
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 29

def_model_attribute :host_key_check

#machine_alias ⇒ String

Returns The alias of the machine to set in the bolt inventory.

Returns:

  • (String) —

    The alias of the machine to set in the bolt inventory



33
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 33

def_model_attribute :machine_alias

#machine_name ⇒ String

Returns The name of the machine to set in the bolt inventory.

Returns:

  • (String) —

    The name of the machine to set in the bolt inventory



37
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 37

def_model_attribute :machine_name

#modulepath ⇒ String

Returns The path to the modules.

Returns:

  • (String) —

    The path to the modules.



41
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 41

def_model_attribute :modulepath

#name ⇒ String

Returns The name of task or plan to run.

Returns:

  • (String) —

    The name of task or plan to run



45
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 45

def_model_attribute :name

#node_list ⇒ String

This setting overrides nodes and needs to be in the protocol://ipaddress:port URI format

Returns:

  • (String) —

    The bolt node list. This defaults to the currnet node.



68
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 68

def_model_attribute :node_list

#nodes ⇒ Array<String, Symbol>, "ALL"

DEPRECATED. Use targets instead. Note: The node_list will override this setting. Valid values are an array of machine names or the string "ALL".

Returns:

  • (Array<String, Symbol>, "ALL") —

    The nodes to run the task or plan on.



52
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 52

def_model_attribute :nodes

#noop ⇒ Boolean

Returns If the command should be run with noop. Only valid with tasks and apply.

Returns:

  • (Boolean) —

    If the command should be run with noop. Only valid with tasks and apply.



56
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 56

def_model_attribute :noop

#params ⇒ Hash

Returns The paramater hash for the task or plan.

Returns:

  • (Hash) —

    The paramater hash for the task or plan



72
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 72

def_model_attribute :params

#password ⇒ String

Returns The password to authenticate on the machine.

Returns:

  • (String) —

    The password to authenticate on the machine.



84
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 84

def_model_attribute :password

#port ⇒ String

Returns The port to connect to the machine.

Returns:

  • (String) —

    The port to connect to the machine.



88
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 88

def_model_attribute :port

#private_key ⇒ String

Returns The path of the private_key to authenticate on the machine.

Returns:

  • (String) —

    The path of the private_key to authenticate on the machine.



92
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 92

def_model_attribute :private_key

#project ⇒ String

Returns The bolt working directory. Defaults to ..

Returns:

  • (String) —

    The bolt working directory. Defaults to .



96
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 96

def_model_attribute :project

#run_as ⇒ String

Returns User to run as using privilege escalation.

Returns:

  • (String) —

    User to run as using privilege escalation.



100
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 100

def_model_attribute :run_as

#ssl ⇒ Boolean

Returns If the connection should use SSL on with WinRM (Windows).

Returns:

  • (Boolean) —

    If the connection should use SSL on with WinRM (Windows)



108
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 108

def_model_attribute :ssl

#ssl_verify ⇒ Boolean

Returns If the connection should verify SSL on with WinRM (Windows).

Returns:

  • (Boolean) —

    If the connection should verify SSL on with WinRM (Windows)



112
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 112

def_model_attribute :ssl_verify

#sudo_password ⇒ String

Returns The password to authenticate sudo on the machine.

Returns:

  • (String) —

    The password to authenticate sudo on the machine.



104
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 104

def_model_attribute :sudo_password

#target_list ⇒ String

This setting overrides targets and needs to be in the protocol://ipaddress:port URI format

Returns:

  • (String) —

    The bolt target list. This defaults to the current target.



123
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 123

def_model_attribute :target_list

#targets ⇒ Array<String, Symbol>, "ALL"

Note: The target_list will override this setting. Valid values are an array of machine names or the string "ALL".

Returns:

  • (Array<String, Symbol>, "ALL") —

    The targets to run the task or plan on.



118
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 118

def_model_attribute :targets

#tmpdir ⇒ String

Returns The directory to upload and execute temporary files on the target.

Returns:

  • (String) —

    The directory to upload and execute temporary files on the target



127
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 127

def_model_attribute :tmpdir

#user ⇒ String

Returns The user to authenticate on the machine.

Returns:

  • (String) —

    The user to authenticate on the machine.



80
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 80

def_model_attribute :user

#verbose ⇒ Boolean

Returns Shows verbose logging.

Returns:

  • (Boolean) —

    Shows verbose logging



131
 
# File 'lib/vagrant-bolt/config_builder/provisioner.rb', line 131

def_model_attribute :verbose