f5networks.f5_modules.bigip_asm_policy_fetch – Exports the ASM policy from remote nodes.
f5networks.f5_modules.bigip_asm_policy_fetch – Exports the ASM policy from remote nodes.
Note
This plugin is part of the f5networks.f5_modules collection (version 1.6.0).
To install it use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_asm_policy_fetch
.
New in version 1.0.0: of f5networks.f5_modules
Synopsis
- Exports the ASM policy from remote nodes.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
base64 boolean |
|
If Only applies to | |
binary boolean |
|
If Only applies to | |
compact boolean |
|
If Only applies to XML type ASM policy exports. | |
dest path |
A directory to save the policy file into. This option is ignored when | ||
file string |
The name of the file to be created on the remote device for downloading. When | ||
force boolean |
|
If | |
inline boolean |
|
If The policy can be be retrieved in the playbook | |
name string / required |
The name of the policy exported to create a file on the remote device for downloading. | ||
partition string |
Default: "Common" |
Device partition which contains the ASM policy to export. | |
provider dictionary added in 1.0.0 of f5networks.f5_modules |
A dict object containing connection details. | ||
auth_provider string |
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. | ||
no_f5_teem boolean |
|
If You may omit this option by setting the environment variable | |
password string / required |
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable
| ||
server string / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port integer |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
timeout integer |
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. | ||
transport string |
|
Configures the transport connection to use when connecting to the remote device. | |
user string / required |
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable | ||
validate_certs boolean |
|
If You may omit this option by setting the environment variable |
Notes
Note
- For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
- Requires BIG-IP software version >= 12.
- The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.
Examples
- name: Export policy in binary format
bigip_asm_policy_fetch:
name: foobar
file: export_foo
dest: /root/download
binary: yes
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Export policy inline base64 encoded format
bigip_asm_policy_fetch:
name: foobar
inline: yes
base64: yes
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Export policy in XML format
bigip_asm_policy_fetch:
name: foobar
file: export_foo
dest: /root/download
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Export compact policy in XML format
bigip_asm_policy_fetch:
name: foobar
file: export_foo.xml
dest: /root/download/
compact: yes
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Export policy in binary format, autogenerate name
bigip_asm_policy_fetch:
name: foobar
dest: /root/download/
binary: yes
provider:
password: secret
server: lb.mydomain.com
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 |
---|---|---|
base64 boolean |
changed |
Set to encode inline export in Base64 format.
|
binary boolean |
changed |
Set to export the ASM policy in binary format.
Sample: True |
compact boolean |
changed |
Set only to export custom ASM policy settings.
|
dest string |
changed |
Local path to download the exported ASM policy.
Sample: /root/downloads/foobar.xml |
file string |
changed |
Name of the policy file on the remote BIG-IP to download. If not specified, then this will be a randomly generated filename.
Sample: foobar.xml |
inline boolean |
changed |
Set when the ASM policy to be exported is inline
Sample: True |
name string |
changed |
Name of the ASM policy to be exported.
Sample: Asm_APP1_Transparent |
Authors
- Wojciech Wypior (@wojtek0806)
- Nitin Khanna (@nitinthewiz)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_asm_policy_fetch_module.html