W3cubDocs

/Ansible

avi_backupconfiguration - Module for setup of BackupConfiguration Avi RESTful Object

New in version 2.4.

Synopsis

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_file_prefix
 no
Prefix of the exported configuration file.
Field introduced in 17.1.1.
backup_passphrase
 no
Passphrase of backup configuration.
controller
 no
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
maximum_backups_stored
 no
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
 yes
Name of backup configuration.
password
 no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
remote_directory
 no
Directory at remote destination with write permission for ssh user.
remote_hostname
 no
Remote destination.
save_local
 no
Local backup.
ssh_user_ref
 no
Access credentials for remote destination.
It is a reference to an object of type 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.
upload_to_remote_host
 no
Remote backup.
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 BackupConfiguration object
  avi_backupconfiguration:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_backupconfiguration

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
BackupConfiguration (api/backupconfiguration) 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.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/avi_backupconfiguration_module.html