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

bigip_as3_deploy – Manages AS3 declarations sent to BIG-IP

New in version 1.0.0.

Synopsis

• Manages AS3 declarations sent to the BIG-IP.

Parameters

Parameter	Choices/Defaults	Configuration	Comments
content raw			The declaration to be configured on the system. This parameter is most often used with the file or template lookup plugins. Refer to the examples section for correct usage. For anything advanced or with formatting, consider using the template lookup. Additionally, this can be used for specifying application service configurations directly in YAML. However that is not an encouraged practice and, if used at all, should only be used for the absolute smallest of configurations to prevent your Playbooks from becoming too large. If your content includes encrypted values (such as ciphertexts, passphrases, etc), the returned changed value will always be true. If you are using the to_nice_json filter, it causes this module to fail because the purpose of that filter is to format the JSON to be human-readable and this process includes inserting extra characters that break JSON validators.
state string	Choices: present ← absent		When state is present, ensures the declaration is exists. When state is absent, ensures the declaration is removed.
tenant string			tenant is mandatory for Per-Application Deployment An AS3 tenant you want to manage. A value of all when state is absent removes all AS3 declarations from the device.
timeout integer	Default: 300		The amount of time to wait for the AS3 async interface to complete its task, in seconds. The accepted value range is between 10 and 1800 seconds.

Notes

Note

• For Traditional Deployment should contian the Tenant information inside it. Traditional Deployment dosen’t depend on perAppDeploymentAllowed value.
• For Per-Application Deployment perAppDeploymentAllowed should be set to true. Per-Application declaration shouldn’t contain Tenant information inside it. Tenant parameter is mandatory for Per-Application Deployments More infotmation can be found here https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/userguide/per-app-declarations.html

Examples

- name: Declaration with 2 Tenants - AS3
  bigip_as3_deploy:
    content: "{{ lookup('file', 'two_tenants.json') }}"

- name: Deploying Per-App Declaration
  bigip_as3_deploy:
    content: "{{ lookup('file', 'per-app-dec.json') }}"
    tenant: sample

- name: Remove one tenant - AS3
  bigip_as3_deploy:
    tenant: "Sample_01"
    state: absent

Return Values

The following are the fields unique to this module:

Key	Returned	Description
content dictionary	changed	The declaration sent to the system. Sample: hash/dictionary of values
tenant string	changed	The AS3 tenant to be managed. Sample: foobar1

Status

Authors

• Wojciech Wypior (@wojtek0806)
• Prateek Ramani (@ramani)