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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/cloud/vmware/vmware_vm_shell.rb

Overview

Start a program in a VM without the need for network connection

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 VM,Will help speed up search.

Returns:

  • (Object, nil) —

    The cluster hosting the VM,Will help speed up search



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

attribute :cluster

#datacenter ⇒ String?

Returns The datacenter hosting the VM,Will help speed up search.

Returns:

  • (String, nil) —

    The datacenter hosting the VM,Will help speed up search



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

attribute :datacenter

#vm_id ⇒ String

Returns The identification for the VM.

Returns:

  • (String) —

    The identification for the VM



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

attribute :vm_id

#vm_id_type ⇒ :uuid, ...

Returns The identification tag for the VM.

Returns:

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

    The identification tag for the VM



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

attribute :vm_id_type

#vm_password ⇒ String?

Returns The password used to login to the VM.

Returns:

  • (String, nil) —

    The password used to login to the VM.



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

attribute :vm_password

#vm_shell ⇒ String

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

Returns:

  • (String) —

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



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

attribute :vm_shell

#vm_shell_args ⇒ String?

Returns The argument to the program.

Returns:

  • (String, nil) —

    The argument to the program.



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

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



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

attribute :vm_shell_cwd

#vm_shell_env ⇒ Array<String>, ...

Returns Comma seperated list of envirnoment variable, specified in the guest OS notation.

Returns:

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

    Comma seperated list of envirnoment variable, specified in the guest OS notation



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

attribute :vm_shell_env

#vm_username ⇒ String?

Returns The user to connect to the VM.

Returns:

  • (String, nil) —

    The user to connect to the VM.



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

attribute :vm_username