openstack.cloud.federation_mapping 模块 – 管理联邦映射

注意

此模块是 openstack.cloud 集合（版本 2.3.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install openstack.cloud。您需要进一步的要求才能使用此模块，有关详细信息，请参阅要求。

要在剧本中使用它，请指定：openstack.cloud.federation_mapping。

概要 

管理联邦映射。

要求 

执行此模块的主机上需要以下要求。

python >= 3.6
openstacksdk >= 1.0.0

参数 

参数	注释
api_timeout 整数	套接字层在 API 调用超时之前应等待多长时间。如果省略此项，则不会将任何内容传递到 requests 库。
auth 字典	包含云的身份验证插件策略所需的身份验证信息的字典。对于默认的password插件，这将包含auth_url、username、password、project_name以及关于域的任何信息（例如，如果云支持，则为user_domain_name或project_domain_name）。对于其他插件，此参数需要包含该身份验证插件所需的任何参数。如果提供了命名的云或存在 OpenStack OS_* 环境变量，则不需要此参数。
auth_type 字符串	要使用的身份验证插件的名称。如果云使用密码身份验证以外的其他身份验证，则应在此处指示插件的名称，并且应相应地更新auth参数的内容。
ca_cert 别名: cacert 字符串	可用作验证 SSL API 请求的一部分的 CA 证书捆绑包的路径。
client_cert 别名: cert 字符串	用作 SSL 事务一部分的客户端证书的路径。
client_key 别名: key 字符串	用作 SSL 事务一部分的客户端密钥的路径。
cloud 任何	要操作的命名云或云配置。如果cloud是字符串，则它引用在 OpenStack clouds.yaml 文件中定义的命名云配置。为auth和auth_type提供默认值。如果提供了auth或存在 OpenStack OS_* 环境变量，则不需要此参数。如果cloud是字典，则它包含完整的云配置，就像 clouds.yaml 的某个部分一样。
interface 别名: endpoint_type 字符串	要从服务目录中获取的端点 URL 类型。选项 `"admin"` `"internal"` `"public"` ← (默认)
name 别名: id 字符串 / 必需	要管理的映射的名称。
region_name 字符串	区域的名称。
rules 列表 / 元素=字典	构成映射的规则。这些是本地和远程定义的对。有关这些工作方式的更多详细信息，请参阅 OpenStack 文档 https://docs.openstack.org/keystone/latest/admin/federation/mapping_combinations.html。如果state是`present`，则为必需。
local 列表 / 元素=字典 / 必需	关于将映射哪些本地属性的信息。
remote 列表 / 元素=字典 / 必需	关于将映射哪些远程属性的信息。
sdk_log_level 字符串	OpenStackSDK 的日志级别选项 `"INFO"` ← (默认) `"DEBUG"`
sdk_log_path 字符串	OpenStackSDK 的日志文件的路径。如果为空，则不写入日志
state 字符串	映射应为`present`还是`absent`。选项 `"present"` ← (默认) `"absent"`
timeout 整数	ansible 应等待所请求资源的时间。默认值: `180`
validate_certs 别名: verify 布尔值	是否应验证 SSL API 请求。在 Ansible 2.3 之前，默认为`true`。选项 `false` `true`
wait 布尔值	ansible 是否应等待直到请求的资源完成。选项 `false` `true` ← (默认)

说明 

注意

名称等于映射的 ID。
可以使用标准的 OpenStack 环境变量，例如 OS_USERNAME，而无需提供显式值。
身份验证信息由 openstacksdk 驱动，这意味着值可以来自 /etc/ansible/openstack.yaml、/etc/openstack/clouds.yaml 或 ~/.config/openstack/clouds.yaml 中的 yaml 配置文件，然后来自标准环境变量，最后来自 plays 中的显式参数。更多信息请访问 https://docs.openstack.org/openstacksdk/

示例 

- name: Create a new mapping
  openstack.cloud.federation_mapping:
    cloud: example_cloud
    name: example_mapping
    rules:
    - local:
      - user:
          name: '{0}'
      - group:
          id: '0cd5e9'
      remote:
      - type: UserName
      - type: orgPersonType
        any_one_of:
        - Contractor
        - SubContractor

- name: Delete a mapping
  openstack.cloud.federation_mapping:
    name: example_mapping
    state: absent

返回值 

常见的返回值已在此处记录这里，以下是此模块独有的字段

键	描述
mapping 字典	描述联邦映射的字典。返回: 总是
id 字符串	映射的 id 返回: 成功示例: `"ansible-test-mapping"`
name 字符串	映射的名称。等于 `id`。返回: 成功示例: `"ansible-test-mapping"`
rules 列表 / 元素=字符串	映射的规则列表返回: 成功

作者

OpenStack Ansible SIG