community / community.general / 0.1.1 / module / avi_systemconfiguration Module for setup of SystemConfiguration Avi RESTful Object Authors: Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com> preview | supported by communitycommunity.general.avi_systemconfiguration (0.1.1) — module
Install with ansible-galaxy collection install community.general:==0.1.1
collections: - name: community.general version: 0.1.1
This module is used to configure SystemConfiguration object
more examples at U(https://github.com/avinetworks/devops)
- name: Example to create SystemConfiguration object avi_systemconfiguration: controller: 10.10.25.42 username: admin password: something state: present name: sample_systemconfiguration
url: description: - Avi controller URL of the object. uuid: description: - Unique object identifier of the object. state: choices: - absent - present default: present description: - The state that should be applied on the entity. tenant: default: admin description: - Name of tenant used for all Avi API calls and context of object. type: str password: default: '' description: - Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). type: str username: default: '' description: - Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). type: str ssh_hmacs: description: - 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. controller: default: '' description: - IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). type: str api_context: description: - Avi API context that includes current session ID and CSRF Token. - This allows user to perform single login and re-use the session. type: dict api_version: default: 16.4.4 description: - Avi API version of to use for Avi API and objects. type: str docker_mode: description: - Boolean flag to set docker_mode. - Default value when not specified in API or module is interpreted by Avi Controller as False. type: bool ssh_ciphers: description: - 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. tenant_uuid: default: '' description: - UUID of tenant used for all Avi API calls and context of object. type: str avi_credentials: description: - Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. suboptions: api_version: default: 16.4.4 description: - Avi controller version controller: description: - Avi controller IP or SQDN csrftoken: description: - Avi controller API csrftoken to reuse existing session with session id password: description: - Avi controller password port: description: - Avi controller port session_id: description: - Avi controller API session id to reuse existing session with csrftoken tenant: default: admin description: - Avi controller tenant tenant_uuid: description: - Avi controller tenant UUID timeout: default: 300 description: - Avi controller request timeout token: description: - Avi controller API token username: description: - Avi controller username type: dict avi_api_patch_op: choices: - add - replace - delete description: - Patch operation to use when using avi_api_update_method as patch. dns_configuration: description: - Dnsconfiguration settings for systemconfiguration. ntp_configuration: description: - Ntpconfiguration settings for systemconfiguration. snmp_configuration: description: - Snmpconfiguration settings for systemconfiguration. email_configuration: description: - Emailconfiguration settings for systemconfiguration. linux_configuration: description: - Linuxconfiguration settings for systemconfiguration. proxy_configuration: description: - Proxyconfiguration settings for systemconfiguration. default_license_tier: description: - 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. global_tenant_config: description: - Tenantconfiguration settings for systemconfiguration. portal_configuration: description: - Portalconfiguration settings for systemconfiguration. avi_api_update_method: choices: - put - patch default: put description: - Default method for object update is HTTP PUT. - Setting to patch will override that behavior to use HTTP PATCH. mgmt_ip_access_control: description: - Configure ip access control for controller to restrict open access. dns_virtualservice_refs: description: - 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. admin_auth_configuration: description: - Adminauthconfiguration settings for systemconfiguration. welcome_workflow_complete: description: - 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. type: bool secure_channel_configuration: description: - Configure secure channel properties. - Field introduced in 18.1.4, 18.2.1. avi_disable_session_cache_as_fact: description: - It disables avi session information to be cached as a fact. type: bool
obj: description: SystemConfiguration (api/systemconfiguration) object returned: success, changed type: dict