community.vmware.vmware_local_role_manager 模块 – 在 ESXi 主机或 vCenter 上管理本地角色

注意

此模块是 community.vmware 集合 (版本 5.2.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.vmware。

要在 playbook 中使用它，请指定： community.vmware.vmware_local_role_manager。

概要 

此模块可用于在 ESXi 主机或 vCenter 上管理本地角色。

参数 

参数	注释
action 字符串	此参数仅在使用权限更新现有角色时有效。 `add` 将权限添加到现有权限列表。 `remove` 将从现有权限列表中删除权限。 `set` 将用用户定义的权限列表替换现有权限。选项 `"add"` `"remove"` `"set"` ← (默认)
force_remove 布尔值	如果设置为 `false`，则如果任何权限正在使用该角色，则会阻止删除该角色。选项 `false` ← (默认) `true`
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。如果任务中未指定该值，则将改用环境变量 `VMWARE_HOST` 的值。
local_privilege_ids 列表 / 元素=字符串	角色需要拥有的权限列表。请参阅 https://docs.vmware.com/en/VMware-vSphere/6.0/com.vmware.vsphere.security.doc/GUID-ED56F3C4-77D0-49E3-88B6-B99B8B437B62.html 默认值： `[]`
local_role_name 字符串 / 必需	要管理的本地角色名称。
password 别名：pass，pwd 字符串	vSphere vCenter 或 ESXi 服务器的密码。如果任务中未指定该值，则将改用环境变量 `VMWARE_PASSWORD` 的值。
port 整数	vSphere vCenter 或 ESXi 服务器的端口号。如果任务中未指定该值，则将改用环境变量 `VMWARE_PORT` 的值。默认值： `443`
proxy_host 字符串	将接收所有 HTTPS 请求并转发它们的代理的地址。格式为主机名或 IP。如果任务中未指定该值，则将改用环境变量 `VMWARE_PROXY_HOST` 的值。
proxy_port 整数	将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。如果任务中未指定该值，则将改用环境变量 `VMWARE_PROXY_PORT` 的值。
state 字符串	指示所需的角色状态。如果 `present` 时角色已存在，则会更新角色信息。选项 `"present"` ← (默认) `"absent"`
用户名别名: admin, user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。如果任务中未指定此值，则将使用环境变量 `VMWARE_USER` 的值。
validate_certs 布尔值	允许在 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 整数	生成的本地角色 ID 返回：始终
role_name 字符串	本地角色的名称返回：始终

作者

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