ngine_io.cloudstack.cs_securitygroup_rule 模块 – 管理基于 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_securitygroup_rule

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 环境变量。

cidr

字符串

用于安全组规则的 CIDR(完整表示法)。

默认值: "0.0.0.0/0"

end_port

整数

此规则的结束端口。如果 protocol=tcpprotocol=udp,则为必需,但如果未设置,则将使用 start_port

icmp_code

整数

此 icmp 消息的错误代码。如果 protocol=icmp,则为必需。

icmp_type

整数

正在发送的 icmp 消息的类型。如果 protocol=icmp,则为必需。

poll_async

布尔值

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

选项

  • false

  • true ←(默认)

project

字符串

要在其中创建安全组的项目的名称。

protocol

字符串

安全组规则的协议。

选项

  • "tcp" ←(默认)

  • "udp"

  • "icmp"

  • "ah"

  • "esp"

  • "gre"

security_group

字符串 / 必需

规则所关联的安全组的名称。安全组必须已存在。

start_port

别名:port

整数

此规则的起始端口。如果 protocol=tcpprotocol=udp,则为必需。

state

字符串

安全组规则的状态。

选项

  • "present" ←(默认)

  • "absent"

type

字符串

入口或出口安全组规则。

选项

  • "ingress" ←(默认)

  • "egress"

user_security_group

字符串

此规则所基于的安全组。

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 added to security group 'default'
  ngine_io.cloudstack.cs_securitygroup_rule:
    security_group: default
    port: 80
    cidr: 1.2.3.4/32

- name: allow tcp/udp outbound added to security group 'default'
  ngine_io.cloudstack.cs_securitygroup_rule:
    security_group: default
    type: egress
    start_port: 1
    end_port: 65535
    protocol: '{{ item }}'
  with_items:
  - tcp
  - udp

- name: allow inbound icmp from 0.0.0.0/0 added to security group 'default'
  ngine_io.cloudstack.cs_securitygroup_rule:
    security_group: default
    protocol: icmp
    icmp_code: -1
    icmp_type: -1

- name: remove rule inbound port 80/tcp from 0.0.0.0/0 from security group 'default'
  ngine_io.cloudstack.cs_securitygroup_rule:
    security_group: default
    port: 80
    state: absent

- name: allow inbound port 80/tcp from security group web added to security group 'default'
  ngine_io.cloudstack.cs_securitygroup_rule:
    security_group: default
    port: 80
    user_security_group: web

返回值

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

描述

cidr

字符串

规则的 CIDR。

已返回:成功且定义了 cidr

示例: "0.0.0.0/0"

end_port

整数

规则的结束端口。

已返回:成功

示例: 80

id

字符串

规则的 UUID。

已返回:成功

示例: "a6f7a5fc-43f8-11e5-a151-feff819cdc9f"

protocol

字符串

规则的协议。

已返回:成功

示例: "tcp"

security_group

字符串

规则的安全组。

已返回:成功

示例: "default"

起始端口

整数

规则的起始端口。

已返回:成功

示例: 80

type

字符串

规则的类型。

已返回:成功

示例: "ingress"

user_security_group

字符串

规则的用户安全组。

返回: 成功,并且定义了 user_security_group

示例: "default"

作者

  • René Moser (@resmo)