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.19.0).

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 version 1.0.0: of f5networks.f5_modules

Synopsis

  • Exports the ASM policy from remote nodes.

Parameters

Parameter

Comments

base64

boolean

If yes, the returned inline ASM policy content is Base64 encoded.

Only applies to inline ASM policy exports.

Choices:

  • no

  • yes

binary

boolean

If yes, the exported ASM policy is in binary format.

Only applies to file ASM policy exports.

Choices:

  • no

  • yes

compact

boolean

If yes, only the ASM policy custom settings is exported.

Only applies to XML type ASM policy exports.

Choices:

  • no

  • yes

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 created on the remote device for downloading.

When binary is set to no the ASM policy is in XML format.

force

boolean

If no, the file will only be transferred if it does not exist in the the destination.

Choices:

  • no

  • yes ← (default)

inline

boolean

If yes, the ASM policy is exported inline as a string instead of a file.

The policy can be be retrieved in the playbook result dictionary under the inline_policy key.

Choices:

  • no

  • yes

name

string / required

The name of the policy exported to create a file on the remote device for downloading.

partition

string

Device partition which contains the ASM policy to export.

Default: “Common”

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 yes, TEEM telemetry data is not sent to F5.

You may omit this option by setting the environment variable F5_TELEMETRY_OFF.

Previously used variable F5_TEEM is deprecated as its name was confusing.

Choices:

  • no ← (default)

  • yes

password

aliases: pass, pwd

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.

server

string / required

The BIG-IP host.

You may omit this option by setting the environment variable F5_SERVER.

server_port

integer

The BIG-IP server port.

You may omit this option by setting the environment variable F5_SERVER_PORT.

Default: 443

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.

Choices:

  • rest ← (default)

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

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.

Choices:

  • no

  • yes ← (default)

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

Description

base64

boolean

Set to encode inline export in Base64 format.

Returned: changed

Sample: false

binary

boolean

Set to export the ASM policy in binary format.

Returned: changed

Sample: true

compact

boolean

Set only to export custom ASM policy settings.

Returned: changed

Sample: false

dest

string

Local path to download the exported ASM policy.

Returned: changed

Sample: “/root/downloads/foobar.xml”

file

string

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: “foobar.xml”

inline

boolean

Set when the ASM policy to be exported is inline

Returned: changed

Sample: true

name

string

Name of the ASM policy to be exported.

Returned: changed

Sample: “Asm_APP1_Transparent”

Authors

  • Wojciech Wypior (@wojtek0806)

  • Nitin Khanna (@nitinthewiz)