vsphere_copy – Copy a file to a VMware datastore — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# vsphere_copy – Copy a file to a VMware datastore

- Synopsis
- Parameters
- Notes
- Examples
- Status

## Synopsis

- Upload files to a VMware datastore through a vCenter REST API.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
datacenter string |  | The datacenter on the vCenter server that holds the datastore.
datastore string / required |  | The datastore to push files to.
hostname string added in 2.9 |  | 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 `VMWARE_HOST` will be used instead. Environment variable support added in Ansible 2.6. aliases: host
password string |  | The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable `VMWARE_PASSWORD` will be used instead. Environment variable support added in Ansible 2.6. aliases: pass, pwd
path string / required |  | The file to push to the datastore.
port integer added in 2.9 | Default: 443 | The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable `VMWARE_PORT` will be used instead. Environment variable support added in Ansible 2.6.
proxy_host string added in 2.9 |  | 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 `VMWARE_PROXY_HOST` will be used instead. This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
proxy_port integer added in 2.9 |  | 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 `VMWARE_PROXY_PORT` will be used instead.
src string / required |  | The file to push to vCenter.
timeout integer added in 2.8 | Default: 10 | The timeout in seconds for the upload to the datastore.
username string added in 2.9 |  | The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable `VMWARE_USER` will be used instead. Environment variable support added in Ansible 2.6. aliases: login
validate_certs boolean | Choices: no yes ← | Allows connection when SSL certificates are not valid. Set to `false` when certificates are not trusted. If the value is not specified in the task, the value of environment variable `VMWARE_VALIDATE_CERTS` will be used instead. Environment variable support added in Ansible 2.6. If set to `yes`, please make sure Python >= 2.7.9 is installed on the given machine.

## Notes

Note

- This module ought to be run from a system that can access the vCenter or the ESXi directly and has the file to transfer. It can be the normal remote target or you can change it either by using `transport: local` or using `delegate_to`.
- Tested on vSphere 5.5 and ESXi 6.7

## Examples

    - name: Copy file to datastore using delegate_to
      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
      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
      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

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Dag Wieers (@dagwieers)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.