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