community.network.avi_systemconfiguration – Module for setup of SystemConfiguration Avi RESTful Object
Note
This plugin is part of the community.network collection (version 3.0.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 community.network
.
To use it in a playbook, specify: community.network.avi_systemconfiguration
.
Synopsis
This module is used to configure SystemConfiguration object
more examples at https://github.com/avinetworks/devops
Parameters
Parameter |
Comments |
---|---|
Adminauthconfiguration settings for systemconfiguration. |
|
Avi API context that includes current session ID and CSRF Token. This allows user to perform single login and re-use the session. |
|
Avi API version of to use for Avi API and objects. Default: “16.4.4” |
|
Patch operation to use when using avi_api_update_method as patch. Choices:
|
|
Default method for object update is HTTP PUT. Setting to patch will override that behavior to use HTTP PATCH. Choices:
|
|
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. |
|
Avi controller version Default: “16.4.4” |
|
Avi controller IP or SQDN |
|
Avi controller API csrftoken to reuse existing session with session id |
|
Avi controller password |
|
Avi controller port |
|
Avi controller API session id to reuse existing session with csrftoken |
|
Avi controller tenant Default: “admin” |
|
Avi controller tenant UUID |
|
Avi controller request timeout Default: 300 |
|
Avi controller API token |
|
Avi controller username |
|
It disables avi session information to be cached as a fact. Choices:
|
|
IP address or hostname of the controller. The default value is the environment variable Default: “” |
|
Specifies the default license tier which would be used by new clouds. Enum options - ENTERPRISE_16, ENTERPRISE_18. Field introduced in 17.2.5. Default value when not specified in API or module is interpreted by Avi Controller as ENTERPRISE_18. |
|
Dnsconfiguration settings for systemconfiguration. |
|
Dns virtualservices hosting fqdn records for applications across avi vantage. If no virtualservices are provided, avi vantage will provide dns services for configured applications. Switching back to avi vantage from dns virtualservices is not allowed. It is a reference to an object of type virtualservice. |
|
Boolean flag to set docker_mode. Default value when not specified in API or module is interpreted by Avi Controller as False. Choices:
|
|
Emailconfiguration settings for systemconfiguration. |
|
Tenantconfiguration settings for systemconfiguration. |
|
Linuxconfiguration settings for systemconfiguration. |
|
Configure ip access control for controller to restrict open access. |
|
Ntpconfiguration settings for systemconfiguration. |
|
Password of Avi user in Avi controller. The default value is the environment variable Default: “” |
|
Portalconfiguration settings for systemconfiguration. |
|
Proxyconfiguration settings for systemconfiguration. |
|
Configure secure channel properties. Field introduced in 18.1.4, 18.2.1. |
|
Snmpconfiguration settings for systemconfiguration. |
|
Allowed ciphers list for ssh to the management interface on the controller and service engines. If this is not specified, all the default ciphers are allowed. |
|
Allowed hmac list for ssh to the management interface on the controller and service engines. If this is not specified, all the default hmacs are allowed. |
|
The state that should be applied on the entity. Choices:
|
|
Name of tenant used for all Avi API calls and context of object. Default: “admin” |
|
UUID of tenant used for all Avi API calls and context of object. Default: “” |
|
Avi controller URL of the object. |
|
Username used for accessing Avi controller. The default value is the environment variable Default: “” |
|
Unique object identifier of the object. |
|
This flag is set once the initial controller setup workflow is complete. Field introduced in 18.2.3. Default value when not specified in API or module is interpreted by Avi Controller as False. Choices:
|
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 SystemConfiguration object
community.network.avi_systemconfiguration:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_systemconfiguration
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
SystemConfiguration (api/systemconfiguration) object Returned: success, changed |
Authors
Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>