You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

avi_backup - Module for setup of Backup Avi RESTful Object¶

New in version 2.4.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
- Status

Synopsis ¶

This module is used to configure Backup 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.
backup_config_ref	no			Backupconfiguration information. It is a reference to an object of type backupconfiguration.
controller	no			IP address or hostname of the controller. The default value is the environment variable `AVI_CONTROLLER`.
file_name	yes			The file name of backup.
local_file_url	no			Url to download the backup file.
password	no			Password of Avi user in Avi controller. The default value is the environment variable `AVI_PASSWORD`.
remote_file_url	no			Url to download the backup file.
scheduler_ref	no			Scheduler information. It is a reference to an object of type scheduler.
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.
timestamp	no			Unix timestamp of when the backup file is created.
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: Example to create Backup object
  avi_backup:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_backup

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	Backup (api/backup) 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.