Class: Ansible::Ruby::Modules::Vmware_vm_shell

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Vmware_vm_shell

Defined in:

lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vm_shell.rb

Overview

Module allows user to run common system administration commands in the guest operating system.

Instance Method Summary

• #cluster ⇒ Object^?

  The cluster hosting the virtual machine.,If set, it will help to speed up virtual machine search.

• #datacenter ⇒ String^?

  The datacenter hosting the virtual machine.,If set, it will help to speed up virtual machine search.

• #folder ⇒ String^?

  Destination folder, absolute or relative path to find an existing guest or create the new guest.,The folder should include the datacenter.

• #timeout ⇒ Integer^?

  Timeout in seconds.,If set to positive integers, then C(wait_for_process) will honor this parameter and will exit after this timeout.

• #vm_id ⇒ String

  Name of the virtual machine to work with.

• #vm_id_type ⇒ :uuid, ...

  The VMware identification method by which the virtual machine will be identified.

• #vm_password ⇒ String

  The password used to login-in to the virtual machine.

• #vm_shell ⇒ String

  The absolute path to the program to start.,On Linux, shell is executed via bash.

• #vm_shell_args ⇒ String^?

  The argument to the program.,The characters which must be escaped to the shell also be escaped on the command line provided.

• #vm_shell_cwd ⇒ String^?

  The current working directory of the application from which it will be run.

• #vm_shell_env ⇒ Array<String>, ...

  Comma separated list of environment variable, specified in the guest OS notation.

• #vm_username ⇒ String

  The user to login-in to the virtual machine.

• #wait_for_process ⇒ Symbol^?

  If set to C(True), module will wait for process to complete in the given virtual machine.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#cluster ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vm_shell.rb', line 16

attribute :cluster

#datacenter ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vm_shell.rb', line 12

attribute :datacenter

#folder ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vm_shell.rb', line 19

attribute :folder

#timeout ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vm_shell.rb', line 59

attribute :timeout

#vm_id ⇒ String

# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vm_shell.rb', line 23

attribute :vm_id

#vm_id_type ⇒ :uuid, ...

# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vm_shell.rb', line 27

attribute :vm_id_type

#vm_password ⇒ String

# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vm_shell.rb', line 35

attribute :vm_password

#vm_shell ⇒ String

# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vm_shell.rb', line 39

attribute :vm_shell

#vm_shell_args ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vm_shell.rb', line 43

attribute :vm_shell_args

#vm_shell_cwd ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vm_shell.rb', line 51

attribute :vm_shell_cwd

#vm_shell_env ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vm_shell.rb', line 47

attribute :vm_shell_env

#vm_username ⇒ String

# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vm_shell.rb', line 31

attribute :vm_username

#wait_for_process ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vm_shell.rb', line 55

attribute :wait_for_process