vcenter_folder — Управление папками на заданном дата-центре
Новое в версии 2.5.
Обзор
- Этот модуль можно использовать для создания, удаления, перемещения и переименования папок в заданном дата-центре.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| datacenter обязательно | Имя дата-центра. | |
| folder_name обязательно | Имя папки, подлежащей управлению. Этот параметр чувствителен к регистру. Имя папки должно содержать не более 80 символов. Это ограничение VMware. | |
| folder_type |
| Тип папки. Если установлено значение vm, создаётся папка 'VM и Шаблон папки' в дата-центре.Если установлено значение host, создаётся папка 'Папка хостов и кластеров' в дата-центре.Если установлено значение datastore, создаётся папка 'Папка хранилищ' в дата-центре.Если установлено значение network, создаётся папка 'Папка сетей' в дата-центре.Этот параметр требуется, если state установлено в present, а параметр parent_folder отсутствует.Этот параметр игнорируется, если установлено parent_folder. |
| hostname | Имя хоста или IP-адрес сервера vCenter или ESXi. Если значение не указано в задаче, используется значение переменной окружения VMWARE_HOST. Поддержка переменных окружения добавлена в версии 2.6. | |
| parent_folder | Имя родительской папки, в которой необходимо создать новую папку. Этот параметр чувствителен к регистру. Укажите уникальное имя папки, так как нет способа обнаружить дубликаты. Если пользователь хочет создать папку в '/DC0/vm/vm_folder', это значение будет 'vm_folder'. | |
| password | Пароль сервера vCenter или ESXi. Если значение не указано в задаче, используется значение переменной окружения VMWARE_PASSWORD. Поддержка переменных окружения добавлена в версии 2.6. псевдонимы: pass, pwd | |
| port (добавлено в 2.5) | По умолчанию: 443 | Номер порта сервера vCenter или ESXi. Если значение не указано в задаче, используется значение переменной окружения VMWARE_PORT. Поддержка переменных окружения добавлена в версии 2.6. |
| state |
| Состояние папки. Если установлено present без параметра parent_folder, создаётся папка с folder_type. Если установлено present с параметром parent_folder, создаётся папка в родительской папке. folder_type игнорируется.Если установлено absent, папка будет отменена и удалена. |
| username | Имя пользователя сервера vCenter или ESXi. Если значение не указано в задаче, используется значение переменной окружения VMWARE_USER. Поддержка переменных окружения добавлена в версии 2.6. псевдонимы: user, admin | |
| validate_certs |
True | Разрешает подключение, когда SSL-сертификаты недействительны. Установите false, когда сертификаты не доверенны.Если значение не указано в задаче, используется значение переменной окружения VMWARE_VALIDATE_CERTS. Поддержка переменных окружения добавлена в версии 2.6. |
Примечания
Примечание
- Тестировалось на 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 строка | успех | Строка, сообщающая о результате Пример: Папка 'sub_network_folder' типа 'vm' успешно создана в папке vm_folder. |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.
Автор
- 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.5/modules/vcenter_folder_module.html