Documentation

avi_backup – Module for setup of Backup Avi RESTful Object

New in version 2.4.

Synopsis

Requirements

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

  • avisdk

Parameters

Parameter Choices/Defaults Comments
api_context
-
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
-
Default:
16.4.4
Avi API version of to use for Avi API and objects.
avi_api_patch_op
-
added in 2.5
    Choices:
  • add
  • replace
  • delete
Patch operation to use when using avi_api_update_method as patch.
avi_api_update_method
-
added in 2.5
    Choices:
  • put ←
  • patch
Default method for object update is HTTP PUT.
Setting to patch will override that behavior to use HTTP PATCH.
avi_credentials
-
added in 2.5
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
backup_config_ref
-
Backupconfiguration information.
It is a reference to an object of type backupconfiguration.
controller
-
Default:
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
file_name
- / required
The file name of backup.
local_file_url
-
Url to download the backup file.
password
-
Default:
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
remote_file_url
-
Url to download the backup file.
scheduler_ref
-
Scheduler information.
It is a reference to an object of type scheduler.
state
-
    Choices:
  • absent
  • present ←
The state that should be applied on the entity.
tenant
-
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
-
Default:
UUID of tenant used for all Avi API calls and context of object.
timestamp
-
Unix timestamp of when the backup file is created.
url
-
Avi controller URL of the object.
username
-
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

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, the following are the fields unique to this module:

Key Returned Description
obj
dictionary
success, changed
Backup (api/backup) object



Status

Authors

Hint

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