Skip to content

Latest commit

 

History

History
350 lines (330 loc) · 13.4 KB

avi_backup.rst

File metadata and controls

350 lines (330 loc) · 13.4 KB

vmware.alb.avi_backup

Module for setup of Backup 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.
backup_config_ref
str
- Backupconfiguration information.
- It is a reference to an object of type backupconfiguration.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
file_name
str
required: true
- The file name of backup.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
local_file_url
str
- Url to download the backup file.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
remote_file_url
str
- Url to download the backup file.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
scheduler_ref
str
- Scheduler information.
- It is a reference to an object of type scheduler.
- 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.
timestamp
str
- Unix timestamp of when the backup file is created.
- Allowed in enterprise edition with any value, essentials, basic, 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 Backup object
      avi_backup:
        avi_credentials: "{{ avi_credentials }}"
        state: present
        name: sample_backup

Authors