Parameter |
Choices/Defaults |
Comments |
account
|
|
Account the firewall rule is related to.
|
api_http_method
|
|
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 |
|
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.
|