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/extras/cloud/vmware/vmware_vm_shell.rb

Instance Method Summary

• #cluster ⇒ Object^?

  The cluster hosting the VM,Will help speed up search.

• #datacenter ⇒ String^?

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

• #vm_id ⇒ String

  The identification for the VM.

• #vm_id_type ⇒ :uuid, ...

  The identification tag for the VM.

• #vm_password ⇒ String^?

  The password used to login to the VM.

• #vm_shell ⇒ String

  The absolute path to the program to start.

• #vm_shell_args ⇒ String^?

  The argument to the program.

• #vm_shell_cwd ⇒ String^?

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

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

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

• #vm_username ⇒ String^?

  The user to connect to the VM.

Methods inherited from Base

#ansible_name, #to_h

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

attr_option, attr_options, attribute, #initialize, #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

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

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

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

attribute :datacenter

#vm_id ⇒ String

Returns The identification for the VM.

Returns:

• (String) —

  The identification for the VM

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

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

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

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.

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

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.

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

attribute :vm_shell

#vm_shell_args ⇒ String^?

Returns The argument to the program.

Returns:

• (String, nil) —

  The argument to the program.

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

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

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

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

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

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.

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

attribute :vm_username