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

Inherits:
Base show all
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 collapse

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?

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

Returns:

  • (Object, nil) —

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



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

attribute :cluster

#datacenter ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :datacenter

#folder ⇒ String?

Returns Destination folder, absolute or relative path to find an existing guest or create the new guest.,The folder should include the datacenter. ESX’s datacenter is ha-datacenter.,Examples:, folder: /ha-datacenter/vm, folder: ha-datacenter/vm, folder: /datacenter1/vm, folder: datacenter1/vm, folder: /datacenter1/vm/folder1, folder: datacenter1/vm/folder1, folder: /folder1/datacenter1/vm, folder: folder1/datacenter1/vm, folder: /folder1/datacenter1/vm/folder2.

Returns:

  • (String, nil) —

    Destination folder, absolute or relative path to find an existing guest or create the new guest.,The folder should include the datacenter. ESX’s datacenter is ha-datacenter.,Examples:, folder: /ha-datacenter/vm, folder: ha-datacenter/vm, folder: /datacenter1/vm, folder: datacenter1/vm, folder: /datacenter1/vm/folder1, folder: datacenter1/vm/folder1, folder: /folder1/datacenter1/vm, folder: folder1/datacenter1/vm, folder: /folder1/datacenter1/vm/folder2



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

attribute :folder

#timeout ⇒ Integer?

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

Returns:

  • (Integer, nil) —

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



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

attribute :timeout

#vm_id ⇒ String

Returns Name of the virtual machine to work with.

Returns:

  • (String) —

    Name of the virtual machine to work with.



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

attribute :vm_id

#vm_id_type ⇒ :uuid, ...

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

Returns:

  • (:uuid, :dns_name, :inventory_path, :vm_name, nil) —

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



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

attribute :vm_id_type

#vm_password ⇒ String

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

Returns:

  • (String) —

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



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

attribute :vm_password

#vm_shell ⇒ String

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

Returns:

  • (String) —

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



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

attribute :vm_shell

#vm_shell_args ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :vm_shell_args

#vm_shell_cwd ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :vm_shell_cwd

#vm_shell_env ⇒ Array<String>, ...

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

Returns:

  • (Array<String>, String, nil) —

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



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

attribute :vm_shell_env

#vm_username ⇒ String

Returns The user to login-in to the virtual machine.

Returns:

  • (String) —

    The user to login-in to the virtual machine.



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

attribute :vm_username

#wait_for_process ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

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



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

attribute :wait_for_process