community.vmware.vcenter_folder – Управление папками на заданном дата-центре
Примечание
Этот плагин входит в коллекцию community.vmware (версия 1.7.0).
Для его установки используйте: ansible-galaxy collection install community.vmware.
Чтобы использовать его в книге задач, укажите: community.vmware.vcenter_folder.
Обзор
- Этот модуль может использоваться для создания, удаления, перемещения и переименования папок в заданном дата-центре.
- Этот модуль поддерживается только для vCenter.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| datacenter строка / обязательно | Имя дата-центра. псевдонимы: datacenter_name | |
| folder_name строка / обязательно | Имя папки, которую нужно управлять. Этот параметр чувствителен к регистру. Имя папки должно содержать не более 80 символов. Это ограничение VMware. | |
| folder_type строка |
| Тип папки. Если задано vm, то под дата-центром создается папка «VM и шаблон папки».Если задано host, то под дата-центром создается папка «Папка хостов и кластеров».Если задано datastore, то под дата-центром создается папка «Папка хранилища».Если задано network, то под дата-центром создается папка «Папка сети».Этот параметр обязателен, если state установлено в present и параметр parent_folder отсутствует.Этот параметр игнорируется, если parent_folder установлен. |
| hostname строка | Имя хоста или IP-адрес сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной среды VMWARE_HOST. Поддержка переменных среды добавлена в Ansible 2.6. | |
| parent_folder строка | Имя родительской папки, в которой необходимо создать новую папку. Этот параметр чувствителен к регистру. Если пользователь хочет создать папку в '/DC0/vm/vm_folder', это значение будет 'vm_folder'. Если пользователь хочет создать папку в '/DC0/vm/folder1/folder2', это значение будет 'folder1/folder2'. | |
| password строка | Пароль сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной среды VMWARE_PASSWORD. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: pass, pwd | |
| port целое число | Значение по умолчанию: 443 | Номер порта сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной среды VMWARE_PORT. Поддержка переменных среды добавлена в Ansible 2.6. |
| proxy_host строка | Адрес прокси-сервера, который будет получать все запросы HTTPS и пересылать их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, используется значение переменной среды VMWARE_PROXY_HOST. Эта функция зависит от версии pyvmomi, большей, чем v6.7.1.2018.12 | |
| proxy_port целое число | Порт HTTP-прокси-сервера, который будет получать все запросы HTTPS и пересылать их. Если значение не указано в задаче, используется значение переменной среды VMWARE_PROXY_PORT. | |
| state строка |
| Состояние папки. Если установлено present без параметра parent folder, то создается папка с folder_type. Если установлено present с параметром parent folder, то папка создается в родительской папке. folder_type игнорируется.Если установлено absent, то папка удаляется. |
| username строка | Имя пользователя сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной среды VMWARE_USER. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: admin, user | |
| validate_certs булево |
| Разрешает подключение, когда сертификаты SSL не валидны. Установите false, когда сертификаты не доверенны.Если значение не указано в задаче, используется значение переменной среды VMWARE_VALIDATE_CERTS. Поддержка переменных среды добавлена в Ansible 2.6. Если установлено true, убедитесь, что Python >= 2.7.9 установлен на данном компьютере. |
Примечания
Примечание
- Тестировалось на vSphere 6.5
Примеры
- 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 сложное | При успехе | Подробности о новой папке | |
| msg строка | успех | Строка, указывающая результат | |
| path строка | успех | Полный путь к новой папке | |
Авторы
- Abhijeet Kasurde (@Akasurde)
- Christian Kotte (@ckotte) <christian.kotte@gmx.de>
- Jan Meerkamp (@meerkampdvv)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/vmware/vcenter_folder_module.html
