vcenter_folder — Управление папками на заданном дата-центре

Новая версия 2.5.

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

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

Требования

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

python >= 2.6
PyVmomi

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
datacenter обязательный		Имя дата-центра.
folder_name обязательный		Имя папки, подлежащей управлению. Этот параметр чувствителен к регистру. Имя папки должно содержать не более 80 символов. Это ограничение VMware.
folder_type	Варианты: datastore host network vm ←	Тип папки. Если установлено значение `vm`, создаётся папка 'VM и шаблон папки' в дата-центре. Если установлено значение `host`, создаётся папка 'Папка хоста и кластера' в дата-центре. Если установлено значение `datastore`, создаётся папка 'Папка хранилища' в дата-центре. Если установлено значение `network`, создаётся папка 'Папка сети' в дата-центре. Этот параметр необходим, если `state` установлено в `present` и parent_folder отсутствует. Этот параметр игнорируется, если `parent_folder` установлено.
hostname str		Имя хоста или IP-адрес сервера vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_HOST`. Поддержка переменных окружения добавлена в версии 2.6.
parent_folder		Имя родительской папки, в которой должна быть создана новая папка. Этот параметр чувствителен к регистру. Укажите уникальное имя папки, так как нет способа обнаружить дублирующие имена. Если пользователь хочет создать папку в '/DC0/vm/vm_folder', это значение будет 'vm_folder'.
password str		Пароль сервера vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PASSWORD`. Поддержка переменных окружения добавлена в версии 2.6. псевдонимы: pass, pwd
port int (добавлен в 2.5)	Значение по умолчанию: 443	Номер порта сервера vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PORT`. Поддержка переменных окружения добавлена в версии 2.6.
state	Варианты: present ← absent	Состояние папки. Если установлено значение `present` без параметра parent_folder, то создаётся папка с именем `folder_type`. Если установлено значение `present` с параметром parent_folder, то папка создаётся в родительской папке. `folder_type` игнорируется. Если установлено значение `absent`, папка будет отменена и удалена.
username str		Имя пользователя сервера vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_USER`. Поддержка переменных окружения добавлена в версии 2.6. псевдонимы: admin, user
validate_certs bool	Варианты: no yes ←	Разрешает подключение, когда сертификаты SSL недействительны. Установите значение `false`, когда сертификаты не доверяются. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_VALIDATE_CERTS`. Поддержка переменных окружения добавлена в версии 2.6. Если установлено значение `yes`, убедитесь, что на данном компьютере установлен Python >= 2.7.9.

Примечания

Примечание

Тестировалось на vSphere 6.5

Примеры

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

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

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

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

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

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

Ключ	Возвращаемое значение	Описание
result строка	success	Строка, содержащая информацию о результате. Пример: Папка 'sub_network_folder' типа 'vm' успешно создана в папке vm_folder.

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

Abhijeet Kasurde (@Akasurde)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/vcenter_folder_module.html