@itentialopensource/adapter-rubrik 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/.eslintignore +5 -0
  2. package/.eslintrc.js +18 -0
  3. package/.jshintrc +3 -0
  4. package/AUTH.md +51 -0
  5. package/BROKER.md +211 -0
  6. package/CALLS.md +213 -0
  7. package/CHANGELOG.md +9 -0
  8. package/CODE_OF_CONDUCT.md +43 -0
  9. package/CONTRIBUTING.md +13 -0
  10. package/ENHANCE.md +69 -0
  11. package/LICENSE +201 -0
  12. package/PROPERTIES.md +646 -0
  13. package/README.md +343 -0
  14. package/SUMMARY.md +9 -0
  15. package/SYSTEMINFO.md +20 -0
  16. package/TAB1.md +10 -0
  17. package/TAB2.md +321 -0
  18. package/TROUBLESHOOT.md +47 -0
  19. package/adapter.js +791 -0
  20. package/adapterBase.js +1452 -0
  21. package/changelogs/CHANGELOG.md +0 -0
  22. package/entities/.generic/action.json +214 -0
  23. package/entities/.generic/schema.json +28 -0
  24. package/entities/.system/action.json +50 -0
  25. package/entities/.system/mockdatafiles/getToken-default.json +3 -0
  26. package/entities/.system/mockdatafiles/healthcheck-default.json +3 -0
  27. package/entities/.system/schema.json +19 -0
  28. package/entities/.system/schemaTokenReq.json +53 -0
  29. package/entities/.system/schemaTokenResp.json +53 -0
  30. package/entities/SlaDomain/action.json +24 -0
  31. package/entities/SlaDomain/schema.json +41 -0
  32. package/error.json +190 -0
  33. package/metadata.json +82 -0
  34. package/package.json +81 -0
  35. package/pronghorn.json +1068 -0
  36. package/propertiesDecorators.json +14 -0
  37. package/propertiesSchema.json +1574 -0
  38. package/refs?service=git-upload-pack +0 -0
  39. package/report/adapter-openapi.json +1760 -0
  40. package/report/adapter-openapi.yaml +1175 -0
  41. package/report/adapterInfo.json +10 -0
  42. package/report/auto-adapter-openapi.json +71 -0
  43. package/report/creationReport.json +215 -0
  44. package/report/rubrik-openapi.json +1415 -0
  45. package/sampleProperties.json +257 -0
  46. package/test/integration/adapterTestBasicGet.js +83 -0
  47. package/test/integration/adapterTestConnectivity.js +118 -0
  48. package/test/integration/adapterTestIntegration.js +508 -0
  49. package/test/unit/adapterBaseTestUnit.js +1024 -0
  50. package/test/unit/adapterTestUnit.js +1567 -0
  51. package/utils/adapterInfo.js +206 -0
  52. package/utils/addAuth.js +94 -0
  53. package/utils/artifactize.js +146 -0
  54. package/utils/basicGet.js +50 -0
  55. package/utils/checkMigrate.js +63 -0
  56. package/utils/entitiesToDB.js +179 -0
  57. package/utils/findPath.js +74 -0
  58. package/utils/methodDocumentor.js +273 -0
  59. package/utils/modify.js +152 -0
  60. package/utils/packModificationScript.js +35 -0
  61. package/utils/patches2bundledDeps.js +90 -0
  62. package/utils/pre-commit.sh +32 -0
  63. package/utils/removeHooks.js +20 -0
  64. package/utils/setup.js +33 -0
  65. package/utils/taskMover.js +309 -0
  66. package/utils/tbScript.js +239 -0
  67. package/utils/tbUtils.js +489 -0
  68. package/utils/testRunner.js +298 -0
  69. package/utils/troubleshootingAdapter.js +193 -0
@@ -0,0 +1,1175 @@
1
+ openapi: 3.0.0
2
+ info:
3
+ title: Rubrik REST API
4
+ description: "\nCopyright © 2017-2021 Rubrik Inc. [Legal](#section/Legal)\n\n# Introduction\n\nWelcome to the Rubrik™ REST API documentation.\n\nThe Rubrik REST API provides a RESTful interface for working with Rubrik clusters and Rubrik Edge virtual appliances. The Rubrik REST API can be used to query, configure, and control nearly all of the operations of the Rubrik software.\n\nThrough authenticated and encrypted interaction with the Rubrik REST API server, perform any of the operations that are available through the Rubrik web UI and many bulk-type operations that might otherwise be difficult or impossible to perform.\n\nThis documentation provides reference information and examples of typical workflows for the Rubrik REST API. For more detailed information about working with Rubrik clusters and Rubrik Edge virtual appliances refer to the *Rubrik User Guide*.\n\nA quick way to become familiar with the Rubrik REST API, is to use the Rubrik REST API Explorer. [OpenAPI](#section/OpenAPI) describes this tool.\n\nRefer to the [changelog](#section/Changelog) to see information about changes within this version of the Rubrik REST API.\n\n# Changelog\n\nRevisions are listed with the most recent revision first.\n\n## Changes to V3 API in Rubrik Version 8.0.0\n### Feature additions/improvements\n * Added new field `frequencies` to `ArchivalSpec` to specify the snapshots to\n be archived based on the frequencies at which the snapshots are taken.\n * Added new field `cloudStorageTiers` to `BaseSnapshotSummary`, this field will\n have only those archival location entries where `cloudStorageTier` is\n applicable.\n\n## Changes to V3 API in Rubrik Version 7.0.0\n### Feature additions/improvements\n* Added `OracleDatabase` and `Mssql` as two new keys in\n `LogConfigMap` for storing Oracle and MSSQL log SLA\n configuration in the SLA definition.\n\n## Changes to V3 API in Rubrik Version 6.0.0\n### New features and improvements\n* Added new field `primaryClusterSlaVersion` and an optional field\n `replicationTargetSlaVersion` in `SlaDomainSummaryV2` to return sla version\n of primary cluster and replication target in\n get, list, create and edit sla rest api responses.\n* Added new optional parameter `should_apply_to_non_policy_snapshots`\n in `PATCH /sla_domain/{id}`.\n\n## Changes to V3 API in Rubrik Version 5.2.0\n### Deprecation\n### New features and improvements\n \n\n# OpenAPI\nThe Rubrik REST API specification conforms to the OpenAPI 2.0 Specification. Tools that work with the OpenAPI 2.0 Specification can be used with the Rubrik REST API specification.\n\nDevelopment releases (pre-1.0) of the Rubrik REST API specification made reference to 'swagger'. The previous release of the OpenAPI 2.0 Specification was named the Swagger 1.2 Specification.\n\nDownload the Rubrik REST API specification for your tools. [Download](./api-docs)\n\n## Rubrik REST API Explorer\nThe Rubrik REST API Explorer is a browser-based API client hosted by the Rubrik cluster. The Explorer has the Rubrik REST API specification built in. You can use the Explorer to try out Rubrik REST API calls and view the responses.\n\n**IMPORTANT:** The Explorer interacts with the Rubrik cluster through the API calls you make. Use care when making calls that modify or delete configurations and data.\n\nTo access the Rubrik REST API Explorer, click: [Rubrik REST API Explorer](./playground/)\n\n# SLA Domains\n\nRubrik clusters provide automated data management and protection through SLA Domains.\nAn SLA Domain defines the data management and protection policies for their assigned snappables (virtual machines, file systems, and applications).\n\nTo provide policy based management and protection of a snappable, add the snappable to an SLA Domain, or to multiple SLA Domains.\n## Patching SLA Domains\n\nTo patch the attributes of an SLA domain, send a PATCH request to\n[`/sla_domain/{id}`](#operation/patchSlaDomainV3). Include in the request body\nonly the attributes that needs to be patched.\n\n**Example:** Patching the daily backup SLA Domain\n\nPatch the SLA Domain that was created in [Creating SLA Domains](#section/SLA-Domains/Creating-SLA-Domains) to change the archival specifications.\n\n```bash\ncurl -X PATCH \\\n -d '{\n \"archivalSpecs\": [\n {\n \"locationId\": \"some-valid-archived-location-id\",\n \"archivalThreshold\": 14\n }\n ]}' \\\n \"https://$cluster_address/api/v3/sla_domain/$sla_id\"\n```\nThe response confirms the new attribute and also includes the other\nattributes that were not changed.\n\n```bash\n{\n \"patchedSlaDomainSummary\" : [\n {\n id\": \"$sla_id\",\n \"name\": \"Daily SLA\",\n \"primaryClusterSlaVersion\": 2,\n \"frequencies\": [\n \"daily\": {\n \"frequency\": 1,\n \"retention\": 7\n }\n ],\n \"archivalSpecs\": [\n {\n \"locationId\": \"some-valid-archived-location-id\",\n \"archivalThreshold\": 14\n }\n ],\n \"allowedBackupWindows\": [],\n \"firstFullAllowedBackupWindows\": []\n }\n ],\n \"batchAsyncRequestStatus\" : [\n {\n \"responses\": [\n {\n \"id\": \"string\",\n \"status\": \"string\",\n \"progress\": 0,\n \"startTime\": \"2019-10-29T22:11:35.256Z\",\n \"endTime\": \"2019-10-29T22:11:35.256Z\",\n \"nodeId\": \"string\",\n \"error\": {\n \"message\": \"string\"\n },\n \"links\": [\n {\n \"href\": \"string\",\n \"rel\": \"string\"\n }\n ]\n }\n ]\n }\n ]\n}\n```\n\nThe Rubrik REST API server responds with HTTP response code 200 and the\nresponse body containing the details of the async request.\n\n# Legal\n\n## Copyright\n\nRubrik REST API - Copyright © 2017-2021 Rubrik Inc.\nAll rights reserved.\n\nThis documentation may be used free of charge. Selling without prior written consent is prohibited.\nObtain permission before redistributing. In all cases, this copyright notice and disclaimer must remain\nintact.\n\n\n## Disclaimer\n\nTHE CONTENTS OF THIS DOCUMENTATION ARE PROVIDED \"AS IS,\" AND COPYRIGHT HOLDERS MAKE NO\nREPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,\nWARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, OR\nTITLE; THAT THE CONTENTS OF THE DOCUMENTATION ARE SUITABLE FOR ANY PURPOSE; THAT THE\nIMPLEMENTATION OF SUCH CONTENTS WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS,\nTRADEMARKS OR OTHER RIGHTS.\nCOPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL\nDAMAGES ARISING OUT OF ANY USE OF THE DOCUMENTATION OR THE PERFORMANCE OR IMPLEMENTATION OF\nTHE CONTENTS THEREOF.\n\n## Trademarks\n\nRubrik, the Rubrik logo, Rubrik Envision, and Rubrik Edge are trademarks or registered trademarks of Rubrik, Inc. in the U.S. and/or other countries. All other trademarks are the property of their respective owners.\n"
5
+ contact: {}
6
+ version: '3'
7
+ servers:
8
+ - url: https://{defaultHost}
9
+ variables:
10
+ defaultHost:
11
+ default: www.example.com/api/v3
12
+ paths:
13
+ /sla_domain/{id}:
14
+ patch:
15
+ tags:
16
+ - /sla_domain
17
+ summary: patchSlaDomainV3
18
+ description: Update the properties of an SLA Domain.
19
+ operationId: patchSlaDomainV3
20
+ parameters:
21
+ - name: id
22
+ in: path
23
+ description: The ID of the SLA Domain.
24
+ required: true
25
+ style: simple
26
+ schema:
27
+ type: string
28
+ - name: should_apply_to_non_policy_snapshots
29
+ in: query
30
+ description: Determines if the new configuration value keeps existing, non-policy snapshots of data sources retained by this SLA Domain. The value is 'false' by default. This configuration value takes effect only if 'should_apply_to_existing_snapshots' is set to true.
31
+ style: form
32
+ explode: true
33
+ schema:
34
+ type: boolean
35
+ default: false
36
+ - name: should_apply_to_existing_snapshots
37
+ in: query
38
+ description: Determines whether the new configuration retains existing snapshots of data sources that are currently retained by this SLA Domain.
39
+ required: true
40
+ style: form
41
+ explode: true
42
+ schema:
43
+ type: boolean
44
+ requestBody:
45
+ description: Object containing the fields to edit for SLA Domain. The SLA Domain accepts two backup windows, one for a regular backup or snapshot and one for the first full backup or snapshot. Specify times using the Rubrik cluster timezone. Remote SLA Domains only support edits to the archival specification.
46
+ content:
47
+ application/json:
48
+ schema:
49
+ allOf:
50
+ - $ref: '#/components/schemas/SlaDomainPatchDefinitionV2'
51
+ - description: Object containing the fields to edit for SLA Domain. The SLA Domain accepts two backup windows, one for a regular backup or snapshot and one for the first full backup or snapshot. Specify times using the Rubrik cluster timezone. Remote SLA Domains only support edits to the archival specification.
52
+ required: true
53
+ responses:
54
+ '202':
55
+ description: Object containing updated SLA Domain along with queued asynchronous requests for assigning the patched SLA domain to affected objects.
56
+ headers: {}
57
+ content:
58
+ application/json:
59
+ schema:
60
+ $ref: '#/components/schemas/SlaDomainUpdateSummary'
61
+ deprecated: false
62
+ components:
63
+ schemas:
64
+ NutanixVmSlaObjectCount:
65
+ title: NutanixVmSlaObjectCount
66
+ type: object
67
+ properties:
68
+ numNutanixVms:
69
+ type: integer
70
+ description: The number of Nutanix virtual machines protected under this SLA domain.
71
+ format: int32
72
+ CloudStorageColdTier:
73
+ title: CloudStorageColdTier
74
+ enum:
75
+ - AzureArchive
76
+ - Glacier
77
+ - GlacierDeepArchive
78
+ type: string
79
+ description: The set of storage classes that support Cold tiering during smart or instant tiering.
80
+ CloudStorageRehydrationSpeed:
81
+ title: CloudStorageRehydrationSpeed
82
+ enum:
83
+ - AwsBulk
84
+ - AwsStandard
85
+ - AwsExpedited
86
+ - AzureStandard
87
+ - AzureHighPriority
88
+ type: string
89
+ description: Specifies the retrieval speed option when retrieving data from the cold storage tier to the hot storage tier for restore purposes. Rubrik cannot directly restore data from the cold storage tier and the data must be first retrieved into the hot storage tier. This is applicable only for AWS S3 and Azure archival locations. For AWS, three speed options are supported -- AwsExpedited, AwsStandard, and AwsBulk. AwsBulk is the cheapest and slowest. AwsExpedited is the fastest and most expensive. AwsStandard is the recommended default value. For Azure, the options are AzureStandard and AzureHighPriority. AzureHighPriority is more expensive and faster than AzureStandard. The default value is AzureStandard.
90
+ AwsEc2InstanceSlaObjectCount:
91
+ title: AwsEc2InstanceSlaObjectCount
92
+ type: object
93
+ properties:
94
+ numEc2Instances:
95
+ type: integer
96
+ description: The number of EC2 instances protected under this SLA Domain.
97
+ format: int32
98
+ HypervVmSlaObjectCount:
99
+ title: HypervVmSlaObjectCount
100
+ type: object
101
+ properties:
102
+ numHypervVms:
103
+ type: integer
104
+ description: The number of Hyper-V virtual machines protected under this SLA domain.
105
+ format: int32
106
+ Link:
107
+ title: Link
108
+ required:
109
+ - href
110
+ - rel
111
+ type: object
112
+ properties:
113
+ href:
114
+ type: string
115
+ description: The destination of the link.
116
+ rel:
117
+ type: string
118
+ description: The relation of the destination of this link to the current resource.
119
+ ManagedVolumeSlaObjectCount:
120
+ title: ManagedVolumeSlaObjectCount
121
+ type: object
122
+ properties:
123
+ numManagedVolumes:
124
+ type: integer
125
+ description: The number of Managed volumes protected under this SLA Domain.
126
+ format: int32
127
+ MssqlDbSlaObjectCount:
128
+ title: MssqlDbSlaObjectCount
129
+ type: object
130
+ properties:
131
+ numDbs:
132
+ type: integer
133
+ description: The number of actively protected databases under this SLA domain.
134
+ format: int32
135
+ AdvancedUiConfigAttributes:
136
+ title: AdvancedUiConfigAttributes
137
+ required:
138
+ - timeUnit
139
+ - retentionType
140
+ type: object
141
+ properties:
142
+ timeUnit:
143
+ $ref: '#/components/schemas/SlaTimeUnit'
144
+ retentionType:
145
+ $ref: '#/components/schemas/SlaTimeUnit'
146
+ ArchivalSpecV2:
147
+ title: ArchivalSpecV2
148
+ required:
149
+ - archivalThreshold
150
+ type: object
151
+ properties:
152
+ locationId:
153
+ type: string
154
+ locationName:
155
+ type: string
156
+ polarisManagedId:
157
+ type: string
158
+ description: The Polaris managed ID of an archival location. At least one of the parameters locationId and polarisManagedId must be defined to correctly refer to an archival location.
159
+ archivalThreshold:
160
+ type: integer
161
+ description: Amount of time, in seconds, after which the snapshot must be uploaded.
162
+ format: int64
163
+ frequencies:
164
+ type: array
165
+ items:
166
+ $ref: '#/components/schemas/SlaTimeUnit'
167
+ description: Frequencies for identifying snapshots to be archived. If frequencies are not specified, snapshots taken at all frequencies are archived as per the SLA Domain configuration.
168
+ archivalTieringSpec:
169
+ $ref: '#/components/schemas/ArchivalTieringSpec'
170
+ isPassthroughSupported:
171
+ type: boolean
172
+ description: Boolean value that indicates if the archival location type supports direct archive backups.
173
+ ArchivalTieringSpec:
174
+ title: ArchivalTieringSpec
175
+ required:
176
+ - isInstantTieringEnabled
177
+ type: object
178
+ properties:
179
+ isInstantTieringEnabled:
180
+ type: boolean
181
+ description: A Boolean value that determines whether to immediately tier uploaded snapshots to cold storage. When this value is 'true,' uploaded snapshots are immediately tiered to cold storage. When this value is 'false,' snapshots are marked as eligible for tiering to cold storage after their time on the archival location exceeds the configured minimum accessible duration.
182
+ minAccessibleDurationInSeconds:
183
+ type: integer
184
+ description: Specifies an interval in seconds. Uploaded snapshots are accessible for instant recovery for the duration of the specified interval. This value is ignored when Instant Tiering is enabled.
185
+ format: int64
186
+ coldStorageClass:
187
+ $ref: '#/components/schemas/CloudStorageColdTier'
188
+ shouldTierExistingSnapshots:
189
+ type: boolean
190
+ description: Indicates if existing snapshots for all objects protected by the SLA should be tiered. If not specified, this defaults to false. Only the snapshots that exist in the archival location associated with the SLA will be tiered.
191
+ BackupWindow:
192
+ title: BackupWindow
193
+ required:
194
+ - startTimeAttributes
195
+ - durationInHours
196
+ type: object
197
+ properties:
198
+ startTimeAttributes:
199
+ $ref: '#/components/schemas/SlaStartTimeAttributes'
200
+ durationInHours:
201
+ type: integer
202
+ format: int32
203
+ BulkSlaDomainAssignmentInfo:
204
+ title: BulkSlaDomainAssignmentInfo
205
+ required:
206
+ - assignmentInfos
207
+ type: object
208
+ properties:
209
+ assignmentInfos:
210
+ type: array
211
+ items:
212
+ $ref: '#/components/schemas/PerSlaDomainAssignmentInfo'
213
+ description: ''
214
+ ConfiguredSlaType:
215
+ title: ConfiguredSlaType
216
+ enum:
217
+ - ProtectionSla
218
+ - RetentionSla
219
+ type: string
220
+ description: Specifies whether the SLA Domain is used for protection or retention.
221
+ Db2DeltaFrequency:
222
+ title: Db2DeltaFrequency
223
+ required:
224
+ - frequency
225
+ - timeUnit
226
+ type: object
227
+ properties:
228
+ frequency:
229
+ type: integer
230
+ description: Frequency value for delta backup of Db2 databases.
231
+ format: int32
232
+ timeUnit:
233
+ $ref: '#/components/schemas/Db2DeltaFrequencyType'
234
+ Db2DeltaFrequencyType:
235
+ title: Db2DeltaFrequencyType
236
+ enum:
237
+ - Minutely
238
+ - Hourly
239
+ - Daily
240
+ type: string
241
+ description: Units for delta backup frequency.
242
+ Db2IncrementalFrequency:
243
+ title: Db2IncrementalFrequency
244
+ required:
245
+ - frequency
246
+ - timeUnit
247
+ type: object
248
+ properties:
249
+ frequency:
250
+ type: integer
251
+ description: Frequency value for incremental backup of Db2 databases.
252
+ format: int32
253
+ timeUnit:
254
+ $ref: '#/components/schemas/Db2IncrementalFrequencyType'
255
+ Db2IncrementalFrequencyType:
256
+ title: Db2IncrementalFrequencyType
257
+ enum:
258
+ - Minutely
259
+ - Hourly
260
+ - Daily
261
+ type: string
262
+ description: Units for incremental backup frequency.
263
+ DeltaFrequencyMap:
264
+ title: DeltaFrequencyMap
265
+ type: object
266
+ properties:
267
+ Db2Database:
268
+ $ref: '#/components/schemas/Db2DeltaFrequency'
269
+ DifferentialFrequencyMap:
270
+ title: DifferentialFrequencyMap
271
+ type: object
272
+ properties:
273
+ SapHanaDatabase:
274
+ $ref: '#/components/schemas/SapHanaDifferentialFrequency'
275
+ EffectiveSlaHolder:
276
+ title: EffectiveSlaHolder
277
+ required:
278
+ - effectiveSlaDomainId
279
+ - effectiveSlaDomainName
280
+ type: object
281
+ properties:
282
+ effectiveSlaDomainId:
283
+ type: string
284
+ description: The ID of the SLA Domain that controls the protection of the Rubrik object.
285
+ effectiveSlaDomainName:
286
+ type: string
287
+ description: The name of the SLA Domain that controls the protection of the Rubrik object.
288
+ isEffectiveSlaDomainRetentionLocked:
289
+ type: boolean
290
+ description: Indicates whether the effective SLA Domain is Retention Locked. When this value is 'true', the effective SLA domain is a Retention Lock SLA Domain.
291
+ effectiveSlaDomainPolarisManagedId:
292
+ type: string
293
+ description: Optional. This field contains the managed ID of of the Polaris-managed effective SLA Domain.
294
+ effectiveSlaSourceObjectId:
295
+ type: string
296
+ description: The ID of the parent of the Rubrik object from which the SLA Domain that controls the protection of Rubrik object is inherited.
297
+ effectiveSlaSourceObjectName:
298
+ type: string
299
+ description: The name of the parent of the Rubrik object from which the SLA Domain that controls the protection of Rubrik object is inherited.
300
+ ExistingSnapshotRetention:
301
+ title: ExistingSnapshotRetention
302
+ enum:
303
+ - RetainSnapshots
304
+ - KeepForever
305
+ - ExpireImmediately
306
+ type: string
307
+ description: Specifies the retention policy to apply to existing snapshots when unprotecting an object.
308
+ FrequencyConfig:
309
+ title: FrequencyConfig
310
+ required:
311
+ - frequency
312
+ - retention
313
+ type: object
314
+ properties:
315
+ frequency:
316
+ type: integer
317
+ format: int32
318
+ retention:
319
+ type: integer
320
+ format: int32
321
+ IncrementalFrequencyMap:
322
+ title: IncrementalFrequencyMap
323
+ type: object
324
+ properties:
325
+ SapHanaDatabase:
326
+ $ref: '#/components/schemas/SapHanaIncrementalFrequency'
327
+ Db2Database:
328
+ $ref: '#/components/schemas/Db2IncrementalFrequency'
329
+ LogConfigMap:
330
+ title: LogConfigMap
331
+ type: object
332
+ properties:
333
+ SapHanaDatabase:
334
+ $ref: '#/components/schemas/SlaLogConfiguration'
335
+ VmwareVirtualMachine:
336
+ $ref: '#/components/schemas/SlaLogConfiguration'
337
+ OracleDatabase:
338
+ $ref: '#/components/schemas/OracleSlaLogConfiguration'
339
+ Mssql:
340
+ $ref: '#/components/schemas/SlaLogConfiguration'
341
+ Db2Database:
342
+ $ref: '#/components/schemas/SlaLogConfiguration'
343
+ LogFrequencyType:
344
+ title: LogFrequencyType
345
+ enum:
346
+ - Continuous
347
+ - Minute
348
+ type: string
349
+ description: Defines the frequency of taking log backups.
350
+ ManagedObjectPendingSlaInfo:
351
+ title: ManagedObjectPendingSlaInfo
352
+ required:
353
+ - objectId
354
+ - pendingSlaDomainId
355
+ - pendingSlaDomainName
356
+ type: object
357
+ properties:
358
+ objectId:
359
+ type: string
360
+ description: Managed ID of the object.
361
+ pendingSlaDomainId:
362
+ type: string
363
+ pendingSlaDomainName:
364
+ type: string
365
+ isPendingSlaDomainRetentionLocked:
366
+ type: boolean
367
+ MissedSnapshotDayOfTimeUnit:
368
+ title: MissedSnapshotDayOfTimeUnit
369
+ enum:
370
+ - Monday
371
+ - Tuesday
372
+ - Wednesday
373
+ - Thursday
374
+ - Friday
375
+ - Saturday
376
+ - Sunday
377
+ - FirstDay
378
+ - Fifteenth
379
+ - LastDay
380
+ type: string
381
+ description: Units for missed snapshot dayOfTime.
382
+ MonthlyConfig:
383
+ title: MonthlyConfig
384
+ required:
385
+ - frequency
386
+ - retention
387
+ - dayOfMonth
388
+ type: object
389
+ properties:
390
+ frequency:
391
+ type: integer
392
+ format: int32
393
+ retention:
394
+ type: integer
395
+ format: int32
396
+ dayOfMonth:
397
+ $ref: '#/components/schemas/SlaDayOfMonth'
398
+ OracleSlaLogConfiguration:
399
+ title: OracleSlaLogConfiguration
400
+ type: object
401
+ properties:
402
+ slaLogFrequencyConfig:
403
+ $ref: '#/components/schemas/SlaLogFrequencyConfig'
404
+ hostLogRetentionInMinutes:
405
+ type: integer
406
+ description: Specifies an interval in minutes, which governs the retention of redo logs. The next log snapshot job deletes archived Oracle redo log files whose 'nextTime' field specifies a time that occurs before the current time minus the specifed number of minutes. To immediately delete archived redo log files regardless of age, specify an interval of -1. To preserve all archived redo log files, specify an interval of -2.
407
+ format: int32
408
+ PerSlaDomainAssignmentInfo:
409
+ title: PerSlaDomainAssignmentInfo
410
+ required:
411
+ - slaDomainId
412
+ - assignmentInfo
413
+ type: object
414
+ properties:
415
+ slaDomainId:
416
+ type: string
417
+ assignmentInfo:
418
+ $ref: '#/components/schemas/SlaDomainAssignmentInfo'
419
+ QuarterlyConfig:
420
+ title: QuarterlyConfig
421
+ required:
422
+ - frequency
423
+ - retention
424
+ - firstQuarterStartMonth
425
+ - dayOfQuarter
426
+ type: object
427
+ properties:
428
+ frequency:
429
+ type: integer
430
+ format: int32
431
+ retention:
432
+ type: integer
433
+ format: int32
434
+ firstQuarterStartMonth:
435
+ $ref: '#/components/schemas/SlaMonth'
436
+ dayOfQuarter:
437
+ $ref: '#/components/schemas/SlaDayOfQuarter'
438
+ ReplicationSpecV2:
439
+ title: ReplicationSpecV2
440
+ required:
441
+ - retentionLimit
442
+ type: object
443
+ properties:
444
+ locationId:
445
+ type: string
446
+ locationName:
447
+ type: string
448
+ polarisManagedId:
449
+ type: string
450
+ description: This refers to the Polaris managed ID of an archival location. At least one of the params locationId and polarisManagedId should be defined to correctly refer to an archival location. If locationId is provided, then polarisManagedId will be ignored.
451
+ retentionLimit:
452
+ type: integer
453
+ description: Specifies a time duration in seconds. Snapshots will be retained on the replication target location until the duration has passed.
454
+ format: int64
455
+ logRetentionLimit:
456
+ type: integer
457
+ description: Specifies an interval in seconds. Logs are retained at the replication location until the specified interval expires.
458
+ format: int64
459
+ replicationType:
460
+ $ref: '#/components/schemas/ReplicationType'
461
+ ReplicationType:
462
+ title: ReplicationType
463
+ enum:
464
+ - REPLICATION_TO_CLUSTER
465
+ - REPLICATION_TO_CLOUD_LOCATION
466
+ type: string
467
+ description: The type of replication for an SLA Domain.
468
+ SapHanaDifferentialFrequency:
469
+ title: SapHanaDifferentialFrequency
470
+ required:
471
+ - frequency
472
+ - timeUnit
473
+ type: object
474
+ properties:
475
+ frequency:
476
+ type: integer
477
+ description: Frequency value for differential backup of SAP HANA databases.
478
+ format: int32
479
+ timeUnit:
480
+ $ref: '#/components/schemas/SapHanaDifferentialFrequencyType'
481
+ SapHanaDifferentialFrequencyType:
482
+ title: SapHanaDifferentialFrequencyType
483
+ enum:
484
+ - Minutely
485
+ - Hourly
486
+ - Daily
487
+ type: string
488
+ description: Units for differential backup frequency.
489
+ SapHanaIncrementalFrequency:
490
+ title: SapHanaIncrementalFrequency
491
+ required:
492
+ - frequency
493
+ - timeUnit
494
+ type: object
495
+ properties:
496
+ frequency:
497
+ type: integer
498
+ description: Frequency value for incremental backup of SAP HANA databases.
499
+ format: int32
500
+ timeUnit:
501
+ $ref: '#/components/schemas/Db2IncrementalFrequencyType'
502
+ SapHanaIncrementalFrequencyType:
503
+ title: SapHanaIncrementalFrequencyType
504
+ enum:
505
+ - Minutely
506
+ - Hourly
507
+ - Daily
508
+ type: string
509
+ description: Units for incremental backup frequency.
510
+ SlaAssignable:
511
+ title: SlaAssignable
512
+ required:
513
+ - id
514
+ - name
515
+ - configuredSlaDomainId
516
+ - configuredSlaDomainName
517
+ - primaryClusterId
518
+ type: object
519
+ properties:
520
+ id:
521
+ type: string
522
+ description: The ID of the Rubrik object.
523
+ name:
524
+ type: string
525
+ description: The name of the Rubrik object.
526
+ configuredSlaDomainId:
527
+ type: string
528
+ description: The ID of the SLA Domain configured directly on the Rubrik object.
529
+ configuredSlaDomainName:
530
+ type: string
531
+ description: The name of the SLA Domain configured directly on the Rubrik object.
532
+ configuredSlaDomainType:
533
+ $ref: '#/components/schemas/ConfiguredSlaType'
534
+ primaryClusterId:
535
+ type: string
536
+ description: The ID of the cluster that manages the Rubrik object.
537
+ isConfiguredSlaDomainRetentionLocked:
538
+ type: boolean
539
+ description: Indicates whether the configured SLA Domain is Retention Locked. When this value is 'true', the configured SLA Domain is a Retention Lock SLA Domain.
540
+ slaLastUpdateTime:
541
+ type: string
542
+ description: The UTC time when the SLA Domain was last updated.
543
+ format: date-time
544
+ SlaDayOfMonth:
545
+ title: SlaDayOfMonth
546
+ enum:
547
+ - FirstDay
548
+ - Fifteenth
549
+ - LastDay
550
+ type: string
551
+ description: The day of the month when snapshot will be taken.
552
+ SlaDayOfQuarter:
553
+ title: SlaDayOfQuarter
554
+ enum:
555
+ - FirstDay
556
+ - LastDay
557
+ type: string
558
+ description: The day of the quarter when snapshot will be taken.
559
+ SlaDayOfWeek:
560
+ title: SlaDayOfWeek
561
+ enum:
562
+ - Monday
563
+ - Tuesday
564
+ - Wednesday
565
+ - Thursday
566
+ - Friday
567
+ - Saturday
568
+ - Sunday
569
+ type: string
570
+ description: The day of the week when snapshot will be taken.
571
+ SlaDayOfYear:
572
+ title: SlaDayOfYear
573
+ enum:
574
+ - FirstDay
575
+ - LastDay
576
+ type: string
577
+ description: The day of the year when snapshot will be taken.
578
+ SlaDomainAssignmentInfo:
579
+ title: SlaDomainAssignmentInfo
580
+ required:
581
+ - managedIds
582
+ type: object
583
+ properties:
584
+ managedIds:
585
+ type: array
586
+ items:
587
+ type: string
588
+ description: ''
589
+ existingSnapshotRetention:
590
+ $ref: '#/components/schemas/ExistingSnapshotRetention'
591
+ shouldApplyToExistingSnapshots:
592
+ type: boolean
593
+ description: A Boolean that specifies whether to retain existing snapshots of assigned objects with the configuration of a specified SLA Domain. The default value is 'true'. If objects are unprotected, the retention of existing snapshots will be determined by the value of parameter 'existingSnapshotRetention'. This field should be kept empty in such cases. When an SLA Domain assignment is cleared from an object, the retention strategy described in this field is used only when the object can inherit a protection SLA Domain from an ancestor object.
594
+ shouldApplyToNonPolicySnapshots:
595
+ type: boolean
596
+ description: A Boolean which if set to true specifies that the retention changes corresponding to the new SLA should be applied to non-policy snapshots in addition to existing policy based snapshots.
597
+ SlaDomainPatchDefinitionV2:
598
+ title: SlaDomainPatchDefinitionV2
599
+ type: object
600
+ properties:
601
+ name:
602
+ type: string
603
+ frequencies:
604
+ $ref: '#/components/schemas/SlaFrequencyV2'
605
+ logConfig:
606
+ $ref: '#/components/schemas/SlaLogConfiguration'
607
+ allowedBackupWindows:
608
+ type: array
609
+ items:
610
+ $ref: '#/components/schemas/BackupWindow'
611
+ description: ''
612
+ firstFullAllowedBackupWindows:
613
+ type: array
614
+ items:
615
+ $ref: '#/components/schemas/BackupWindow'
616
+ description: ''
617
+ localRetentionLimit:
618
+ type: integer
619
+ format: int64
620
+ archivalSpecs:
621
+ type: array
622
+ items:
623
+ $ref: '#/components/schemas/ArchivalSpecV2'
624
+ description: ''
625
+ replicationSpecs:
626
+ type: array
627
+ items:
628
+ $ref: '#/components/schemas/ReplicationSpecV2'
629
+ description: ''
630
+ showAdvancedUi:
631
+ type: boolean
632
+ advancedUiConfig:
633
+ type: array
634
+ items:
635
+ $ref: '#/components/schemas/AdvancedUiConfigAttributes'
636
+ description: ''
637
+ isRetentionLocked:
638
+ type: boolean
639
+ description: Boolean value that identifies a Retention Lock SLA Domain. Value is true when an SLA Domain is Retention Locked and false when it is not.
640
+ incrementalFrequency:
641
+ $ref: '#/components/schemas/IncrementalFrequencyMap'
642
+ differentialFrequency:
643
+ $ref: '#/components/schemas/DifferentialFrequencyMap'
644
+ deltaFrequency:
645
+ $ref: '#/components/schemas/DeltaFrequencyMap'
646
+ logConfigs:
647
+ $ref: '#/components/schemas/LogConfigMap'
648
+ SlaDomainSummaryV2:
649
+ title: SlaDomainSummaryV2
650
+ required:
651
+ - id
652
+ - primaryClusterId
653
+ - name
654
+ - primaryClusterSlaVersion
655
+ - frequencies
656
+ - allowedBackupWindows
657
+ - firstFullAllowedBackupWindows
658
+ - maxLocalRetentionLimit
659
+ - isDefault
660
+ - showAdvancedUi
661
+ - advancedUiConfig
662
+ type: object
663
+ properties:
664
+ numNutanixVms:
665
+ type: integer
666
+ description: The number of Nutanix virtual machines protected under this SLA domain.
667
+ format: int32
668
+ numEc2Instances:
669
+ type: integer
670
+ description: The number of EC2 instances protected under this SLA Domain.
671
+ format: int32
672
+ numHypervVms:
673
+ type: integer
674
+ description: The number of Hyper-V virtual machines protected under this SLA domain.
675
+ format: int32
676
+ numManagedVolumes:
677
+ type: integer
678
+ description: The number of Managed volumes protected under this SLA Domain.
679
+ format: int32
680
+ numDbs:
681
+ type: integer
682
+ description: The number of actively protected databases under this SLA domain.
683
+ format: int32
684
+ numVcdVapps:
685
+ type: integer
686
+ description: The number of vApps protected under this SLA Domain.
687
+ format: int32
688
+ numOracleDbs:
689
+ type: integer
690
+ description: The number of actively protected oracle databases under this SLA Domain.
691
+ format: int32
692
+ numFilesets:
693
+ type: integer
694
+ description: The number of filesets protected under this SLA Domain.
695
+ format: int32
696
+ numStorageArrayVolumeGroups:
697
+ type: integer
698
+ description: The number of storage array volume groups protected under this SLA Domain.
699
+ format: int32
700
+ numWindowsVolumeGroups:
701
+ type: integer
702
+ description: The number of Windows volume groups protected under this SLA Domain.
703
+ format: int32
704
+ numLinuxHosts:
705
+ type: integer
706
+ description: The number of Linux servers with filesets protected under this SLA Domain.
707
+ format: int32
708
+ numShares:
709
+ type: integer
710
+ description: The number of shares protected under this SLA Domain.
711
+ format: int32
712
+ numWindowsHosts:
713
+ type: integer
714
+ description: The number of Windows servers with filesets protected under this SLA Domain.
715
+ format: int32
716
+ numVms:
717
+ type: integer
718
+ format: int32
719
+ numProtectedObjects:
720
+ type: integer
721
+ description: The total number of protected ojects under this SLA Domain.
722
+ format: int32
723
+ id:
724
+ type: string
725
+ primaryClusterId:
726
+ type: string
727
+ name:
728
+ type: string
729
+ primaryClusterSlaVersion:
730
+ type: integer
731
+ description: Specifies the version of the SLA that is incremented for every user SLA Domain edit. For remote SLA Domains, this specifies the version of SLA Domain used by the source cluster.
732
+ format: int32
733
+ replicationTargetSlaVersion:
734
+ type: integer
735
+ description: Specifies the version of the remote SLA Domain that is incremented for every user SLA Domain on the replication target.
736
+ format: int32
737
+ polarisManagedId:
738
+ type: string
739
+ description: Optional field containing Polaris managed ids of the Polaris managed SLAs. This field will be set only if the SLA is Polaris managed.
740
+ frequencies:
741
+ $ref: '#/components/schemas/SlaFrequencyV2'
742
+ logConfig:
743
+ $ref: '#/components/schemas/SlaLogConfiguration'
744
+ allowedBackupWindows:
745
+ type: array
746
+ items:
747
+ $ref: '#/components/schemas/BackupWindow'
748
+ description: ''
749
+ firstFullAllowedBackupWindows:
750
+ type: array
751
+ items:
752
+ $ref: '#/components/schemas/BackupWindow'
753
+ description: ''
754
+ localRetentionLimit:
755
+ type: integer
756
+ description: The retention limit for snapshots on the local Rubrik system. When no limit is specified, snapshots are retained up to the limit specified by the SLA.
757
+ format: int64
758
+ maxLocalRetentionLimit:
759
+ type: integer
760
+ description: The maximum retention limit for snapshots on the local Rubrik system. For snapshots operating under a local SLA, this limit is the longest period specified in the SlaFrequencyV2 object. For snapshots under a remote SLA, this limit is the value of the retentionLimit variable set at the replication target location.
761
+ format: int64
762
+ archivalSpecs:
763
+ type: array
764
+ items:
765
+ $ref: '#/components/schemas/ArchivalSpecV2'
766
+ description: Specification for archival locations on this SLA.
767
+ replicationSpecs:
768
+ type: array
769
+ items:
770
+ $ref: '#/components/schemas/ReplicationSpecV2'
771
+ description: Specification for the replication locations on this SLA.
772
+ isDefault:
773
+ type: boolean
774
+ uiColor:
775
+ type: string
776
+ showAdvancedUi:
777
+ type: boolean
778
+ advancedUiConfig:
779
+ type: array
780
+ items:
781
+ $ref: '#/components/schemas/AdvancedUiConfigAttributes'
782
+ description: ''
783
+ isRetentionLocked:
784
+ type: boolean
785
+ description: Boolean value that identifies a Retention Lock SLA Domain. Value is true when an SLA Domain is Retention Locked and false when it is not.
786
+ isPaused:
787
+ type: boolean
788
+ description: A Boolean value that specifies whether protection for all the snappables that are protected by the specified SLA Domain is paused. When the value is 'true' protection is paused.
789
+ incrementalFrequency:
790
+ $ref: '#/components/schemas/IncrementalFrequencyMap'
791
+ differentialFrequency:
792
+ $ref: '#/components/schemas/DifferentialFrequencyMap'
793
+ deltaFrequency:
794
+ $ref: '#/components/schemas/DeltaFrequencyMap'
795
+ logConfigs:
796
+ $ref: '#/components/schemas/LogConfigMap'
797
+ SlaDomainUpdateSummary:
798
+ title: SlaDomainUpdateSummary
799
+ required:
800
+ - patchedSlaDomainSummary
801
+ type: object
802
+ properties:
803
+ patchedSlaDomainSummary:
804
+ $ref: '#/components/schemas/SlaDomainSummaryV2'
805
+ batchAsyncRequestStatus:
806
+ $ref: '#/components/schemas/BatchAsyncRequestStatus'
807
+ SlaFrequencyV2:
808
+ title: SlaFrequencyV2
809
+ type: object
810
+ properties:
811
+ minute:
812
+ $ref: '#/components/schemas/FrequencyConfig'
813
+ hourly:
814
+ $ref: '#/components/schemas/FrequencyConfig'
815
+ daily:
816
+ $ref: '#/components/schemas/FrequencyConfig'
817
+ weekly:
818
+ $ref: '#/components/schemas/WeeklyConfig'
819
+ monthly:
820
+ $ref: '#/components/schemas/MonthlyConfig'
821
+ quarterly:
822
+ $ref: '#/components/schemas/QuarterlyConfig'
823
+ yearly:
824
+ $ref: '#/components/schemas/YearlyConfig'
825
+ SlaLogConfig:
826
+ title: SlaLogConfig
827
+ type: object
828
+ properties:
829
+ slaLogFrequencyConfig:
830
+ $ref: '#/components/schemas/SlaLogFrequencyConfig'
831
+ description: (Deprecated) Log backup configuration for VMware virtual machines only. To track log backup configuration by object type, use **logConfigs** instead.
832
+ SlaLogConfiguration:
833
+ title: SlaLogConfiguration
834
+ type: object
835
+ properties:
836
+ slaLogFrequencyConfig:
837
+ $ref: '#/components/schemas/SlaLogFrequencyConfig'
838
+ SlaLogFrequencyConfig:
839
+ title: SlaLogFrequencyConfig
840
+ required:
841
+ - retention
842
+ - logFrequencyType
843
+ type: object
844
+ properties:
845
+ retention:
846
+ type: integer
847
+ format: int32
848
+ logFrequencyType:
849
+ $ref: '#/components/schemas/LogFrequencyType'
850
+ frequency:
851
+ type: integer
852
+ format: int32
853
+ SlaMonth:
854
+ title: SlaMonth
855
+ enum:
856
+ - January
857
+ - February
858
+ - March
859
+ - April
860
+ - May
861
+ - June
862
+ - July
863
+ - August
864
+ - September
865
+ - October
866
+ - November
867
+ - December
868
+ type: string
869
+ description: The month of the year when snapshot will be taken.
870
+ SlaObjectCounts:
871
+ title: SlaObjectCounts
872
+ type: object
873
+ properties:
874
+ numNutanixVms:
875
+ type: integer
876
+ description: The number of Nutanix virtual machines protected under this SLA domain.
877
+ format: int32
878
+ numEc2Instances:
879
+ type: integer
880
+ description: The number of EC2 instances protected under this SLA Domain.
881
+ format: int32
882
+ numHypervVms:
883
+ type: integer
884
+ description: The number of Hyper-V virtual machines protected under this SLA domain.
885
+ format: int32
886
+ numManagedVolumes:
887
+ type: integer
888
+ description: The number of Managed volumes protected under this SLA Domain.
889
+ format: int32
890
+ numDbs:
891
+ type: integer
892
+ description: The number of actively protected databases under this SLA domain.
893
+ format: int32
894
+ numVcdVapps:
895
+ type: integer
896
+ description: The number of vApps protected under this SLA Domain.
897
+ format: int32
898
+ numOracleDbs:
899
+ type: integer
900
+ description: The number of actively protected oracle databases under this SLA Domain.
901
+ format: int32
902
+ numFilesets:
903
+ type: integer
904
+ description: The number of filesets protected under this SLA Domain.
905
+ format: int32
906
+ numStorageArrayVolumeGroups:
907
+ type: integer
908
+ description: The number of storage array volume groups protected under this SLA Domain.
909
+ format: int32
910
+ numWindowsVolumeGroups:
911
+ type: integer
912
+ description: The number of Windows volume groups protected under this SLA Domain.
913
+ format: int32
914
+ numLinuxHosts:
915
+ type: integer
916
+ description: The number of Linux servers with filesets protected under this SLA Domain.
917
+ format: int32
918
+ numShares:
919
+ type: integer
920
+ description: The number of shares protected under this SLA Domain.
921
+ format: int32
922
+ numWindowsHosts:
923
+ type: integer
924
+ description: The number of Windows servers with filesets protected under this SLA Domain.
925
+ format: int32
926
+ numVms:
927
+ type: integer
928
+ format: int32
929
+ numProtectedObjects:
930
+ type: integer
931
+ description: The total number of protected ojects under this SLA Domain.
932
+ format: int32
933
+ SlaStartTimeAttributes:
934
+ title: SlaStartTimeAttributes
935
+ required:
936
+ - minutes
937
+ - hour
938
+ type: object
939
+ properties:
940
+ minutes:
941
+ type: integer
942
+ format: int32
943
+ hour:
944
+ type: integer
945
+ format: int32
946
+ dayOfWeek:
947
+ type: integer
948
+ format: int32
949
+ SlaTimeUnit:
950
+ title: SlaTimeUnit
951
+ enum:
952
+ - Minute
953
+ - Hourly
954
+ - Daily
955
+ - Weekly
956
+ - Monthly
957
+ - Quarterly
958
+ - Yearly
959
+ type: string
960
+ description: Units for frequency and retention. Accepted values are Minute, Hourly, Daily, Weekly, Monthly, Quarterly, and Yearly.
961
+ Snappable:
962
+ title: Snappable
963
+ required:
964
+ - id
965
+ - name
966
+ - configuredSlaDomainId
967
+ - configuredSlaDomainName
968
+ - primaryClusterId
969
+ - effectiveSlaDomainId
970
+ - effectiveSlaDomainName
971
+ - slaAssignment
972
+ type: object
973
+ properties:
974
+ id:
975
+ type: string
976
+ description: The ID of the Rubrik object.
977
+ name:
978
+ type: string
979
+ description: The name of the Rubrik object.
980
+ configuredSlaDomainId:
981
+ type: string
982
+ description: The ID of the SLA Domain configured directly on the Rubrik object.
983
+ configuredSlaDomainName:
984
+ type: string
985
+ description: The name of the SLA Domain configured directly on the Rubrik object.
986
+ configuredSlaDomainType:
987
+ $ref: '#/components/schemas/ConfiguredSlaType'
988
+ primaryClusterId:
989
+ type: string
990
+ description: The ID of the cluster that manages the Rubrik object.
991
+ isConfiguredSlaDomainRetentionLocked:
992
+ type: boolean
993
+ description: Indicates whether the configured SLA Domain is Retention Locked. When this value is 'true', the configured SLA Domain is a Retention Lock SLA Domain.
994
+ slaLastUpdateTime:
995
+ type: string
996
+ description: The UTC time when the SLA Domain was last updated.
997
+ format: date-time
998
+ effectiveSlaDomainId:
999
+ type: string
1000
+ description: The ID of the SLA Domain that controls the protection of the Rubrik object.
1001
+ effectiveSlaDomainName:
1002
+ type: string
1003
+ description: The name of the SLA Domain that controls the protection of the Rubrik object.
1004
+ isEffectiveSlaDomainRetentionLocked:
1005
+ type: boolean
1006
+ description: Indicates whether the effective SLA Domain is Retention Locked. When this value is 'true', the effective SLA domain is a Retention Lock SLA Domain.
1007
+ effectiveSlaDomainPolarisManagedId:
1008
+ type: string
1009
+ description: Optional. This field contains the managed ID of of the Polaris-managed effective SLA Domain.
1010
+ effectiveSlaSourceObjectId:
1011
+ type: string
1012
+ description: The ID of the parent of the Rubrik object from which the SLA Domain that controls the protection of Rubrik object is inherited.
1013
+ effectiveSlaSourceObjectName:
1014
+ type: string
1015
+ description: The name of the parent of the Rubrik object from which the SLA Domain that controls the protection of Rubrik object is inherited.
1016
+ slaAssignment:
1017
+ $ref: '#/components/schemas/SlaAssignment'
1018
+ retentionSlaDomainId:
1019
+ type: string
1020
+ description: The ID of the SLA Domain whose retention policy is in use.
1021
+ WeeklyConfig:
1022
+ title: WeeklyConfig
1023
+ required:
1024
+ - frequency
1025
+ - retention
1026
+ - dayOfWeek
1027
+ type: object
1028
+ properties:
1029
+ frequency:
1030
+ type: integer
1031
+ format: int32
1032
+ retention:
1033
+ type: integer
1034
+ format: int32
1035
+ dayOfWeek:
1036
+ $ref: '#/components/schemas/SlaDayOfWeek'
1037
+ YearlyConfig:
1038
+ title: YearlyConfig
1039
+ required:
1040
+ - frequency
1041
+ - retention
1042
+ - yearStartMonth
1043
+ - dayOfYear
1044
+ type: object
1045
+ properties:
1046
+ frequency:
1047
+ type: integer
1048
+ format: int32
1049
+ retention:
1050
+ type: integer
1051
+ format: int32
1052
+ yearStartMonth:
1053
+ $ref: '#/components/schemas/SlaMonth'
1054
+ dayOfYear:
1055
+ $ref: '#/components/schemas/SlaDayOfYear'
1056
+ AsyncRequestStatus:
1057
+ title: AsyncRequestStatus
1058
+ required:
1059
+ - id
1060
+ - status
1061
+ - links
1062
+ type: object
1063
+ properties:
1064
+ id:
1065
+ type: string
1066
+ description: The ID of the request object used to poll the status.
1067
+ status:
1068
+ type: string
1069
+ description: Status of the ID.
1070
+ progress:
1071
+ type: number
1072
+ description: The current percentage progress of the asynchronous request.
1073
+ startTime:
1074
+ type: string
1075
+ description: The start time of the request.
1076
+ format: date-time
1077
+ endTime:
1078
+ type: string
1079
+ description: The end time of the request.
1080
+ format: date-time
1081
+ nodeId:
1082
+ type: string
1083
+ description: The ID of the node where the job ran.
1084
+ error:
1085
+ $ref: '#/components/schemas/RequestErrorInfo'
1086
+ links:
1087
+ type: array
1088
+ items:
1089
+ $ref: '#/components/schemas/Link'
1090
+ description: References to any related objects.
1091
+ BatchAsyncRequest:
1092
+ title: BatchAsyncRequest
1093
+ required:
1094
+ - ids
1095
+ type: object
1096
+ properties:
1097
+ ids:
1098
+ type: array
1099
+ items:
1100
+ type: string
1101
+ description: Batch of the request object IDs used to poll the status.
1102
+ BatchAsyncRequestStatus:
1103
+ title: BatchAsyncRequestStatus
1104
+ required:
1105
+ - responses
1106
+ type: object
1107
+ properties:
1108
+ responses:
1109
+ type: array
1110
+ items:
1111
+ $ref: '#/components/schemas/AsyncRequestStatus'
1112
+ description: The asynchronous request status of a batch request.
1113
+ RequestErrorInfo:
1114
+ title: RequestErrorInfo
1115
+ required:
1116
+ - message
1117
+ type: object
1118
+ properties:
1119
+ message:
1120
+ type: string
1121
+ description: The error message for failed IDs.
1122
+ RequestFailedException:
1123
+ title: RequestFailedException
1124
+ required:
1125
+ - errorType
1126
+ - message
1127
+ type: object
1128
+ properties:
1129
+ errorType:
1130
+ type: string
1131
+ message:
1132
+ type: string
1133
+ code:
1134
+ type: string
1135
+ param:
1136
+ type: string
1137
+ StringResponse:
1138
+ title: StringResponse
1139
+ required:
1140
+ - response
1141
+ type: object
1142
+ properties:
1143
+ response:
1144
+ type: string
1145
+ VcdVappSlaObjectCount:
1146
+ title: VcdVappSlaObjectCount
1147
+ type: object
1148
+ properties:
1149
+ numVcdVapps:
1150
+ type: integer
1151
+ description: The number of vApps protected under this SLA Domain.
1152
+ format: int32
1153
+ SlaAssignment:
1154
+ title: SlaAssignment
1155
+ enum:
1156
+ - Derived
1157
+ - Direct
1158
+ - Unassigned
1159
+ type: string
1160
+ description: The SLA assignment type. Direct SLA assignment means that a SLA Domain was configured directly on the Rubrik object by the user. Derived SLA assignment means that the Rubrik object inherits an SLA Domain from its parent Rubrik object.
1161
+ securitySchemes:
1162
+ BasicAuth:
1163
+ type: http
1164
+ scheme: basic
1165
+ Bearer:
1166
+ type: apiKey
1167
+ name: Authorization
1168
+ in: header
1169
+ security:
1170
+ - BasicAuth: []
1171
+ - Bearer: []
1172
+ tags:
1173
+ - name: Endpoint reference
1174
+ - name: /sla_domain
1175
+ description: SLA Domains.