avi_l4policyset - Module for setup of L4PolicySet Avi RESTful Object
New in version 2.6.
Synopsis
- This module is used to configure L4PolicySet object
- more examples at https://github.com/avinetworks/devops
Requirements
The below requirements are needed on the host that executes this module.
- avisdk
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| api_context (added in 2.5) | Avi API context that includes current session ID and CSRF Token. This allows user to perform single login and re-use the session. | |
| api_version | Default: "16.4.4" | Avi API version of to use for Avi API and objects. |
| avi_api_patch_op |
| Patch operation to use when using avi_api_update_method as patch. |
| avi_api_update_method |
| Default method for object update is HTTP PUT. Setting to patch will override that behavior to use HTTP PATCH. |
| avi_credentials (added in 2.5) | Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
| controller | Default: "" | IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER. |
| created_by | Creator name. Field introduced in 17.2.7. | |
| description | Field introduced in 17.2.7. | |
| is_internal_policy bool |
| Field introduced in 17.2.7. Default value when not specified in API or module is interpreted by Avi Controller as False. |
| l4_connection_policy | Policy to apply when a new transport connection is setup. Field introduced in 17.2.7. | |
| name required | Name of the l4 policy set. Field introduced in 17.2.7. | |
| password | Default: "" | Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD. |
| state |
| The state that should be applied on the entity. |
| tenant | Default: "admin" | Name of tenant used for all Avi API calls and context of object. |
| tenant_ref | It is a reference to an object of type tenant. Field introduced in 17.2.7. | |
| tenant_uuid | Default: "" | UUID of tenant used for all Avi API calls and context of object. |
| url | Avi controller URL of the object. | |
| username | Default: "" | Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME. |
| uuid | Id of the l4 policy set. Field introduced in 17.2.7. |
Notes
Note
- For more information on using Ansible to manage Avi Network devices see https://www.ansible.com/ansible-avi-networks.
Examples
- name: Example to create L4PolicySet object
avi_l4policyset:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_l4policyset
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| obj dict | success, changed | L4PolicySet (api/l4policyset) object |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Author
- Chaitanya Deshpande (chaitanya.deshpande@avinetworks.com)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/avi_l4policyset_module.html