f5networks.f5_bigip.bigip_apm_policy_import (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

Manage BIG-IP APM policy or APM access profile imports.

Usage examples

Scanned by Steampunk Spotter

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

- name: Import APM profile
  bigip_apm_policy_import:
    name: new_apm_profile
    source: /root/apm_profile.tar.gz

Scanned by Steampunk Spotter

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

- name: Import APM policy
  bigip_apm_policy_import:
    name: new_apm_policy
    source: /root/apm_policy.tar.gz
    type: access_policy

Scanned by Steampunk Spotter

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

- name: Override existing APM policy
  bigip_asm_policy:
    name: new_apm_policy
    source: /root/apm_policy.tar.gz
    force: true

Scanned by Steampunk Spotter

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

- name: Import APM profile without re-using existing configuration objects
  bigip_apm_policy_import:
    name: new_apm_profile
    source: /root/apm_profile.tar.gz
    reuse_objects: false

Inputs

    
name:
    description:
    - The name of the APM policy or APM access profile to create or override.
    required: true
    type: str

type:
    choices:
    - profile_access
    - access_policy
    - profile_api_protection
    default: profile_access
    description:
    - Specifies the type of item to export from the device.
    type: str

force:
    default: false
    description:
    - When set to C(true), any existing policy with the same name is overwritten by the
      new import.
    - If a policy does not exist, this setting is ignored.
    type: bool

source:
    description:
    - Full path to a file to be imported into the BIG-IP APM.
    type: path

partition:
    default: Common
    description:
    - Device partition on which to manage resources.
    type: str

reuse_objects:
    default: true
    description:
    - When set to C(true) and objects referred within the policy exist on the BIG-IP,
      those are used instead of the objects defined in the policy.
    - Reusing existing objects reduces configuration size.
    - The configuration of existing objects might differ from the configuration of the
      objects defined in the policy!
    type: bool

Outputs

force:
  description: Set when overwriting an existing policy or profile.
  returned: changed
  sample: true
  type: bool
name:
  description: Name of the APM policy or APM access profile to be created/overwritten.
  returned: changed
  sample: APM_policy_global
  type: str
reuse_objects:
  description: Set when reusing existing objects on the BIG-IP.
  returned: changed
  sample: true
  type: bool
source:
  description: Local path to the APM policy file.
  returned: changed
  sample: /root/some_policy.tar.gz
  type: str
type:
  description: Set to specify the type of item to export.
  returned: changed
  sample: access_policy
  type: str