avi_cloudconnectoruser – Module for setup of CloudConnectorUser Avi RESTful Object

New in version 2.4.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis

This module is used to configure CloudConnectorUser object
more examples at https://github.com/avinetworks/devops

Requirements

The below requirements are needed on the host that executes this module.

avisdk

Parameters

Parameter		Choices/Defaults	Comments
api_context dictionary added in 2.5			Avi API context that includes current session ID and CSRF Token. This allows user to perform single login and re-use the session.
api_version string		Default: "16.4.4"	Avi API version of to use for Avi API and objects.
avi_api_patch_op - added in 2.5		add replace delete	Patch operation to use when using avi_api_update_method as patch.
avi_api_update_method - added in 2.5		put ← patch	Default method for object update is HTTP PUT. Setting to patch will override that behavior to use HTTP PATCH.
avi_credentials dictionary added in 2.5			Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
	api_version -	Default: "16.4.4"	Avi controller version
	controller -		Avi controller IP or SQDN
	csrftoken -		Avi controller API csrftoken to reuse existing session with session id
	password -		Avi controller password
	port -		Avi controller port
	session_id -		Avi controller API session id to reuse existing session with csrftoken
	tenant -	Default: "admin"	Avi controller tenant
	tenant_uuid -		Avi controller tenant UUID
	timeout -	Default: 300	Avi controller request timeout
	token -		Avi controller API token
	username -		Avi controller username
avi_disable_session_cache_as_fact boolean added in 2.6		no yes	It disables avi session information to be cached as a fact.
azure_serviceprincipal - added in 2.5			Field introduced in 17.2.1.
azure_userpass - added in 2.5			Field introduced in 17.2.1.
controller string		Default: ""	IP address or hostname of the controller. The default value is the environment variable `AVI_CONTROLLER`.
gcp_credentials - added in 2.9			Credentials for google cloud platform. Field introduced in 18.2.1.
name - / required			Name of the object.
oci_credentials - added in 2.9			Credentials for oracle cloud infrastructure. Field introduced in 18.2.1,18.1.3.
password string		Default: ""	Password of Avi user in Avi controller. The default value is the environment variable `AVI_PASSWORD`.
private_key -			Private_key of cloudconnectoruser.
public_key -			Public_key of cloudconnectoruser.
state -		absent present ←	The state that should be applied on the entity.
tenant string		Default: "admin"	Name of tenant used for all Avi API calls and context of object.
tenant_ref -			It is a reference to an object of type tenant.
tenant_uuid string		Default: ""	UUID of tenant used for all Avi API calls and context of object.
tencent_credentials - added in 2.9			Credentials for tencent cloud. Field introduced in 18.2.3.
url -			Avi controller URL of the object.
username string		Default: ""	Username used for accessing Avi controller. The default value is the environment variable `AVI_USERNAME`.
uuid -			Unique object identifier of the object.

Notes

Note

For more information on using Ansible to manage Avi Network devices see https://www.ansible.com/ansible-avi-networks.

Examples

- name: Create a Cloud connector user that is used for integration into cloud platforms
  avi_cloudconnectoruser:
    controller: '{{ controller }}'
    name: root
    password: '{{ password }}'
    private_key: |
      -----BEGIN RSA PRIVATE KEY-----
      -----END RSA PRIVATE KEY-----'
    public_key: 'ssh-rsa ...'
    tenant_ref: admin
    username: '{{ username }}'

Return Values

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

Key	Returned	Description
obj dictionary	success, changed	CloudConnectorUser (api/cloudconnectoruser) object

Status

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors

Gaurav Rastogi (@grastogi23) <[email protected]>

Hint

If you notice any issues in this documentation, you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/avi_cloudconnectoruser_module.html