Documentation

avi_cloudconnectoruser - Module for setup of CloudConnectorUser Avi RESTful Object

New in version 2.4.

Synopsis

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.
name
yes
Name of the object.
password
no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
private_key
no
Private_key of cloudconnectoruser.
public_key
no
Public_key of cloudconnectoruser.
state
no present
  • absent
  • present
The state that should be applied on the entity.
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.
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
Unique object identifier of the object.

Examples

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

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 CloudConnectorUser (api/cloudconnectoruser) object success, changed dict


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.