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 上的对象权限。

参数 

参数	注释
group 字符串	要分配权限的组。如果未指定 `principal`，则需要此参数。
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。如果任务中未指定此值，则将使用环境变量 `VMWARE_HOST` 的值。
object_name 字符串 / 必填	要分配权限的对象名称。
object_type 字符串	目标对象类型。选项 `"Folder"` ← (默认) `"VirtualMachine"` `"Datacenter"` `"ResourcePool"` `"Datastore"` `"Network"` `"HostSystem"` `"ComputeResource"` `"ClusterComputeResource"` `"DistributedVirtualSwitch"` `"DistributedVirtualPortgroup"` `"StoragePod"`
password 别名：pass，pwd 字符串	vSphere vCenter 或 ESXi 服务器的密码。如果任务中未指定此值，则将使用环境变量 `VMWARE_PASSWORD` 的值。
port 整数	vSphere vCenter 或 ESXi 服务器的端口号。如果任务中未指定此值，则将使用环境变量 `VMWARE_PORT` 的值。默认值： `443`
principal 字符串	要分配权限的用户。如果未指定 `group`，则需要此参数。如果指定域用户，则需要使用反斜杠作为域分隔符。
proxy_host 字符串	将接收所有 HTTPS 请求并转发它们的代理的地址。格式为主机名或 IP 地址。如果任务中未指定此值，则将使用环境变量 `VMWARE_PROXY_HOST` 的值。
proxy_port 整数	将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。如果任务中未指定此值，则将使用环境变量 `VMWARE_PROXY_PORT` 的值。
recursive 布尔值	权限是否应递归应用。选项 `false` `true` ← (默认)
role 字符串 / 必填	要分配权限的角色。用户也可以指定在 Web UI 中显示的角色名称。
state 字符串	指示对象权限的所需状态。当为 `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)