bigip_apm_policy_import – Manage BIG-IP APM policy or APM access profile imports

New in version 1.0.0.

Synopsis

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

Parameters

Parameter Choices/Defaults Configuration Comments
force
boolean
    Choices:
  • no ←
  • yes
When set to yes, any existing policy with the same name is overwritten by the new import.
If a policy does not exist, this setting is ignored.
name
string / required
The name of the APM policy or APM access profile to create or override.
partition
string
Default:
"Common"
Device partition on which to manage resources.
reuse_objects
boolean
    Choices:
  • no
  • yes ←
When set to yes 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!
source
path
Full path to a file to be imported into the BIG-IP APM.
type
string
    Choices:
  • profile_access ←
  • access_policy
  • profile_api_protection
Specifies the type of item to export from the device.

Notes

Note

  • 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: Import APM profile
      bigip_apm_policy_import:
        name: new_apm_profile
        source: /root/apm_profile.tar.gz

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

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

    - 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

Return Values

The following are the fields unique to this module:

Key Returned Description
force
boolean
changed
Set when overwriting an existing policy or profile.

Sample:
True
name
string
changed
Name of the APM policy or APM access profile to be created/overwritten.

Sample:
APM_policy_global
reuse_objects
boolean
changed
Set when reusing existing objects on the BIG-IP.

Sample:
True
source
string
changed
Local path to the APM policy file.

Sample:
/root/some_policy.tar.gz
type
string
changed
Set to specify the type of item to export.

Sample:
access_policy


Status

Authors

  • Wojciech Wypior (@wojtek0806)