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

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

Synopsis

Requirements

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

  • avisdk

Parameters

Parameter

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

Avi API version of to use for Avi API and objects.

Default: “16.4.4”

avi_api_patch_op

string

Patch operation to use when using avi_api_update_method as patch.

Choices:

  • add

  • replace

  • delete

avi_api_update_method

string

Default method for object update is HTTP PUT.

Setting to patch will override that behavior to use HTTP PATCH.

Choices:

  • put ← (default)

  • patch

avi_credentials

dictionary

Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.

api_version

string

Avi controller version

Default: “16.4.4”

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

Avi controller tenant

Default: “admin”

tenant_uuid

string

Avi controller tenant UUID

timeout

string

Avi controller request timeout

Default: 300

token

string

Avi controller API token

username

string

Avi controller username

avi_disable_session_cache_as_fact

boolean

It disables avi session information to be cached as a fact.

Choices:

  • no ← (default)

  • yes

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

IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.

Default: “”

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

Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.

Default: “”

remote_directory

string

Directory at remote destination with write permission for ssh user.

remote_hostname

string

Remote destination.

save_local

boolean

Local backup.

Choices:

  • no

  • yes

ssh_user_ref

string

Access credentials for remote destination.

It is a reference to an object of type cloudconnectoruser.

state

string

The state that should be applied on the entity.

Choices:

  • absent

  • present ← (default)

tenant

string

Name of tenant used for all Avi API calls and context of object.

Default: “admin”

tenant_ref

string

It is a reference to an object of type tenant.

tenant_uuid

string

UUID of tenant used for all Avi API calls and context of object.

Default: “”

upload_to_remote_host

boolean

Remote backup.

Choices:

  • no

  • yes

upload_to_s3

boolean

Cloud backup.

Field introduced in 18.2.3.

Choices:

  • no

  • yes

url

string

Avi controller URL of the object.

username

string

Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.

Default: “”

uuid

string

Unique object identifier of the object.

Notes

Note

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

Description

obj

dictionary

BackupConfiguration (api/backupconfiguration) object

Returned: success, changed

Authors