-
Notifications
You must be signed in to change notification settings - Fork 69
/
Copy pathBackupConfiguration.yaml
445 lines (440 loc) · 21.4 KB
/
BackupConfiguration.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
# Copyright 2021 VMware, Inc.
# SPDX-License-Identifier: Apache License 2.0
# GENERATED FILE - DO NOT EDIT THIS FILE
---
swagger: '2.0'
info:
version: '31.1.1'
title: Avi BackupConfiguration Object API
contact:
name: Avi Networks Inc.
url: https://avinetworks.com/contact-us
email: [email protected]
description: |
CLI
```
- show backupconfiguration <key>
- configure backupconfiguration <key>
```
securityDefinitions:
basicAuth:
type: basic
description: basic authentication
basePath: /api
paths:
/backupconfiguration:
get:
consumes:
- application/json
produces:
- application/json
parameters:
- name: name
in: query
description: object name
required: false
type: string
- name: refers_to
in: query
description: 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
type: string
- name: referred_by
in: query
description: 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
type: string
- name: fields
in: query
description: List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
type: string
- name: include_name
in: query
description: 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.
required: false
type: boolean
- name: skip_default
in: query
description: Default values are not set.
required: false
type: boolean
- name: join_subresources
in: query
description: It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
type: string
- name: X-Avi-Tenant
in: header
type: string
required: false
description: Avi Tenant Header
- name: X-Avi-Tenant-UUID
in: header
type: string
required: false
description: Avi Tenant Header UUID
- name: X-Avi-Version
in: header
type: string
required: true
description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
- name: X-CSRFToken
in: header
type: string
required: false
description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
security:
- basicAuth: []
responses:
200:
description: OK
schema:
$ref: "#/definitions/BackupConfigurationApiResponse"
401:
description: log in failed
post:
consumes:
- application/json
produces:
- application/json
parameters:
- name: X-Avi-Tenant
in: header
type: string
required: false
description: Avi Tenant Header
- name: X-Avi-Tenant-UUID
in: header
type: string
required: false
description: Avi Tenant Header UUID
- name: X-Avi-Version
in: header
type: string
required: true
description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
- name: X-CSRFToken
in: header
type: string
required: false
description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
- in: body
name: body
description: BackupConfiguration object creation
required: true
schema:
$ref: "#/definitions/BackupConfiguration"
security:
- basicAuth: []
responses:
200:
description: OK
schema:
$ref: "#/definitions/BackupConfiguration"
401:
description: log in failed
/backupconfiguration/{uuid}:
get:
consumes:
- application/json
produces:
- application/json
parameters:
- name: name
in: query
description: object name
required: false
type: string
- name: X-Avi-Tenant
in: header
type: string
required: false
description: Avi Tenant Header
- name: X-Avi-Tenant-UUID
in: header
type: string
required: false
description: Avi Tenant Header UUID
- name: X-Avi-Version
in: header
type: string
required: true
description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
- name: X-CSRFToken
in: header
type: string
required: false
description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
- name: uuid
in: path
description: UUID of the object to fetch
required: true
type: string
- name: fields
in: query
description: List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
type: string
- name: include_name
in: query
description: 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.
required: false
type: boolean
- name: skip_default
in: query
description: Default values are not set.
required: false
type: boolean
- name: join_subresources
in: query
description: It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
type: string
security:
- basicAuth: []
responses:
200:
description: OK
schema:
$ref: "#/definitions/BackupConfiguration"
401:
description: log in failed
put:
consumes:
- application/json
produces:
- application/json
parameters:
- in: query
name: name
description: object name
required: false
type: string
- in: header
name: X-Avi-Tenant
type: string
required: false
description: Avi Tenant Header
- name: X-Avi-Tenant-UUID
in: header
type: string
required: false
description: Avi Tenant Header UUID
- name: X-Avi-Version
in: header
type: string
required: true
description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
- name: X-CSRFToken
in: header
type: string
required: false
description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
- in: body
name: body
description: BackupConfiguration object creation
required: true
schema:
$ref: "#/definitions/BackupConfiguration"
- in: path
name: uuid
description: UUID of the object to fetch
required: true
type: string
security:
- basicAuth: []
responses:
200:
description: OK
schema:
$ref: "#/definitions/BackupConfiguration"
401:
description: log in failed
patch:
consumes:
- application/json
produces:
- application/json
parameters:
- in: query
name: name
description: object name
required: false
type: string
- in: header
name: X-Avi-Tenant
type: string
required: false
description: Avi Tenant Header
- name: X-Avi-Tenant-UUID
in: header
type: string
required: false
description: Avi Tenant Header UUID
- name: X-Avi-Version
in: header
type: string
required: true
description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
- name: X-CSRFToken
in: header
type: string
required: false
description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
- in: body
name: body
description: BackupConfiguration object creation
required: true
schema:
$ref: "#/definitions/BackupConfiguration"
- in: path
name: uuid
description: UUID of the object to fetch
required: true
type: string
security:
- basicAuth: []
responses:
200:
description: OK
schema:
$ref: "#/definitions/BackupConfiguration"
401:
description: log in failed
delete:
consumes:
- application/json
produces:
- application/json
parameters:
- in: query
name: name
description: object name
required: false
type: string
- in: header
name: X-Avi-Tenant
type: string
required: false
description: Avi Tenant Header
- name: X-Avi-Tenant-UUID
in: header
type: string
required: false
description: Avi Tenant Header UUID
- name: X-Avi-Version
in: header
type: string
required: true
description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
- name: X-CSRFToken
in: header
type: string
required: false
description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
- in: path
name: uuid
description: UUID of the object to fetch
required: true
type: string
security:
- basicAuth: []
responses:
204:
description: object deleted
schema:
type: string
404:
description: not found
definitions:
BackupConfiguration:
type: object
required:
- name
properties:
_last_modified:
description: "UNIX time since epoch in microseconds. Units(MICROSECONDS)."
readOnly: True
type: string
aws_access_key:
description: "AWS Access Key ID. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
aws_bucket_id:
description: "AWS bucket. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
aws_bucket_region:
description: "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."
type: string
aws_secret_access:
description: "AWS Secret Access Key. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
backup_file_prefix:
description: "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."
type: string
backup_passphrase:
description: "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."
type: string
configpb_attributes:
description: "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."
$ref: '#/definitions/ConfigPbAttributes'
maximum_backups_stored:
description: "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."
type: integer
default: 4
format: uint32
name:
description: "Name of backup configuration. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
remote_directory:
description: "Directory at remote destination with write permission for ssh user. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
remote_file_transfer_protocol:
description: "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."
type: string
default: "SCP"
remote_hostname:
description: "Remote Destination. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
s3_bucket_folder:
description: "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."
type: string
save_local:
description: "Local Backup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: boolean
ssh_user_ref:
description: "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."
type: string
tenant_ref:
description: " It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
upload_to_remote_host:
description: "Remote Backup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: boolean
upload_to_s3:
description: "Cloud Backup. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: boolean
url:
description: "url"
readOnly: True
type: string
uuid:
description: " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
BackupConfigurationApiResponse:
type: object
required:
- count
- results
properties:
count:
type: integer
format: int32
results:
type: array
items:
$ref: "#/definitions/BackupConfiguration"
next:
type: string
ConfigPbAttributes:
type: object
properties:
version:
description: "Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. 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."
type: integer
default: 1
format: uint32