Last updated on: 2024-04-01 03:24:20.

bigip_asm_policy_import – Manage BIG-IP ASM policy imports

New in version 1.0.0.

Synopsis

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

Parameters

Parameter Choices/Defaults Configuration 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 true 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.
retain_inheritance_settings
boolean
    Choices:
  • no
  • yes
Indicates if an imported security type policy should retain settings when attached to the 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.

Examples

- name: Import ASM policy
  bigip_asm_policy_import:
    name: new_asm_policy
    file: /root/asm_policy.xml

- name: Import ASM policy inline
  bigip_asm_policy_import:
    name: foo-policy4
    inline: <xml>content</xml>

- name: Override existing ASM policy
  bigip_asm_policy_import:
    name: new_asm_policy
    source: /root/asm_policy_new.xml
    force: true

Return Values

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


Status

Authors

  • Wojciech Wypior (@wojtek0806)