community.vmware.vmware_local_role_manager – Управление локальными ролями на хосте ESXi
Примечание
Этот плагин является частью коллекции community.vmware (версия 1.7.0).
Для его установки используйте: ansible-galaxy collection install community.vmware.
Чтобы использовать его в книге задач, укажите: community.vmware.vmware_local_role_manager.
Описание
- Этот модуль может использоваться для управления локальными ролями на хосте ESXi.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| action строка |
| Этот параметр действителен только при обновлении существующей роли с привилегиями. add добавит привилегии к существующему списку привилегий.remove удалит привилегии из существующего списка привилегий.set заменит привилегии существующих привилегий на пользовательский список привилегий. |
| force_remove булево |
| Если установлено False, предотвращает удаление роли, если какие-либо разрешения используют её. |
| hostname строка | Имя хоста или IP-адрес сервера vCenter или ESXi сервера vSphere. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_HOST. Поддержка переменных среды добавлена в Ansible 2.6. | |
| local_privilege_ids список / элементы=строка | Значение по умолчанию: [] | Список привилегий, которые должна иметь роль. |
| local_role_name строка / обязательно | Имя локальной роли для управления. | |
| password строка | Пароль сервера vCenter или ESXi сервера vSphere. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PASSWORD. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: pass, pwd | |
| port целое число | Значение по умолчанию: 443 | Номер порта сервера vCenter или ESXi сервера vSphere. Если значение не указано в задаче, будет использовано значение переменной среды 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 строка |
| Указывает желаемое состояние роли. Если роль уже существует, когда state=present, информация о роли обновляется. |
| username строка | Имя пользователя сервера vCenter или ESXi сервера vSphere. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_USER. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: admin, user | |
| validate_certs булево |
| Разрешает подключение, когда сертификаты SSL не валидны. Установите в false, когда сертификаты не доверенны.Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_VALIDATE_CERTS. Поддержка переменных среды добавлена в Ansible 2.6. Если установлено true, убедитесь, что на данном компьютере установлен Python >= 2.7.9. |
Примечания
Примечание
- Тестировано на ESXi 6.5
- Убедитесь, что пользователь ESXi, используемый для входа, имеет соответствующие права на создание/удаление/изменение ролей
Примеры
- name: Add local role to ESXi
community.vmware.vmware_local_role_manager:
hostname: '{{ esxi_hostname }}'
username: '{{ esxi_username }}'
password: '{{ esxi_password }}'
local_role_name: vmware_qa
state: present
delegate_to: localhost
- name: Add local role with privileges to ESXi
community.vmware.vmware_local_role_manager:
hostname: '{{ esxi_hostname }}'
username: '{{ esxi_username }}'
password: '{{ esxi_password }}'
local_role_name: vmware_qa
local_privilege_ids: [ 'Folder.Create', 'Folder.Delete']
state: present
delegate_to: localhost
- name: Remove local role from ESXi
community.vmware.vmware_local_role_manager:
hostname: '{{ esxi_hostname }}'
username: '{{ esxi_username }}'
password: '{{ esxi_password }}'
local_role_name: vmware_qa
state: absent
delegate_to: localhost
- name: Add a privilege to an existing local role
community.vmware.vmware_local_role_manager:
hostname: '{{ esxi_hostname }}'
username: '{{ esxi_username }}'
password: '{{ esxi_password }}'
local_role_name: vmware_qa
local_privilege_ids: [ 'Folder.Create' ]
action: add
delegate_to: localhost
- name: Remove a privilege to an existing local role
community.vmware.vmware_local_role_manager:
hostname: '{{ esxi_hostname }}'
username: '{{ esxi_username }}'
password: '{{ esxi_password }}'
local_role_name: vmware_qa
local_privilege_ids: [ 'Folder.Create' ]
action: remove
delegate_to: localhost
- name: Set a privilege to an existing local role
community.vmware.vmware_local_role_manager:
hostname: '{{ esxi_hostname }}'
username: '{{ esxi_username }}'
password: '{{ esxi_password }}'
local_role_name: vmware_qa
local_privilege_ids: [ 'Folder.Create' ]
action: set
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| local_role_name строка | всегда | Имя локальной роли |
| new_privileges список / элементы=строка | всегда | Список привилегий |
| old_privileges список / элементы=строка | при обновлении | Список привилегий роли до обновления |
| privileges список / элементы=строка | всегда | Список привилегий |
| privileges_previous список / элементы=строка | при обновлении | Список привилегий роли до обновления |
| role_id целое число | всегда | Идентификатор локальной роли, сгенерированный ESXi |
| role_name строка | всегда | Имя локальной роли |
Авторы
- Abhijeet Kasurde (@Akasurde)
- Christian Kotte (@ckotte)
© 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/vmware_local_role_manager_module.html