/
swagger-nbu-admin-api.yaml
2853 lines (2700 loc) · 111 KB
/
swagger-nbu-admin-api.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
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: NetBackup Administration API
version: '4.0'
description: >
The NetBackup Administration API provides access to administrative
operations in NetBackup.
externalDocs:
description: Getting Started Guide
url: >-
http://sort.veritas.com/public/documents/nbu/8.3/windowsandunix/productguides/html/getting-started/
servers:
- url: 'https://<masterserver>:1556/netbackup'
description: NetBackup Master
paths:
'/admin/hosts/{hostId}/processes':
get:
security:
- rbacSecurity: []
parameters:
- &ref_12
name: hostId
in: path
description: >-
The unique ID (UUID) of the host. See the 'uuid' attribute of the
response of GET /config/hosts API.
required: true
schema:
type: string
- name: filter
description: >
Filter criteria syntax is based on OData standards. Filtering is
supported on the following attributes:
|Name|Supported Operators|Description|Schema|
|---|---|---|---|
|processName|eq|The process name.|string|
in: query
required: false
schema:
type: string
description: >
Get the list of NetBackup processes running on the specified host.
**Access Control**\
Enforcement Type:
[API-Level](http://sort.veritas.com/public/documents/nbu/8.3/windowsandunix/productguides/html/getting-started#user-content-object-level-enforcement)\
Namespace: `|MANAGE|HOSTS|PROCESSES|`\
Requires Operation: `|OPERATIONS|VIEW|`
tags:
- Hosts
responses:
'200':
description: Successfully retrieved the list of processes.
content:
application/vnd.netbackup+json;version=4.0:
schema: &ref_18
type: object
properties:
data:
type: array
items:
type: object
properties:
type:
type: string
description: Resource type.
enum:
- process
id:
type: string
description: The process ID (PID) of the process.
attributes:
type: object
properties:
processName:
type: string
description: The name of the process.
ppid:
type: integer
description: The process ID of the parent process.
priority:
type: integer
description: The priority of the process.
memoryUsageMB:
type: number
description: The memory usage of the process in MB.
startTime:
type: string
format: date-time
description: >-
The time the process started in ISO 8601 time
format.
elapsedTime:
type: string
description: >-
The duration of the process since startTime, in
ISO 8601 time format.
username:
type: string
description: The username that started the process.
arguments:
type: string
description: The arguments provided to the process.
required:
- processName
- priority
- memoryUsageMB
- startTime
- elapsedTime
required:
- type
- id
- attributes
required:
- data
'401': &ref_4
description: >
The `Authorization` header is missing, the token is invalid, or you
do not have permission for this action.
content:
application/vnd.netbackup+json;version=4.0:
schema: &ref_0
type: object
properties:
errorCode:
type: integer
format: int64
description: The NetBackup error code.
errorMessage:
type: string
description: The NetBackup error code description.
attributeErrors:
type: object
description: >
Maps the attributes with the invalid values to an error
that describes why the value is invalid, to provide more
context to the nature of the error.
errorDetails:
type: array
description: >-
A list that contains additional information about the
error.
items:
type: string
fileUploadErrors:
type: array
description: >
If an API is supporting content-type multipart/form-data,
then this holds a list of objects that contains names of
failed files and associated error messages.
items:
type: object
required:
- errorCode
- errorMessage
'404':
description: No host exists with the specified host ID.
content:
application/vnd.netbackup+json;version=4.0:
schema: *ref_0
'406': &ref_1
description: >-
Invalid `Accept` type. Make sure your `Accept` header matches what
this API produces.
content:
application/vnd.netbackup+json;version=4.0:
schema: *ref_0
'500': &ref_2
description: An unexpected system error occurred.
content:
application/vnd.netbackup+json;version=4.0:
schema: *ref_0
/admin/jobs:
get:
security:
- rbacSecurity: []
parameters:
- name: filter
description: >
Filter criteria syntax is based on OData standards. Filtering is
supported on the following attributes:
|Name|Supported Operators|Description|Schema|
|---|---|---|---|
|jobId|eq ne lt gt le ge|The job identifier.|integer|
|parentJobId|eq ne lt gt le ge|The parent job identifier.|integer|
|clientName|eq ne contains, startswith, endswith|The name of the
client to protect. If the client name contains a space or "%",
encode these characters as '%20' or '%25', respectively.|string|
|endTime|eq ne lt gt le ge|The time when the job
finished.|date-time|
|startTime|eq ne lt gt le ge|The time when the job
started.|date-time|
|state|eq ne|The state of the job. Possible values: QUEUED, ACTIVE,
REQUEUED, DONE, SUSPENDED, INCOMPLETE|string|
|status|eq ne lt gt le ge|The final job status code.|integer|
|jobType|eq ne|The type of the job. Possible values: BACKUP,
ARCHIVE, RESTORE, VERIFY, DUPLICATE, IMPORT, DBBACKUP, VAULT, LABEL,
ERASE, TPREQ, TPCLEAN, TPFORMAT, VMPHYSINV, DQTS, DBRECOVER,
MCONTENTS, IMAGEDELETE, GENERIC, REPLICATE, REPLICA_IMPORT,
SNAPDUPE, SNAPREPLICATE, SNAPIMPORT, APP_STATE_CAPTURE, INDEXING,
INDEXCLEANUP, SNAPINDEX, ACTIVATE_IR, DEACTIVATE_IR, REACTIVATE_IR,
STOP_IR, INSTANT_RECOVERY, RMAN_CATALOG, LOCKVM,
CLOUD_SNAPSHOT_REPLICATE|string|
|policyName|contains, startswith, endswith|The name of the policy
used by this job.|string|
|policyType|eq ne|The type of the policy. Possible values: STANDARD,
PROXY, NONSTANDARD, APOLLO_WBAK, OBACKUP, ANY, INFORMIX, SYBASE,
SHAREPOINT, WINDOWS, NETWARE, BACKTRACK, AUSPEX_FASTBACK,
WINDOWS_NT, OS2, SQL_SERVER, EXCHANGE, SAP, DB2, NDMP, FLASHBACKUP,
SPLITMIRROR, AFS, DFS, DATASTORE, LOTUS_NOTES, NCR_TERADATA,
VAX_VMS, HP3000_MPE, FBU_WINDOWS, VAULT, BE_SQL_SERVER, BE_EXCHANGE,
MAC, DS, NBU_CATALOG, GENERIC, CMS_DB, PUREDISK_EXPORT,
ENTERPRISE_VAULT, VMWARE, HYPERV, NBU_SEARCHSERVER, HYPERSCALE,
BIGDATA, CLOUD, DEPLOYMENT, HYPERVISOR, UNIVERSAL_SHARE,
NAS_DATA_PROTECTION|string|
|restoreBackupIDs|eq, ne, contains, startswith, endswith|The backup
images used for restore. If the client name contains a space or "%",
encode these characters as '%20' or '%25', respectively.|string|
|initiatorId|eq, ne, contains, startswith, endswith|The initiator of
the job.|string|
|assetID|eq|The asset identifier.|string|
|destinationStorageUnitName|eq|The destination storage unit
name.|string|
|destinationMediaId|eq|The destination media id.|string|
in: query
required: false
schema:
type: string
- name: 'page[offset]'
description: The job record number offset.
in: query
required: false
schema:
type: integer
- name: 'page[limit]'
description: The number of records on one page after the offset.
in: query
required: false
schema:
type: integer
- name: sort
description: >-
Sorts in ascending order on the specified property. Prefix with '-'
for descending order.
in: query
required: false
schema:
type: string
description: >
Gets the list of jobs based on specified filters. If no filters are
specified, information for 10 jobs sorted in
descending order by job start time is retrieved.
To avoid sending large set of jobs data, API returns only subset of data
(default size 10). To fetch additional
results, take advantage of pagination using `page[Offset]` &
`page[limit]` which allows for subsequent requests
to "page" through the rest of the results until the end is reached.
**Access Control**\
Enforcement Type:
[API-Level](http://sort.veritas.com/public/documents/nbu/8.3/windowsandunix/productguides/html/getting-started#user-content-object-level-enforcement)\
Namespace: `|MANAGE|JOBS|`\
Requires Operation: `|OPERATIONS|VIEW|`
A given principal can also view the jobs that they initiate even if they
are not granted the Jobs view operation.
tags:
- Jobs
responses:
'200':
description: >
Successfully retrieved the list of jobs based on the specified
filters. No data is returned if no jobs are found.
content:
application/vnd.netbackup+json;version=4.0:
schema: &ref_22
type: object
properties:
links:
type: object
properties:
self:
type: object
properties:
href:
type: string
next:
type: object
properties:
href:
type: string
prev:
type: object
properties:
href:
type: string
first:
type: object
properties:
href:
type: string
last:
type: object
properties:
href:
type: string
data:
type: array
items: &ref_3
type: object
properties:
type:
type: string
id:
type: string
links:
type: object
properties:
self:
type: object
properties:
href:
type: string
try-logs:
type: object
properties:
href:
type: string
file-lists:
type: object
properties:
href:
type: string
attributes:
type: object
properties:
jobId:
type: integer
description: The job identifier.
acceleratorOptimization:
type: integer
description: >-
The percentage of optimization achieved if the
job uses NetBackup Accelerator.
activeProcessId:
type: integer
description: The identifier of the active process.
activeTryStartTime:
type: string
format: date-time
description: A UTC timestamp of when the current try started.
applicationType:
type: string
description: The application type.
enum:
- NONE
- VMWARE
- HYPERV
- VXVI
- HYPERSCALE
- RHV
auditDomainName:
type: string
description: The domain name for auditing.
auditDomainType:
type: integer
description: |
The auditing domain type.
0=INVALID,
1=ACTIVE_DIRECTORY,
2=NIS_PLUS,
3=VXAT_PRIVATE,
4=UNIX_PASSWORD,
5=NIS,
6=LOCAL_HOST,
7=UNKNOWN_AUTH
auditUserName:
type: string
description: The user name in the audit record.
assetID:
type: string
description: >-
The GUID of the asset for which the job was
started.
assetDisplayableName:
type: string
description: >-
The displayable name of the asset for which the
job was started.
backupId:
type: string
description: The backup ID or image ID.
clientName:
type: string
description: The name of the client to protect.
compression:
type: integer
description: >
Indicates if compression is enabled for the
backup policy.
0=disabled,
1=enabled
controlHost:
type: string
description: The host from which the job was initiated.
copyNumber:
type: integer
description: The copy number of the backup image.
currentFile:
type: string
description: The file currently being protected.
currentOperation:
type: integer
format: int64
description: >
The operation currently being performed. A value
of -99 indicates that an invalid value was
returned.
0=MOUNTING,
1=POSITIONING,
2=CONNECTING,
3=WRITING,
4=VLT_INIT,
5=VLT_DUPIMG,
6=VLT_DUPCMP,
7=VLT_BK_NBCAT,
8=VLT_EJRPT,
9=VLT_COMPLETE,
10=READING,
11=DUPLICATE,
12=IMPORT,
13=VERIFY,
14=RESTORE,
15=BACKUPDB,
16=VAULT,
17=LABEL,
18=ERASE,
19=SYNTH_DBQUERY,
20=SYNTH_PROCESS_EXTENTS,
21=SYNTH_PLAN,
22=CREATE_SNAPSHOT,
23=DELETE_SNAPSHOT,
24=RECOVERDB,
25=MCONTENTS,
26=SYNTH_REQUERESOURCES,
27=PARENT_JOB,
28=INDEXING,
29=REPLICATE,
30=RUNNING,
31=ASSEMBLING_FILE_LIST,
32=ALLOCATING_MEDIA
dataMovement:
type: string
description: The type of data movement used for this job.
enum:
- STANDARD
- INSTANTRECOVERYDISK
- INSTANTRECOVERYDISKANDTAPE
- SYNTHETIC
- DISKSTAGING
- SNAPSHOT
dedupRatio:
type: number
format: float
description: The deduplication rate that was achieved.
destinationMediaId:
type: string
description: >-
The destination media server. Used for
deduplication jobs.
destinationStorageUnitName:
type: string
description: >-
The destination storage unit. Used for
deduplication jobs.
destinationMediaServerName:
type: string
description: >-
The destination media server name. Used for
deduplication jobs.
dumpHost:
type: string
description: The recovery appliance host name for Copilot.
elapsedTime:
type: string
description: >-
The time that has elapsed since the start of the
job.
endTime:
type: string
format: date-time
description: The time that the job ended.
estimatedFiles:
type: integer
description: The estimated number of files to protect.
frozenImage:
type: integer
description: >-
Indicates if the job type is a snapshot. This
property is used internally.
initiatorId:
type: string
description: The initiator of the job.
instanceDatabaseName:
type: string
description: >-
The name of the database instance or the
database.
jobGroup:
type: string
description: The name of the group that initiated the job.
jobOwner:
type: string
description: >-
The job owner or the user that initiated the
job.
jobQueueReason:
type: integer
format: int64
description: >
The reason the job is queued. A value of -99
indicates that an invalid value was returned.
1=MEDIA_IN_USE,
2=DRIVES_IN_USE,
3=MEDIA_SERVER_OFFLINE,
4=ROBOT_DOWN,
5=MAX_STORAGE_UNIT_JOBS,
6=MEDIA_REQUEST_DELAY,
7=LOCAL_DRIVES_DOWN,
8=MEDIA_IN_DRIVE_IN_USE,
9=PHYSICAL_DRIVE_UNAVAILABLE,
10=CLEANING_MEDIA_UNAVAILABLE,
11=DRIVE_SCAN_HOST_OFFLINE,
12=DISK_MEDIA_SERVER_OFFLINE,
13=NO_MASTER_MEDIA_CONNECTIVITY,
14=MEDIA_SERVER_NON_ACTIVE_MODE,
15=STORAGEUNIT_JOB_COUNTS_THROTTLED,
16=JOB_HISTORY_DRIVES_IN_USE,
17=DISK_VOLUME_UNAVAILABLE,
18=MAX_CONCURRENT_VOLUME_READERS,
19=DISK_GROUP_UNAVAILABLE,
20=FAT_PIPE_IN_USE,
21=DISK_VOLUME_UNMOUNTING,
22=DISK_VOLUME_IN_USE,
23=MAX_PARTIAL_MEDIA,
24=LOGICAL_RESOURCE,
25=DRIVES_IN_STORAGE_UNIT_IN_USE,
26=STOP_DRIVE_SCAN,
27=DISK_VOLUME_MOUNTING,
28=MOUNT_FILE_EXISTS,
29=PENDING_ACTION,
30=DISK_VOLUME_STREAM_LIMIT
jobQueueResource:
type: string
description: >-
The name of the resource for which the queued
job is waiting.
jobSubType:
type: string
description: The job subtype.
enum:
- IMMEDIATE
- SCHEDULED
- USERBACKUP
- ERASETYPE_QUICK
- ERASETYPE_LONG
- DBBACKUP_STAGING
- DBBACKUP_COLD
- RMAN_CATALOG
- IA_CREATE_VM
- IA_DELETE_VM
- IA_CREATE_MOUNT
- IA_DELETE_MOUNT
- IA_FILE_RESTORE
- IA_GET_DOWNLOAD_URL
- AGENTLESS_RESTORE
- FULL_VM_RESTORE
- CLOUD_VM_CONVERT
- IA_ATTACH_DATABASE
- IA_DETACH_DATABASE
jobType:
type: string
description: The job type.
enum:
- BACKUP
- ARCHIVE
- RESTORE
- VERIFY
- DUPLICATE
- IMPORT
- DBBACKUP
- VAULT
- LABEL
- ERASE
- TPREQ
- TPCLEAN
- TPFORMAT
- VMPHYSINV
- DQTS
- DBRECOVER
- MCONTENTS
- IMAGEDELETE
- GENERIC
- REPLICATE
- REPLICA_IMPORT
- SNAPDUPE
- SNAPREPLICATE
- SNAPIMPORT
- APP_STATE_CAPTURE
- INDEXING
- INDEXCLEANUP
- SNAPSHOT
- SNAPINDEX
- ACTIVATE_IR
- DEACTIVATE_IR
- REACTIVATE_IR
- STOP_IR
- INSTANT_RECOVERY
- RMAN_CATALOG
- LOCKVM
- INSTANT_ACCESS
- CLOUD_SNAPSHOT_REPLICATE
cancellable:
type: integer
description: Indicates if the job can be stopped.
kilobytesDataTransferred:
type: integer
description: >
The actual data transferred, in kilobytes. For
some jobs, data transferred is different than
the final image size.
kilobytesToTransfer:
type: integer
description: The remaining kilobytes to transfer.
kilobytesTransferred:
type: integer
description: >-
The estimated amount of data transferred, in
kilobytes.
lastUpdateTime:
type: string
format: date-time
description: The UTC timestamp when the job was modified.
mainProcessId:
type: integer
description: >-
The process ID of the main controlling process
for restore and image cleanup.
numberOfFiles:
type: integer
description: The actual number of files protected.
numberOfTapeToEject:
type: integer
description: >-
For Vault jobs, the total number of tape media
to eject.
offHostType:
type: string
description: The Offhost type.
enum:
- STANDARD
- ATLCLIENT
- TPC
- MEDIASERVER
- NAS
- NDMP
- UNRECOGNIZED_VALUE
parentJobId:
type: integer
description: The parent job ID.
percentComplete:
type: integer
description: >-
The estimate (as a percentage) of when the job
will be completed.
policyName:
type: string
description: The name of the policy used by this job.
policyType:
type: string
description: The backup policy type.
enum:
- STANDARD
- PROXY
- NONSTANDARD
- APOLLO_WBAK
- OBACKUP
- ANY
- INFORMIX
- SYBASE
- SHAREPOINT
- WINDOWS
- NETWARE
- BACKTRACK
- AUSPEX_FASTBACK
- WINDOWS_NT
- OS2
- SQL_SERVER
- EXCHANGE
- SAP
- DB2
- NDMP
- FLASHBACKUP
- SPLITMIRROR
- AFS
- DFS
- DATASTORE
- LOTUS_NOTES
- NCR_TERADATA
- VAX_VMS
- HP3000_MPE
- FBU_WINDOWS
- VAULT
- BE_SQL_SERVER
- BE_EXCHANGE
- MAC
- DS
- NBU_CATALOG
- GENERIC
- CMS_DB
- PUREDISK_EXPORT
- ENTERPRISE_VAULT
- VMWARE
- HYPERV
- NBU_SEARCHSERVER
- HYPERSCALE
- BIGDATA
- CLOUD
- DEPLOYMENT
- HYPERVISOR
- UNIVERSAL_SHARE
- NAS_DATA_PROTECTION
priority:
type: integer
description: The priority of this job.
profileName:
type: string
description: The name of the Vault profile.
restartable:
type: integer
description: Indicates if the job can be restarted.
restoreBackupIDs:
type: string
description: >-
The list of backup IDs needed for the restore
job.
resumable:
type: integer
description: Indicates if the job can be resumed.
retentionLevel:
type: integer
description: The retention level of the backup image.
robotName:
type: string
description: The name of the robot in the Vault job.
scheduleName:
type: string
description: >-
The name of the backup schedule used by the
backup job.
scheduleType:
type: string
description: The type of schedule used by the backup job.
enum:
- FULL_BACKUP
- DIFFERENTIAL_INCREMENTAL_BACKUP
- USER_BACKUP
- USER_ARCHIVE
- CUMULATIVE_INCREMENTAL_BACKUP
- VAULT_CATALOG_BACKUP
- AUTOMATIC_BACKUP
- APPLICATION_BACKUP
- AUTOMATIC_FULL_BACKUP
- AUTOMATIC_INCREMENTAL_BACKUP
- AUTOMATIC_DIFFERENTIAL_INCREMENTAL_BACKUP
- AUTOMATIC_CUMULATIVE_INCREMENTAL_BACKUP
- AUTOMATIC_VAULT
- ARCHIVE_REDO_LOG_BACKUP
- TRANSACTION_LOG_BACKUP
- PRE_CHECK
- STAGE_PACKAGE
- INSTALL_PACKAGE
- UNUSED
- UNRECOGNIZED_VALUE
sessionId:
type: integer
description: The Vault session ID.
sourceMediaId:
type: string
description: The source media ID for the duplication job.
sourceMediaServerName:
type: string
description: >-
The name of the source media server for the
duplication job.
sourceStorageUnitName:
type: string
description: The name of the source storage unit.
startTime:
type: string
format: date-time
description: The UTC timestamp when the job was started.
state:
type: string
description: The current state of the job.
enum:
- QUEUED
- ACTIVE
- REQUEUED
- DONE
- SUSPENDED
- INCOMPLETE
status:
type: integer
description: The final job status code.
streamNumber:
type: integer
description: The stream number of the job.
submissionType:
type: integer
description: The job submission type.
suspendable:
type: integer
description: Indicates if the job can be suspended.
transferRate:
type: integer
description: >-
The data transfer rate in kilobytes (KB) per
second.
transportType:
type: string
description: The data transport type used for the job.
enum:
- LAN
- FAT
- UNKNOWN_TYPE
try:
type: integer
description: The current try number to execute this job.
vaultName:
type: string
description: The Vault name used by the job.
meta:
type: object
properties:
pagination:
type: object
properties:
prev:
type: integer
next:
type: integer
first:
type: integer
last:
type: integer
count:
type: integer
page:
type: integer
offset:
type: integer
pages:
type: integer
limit:
type: integer
example:
data:
- links:
self:
href: /admin/jobs/1
file-lists:
href: >-
https://dummyHost:1556/netbackup/admin/jobs/1/file-lists
try-logs:
href: >-
https://dummyHost:1556/netbackup/admin/jobs/1/try-logs
type: job
id: 1
attributes:
jobId: 1
parentJobId: 0
activeProcessId: 8624
mainProcessId: 0
jobType: IMAGEDELETE
jobSubType: IMMEDIATE
policyName: ''
scheduleType: FULL
scheduleName: ''
clientName: ''
controlHost: ''
jobOwner: user
jobGroup: ''
backupId: ''
sourceMediaId: ''
sourceStorageUnitName: ''
sourceMediaServerName: ''
destinationMediaId: ''
destinationStorageUnitName: ''
destinationMediaServerName: ''
dataMovement: STANDARD
streamNumber: 0
copyNumber: 0
priority: 0
retentionLevel: 0
compression: 0
status: 0
state: DONE
done: 1
numberOfFiles: 0
estimatedFiles: 0
kilobytesTransferred: 0
kilobytesToTransfer: 0
transferRate: 0
percentComplete: 100
restartable: 0
suspendable: 0
resumable: 0
killable: 1
frozenImage: 0
transportType: LAN
currentOperation: 0
jobQueueReason: 0
jobQueueResource: ''
robotName: ''
vaultName: ''
profileName: ''
sessionId: 0
numberOfTapeToEject: 0
submissionType: 0
dumpHost: ''
instanceDatabaseName: ''
auditUserName: ''
auditDomainName: ''
auditDomainType: 0
restoreBackupIDs: ''
startTime: '2018-06-25T19:00:32.000Z'
endTime: '2018-06-25T19:00:38.000Z'
activeTryStartTime: '2018-06-25T19:00:32.000Z'
lastUpdateTime: '2018-06-25T19:00:38.407Z'
kilobytesDataTransferred: 0
initiatorId: ''
try: 1
assetID: ''
assetDisplayableName: ''
elapsedTime: '00:00:06'
- links:
self:
href: /admin/jobs/2
file-lists:
href: >-
https://dummyHost:1556/netbackup/admin/jobs/2/file-lists
try-logs:
href: >-
https://dummyHost:1556/netbackup/admin/jobs/2/try-logs
type: job
id: 2
attributes:
jobId: 2
parentJobId: 0
activeProcessId: 8625
mainProcessId: 0
jobType: IMAGEDELETE
jobSubType: IMMEDIATE
policyName: ''
scheduleType: FULL
scheduleName: ''