vcenter_folder – Управление папками на заданном дата-центре
Новое в версии 2.5.
Описание
- Этот модуль может использоваться для создания, удаления, перемещения и переименования папок в заданном дата-центре.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| datacenter - / обязательно | Имя дата-центра. | |
| folder_name - / обязательно | Имя управляемой папки. Этот параметр чувствителен к регистру. Имя папки должно содержать не более 80 символов. Это ограничение VMware. | |
| folder_type - |
| Тип папки. Если установлено значение vm, создается папка 'Папка виртуальных машин и шаблонов' в дата-центре.Если установлено значение host, создается папка 'Папка хостов и кластеров' в дата-центре.Если установлено значение datastore, создается папка 'Папка хранилищ' в дата-центре.Если установлено значение network, создается папка 'Папка сетей' в дата-центре.Этот параметр требуется, если state установлено в значение present и параметр parent_folder отсутствует.Этот параметр игнорируется, если parent_folder установлено. |
| hostname строка | Имя хоста или IP-адрес сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной среды VMWARE_HOST. Поддержка переменных среды добавлена в версии 2.6. | |
| parent_folder - | Имя родительской папки, в которую должна быть создана новая папка. Этот параметр чувствителен к регистру. Пожалуйста, укажите уникальное имя папки, так как нет способа обнаружить дублирующие имена. Если пользователь хочет создать папку в '/DC0/vm/vm_folder', это значение будет 'vm_folder'. | |
| password строка | Пароль сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной среды VMWARE_PASSWORD. Поддержка переменных среды добавлена в версии 2.6. псевдонимы: pass, pwd | |
| port целое число добавлено в 2.5 | По умолчанию: 443 | Номер порта сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной среды VMWARE_PORT. Поддержка переменных среды добавлена в версии 2.6. |
| state - |
| Состояние папки. Если установлено значение present без параметра parent folder, создается папка с folder_type. Если установлено значение present с параметром parent folder, папка создается внутри родительской папки. folder_type игнорируется.Если установлено значение absent, папка будет зарегистрирована и уничтожена. |
| username строка | Имя пользователя сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной среды VMWARE_USER. Поддержка переменных среды добавлена в версии 2.6. псевдонимы: admin, user | |
| validate_certs булево |
| Разрешает подключение, когда сертификаты 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
delegate_to: localhost
- 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
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: 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: datacenter_name
folder_name: sample_vm_folder
folder_type: vm
state: absent
register: vm_folder_deletion_result
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| result строка | success | Строка, обозначающая результат Пример: Папка 'sub_network_folder' типа 'vm' успешно создана в папке vm_folder. |
Статус
- Гарантируется, что этот модуль будет иметь обратную совместимость. [превью]
- Этот модуль поддерживается сообществом 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.7/modules/vcenter_folder_module.html