community / community.general / 0.1.1 / module / avi_authprofile Module for setup of AuthProfile Avi RESTful Object Authors: Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com> preview | supported by communitycommunity.general.avi_authprofile (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 AuthProfile object
more examples at U(https://github.com/avinetworks/devops)
- name: Create user authorization profile based on the LDAP avi_authprofile: controller: '{{ controller }}' password: '{{ password }}' username: '{{ username }}' http: cache_expiration_time: 5 group_member_is_full_dn: false ldap: base_dn: dc=avi,dc=local bind_as_administrator: true port: 389 security_mode: AUTH_LDAP_SECURE_NONE server: - 10.10.0.100 settings: admin_bind_dn: user@avi.local group_filter: (objectClass=*) group_member_attribute: member group_member_is_full_dn: true group_search_dn: dc=avi,dc=local group_search_scope: AUTH_LDAP_SCOPE_SUBTREE ignore_referrals: true password: password user_id_attribute: samAccountname user_search_dn: dc=avi,dc=local user_search_scope: AUTH_LDAP_SCOPE_ONE name: ProdAuth tenant_ref: admin type: AUTH_PROFILE_LDAP
url: description: - Avi controller URL of the object. http: description: - Http user authentication params. ldap: description: - Ldap server and directory settings. name: description: - Name of the auth profile. required: true saml: description: - Saml settings. - Field introduced in 17.2.3. type: description: - Type of the auth profile. - Enum options - AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS, AUTH_PROFILE_SAML, AUTH_PROFILE_PINGACCESS. required: true uuid: description: - Uuid of the auth profile. 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 controller: default: '' description: - IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). type: str tenant_ref: description: - It is a reference to an object of type tenant. 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 description: description: - User defined description for the object. tacacs_plus: description: - Tacacs+ settings. tenant_uuid: default: '' description: - UUID of tenant used for all Avi API calls and context of object. type: str pa_agent_ref: description: - Pingaccessagent uuid. - It is a reference to an object of type pingaccessagent. - Field introduced in 18.2.3. 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. 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. avi_disable_session_cache_as_fact: description: - It disables avi session information to be cached as a fact. type: bool
obj: description: AuthProfile (api/authprofile) object returned: success, changed type: dict