community.network.avi_backupconfiguration – Module for setup of BackupConfiguration Avi RESTful Object

Note

This plugin is part of the community.network collection (version 1.3.0).

To install it use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.avi_backupconfiguration.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

This module is used to configure BackupConfiguration 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			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 string		add replace delete	Patch operation to use when using avi_api_update_method as patch.
avi_api_update_method string		put ← patch	Default method for object update is HTTP PUT. Setting to patch will override that behavior to use HTTP PATCH.
avi_credentials dictionary			Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
	api_version string	Default: "16.4.4"	Avi controller version
	controller string		Avi controller IP or SQDN
	csrftoken string		Avi controller API csrftoken to reuse existing session with session id
	password string		Avi controller password
	port string		Avi controller port
	session_id string		Avi controller API session id to reuse existing session with csrftoken
	tenant string	Default: "admin"	Avi controller tenant
	tenant_uuid string		Avi controller tenant UUID
	timeout string	Default: 300	Avi controller request timeout
	token string		Avi controller API token
	username string		Avi controller username
avi_disable_session_cache_as_fact boolean		no ← yes	It disables avi session information to be cached as a fact.
aws_access_key string			Aws access key id. Field introduced in 18.2.3.
aws_bucket_id string			Aws bucket. Field introduced in 18.2.3.
aws_secret_access string			Aws secret access key. Field introduced in 18.2.3.
backup_file_prefix string			Prefix of the exported configuration file. Field introduced in 17.1.1.
backup_passphrase string			Passphrase of backup configuration.
controller string		Default: ""	IP address or hostname of the controller. The default value is the environment variable `AVI_CONTROLLER`.
maximum_backups_stored string			Rotate the backup files based on this count. Allowed values are 1-20. Default value when not specified in API or module is interpreted by Avi Controller as 4.
name string / required			Name of backup configuration.
password string		Default: ""	Password of Avi user in Avi controller. The default value is the environment variable `AVI_PASSWORD`.
remote_directory string			Directory at remote destination with write permission for ssh user.
remote_hostname string			Remote destination.
save_local boolean		no yes	Local backup.
ssh_user_ref string			Access credentials for remote destination. It is a reference to an object of type cloudconnectoruser.
state string		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 string			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.
upload_to_remote_host boolean		no yes	Remote backup.
upload_to_s3 boolean		no yes	Cloud backup. Field introduced in 18.2.3.
url string			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 string			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: Example to create BackupConfiguration object
  community.network.avi_backupconfiguration:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_backupconfiguration

Return Values

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

Key	Returned	Description
obj dictionary	success, changed	BackupConfiguration (api/backupconfiguration) object

Authors

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/avi_backupconfiguration_module.html