f5networks.f5_modules.bigip_asm_policy_fetch module – Exports the ASM policy from remote nodes.
Note
This module is part of the f5networks.f5_modules collection (version 1.32.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
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 f5networks.f5_modules 1.0.0
Synopsis
Exports the ASM policy from remote nodes.
Parameters
Parameter |
Comments |
---|---|
If Only applies to Choices:
|
|
If Only applies to Choices:
|
|
If Only applies to XML type ASM policy exports. Choices:
|
|
A directory to save the policy file into. This option is ignored when |
|
The name of the file to be created on the remote device for downloading. When |
|
If Choices:
|
|
If The policy can be be retrieved in the playbook Choices:
|
|
The name of the policy exported to create a file on the remote device for downloading. |
|
Device partition which contains the ASM policy to export. Default: |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
The password for the user account used to connect to the BIG-IP or the BIG-IQ. You may omit this option by setting the environment variable |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative privileges on the device. You may omit this option by setting the environment variable |
|
If You may omit this option by setting the environment variable Choices:
|
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: true
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: true
base64: true
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: true
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: true
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 |
Description |
---|---|
Set to encode inline export in Base64 format. Returned: changed Sample: |
|
Set to export the ASM policy in binary format. Returned: changed Sample: |
|
Set only to export custom ASM policy settings. Returned: changed Sample: |
|
Local path to download the exported ASM policy. Returned: changed Sample: |
|
Name of the policy file on the remote BIG-IP to download. If not specified, then this is a randomly generated filename. Returned: changed Sample: |
|
Set when the ASM policy to be exported is inline Returned: changed Sample: |
|
Name of the ASM policy to be exported. Returned: changed Sample: |