f5networks.f5_modules.bigip_asm_policy_import – Manage BIG-IP ASM policy imports

Note

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

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

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

New in version 1.0.0: of f5networks.f5_modules

Synopsis

• Manage the policy imports for BIG-IP ASM policies.

Parameters

Parameter		Choices/Defaults	Comments
base64 boolean		Choices: no yes	Indicates if the imported policy string is encoded in Base64. Parameter only takes effect when using the inline method of import.
encoding string		Choices: windows-874 utf-8 koi8-r windows-1253 iso-8859-10 gbk windows-1256 windows-1250 iso-8859-13 iso-8859-9 windows-1251 iso-8859-6 big5 gb2312 iso-8859-1 windows-1252 iso-8859-4 iso-8859-2 iso-8859-3 gb18030 shift_jis iso-8859-8 euc-kr iso-8859-5 iso-8859-7 windows-1255 euc-jp iso-8859-15 windows-1257 iso-8859-16 auto-detect	Specifies the desired application language of the imported policy. The imported policy cannot be a parent type or attached to a parent policy when auto-detect encoding is set. When importing a policy to attach to a parent policy, the encoding of the imported policy, if different, must be set to be the same value as parent_policy, otherwise import will fail. This parameter is available on TMOS version 13.x and later and only takes effect when the inline import method is used.
force boolean		Choices: no ← yes	When set to yes any existing policy with the same name will be overwritten by the new import. Works for both inline and file imports, if the policy does not exist this setting is ignored.
inline string			When specified, the ASM policy is created from a provided string. Content needs to be provided in a valid XML format, otherwise the operation will fail.
name string / required			The ASM policy to create or override.
parent_policy string			The parent policy to which the newly imported policy should be attached as child. When parent_policy is specified, the imported policy_type must not be parent. This parameter is available on TMOS version 13.x and later and only takes effect when inline import method is used.
partition string		Default: "Common"	Device partition on which to create the policy. This parameter is also applied to indicate the partition of the parent policy.
policy_type string		Choices: security ← parent	The type of the policy to import. When policy_type is security, the policy is imported as an application security policy that you can apply to a virtual server. When policy_type is parent, the policy becomes a parent to which other Security policies attach, inheriting its attributes. This policy type cannot be applied to Virtual Servers. This parameter is available on TMOS version 13.x and later and only takes effect when the inline import method is used.
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.
retain_inheritance_settings boolean		Choices: no yes	Indicate if an imported security type policy should retain settings when attached to parent policy. This parameter is available on TMOS version 13.x and later and only takes effect when the inline import method is used.
source path			Full path to a policy file to be imported into the BIG-IP ASM. Policy files exported from newer versions of BIG-IP cannot be imported into older versions of BIG-IP. The opposite, however, is true; you can import older into newer. The file format can be binary or XML.

Notes

Note

• 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 ASM policy
  bigip_asm_policy_import:
    name: new_asm_policy
    file: /root/asm_policy.xml
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Import ASM policy inline
  bigip_asm_policy_import:
    name: foo-policy4
    inline: <xml>content</xml>
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Override existing ASM policy
  bigip_asm_policy:
    name: new_asm_policy
    source: /root/asm_policy_new.xml
    force: yes
    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
base64 boolean	changed	Indicates if the imported policy string is encoded in Base64. Sample: True
encoding string	changed	The desired application language of the imported policy. Sample: utf-8
force boolean	changed	Set when overwriting an existing policy. Sample: True
inline string	changed	Contents of a policy as an inline string. Sample: <xml>foobar contents</xml>
name string	changed	Name of the ASM policy to be created/overwritten. Sample: Asm_APP1_Transparent
parent_policy string	changed	The parent policy to which the newly imported policy should be attached as child. Sample: /Common/parent
policy_type string	changed	The type of the policy to import. Sample: security
retain_inheritance_settings boolean	changed	Indicate if an imported security type policy should retain settings when attached to the parent policy. Sample: True
source string	changed	Local path to an ASM policy file. Sample: /root/some_policy.xml

Authors

• Wojciech Wypior (@wojtek0806)

• Nitin Khanna (@nitinthewiz)