bigip_asm_policy_fetch – Exports the asm policy from remote nodes
bigip_asm_policy_fetch – Exports the asm policy from remote nodes
New in version 2.8.
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 create on the remote device for downloading. When | ||
force boolean |
|
If | |
inline boolean |
|
If The policy can be be retrieved in 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 ASM policy to export. | |
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
| ||
provider dictionary added in 2.5 |
A dict object containing connection details. | ||
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 | |
ssh_keyfile path |
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable | ||
timeout integer |
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. | |
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 | |
server string / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port integer added in 2.2 |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
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 added in 2.0 |
|
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 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 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 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 ASM policy to be exported inline
Sample: True |
name string |
changed |
Name of the ASM policy to be exported.
Sample: Asm_APP1_Transparent |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors
- Wojciech Wypior (@wojtek0806)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/bigip_asm_policy_fetch_module.html