Avi BackupConfiguration Object API

##CLI## ``` - show backupconfiguration - configure backupconfiguration ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /backupconfiguration
  2. post /backupconfiguration
  3. delete /backupconfiguration/{uuid}
  4. get /backupconfiguration/{uuid}
  5. patch /backupconfiguration/{uuid}
  6. put /backupconfiguration/{uuid}
Up
get /backupconfiguration
(backupconfigurationGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

BackupConfigurationApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "backup_file_prefix" : "aeiou",
    "ssh_user_ref" : "aeiou",
    "backup_passphrase" : "aeiou",
    "save_local" : true,
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "remote_directory" : "aeiou",
    "remote_hostname" : "aeiou",
    "upload_to_remote_host" : true,
    "uuid" : "aeiou",
    "maximum_backups_stored" : 123,
    "url" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK BackupConfigurationApiResponse

401

log in failed

Up
post /backupconfiguration
(backupconfigurationPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — BackupConfiguration object creation

Return type

BackupConfiguration

Example data

Content-Type: application/json
{
  "backup_file_prefix" : "aeiou",
  "ssh_user_ref" : "aeiou",
  "backup_passphrase" : "aeiou",
  "save_local" : true,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "remote_directory" : "aeiou",
  "remote_hostname" : "aeiou",
  "upload_to_remote_host" : true,
  "uuid" : "aeiou",
  "maximum_backups_stored" : 123,
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK BackupConfiguration

401

log in failed

Up
delete /backupconfiguration/{uuid}
(backupconfigurationUuidDelete)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
get /backupconfiguration/{uuid}
(backupconfigurationUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

BackupConfiguration

Example data

Content-Type: application/json
{
  "backup_file_prefix" : "aeiou",
  "ssh_user_ref" : "aeiou",
  "backup_passphrase" : "aeiou",
  "save_local" : true,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "remote_directory" : "aeiou",
  "remote_hostname" : "aeiou",
  "upload_to_remote_host" : true,
  "uuid" : "aeiou",
  "maximum_backups_stored" : 123,
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK BackupConfiguration

401

log in failed

Up
patch /backupconfiguration/{uuid}
(backupconfigurationUuidPatch)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — BackupConfiguration object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

BackupConfiguration

Example data

Content-Type: application/json
{
  "backup_file_prefix" : "aeiou",
  "ssh_user_ref" : "aeiou",
  "backup_passphrase" : "aeiou",
  "save_local" : true,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "remote_directory" : "aeiou",
  "remote_hostname" : "aeiou",
  "upload_to_remote_host" : true,
  "uuid" : "aeiou",
  "maximum_backups_stored" : 123,
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK BackupConfiguration

401

log in failed

Up
put /backupconfiguration/{uuid}
(backupconfigurationUuidPut)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — BackupConfiguration object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

BackupConfiguration

Example data

Content-Type: application/json
{
  "backup_file_prefix" : "aeiou",
  "ssh_user_ref" : "aeiou",
  "backup_passphrase" : "aeiou",
  "save_local" : true,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "remote_directory" : "aeiou",
  "remote_hostname" : "aeiou",
  "upload_to_remote_host" : true,
  "uuid" : "aeiou",
  "maximum_backups_stored" : 123,
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK BackupConfiguration

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. BackupConfiguration
  2. BackupConfigurationApiResponse

BackupConfiguration Up

backup_file_prefix (optional)
String Prefix of the exported configuration file. Field introduced in 17.1.1.
backup_passphrase (optional)
String Passphrase of backup configuration.
maximum_backups_stored (optional)
Integer Rotate the backup files based on this count. Allowed values are 1-20. format: int32
name
String Name of backup configuration.
remote_directory (optional)
String Directory at remote destination with write permission for ssh user.
remote_hostname (optional)
String Remote Destination.
save_local (optional)
Boolean Local Backup.
ssh_user_ref (optional)
String Access Credentials for remote destination. It is a reference to an object of type CloudConnectorUser.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
upload_to_remote_host (optional)
Boolean Remote Backup.
url (optional)
String url
uuid (optional)
String Unique object identifier of the object.

BackupConfigurationApiResponse Up

count
Integer format: int32
results