bigip_apm_policy_fetch – Exports the APM policy or APM access profile from remote nodes.

New in version 1.0.0.

Synopsis

  • Exports the APM policy or APM access profile from remote nodes.

Parameters

Parameter Choices/Defaults Configuration Comments
dest
path
A directory to save the file into.
file
string
The name of the file to be created on the remote device for downloading.
force
boolean
    Choices:
  • no
  • yes ←
If no, the file will only be transferred if it does not exist in the the destination.
name
string / required
The name of the APM policy or APM access profile exported to create a file on the remote device for downloading.
partition
string
Default:
"Common"
Device partition which contains the APM policy or APM access profile to export.
type
string
    Choices:
  • profile_access ←
  • access_policy
Specifies the type of item to export from the device.

Notes

Note

  • Due to ID685681 it is not possible to execute ng_* tools via REST API on v12.x and 13.x, once this is fixed this restriction will be removed.
  • Requires BIG-IP >= 14.0.0

Examples

- hosts: all
  collections:
    - f5networks.f5_bigip
  connection: httpapi

  vars:
    ansible_host: "lb.mydomain.com"
    ansible_user: "admin"
    ansible_httpapi_password: "secret"
    ansible_network_os: f5networks.f5_bigip.bigip
    ansible_httpapi_use_ssl: yes

  tasks:
    - name: Export APM access profile
      bigip_apm_policy_fetch:
        name: foobar
        file: export_foo
        dest: /root/download

    - name: Export APM access policy
      bigip_apm_policy_fetch:
        name: foobar
        file: export_foo
        dest: /root/download
        type: access_policy

    - name: Export APM access profile, autogenerate name
      bigip_apm_policy_fetch:
        name: foobar
        dest: /root/download

Return Values

The following are the fields unique to this module:

Key Returned Description
dest
string
changed
Local path to download the exported APM policy.

Sample:
/root/downloads/profile-foobar_file.conf.tar.gz
file
string
changed
Name of the exported file on the remote BIG-IP to download. If not specified, then this will be a randomly generated filename.

Sample:
foobar_file
name
string
changed
Name of the APM policy or APM access profile to be exported.

Sample:
APM_policy_global
type
string
changed
Set to specify the type of item to export.

Sample:
access_policy


Status

Authors

  • Wojciech Wypior (@wojtek0806)