openstack.cloud.address_scope 模块 – 从 OpenStack 创建或删除地址范围

注意

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

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

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

要在 playbook 中使用它，请指定：openstack.cloud.address_scope。

概要

• 从 OpenStack 创建或删除地址范围。

要求

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

• 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 的一部分中一样。
extra_specs 字典	传递给 API 的带有额外键/值对的字典 默认值： {}
interface 别名：endpoint_type 字符串	要从服务目录中获取的端点 URL 类型。 选项 "admin" "internal" "public" ← (默认)
ip_version 字符串	子网的 IP 版本 4 或 6。 此选项无法更新。 选项 "4" ← (默认) "6"
is_shared 别名：shared 布尔值	此地址范围是否共享。 选项 false ← (默认) true
name 字符串 / 必需	要赋予地址范围的名称 此选项无法更新。
project 字符串	项目的唯一名称或 ID。 此选项无法更新。
region_name 字符串	区域的名称。
sdk_log_level 字符串	OpenStackSDK 的日志级别 选项 "INFO" ← (默认) "DEBUG"
sdk_log_path 字符串	OpenStackSDK 的日志文件的路径。如果为空，则不写入日志
state 字符串	指示资源的期望状态 选项 "present" ← (默认) "absent"
timeout 整数	Ansible 应等待请求的资源多长时间。 默认值： 180
validate_certs 别名：verify 布尔值	是否应验证 SSL API 请求。 在 Ansible 2.3 之前，默认为 true。 选项 false true
wait 布尔值	Ansible 是否应等待，直到请求的资源完成。 选项 false true ← (默认)

备注

注意

• 可以使用标准的 OpenStack 环境变量，例如 OS_USERNAME，而不是提供显式值。

• 身份验证信息由 openstacksdk 驱动，这意味着值可以来自 /etc/ansible/openstack.yaml、/etc/openstack/clouds.yaml 或 ~/.config/openstack/clouds.yaml 中的 yaml 配置文件，然后来自标准环境变量，最后来自 playbook 中的显式参数。有关更多信息，请访问 https://docs.openstack.org/openstacksdk/

示例

# Create an IPv4 address scope.
- openstack.cloud.address_scope:
    cloud: mycloud
    state: present
    name: my_adress_scope

# Create a shared IPv6 address scope for a given project.
- openstack.cloud.address_scope:
    cloud: mycloud
    state: present
    ip_version: 6
    name: ipv6_address_scope
    project: myproj

# Delete address scope.
- openstack.cloud.address_scope:
    cloud: mycloud
    state: absent
    name: my_adress_scope

返回值

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

键	描述
address_scope 字典	描述地址范围的字典。 返回: 当state为’present’时成功返回
id 字符串	地址范围 ID。 返回: 成功 示例: "474acfe5-be34-494c-b339-50f06aa143e4"
ip_version 字符串	子网的 IP 版本 4 或 6。 返回: 成功 示例: "4"
is_shared 布尔值	指示此地址范围是否在所有租户之间共享。 返回: 成功 示例: false
name 字符串	地址范围名称。 返回: 成功 示例: "my_address_scope"
project_id 字符串	项目 ID 返回: 成功 示例: "474acfe5-be34-494c-b339-50f06aa143e4"
tenant_id 字符串	租户 ID。 返回: 成功 示例: "861174b82b43463c9edc5202aadc60ef"

作者

• OpenStack Ansible SIG

集合链接

• 问题跟踪器
• 存储库 (源代码)