f5networks.f5_bigip.bigip_apm_policy_fetch (3.4.0) — module

Install collection

Install with ansible-galaxy collection install f5networks.f5_bigip:==3.4.0

Add to requirements.yml

  collections:
    - name: f5networks.f5_bigip
      version: 3.4.0

Description

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
dest:
    description:
    - A directory to save the file into.
    type: path

file:
    description:
    - The name of the file to be created on the remote device for downloading.
    type: str

name:
    description:
    - The name of the APM policy or APM access profile exported to create a file on the
      remote device for downloading.
    required: true
    type: str

type:
    choices:
    - profile_access
    - access_policy
    default: profile_access
    description:
    - Specifies the type of item to export from the device.
    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

partition:
    default: Common
    description:
    - Device partition which contains the APM policy or APM access profile to export.
    type: str

Outputs

dest:
  description: Local path to download the exported APM policy.
  returned: changed
  sample: /root/downloads/profile-foobar_file.conf.tar.gz
  type: str
file:
  description:
  - Name of the exported file on the remote BIG-IP to download. If not specified,
    then this will be a randomly generated filename.
  returned: changed
  sample: foobar_file
  type: str
name:
  description: Name of the APM policy or APM access profile to be exported.
  returned: changed
  sample: APM_policy_global
  type: str
type:
  description: Set to specify the type of item to export.
  returned: changed
  sample: access_policy
  type: str