community.vmware.vmware_object_role_permission 模块 – 管理 ESXi 主机或 vCenter 上的本地角色

注意

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

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

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

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

概要

• 此模块可用于管理给定主机或 vCenter 上的对象权限。

参数

参数	注释
组 字符串	要分配权限的组。 如果未指定 principal，则为必需。
主机名 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。 如果任务中未指定该值，则将使用环境变量 VMWARE_HOST 的值。
object_name 字符串 / 必需	要分配权限的对象名称。
object_type 字符串	要定位的对象类型。 选项 "Folder" ← (默认) "VirtualMachine" "Datacenter" "ResourcePool" "Datastore" "Network" "HostSystem" "ComputeResource" "ClusterComputeResource" "DistributedVirtualSwitch" "DistributedVirtualPortgroup" "StoragePod"
密码 别名: pass, pwd 字符串	vSphere vCenter 或 ESXi 服务器的密码。 如果任务中未指定该值，则将使用环境变量 VMWARE_PASSWORD 的值。
端口 整数	vSphere vCenter 或 ESXi 服务器的端口号。 如果任务中未指定该值，则将使用环境变量 VMWARE_PORT 的值。 默认: 443
主体 字符串	要分配权限的用户。 如果未指定 group，则为必需。 如果指定域用户，则域的分隔符需要使用反斜杠。
proxy_host 字符串	将接收所有 HTTPS 请求并转发它们的代理的地址。 格式是主机名或 IP。 如果任务中未指定该值，则将使用环境变量 VMWARE_PROXY_HOST 的值。
proxy_port 整数	将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。 如果任务中未指定该值，则将使用环境变量 VMWARE_PROXY_PORT 的值。
递归 布尔值	是否应递归应用权限。 选项 false true ← (默认)
角色 字符串 / 必需	要分配的权限的角色。 用户还可以指定 Web UI 中显示的角色名称。
状态 字符串	指示对象权限的所需状态。 当 present 时，如果权限尚不存在，则会添加该权限。 当 absent 时，如果权限存在，则会删除该权限。 选项 "present" ← (默认) "absent"
username 别名: admin, user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。 如果在任务中未指定该值，则将使用环境变量 VMWARE_USER 的值。
validate_certs 布尔值	当 SSL 证书无效时允许连接。当证书不被信任时，设置为 false。 如果在任务中未指定该值，则将使用环境变量 VMWARE_VALIDATE_CERTS 的值。 选项 false true ← (默认)

注意

注意

• 登录用户必须具有管理权限的适当权限。

• 分布式交换机的权限必须在数据中心或包含该交换机的文件夹上定义和管理。

• 所有模块都需要 API 写入访问权限，因此在免费的 ESXi 许可证上不受支持。

• 所有变量和 VMware 对象名称都区分大小写。

示例

- name: Assign user to VM folder
  community.vmware.vmware_object_role_permission:
    hostname: '{{ esxi_hostname }}'
    username: '{{ esxi_username }}'
    password: '{{ esxi_password }}'
    role: Admin
    principal: user_bob
    object_name: services
    state: present
  delegate_to: localhost

- name: Remove user from VM folder
  community.vmware.vmware_object_role_permission:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    role: Admin
    principal: user_bob
    object_name: services
    state: absent
  delegate_to: localhost

- name: Assign finance group to VM folder
  community.vmware.vmware_object_role_permission:
    hostname: '{{ esxi_hostname }}'
    username: '{{ esxi_username }}'
    password: '{{ esxi_password }}'
    role: Limited Users
    group: finance
    object_name: Accounts
    state: present
  delegate_to: localhost

- name: Assign view_user Read Only permission at root folder
  community.vmware.vmware_object_role_permission:
    hostname: '{{ esxi_hostname }}'
    username: '{{ esxi_username }}'
    password: '{{ esxi_password }}'
    role: ReadOnly
    principal: view_user
    object_name: rootFolder
    state: present
  delegate_to: localhost

- name: Assign domain user to VM folder
  community.vmware.vmware_object_role_permission:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    role: Admin
    principal: "vsphere.local\\domainuser"
    object_name: services
    state: present
  delegate_to: localhost

返回值

通用返回值记录在此处，以下是此模块特有的字段

键	描述
changed 布尔值	是否对对象的角色进行了更改 返回: 总是

作者

• Derek Rushing (@kryptsi)

• Joseph Andreatta (@vmwjoseph)

集合链接

• 问题跟踪器
• 主页
• 存储库（源代码）