os_security_group_rule - Add/Delete rule from an existing security group
New in version 2.0.
Synopsis
- Add or Remove rule from an existing security group
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- shade
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| api_timeout | How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. | |
| auth | Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present. | |
| auth_type | Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. | |
| availability_zone | Ignored. Present for backwards compatibility | |
| cacert | A path to a CA Cert bundle that can be used as part of verifying SSL API requests. | |
| cert | A path to a client certificate to use as part of the SSL transaction. | |
| cloud | Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. | |
| direction |
| The direction in which the security group rule is applied. Not all providers support egress. |
| ethertype |
| Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. Not all providers support IPv6. |
| interface (added in 2.3) |
| Endpoint URL type to fetch from the service catalog. aliases: endpoint_type |
| key | A path to a client key to use as part of the SSL transaction. | |
| port_range_max | Default: None | Ending port |
| port_range_min | Default: None | Starting port |
| protocol |
| IP protocols TCP UDP ICMP 112 (VRRP) |
| region_name | Name of the region. | |
| remote_group | Name or ID of the Security group to link (exclusive with remote_ip_prefix) | |
| remote_ip_prefix | Source IP address(es) in CIDR notation (exclusive with remote_group) | |
| security_group required | Name or ID of the security group | |
| state |
| Should the resource be present or absent. |
| timeout | Default: 180 | How long should ansible wait for the requested resource. |
| verify |
| Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True. aliases: validate_certs |
| wait |
| Should ansible wait until the requested resource is complete. |
Notes
Note
- The standard OpenStack environment variables, such as
OS_USERNAMEmay be used instead of providing explicit values. - Auth information is driven by os-client-config, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at http://docs.openstack.org/developer/os-client-config
Examples
# Create a security group rule
- os_security_group_rule:
cloud: mordred
security_group: foo
protocol: tcp
port_range_min: 80
port_range_max: 80
remote_ip_prefix: 0.0.0.0/0
# Create a security group rule for ping
- os_security_group_rule:
cloud: mordred
security_group: foo
protocol: icmp
remote_ip_prefix: 0.0.0.0/0
# Another way to create the ping rule
- os_security_group_rule:
cloud: mordred
security_group: foo
protocol: icmp
port_range_min: -1
port_range_max: -1
remote_ip_prefix: 0.0.0.0/0
# Create a TCP rule covering all ports
- os_security_group_rule:
cloud: mordred
security_group: foo
protocol: tcp
port_range_min: 1
port_range_max: 65535
remote_ip_prefix: 0.0.0.0/0
# Another way to create the TCP rule above (defaults to all ports)
- os_security_group_rule:
cloud: mordred
security_group: foo
protocol: tcp
remote_ip_prefix: 0.0.0.0/0
# Create a rule for VRRP with numbered protocol 112
- os_security_group_rule:
security_group: loadbalancer_sg
protocol: 112
remote_group: loadbalancer-node_sg
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| direction string | state == present | The direction in which the security group rule is applied. Sample: egress |
| ethertype string | state == present | One of IPv4 or IPv6. Sample: IPv4 |
| id string | state == present | Unique rule UUID. |
| port_range_max int | state == present | The maximum port number in the range that is matched by the security group rule. Sample: 8000 |
| port_range_min int | state == present | The minimum port number in the range that is matched by the security group rule. Sample: 8000 |
| protocol string | state == present | The protocol that is matched by the security group rule. Sample: tcp |
| remote_ip_prefix string | state == present | The remote IP prefix to be associated with this security group rule. Sample: 0.0.0.0/0 |
| security_group_id string | state == present | The security group ID to associate with this security group rule. |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author
- Benno Joy (@bennojoy)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/os_security_group_rule_module.html