Class: Ansible::Ruby::Modules::Vmware_guest_file_operation

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

Overview

Module to copy a file to a VM, fetch a file from a VM and create or delete a directory in the guest OS.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

attr_option, attr_options, attribute, fix_inclusion, #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_guest_file_operation.rb', line 16

attribute :cluster

#copy ⇒ Hash?

Returns Copy file to vm without requiring network.,Valid attributes are:, src: file source absolute or relative, dest: file destination, path must be exist, overwrite: False or True (not required, default False).

Returns:

  • (Hash, nil) —

    Copy file to vm without requiring network.,Valid attributes are:, src: file source absolute or relative, dest: file destination, path must be exist, overwrite: False or True (not required, default False)



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

attribute :copy

#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_guest_file_operation.rb', line 12

attribute :datacenter

#directory ⇒ Hash?

Returns Create or delete directory.,Valid attributes are:, path: directory path to create or remove, operation: Valid values are create, delete, recurse (boolean): Not required, default (false).

Returns:

  • (Hash, nil) —

    Create or delete directory.,Valid attributes are:, path: directory path to create or remove, operation: Valid values are create, delete, recurse (boolean): Not required, default (false)



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

attribute :directory

#fetch ⇒ Hash?

Returns Get file from virtual machine without requiring network.,Valid attributes are:, src: The file on the remote system to fetch. This I(must) be a file, not a directory, dest: file destination on localhost, path must be exist.

Returns:

  • (Hash, nil) —

    Get file from virtual machine without requiring network.,Valid attributes are:, src: The file on the remote system to fetch. This I(must) be a file, not a directory, dest: file destination on localhost, path must be exist



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

attribute :fetch

#folder ⇒ Object?

Returns Destination folder, absolute path to find an existing guest or create the new guest.,The folder should include the datacenter. ESX’s datacenter is ha-datacenter,Used only if C(vm_id_type) is C(inventory_path).,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, folder: vm/folder2, folder: folder2.

Returns:

  • (Object, nil) —

    Destination folder, absolute path to find an existing guest or create the new guest.,The folder should include the datacenter. ESX’s datacenter is ha-datacenter,Used only if C(vm_id_type) is C(inventory_path).,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, folder: vm/folder2, folder: folder2



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

attribute :folder

#vm_id ⇒ String

Returns Name of the virtual machine to work with.

Returns:

  • (String) —

    Name of the virtual machine to work with.



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

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.



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

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.



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

attribute :vm_password

#vm_username ⇒ String

Returns The user to login in to the virtual machine.

Returns:

  • (String) —

    The user to login in to the virtual machine.



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

attribute :vm_username