avi_authprofile - Module for setup of AuthProfile Avi RESTful Object
New in version 2.4.
Synopsis
- This module is used to configure AuthProfile object
- more examples at https://github.com/avinetworks/devops
Requirements (on host that executes module)
- avisdk
Options
parameter | required | default | choices | comments |
---|---|---|---|---|
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 .
|
||
description |
no |
User defined description for the object.
|
||
http |
no |
Http user authentication params.
|
||
ldap |
no |
Ldap server and directory settings.
|
||
name |
yes |
Name of the auth profile.
|
||
password |
no |
Password of Avi user in Avi controller. The default value is the environment variable
AVI_PASSWORD .
|
||
state |
no | present |
|
The state that should be applied on the entity.
|
tacacs_plus |
no |
Tacacs+ settings.
|
||
tenant |
no | admin |
Name of tenant used for all Avi API calls and context of object.
|
|
tenant_ref |
no |
It is a reference to an object of type tenant.
|
||
tenant_uuid |
no |
UUID of tenant used for all Avi API calls and context of object.
|
||
type |
yes |
Type of the auth profile.
Enum options - AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS.
|
||
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 |
Uuid of the auth profile.
|
Examples
- name: Create user authorization profile based on the LDAP avi_authprofile: controller: '' password: '' 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: [email protected] 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
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 |
AuthProfile (api/authprofile) 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–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/avi_authprofile_module.html