Модуль community.vmware.vcenter_folder – Управление папками в заданном центре данных

Примечание

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

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

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

Для использования в playbook, укажите: community.vmware.vcenter_folder.

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

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

Этот модуль можно использовать для создания, удаления, перемещения и переименования папок в заданном центре данных.
Этот модуль поддерживается только для vCenter.

Параметры

Параметр	Комментарии
datacenter aliases: datacenter_name string / required	Имя центра данных.
folder_name string / required	Имя папки, которой необходимо управлять. Имя папки должно содержать менее 80 символов. Это ограничение VMware.
folder_type string	Тип папки. Если установлен как `vm`, то создается папка «Папка виртуальных машин и шаблонов» в центре данных. Если установлен как `host`, то создается папка «Папка хостов и кластеров» в центре данных. Если установлен как `datastore`, то создается папка «Папка хранилищ» в центре данных. Если установлен как `network`, то создается папка «Папка сетей» в центре данных. Этот параметр обязателен, если `state=absent` и `parent_folder` не заданы. Варианты: `"datastore"` `"host"` `"network"` `"vm"` ← (по умолчанию)
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_HOST`.
parent_folder string	Имя родительской папки, в которой необходимо создать новую папку. Если пользователь хочет создать папку в «/DC0/vm/vm_folder», это значение будет «vm_folder». Если пользователь хочет создать папку в «/DC0/vm/folder1/folder2», это значение будет «folder1/folder2».
password aliases: pass, pwd string	Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PORT`. По умолчанию: `443`
proxy_host string	Адрес прокси-сервера, который будет принимать все HTTPS-запросы и пересылать их. Формат – имя хоста или IP-адрес. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PROXY_HOST`.
proxy_port integer	Порт HTTP-прокси, который будет принимать все HTTPS-запросы и пересылать их. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PROXY_PORT`.
state string	Состояние папки. Если установлено как `present` без параметра родительской папки, то создается папка с `folder_type`. Если установлено как `present` с параметром родительской папки, то папка создается в родительской папке. `folder_type` игнорируется. Если установлено как `absent`, то папка отменяется и удаляется. Варианты: `"present"` ← (по умолчанию) `"absent"`
username aliases: admin, user string	Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_USER`.
validate_certs boolean	Разрешает подключение, когда SSL-сертификаты недействительны. Установите в `false`, когда сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Все модули требуют права доступа к записи API и поэтому не поддерживаются в бесплатной лицензии ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.

Примеры

- name: Create a VM folder on given datacenter
  community.vmware.vcenter_folder:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: datacenter_name
    folder_name: sample_vm_folder
    folder_type: vm
    state: present
  register: vm_folder_creation_result
  delegate_to: localhost

- name: Create a datastore folder on given datacenter
  community.vmware.vcenter_folder:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: datacenter_name
    folder_name: sample_datastore_folder
    folder_type: datastore
    state: present
  register: datastore_folder_creation_result
  delegate_to: localhost

- name: Create a sub folder under VM folder on given datacenter
  community.vmware.vcenter_folder:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: datacenter_name
    folder_name: sample_sub_folder
    parent_folder: vm_folder
    state: present
  register: sub_folder_creation_result
  delegate_to: localhost

- name: Delete a VM folder on given datacenter
  community.vmware.vcenter_folder:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: datacenter_name
    folder_name: sample_vm_folder
    folder_type: vm
    state: absent
  register: vm_folder_deletion_result
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
result complex	Подробная информация о новой папке Возвращается: При успехе
msg string	Строка, указывающая на результат Возвращается: При успехе
path string	Полный путь к новой папке Возвращается: При успехе

Авторы

Abhijeet Kasurde (@Akasurde)
Christian Kotte (@ckotte)
Jan Meerkamp (@meerkampdvv)

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

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