bigip_asm_policy_fetch – Exports the ASM policy from remote nodes.

New in version 1.0.0.

Synopsis

  • Exports the ASM policy from remote nodes.

Parameters

Parameter Choices/Defaults Configuration Comments
base64
boolean
    Choices:
  • no
  • yes
If true, the returned inline ASM policy content is Base64 encoded.
Only applies to inline ASM policy exports.
binary
boolean
    Choices:
  • no
  • yes
If true, the exported ASM policy is in binary format.
Only applies to file ASM policy exports.
compact
boolean
    Choices:
  • no
  • yes
If true, only the ASM policy custom settings is 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 true.
file
string
The name of the file to be created on the remote device for downloading.
When binary is set to false the ASM policy is in XML format.
force
boolean
    Choices:
  • no
  • yes ←
If false, the file will only be transferred if it does not exist in the the destination.
inline
boolean
    Choices:
  • no
  • yes
If true, 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.
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
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
    Choices:
  • no ←
  • yes
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.
password
string / required
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 F5_PASSWORD.

aliases: pass, pwd
server
string / required
The BIG-IP host or the BIG-IQ 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.
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
    Choices:
  • rest ←
Configures the transport connection to use when connecting to the remote device.
user
string / required
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 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.

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

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 is 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


Status

Authors

  • Wojciech Wypior (@wojtek0806)
  • Nitin Khanna (@nitinthewiz)