Модуль community.vmware.vmware_local_role_manager – Управление локальными ролями на хосте ESXi или vCenter

Примечание

Этот модуль является частью коллекции community.vmware (версия 4.7.1).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.vmware.

Для использования в playbook, укажите: community.vmware.vmware_local_role_manager.

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль можно использовать для управления локальными ролями на хосте ESXi или vCenter.

Параметры

Параметр	Комментарии
action string	Этот параметр действителен только при обновлении существующей роли с правами. `add` добавит права в существующий список прав. `remove` удалит права из существующего списка прав. `set` заменит существующие права на пользовательский список прав. Варианты: `"add"` `"remove"` `"set"` ← (по умолчанию)
force_remove boolean	Если установлено в `false`, предотвращает удаление роли, если какие-либо разрешения её используют. Варианты: `false` ← (по умолчанию) `true`
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_HOST`.
local_privilege_ids list / elements=string	Список прав, которыми должна обладать роль. См. https://docs.vmware.com/en/VMware-vSphere/6.0/com.vmware.vsphere.security.doc/GUID-ED56F3C4-77D0-49E3-88B6-B99B8B437B62.html По умолчанию: `[]`
local_role_name string / required	Имя локальной роли, которой нужно управлять.
password псевдонимы: pass, pwd string	Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PORT`. По умолчанию: `443`
proxy_host string	Адрес прокси-сервера, который будет получать все HTTPS-запросы и пересылать их. Формат – имя хоста или IP-адрес. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PROXY_HOST`.
proxy_port integer	Порт HTTP-прокси, который будет получать все HTTPS-запросы и пересылать их. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PROXY_PORT`.
state string	Указывает желаемое состояние роли. Если роль уже существует при `present`, информация о роли обновляется. Варианты: `"present"` ← (по умолчанию) `"absent"`
username псевдонимы: admin, user string	Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_USER`.
validate_certs boolean	Разрешает подключение, когда SSL-сертификаты недействительны. Установите в `false`, если сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Убедитесь, что пользователь, используемый для входа, имеет соответствующие права на создание/удаление/редактирование ролей
Все модули требуют доступа для записи API и, следовательно, не поддерживаются на бесплатной лицензии ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.

Примеры

- 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 vCenter
  community.vmware.vmware_local_role_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_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: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_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: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_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 целое число	Сгенерированный идентификатор локальной роли Возвращается: всегда
role_name строка	Имя локальной роли Возвращается: всегда

Авторы

Abhijeet Kasurde (@Akasurde)
Christian Kotte (@ckotte)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_local_role_manager_module.html