f5networks.f5_modules.bigip_asm_policy_import module – Manage BIG-IP ASM policy imports
Note
This module is part of the f5networks.f5_modules collection (version 1.17.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
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
Parameters
Parameter |
Comments |
|---|---|
Indicates if the imported policy string is encoded in Base64. This parameter only takes effect when using the Choices:
|
|
Specifies the desired application language of the imported policy. The imported policy cannot be a When importing a policy to attach to a This parameter is available on TMOS version 13.x and later and only takes effect when the Choices:
|
|
When set to This works for both inline and file imports, if the policy does not exist this setting is ignored. Choices:
|
|
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. |
|
The ASM policy to create or override. |
|
The parent policy to which the newly imported policy should be attached as child. When This parameter is available on TMOS version 13.x and later and only takes effect when |
|
Device partition on which to create the policy. This parameter is also applied to indicate the partition of the Default: “Common” |
|
The type of the policy to import. When When This parameter is available on TMOS version 13.x and later and only takes effect when the Choices:
|
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable |
|
The BIG-IP host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: 443 |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
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 |
|
If You may omit this option by setting the environment variable Choices:
|
|
Indicates 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 Choices:
|
|
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. However, policy files from older versions of BIG-IP can be imported into newer versions of BIG-IP. 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 |
Description |
|---|---|
Indicates if the imported policy string is encoded in Base64. Returned: changed Sample: true |
|
The desired application language of the imported policy. Returned: changed Sample: “utf-8” |
|
Set when overwriting an existing policy. Returned: changed Sample: true |
|
Contents of a policy as an inline string. Returned: changed Sample: “\u003cxml\u003efoobar contents\u003c/xml\u003e” |
|
Name of the ASM policy to be created/overwritten. Returned: changed Sample: “Asm_APP1_Transparent” |
|
The parent policy to which the newly imported policy should be attached as child. Returned: changed Sample: “/Common/parent” |
|
The type of the policy to import. Returned: changed Sample: “security” |
|
Indicate if an imported security type policy should retain settings when attached to the parent policy. Returned: changed Sample: true |
|
Local path to an ASM policy file. Returned: changed Sample: “/root/some_policy.xml” |
Authors
Wojciech Wypior (@wojtek0806)
Nitin Khanna (@nitinthewiz)