Модуль vmware.vmware_rest.vcenter_vm_guest_filesystem_directories — создание каталога в гостевой операционной системе

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install vmware.vmware_rest. Для использования этого модуля также требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: vmware.vmware_rest.vcenter_vm_guest_filesystem_directories.

Добавлено в vmware.vmware_rest 2.0.0

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

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

Создаёт каталог в гостевой операционной системе.

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

vSphere 7.0.3 или более поздней версии
python >= 3.6
aiohttp

Параметры

Параметр	Описание
create_parents логическое значение	Нужно ли создавать родительские каталоги. Если произойдёт сбой, некоторые родительские каталоги могут остаться. Если параметр не задан, родительские каталоги не создаются. Варианты: `false` `true`
credentials словарь / обязательный	Данные аутентификации в гостевой системе. Этот параметр обязателен. Допустимые атрибуты: - `interactive_session` (bool): если задано, операция будет взаимодействовать с сеансом рабочего стола, в который выполнен вход в гостевой системе. Для этого пользователь, вошедший в систему, должен совпадать с пользователем, указанным в Credentials. В настоящее время поддерживается только для USERNAME_PASSWORD. ([‘absent’, ‘create_temporary’, ‘move’, ‘present’]) Этот ключ обязателен при значениях [‘absent’, ‘create_temporary’, ‘move’, ‘present’]. - `type` (str): тип учётных данных гостевой системы ([‘absent’, ‘create_temporary’, ‘move’, ‘present’]) Этот ключ обязателен при значениях [‘absent’, ‘create_temporary’, ‘move’, ‘present’]. - Допустимые значения: - SAML_BEARER_TOKEN - USERNAME_PASSWORD - `user_name` (str): для SAML_BEARER_TOKEN — пользователь гостевой системы, связанный с учётными данными. Для USERNAME_PASSWORD — имя пользователя гостевой системы. Если для SAML_BEARER_TOKEN пользователь не указан, соответствие, зависящее от гостевой системы, определит, какая учётная запись гостевого пользователя будет использована. ([‘absent’, ‘create_temporary’, ‘move’, ‘present’]) - `password` (str): пароль Это поле необязательно и имеет значение только в том случае, если значение Credentials.type — USERNAME_PASSWORD. ([‘absent’, ‘create_temporary’, ‘move’, ‘present’]) - `saml_token` (str): токен предъявителя SAML Это поле необязательно и имеет значение только в том случае, если значение Credentials.type — SAML_BEARER_TOKEN. ([‘absent’, ‘create_temporary’, ‘move’, ‘present’])
new_path строка	Полный путь, куда перемещается каталог, или его новое имя. Не может указывать на существующий каталог или файл. Обязателен при state=[‘move’]
parent_path строка	Полный путь к каталогу, в котором нужно создать новый каталог. Если параметр не задан, будет использоваться значение по умолчанию, зависящее от гостевой системы.
path строка	Полный путь к создаваемому каталогу. Обязателен при state=[‘absent’, ‘move’, ‘present’]
prefix строка	Префикс нового временного каталога. Обязателен при state=[‘create_temporary’]
recursive логическое значение	Если значение равно true, удаляются также все файлы и подкаталоги. Если значение равно false, для успешного выполнения операции каталог должен быть пустым. Если параметр не задан, содержимое каталога не удаляется. Варианты: `false` `true`
session_timeout число с плавающей точкой добавлено в vmware.vmware_rest 2.1.0	Настройка времени ожидания сеанса клиента. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с.
state строка	Варианты: `"absent"` `"create_temporary"` `"move"` `"present"` ← (по умолчанию)
suffix строка	Суффикс нового временного каталога. Обязателен при state=[‘create_temporary’]
vcenter_hostname строка / обязательный	Имя хоста или IP-адрес vSphere vCenter Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_HOST`.
vcenter_password строка / обязательный	Пароль vSphere vCenter Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PASSWORD`.
vcenter_rest_log_file строка	Этот необязательный параметр позволяет задать расположение файла журнала. В этом файле будут записываться данные взаимодействия по HTTP REST. Файл будет сохранён на хосте, на котором выполняется модуль. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_REST_LOG_FILE`.
vcenter_username строка / обязательный	Имя пользователя vSphere vCenter Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_USER`.
vcenter_validate_certs логическое значение	Разрешает подключение, если SSL-сертификаты недействительны. Установите значение `false`, если сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
vm строка / обязательный	Виртуальная машина, над которой выполняется операция. Параметр должен содержать идентификатор ресурса, возвращённый модулем vmware.vmware_rest.vcenter_vm_info. Этот параметр обязателен.

Примечания

Примечание

Проверено на vSphere 7.0.3

Примеры

- name: Create a VM
  vmware.vmware_rest.vcenter_vm:
    placement:
      cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}"
      datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}"
      folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}"
      resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}"
    name: test_vm1
    guest_OS: RHEL_7_64
    hardware_version: VMX_11
    memory:
      hot_add_enabled: true
      size_MiB: 1024
    disks:
    - type: SATA
      backing:
        type: VMDK_FILE
        vmdk_file: '[local] test_vm1/{{ disk_name }}.vmdk'
    - type: SATA
      new_vmdk:
        name: second_disk
        capacity: 32000000000
    cdroms:
    - type: SATA
      sata:
        bus: 0
        unit: 2
    nics:
    - backing:
        type: STANDARD_PORTGROUP
        network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}"
  register: my_vm

- name: Create a directory in /tmp
  vmware.vmware_rest.vcenter_vm_guest_filesystem_directories:
    vm: '{{ my_vm.id }}'
    path: /tmp/my/path
    create_parents: true
    credentials:
      interactive_session: false
      type: USERNAME_PASSWORD
      user_name: root
      password: root

Авторы

Команда Ansible Cloud (@ansible-collections)

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

© 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/vmware/vmware_rest/vcenter_vm_guest_filesystem_directories_module.html