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

Note

This plugin is part of the f5networks.f5_modules collection (version 1.7.1).

To install it use: ansible-galaxy collection install f5networks.f5_modules.

To use it in a playbook, specify: f5networks.f5_modules.bigip_apm_policy_import.

New in version 1.0.0: of f5networks.f5_modules

Synopsis

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

Parameters

Parameter		Choices/Defaults	Comments
force boolean		Choices: no ← yes	When set to yes any existing policy with the same name will be 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 to manage resources on.
provider dictionary added in 1.0.0 of f5networks.f5_modules			A dict object containing connection details.
	auth_provider string		Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices.
	no_f5_teem boolean	Choices: no yes	If yes, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable F5_TEEM.
	password string / required		The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable F5_PASSWORD. aliases: pass, pwd
	server string / required		The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER.
	server_port integer	Default: 443	The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT.
	timeout integer		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.
	transport string	Choices: rest ←	Configures the transport connection to use when connecting to the remote device.
	user string / required		The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable F5_USER.
	validate_certs boolean	Choices: no yes ←	If 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 F5_VALIDATE_CERTS.
reuse_objects boolean		Choices: no yes ←	When set to yes 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!
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

• 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

• For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.

• Requires BIG-IP software version >= 12.

• The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.

Examples

- 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

- 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

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

- 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

Return Values

Common return values are documented here, 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 APM policy file. Sample: /root/some_policy.tar.gz
type string	changed	Set to specify type of item to export. Sample: access_policy

Authors

• Wojciech Wypior (@wojtek0806)