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

注意

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

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

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

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

概要 

从 OpenStack 添加、更新或删除网络。

要求 

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

python >= 3.6
openstacksdk >= 1.0.0

参数 

参数	注释
admin_state_up 布尔值	是否应将状态标记为启用或禁用。选择 `false` `true`
api_timeout 整数	套接字层在 API 调用超时之前应等待多长时间。如果省略此项，则不会将任何内容传递给请求库。
auth 字典	包含云的身份验证插件策略所需的身份验证信息的字典。对于默认的密码插件，这将包含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 的某个部分中一样。
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`
等待布尔值	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 default 返回：成功
is_port_security_enabled 字符串	端口安全是否启用返回：成功
is_router_external 字符串	是否为外部路由器返回：成功
is_shared 字符串	是否共享返回：成功
is_vlan_transparent 字符串	Is vlan transparent 返回：成功
mtu 字符串	MTU 返回：成功
name 字符串	Name 返回：成功
project_id 字符串	项目 ID 返回：成功
provider_network_type 字符串	Provider network type 返回：成功
provider_physical_network 字符串	Provider physical network 返回：成功
provider_segmentation_id 字符串	Provider segmentation id 返回：成功
qos_policy_id 字符串	QoS 策略 ID 返回：成功
revision_number 字符串	修订号返回：成功
segments 字符串	分段返回：成功
status 字符串	状态返回：成功
subnet_ids 字符串	子网 ID 返回：成功
tags 字符串	标签返回：成功
updated_at 字符串	更新时间戳返回：成功

作者

OpenStack Ansible SIG