Try SpotterExports the ASM policy from remote nodes.
| "added in version" 1.0.0 of f5networks.f5_modules"
Authors: Wojciech Wypior (@wojtek0806), Nitin Khanna (@nitinthewiz)
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections:
- name: f5networks.f5_modules
version: 1.28.0Exports the ASM policy from remote nodes.
- 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
dest:
description:
- A directory to save the policy file into.
- This option is ignored when C(inline) is set to C(true).
type: path
file:
description:
- The name of the file to be created on the remote device for downloading.
- When C(binary) is set to C(false) the ASM policy is in XML format.
type: str
name:
description:
- The name of the policy exported to create a file on the remote device for downloading.
required: true
type: str
force:
default: true
description:
- If C(false), the file will only be transferred if it does not exist in the the destination.
type: bool
base64:
description:
- If C(true), the returned C(inline) ASM policy content is Base64 encoded.
- Only applies to C(inline) ASM policy exports.
type: bool
binary:
description:
- If C(true), the exported ASM policy is in binary format.
- Only applies to C(file) ASM policy exports.
type: bool
inline:
description:
- If C(true), the ASM policy is exported C(inline) as a string instead of a file.
- The policy can be be retrieved in the playbook C(result) dictionary under the C(inline_policy)
key.
type: bool
compact:
description:
- If C(true), only the ASM policy custom settings is exported.
- Only applies to XML type ASM policy exports.
type: bool
provider:
description:
- A dict object containing connection details.
suboptions:
auth_provider:
description:
- Configures the auth provider for to obtain authentication tokens from the remote
device.
- This option is really used when working with BIG-IQ devices.
type: str
no_f5_teem:
default: false
description:
- If C(yes), TEEM telemetry data is not sent to F5.
- You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
- Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
type: bool
password:
aliases:
- pass
- pwd
description:
- 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 C(F5_PASSWORD).
required: true
type: str
server:
description:
- The BIG-IP host or the BIG-IQ host.
- You may omit this option by setting the environment variable C(F5_SERVER).
required: true
type: str
server_port:
default: 443
description:
- The BIG-IP server port.
- You may omit this option by setting the environment variable C(F5_SERVER_PORT).
type: int
timeout:
description:
- 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.
type: int
transport:
choices:
- rest
default: rest
description:
- Configures the transport connection to use when connecting to the remote device.
type: str
user:
description:
- 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 C(F5_USER).
required: true
type: str
validate_certs:
default: true
description:
- If C(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 C(F5_VALIDATE_CERTS).
type: bool
type: dict
version_added: 1.0.0
version_added_collection: f5networks.f5_modules
partition:
default: Common
description:
- Device partition which contains the ASM policy to export.
type: str
base64:
description: Set to encode inline export in Base64 format.
returned: changed
sample: false
type: bool
binary:
description: Set to export the ASM policy in binary format.
returned: changed
sample: true
type: bool
compact:
description: Set only to export custom ASM policy settings.
returned: changed
sample: false
type: bool
dest:
description: Local path to download the exported ASM policy.
returned: changed
sample: /root/downloads/foobar.xml
type: str
file:
description:
- 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
type: str
inline:
description: Set when the ASM policy to be exported is inline
returned: changed
sample: true
type: bool
name:
description: Name of the ASM policy to be exported.
returned: changed
sample: Asm_APP1_Transparent
type: str