bigip_asm_policy_fetch – Exports the asm policy from remote nodes — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# bigip_asm_policy_fetch – Exports the asm policy from remote nodes

New in version 2.8.

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Exports the asm policy from remote nodes.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
base64 boolean | Choices: no yes | If `yes`, the returned `inline` ASM policy content will be Base64 encoded. Only applies to `inline` ASM policy exports.
binary boolean | Choices: no yes | If `yes`, the exported ASM policy will be in binary format. Only applies to `file` ASM policy exports.
compact boolean | Choices: no yes | If `yes`, only the ASM policy custom settings will be exported. Only applies to XML type ASM policy exports.
dest path |  | A directory to save the policy file into. This option is ignored when `inline` is set to c(yes).
file string |  | The name of the file to be create on the remote device for downloading. When `binary` is set to `no` the ASM policy will be in XML format.
force boolean | Choices: no yes ← | If `no`, the file will only be transferred if it does not exist in the the destination.
inline boolean | Choices: no yes | If `yes`, the ASM policy will be exported `inline` as a string instead of a file. The policy can be be retrieved in playbook `result` dictionary under `inline_policy` key.
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 `F5_PASSWORD`. aliases: pass, pwd
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 `F5_PASSWORD`. aliases: pass, pwd
| server string / required |  | The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`.
| server_port integer | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`.
| 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 `ANSIBLE_NET_SSH_KEYFILE`.
| 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 | Choices: cli rest ← | 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 `F5_USER`.
| validate_certs boolean | Choices: no yes ← | If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`.
server string / required |  | The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`.
server_port integer added in 2.2 | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`.
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 `F5_USER`.
validate_certs boolean added in 2.0 | Choices: no yes ← | If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`.

## 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)

Hint

If you notice any issues in this documentation you can edit this document to improve it.