bigip_asm_policy_fetch – Exports the ASM policy from remote nodes.

New in version 1.0.0.

Synopsis

• Exports the BIG-IP ASM policy from remote nodes.

Parameters

Parameter	Choices/Defaults	Configuration	Comments
base64 boolean	Choices: no yes		If true, the returned inline ASM policy content will be Base64 encoded. Only applies to inline ASM policy exports.
compact boolean	Choices: no yes		If true, only the ASM policy custom settings will be exported. Only applies to XML and JSON type ASM policy exports.
dest path			A directory where you want to save the policy file. 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 will be 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.
format string / required	Choices: json xml binary		Defines the output format for the ASM policy to be exported. When json, the ASM policy will be in JSON format. When xml, the ASM policy will be in XML format. When binary, the ASM policy will be in binary format. When binary, inline export is not supported.
inline boolean	Choices: no yes		If true, the ASM policy will be 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.
learning_suggestions boolean	Choices: no yes		If true, JSON ASM policy with suggestions will be exported. Only applies to JSON type ASM policy exports.
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.

Examples

- name: Export policy in binary format
  bigip_asm_policy_fetch:
    name: foobar
    file: export_foo
    dest: /root/download
    format: binary

- name: Export policy inline base64 encoded format
  bigip_asm_policy_fetch:
    name: foobar
    inline: true
    base64: true
    format: xml

- name: Export policy in XML format
  bigip_asm_policy_fetch:
    name: foobar
    file: export_foo
    dest: /root/download
    format: xml

- name: Export compact policy in XML format
  bigip_asm_policy_fetch:
    name: foobar
    file: export_foo.xml
    dest: /root/download/
    compact: true
    format: xml

- name: Export policy in binary format, autogenerate name
  bigip_asm_policy_fetch:
    name: foobar
    dest: /root/download/
    format: binary

- name: Export policy in JSON compact format with learning suggestions, autogenerate name
  bigip_asm_policy_fetch:
    name: foobar
    dest: /root/download/
    format: json
    compact: true
    learning_suggestions: true

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, this will be 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)