community / community.vmware / 4.2.0 / module / vsphere_copy Copy a file to a VMware datastore Authors: Dag Wieers (@dagwieers)community.vmware.vsphere_copy (4.2.0) — module
Install with ansible-galaxy collection install community.vmware:==4.2.0
collections: - name: community.vmware version: 4.2.0
Upload files to a VMware datastore through a vCenter REST API.
- name: Copy file to datastore using delegate_to community.vmware.vsphere_copy: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' src: /some/local/file datacenter: DC1 Someplace datastore: datastore1 path: some/remote/file delegate_to: localhost
- name: Copy file to datastore when datacenter is inside folder called devel community.vmware.vsphere_copy: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' src: /some/local/file datacenter: devel/DC1 datastore: datastore1 path: some/remote/file delegate_to: localhost
- name: Copy file to datastore using other_system community.vmware.vsphere_copy: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' src: /other/local/file datacenter: DC2 Someplace datastore: datastore2 path: other/remote/file delegate_to: other_system
- name: Copy file to datastore using other_system community.vmware.vsphere_copy: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' src: /other/local/streamOptimized.vmdk datacenter: DC2 Someplace datastore: datastore2 path: disk_imports/streamOptimized.vmdk timeout: 360 diskformat: StreamVmdk delegate_to: other_system
src: aliases: - name description: - The file to push to vCenter. required: true type: str path: aliases: - dest description: - The file to push to the datastore. required: true type: str port: default: 443 description: - The port number of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PORT) will be used instead. type: int timeout: default: 10 description: - The timeout in seconds for the upload to the datastore. type: int hostname: description: - The hostname or IP address of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_HOST) will be used instead. type: str password: aliases: - pass - pwd description: - The password of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD) will be used instead. type: str username: aliases: - admin - user description: - The username of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_USER) will be used instead. type: str datastore: description: - The datastore to push files to. required: true type: str datacenter: description: - The datacenter on the vCenter server that holds the datastore. required: false type: str diskformat: choices: - StreamVmdk description: - Optional argument - Set a diskformat for certain uploads like stream optimized VMDKs - There is no official documentation, but it looks like V(StreamVmdk) needs to be set for stream optimized VMDKs that are uploaded to vSAN storage - Setting this for non-VMDK files might lead to undefined behavior and is not supported. type: str version_added: 4.2.0 version_added_collection: community.vmware proxy_host: description: - Address of a proxy that will receive all HTTPS requests and relay them. - The format is a hostname or a IP. - If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_HOST) will be used instead. required: false type: str proxy_port: description: - Port of the HTTP proxy that will receive all HTTPS requests and relay them. - If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_PORT) will be used instead. required: false type: int validate_certs: default: true description: - Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted. - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS) will be used instead. type: bool