Steampunk Ansible Documentation - f5networks.f5_modules.bigip_apm_policy_import (1.28.0) - module - Manage BIG-IP APM policy or APM access profile imports

Install collection

Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0

Add to requirements.yml

  collections:
    - name: f5networks.f5_modules
      version: 1.28.0

Description

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

Usage examples

Scanned by Steampunk Spotter

- name: Import APM profile
  bigip_apm_policy_import:
    name: new_apm_profile
    source: /root/apm_profile.tar.gz
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Scanned by Steampunk Spotter

- name: Import APM policy
  bigip_apm_policy_import:
    name: new_apm_policy
    source: /root/apm_policy.tar.gz
    type: access_policy
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Scanned by Steampunk Spotter

- name: Override existing APM policy
  bigip_asm_policy:
    name: new_apm_policy
    source: /root/apm_policy.tar.gz
    force: true
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Scanned by Steampunk Spotter

- 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
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

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 will be 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

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 to manage resources on.
type: str

reuse_objects:
default: true
description:
- When set to C(true) and objects referred within the policy exist on the BIG-IP,
those will be used instead of the objects defined in the policy.
- Reusing existing objects reduces configuration size.
- The configuration of existing objects might differ to 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 APM policy file.
  returned: changed
  sample: /root/some_policy.tar.gz
  type: str
type:
  description: Set to specify type of item to export.
  returned: changed
  sample: access_policy
  type: str