openstack.cloud.network 模块 – 从 OpenStack 创建/删除网络

注意

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

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

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

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

概要

• 在 OpenStack 中添加、更新或删除网络。

要求

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

• python >= 3.6

• openstacksdk >= 1.0.0

参数

参数	注释
admin_state_up 布尔值	状态应标记为启动还是停止。 选项 false true
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 字符串	CA 证书包的路径，可用作验证 SSL API 请求的一部分。
client_cert 别名：cert 字符串	客户端证书的路径，用作 SSL 事务的一部分。
client_key 别名：key 字符串	客户端密钥的路径，用作 SSL 事务的一部分。
cloud 任意	要操作的命名云或云配置。如果 *cloud* 是字符串，则它引用在 OpenStack clouds.yaml 文件中定义的命名云配置。为 *auth* 和 *auth_type* 提供默认值。如果提供了 *auth* 或存在 OpenStack OS_* 环境变量，则不需要此参数。如果 *cloud* 是字典，则它包含完整的云配置，就像 clouds.yaml 的一部分一样。
dns_domain 字符串	要设置的 DNS 域名值。如果没有提供此选项，网络将使用 Openstack 默认值。
external 布尔值	此网络是否可外部访问。 选项 false true
interface 别名：endpoint_type 字符串	从服务目录中获取的端点 URL 类型。 选项 "admin" "internal" "public" ← (默认)
is_default 布尔值	此网络是否为默认网络。这仅对外部网络有效。 选项 false true
is_vlan_transparent 布尔值	此网络是否为 vlan_transparent。 选项 false true
mtu 别名：mtu_size 整数	用于解决碎片的最大传输单元 (MTU) 值。如果没有提供此选项，网络将使用 OpenStack 默认值。
name 字符串 / 必需	要分配给网络的名称。
port_security_enabled 布尔值	网络上是否启用了端口安全。如果不使用此选项，网络将使用 OpenStack 默认值。 选项 false true
project 字符串	包含网络的项目名称或 ID（仅限管理员）
provider_network_type 字符串	映射到此网络资源的物理网络类型。
provider_physical_network 字符串	实现此网络对象的物理网络。
provider_segmentation_id 整数	物理网络上的隔离段。*network_type* 属性定义了分段模型。例如，如果 *network_type* 值为 vlan，则此 ID 为 vlan 标识符。如果 *network_type* 值为 gre，则此 ID 为 gre 密钥。
region_name 字符串	区域名称。
sdk_log_level 字符串	OpenStackSDK 的日志级别 选项 "INFO" ← (默认) "DEBUG"
sdk_log_path 字符串	OpenStackSDK 日志文件的路径。如果为空，则不写入日志
shared 布尔值	此网络是否共享。 选项 false true
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 配置文件，然后来自标准环境变量，最后来自剧本中的显式参数。更多信息可以在 https://docs.openstack.org/openstacksdk/ 找到。

示例

# Create an externally accessible network named 'ext_network'.
- openstack.cloud.network:
    cloud: mycloud
    state: present
    name: ext_network
    external: true

返回值

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

键	描述
id 字符串	网络ID 返回值： 网络存在时成功。
network 字典	描述网络的字典。 返回值： 网络存在时成功。
availability_zone_hints 字符串	可用区提示 返回值： 成功
availability_zones 字符串	可用区 返回值： 成功
created_at 字符串	创建时间戳 返回值： 成功
description 字符串	描述 返回值： 成功
dns_domain 字符串	DNS域名 返回值： 成功
id 字符串	ID 返回值： 成功
ipv4_address_scope_id 字符串	IPv4地址范围ID 返回值： 成功
ipv6_address_scope_id 字符串	IPv6地址范围ID 返回值： 成功
is_admin_state_up 字符串	管理员状态是否启动 返回值： 成功
is_default 字符串	是否默认 返回值： 成功
is_port_security_enabled 字符串	端口安全是否启用 返回值： 成功
is_router_external 字符串	是否为外部路由器 返回值： 成功
is_shared 字符串	是否共享 返回值： 成功
is_vlan_transparent 字符串	是否为VLAN透明 返回值： 成功
mtu 字符串	MTU 返回值： 成功
name 字符串	名称 返回值： 成功
project_id 字符串	项目ID 返回值： 成功
provider_network_type 字符串	提供商网络类型 返回值： 成功
provider_physical_network 字符串	提供商物理网络 返回值： 成功
provider_segmentation_id 字符串	提供商分段ID 返回值： 成功
qos_policy_id 字符串	QoS策略ID 返回值： 成功
revision_number 字符串	修订号 返回值： 成功
segments 字符串	分段 返回值： 成功
status 字符串	状态 返回值： 成功
subnet_ids 字符串	子网ID 返回值： 成功
tags 字符串	标签 返回值： 成功
updated_at 字符串	更新时间戳 返回值： 成功

作者

• OpenStack Ansible SIG

集合链接

• 问题追踪器
• 仓库（源代码）