cs_firewall - Manages firewall rules on Apache CloudStack based clouds.

New in version 2.0.

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • cs >= 0.6.10

Parameters

Parameter Choices/Defaults Comments
account
Account the firewall rule is related to.
api_http_method
    Choices:
  • get
  • post
HTTP method used to query the API endpoint.
If not given, the CLOUDSTACK_METHOD env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
Fallback value is get if not specified.
api_key
API key of the CloudStack API.
If not given, the CLOUDSTACK_KEY env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
api_region Default:
cloudstack
Name of the ini section in the cloustack.ini file.
If not given, the CLOUDSTACK_REGION env variable is considered.
api_secret
Secret key of the CloudStack API.
If not set, the CLOUDSTACK_SECRET env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
api_timeout
HTTP timeout in seconds.
If not given, the CLOUDSTACK_TIMEOUT env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
Fallback value is 10 seconds if not specified.
api_url
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
If not given, the CLOUDSTACK_ENDPOINT env variable is considered.
As the last option, the value is taken from the ini config file, also see the notes.
cidrs Default:
0.0.0.0/0
List of CIDRs (full notation) to be used for firewall rule.
Since version 2.5, it is a list of CIDR.

aliases: cidr
domain
Domain the firewall rule is related to.
end_port
End port for this rule. Considered if protocol=tcp or protocol=udp.
If not specified, equal start_port.
icmp_code
Error code for this icmp message.
Considered if protocol=icmp.
icmp_type
Type of the icmp message being sent.
Considered if protocol=icmp.
ip_address
Public IP address the ingress rule is assigned to.
Required if type=ingress.
network
Network the egress rule is related to.
Required if type=egress.
poll_async
bool
    Choices:
  • no
  • yes ←
Poll async jobs until job has finished.
project
Name of the project the firewall rule is related to.
protocol
    Choices:
  • tcp ←
  • udp
  • icmp
  • all
Protocol of the firewall rule.
all is only available if type=egress.
start_port
Start port for this rule.
Considered if protocol=tcp or protocol=udp.

aliases: port
state
    Choices:
  • present ←
  • absent
State of the firewall rule.
tags
(added in 2.4)
List of tags. Tags are a list of dictionaries having keys key and value.
To delete all tags, set a empty list e.g. tags: [].

aliases: tag
type
    Choices:
  • ingress ←
  • egress
Type of the firewall rule.
zone
Name of the zone in which the virtual machine is in.
If not set, default zone is used.

Notes

Note

  • Ansible uses the cs library’s configuration method if credentials are not provided by the arguments api_url, api_key, api_secret. Configuration is read from several locations, in the following order. The CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET and CLOUDSTACK_METHOD. CLOUDSTACK_TIMEOUT environment variables. A CLOUDSTACK_CONFIG environment variable pointing to an .ini file. A cloudstack.ini file in the current working directory. A .cloudstack.ini file in the users home directory. Optionally multiple credentials and endpoints can be specified using ini sections in cloudstack.ini. Use the argument api_region to select the section name, default section is cloudstack. See https://github.com/exoscale/cs for more information.
  • A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
  • This module supports check mode.

Examples

- name: Allow inbound port 80/tcp from 1.2.3.4 to 4.3.2.1
  local_action:
    module: cs_firewall
    ip_address: 4.3.2.1
    port: 80
    cidr: 1.2.3.4/32

- name: Allow inbound tcp/udp port 53 to 4.3.2.1
  local_action:
    module: cs_firewall
    ip_address: 4.3.2.1
    port: 53
    protocol: '{{ item }}'
  with_items:
  - tcp
  - udp

- name: Ensure firewall rule is removed
  local_action:
    module: cs_firewall
    ip_address: 4.3.2.1
    start_port: 8000
    end_port: 8888
    cidr: 17.0.0.0/8
    state: absent

- name: Allow all outbound traffic
  local_action:
    module: cs_firewall
    network: my_network
    type: egress
    protocol: all

- name: Allow only HTTP outbound traffic for an IP
  local_action:
    module: cs_firewall
    network: my_network
    type: egress
    port: 80
    cidr: 10.101.1.20

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
cidr
string
 success
CIDR string of the rule.

Sample:
0.0.0.0/0
cidrs
list

(added in 2.5)
 success
CIDR list of the rule.

Sample:
['0.0.0.0/0']
end_port
int
 success
End port of the rule.

Sample:
80
icmp_code
int
 success
ICMP code of the rule.

Sample:
1
icmp_type
int
 success
ICMP type of the rule.

Sample:
1
id
string
 success
UUID of the rule.

Sample:
04589590-ac63-4ffc-93f5-b698b8ac38b6
ip_address
string
 success
IP address of the rule if type=ingress

Sample:
10.100.212.10
network
string
 success
Name of the network if type=egress

Sample:
my_network
protocol
string
 success
Protocol of the rule.

Sample:
tcp
start_port
int
 success
Start port of the rule.

Sample:
80
type
string
 success
Type of the rule.

Sample:
ingress


Status

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • René Moser (@resmo)

Hint

If you notice any issues in this documentation you can edit this document to improve it.