Модуль community.vmware.vmware_guest_file_operation — операции с файлами в гостевой операционной системе VMware без сети

Примечание

Этот модуль входит в коллекцию community.vmware (версия 6.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.vmware.

Чтобы использовать её в плейбуке, укажите: community.vmware.vmware_guest_file_operation.

Краткое описание
Параметры
Примечания
Примеры

Краткое описание

Модуль для копирования файла на виртуальную машину, получения файла с виртуальной машины и создания или удаления каталога в гостевой ОС.

Параметры

Параметр	Описание
cluster string	Кластер, в котором размещена виртуальная машина. Если задано, это поможет ускорить поиск виртуальной машины.
copy dictionary	Копирование файла на виртуальную машину без использования сети.
dest string / обязательный	Путь назначения файла должен существовать.
overwrite boolean	Перезаписывать файл или нет. Варианты: `false` ← (по умолчанию) `true`
src string / обязательный	Абсолютный или относительный путь к исходному файлу.
datacenter string	Центр обработки данных, в котором размещена виртуальная машина. Если задано, это поможет ускорить поиск виртуальной машины.
directory dictionary	Создание или удаление каталога. Можно использовать для создания временного каталога в гостевой системе с помощью операции mktemp. Операция mktemp записывает в результат переменную `dir` с именем нового каталога.
operation string / обязательный	Выполняемая операция. Варианты: `"create"` `"delete"` `"mktemp"`
path string	Путь к каталогу. Обязателен для `directory.operation=create` или `directory.operation=remove`.
prefix string	Префикс временного каталога. Обязателен для `directory.operation=mktemp`.
recurse boolean	Необязательный параметр. Варианты: `false` ← (по умолчанию) `true`
suffix string	Суффикс временного каталога. Обязателен для `directory.operation=mktemp`.
fetch dictionary	Получение файла с виртуальной машины без использования сети.
dest string / обязательный	Путь назначения файла на localhost должен существовать.
src string / обязательный	Файл на удалённой системе, который нужно получить. Это должен быть файл, а не каталог.
folder string	Целевая папка; абсолютный путь для поиска существующей гостевой системы или создания новой. Путь должен включать центр обработки данных. Центр обработки данных ESX — ha-datacenter Используется только если `vm_id_type=inventory_path`. Примеры: 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
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_HOST`.
password псевдонимы: pass, pwd string	Пароль сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PORT`. По умолчанию: `443`
proxy_host string	Адрес прокси-сервера, который будет принимать и перенаправлять все HTTPS-запросы. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PROXY_HOST`.
proxy_port integer	Порт HTTP-прокси, который будет принимать и перенаправлять все HTTPS-запросы. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PROXY_PORT`.
timeout integer добавлено в community.vmware 3.1.0	Время ожидания в секундах при получении или копировании файла. По умолчанию: `100`
username псевдонимы: admin, user string	Имя пользователя сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_USER`.
validate_certs boolean	Разрешает подключение, если SSL-сертификаты недействительны. Установите значение `false`, если сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
vm_id string / обязательный	Имя виртуальной машины, с которой нужно работать.
vm_id_type string	Метод идентификации VMware, используемый для определения виртуальной машины. Варианты: `"uuid"` `"instance_uuid"` `"dns_name"` `"inventory_path"` `"vm_name"` ← (по умолчанию)
vm_password string / обязательный	Пароль для входа в виртуальную машину.
vm_username string / обязательный	Пользователь для входа в виртуальную машину.

Примечания

Примечание

Используется только первое совпадение с vm_id, даже если найдено несколько совпадений.
Всем модулям необходим доступ на запись через API, поэтому они не поддерживаются при бесплатной лицензии ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.
Модули могут использовать библиотеку Python «requests», которая по умолчанию не использует системное хранилище сертификатов. Указать хранилище сертификатов можно с помощью переменной окружения REQUESTS_CA_BUNDLE. Обратите внимание: наличие этой переменной может в некоторых случаях привести к игнорированию значения «false» параметра «validate_certs». Пример: «export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem»

Примеры

- name: Create directory inside a vm
  community.vmware.vmware_guest_file_operation:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    vm_id: "{{ guest_name }}"
    vm_username: "{{ guest_username }}"
    vm_password: "{{ guest_userpassword }}"
    directory:
      path: "/test"
      operation: create
      recurse: false
  delegate_to: localhost

- name: copy file to vm
  community.vmware.vmware_guest_file_operation:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    vm_id: "{{ guest_name }}"
    vm_username: "{{ guest_username }}"
    vm_password: "{{ guest_userpassword }}"
    copy:
        src: "files/test.zip"
        dest: "/root/test.zip"
        overwrite: false
  delegate_to: localhost

- name: fetch file from vm
  community.vmware.vmware_guest_file_operation:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    vm_id: "{{ guest_name }}"
    vm_username: "{{ guest_username }}"
    vm_password: "{{ guest_userpassword }}"
    fetch:
        src: "/root/test.zip"
        dest: "files/test.zip"
  delegate_to: localhost

- name: If a timeout error occurs, specify a high(er) timeout value
  community.vmware.vmware_guest_file_operation:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    vm_id: "{{ guest_name }}"
    vm_username: "{{ guest_username }}"
    vm_password: "{{ guest_userpassword }}"
    timeout: 10000
    copy:
        src: "files/test.zip"
        dest: "/root/test.zip"
        overwrite: false
  delegate_to: localhost

Авторы

Stéphane Travassac (@stravassac)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/vmware/vmware_guest_file_operation_module.html