community.general.avi_backupconfiguration (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

This module is used to configure BackupConfiguration object

more examples at U(https://github.com/avinetworks/devops)

Requirements

• avisdk

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Example to create BackupConfiguration object
  avi_backupconfiguration:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_backupconfiguration

Inputs

    
url:
    description:
    - Avi controller URL of the object.

name:
    description:
    - Name of backup configuration.
    required: true

uuid:
    description:
    - Unique object identifier of the object.

state:
    choices:
    - absent
    - present
    default: present
    description:
    - The state that should be applied on the entity.

tenant:
    default: admin
    description:
    - Name of tenant used for all Avi API calls and context of object.
    type: str

password:
    default: ''
    description:
    - Password of Avi user in Avi controller. The default value is the environment variable
      C(AVI_PASSWORD).
    type: str

username:
    default: ''
    description:
    - Username used for accessing Avi controller. The default value is the environment
      variable C(AVI_USERNAME).
    type: str

controller:
    default: ''
    description:
    - IP address or hostname of the controller. The default value is the environment variable
      C(AVI_CONTROLLER).
    type: str

save_local:
    description:
    - Local backup.
    type: bool

tenant_ref:
    description:
    - It is a reference to an object of type tenant.

api_context:
    description:
    - Avi API context that includes current session ID and CSRF Token.
    - This allows user to perform single login and re-use the session.
    type: dict

api_version:
    default: 16.4.4
    description:
    - Avi API version of to use for Avi API and objects.
    type: str

tenant_uuid:
    default: ''
    description:
    - UUID of tenant used for all Avi API calls and context of object.
    type: str

ssh_user_ref:
    description:
    - Access credentials for remote destination.
    - It is a reference to an object of type cloudconnectoruser.

upload_to_s3:
    description:
    - Cloud backup.
    - Field introduced in 18.2.3.
    type: bool

aws_bucket_id:
    description:
    - Aws bucket.
    - Field introduced in 18.2.3.

aws_access_key:
    description:
    - Aws access key id.
    - Field introduced in 18.2.3.

avi_credentials:
    description:
    - Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller
      login details.
    suboptions:
      api_version:
        default: 16.4.4
        description:
        - Avi controller version
      controller:
        description:
        - Avi controller IP or SQDN
      csrftoken:
        description:
        - Avi controller API csrftoken to reuse existing session with session id
      password:
        description:
        - Avi controller password
      port:
        description:
        - Avi controller port
      session_id:
        description:
        - Avi controller API session id to reuse existing session with csrftoken
      tenant:
        default: admin
        description:
        - Avi controller tenant
      tenant_uuid:
        description:
        - Avi controller tenant UUID
      timeout:
        default: 300
        description:
        - Avi controller request timeout
      token:
        description:
        - Avi controller API token
      username:
        description:
        - Avi controller username
    type: dict

remote_hostname:
    description:
    - Remote destination.

avi_api_patch_op:
    choices:
    - add
    - replace
    - delete
    description:
    - Patch operation to use when using avi_api_update_method as patch.

remote_directory:
    description:
    - Directory at remote destination with write permission for ssh user.

aws_secret_access:
    description:
    - Aws secret access key.
    - Field introduced in 18.2.3.

backup_passphrase:
    description:
    - Passphrase of backup configuration.

backup_file_prefix:
    description:
    - Prefix of the exported configuration file.
    - Field introduced in 17.1.1.

avi_api_update_method:
    choices:
    - put
    - patch
    default: put
    description:
    - Default method for object update is HTTP PUT.
    - Setting to patch will override that behavior to use HTTP PATCH.

upload_to_remote_host:
    description:
    - Remote backup.
    type: bool

maximum_backups_stored:
    description:
    - 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.

avi_disable_session_cache_as_fact:
    description:
    - It disables avi session information to be cached as a fact.
    type: bool

Outputs

obj:
  description: BackupConfiguration (api/backupconfiguration) object
  returned: success, changed
  type: dict