Skip to content

Latest commit

 

History

History
531 lines (509 loc) · 21.7 KB

avi_authprofile.rst

File metadata and controls

531 lines (509 loc) · 21.7 KB

vmware.alb.avi_authprofile

Module for setup of AuthProfile Avi RESTful Object

Synopsis

Parameters

Parameter Choices/Defaults Comments
state
str
  • absent
  • present ←
- The state that should be applied on the entity.
avi_api_update_method
str
  • put ←
  • patch
- Default method for object update is HTTP PUT.
- Setting to patch will override that behavior to use HTTP PATCH.
avi_api_patch_op
str
  • add ←
  • replace
  • delete
  • remove
- Patch operation to use when using avi_api_update_method as patch.
avi_patch_path
str
- Patch path to use when using avi_api_update_method as patch.
avi_patch_value
str
- Patch value to use when using avi_api_update_method as patch.
configpb_attributes
dict
- Protobuf versioning for config pbs.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
description
str
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
http
dict
- Http user authentication params.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
jwt_profile_ref
str
- Jwtserverprofile to be used for authentication.
- It is a reference to an object of type jwtserverprofile.
- Field introduced in 20.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
ldap
dict
- Ldap server and directory settings.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
markers
list
- List of labels to be used for granular rbac.
- Field introduced in 20.1.6.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
name
str
required: true
- Name of the auth profile.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
oauth_profile
dict
- Oauth profile - common endpoint information.
- Field introduced in 21.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
pa_agent_ref
str
- Pingaccessagent uuid.
- It is a reference to an object of type pingaccessagent.
- Field deprecated in 30.2.1.
- Field introduced in 18.2.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
saml
dict
- Saml settings.
- Field introduced in 17.2.3.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
tacacs_plus
dict
- Tacacs+ settings.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
tenant_ref
str
- It is a reference to an object of type tenant.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
type
str
required: true
- Type of the auth profile.
- Enum options - AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS, AUTH_PROFILE_SAML, AUTH_PROFILE_PINGACCESS, AUTH_PROFILE_JWT, AUTH_PROFILE_OAUTH.
- Allowed in enterprise edition with any value, essentials edition(allowed values-
- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth), basic edition(allowed values-
- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth), enterprise with cloud services edition.
url
str
- Avi controller URL of the object.
uuid
str
- Uuid of the auth profile.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.

Examples

- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  vars:
    avi_credentials:
      username: "{{ username }}"
      password: "{{ password }}"
      controller: "{{ controller }}"
      api_version: "{{ api_version }}"
  tasks:
    - name: Create user authorization profile based on the LDAP
      avi_authprofile:
        avi_credentials: "{{ avi_credentials }}"

        ldap:
          base_dn: dc=avi,dc=local
          bind_as_administrator: true
          port: 389
          security_mode: AUTH_LDAP_SECURE_NONE
          server:
          - 192.168.12.18
          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: /api/tenant?name=admin
        type: AUTH_PROFILE_LDAP

Authors