W3cubDocs

/Ansible

avi_systemconfiguration - Module for setup of SystemConfiguration Avi RESTful Object

New in version 2.3.

Synopsis

Requirements (on host that executes module)

  • avisdk

Options

parameter required default choices comments
admin_auth_configuration
 no
Adminauthconfiguration settings for systemconfiguration.
api_version
 no
Avi API version of to use for Avi API and objects.
controller
 no
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
dns_configuration
 no
Dnsconfiguration settings for systemconfiguration.
dns_virtualservice_refs
 no
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
 no
Boolean flag to set docker_mode.
Default value when not specified in API or module is interpreted by Avi Controller as False.
email_configuration
 no
Emailconfiguration settings for systemconfiguration.
global_tenant_config
 no
Tenantconfiguration settings for systemconfiguration.
linux_configuration
 no
Linuxconfiguration settings for systemconfiguration.
mgmt_ip_access_control
 no
Configure ip access control for controller to restrict open access.
ntp_configuration
 no
Ntpconfiguration settings for systemconfiguration.
password
 no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
portal_configuration
 no
Portalconfiguration settings for systemconfiguration.
proxy_configuration
 no
Proxyconfiguration settings for systemconfiguration.
snmp_configuration
 no
Snmpconfiguration settings for systemconfiguration.
ssh_ciphers
 no
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 -q cipher provides the list of default ciphers supported.
ssh_hmacs
 no
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.
Ssh -q mac provides the list of default hmacs supported.
state
 no present
  • absent
  • present
The state that should be applied on the entity.
tenant
 no admin
Name of tenant used for all Avi API calls and context of object.
tenant_uuid
 no
UUID of tenant used for all Avi API calls and context of object.
url
 no
Avi controller URL of the object.
username
 no
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
 no
Unique object identifier of the object.

Examples

- name: Example to create SystemConfiguration object
  avi_systemconfiguration:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_systemconfiguration

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
obj
SystemConfiguration (api/systemconfiguration) object
 success, changed dict

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/avi_systemconfiguration_module.html