community.network.avi_systemconfiguration – Module for setup of SystemConfiguration Avi RESTful Object

Note

This plugin is part of the community.network collection (version 1.3.2).

To install it use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.avi_systemconfiguration.

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • avisdk

Parameters

Parameter Choices/Defaults Comments
admin_auth_configuration
string
Adminauthconfiguration settings for systemconfiguration.
api_context
dictionary
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
string
Default:
"16.4.4"
Avi API version of to use for Avi API and objects.
avi_api_patch_op
string
    Choices:
  • add
  • replace
  • delete
Patch operation to use when using avi_api_update_method as patch.
avi_api_update_method
string
    Choices:
  • put ←
  • patch
Default method for object update is HTTP PUT.
Setting to patch will override that behavior to use HTTP PATCH.
avi_credentials
dictionary
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
api_version
string
Default:
"16.4.4"
Avi controller version
controller
string
Avi controller IP or SQDN
csrftoken
string
Avi controller API csrftoken to reuse existing session with session id
password
string
Avi controller password
port
string
Avi controller port
session_id
string
Avi controller API session id to reuse existing session with csrftoken
tenant
string
Default:
"admin"
Avi controller tenant
tenant_uuid
string
Avi controller tenant UUID
timeout
string
Default:
300
Avi controller request timeout
token
string
Avi controller API token
username
string
Avi controller username
avi_disable_session_cache_as_fact
boolean
    Choices:
  • no ←
  • yes
It disables avi session information to be cached as a fact.
controller
string
Default:
""
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
default_license_tier
string
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.
dns_configuration
string
Dnsconfiguration settings for systemconfiguration.
dns_virtualservice_refs
string
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.
docker_mode
boolean
    Choices:
  • no
  • yes
Boolean flag to set docker_mode.
Default value when not specified in API or module is interpreted by Avi Controller as False.
email_configuration
string
Emailconfiguration settings for systemconfiguration.
global_tenant_config
string
Tenantconfiguration settings for systemconfiguration.
linux_configuration
string
Linuxconfiguration settings for systemconfiguration.
mgmt_ip_access_control
string
Configure ip access control for controller to restrict open access.
ntp_configuration
string
Ntpconfiguration settings for systemconfiguration.
password
string
Default:
""
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
portal_configuration
string
Portalconfiguration settings for systemconfiguration.
proxy_configuration
string
Proxyconfiguration settings for systemconfiguration.
secure_channel_configuration
string
Configure secure channel properties.
Field introduced in 18.1.4, 18.2.1.
snmp_configuration
string
Snmpconfiguration settings for systemconfiguration.
ssh_ciphers
string
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.
ssh_hmacs
string
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.
state
string
    Choices:
  • absent
  • present ←
The state that should be applied on the entity.
tenant
string
Default:
"admin"
Name of tenant used for all Avi API calls and context of object.
tenant_uuid
string
Default:
""
UUID of tenant used for all Avi API calls and context of object.
url
string
Avi controller URL of the object.
username
string
Default:
""
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
string
Unique object identifier of the object.
welcome_workflow_complete
boolean
    Choices:
  • no
  • yes
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.

Notes

Note

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 Returned Description
obj
dictionary
success, changed
SystemConfiguration (api/systemconfiguration) object


Authors