ngine_io.cloudstack.cs_firewall 模块 – 管理基于 Apache CloudStack 云的防火墙规则。

注意

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

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

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

要在 playbook 中使用它，请指定：ngine_io.cloudstack.cs_firewall。

ngine_io.cloudstack 0.1.0 中的新功能

概要

• 创建和删除防火墙规则。

要求

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

• python >= 2.6

• cs >= 0.9.0

参数

参数	注释
帐户 字符串	防火墙规则所关联的帐户。
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 环境变量。
cidrs 别名：cidr 列表 / 元素=字符串	用于防火墙规则的 CIDR 列表（完整表示法）。 自 2.5 版起，它是一个 CIDR 列表。 默认值： ["0.0.0.0/0"]
域 字符串	防火墙规则所关联的域。
end_port 整数	此规则的结束端口。如果协议=tcp 或 协议=udp，则考虑。 如果未指定，则等于 start_port。
icmp_code 整数	此 icmp 消息的错误代码。 如果 协议=icmp，则考虑。
icmp_type 整数	发送的 icmp 消息的类型。 如果 协议=icmp，则考虑。
ip_address 字符串	入站规则所分配到的公共 IP 地址。 如果 type=ingress，则为必需。
网络 字符串	出站规则所关联的网络。 如果 type=egress，则为必需。
poll_async 布尔值	轮询异步作业直到作业完成。 选择 false true ←（默认）
项目 字符串	防火墙规则所关联的项目的名称。
协议 字符串	防火墙规则的协议。 仅当 type=egress 时，all 才可用。 选择 "tcp" ←（默认） "udp" "icmp" "all"
start_port 别名：port 整数	此规则的起始端口。 如果 协议=tcp 或 协议=udp，则考虑。
状态 字符串	防火墙规则的状态。 选择 "present" ←（默认） "absent"
tags 别名：tag 列表 / 元素=字典	标记列表。标记是具有键 key 和 value 的字典列表。 要删除所有标记，请设置一个空列表，例如 tags: []。
类型 字符串	防火墙规则的类型。 选择 "ingress" ←（默认） "egress"
validate_certs 布尔值 在 ngine_io.cloudstack 2.4.0 中添加	如果 false，则不会验证 SSL 证书。 如果未给定，则考虑 CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY 环境变量。 这应该仅在个人控制的站点上使用自签名证书。 选择 false true ←（默认）
区域 字符串 / 必需	虚拟机所在的区域的名称。

注释

注意

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

• 此模块支持检查模式。

示例

- name: Allow inbound port 80/tcp from 1.2.3.4 to 4.3.2.1
  ngine_io.cloudstack.cs_firewall:
    ip_address: 4.3.2.1
    zone: zone01
    port: 80
    cidr: 1.2.3.4/32

- name: Allow inbound tcp/udp port 53 to 4.3.2.1
  ngine_io.cloudstack.cs_firewall:
    ip_address: 4.3.2.1
    zone: zone01
    port: 53
    protocol: '{{ item }}'
  with_items:
  - tcp
  - udp

- name: Ensure firewall rule is removed
  ngine_io.cloudstack.cs_firewall:
    ip_address: 4.3.2.1
    zone: zone01
    start_port: 8000
    end_port: 8888
    cidr: 17.0.0.0/8
    state: absent

- name: Allow all outbound traffic
  ngine_io.cloudstack.cs_firewall:
    network: my_network
    zone: zone01
    type: egress
    protocol: all

- name: Allow only HTTP outbound traffic for an IP
  ngine_io.cloudstack.cs_firewall:
    network: my_network
    zone: zone01
    type: egress
    port: 80
    cidr: 10.101.1.20

返回值

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

键	描述
cidr 字符串	规则的 CIDR 字符串。 返回：成功 示例： "0.0.0.0/0"
cidrs 列表 / 元素=字符串	规则的 CIDR 列表。 返回：成功 示例： ["0.0.0.0/0"]
end_port 整数	规则的结束端口。 返回：成功 示例: 80
icmp_code 整数	规则的 ICMP 代码。 返回：成功 示例: 1
icmp_type 整数	规则的 ICMP 类型。 返回：成功 示例: 1
id 字符串	规则的 UUID。 返回：成功 示例: "04589590-ac63-4ffc-93f5-b698b8ac38b6"
ip_address 字符串	如果 type=ingress，则为规则的 IP 地址。 返回：成功 示例: "10.100.212.10"
网络 字符串	如果 type=egress，则为网络的名称。 返回：成功 示例: "my_network"
协议 字符串	规则的协议。 返回：成功 示例: "tcp"
start_port 整数	规则的起始端口。 返回：成功 示例: 80
类型 字符串	规则的类型。 返回：成功 示例: "ingress"

作者

• René Moser (@resmo)

集合链接

• 问题跟踪器
• 存储库（源代码）