bigip_security_port_list - Manage port lists on BIG-IP AFM
New in version 2.5.
Synopsis
- Manages the AFM port lists on a BIG-IP. This module can be used to add and remove port list entries.
Requirements
The below requirements are needed on the host that executes this module.
- f5-sdk >= 3.0.9
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
description | Description of the port list | ||
name required | Specifies the name of the port list. | ||
partition | Default: "Common" | Device partition to manage resources on. | |
password required | The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable F5_PASSWORD is set.aliases: pass, pwd | ||
port_lists | Simple list of existing port lists to add to this list. Port lists can be specified in either their fully qualified name (/Common/foo) or their short name (foo). If a short name is used, the partition argument will automatically be prepended to the short name. | ||
port_ranges | A list of port ranges where the range starts with a port number, is followed by a dash (-) and then a second number. If the first number is greater than the second number, the numbers will be reversed so-as to be properly formatted. ie, 90-78 would become 78-90. | ||
ports | Simple list of port values to add to the list | ||
provider (added in 2.5) | A dict object containing connection details. | ||
password required | The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable F5_PASSWORD is set.aliases: pass, pwd | ||
server required | The BIG-IP host. You can omit this option if the environment variable F5_SERVER is set. | ||
server_port | Default: 443 | The BIG-IP server port. You can omit this option if the environment variable F5_SERVER_PORT is set. | |
user required | The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable F5_USER is set. | ||
validate_certs bool |
| If no , SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable F5_VALIDATE_CERTS is set. | |
timeout | Default: 10 | Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. | |
ssh_keyfile | Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead. | ||
transport required |
| Configures the transport connection to use when connecting to the remote device. | |
server required | The BIG-IP host. You can omit this option if the environment variable F5_SERVER is set. | ||
server_port (added in 2.2) | Default: 443 | The BIG-IP server port. You can omit this option if the environment variable F5_SERVER_PORT is set. | |
state |
| When present , ensures that the address list and entries exists.When absent , ensures the address list is removed. | |
user required | The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable F5_USER is set. | ||
validate_certs bool (added in 2.0) |
| If no , SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable F5_VALIDATE_CERTS is set. |
Notes
Note
- For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
- Requires the f5-sdk Python package on the host. This is as easy as
pip install f5-sdk
.
Examples
- name: Create a simple port list
bigip_security_port_list:
name: foo
ports:
- 80
- 443
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
- name: Override the above list of ports with a new list
bigip_security_port_list:
name: foo
ports:
- 3389
- 8080
- 25
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
- name: Create port list with series of ranges
bigip_security_port_list:
name: foo
port_ranges:
- 25-30
- 80-500
- 50-78
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
- name: Use multiple types of port arguments
bigip_security_port_list:
name: foo
port_ranges:
- 25-30
- 80-500
- 50-78
ports:
- 8080
- 443
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
- name: Remove port list
bigip_security_port_list:
name: foo
password: secret
server: lb.mydomain.com
state: absent
user: admin
delegate_to: localhost
- name: Create port list from a file with one port per line
bigip_security_port_list:
name: lot-of-ports
ports: "{{ lookup('file', 'my-large-port-list.txt').split('\n') }}"
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
description string | changed | The new description of the port list. Sample: My port list |
port_lists list | changed | The new list of port list names applied to the port list. Sample: ['/Common/list1', '/Common/list2'] |
port_ranges list | changed | The new list of port ranges applied to the port list. Sample: ['80-100', '200-8080'] |
ports list | changed | The new list of ports applied to the port list. Sample: [80, 443] |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
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
- Tim Rupp (@caphrim007)
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.6/modules/bigip_security_port_list_module.html