Skip to content

Latest commit

 

History

History
612 lines (592 loc) · 25.6 KB

avi_backupconfiguration.rst

File metadata and controls

612 lines (592 loc) · 25.6 KB

vmware.alb.avi_backupconfiguration

Module for setup of BackupConfiguration Avi RESTful Object

Synopsis

Parameters

Parameter Choices/Defaults Comments
state
str
  • absent
  • present ←
- The state that should be applied on the entity.
avi_api_update_method
str
  • put ←
  • patch
- Default method for object update is HTTP PUT.
- Setting to patch will override that behavior to use HTTP PATCH.
avi_api_patch_op
str
  • add ←
  • replace
  • delete
  • remove
- Patch operation to use when using avi_api_update_method as patch.
avi_patch_path
str
- Patch path to use when using avi_api_update_method as patch.
avi_patch_value
str
- Patch value to use when using avi_api_update_method as patch.
aws_access_key
str
- Aws access key id.
- Field introduced in 18.2.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
aws_bucket_id
str
- Aws bucket.
- Field introduced in 18.2.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
aws_bucket_region
str
- The name of the aws region associated with the bucket.
- Field introduced in 21.1.5, 22.1.1, 22.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
aws_secret_access
str
- Aws secret access key.
- Field introduced in 18.2.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
backup_file_prefix
str
- Prefix of the exported configuration file.
- Field introduced in 17.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
backup_passphrase
str
- Default passphrase to encrypt sensitive fields for configuration export and periodic backup.
- The same passphrase must be provided to import the configuration.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
configpb_attributes
dict
- Protobuf versioning for config pbs.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
maximum_backups_stored
int
- Rotate the backup files based on this count.
- Allowed values are 1-20.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 4.
name
str
required: true
- Name of backup configuration.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
remote_directory
str
- Directory at remote destination with write permission for ssh user.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
remote_file_transfer_protocol
str
- Remote file transfer protocol type.
- Enum options - SCP, SFTP.
- Field introduced in 22.1.1.
- Allowed in enterprise edition with any value, basic edition(allowed values- scp,sftp), enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as SCP.
remote_hostname
str
- Remote destination.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
s3_bucket_folder
str
- The folder name in s3 bucket where backup will be stored.
- Field introduced in 30.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
save_local
bool
- Local backup.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
ssh_user_ref
str
- Access credentials for remote destination.
- It is a reference to an object of type cloudconnectoruser.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
tenant_ref
str
- It is a reference to an object of type tenant.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
upload_to_remote_host
bool
- Remote backup.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
upload_to_s3
bool
- Cloud backup.
- Field introduced in 18.2.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
url
str
- Avi controller URL of the object.
uuid
str
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.

Examples

- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  vars:
    avi_credentials:
      username: "avi_user"
      password: "avi_password"
      controller: "192.168.138.18"
      api_version: "21.1.1"
  tasks:
    - name: Example to create BackupConfiguration object
      avi_backupconfiguration:
        avi_credentials: "{{ avi_credentials }}"
        state: present
        name: sample_backupconfiguration

Authors