ngine_io.cloudstack.cs_network 模块 – 管理基于 Apache CloudStack 的云上的网络。

注意

此模块是 ngine_io.cloudstack 集合(版本 2.5.0)的一部分。

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

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

要在剧本中使用它,请指定:ngine_io.cloudstack.cs_network

ngine_io.cloudstack 0.1.0 中的新增功能

概要

  • 创建、更新、重启和删除网络。

要求

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

  • python >= 2.6

  • cs >= 0.9.0

参数

参数

注释

帐户

字符串

网络相关的帐户。

acl

字符串

VPC 网络层的访问控制列表的名称。

acl_type

字符串

网络的访问控制类型。

如果未指定,Cloudstack 将默认为隔离网络的 account

和共享网络的 domain

仅在创建时考虑。

选择

  • "account"

  • "domain"

api_http_method

字符串

用于查询 API 端点的 HTTP 方法。

如果未给出,则考虑 CLOUDSTACK_METHOD 环境变量。

选择

  • "get" ← (默认)

  • "post"

api_key

字符串 / 必需

CloudStack API 的 API 密钥。

如果未给出,则考虑 CLOUDSTACK_KEY 环境变量。

api_secret

字符串 / 必需

CloudStack API 的密钥。

如果未设置,则考虑 CLOUDSTACK_SECRET 环境变量。

api_timeout

整数

HTTP 超时(以秒为单位)。

如果未给出,则考虑 CLOUDSTACK_TIMEOUT 环境变量。

默认: 10

api_url

字符串 / 必需

CloudStack API 的 URL,例如 https://cloud.example.com/client/api

如果未给出,则考虑 CLOUDSTACK_ENDPOINT 环境变量。

api_verify_ssl_cert

字符串

验证 CA 授权证书文件。

如果未给出,则考虑 CLOUDSTACK_VERIFY 环境变量。

cidr_ipv6

字符串

IPv6 网络的 CIDR,必须至少为 /64。

仅在创建时考虑。

clean_up

布尔值

清理旧的网络元素。

仅在 state=restarted 时考虑。

选择

  • false ← (默认)

  • true

display_text

字符串

网络的显示文本。

如果未指定,将使用 name 作为 display_text

domain

字符串

网络相关的域。

end_ip

字符串

网络所属的结束 IPv4 地址。

如果未指定,则使用 start_ip 的值。

仅在创建时考虑。

end_ipv6

字符串

网络所属的结束 IPv6 地址。

如果未指定,则使用 start_ipv6 的值。

仅在创建时考虑。

gateway

字符串

网络的网关。

当属于 VPC 时,共享网络和隔离网络需要。

仅在创建时考虑。

gateway_ipv6

字符串

IPv6 网络的网关。

共享网络需要。

仅在创建时考虑。

isolated_pvlan

字符串

此网络的隔离专用 VLAN。

name

字符串 / 必需

网络的名称(区分大小写)。

netmask

字符串

网络的子网掩码。

当属于 VPC 时,共享网络和隔离网络需要。

仅在创建时考虑。

network_domain

字符串

网络域。

network_offering

字符串

网络的产品的名称。

如果 state=present,则为必需。

poll_async

布尔值

轮询异步作业直到作业完成。

选择

  • false

  • true ← (默认)

project

字符串

要在其中部署网络的项目的名称。

start_ip

字符串

网络所属的起始 IPv4 地址。

仅在创建时考虑。

start_ipv6

字符串

网络所属的起始 IPv6 地址。

仅在创建时考虑。

state

字符串

网络的状态。

选择

  • "present" ← (默认)

  • "absent"

  • "restarted"

subdomain_access

布尔值

定义是否允许子域使用专用于其父域的网络。

应与 acl_type=domain 一起使用。

仅在创建时考虑。

选择

  • false

  • true

tags

别名:tag

列表 / 元素=字典

标签列表。标签是具有键 keyvalue 的字典列表。

要删除所有标签,请设置一个空列表,例如 tags: []

validate_certs

布尔值

在 ngine_io.cloudstack 2.4.0 中添加

如果 false,则不会验证 SSL 证书。

如果未给出,则考虑 CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY 环境变量。

这应该只在个人控制的使用自签名证书的站点上使用。

选择

  • false

  • true ← (默认)

vlan

字符串

网络的 ID 或 VID。

vpc

字符串

网络的 VPC 的名称。

zone

字符串 / 必需

应该在其中部署网络的区域的名称。

注意

注意

  • 有关 cloudstack 模块的详细指南,请参阅CloudStack 云指南

  • 此模块支持检查模式。

示例

- name: Create a network
  ngine_io.cloudstack.cs_network:
    name: my network
    zone: gva-01
    network_offering: DefaultIsolatedNetworkOfferingWithSourceNatService
    network_domain: example.com

- name: Create a network with start and end IP
  ngine_io.cloudstack.cs_network:
    name: Private Network
    network_offering: PrivNet
    start_ip: 10.12.9.10
    end_ip: 10.12.9.100
    netmask: 255.255.255.0
    zone: gva-01

- name: Create a VPC tier
  ngine_io.cloudstack.cs_network:
    name: my VPC tier 1
    zone: gva-01
    vpc: my VPC
    network_offering: DefaultIsolatedNetworkOfferingForVpcNetworks
    gateway: 10.43.0.1
    netmask: 255.255.255.0
    acl: my web acl

- name: Update a network
  ngine_io.cloudstack.cs_network:
    name: my network
    zone: zone01
    display_text: network of domain example.local
    network_domain: example.local

- name: Restart a network with clean up
  ngine_io.cloudstack.cs_network:
    name: my network
    zone: zone01
    clean_up: yes
    state: restarted

- name: Remove a network
  ngine_io.cloudstack.cs_network:
    name: my network
    zone: zone01
    state: absent

返回值

常见的返回值在 这里 中进行了文档记录,以下是此模块特有的字段

描述

帐户

字符串

网络相关的帐户。

返回: 成功

示例: "示例 帐户"

acl

字符串

VPC 网络层的访问控制列表的名称。

返回: 成功

示例: "My ACL"

acl_id

字符串

VPC 网络层的访问控制列表 ID。

返回: 成功

示例: "dfafcd55-0510-4b8c-b6c5-b8cedb4cfd88"

acl_type

字符串

网络的访问类型(域、账户)。

返回: 成功

示例: "Account"

broadcast_domain_type

字符串

网络的广播域类型。

返回: 成功

示例: "Vlan"

cidr

字符串

IPv4 网络 CIDR。

返回: 成功

示例: "10.101.64.0/24"

cidr_ipv6

字符串

IPv6 网络 CIDR。

返回: 如果可用

示例: "2001:db8::/64"

display_text

字符串

网络的显示文本。

返回: 成功

示例: "web project"

dns1

字符串

第一个名称服务器的 IP 地址。

返回: 成功

示例: "1.2.3.4"

dns2

字符串

第二个名称服务器的 IP 地址。

返回: 成功

示例: "1.2.3.4"

domain

字符串

网络相关的域。

返回: 成功

示例: "ROOT"

gateway

字符串

IPv4 网关。

返回: 成功

示例: "10.101.64.1"

gateway_ipv6

字符串

IPv6 网关。

返回: 如果可用

示例: "2001:db8::1"

id

字符串

网络的 UUID。

返回: 成功

示例: "04589590-ac63-4ffc-93f5-b698b8ac38b6"

is_persistent

布尔值

网络是否是持久的。

返回: 成功

示例: false

is_system

布尔值

网络是否与系统相关。

返回: 成功

示例: false

name

字符串

网络的名称。

返回: 成功

示例: "web project"

netmask

字符串

IPv4 子网掩码。

返回: 成功

示例: "255.255.255.0"

network_domain

字符串

网络域

返回: 成功

示例: "example.local"

network_offering

字符串

网络产品名称。

返回: 成功

示例: "DefaultIsolatedNetworkOfferingWithSourceNatService"

network_offering_availability

字符串

创建网络所基于的网络产品的可用性

返回: 成功

示例: "Optional"

network_offering_conserve_mode

布尔值

网络产品是否启用了 IP 保留模式。

返回: 成功

示例: false

network_offering_display_text

字符串

网络产品显示文本。

返回: 成功

示例: "Offering for Isolated Vpc networks with Source Nat service enabled"

project

字符串

项目名称。

返回: 成功

示例: "Production"

state

字符串

网络的状态(已分配、已实现、已设置)。

返回: 成功

示例: "Allocated"

tags

列表 / 元素=字符串

与网络关联的资源标签列表。

返回: 成功

示例: ["[ { \"key\": \"foo\"", " \"value\": \"bar\" } ]"]

traffic_type

字符串

网络的流量类型。

返回: 成功

示例: "Guest"

type

字符串

网络的类型。

返回: 成功

示例: "Isolated"

vpc

字符串

VPC 的名称。

返回: 如果可用

示例: "My VPC"

zone

字符串

区域的名称。

返回: 成功

示例: "ch-gva-2"

作者

  • René Moser (@resmo)