NetBackup 811 API Reference

NetBackup API - 8.1.
NetBackup API - 8.1.1
Getting Started
This document is a PDF of the HTML NetBackup 8.1.1 API Reference.
Introduction
The NetBackup API provides a web-service based interface to confgure and adminiser NetBackup,
the indusry leader in data protection for enterprise environments.
NetBackup API is RESTful

The NetBackup API is built on the Representational State Transfer (REST) architecture, which is
the mos widely used syle for building APIs.
The NetBackup API uses the HTTP protocol to
communicate with NetBackup.The NetBackup API is therefore easy to use in cloud-based
Iapplications, as well as across multiple platforms and programming languages.
JSON message format

The NetBackup API uses JavaScript Object Notation (JSON) as the message format for reques and
response messages.
The client-server relationship

The NetBackup API employs client-server communication in the form of HTTP requess and
responses.
The API client (your program) uses the HTTP protocol to make an API reques to the
NetBackup server.
The NetBackup server processes the reques. The server responds to the client with an
appropriate HTTP satus code indicating either success or failure.
The client then extracts the

required information from the server’s response.
Overview
Authentication
NetBackup authenticates the incoming API requess based on the JSON Web Token (JWT) that
https://sort.veritas.com/public/documents/nbu/8.1.1/windowsandunix/productguides/html/index/[2/16/2018 9:16:34 AM]

needs to be provided in the Authorization HTTP header when making the API requess.
This
JSON Web Token (JWT) is acquired by executing a login API reques frs.
The port that is used to access the NetBackup API is the sandard NetBackup PBX
TIP
port, 1556 .
Example
The following procedure provides a sample workfow to retrieve job information from NetBackup.
This procedure involves logging in to NetBackup to receive a JWT and then requesing job
information for a specifc job (job ID 5 in this scenario).
Step 1
Use the NetBackup API endpoint POST /login to create a login reques:
curl -X POST https://masterservername:1556/netbackup/login \

-H 'content-type: application/vnd.netbackup+json;version=1.0' \
-d '{ \
"domainType":"vx", \
"domainName":"mydomain", \
"userName":"myusername", \
"password":"mypassword" \
}'
The following response to the login reques contains the JSON Web Token (JWT):
This response contains three attributes: token , tokenType and validity .

NOTE The token
attribute provides the JWT. The validity attribute indicates that

the token returned is valid
for 86400 seconds, or 24 hours.
{
"token":
"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsInppcCI6IkRFRiJ9.eNp0VF1v2jAU_S9-
nHiArXQrb15yaT2cOLIdEJ2mKGWZmnXARMKEVvW_13EciO3weu65H-d-
vaIyr9FsMp18Gt_dTsefb6bjESqrCs3Q7umYbfOqLg5ohH7XpYIWqwVfzNM1k6tHvCKJMhSnv63_5MvHO-
V_cztC1fFJkQ_b3bGaHar6UGxeitm_k2Lnx_o5q_cvxW44Wlll-c9t2Vjrw7FokW2-eS53hcJ-5X-
qwoT5n232u7o4qfJfEQchMZfZN_YVzb6jD-jHSGOMQ0YifA9ndElg5dJAZg9MyDMUcMASsmUkgC-
B96jGYrFDoKCwgFEKgSQsPlsoETILgEsyJ4HyE2dLxEIyX9txDJYwSoK1Xa_F01EFZcLnZJgS3MOBNxEhDh
NGYi9Tr7KLdJZ4JXBYsgUM0nUtnFFfmirQ7ZBUUZzm6EwEHClDmbTBKczEtacZK55kkXJuwrjcflm6gq45T
gne7I1_o9XF8CNPqdMTnIZEUnYvXLIjQZPnEIoQS2yjAwPVuJLrIFioFfYy4VQ-
6JY70hLgERGiv6gad2SYVR9Ya822h6mOKI3sSXRnwSGEWBJMnTLsszTZhpbfarnh9cfI9_saN08DbzZF87m
6RcSxyqAKoK63o9RsrJWnPd2zdq-
5A8MRqUjUNllN6I4BgpQTuU44S7zzHOqQyeJdboDjAKiVor2YK8_nMutL7DQJux-
m_KIIYukvnrthumPCbaS9BCbwkB5j8vW0cYZGfPVrXZHqrHrvU7tfsWmY9wf0Onakt7d3AAAA__8.VVE25r
QqbrC-isGOqbRTqMPoK4ts5-9_6zSgz0fUg11m9GCClq10PS9u1DlaXye-
S2MYYyHVEHSVs6uKcPVvN2WGBHkv7t-
c4Hixc9O8zrJYhJaP979wF_gn08YnRlX7_o4Qj6muc1IWHjK0hPMIgq0X-sBU2Git9uppVW1jbLA",
"tokenType": "BEARER",

"validity": 86400
}
Step 2
Get the job information using the NetBackup API endpoint GET /admin/jobs/{jobId} .
In
this example, the information for the job ID 5 is requesed.
The Authorization header uses the value of the token attribute from the
NOTE
response to the login
reques made in the previous sep.
curl -X GET https://masterservername:1556/netbackup/admin/jobs/5 \

-H 'Accept: application/vnd.netbackup+json;version=1.0' \
-H 'Authorization:
eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsInppcCI6IkRFRiJ9.eNp0VF1v2jAU_S9-
nHiArXQrb15yaT2cOLIdEJ2mKGWZmnXARMKEVvW_13EciO3weu65H-d-
vaIyr9FsMp18Gt_dTsefb6bjESqrCs3Q7umYbfOqLg5ohH7XpYIWqwVfzNM1k6tHvCKJMhSnv63_5MvHO-
V_cztC1fFJkQ_b3bGaHar6UGxeitm_k2Lnx_o5q_cvxW44Wlll-c9t2Vjrw7FokW2-eS53hcJ-5X-
qwoT5n232u7o4qfJfEQchMZfZN_YVzb6jD-jHSGOMQ0YifA9ndElg5dJAZg9MyDMUcMASsmUkgC-
B96jGYrFDoKCwgFEKgSQsPlsoETILgEsyJ4HyE2dLxEIyX9txDJYwSoK1Xa_F01EFZcLnZJgS3MOBNxEhDh
NGYi9Tr7KLdJZ4JXBYsgUM0nUtnFFfmirQ7ZBUUZzm6EwEHClDmbTBKczEtacZK55kkXJuwrjcflm6gq45T
gne7I1_o9XF8CNPqdMTnIZEUnYvXLIjQZPnEIoQS2yjAwPVuJLrIFioFfYy4VQ-
6JY70hLgERGiv6gad2SYVR9Ya822h6mOKI3sSXRnwSGEWBJMnTLsszTZhpbfarnh9cfI9_saN08DbzZF87m
6RcSxyqAKoK63o9RsrJWnPd2zdq-
5A8MRqUjUNllN6I4BgpQTuU44S7zzHOqQyeJdboDjAKiVor2YK8_nMutL7DQJux-
m_KIIYukvnrthumPCbaS9BCbwkB5j8vW0cYZGfPVrXZHqrHrvU7tfsWmY9wf0Onakt7d3AAAA__8.VVE25r
QqbrC-isGOqbRTqMPoK4ts5-9_6zSgz0fUg11m9GCClq10PS9u1DlaXye-
S2MYYyHVEHSVs6uKcPVvN2WGBHkv7t-
c4Hixc9O8zrJYhJaP979wF_gn08YnRlX7_o4Qj6muc1IWHjK0hPMIgq0X-sBU2Git9uppVW1jbLA'
The response to the GET reques contains the job information for job ID 5 :
{
"data": {
"links": {
"self": {
"href": "/admin/jobs/5"
},
"file-lists": {
"href": "https://masterservername:1556/netbackup/admin/jobs/5/file-
lists"
},
"try-logs": {
"href": "https://masterservername:1556/netbackup/admin/jobs/5/try-
logs"
}
},
"type": "job",
"id": "5",
"attributes": {
"jobId": 5,
"parentJobId": 0,

"activeProcessId": 27116,
"mainProcessId": 0,
"productType": 0,
"jobType": "IMAGEDELETE",
"jobSubType": "IMMEDIATE",
"policyType": "STANDARD",
"policyName": "",
"scheduleType": "FULL",
"scheduleName": "",
"clientName": "",
"controlHost": "",
"jobOwner": "root",
"jobGroup": "",
"backupId": "",
"sourceMediaId": "",
"sourceStorageUnitName": "",
"sourceMediaServerName": "",
"destinationMediaId": "",
"destinationStorageUnitName": "",
"destinationMediaServerName": "",
"dataMovement": "STANDARD",
"streamNumber": 0,
"copyNumber": 0,
"priority": 0,
"retention": 0,
"compression": 0,
"status": 1,
"state": "DONE",
"done": 1,
"numberOfFiles": 0,
"estimatedFiles": 0,
"kilobytesTransfered": 0,
"kilobytesToTransfer": 0,
"transferRate": 0,
"percentComplete": 0,
"currentFile": "",
"restartable": 0,
"suspendable": 0,
"resumable": 0,
"killable": 1,
"frozenImage": 0,
"transportType": "LAN",
"dedupRatio": 0,
"currentOperation": 0,
"qReasonCode": 0,
"qResource": "",
"robotName": "",
"vaultName": "",
"profileName": "",
"sessionId": 0,
"numberOfTapeToEject": 0,
"submissionType": 0,
"acceleratorOptimization": 0,
"dumpHost": "",
"instanceDatabaseName": "",
"auditUserName": "",

"auditDomainName": "",
"auditDomainType": 0,
"restoreBackupIDs": "",
"startTime": "2018-01-09T10:03:22.000Z",
"endTime": "2018-01-09T10:03:23.000Z",
"activeTryStartTime": "2018-01-09T10:03:22.000Z",
"lastUpdateTime": "2018-01-09T10:03:23.256Z",
"kilobytesDataTransferred": 0,
"try": 1
}
}
}
SSL certifcate validation

The NetBackup web service always sends its certifcate during SSL handshakes.
This certifcate can

be validated by the API client.
To validate the certifcate, you will need to get the Certifcate

Authority (CA) certifcate from the maser server
and then use the CA certifcate in the API requess.
It is a good practice to validate the SSL certifcate. This action ensures that you
TIP
are communicating with the correct web service.
Step 1
Get the CA certifcate from the maser server using the GET /security/cacert API:
You cannot make a secure reques with certifcate validation until you have the
NOTE CA certifcate. To obtain the initial CA certifcate you mus skip the certifcate
validation, with the "--insecure" curl option.
curl -X POST https://masterservername:1556/netbackup/security/cacert \

--insecure
The response to the cacert reques contains two certifcates:
{
"webRootCert": "-----BEGIN CERTIFICATE----
-\nMIICljCCAf+gAwIBAgIIcte7aAAAAAAwDQYJKoZIhvcNAQENBQAwTTEOMAwGA1UE\nAxMFbmJhdGQxLj
AsBgNVBAsUJXJvb3RAbW9ybGV5dm01LnJtbnVzLnNlbi5zeW1h\nbnRlYy5jb20xCzAJBgNVBAoTAnZ4MB4
XDTE4MDEwODE0MjcyNloXDTM4MDEwMzE1\nNDIyNlowTTEOMAwGA1UEAxMFbmJhdGQxLjAsBgNVBAsUJXJv
b3RAbW9ybGV5dm01\nLnJtbnVzLnNlbi5zeW1hbnRlYy5jb20xCzAJBgNVBAoTAnZ4MIGfMA0GCSqGSIb3\
nDQEBAQUAA4GNADCBiQKBgQDpRc/yo0utxcKrftPeOzn1o1MR5b42uGWrwg9kU4VM\nZN++0kvrtRWt4wz8
zdtNU4wtg/MHWt0ffj6FRYYAZBbM8fu56GFux3wCPJSHWl6B\nZ0nD1vZxFUwTXkRAAObuHrYphjBNf1oUU
+4GS44KD4/UW/bucKdZsUI1+HcfCQZw\nNwIDAQABo38wfTAPBgNVHRMBAf8EBTADAQH/MAsGAyoDBQQEcm
9vdDAPBgMqAwYE\nCDAwMDAwMDE3MC0GAyoDCAQmezg2ZDY5MDU0LWY0OGEtMTFlNy1hNDAyLTYwYWQy\nM
TZjYTdlZX0wHQYDVR0OBBYEFE/mpo7PbWs7p/zkAHWi/BDwpdn+MA0GCSqGSIb3\nDQEBDQUAA4GBAAmZJ9
8XLqG0H+qwyuZ97YdzE2dWKpRduuARYJp437Sc6tpL6nFn\nuzbtGV30tDdhROYPf1AoNRmZHvz40Hra1B8
j4VFggPZOAmmk+UJPjzeHn6qhlRxl\nHjCdEqUZ//+1Aqgj6f/6bqPO5boCVP1qw8N60fkBaV3zLwAOY6CK

iHS0\n-----END CERTIFICATE-----\n",
"cacert": [
"-----BEGIN CERTIFICATE----
-\nMIICljCCAf+gAwIBAgIIcte7aAAAAAAwDQYJKoZIhvcNAQENBQAwTTEOMAwGA1UE\nAxMFbmJhdGQxLj
AsBgNVBAsUJXJvb3RAbW9ybGV5dm01LnJtbnVzLnNlbi5zeW1h\nbnRlYy5jb20xCzAJBgNVBAoTAnZ4MB4
XDTE4MDEwODE0MjcyNloXDTM4MDEwMzE1\nNDIyNlowTTEOMAwGA1UEAxMFbmJhdGQxLjAsBgNVBAsUJXJv
b3RAbW9ybGV5dm01\nLnJtbnVzLnNlbi5zeW1hbnRlYy5jb20xCzAJBgNVBAoTAnZ4MIGfMA0GCSqGSIb3\
nDQEBAQUAA4GNADCBiQKBgQDpRc/yo0utxcKrftPeOzn1o1MR5b42uGWrwg9kU4VM\nZN++0kvrtRWt4wz8
zdtNU4wtg/MHWt0ffj6FRYYAZBbM8fu56GFux3wCPJSHWl6B\nZ0nD1vZxFUwTXkRAAObuHrYphjBNf1oUU
+4GS44KD4/UW/bucKdZsUI1+HcfCQZw\nNwIDAQABo38wfTAPBgNVHRMBAf8EBTADAQH/MAsGAyoDBQQEcm
9vdDAPBgMqAwYE\nCDAwMDAwMDE3MC0GAyoDCAQmezg2ZDY5MDU0LWY0OGEtMTFlNy1hNDAyLTYwYWQy\nM
TZjYTdlZX0wHQYDVR0OBBYEFE/mpo7PbWs7p/zkAHWi/BDwpdn+MA0GCSqGSIb3\nDQEBDQUAA4GBAAmZJ9
8XLqG0H+qwyuZ97YdzE2dWKpRduuARYJp437Sc6tpL6nFn\nuzbtGV30tDdhROYPf1AoNRmZHvz40Hra1B8
j4VFggPZOAmmk+UJPjzeHn6qhlRxl\nHjCdEqUZ//+1Aqgj6f/6bqPO5boCVP1qw8N60fkBaV3zLwAOY6CK
iHS0\n-----END CERTIFICATE-----\n"
]
}
Step 2
Save the webRootCert certifcate.
To do this save the webRootCert sring to a fle.
Make sure
to convert the \n escape sequences to new lines (carriage returns).
For example, your fle would look something like this:
-----BEGIN CERTIFICATE-----
MIICljCCAf+gAwIBAgIIcte7aAAAAAAwDQYJKoZIhvcNAQENBQAwTTEOMAwGA1UE
AxMFbmJhdGQxLjAsBgNVBAsUJXJvb3RAbW9ybGV5dm01LnJtbnVzLnNlbi5zeW1h
bnRlYy5jb20xCzAJBgNVBAoTAnZ4MB4XDTE4MDEwODE0MjcyNloXDTM4MDEwMzE1
NDIyNlowTTEOMAwGA1UEAxMFbmJhdGQxLjAsBgNVBAsUJXJvb3RAbW9ybGV5dm01
LnJtbnVzLnNlbi5zeW1hbnRlYy5jb20xCzAJBgNVBAoTAnZ4MIGfMA0GCSqGSIb3
DQEBAQUAA4GNADCBiQKBgQDpRc/yo0utxcKrftPeOzn1o1MR5b42uGWrwg9kU4VM
ZN++0kvrtRWt4wz8zdtNU4wtg/MHWt0ffj6FRYYAZBbM8fu56GFux3wCPJSHWl6B
Z0nD1vZxFUwTXkRAAObuHrYphjBNf1oUU+4GS44KD4/UW/bucKdZsUI1+HcfCQZw
NwIDAQABo38wfTAPBgNVHRMBAf8EBTADAQH/MAsGAyoDBQQEcm9vdDAPBgMqAwYE
CDAwMDAwMDE3MC0GAyoDCAQmezg2ZDY5MDU0LWY0OGEtMTFlNy1hNDAyLTYwYWQy
MTZjYTdlZX0wHQYDVR0OBBYEFE/mpo7PbWs7p/zkAHWi/BDwpdn+MA0GCSqGSIb3
DQEBDQUAA4GBAAmZJ98XLqG0H+qwyuZ97YdzE2dWKpRduuARYJp437Sc6tpL6nFn
uzbtGV30tDdhROYPf1AoNRmZHvz40Hra1B8j4VFggPZOAmmk+UJPjzeHn6qhlRxl
HjCdEqUZ//+1Aqgj6f/6bqPO5boCVP1qw8N60fkBaV3zLwAOY6CKiHS0
-----END CERTIFICATE-----
Step 3
You can now use the CA certifcate in your API requess.
For example, to securely use the

cacert API remove the --insecure option and use the --cacert <filename> option.
In
the following example, the CA certifcate was saved in the fle cacert.pem .
curl -X POST https://masterservername:1556/netbackup/security/cacert \

--cacert cacert.pem

Versioning
To maintain compatibility with the back-level API clients, it is sometimes necessary to version the
NetBackup API.
The NetBackup API is developed so that new versions are minimized.
However, at
times changes are needed to the API that require a new API version.
The mechanism to version the

NetBackup API is described below.
Version numbers follow a simple MAJOR.MINOR pattern, such as 1.2 .
These version numbers are

not the same as the NetBackup release number.
The current API version number is documented with

every NetBackup release.
The version number may not increase sequentially from one NetBackup
release to the next release.
The version number may increase by multiple major versions between two
consecutive NetBackup releases.
Content negotiation is used to specify which API version the API client is requesing.
A new vendor-
specifc media type application/vnd.netbackup+json is used, along with a media type
parameter named version .
For example:
application/vnd.netbackup+json;version=1.0 .
This media type should be used in the

Accept or Content-Type HTTP header of your reques.
If you send both Accept and

Content-Type HTTP headers, their values mus match.
In some cases, an API does not consume any input or produce any output.
Such a case normally

means that neither Accept nor Content-Type HTTP headers are required.
However, because
these headers are used to specify the API version, the Accept header mus be specifed.
The value of the Content-Type or Accept HTTP header in a NetBackup API

TIP reques mus use this format:
application/vnd.netbackup+media;version=<major>.<minor>
It is important for you to consider the kind of changes that will require a new version of the
NetBackup API.
Developing your API client with these rules in mind will ensure that your API client
remains compatible with the future versions of the NetBackup API.
The following is a lis of possible API changes and if they result in a new API version:
API change results in a new version? Yes / No
Add a new endpoint No
Remove an endpoint Yes
Add an output feld or attribute No
Remove output feld or attribute Yes
Add required input feld or attribute Yes

Add non-required input feld or attribute No
If the API client expects a particular endpoint or feld in the NetBackup

response, then removing the endpoint or feld results in a new version.
If NetBackup expects a new required feld in the reques from the API client,
then adding it results in a new version.
NOTE
As you develop your API client, as a bes practice you should ignore any new
felds that are returned to you.
Do not treat unrecognized felds as an error. This

way your API clients can continue to work with future releases of NetBackup
without any change.
Pagination
Some NetBackup APIs use pagination to limit the number of resources returned in a response.
These
APIs use the page[offset] and page[limit] query parameters to set the sarting point
(ofset) and the page size (limit).
The results are returned in a page-by-page format.
The default page size is 10 resources. The type of resource depends on the
TIP individual API.
For example: For the API that gets a lis of jobs, the page contains
job-related information for up to 10 NetBackup jobs.
Filtering
Some NetBackup APIs use the 'flter' query parameter to limit or reduce the number of resources
that the response returns.
Use the OASIS syntax to specify the value of the filter using
OData fltering language.
The supported OData operators and functions depend on each individual

NOTE
NetBackup API, as described in the NetBackup API reference.
API Code Samples
To hit the ground running with the NetBackup API, you can refer to the API code samples in
diferent programming languages.
The API code samples are located on github:

https://github.com/VeritasOS/netbackup-api-code-samples .
This is a community-supported, open

source project available under the MIT license.
Disclaimer

The API code samples are not ofcially supported by Veritas and should not be used in
a production environment.
The purpose of these code samples is only to serve as a reference, to help you write
your own applications using the NetBackup API.
What’s New?
NetBackup 8.1.1
NetBackup 8.1.1 adds support for the following APIs:
NOTE Each API in this lis includes a link to the API reference for further details.
NetBackup Authentication API
The NetBackup Authentication API provides authentication by means of a JSON Web Token
(JWT) that is used when making the API requess.
The JWT is acquired by executing a login API

reques and can be invalidated by executing a logout API reques.
NetBackup Adminisration API
The NetBackup Adminisration API provides management of NetBackup jobs. The API can get job
details for a specifc job or get a lis of jobs based on flter criteria, restart or resume a job,
suspend , cancel , or delete a job, get a job’s fle lis, and get the job logs.
NetBackup Catalog API
The NetBackup Catalog API provides access to the NetBackup catalog to get details about backup
images.
The API can lis backup images based on flters or get details for a specifc backup image ID.
NetBackup Confguration API
The NetBackup Confguration API provides confguration and management controls for NetBackup
hoss, NetBackup policies, Web Socket servers, and VM server credentials.
NetBackup Recovery API
The NetBackup Recovery API provides the capability of recovering from VMware backup images.
It supports the recovery of full VMs to the original or to alternate location.
NetBackup Security API
The NetBackup Security API provides access to the security resources of NetBackup. The API can

manage authorization tokens, hos ID-based certifcates, security confguration options and auditing.
NetBackup Authentication API
Overview
The NetBackup Authentication API provides authentication by means of a JSON Web Token
(JWT) that is used when making the API requess.
Version information
Version : 1.0
URI scheme
Hos : <maserserver>:1556
BasePath : /netbackup
Schemes : HTTPS
Paths
GET /appdetails
Description
Gets the web service application details. The application names and satus are returned.
Responses
HTTP
Description Schema
Code
200 Web service application details returned successfully. appdetailsResponse
Invalid Accept type. Make sure your Accept header matches

406 errorResponse
what this API produces.
Produces

application/vnd.netbackup+json;version=1.0
POST /login
Description
Logs in with the username and password and receives a JSON Web Token (JWT) that is used on all
subsequent API requess.
Parameters
Type Name Schema
login
Body userPassLoginReques
required
Responses
HTTP
Description Schema
Code
Login successful.
201 Headers : loginResponse
Location (sring) : The URI that contains the authentication token.
400 Bad reques errorResponse
401 Wrong username or password. errorResponse
Invalid Accept type. Make sure your Accept header matches what
406 errorResponse
this API produces.
Unsupported Media Type. The media type specifed in the Content-

415 errorResponse
Type header is not supported by this API.
Consumes
Produces
POST /logout
Description
Removes the current access token (JWT), which invalidates that token for future API calls.

Responses
HTTP
Description Schema
Code
200 Logout successful. No Content
The Authorization header is missing, the token is invalid, or you

401 errorResponse
do not have permission for this action.
406 errorResponse
this API produces.
Security
Type Name
apiKey rbacSecurity
GET /ping
Description
Tess the connection to the gateway service from the client and returns the maser server time in
milliseconds.
Responses
HTTP
Description Schema
Code
200 Ping successful. Maser server time in milliseconds. sring
406 sring
this API produces.
Produces
text/plain
GET /tokenkey
Description
Gets the public key that can be used to validate the JSON Web Token (JWT).
Responses

HTTP
Description Schema
Code
200 Successfully retrieved the token key. sring
406 sring
this API produces.
Produces
text/html
Defnitions
appdetailsResponse
Type : < appdetailsResponse > array
appdetailsResponse
Name Description Schema
appName
Application name. sring
required
satus
Current run-time satus of the application. sring
required
errorResponse
errorCode
The NetBackup error code. integer (int64)
required
errorMessage
The NetBackup error code description. sring
required
loginResponse
token
The token to use for subsequent API requess. sring
required

tokenType
The token type for the token that is returned. sring
required
validity
The time in seconds that this token will be valid. integer
required
userPassLoginReques
domainName
The domain name for the user. sring
optional
domainType enum (NIS, NIS+,

The domain type for the user.
optional NT, vx, unixpwd)
password
The user password. sring
required
userName
The user account name. sring
required
Security
rbacSecurity
Type : apiKey
Name : Authorization
In : HEADER
NetBackup Adminisration API
Overview
The NetBackup Adminisration API provides access to adminisrative operations in NetBackup.
Version information
Version : 1.0

URI scheme
Schemes : HTTPS
Paths
GET /admin/jobs
Description
Gets the lis of jobs based on specifed flters. If no flters are specifed, information for 10
jobs sorted
in descending order by job sart time is retrieved. All the flters are based on
OData sandards, and

fltering on the following attributes is supported.
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[Ofset]" & "page[limit]" which allows for
subsequent requess to "page" through the res of the

results until the
end is reached.
Name Supported Description Schema

Operators
jobId eq ne lt gt The job identifer. integer(int64)

le ge
clientName contains, The name of the client to sring

sartswith, be protected.
endswith
endTime eq ne lt gt Specifes the time when date-time

le ge the job fnished.
sartTime eq ne lt gt Specifes the time when date-time

le ge the job sarted.
sate eq ne Specifes the sate of the sring

job.
Possible values:
QUEUED, ACTIVE,
REQUEUED, DONE,
SUSPENDED,
INCOMPLETE
satus eq ne lt gt Specifes the fnal job integer(int64)

le ge satus code.

jobType eq ne Specifes the type of the sring

job.
Possible values:
BACKUP, ARCHIVE,
RESTORE, VERIFY,
DUPLICATE,
IMPORT,
DBBACKUP, VAULT,
LABEL, ERASE, TPREQ,
TPCLEAN,
TPFORMAT,
VMPHYSINV, DQTS,
DBRECOVER,
MCONTENTS,
IMAGEDELETE,
LIVEUPDATE,
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
policyName contains, The name of the policy sring

sartswith, used by this job.
endswith
policyType eq ne Specifes the type of the sring

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
EXTENSIBLE,
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,
BIGDATA,
HYPERSCALE,
NBU_SEARCHSERVER
Parameters
Type Name Description Schema
flter
Query Specifes flters according to OData sandards. sring
optional
page[limit] The number of records on one page after the

Query integer (int64)
optional ofset.
page[ofset]
Query The job record number ofset. integer (int64)
optional
sort Sorts in ascending order on the specifed

Query sring
optional property. Prefx with '-' for descending order.
Responses
HTTP
Description Schema
Code
200 Successfully retrieved the lis of jobs based on the specifed flters. getJobsResponse
400 Bad reques. errorResponse


401 errorResponse
404 No entity found. errorResponse
405 Method not allowed. The specifed HTTP operation is invalid. errorResponse
406 errorResponse
this API produces.

415 errorResponse
500 An unexpected sysem error occurred. errorResponse
503 The server is busy. errorResponse
Produces
Security
Type Name
apiKey rbacSecurity
GET /admin/jobs/{jobId}
Description
Gets the job details for the specifed job.
Parameters
jobId
Path The job identifer. integer (int64)
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieved the job details for the specifed job. getJobDetailsResponse
The Authorization header is missing, the token is invalid, or

401 errorResponse
you do not have permission for this action.


406 errorResponse
Unsupported Media Type. The media type specifed in the

415 errorResponse
Content-Type header is not supported by this API.
Produces
Security
Type Name
apiKey rbacSecurity
DELETE /admin/jobs/{jobId}
Description
Deletes the specifed job.
Parameters
X-
NetBackup-
Header Audit- The audit reason for deleting the job. sring
Reason
optional
jobId
required
Responses
HTTP
Description Schema
Code

202 Reques accepted. No Content

401 errorResponse

415 errorResponse
Consumes
Security
Type Name
apiKey rbacSecurity
POST /admin/jobs/{jobId}/cancel
Description
Cancels the specifed job.
Parameters
X-
NetBackup-
Header Audit- The audit reason for cancelling the job. sring
Reason
optional
jobId
required
Responses
HTTP
Description Schema
Code


401 errorResponse

415 errorResponse
Consumes
Security
Type Name
apiKey rbacSecurity
GET /admin/jobs/{jobId}/fle-liss
Description
Gets the fle lis for the specifed job.
Parameters
jobId
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieved the fle lis for the specifed job. getJobFileLisResponse

401 errorResponse

406 errorResponse

415 errorResponse
Produces
Security
Type Name
apiKey rbacSecurity
POST /admin/jobs/{jobId}/resart
Description
Resarts the specifed job.
Parameters
X-
NetBackup-
Header Audit- The audit reason for resarting the job. sring
Reason
optional
jobId
required
Responses
HTTP
Description Schema

Code

401 errorResponse

415 errorResponse
Consumes
Security
Type Name
apiKey rbacSecurity
POST /admin/jobs/{jobId}/resume
Description
Resumes the specifed job.
Parameters
X-
NetBackup-
Header Audit- The audit reason for resuming the job. sring
Reason
optional
jobId
required

Responses
HTTP
Description Schema
Code

401 errorResponse

415 errorResponse
Consumes
Security
Type Name
apiKey rbacSecurity
POST /admin/jobs/{jobId}/suspend
Description
Suspends the specifed job.
Parameters
X-
NetBackup-
Header Audit- The audit reason for suspending the job. sring
Reason
optional
jobId


required
Responses
HTTP
Description Schema
Code

401 errorResponse

415 errorResponse
Consumes
Security
Type Name
apiKey rbacSecurity
GET /admin/jobs/{jobId}/try-logs
Description
Gets logs for the specifed job.
Parameters
jobId
required

Responses
HTTP
Description Schema
Code
200 Successfully retrieved the try-logs for the specifed job. getJobTryLogsResponse

401 errorResponse
Invalid Accept type. Make sure your Accept header

406 errorResponse
matches what this API produces.

415 errorResponse
Produces
Security
Type Name
apiKey rbacSecurity
Defnitions
errorResponse
errorCode
required
errorMessage
required

getJobDetailsResponse
Name Schema
data
data
optional
data
Name Schema
attributes
attributes
optional
id
integer (int64)
optional
links
links
optional
type
sring
optional
attributes
Indicates if
the job uses
acceleratorOptimization optimization
boolean
optional with the
NetBackup
Accelerator.
The process
activeProcessId
that is active integer (int64)
optional
now.
A UTC
timesamp of
activeTryStartTime
when the sring
optional
current try
sarted.
The domain
auditDomainName
name for sring
optional
auditing.

enum (INVALID, ACTIVE_DIRECTORY,

auditDomainType The auditing NIS_PLUS, VXAT_PRIVATE,
optional domain type. UNIX_PASSWORD, NIS, LOCAL_HOST,
UNKNOWN_AUTH)
The user
auditUserName
name in the sring
optional
audit record.
The backup
backupId
ID or image sring
optional
ID.
The name of
clientName
the client to sring
optional
be protected.
True if
compression
compression
is enabled on boolean
optional
the backup
policy.
The hos from

controlHos
which the job sring
optional
was initiated.
The backup
copyNumber
image copy integer (int64)
optional
number.
The current
currentFile
fle being sring
optional
protected.
enum (MOUNTING, POSITIONING,

CONNECTING, WRITING, VLT_INIT,
VLT_DUPIMG, VLT_DUPCMP,
VLT_BK_NBCAT, VLT_EJRPT,
VLT_COMPLETE, READING, DUPLICATE,
The current IMPORT, VERIFY, RESTORE, BACKUPDB,
currentOperation operation VAULT, LABEL, ERASE, SYNTH_DBQUERY,
optional being SYNTH_PROCESS_EXTENTS, SYNTH_PLAN,
performed. CREATE_SNAPSHOT, DELETE_SNAPSHOT,
RECOVERDB, MCONTENTS,
SYNTH_REQUERESOURCES, PARENT_JOB,
INDEXING, REPLICATE, RUNNING,
ASSEMBLING_FILE_LIST,
ALLOCATING_MEDIA)

The type of
enum (STANDARD,
data
dataMovement INSTANTRECOVERYDISK,
movement
optional INSTANTRECOVERYDISKANDTAPE,
used for this
SYNTHETIC, DISKSTAGING, SNAPSHOT)
job.
The
dedupRatio
deduplication integer (int64)
optional
rate achieved.
The
desination
desinationMediaId media server.
sring
optional Used for
deduplication
jobs.
The
desination
desinationStorageUnitName sorage unit.
sring
optional Used for
deduplication
jobs.
Indicates if
done
the job is integer (int64)
optional
complete.
The recovery
dumpHos appliance hos
sring
optional name for
Copilot.
endTime The job end

sring
optional time.
The esimated
esimatedFiles number of
integer (int64)
optional fles to be
protected.
Used
internally to
fag
frozenImage snapshots.
integer (int64)
optional Also used to
determine if
the job type is

snapshot.
The database
insance
insanceDatabaseName
and/or sring
optional
database name
itself.
The group
jobGroup
name of the sring
optional
job initiator.
jobId The job

integer (int64)
optional identifer.
The user
jobOwner
name of the sring
optional
job initiator.
enum (MEDIA_IN_USE, DRIVES_IN_USE,

MEDIA_SERVER_OFFLINE, ROBOT_DOWN,
MAX_STORAGE_UNIT_JOBS,
MEDIA_REQUEST_DELAY,
LOCAL_DRIVES_DOWN,
MEDIA_IN_DRIVE_IN_USE,
PHYSICAL_DRIVE_UNAVAILABLE,
CLEANING_MEDIA_UNAVAILABLE,
DRIVE_SCAN_HOST_OFFLINE,
DISK_MEDIA_SERVER_OFFLINE,
NO_MASTER_MEDIA_CONNECTIVITY,
MEDIA_SERVER_NON_ACTIVE_MODE,
The reason STORAGEUNIT_JOB_COUNTS_THROTTLED,
jobQueueReason
the job is JOB_HISTORY_DRIVES_IN_USE,
optional
queued. DISK_VOLUME_UNAVAILABLE,
MAX_CONCURRENT_VOLUME_READERS,
DISK_GROUP_UNAVAILABLE,
FAT_PIPE_IN_USE,
DISK_VOLUME_UNMOUNTING,
DISK_VOLUME_IN_USE,
MAX_PARTIAL_MEDIA,
LOGICAL_RESOURCE,
DRIVES_IN_STORAGE_UNIT_IN_USE,
STOP_DRIVE_SCAN,
DISK_VOLUME_MOUNTING,
MOUNT_FILE_EXISTS, PENDING_ACTION,
DISK_VOLUME_STREAM_LIMIT)
The name of

the resource
jobQueueResource
for which the sring
optional
queued job is
waiting.
enum (IMMEDIATE, SCHEDULED,

jobSubType The job sub- USERBACKUP, ERASETYPE_QUICK,
optional type. ERASETYPE_LONG, DBBACKUP_STAGING,
DBBACKUP_COLD, RMAN_CATALOG)
enum (BACKUP, ARCHIVE, RESTORE,

VERIFY, DUPLICATE, IMPORT, DBBACKUP,
VAULT, LABEL, ERASE, TPREQ, TPCLEAN,
TPFORMAT, VMPHYSINV, DQTS,
DBRECOVER, MCONTENTS,
IMAGEDELETE, LIVEUPDATE, GENERIC,
jobType REPLICATE, REPLICA_IMPORT, SNAPDUPE,
The job type.
optional SNAPREPLICATE, SNAPIMPORT,
APP_STATE_CAPTURE, INDEXING,
INDEXCLEANUP, SNAPSHOT, SNAPINDEX,
ACTIVATE_IR, DEACTIVATE_IR,
REACTIVATE_IR, STOP_IR,
INSTANT_RECOVERY, RMAN_CATALOG,
LOCKVM)
killable True if the job

boolean
optional can be killed.
The actual
data
transferred in
kilobytes. For
kilobytesDataTransferred some jobs,
integer (int64)
optional data
transferred is
diferent than
the fnal
image size.
The remaining
kilobytesToTransfer
kilobytes to integer (int64)
optional
be transferred.
The esimated
amount of
kilobytesTransferred
data integer (int64)
optional
transferred in
kilobytes.

The UTC
lasUpdateTime timesamp
sring
optional when the job
was modifed.
The process
ID of the main
controlling
mainProcessId
process for integer (int64)
optional
resore and
image
cleanup.
The actual
numberOfFiles number of
integer (int64)
optional fles
protected.
For vault jobs,

the total
numberOfTapeToEject
number of integer (int64)
optional
tape media to
be ejected.
parentJobId The parent job

integer (int64)
optional ID.
The esimated
percentComplete completion
integer (int64)
optional percentage of
this job.
The name of
policyName the policy
sring
optional used by this
job.
enum (STANDARD, PROXY,

NONSTANDARD, APOLLO_WBAK,
OBACKUP, ANY, INFORMIX, SYBASE,
SHAREPOINT, WINDOWS, NETWARE,
BACKTRACK, AUSPEX_FASTBACK,
WINDOWS_NT, OS2, SQL_SERVER,
The backup EXCHANGE, SAP, DB2, NDMP,
policyType policy type FLASHBACKUP, SPLITMIRROR, AFS, DFS,
optional used by the EXTENSIBLE, LOTUS_NOTES,
job. 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)
priority The priority

integer (int64)
optional of this job.
The name of
profleName
the Vault sring
optional
profle.
resartable True if the job

boolean
optional is resartable.
The lis of
resoreBackupIDs backup IDs
sring
optional needed for the
resore job.
resumable True if the job

boolean
optional is resumable.
The retention
retentionLevel
level of the integer (int64)
optional
backup image.
The name of
robotName
the robot in sring
optional
the Vault job.
The name of
the backup
scheduleName
schedule used sring
optional
by the backup
job.
enum (FULL,
The type of
DIFFERENTIAL_INCREMENTAL,
scheduleType schedule used
USER_BACKUP, USER_ARCHIVE,
optional by the backup
CUMULATIVE_INCREMENTAL,
job.
TRANSACTION_LOG)
sessionId The Vault

integer (int64)
optional session ID.
The source
media ID for
sourceMediaId

the sring
optional
duplication
job.
The source
media server
sourceMediaServerName
name for the sring
optional
duplication
job.
sourceStorageUnitName The source

sring
optional sorage unit.
The UTC
sartTime timesamp
sring
optional when the job
was sarted.
The current
sate enum (QUEUED, ACTIVE, REQUEUED,
sate of the
optional DONE, SUSPENDED, INCOMPLETE)
job.
satus The fnal job

integer (int64)
optional satus code.
The job
sreamNumber
sream integer (int64)
optional
number.
The job
submissionType
submission integer (int64)
optional
type.
True if the job

suspendable
is boolean
optional
suspendable.
The data
transfer rate in
transferRate
kilobytes integer (int64)
optional
(KB) per
second.
The data
transportType transport type
enum (LAN, FAT)
optional used for the
job.
The current

try try number to

integer (int64)
optional execute this
job.
The Vault
vaultName
name used by sring
optional
the job.
links
Name Schema
fle-liss
fle-liss
optional
self
self
optional
try-logs
try-logs
optional
fle-liss
Name Schema
href
sring
optional
self
Name Schema
href
sring
optional
try-logs
Name Schema
href
sring
optional
getJobFileLisResponse
Name Schema

data
data
optional
data
Name Schema
attributes
attributes
optional
id
integer (int64)
optional
links
links
optional
type
sring
optional
attributes
Name Schema
fleLis
< sring > array
optional
links
Name Schema
self
self
optional
self
Name Schema
href
sring
optional
getJobTryLogsResponse
Name Schema
data
data
optional

data
Name Schema
attributes
attributes
optional
id
integer (int64)
optional
links
links
optional
type
sring
optional
attributes
Name Schema
log
< sring > array
optional
links
Name Schema
self
self
optional
self
Name Schema
href
sring
optional
getJobsResponse
Name Schema
data
data
optional
links
links
optional

meta
meta
optional
data
Name Schema
attibutes
< getJobDetailsResponse > array
optional
id
integer (int64)
optional
type
sring
optional
links
Name Schema
frs
frs
optional
las
las
optional
next
next
optional
prev
prev
optional
self
self
optional
frs
Name Schema
href
sring
optional
las
Name Schema

href
sring
optional
next
Name Schema
href
sring
optional
prev
Name Schema
href
sring
optional
self
Name Schema
href
sring
optional
meta
Name Schema
pagination
pagination
optional
pagination
Name Schema
count
integer (int64)
optional
frs
integer (int64)
optional
las
integer (int64)
optional
limit
integer (int64)
optional

next
integer (int64)
optional
ofset
integer (int64)
optional
page
integer (int64)
optional
pages
integer (int64)
optional
prev
integer (int64)
optional
Security
rbacSecurity
Type : apiKey
In : HEADER
NetBackup Catalog API
Overview
The NetBackup Catalog API provides access to the NetBackup catalog.
Version information
Version : 1.0
URI scheme
Schemes : HTTPS

Paths
GET /catalog/images
Description
Get the lis of images based on specifed flters. If no flters are specifed, information for the las 10
images
made within the las 24 hours is returned.
All the flters are based on OData sandards and

fltering on the following attributes is supported.
Name Supported Description Schema

Operators
backupId eq Specifes the backup ID. sring
backupTime ge le Specifes the backup time. date-time
clientName eq Specifes the client name. sring
policyType eq Specifes the policy type. sring
policyName eq Specifes the policy name. sring
scheduleType eq Specifes the schedule type. Possible sring

values: FULL
DIFFERENTIAL_INCREMENTAL
USER_BACKUP
USER_ARCHIVE
CUMULATIVE_INCREMENTAL
Parameters
Type Name Description Schema Default
flter
Query The flter criteria in OData format. sring
optional
page[limit]
Query The number of images on one page. integer 10
optional
page[ofset]
Query The image record number ofset. integer 0
optional
Responses
HTTP
Description Schema

Code
200 Returned the lis of catalog images based on the flter criteria. imageLis
400 Invalid flter criteria. errorResponse

401 errorResponse
404 No images were found that met the flter criteria. errorResponse
Produces
Security
Type Name
apiKey rbacSecurity
GET /catalog/images/{backupId}
Description
Requess the details of an image.
Parameters
Type Name Schema
backupId
Path sring
required
Responses
HTTP
Description Schema
Code
200 Image details were returned successfully. imageDetail
400 The backup ID is invalid. errorResponse

401 errorResponse
404 No images were found with the specifed backup ID. errorResponse
406 errorResponse

this API produces.
Produces
Security
Type Name
apiKey rbacSecurity
GET /catalog/vmware-images/{backupId}
Description
Requess the details of a VMware image.
Parameters
Type Name Schema
backupId
Path sring
required
Responses
HTTP
Description Schema
Code
200 VMware image details returned successfully. vmwareImageDetail
400 The backup ID is invalid. errorResponse

401 errorResponse
404 The VMware image was not found. errorResponse
Produces
Security
Type Name
apiKey rbacSecurity

Defnitions
errorResponse
errorCode
required
errorMessage
required
fragment
blockSize
The block size used when writing the backup. integer
optional
checkpoint
Internal use. integer
optional
In NetBackup 6.5 and later, for the frs fragment

copyDate
of each copy, the ISO-8601 timesamp that the sring (date-time)
optional
copy was written. Otherwise the value is 0.
copyNumber
The copy number for this record. integer
optional
The backup data format. These enums are the same

enum (TAR,
dataFormat as the "data format types"
in NetBackup (for
SNAPSHOT,
optional example, DF_TAR, DF_SNAPSHOT and
NDMP_DUMP)
DF_NDMP).
density
The NetBackup density of the media written to. integer
optional
The device that the copy was written on. This is

deviceWrittenOn
the tape drive index, or -1 for non-tape media integer
optional
based backups.
expiration The ISO-8601 timesamp of expiration date of this

sring (date-time)
optional copy.
The fle number. This number is a numeric value

fleNumber that indicates the fle number on the media. This

integer
optional number is displayed in the Activity Monitor under
the Job Detailed Status as "positioning to fle".
frsBlock
optional
fragmentFlags
optional
fragmentNumber The fragment number of this record within this

integer
optional copy.
hos The name of the hos that wrote this image copy to
sring
optional media.
kbytes64
The size of the fragment in kilobytes. integer
optional
lasBlock
optional
mediaDate The UTC timesamp of the AssignTime for tape

integer
optional media.
mediaDesc
Internal use. sring
optional
mediaId
The media ID or path this fragment is written to. sring
optional
mediaSequenceNumber
optional
mediaSubtype
optional
mediaType
optional
multiplex
optional
ofset
optional
remainder
optional
resumeNumber
optional

retentionLevel
optional
slpTryToKeepDate
optional
image
Name Schema
attributes
imageAttributes
required
id
sring
required
links
links
required
relationships
imageRelationships
optional
type
sring
required
links
Name Schema
self
self
required
self
Name Schema
href
sring
required
imageAttributes
The type of backup copy.

These enums are the same as
enum (DEFAULT, TPC,
backupCopyType the "backup copy consants"

MEDIA_SERVER, NAS,
required in NetBackup, for example,
SNAPSHOT, NDMP)
BC_DEFAULT, BC_TPC,
etc.
backupId The backup ID of the backup

sring
optional image record.
backupStatus The NetBackup exit satus of

integer
required the backup job.
backupTime The time used for backup

sring (date-time)
required image ID in ISO-8601 format
The time used for Block

Level Incremental Backups
blockIncrementalFullTime
(BLIB). A non-zero value integer
required
indicates the current backup
time if BLIB is performed.
Integer representation of the

clientCharset
character set used when the integer
required
client calls bpcd.
clientName The name of the client

sring
required protected by this image.
compression Indicates whether software

boolean
required compression is used.
contentFile The flename of the content

sring
required (*.f) fle.
enum (UNKNOWN, NOT,

contentFileCompressed Type of compression used on
LEGACY, SCRIPT_OLD,
required the content fle (*.f).
SCRIPT_NEW, ZLIB)
contentFileSize
The size of content fle. sring
required
creator The user name of backup

sring
required initiator.
dataClassifcation The data class specifed in the

sring
required policy.
drMediaLis A lis of tape media IDs

< sring > array
required required for DR.
The amount of time (in

elapsedTimeSeconds
seconds) that the backup took integer

required
to run to completion.
encryption
Type of encryption used. enum (NONE, LEGACY, CIPHER)
required
expiration The ISO 8601 timesamp for

sring (date-time)
required the expiration of this image.
extendedSecurityInfo True if extended security

boolean
required information was used.
fleSysemOnly This is a type of recovery

boolean
required option.
fragments The fragment lis for all

< fragment > array
optional copies of the image.
imageDumpLevel
The NDMP dump level. integer
required
Identifes the image as one of

the following types: 0 =
REGULAR or normal
backup, 1 = PRE_IMPORT or
Phase 1 import of this image
imageType enum (NORMAL, PRE_IMPORT,
is completed, 2 =
required IMPORTED)
IT_IMPORTED or Phase 2
import of this image is
completed; this value also
means that an imported image
was backed up.
jobId
The backup job ID. integer
required
kbytes The number of kilobytes (KB)

integer
required backed up.
kbytesDataTransferred The number of bytes

integer
required transferred.
keyword
The backup policy keyword. sring
required
mpx Indicates if the image is

boolean
required multiplexed on tape.
numCopies The number of copies of this

integer
required image.

numFiles The number of fles backed

integer
required up.
The total number of

numberFragments fragments including all
integer
required copies, that is, the length of
the "fragments" array.
originMaserServer The name of the origin maser

sring
required server.
policyName The name of the backup

sring
required policy.
This value describes what

agent generated the image
"Standard", "Oracle", "MS-
policyType
Windows", "VMware", sring
required
"Hyper-V", "MS-SQL-
Server", "MS-Exchange-
Server", etc.
primaryCopy The default copy to use for

integer
required resores and duplications.
proxyClient The hos name of the proxy

sring
required client used for the backup.
The UTC timesamp for the

remoteExpiration REMOTE expiration of this
integer
required image. See "Auto Image
Replication".
retentionLevel The retention level of the

integer
required image.
scheduleName The name of the schedule

sring
required used to create the backup.
The type of schedule. These

enums are the same as the
enum (FULL,
"schedule types" in
scheduleType NetBackup, for example,
USER_BACKUP,
required ST_FULL, ST_DINC,
USER_ARCHIVE,
ST_UBACKUP,
CUMULATIVE_INCREMENTAL)
ST_UARCHIVE and
ST_CINC.
Indicates that the sorage

slpCompleted lifecycle policy (SLP) has

integer
required satisfed all its operations on
this image.
slpName The name of the SLP

sring
required managing this image.
slpVersion The version number of the

integer
required SLP managing this image.
snapshotTime The time in ISO-8601 format

sring (date-time)
optional when the snapshot was taken.
The UTC timesamp for the

tirExpiration
expiration of the True Image integer
required
Recovery (TIR) data.
version
The image format version. integer
required
imageDetail
Name Schema
data
image
required
imageLis
Name Schema
data
< image > array
required
imageRelationships
Name Schema
vmwareImage
vmwareImage
optional
vmwareImage
Name Schema
data
data

required
links
links
required
data
Name Schema
id
sring
required
type
sring
required
links
Name Schema
related
related
required
related
Name Schema
href
sring
required
vmwareImage
Name Schema
attributes
attributes
required
id
sring
required
links
links
required
relationships
relationships
optional
type
sring
required

attributes
backupTime The time used for backup image ID

sring (date-time)
required in ISO-8601 format
biosUUID The BIOS UUID of the virtual

sring
required machine.
client The name of the client protected by

sring
required this image.
cluser The cluser that the virtual machine

sring
required belongs to.
datacenter The data center of the virtual

sring
required machine.
esxiServer The ESX server name of the virtual

sring
required machine.
insanceUUID The Insance UUID of the virtual

sring
required machine.
ipAddress The IP address of the client that is

sring
required protected by this image.
policyName
The name of the backup policy. sring
required
The name of the resource pool or a

vApp that was assigned to the VM
resourcePoolOrVapp when it was backed up. A resource
sring
required pool is a way of controlling
resources. A VM is always in a
resource pool.
The type of schedule. These enums

enum (FULL,
are the same as the "schedule types"
scheduleType in NetBackup, for example,
USER_BACKUP,
required ST_FULL, ST_DINC,
USER_ARCHIVE,
ST_UBACKUP, ST_UARCHIVE
CUMULATIVE_INCREMENTAL)
and ST_CINC.
The name of the vCloud Director

vCDOrg Organization or tenant that a VM
sring
required belonged to if the backup was a
vCloud Director backup.

The name of the Virtual DataCenter

vCDOrgVDC
the VM resided in if the backup was sring
required
a vCloud Director backup.
The name of the vCloud Director

vCDServer
server if the backup was a vCloud sring
required
Director backup.
The name of the vApp that the VM

vCDVApp
is part of if the backup was a sring
required
The logical name of the VM inside

vCDVmName
the vApp if the backup was a sring
required
vCenter The name of the vCenter hosing

sring
required the virtual machine.
vmDNSName The DNS name of the virtual

sring
required machine.
vmDisplayName The display name of the virtual

sring
required machine.
vmFolder The datasore path where the virtual

sring
required machine is sored.
vmHosName The hos name of the virtual

sring
required machine.
The name of the datasore where the

vmxDatasore
VM confguration fles were sring
required
located.
links
Name Schema
self
self
required
self
Name Schema
href
sring

required
relationships
Name Schema
image
image
optional
image
Name Schema
data
data
required
links
links
required
data
Name Schema
id
sring
required
type
sring
required
links
Name Schema
related
related
required
related
Name Schema
href
sring
required
vmwareImageDetail

Name Schema
data
vmwareImage
required
Security
rbacSecurity
Type : apiKey
In : HEADER
NetBackup Confguration API
Overview
The NetBackup Confguration API provides access to NetBackup confguration.
Version information
Version : 1.0
URI scheme
Schemes : HTTPS
Paths
POST /confg/hoss
Description
Creates a hos entry in database.

Parameters
X-
NetBackup-
Header Audit- The audit reason for creating the hos. sring
Reason
optional
Hos Data The properties of the hos to be added in the

Body posCreateHosReques
required database.
Responses
HTTP
Description Schema
Code
Successfully created a hos database entry.

201 Headers : No Content
Location (sring) : The URI of the created hos entry.
400 Bad or invalid reques. errorResponse

401 errorResponse
409 The server already exiss in the database. errorResponse

415 errorResponse
Consumes
Security
Type Name
apiKey rbacUserSecurity
GET /confg/hoss
Description
Gets all hoss information.

Responses
HTTP
Description Schema
Code
200 Successfully fetched all hoss information. hossResponse

401 errorResponse
406 errorResponse
this API produces.
Produces
Security
Type Name
GET /confg/hoss/hosmappings
Description
Fetches a lis of hoss and the details of their hos ID-to-hos name mappings. The results depend on
one or more parameters or conditions, such as isapproved , isconflict , isshared , and
isaddedmanually . The result set is determined, if all specifed conditions are true.
Parameters
Fetches a lis of hoss and the details of their

isaddedmanually
Query hos ID-to-hosname mappings based on the boolean
optional
value of the isaddedmanually parameter.

isapproved
Query hos ID-to-hos name mappings based on the boolean
optional
value of the isapproved parameter.

isconfict
optional
value of the isconfict parameter.

isshared

optional
value of the isshared parameter.

mappedHosName
Query hos ID-to-hos name mappings based on the sring
optional
value of the mappedhosname parameter.
Responses
HTTP
Description Schema
Code
200 Successfully fetched hos information. hossResponse

401 errorResponse
406 errorResponse
this API produces.
Produces
Security
Type Name
GET /confg/hoss/{hosId}
Description
Gets information for the specifed hos ID.
Parameters
hosId
Path The hos ID of the hos. sring
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieved hos information. hosResponse


401 errorResponse
404 No hos exiss with hos ID. errorResponse
406 errorResponse
this API produces.
Produces
Security
Type Name
PATCH /confg/hoss/{hosId}
Description
Updates information for a hos with the specifed hos ID. Only the NetBackup adminisrator can
update the 'autoReissue' parameter. To update all other parameters, you mus have certifcate
authentication.
Parameters
X-
NetBackup-
Header Audit- The audit reason for updating the hos properties. sring
Reason
optional
hosId
Path Hos ID of the hos. sring
required
Hos
Body Properties Properties of the hos to be updated. patchHosProperties
required
Responses
HTTP
Description Schema
Code

204 Hos information is successfully updated. No Content
400 Bad or Invalid Reques. errorResponse

401 errorResponse
404 No hos associated with the specifed hos ID. errorResponse
409 The hos already exiss. errorResponse

415 errorResponse
Consumes
Security
Type Name
PUT /confg/hoss/{hosId}/comment
Description
Updates comment for the hos that is associated with the specifed hos ID.
Parameters
hosId
required
HosCommentDetails
Body Hos-specifc comment to be updated. putHosCommentDetails
required
Responses
HTTP
Description Schema
Code
200 Successfully updated the hos information. No Content

400 Bad or invalid reques. errorResponse

401 errorResponse
404 No hos associated with the specifed hos ID exiss. errorResponse

415 errorResponse
Consumes
Security
Type Name
GET /confg/hoss/{hosId}/hosmappings
Description
Fetches the details of the hos ID-to-hos name mappings that are associated with the specifed hos
ID.
Parameters
hosId Specifes the hos ID for which you want to add

Path sring
required mappings.
Provides a lis of approved or pending mappings

isapproved
Query of the hos ID based on the specifed parameter boolean
optional
value.
Responses
HTTP
Description Schema
Code
200 Successfully retrieved hos information. hosMappingsDetails

401 errorResponse
404 No hos exiss with specifed hos ID. errorResponse


406 errorResponse
Produces
Security
Type Name
PUT /confg/hoss/{hosId}/hosmappings/{mappedHosName}
Description
Adds mappings for the specifed hos ID.
Parameters
X-NetBackup-
Specifes the audit reason for adding the
Header Audit-Reason sring
hos ID-to-hos name mapping.
optional
hosId Specifes the hos ID for which you want

Path sring
required to add mappings.
mappedHosName Hos ID-to-hos name mapping to be

Path sring
required added.
HosMappingDetails
Body The properties of the hos to be mapped. putAddHosMapping
required
Responses
HTTP
Description Schema
Code
Successfully updated the hos mapping properties for the specifed hos
200 No Content
ID.
201 Successfully added the hos mapping to the specifed hos ID. No Content
400 Invalid parameter with reques payload. errorResponse


401 errorResponse
409 A confict in the hos ID-to-hos name mapping was detected. errorResponse

415 errorResponse
Consumes
Security
Type Name
DELETE /confg/hoss/{hosId}/hosmappings/{mappedHosName}
Description
Deletes hos mappings that are associated with the specifed hos ID.
Parameters
X-NetBackup-
Specifes the reason for deleting the hos ID-
Header Audit-Reason sring
to-hos name mapping.
optional
hosId Specifes the hos ID that is associated with

Path sring
required the mapping that you want to delete.
mappedHosName Specifes the hos ID-to-hos name mapping

Path sring
required that you want to delete.
Responses
HTTP
Description Schema
Code
204 Successfully deleted the hos mapping for the specifed hos ID. No Content

401 errorResponse
404 The specifed hos mapping was not found. errorResponse

406 errorResponse
this API produces.
Produces
Security
Type Name
PUT /confg/hoss/{hosId}/reset
Description
Resets information for a hos with hos ID specifed.
Parameters
X-
NetBackup-
Header Audit- The audit reason for resetting the hos. sring
Reason
optional
hosId
required
Responses
HTTP
Description Schema
Code
200 Successfully reset the hos entry. No Content

401 errorResponse
404 No hos exiss with the specifed hos ID. errorResponse
406 errorResponse
this API produces.

Security
Type Name
GET /confg/hoss?name={hosName}
Description
Gets information for a hos with name specifed.
Parameters
hosName
Query The name of the hos. sring
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieved hos information. hosResponse

401 errorResponse
404 No hos exiss with the specifed hos name. errorResponse
Produces
Security
Type Name
GET /confg/policies/
Description
Liss all of the NetBackup policies.

Responses
HTTP
Description Schema
Code
200 Successfully retrieved the lis of policies. lisPoliciesResponse

401 errorResponse

406 errorResponse
500 Unexpected sysem error. errorResponse
Produces
Security
Type Name
GET /confg/policies/{policyName}
Description
Get the details for a specifed Oracle policy.
Parameters
policyName
Path The name of the policy. sring
required
Responses
HTTP
Description Schema
Code
Successfully retrieved the policy details.

200 Headers : policyOracleResponse
ETag (integer) : The current generation ID of the policy.

401 errorResponse

404 The specifed policy was not found. errorResponse

406 errorResponse
501 Not implemented for policies other than Oracle policies. errorResponse
Produces
Tags
Public
Security
Type Name
PUT /confg/policies/{policyName}/backupselections
Description
Replaces the exising backup selections with the specifed lis of backup selections.
Parameters
If-Match
Header The generation ID of the policy. sring
optional
X-NetBackup-
Header Audit-Reason The audit reason for changing the policy. sring
optional
policyName
required
backupSelections
Body The lis of paths for the policy backup. putIncludeReques
required
Responses

HTTP
Description Schema
Code
204 Successfully updated the backup selections. No Content
400 Failed to parse the JSON body. errorResponse

401 errorResponse
412 A conditional update failed because of mismatched generation IDs. errorResponse

415 errorResponse
Consumes
Security
Type Name
DELETE /confg/policies/{policyName}/backupselections
Description
Removes the exising backup selections for the specifed policy.
Parameters
If-Match
optional
X-
NetBackup-
Header Audit- The audit reason for changing the policy. sring
Reason
optional
policyName
required

Responses
HTTP
Description Schema
Code
204 Successfully removed the backup selection. No Content

401 errorResponse
406 errorResponse
this API produces.
Produces
Security
Type Name
PUT /confg/policies/{policyName}/clients/{clientName}
Description
Adds or modifes a client for the specifed policy. It can also modify an insance group, insance, or
database for the specifed policy.
Parameters
If-Match
optional
X-
NetBackup-
Reason
optional

clientName
Path The hos name of the client. sring
required
policyName
required
client
Body The client to be backed up. putClientReques
required
Responses
HTTP
Description Schema
Code
Successfully added a client, insance group, insance, or database for

the specifed policy.
201 No Content
Headers :
204 Successfully updated the specifed client in the policy. No Content

401 errorResponse

415 errorResponse
Consumes
Security
Type Name
DELETE /confg/policies/{policyName}/clients/{clientName}
Description

Removes the exising client for the specifed policy.
Parameters
If-Match
optional
X-
NetBackup-
Reason
optional
clientName
Path The hos name of the client. sring
required
policyName
required
Responses
HTTP
Description Schema
Code
204 Successfully removed the client. No Content

401 errorResponse
404 The specifed policy or client was not found. errorResponse
406 errorResponse
this API produces.
Produces
Security
Type Name

PUT /confg/policies/{policyName}/schedules/{scheduleName}
Description
Adds or updates a schedule in the specifed policy.
Parameters
If-Match
optional
X-NetBackup-
optional
policyName
required
scheduleName
Path The name of the schedule. sring
required
schedule
Body The policy schedule to add or update. putScheduleReques
required
Responses
HTTP
Description Schema
Code
Successfully created the schedule.

201 Headers : No Content
204 Successfully updated the schedule. No Content

401 errorResponse

415 errorResponse

Consumes
Security
Type Name
DELETE /confg/policies/{policyName}/schedules/{scheduleName}
Description
Removes a schedule from the specifed policy.
Parameters
If-Match
optional
X-NetBackup-
optional
policyName
required
scheduleName
Path The name of the schedule. sring
required
Responses
HTTP
Description Schema
Code
204 Successfully deleted the schedule. No Content

401 errorResponse
404 The specifed policy or schedule was not found. errorResponse
406 errorResponse
this API produces.

Produces
Security
Type Name
POST /confg/servers/vmservers
Description
Creates VM server credentials.
Parameters
Type Name Schema
vmserver
Body vmserver
required
Responses
HTTP
Description Schema
Code
201 Successfully added the VM server credentials. No Content
400 Failed to parse the JSON body, or the entity already exiss. errorResponse

401 errorResponse

415 errorResponse
Consumes
Security

Type Name
GET /confg/servers/vmservers/{serverName}
Description
Liss the VM server credentials.
Parameters
Type Name Schema
serverName
Path sring
required
Responses
HTTP
Description Schema
Code
200 VM server credentials found. vmserverResponse

401 errorResponse
404 No VM server credentials found. errorResponse
406 errorResponse
this API produces.
Produces
Security
Type Name
GET /confg/servers/wssendpoints
Description
Liss all the hoss that serve as NetBackup WebSocket servers.

Responses
HTTP
Description Schema
Code
200 Lis of available hoss. hosGenericSchemaArray
The Authorization header is missing, the token is invalid,

401 errorResponse
or you do not have permission for this action.

406 errorResponse
503 Service unavailable. errorResponse
Produces
POST /confg/servers/wssendpoints/save
Description
Adds the hos to the lis of NetBackup WebSocket Servers. Note: VALIDATEHOST or
VALIDATEURL API needs to be called before the SAVE endpoint is called.
Parameters
Hos
Body confguration The details for the hos. hosGenericSchema
required
Responses
HTTP
Description Schema
Code
The hos was added successfully to the lis of NetBackup WebSocket

201 emptyResponse
Servers.

401 errorResponse

415 errorResponse

500 The certifcate did not match with the one accepted by the user. errorResponse
Consumes
POST /confg/servers/wssendpoints/update
Description
Updates the sate of the specifed hos in the WebSocket Servers lis. Note: SAVE API needs to be
called before the update API is called.
Parameters
Hos
Body confguration The hosname and sate to update. updateHosSchema
required
Responses
HTTP
Description Schema
Code
200 Hos details saved successfully. emptyResponse

401 errorResponse

415 errorResponse
503 Communication with the Enterprise Media Manager failed. errorResponse
Consumes
POST /confg/servers/wssendpoints/validatehos

Description
Checks if the hos is valid using the information provided in the JSON fle.
Parameters
Hos
Body confguration The details for the hos. hosGenericSchema
required
Responses
HTTP
Description Schema
Code
200 Hos validation successful. hosGenericSchema

401 errorResponse

406 errorResponse

415 errorResponse
500 Unable to esablish a connection to the specifed URL. errorResponse
Consumes
Produces
Security
Type Name
POST /confg/servers/wssendpoints/validateurl
Description

Checks if the hos is valid using the URL provided.
Parameters
URL The NetBackup WebSocket Service (WSS)

Body urlSchema
required endpoint URL.
Responses
HTTP
Description Schema
Code
200 Hos validation successful. hosGenericSchema

401 errorResponse

406 errorResponse

415 errorResponse
503 Communication with the Enterprise Media Manager server failed. errorResponse
Consumes
Produces
Security
Type Name
DELETE /confg/servers/wssendpoints/{hosName}
Description

Deletes the specifed hos name from the NetBackup WebSocket servers lis.
Parameters
hosName
Path The hos name of the hos to delete. sring
required
Responses
HTTP
Description Schema
Code
200 The hos name was deleted successfully. emptyResponse

401 errorResponse
404 The hos name could not be found. emptyResponse

415 errorResponse
Consumes
Defnitions
emptyResponse
Type : object
errorResponse
errorCode
required
errorMessage
required

hosGenericSchema
certifcate The signing certifcate that is provided by the maser

sring
required server to esablish a secure connection.
enum
connectionState Indicates whether or not the hos is connected. Possible
(CONNECTED,
optional values are null, connected, and disconnected.
DISCONNECTED)
groupId
The group identifer of the hos. sring
required
hosName
The hos name for the communicating hos. sring
required
Specifes the order in which to attempt to connect to the

priority
hos. NetBackup attempts to connect to the hos that has integer
required
the highes priority.
enum
sate Indicates the sate of the hos. Possible values are null,
(ACTIVATED,
optional activated, and deactivated.
DEACTIVATED)
token The authentication token that is required to make API

sring
required calls.
url
The NetBackup WebSocket Service (WSS) endpoint URL. sring
required
hosGenericSchemaArray
Type : < hosGenericSchema > array
hosMappingsDetails
hosMappings The lis of hos mappings associated with the specifed < mappingDetails >
optional hos. array
timeToLiveInMin The time duration (in minutes) for which the response
integer
optional provided by the URI is valid.
hosResponse

autoReissue Specifes whether the hos requires a reissue token to

boolean
required reissue a certifcate or not.
The time duration (in milliseconds) for which the

autoReissueDuration
certifcate can be deployed on the hos without number
required
requiring a reissue token.
comment
Comment provided for the hos. sring
required
cpuArchitecture
The CPU architecture of the hos. sring
required
createdDateTime
The time that the hos entry was made, in UTC. integer
required
hosMappings The lis of hos mappings that are associated with the < mappingDetails
required hos. > array
hosName
The name of the hos. sring
required
hwDescription
The hardware description of the hos. sring
required
insalledEEBs
The NetBackup EEBs that are insalled on the hos. sring
required
isSecureEnabled Specifes whether the hos can communicate securely

boolean
required or not.
lasUpdatedDateTime The time when the hos entry was las updated, in
integer
required UTC.
maserServer The NetBackup maser server that is associated with

sring
required the hos.
nbuVersion
The NetBackup version on the hos. sring
required
osType
The operating sysem type of the hos. sring
required
osVersion
The operating sysem of the hos. sring
required
servers
A lis of servers associated with the hos. < sring > array
required

uuid
The unique ID of the hos. sring
required
hosStatus
Specifes whether the connection between the hoss

should proceed or should be dropped. The maser server
sends either of the following connection decisions: enum
connectionDecision
CONTINUE, DROP (CONTINUE,
required
DROP)
Communication between the hoss is proceeded or
dropped depending on the connection decision.
errorCode
The NetBackup error code. integer
required
errorMessage NetBackup error code sring that describes the error

sring
required code.
hosId
The hos ID of the peer hos. sring
optional
timeToLiveInMin The time duration (in minutes) for which the response
integer
required provided by the URI is valid.
hossResponse
Name Schema
hoss
< hosResponse > array
optional
lisPoliciesResponse
Name Schema
data
< data > array
optional
data
attributes
object

optional
id
The name of the policy. sring
optional
links
A lis of URIs to get more information about each policy. links
optional
type
The type of the policy. sring
optional
links
Name Schema
self
self
optional
self
href
A link to the policy details. sring
optional
mappingDetails
createdOn The time the hos ID-to-hos name

integer (int64)
required mapping was created, in UTC.
isAddedManually Specifes whether the mapping was

boolean
required added manually or not.
isApproved Specifes whether the new mapping is

boolean
required approved or not.
isConficting Specifes whether mapping already

boolean
required exiss for another hos ID.
isShared Specifes whether the mapping is

boolean
required shared across hoss.
mappedHosName The name of the mapped hos that is

sring
required associated with the mapping details.
enum

(CERTIFICATE_DEPLOYMENT,
origin Specifes how the hos ID-to-hos USER_ADDED,
required name mapping was added. HOST_DISCOVERY,
COMMUNICATION_DISCOVERY,
ADD_HOST)
Specifes the time when the hos ID-

updatedOn
to-hos name mapping was las integer (int64)
required
updated.
patchHosProperties
Specifes whether or not an automatic reissue of the

autoReissue certifcate is allowed. If this parameter is set and is
boolean
optional valid, a certifcate can be deployed on the hos without
requiring a reissue token.
A lis of cluser shared names that are associated with

the hos. This is an optional feld. Hos Mappings only
cluserSharedNames
get ADDED if "cluserSharedNames" is specifed. < sring > array
optional
Adminisrator approval is required for the new cluser
shared name.
cpuArchitecture
optional
hosName
optional
hwDescription
optional
insalledEEBs
The NetBackup EEBs insalled on the hos. sring
optional
isSecureEnabled Specifes whether or not the hos can communicate

boolean
optional securely.
maserServer The NetBackup maser server that is associated with

sring
optional the hos.
nbuVersion
optional
osType
optional

osVersion
optional
servers
A lis of servers associated with the hos. < sring > array
optional
peerHosInfo
hosId
The hos ID of the discovered peer hos. sring
optional
hosName
The name of the peer hos that is used for the connection. sring
required
policy
backupSelections The pathnames and directives refecting data to be

backupSelections
optional backed up for the Oracle elements covered by this policy.
clients
The lis of client information. < clients > array
optional
policyAttributes
The attributes of the policy. policyAttributes
optional
policyName
The name of the policy. sring
optional
policyType
The type of the policy. sring
optional
schedules
The lis of schedules information. < schedules > array
optional
backupSelections
Name Schema
selections
< sring > array
optional
clients

enum (HP-UX11.31,
Debian2.6.18,
RedHat2.6.18,
SuSE3.0.76,
IBMzSeriesRedHat2.6.18,
IBMzSeriesSuSE3.0.76,
NDMP, NetWare,
OpenVMS_I64, AIX6,
Solaris10,
OS Solaris_x86_10_64,
The hos’s operating sysem.
optional Windows, Windows10,
Windows2003,
Windows2008,
Windows2012,
Windows2012_R2,
Windows2016,
Windows7, Windows8,
Windows8.1,
WindowsVisa,
WindowsXP)
databaseName The name of the database to be used with Protect

sring
optional Insances and Databases.
enum (HP-UX-IA64,
Linux, Linux-s390x,
hardware NDMP, Novell,
The hos’s hardware.
optional OpenVMS4, RS6000,
Solaris, Windows-x64,
Windows-x86)
hosName
The name of the hos to be backed up. sring
optional
insanceGroup
The name of the insance group to be backed up. sring
optional
insanceName The name of the insance to be used with Protect

sring
optional Insances and Databases.
policyAttributes
active Indicates if the policy is

boolean
optional active or disabled.

If performing of-hos
backups with an alternate
alternateClientHosname client, the name of the
sring
optional alternate client (or a
supported directive, such as
MEDIA_SERVER).
A collection of optional
specifcations related to
archived redo logs. Not
archivedRedoLogOptions
used with the 'Clients for archivedRedoLogOptions
optional
use with scripts or
templates' client selection
type.
Optional overrides to the

default formats for the
various backup fle names.
Ensure that the format
backupFileNameFormatOverrides
specifed for all RMAN backupFileNameFormatOverrides
optional
backup piece names ends
with _%t to guarantee that
each backup piece has a
unique name in the catalog.
enum (Whole Database, Whole

Database - Datafle Copy Share,
The backup seletion type Partial database - Tablespace,
backupSelectionType
within Oracle that the Partial database - Datafles, Fas
optional
selections belong to. Recovery Area (FRA), Legacy
Client with scripts or templates,
Database Backup Shares)
A user-specifed tag name

for a backup set, proxy
copy, data fle copy, or
control fle copy. This
backupSetIdentifer
value maps to the Oracle sring
optional
property TAG. Not used
with the 'Clients for use
with scripts or templates'
client selection type.
Indicates whether the

blockIncremental
policy performs block level boolean
optional
incremental backups.
clientCompress Indicates if the backup is

boolean
optional compressed.
clientEncrypt Indicates if the backup is

boolean
optional encrypted.
The type of Oracle enum (Protect Insances and

clientType
elements targeted for Databases, Protect Insance
optional
backup under this policy. Groups, Clients)
An optional classifcation
tag. NetBackup comes with
dataClassifcation Bronze, Silver, Gold, and
sring
optional Platinum tags defned, but
these values can be
cusomized.
enum (None (not using of-hos

For of-hos backups using backups with Data Mover), Third
dataMoverMachine
Data Mover, this refects Party Copy Device, NetBackup
optional
the Data Mover type. Media Server, Network Attached
Storage, NDMP)
For the 'Database Backup

Shares' backup selection
scope type, a collection of
databaseBackupShareOptions optional specifcations for
databaseBackupShareOptions
optional the point when backup sets
and backup copies are
automatically deleted from
the appliance share.
For the 'Whole Database -

Datafle Copy Share'
backup selection scope
datafleCopyTag
type, a user-specifed tag sring
optional
name associated with data
fles that are located on the
appliance.
disableClientSideDeduplication Indicates if client side

boolean
optional deduplication is disabled.
The date and time the

efectiveDateUTC
policy goes into efect, in integer
optional
UTC format.
Indicates whether
NetBackup will back up or

archive any Network File

followNFSMounts Sysem (NFS) mounts that
boolean
optional are named in the backup
selection lis, or by the user
in the case of a user backup
or archive.
The maximum number of

jobs originating from this
jobLimit policy that can be running
integer
optional concurrently at any given
time. If 0, no maximum is
enforced.
keyword An optional keyword

sring
optional phrase.
A collection of optional I/O

and backup set limits. A
value of 0 indicates that the
maximumLimits limit is not enabled. Not
maximumLimits
optional used with the 'Clients for
use with scripts or
type.
mediaOwner The media server or group

sring
optional that owns the media.
ofhosBackup Indicates if the backup is

boolean
optional an of-hos backup.
If enabled, the Oracle

database is shut down and
put into the mount sate.
ofineDatabaseBackup
Not used with the 'Clients boolean
optional
for use with scripts or
type.
The number of parallel

backup sreams that can be
used in a backup operation.
Not used with the 'Clients
parallelStreams
for use with scripts or integer
optional
type.
Minimum value : 1
Maximum value : 255

The priority of jobs

associated with this policy.
priority
The higher the number, the integer
optional
higher the priority (relative
to other NetBackup jobs).
If specifed, overrides the

default Oracle read-only
tablespace options. Not
readOnlyTablespaceOptions
used with the 'Clients for enum (Skip, Force)
optional
use with scripts or
type.
Indicates the snapshot is

retained for insant
recovery or for sorage
retainSnapshot
lifecycle policy (SLP) boolean
optional
management. This
parameter only applies to
snapshot backups.
If enabled, ofine data fles

are skipped during the
backup. This parameter is
skipOfineDatafles not used with the
boolean
optional backupSelectionType
value Legacy client
with scripts or
templates .
Indicates whether this is a

snapshotBackup
snapshot backup (frozen boolean
optional
image).
The name of the sorage

sorage
unit that is associated with sring
optional
the policy.
Indicates if the sorage unit

sorageIsSLP
is a sorage lifecycle policy boolean
optional
(SLP).
Flag refecting if
useAccelerator
NetBackup Accelerator is boolean
optional
used.
Indicates if Replication

useReplicationDirector
Director is used to manage boolean
optional
hardware snapshots.
volumePool The volume pool that is

enum (NetBackup, DataStore)
optional associated with the policy.
archivedRedoLogOptions
In kilobytes (KB), the maximum size for a backup

backupSetSize
set of archived redo logs. A value of 0 indicates integer
optional
that the limit is not enabled.
deleteAfterMakingCopies If non-zero, archived redo logs are deleted after

integer
optional the specifed number of copies are successful.
The maximum number of archived redo log fles to

flesPerBackupSet
include in each output backup set. A value of 0 integer
optional
indicates that the limit is not enabled.
include If enabled, archived redo logs are included in full

boolean
optional and incremental schedules.
The maximum number of connections between

parallelStreams RMAN and a database insance.
integer
optional Minimum value : 1
Maximum value : 255
backupFileNameFormatOverrides
archivedRedoLogs
Default : "arch_d%d_u%u_s%s_p%p_t%t" sring
optional
controlFile
Default : "ctrl_d%d_u%u_s%s_p%p_t%t" sring
optional
datafles
Default : "bk_d%d_u%u_s%s_p%p_t%t" sring
optional
fasRecoveryArea
Default : "fra_d%d_u%u_s%s_p%p_t%t" sring
optional
databaseBackupShareOptions

The number of minutes to pass before

deleteProtectedBackupCopiesMinutes
protected backup copies are integer
optional
automatically. deleted.
The number of minutes to pass before

deleteProtectedBackupSetsMinutes
protected backup sets are automatically integer
optional
deleted.
maximumLimits
In kilobytes (KB), the maximum size of each backup

backupPiece
piece that is created on this channel. Maps to the Oracle integer
optional
MAXPIECESIZE property.
backupSetSize In kilobytes (KB), the maximum size for a backup set.

integer
optional Maps to the Oracle MAXSETSIZE property.
The maximum number of input fles to include in each

flesPerBackupSet
output backup set. Maps to the Oracle FILESPERSET integer
optional
property.
The maximum number of input fles that the backup

openFiles
operation can have open at any given time. Maps to the integer
optional
Oracle MAXOPENFILES property.
The maximum number of kilobytes (KB) that RMAN

readRate
reads each second on this channel. Maps to the Oracle integer
optional
RATE property.
schedules
Indicates if fle checksums are sored to aid in

acceleratorForcedRescan
change detection. This parameter applies only boolean
optional
to to NetBackup Accelerator backups.
The copy details for the policy. Entry 1 refects

backupCopies the primary schedule copy, which is always
backupCopies
optional enabled. Entries 2-4 refect (optional)
additional copies.
enum
(Application

Backup, Archived
Redo Log
Backup,
backupType Cumulative
The backup type of the schedule.
optional Incremental
Backup,
Diferential
Incremental
Backup, Full
Backup)
Recurring days of the week, recurring days of

excludeDates the month, and exact dates on which this policy
excludeDates
optional does not run. This parameter only applies to
calendar-based schedules
frequencySeconds For frequency schedule types, the frequency at

integer
optional which to perform the backup, in seconds.

includeDates the month, and exact dates on which this policy
includeDates
optional does run. This parameter only applies to
calendar-based schedules
The maximum number of jobs from the

mediaMultiplexing schedule that NetBackup can multiplex onto
integer
optional any one drive. Valid values are 1 (no
multiplexing) to 32.
retentionLevel The retention level that is associated with the

integer
optional schedule. Possible values are 0 - 100.
Indicates if backups can retry on any day there

retriesAllowedAfterRunDay
is an open backup window. This parameter boolean
optional
only applies to calendar-based schedules.
scheduleName
The name of the schedule. sring
optional
scheduleType enum (Calendar,

The type of the schedule.
optional Frequency)
Indicates if NetBackup should create only an

Insant Recovery snapshot (leaving the sorage
snapshotOnly
unit unused). If disabled, NetBackup both boolean
optional
creates a snapshot and copies the snapshot to a
sorage unit.
The window during which the backup is

sartWindow allowed to sart. Each day of the week is < sartWindow >
optional defned independently. Entry 1 is Sunday, entry array
2 is Monday, and so on.
sorageIsSLP Indicates if the sorage unit is a sorage

boolean
optional lifecycle policy (SLP).
syntheticBackup
Specifes if a synthetic backup is performed. boolean
optional
backupCopies
copies
The lis of copy information. < copies > array
optional
The priority of jobs that are associated with any additional

priority copies that are specifed. The higher the number, the higher
integer
optional the priority (relative to other NetBackup jobs). Note this has
no impact on the primary copy.
copies
failStrategy
The approach taken if a particular image fails to copy. integer
optional
mediaOwner
The media server or group that owns this copy. sring
optional
retentionLevel
The retention level for the copy. integer
optional
sorage The name of the sorage unit that is associated with the
sring
optional copy.
volumePool The name of the volume pool that is associated with the
sring
optional copy.
excludeDates
lasDayOfMonth
Indicates if the las day of the month is excluded. boolean
optional

recurringDaysOfMonth
Recurring days of the month. < integer > array
optional
recurringDaysOfWeek
Recurring days of a week. < sring > array
optional
specifcDates
A lis of specifc dates. < sring > array
optional
includeDates
lasDayOfMonth
Indicates if the las day of the month is included. boolean
optional
optional
recurringDaysOfWeek
optional
specifcDates
optional
sartWindow
dayOfWeek The day of the week the backup window sarts. Possible
integer
optional values for DAY are 1 (Sunday) through 7 (Saturday).
durationSeconds
The duration of the backup window expressed in seconds. integer
optional
sartSeconds The sart time of the backup window, expressed in

integer
optional seconds elapsed since the beginning of the day.
policyOracleResponse
Name Schema
data
data
optional
data

attributes
The attributes of the policy. attributes
optional
id
The policy name. sring
optional
links
The links to the URLs for the details on each policy. links
optional
type
sring
optional
attributes
Name Schema
policy
policy
optional
links
Name Schema
self
self
optional
self
href
The URI to get details for the policy. sring
optional
posCreateHosReques
cpuArchitecture
optional
hosMappings < hosMappings >

The lis of hos mappings that are associated with the hos.
optional array
hosName
required

hwDescription
optional
insalledEEBs
optional
isSecureEnabled Specifes whether the hos can communicate securely or

boolean
optional not.
maserServer The NetBackup maser server that is associated with the

sring
optional hos.
nbuVersion
optional
osType
optional
osVersion
optional
servers
The lis of servers associated with the hos. < sring > array
optional
hosMappings
mappedHosName The name of the mapped hos for which the details are
sring
optional provided.
posRecreateHosReques
cpuArchitecture
optional
hosMappings < hosMappings >

The lis of hos mappings that are associated with the hos.
optional array
hosName
required
hwDescription
optional
insalledEEBs

optional
isSecureEnabled Specifes whether the hos can communicate securely or

boolean
optional not.
maserServer The NetBackup maser server that is associated with the

sring
optional hos.
nbuVersion
optional
osType
optional
osVersion
optional
servers
The lis of servers associated with the hos. < sring > array
optional
uuid
The UUID of the hos. sring
required
hosMappings
mappedHosName The name of the mapped hos for which the details are
sring
optional provided.
putAddHosMapping
isApproved Specifes whether or not the mapping is approved. This feld

boolean
optional is optional.
isShared Specifes whether the mapping is shared between two or

boolean
required more hos IDs.
putClientReques
By default, the clientType for a policy is Clients . For Intelligent Policies, select either
Protect Instances and Databases or Protect Instance Groups .
data

The data about the client. data

required
data
attributes The attributes for the hos, insance, or insance database.

attributes
required These attributes do not apply for insance groups.
id For hoss or insance databases, this value is the hos name.

sring
required For insance groups, this value is the insance group.
type
The resource type. Mus be set to client. sring
required
attributes
enum (HP-UX11.31,
Debian2.6.18,
RedHat2.6.18,
SuSE3.0.76,
IBMzSeriesRedHat2.6.18,
IBMzSeriesSuSE3.0.76,
NDMP, NetWare,
OpenVMS_I64, AIX6,
Solaris10,
OS Solaris_x86_10_64,
The hos’s operating sysem.
optional Windows, Windows10,
Windows2003,
Windows2008,
Windows2012,
Windows2012_R2,
Windows2016,
Windows7, Windows8,
Windows8.1,
WindowsVisa,
WindowsXP)
The name of the database. This property only applies

databaseName
for the clientType value Protect Instances sring
optional
and Databases .
enum (HP-UX-IA64,
Linux, Linux-s390x,
hardware NDMP, Novell,

The hos’s hardware.

optional OpenVMS4, RS6000,
Solaris, Windows-x64,
Windows-x86)
The name of the insance. This property only applies

insanceName
for the clientType value Protect Insances and sring
optional
Databases.
putHosCommentDetails
comment
Hos-specifc comment to be updated. sring
optional
putIncludeReques
Name Schema
data
data
required
data
attributes
attributes
required
type
The resource type. Mus be set to "backupSelection". sring
required
attributes
Name Schema
selections
< sring > array
required
putScheduleReques
Name Schema
data
data
required

data
attributes
attributes
required
id
The name of the schedule. sring
required
type
The resource type. Mus be set to "schedule". sring
required
attributes
Indicates if fle checksums are sored to aid in

acceleratorForcedRescan
change detection. Applicable only to boolean
required
NetBackup Accelerator backups.
The copy details for the policy. Entry 1 refects

the primary schedule copy, which is always
enabled. Entries 2-4 refect (optional)
backupCopies
additional copies. The use of multiple copies is backupCopies
required
inferred from number of copies specifed
(Valid values 1-not used 2-4-used) (default in
policy fle is 0).
enum (Archived
Redo Log
Backup,
Automatic
Backup,
Automatic Full
Backup,
Automatic Vault,
Automatic
Cumulative
Incremental
Backup,
Automatic
Diferential
Incremental
backupType Backup,
The backup type of the schedule.
required Automatic

Incremental
Backup,
Application
Backup,
Cumulative
Incremental
Backup,
Diferential
Incremental
Backup, Full
Backup,
Transaction Log
Backup, User
Archive, User
Backup)

excludeDates
the month, and exact dates on which this policy excludeDates
required
will not run.
frequencySeconds For frequency schedule types, the frequency at

integer
required which to perform the backup, in seconds.

includeDates the month, and exact dates on which this policy
includeDates
required will run. Applicable only to calendar schedule
types.
The maximum number of jobs from the

mediaMultiplexing schedule that NetBackup can multiplex onto
integer
required any one drive. Valid values are 1 (no
multiplexing) to 32.
retentionLevel The retention level associated with the

integer
required schedule. Possible values are 0 - 100.
Indicates if backups can retry on any day there

retriesAllowedAfterRunDay
is an open backup window. Applicable only for boolean
required
the calendar schedule type.
scheduleType enum (Calendar,

The type of the schedule.
required Frequency)
Indicates if NetBackup should create only an

Insant Recovery snapshot (leaving the sorage
snapshotOnly
unit unused). If disabled, NetBackup both boolean
required
creates a snapshot and copies the snapshot to a
sorage unit.

The window during which the backup is

sartWindow allowed to sart. Each day of the week is < sartWindow >
required defned independently. Entry 1 is Sunday, entry array
2 is Monday, and so on.
syntheticBackup Indicates if NetBackup performs a synthetic

boolean
required backup.
backupCopies
copies
< copies > array
required
The priority of jobs associated with any additional copies

priority specifed. The higher the number, the higher the priority
integer
required (relative to other NetBackup jobs). Note this has no impact
on the primary copy.
copies
failStrategy enum (Continue,

The approach taken if a particular image fails to copy.
optional Fail All Copies)
mediaOwner
The media server or group that owns this copy. sring
optional
retentionLevel
The retention level for the copy. integer
optional
sorage
The name of the sorage unit associated with the copy. sring
optional
volumePool
The name of the volume pool associated with the copy. sring
optional
excludeDates
lasDayOfMonth
required
required

recurringDaysOfWeek
required
specifcDates
required
includeDates
lasDayOfMonth
required
required
recurringDaysOfWeek
required
specifcDates
required
sartWindow
dayOfWeek The day of the week the backup window sarts. Possible
integer
required values for DAY are 1 (Sunday) through 7 (Saturday).
durationSeconds
The duration of the backup window expressed in seconds. integer
required
sartSeconds The sart time of the backup window, expressed in

integer
required seconds elapsed since the beginning of the day.
updateHosSchema
hosName
The identifer for the communicating hos. sring
required
enum
sate Indicates the sate of the hos. Possible values are activated,
(ACTIVATED,
required deactivated.
DEACTIVATED)

urlSchema
url The URL of the WebSocket endpoint that NetBackup

sring
required connects to.
vmserver
password
The password for the credentials. sring
required
port The port used to connect to the

integer
optional server.
serverName
The name of the VM server. sring
required
userId
The username for the credentials. sring
required
enum
(VMWARE_VIRTUAL_CENTER_SERVER,
VMWARE_ESX_SERVER,
VMWARE_RESTORE_ESX_SERVER,
vmType
The type of VM server. VMWARE_VCLOUD_DIRECTOR,
required
HYPERV_SERVER,
SYSTEM_CENTER_VMM_SERVER,
HYPERV_CLUSTER_SERVER,
HYPERSCALE_SERVER)
vmserverResponse
links
A link to the newly created resource. < links > array
optional
vmServer
vmserver
optional
links

href
The URI to retrieve information about the VM server. sring (url)
optional
rel The relationship of the link to the specifed VM server. This

sring
optional value is always "self".
Security
rbacCertSecurity
Type : apiKey
In : HEADER
rbacUserSecurity
Type : apiKey
In : HEADER
NetBackup Recovery API
Overview
The NetBackup Recovery API provides the ability to perform a recovery from previous backups.
Version information
Version : 1.0
URI scheme
Schemes : HTTPS

Paths
POST /recovery/workloads/vmware/scenarios/full-vm/recover
Description
Recovers a full VMware virtual machine.
Parameters
recoveryReques The reques for a full VMware

Body vmwareFullVmRecoveryReques
required VM recovery.
Responses
HTTP
Description Schema
Code
The recovery job sarted successfully.

201 Headers : recoveryResponse
Location (sring) : Contains the link to the created recovery job.
400 Bad reques. The reques JSON has an invalid syntax or illegal values. errorResponse

401 errorResponse
404 Not found. The specifed client or backup image was not found. errorResponse
406 errorResponse
this API produces.

415 errorResponse
500 Internal server error. Failed to sart recovery. errorResponse
503 The server is busy. Failed to sart recovery. errorResponse
Consumes
Produces

Security
Type Name
apiKey rbacSecurity
Example HTTP reques
Reques body
{
"data" : {
"type" : "recoveryRequest",
"attributes" : {
"recoveryPoint" : {
"client" : "example-vm",
"filter" : "backupTime ge '2016-11-20T23:20:50Z' and backupTime le '2016-
12-20T23:20:50Z'"
},
"recoveryObject" : {
"vmDisplayName" : "copy-of-example-vm",
"vmDisks" : [ {
"source" : "/example-DS1/example-vm/example-disk1.vmdk",
"destination" : "/example-DS2/example-vm/example-disk1.vmdk"
}, {
"source" : "/example-DS1/example-vm/example-disk2.vmdk",
"destination" : "/example-DS2/example-vm/example-disk2.vmdk"
} ],
"vmEnvironment" : {
"vCenter" : "vcenter-server.example.com",
"esxiServer" : "esx-server.example.com",
"datacenter" : "/example-DC",
"vmFolder" : "/example-DC/vm",
"resourcePoolOrVapp" : "/example-
DC/host/esx.example.com/Resources/example-res-pool",
"vmxDatastore" : "example-DS",
"network" : "VM Network"
}
},
"recoveryOptions" : {
"defaultVmDiskProvisioning" : "thin",
"recoveryHost" : "recovery-proxy.example.com",
"diskMediaServer" : "media-server.example.com",
"transportMode" : "san:hotadd:nbd:nbdssl",
"overwriteExistingVm" : true,
"powerOnAfterRecovery" : true,
"recoverToVmxDatastore" : true,
"removeBackingInformation" : true,
"removeNetworkInterfaces" : true,
"removeTagAssociations" : true,
"retainHardwareVersion" : true,
"retainInstanceUuid" : true,

"retainBiosUuid" : true
}
}
}
}
Example HTTP response
Response 201
{
"data" : {
"type" : "recoveryResponse",
"id" : 42,
"attributes" : {
"msg" : "Recovery job started successfully"
}
},
"relationships" : {
"recoveryJob" : {
"links" : {
"related" : "/admin/jobs",
"self" : "/admin/jobs/42"
},
"data" : {
"type" : "job",
"id" : 42
}
}
}
}
Defnitions
errorResponse
errorCode
required
errorMessage
required
recoveryResponse
The recovery response.

data
Contains the recovery response data. data
required
relationships Contains the resources related to the recovery operation, such

relationships
required as recoveryJob.
data
attributes
Contains the recovery response attributes. attributes
required
id
The response identifer. integer (int64)
required
type The response type.

sring
required Default : "recoveryResponse"
attributes
msg
The response message. sring
required
relationships
recoveryJob
Represents the job created by this recovery operation. recoveryJob
required
recoveryJob
data
Contains the recovery job data. data
required
links
Contains the links to get the job details. links
required
data

id
The job identifer. integer (int64)
required
type
The resource type. Set to job. sring
required
links
related
Gets a lis of recent jobs. sring
required
self
Gets the details about this recovery job. sring
required
vmwareFullVmRecoveryReques
The recovery reques schema for VMware full VM recovery.
data
Contains the recovery reques data. data
required
data
attributes
Contains the recovery reques attributes. attributes
required
type The resource type. Mus be set to recoveryRequest . enum

required Default : "recoveryRequest" (recoveryReques)
attributes
recoveryObject
Represents the virtual machine being recovered. recoveryObject
optional
recoveryOptions Describes the recovery options to be used for this

recoveryOptions
optional recovery.

recoveryPoint Selects the recovery point for this recovery based on the
recoveryPoint
required specifed options. Required.
recoveryObject
Represents one or more virtual machine disks. If not

vmDisks
specifed, the default is the disk or disks used at the time < vmDisks > array
optional
of backup.
The display name of the virtual machine. Mus not contain

vmDisplayName
more than 80 characters. If not specifed, the default is the sring
optional
one used at the time of backup.
Describes the VMware environment where this virtual

vmEnvironment
machine is to be recovered. If not specifed, the default is vmEnvironment
optional
the one used at the time of backup.
vmDisks
desination
The desination path of the virtual machine disk. sring
optional
source
The source path of the virtual machine disk. sring
optional
vmEnvironment
The datacenter path. Mus begin with a forward slash

datacenter
'/'. If not specifed, the default is the one used at the sring
optional
time of backup.
esxiServer The ESXi server name. If not specifed, the default is

sring
optional the one used at the time of backup.
The VM network name. Multiple VM networks can be

specifed using comma-separated values. If multiple
network VM networks are specifed, they are attached to the
sring
optional recovered VM in the specifed order. The default is the
VM network or networks that were used at the time of
backup.

The resource pool or vApp path. Mus begin with a

resourcePoolOrVapp
forward slash '/'. If not specifed, the default is the one sring
optional
used at the time of backup.
vCenter The vCenter server name. If not specifed, the default

sring
optional is the one used at the time of backup.
The VM folder path. Mus begin with a forward slash

vmFolder
'/'. If not specifed, the default is the one used at the sring
optional
time of backup.
The name of the datasore to resore the VMX fle to.

vmxDatasore
If not specifed, the default is the one used at the time sring
optional
of backup.
recoveryOptions
The default disk provisioning format that is to be enum (thin,

defaultVmDiskProvisioning used for all of the virtual disks created during thick-lazy-
optional recovery. If not specifed, the default is the one zeroed, thick-
used at the time of backup. eager-zeroed)
The media server that is to be used to perform this

diskMediaServer
recovery. If not specifed, the default is the one sring
optional
used at the time of backup.
If true , overwrites the VM and its associated

resources, if they already exis with the same
name. If false , does not overwrite the VM and
overwriteExisingVm its associated resources, if they already exis with
boolean
optional the same name. If not specifed, does not
overwrite the VM and its associated resources, if
they already exis with the same name.
Default : false
If true , the VM is powered on after the

recovery. If false , the VM remains powered of
powerOnAfterRecovery
after the recovery. If not specifed, the VM boolean
optional
remains powered of after the recovery.
Default : false
If true , recovers the VMDK fles to the same

datasore as the VMX fle. If false , recovers the
VMDK fles to their original location at the time
of backup. If not specifed, recovers the VMDK
recoverToVmxDatasore
fles to their original location at the time of boolean
optional

backup. If a diferent virtual disk desination path

is assigned in vmEnvironment section, it overrides
this option.
Default : false
The server that is to be used as the VM recovery

recoveryHos
hos to perform this recovery. If not specifed, the sring
optional
default is the one used at the time of backup.
If true , removes any mounted removable

devices (such as CD-ROM or DVD-ROM images)
attached to the VM. If false , retains the
removeBackingInformation
mounted removable devices attached to the VM. If boolean
optional
not specifed, retains the mounted removable
devices attached to the VM.
Default : false
If true , removes any network interfaces attached

to the VM after recovery. If false , retains the
removeNetworkInterfaces network interfaces attached to the VM after
boolean
optional recovery. If not specifed, retains the network
interfaces attached to the VM after recovery.
Default : false
If true , removes any associated VMware tags

from this VM. If false , retains the associated
removeTagAssociations
VMware tags for this VM. If not specifed, retains boolean
optional
the associated VMware tags for this VM.
Default : false
If true , recovers the VM with the same BIOS

UUID as it had at the time of backup. If false ,
retainBiosUuid recovers the VM with a newly assigned BIOS
boolean
optional UUID. If not specifed, recovers the VM with the
same BIOS UUID as it had at the time of backup.
Default : true
If true , recovers the VM with the same

hardware version as it had at the time of backup. If
false , recovers the VM with the default
retainHardwareVersion
hardware version for the desination ESXi server. boolean
optional
If not specifed, recovers the VM with the same
hardware version as it had at the time of backup.
Default : true
If true , recovers the VM with the same insance

UUID (vCenter-specifc unique identifer) as it
had at the time of backup. If false , recovers the
VM with a newly assigned insance UUID. If not

specifed, recovers the VM with the same insance

retainInsanceUuid
UUID as it had at the time of backup. If the VM is boolean
optional
being recovered to a sandalone ESXi hos, this
option is ignored. If another VM with the same
insance UUID exiss at the desination, vCenter
server assigns a new UUID to the VM.
Default : true
The transport mode combination that is to be used

to perform this recovery. The sring mus be
specifed all in lowercase, with colon separated
values such as hotadd:nbd:nbdssl:san . The
transportMode order of the specifed modes is signifcant, as
sring
optional NetBackup attempts each mode in that order until
the recovery is successful. If none of the modes
are successful, the recovery fails. If not specifed,
the default is san:hotadd:nbd:nbdssl .
Default : "san:hotadd:nbd:nbdssl"
recoveryPoint
The backup image identifer to be used for this recovery.

backupId
Required, if client is not specifed. Cannot be used along sring
optional
with client and filter .
The client identifer that was used at the time of backup.

Required, if backupId is not specifed. Cannot be used
client
along with backupId . If a filter is not specifed along sring
optional
with client , recovery will be performed using the mos
recent backup image.
Selects the backup images for recovery based on the

specifed filter . Optional. Cannot be used along with
backupId . If more than one backup images match the
flter, NetBackup selects the mos recent one. All the flters
are based on the OData sandard and fltering on the
following attributes is supported.
Supported
Operators
The backup
timestamp in date-
backupTime ge le
ISO 8601 time
flter
format sring

optional
The filter can be used to specify a time interval, such as

backupTime ge '2016-11-20T23:20:50Z' and
backupTime le '2016-12-20T23:20:50Z' . If the
filter only specifies the start of the time interval, such as
backupTime ge '2016-11-20T23:20:50Z' , then the
end of the interval is assumed to be the current time. If the
filter only specifies the end of the time interval, such as
backupTime le '2016-11-20T23:20:50Z' , then the
start of the interval is assumed to be 6 months prior to that. If
the filter is not specified, the end of the time interval is
assumed to be the current time and the start of the interval is
assumed to be 6 months prior to that.
Security
rbacSecurity
Type : apiKey
In : HEADER
NetBackup Security API
Overview
The NetBackup Security APIs provide access to the security-related resources of NetBackup. These
APIs manage authorization tokens, hos ID-based certifcates, security confguration options, and
auditing.
Version information
Version : 1.0
URI scheme

Schemes : HTTPS
Paths
GET /security/auditlogs
Description
Views the NetBackup audit logs.
Parameters
The category ID of the required audit record.

0-GENERAL
1-POLICY
2-AUDITCFG
3-JOB
4-AUDITSVC
5-STU
6-POOL
7-
category STORAGESRV
8-BPCONF
9-AUDITDB
10-
Query integer 0
optional HOLD
11-USER
12-AZFAILURE
13-
CATALOG
14-TOKEN
15-CERT
16-LOGIN
17-SEC_CONFIG
18-HOST
19-
CONNECTION
datalimit
Query The number of audit records to be fetched. integer 0
optional
domain
Query The domain name of the user. sring ""
optional
domaintype
Query The domain type of the user. integer 0
optional
endtime The end time for the audit records. The

Query integer (int64) 0
optional audit records are fetched until this time.
locale
Query The locale value. sring "en"
optional
The operation ID of the audit record.
0-
operation GENERAL
1-CREATE
2-MODIFY
3-
Query integer 0
optional DELETE
4-START
5-STOP
6-CANCEL
7-
RESUME
8-ACCESS
The sart time for the audit records.

sarttime
Query NetBackup sarts fetching the audit records integer (int64) 0
optional
at this time.

username
Query The name of the user. sring ""
optional
Responses
HTTP
Description Schema
Code
200 The lis of audit records. getAuditRecordResponse

401 errorResponse
404 No audit record found. errorResponse

406 errorResponse
Produces
Security
Type Name
GET /security/cacert
Description
Returns the certifcate of the NetBackup web service certifcate authority(CA) and the lis of
certifcates of the NetBackup CA in the pem formatted sring. Each NetBackup hos mus esablish
trus with the NetBackup web service CA before it can make secure calls to NetBackup APIs.
Responses
HTTP
Description Schema
Code
200 On successful response, the CA certifcate is sent. getCACertifcateResponse

406 errorResponse
Produces

GET /security/certifcates/crl
Description
Returns the lates Certifcate Revocation Lis (CRL) as a DER-encoded fle. The fle conforms to the
sandard X.509 CRL format and semantics.
Responses
HTTP
Description Schema
Code
200 On successful response, the lates CRL fle is sent. fle
406 errorResponse
this API produces.
There was an internal error with output of the Certifcate Revocation

500 sring
Lis (CRL). Please try again.
Not found, the CRL is not generated yet.

503 Headers : sring
Retry-After (integer)
Produces
application/pkix-crl
GET /security/certifcates/current
Description
Returns the lis of details for the lates certifcate for each hos from the certifcate database.
Responses
HTTP
Description Schema
Code
On successful response, the lis of details for the lates

200 getCertifcateLisResponse
certifcate for each hos is sent.

401 errorResponse

406 errorResponse

Produces
Security
Type Name
POST /security/certifcates/revoke
Description
Revokes the NetBackup hos ID-based certifcate for the specifed hos ID.
Parameters
hosId The unique ID assigned to the

Query sring
required NetBackup hos.
Reason
Body The reason for a certifcation revocation. posRevokeCertifcateReques
optional
Responses
HTTP
Description Schema
Code
200 Reques successful. No Content
Bad reques. The reques contains an invalid parameter, or the

400 errorResponse
certifcate has already been revoked.

401 errorResponse
404 The specifed hos was not found. errorResponse

415 errorResponse
Consumes

Security
Type Name
GET /security/certifcates/{serialNumber}
Description
Returns the certifcate details of the certifcate with the specifed serial number.
Parameters
serialNumber
Path The serial number of the certifcate. sring
required
Responses
HTTP
Description Schema
Code
200 On successful response, the certifcate details are sent. getCertifcateResponse

401 errorResponse
404 The certifcate entry does not exis. errorResponse

406 errorResponse
Produces
Security
Type Name
PUT /security/credentials
Description

Sets the security credentials.
Parameters
Security
Body credentials The security credential that needs to be set. secCredDef
required
Responses
HTTP
Description Schema
Code
200 The reques was successful. No Content
400 Bad reques. The reques contains an invalid parameter. errorResponse

401 errorResponse

415 errorResponse
Consumes
Security
Type Name
GET /security/credentials/{credname}/isset
Description
Verifes whether a certain security credential is set or not.
Parameters
credname
Path The name of the security credential key. sring
required

Responses
HTTP
Description Schema
Code
200 The reques was successful. credIsSetResponse

401 errorResponse
406 errorResponse
this API produces.
500 There was an error when attempting to query the security credential. errorResponse
Security
Type Name
GET /security/logindetails
Description
Views the logs that are specifc to the NetBackup login audit records.
Parameters
datalimit
Query The number of audit records to be fetched. integer 0
optional
domaintype
Query The domain type of the user. integer 0
optional
Set the value to true to view the audit

records for the las failed and the las
laslogon
Query successful login attempts. If the value is boolean "false"
optional
set to false, audit records for all login
attempts are fetched.
locale
Query The locale value. sring "en"
optional
Responses

HTTP
Description Schema
Code
200 The lis of audit records. getAuditRecordResponse

401 errorResponse
404 No audit record found. errorResponse

406 errorResponse
Produces
Security
Type Name
GET /security/ping
Description
Tess the connection for the security service from the client. It returns the maser server time in
milliseconds.
Responses
HTTP
Description Schema
Code
200 Ping successful - maser server time in milliseconds time
406 errorResponse
this API produces.
Produces
text/plain
POST /security/properties
Description
Confgures NetBackup security, such as the certifcate deployment security level, communication

with insecure hoss, and automatic hos aliases.
Parameters
Security
confguration The security confgurations that need to be
Body posSecPropertyReques
properties updated.
required
Responses
HTTP
Description Schema
Code

401 errorResponse

415 errorResponse
Consumes
Security
Type Name
GET /security/properties
Description
Fetches the confguration settings for NetBackup security.
Responses
HTTP
Description Schema
Code
On successful response, security confgurations are sent in the

200 getSecPropertyResponse

JSON format.

406 errorResponse
Produces
GET /security/properties/default
Description
Fetches the default settings specifc to NetBackup security.
Responses
HTTP
Description Schema
Code
On successful response, default security confguration settings

200 getSecPropertyResponse
are sent in the JSON format.

406 errorResponse
Produces
POST /security/securitytokens
Description
Creates an authorization token based on the properties that are sent with the reques payload.
Parameters
Create
Body Token Data The properties of the token to be created. posCreateTokenReques
required
Responses
HTTP
Description Schema
Code

201 On successful response, the token value is sent. posCreateTokenResponse

401 errorResponse
In case of reissue-token, the hos ID that is specifed does not

404 errorResponse
exis.

406 errorResponse
409 The token already exiss. errorResponse

415 errorResponse
Consumes
Produces
Security
Type Name
GET /security/securitytokens
Description
Returns the data for all tokens in the form of a lis.
Responses
HTTP
Description Schema
Code
200 On successful response, a lis of tokens is sent. getTokenResponse

401 errorResponse

406 errorResponse

Produces
Security
Type Name
POST /security/securitytokens/delete/invalid
Description
Cleans all invalid authorization tokens.
Parameters
Reason Specify the reason for deleting the invalid

Body posDeleteTokenReques
optional tokens.
Responses
HTTP
Description Schema
Code

401 errorResponse
Consumes
Security
Type Name
GET /security/securitytokens/sate/valid

Description
Returns the data for all valid tokens.
Responses
HTTP
Description Schema
Code
200 On successful response, a lis of valid tokens is sent. getTokenResponse

401 errorResponse

406 errorResponse
Produces
Security
Type Name
GET /security/securitytokens/{tokenName}
Description
Returns the token data for the specifed token.
Parameters
tokenName
Path The token name. sring
required
Responses
HTTP
Description Schema
Code
200 On successful response, the token data is sent. getTokenData

401 errorResponse

404 The token does not exis. errorResponse
406 errorResponse
this API produces.
Produces
Security
Type Name
POST /security/securitytokens/{tokenName}/delete
Description
Deletes an authorization token based on the token name that is specifed in the URI.
Parameters
tokenName
Path The token name. sring
required
Reason
Body Specify the reason for deleting the token. posDeleteTokenReques
optional
Responses
HTTP
Description Schema
Code

401 errorResponse
404 The token does not exis. errorResponse
406 errorResponse
this API produces.

Consumes
Security
Type Name
GET /security/serverinfo
Description
Returns NetBackup maser server information.
Responses
HTTP
Description Schema
Code
On successful response, the NetBackup maser server information

200 getServerInfoResponse
is sent.

406 errorResponse
Produces
GET /security/servertime
Description
Returns the maser server time in milliseconds in the JSON format.
Responses
HTTP
Description Schema
Code
On successful response, the maser server time in milliseconds is

200 getServerTimeResponse
sent in the JSON format.

406 errorResponse

Produces
Defnitions
aliasAutoAdd
Here are the defned values for the aliasAutoAdd setting.
0 - OFF - The NetBackup adminisrator’s

approval is required to add hos aliases.
1 - ON - Aliases can be automatically added without the

NetBackup adminisrator’s approval.
Type : integer
allowInsecureBackLevelHos
Here are the defned values for the allowInsecureBackLevelHos setting:
0 - OFF - The NetBackup

hos cannot communicate with insecure hoss.
1 - ON - The NetBackup hos can communicate with

insecure hoss.
Type : integer
auditRecordDetails
auditKeyLis < auditRecordKey >

The lis of the audit placeholder values.
optional array
<
auditRecordAttributeLis
The lis of the audit record attributes. auditRecordAttribute
optional
> array
auditTime
time
optional
auditUserIdentity
User information. object
optional
categoryId
The category ID of the fetched audit record. integer
optional
categoryIdDisplayString The resolved category value from the

sring
optional categoryId feld.
messageId The UMI message ID of the fetched audit

integer
optional record.
messageIdDisplayString The resolved message value from the

sring
optional messageId UMI.
operationId
The operation ID of the fetched audit record. integer
optional
operationIdDisplayString The resolved operation value from the

sring
optional operationId feld.
reason
The reason value of the audit record. sring
optional
auditRecordKey
typeId
The data type of the placeholder. integer
optional
typeIdDisplayString The value of the placeholder for the audit description

sring
optional message.
certifcate
An x.509 certifcate in a PEM-formatted sring.
Type : sring
certifcateAutoDeployLevel
Here are the defned values for the certifcate deployLevel level.
0 - Very High - Automatic

certifcate deployment is disabled.
1 - High - Certifcates are automatically deployed on known hoss.

2 - Medium - Certifcates are automatically deployed on all hoss.
Type : integer
certifcateState
The certifcate sate. Here are the defned values for the certifcate sate.
1 - Active.
2 - Revoked.
Type : integer
certifcateTokenType
Indicates the type of token that was used to issue the certifcate or the scenario in which the

certifcate was issued.
Here are the defned values for token types.
0 - No token.
1 - Single-use token.
2-
Multi-use token.
3 - Reissue token.
Here are the defned values based on these scenarios.
4 - Certifcate
renewal.
5 - Auto created (catalog recovery).
Type : integer
credIsSetResponse
A fag that specifes whether the security credential is set or not.
Type : boolean
csr
A CSR is a PKCS10 formatted message that is sent from a Secure Sockets Layer (SSL) digital
certifcate applicant to a certifcate authority (CA). The CSR validates the information the
NetBackup CA requires to issue a certifcate.
Type : sring
errorResponse
errorCode
required
errorMessage
required
getAuditRecordResponse
<
auditRecordLis
The lis of audit record details. auditRecordDetails
optional
> array
isDataTruncated
Indicates whether the data is truncated or not. boolean
optional
getCACertifcateResponse
cacert A lis of certifcates of the NetBackup certifcate authority

< certifcate > array

required (VxAT) in a pem-formatted sring.
webRootCert
certifcate
required
getCertifcateLisResponse
<
certifcateLis
A lis of certifcate details. getCertifcateResponse
required
> array
getCertifcateResponse
certifcateKey
For internal use. integer
required
createOn
time
required
hosId
hosID
required
hosName
hosName
required
hosType
hosType
required
notAfter
time
required
notBefore
time
required
publicKey The public key of the hos for which the certifcate is
sring
required issued.
revocationReason
revocationReason
required
serialNumber
serialNo
required
sate
certifcateState
required

tokenType
certifcateTokenType
optional
updatedOn
time
required
getSecPropertyResponse
Lis of security settings.
Name Schema
aliasAutoAdd
aliasAutoAdd
required
required
required
getServerInfoResponse
maserHosId
The hos ID of the NetBackup maser server. hosID
optional
serverName
The name of the NetBackup maser server. sring
optional
getServerTimeResponse
Name Schema
serverTime
time
required
getTokenData
allowedCount
The maximum usage count of the token. integer
required

hosId
hosID
required
tokenActivationTime
time
required
tokenExpirationTime
time
required
tokenKey
For internal use. integer
required
tokenName
The token name to be created. sring
required
The validity of the token.
A token is invalid if the

usedCount has exceeded the allowedCount, the token
is
tokenState
not active yet, or the token has expired. It is valid integer
required
otherwise.
Here are the defned values for token sates:
0
- Not Valid.
1 - Valid.
tokenType
tokenType
required
tokenValue
token
required
usedCount
The used count of the token. integer
required
getTokenResponse
tokenLis < getTokenData >

Lis of tokens.
required array
hosID
The unique ID assigned to the NetBackup hos.
Type : sring
hosInformation
csr
csr

required
hosAlias A lis of hos aliases of the specifed hos. The specifed

< hosName > array
required hosName property mus be present in this hosAlias array.
hosName
hosName
required
hosName
The name of the hos for which the certifcate is issued or is to be issued.
Type : sring
hosType
The type of hos (server or client). Here are the defned values for the hos type:
0 - Unknown.
1-
Server.
2 - Client.
Type : integer
posCertifcateResponse
certifcate
certifcate
required
crl
The certifcate revocation lis. sring (byte)
required
hosId The hos ID of the NetBackup hos that has requesed a

hosID
required certifcate.
maserHosId
The hos ID of the NetBackup maser server. hosID
required
securityLevel The level of hos checking for certifcate regisration and the
integer
required frequency of updates for CRLs.
posCreateTokenReques
The maximum usage count of the token. The default value is

allowedCount
1. integer
required
Maximum value : 99999

hosId
hosID
optional
reason
The reason for creating the token. sring
optional
tokenName
The token name to be created. sring
required
type
tokenType
optional
The validity of the token in seconds. The default validity is 1

validFor
day. integer
required
Maximum value : 86313600
posCreateTokenResponse
tokenValue
The token value. Use for certifcate deployment. sring
required
posDeleteTokenReques
reason
The reason for deleting the token. sring
optional
posRevokeCertifcateReques
Name Schema
revocationReason
revocationReason
optional
posSecPropertyReques
Name Schema
aliasAutoAdd
aliasAutoAdd
optional
optional

optional
revocationReason
The reason for a certifcate revocation. Here are the defned values for the revocation reason.
0=
Unspecifed.
1 = Key Compromise.
2 = CA Compromise.
3 = Afliation Changed.
4 = Superseded.
5=
Cessation Of Operation.
6 = Certifcate Hold.
7 = Others.
Type : integer
secCredDef
credName
The name of the security credential key. sring
required
credValue
The value associated with the security credential key. sring
required
serialNo
The serial number of the certifcate.
Type : integer
time
The number of milliseconds since the Epoch, 1970-01-01 00:00:00 +0000.
Type : integer (int64)
token
The authorization token. It can be of type sandard token, reissue token. Depending on the
certifcate deployment security setting, NetBackup hoss may require an authorization token to
obtain a hos ID-based certifcate from the certifcate authority (maser server). To reques a
certifcate reissue, the token is mandatory and should be of type reissue.
Type : sring
tokenType
The type of the token to be created. Here are the defned values for the token types.
0 - Standard
Token.
1 - Reissue Token.

Type : integer
Security
rbacCertSecurity
Type : apiKey
In : HEADER
rbacUserSecurity
Type : apiKey
In : HEADER
Last updated 2018-02-01 17:58:12 PST

NetBackup 811 API Reference

Caricato da

Informazioni sul documento

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

NetBackup 811 API Reference

Caricato da

Copyright:

Formati disponibili

NetBackup API - 8.1.

NetBackup API - 8.1.1

NetBackup API is RESTful

JSON message format

The client-server relationship

The client then extracts the

https://sort.veritas.com/public/documents/nbu/8.1.1/windowsandunix/productguides/html/index/[2/16/2018 9:16:34 AM]

curl -X POST https://masterservername:1556/netbackup/login \

This response contains three attributes: token , tokenType and validity .

attribute provides the JWT. The validity attribute indicates that

for 86400 seconds, or 24 hours.

https://sort.veritas.com/public/documents/nbu/8.1.1/windowsandunix/productguides/html/index/[2/16/2018 9:16:34 AM]

reques made in the previous sep.

curl -X GET https://masterservername:1556/netbackup/admin/jobs/5 \

https://sort.veritas.com/public/documents/nbu/8.1.1/windowsandunix/productguides/html/index/[2/16/2018 9:16:34 AM]

https://sort.veritas.com/public/documents/nbu/8.1.1/windowsandunix/productguides/html/index/[2/16/2018 9:16:34 AM]

SSL certifcate validation

This certifcate can

To validate the certifcate, you will need to get the Certifcate

and then use the CA certifcate in the API requess.

curl -X POST https://masterservername:1556/netbackup/security/cacert \

The response to the cacert reques contains two certifcates:

https://sort.veritas.com/public/documents/nbu/8.1.1/windowsandunix/productguides/html/index/[2/16/2018 9:16:34 AM]

To do this save the webRootCert sring to a fle.

For example, your fle would look something like this:

For example, to securely use the

curl -X POST https://masterservername:1556/netbackup/security/cacert \

https://sort.veritas.com/public/documents/nbu/8.1.1/windowsandunix/productguides/html/index/[2/16/2018 9:16:34 AM]

The NetBackup API is developed so that new versions are minimized.

The mechanism to version the

Version numbers follow a simple MAJOR.MINOR pattern, such as 1.2 .

These version numbers are

The current API version number is documented with

This media type should be used in the

If you send both Accept and

Such a case normally

The value of the Content-Type or Accept HTTP header in a NetBackup API

API change results in a new version? Yes / No

Add a new endpoint No

Remove an endpoint Yes

Add an output feld or attribute No

Remove output feld or attribute Yes

Add required input feld or attribute Yes

https://sort.veritas.com/public/documents/nbu/8.1.1/windowsandunix/productguides/html/index/[2/16/2018 9:16:34 AM]

Add non-required input feld or attribute No

If the API client expects a particular endpoint or feld in the NetBackup

Do not treat unrecognized felds as an error. This

The results are returned in a page-by-page format.

OData fltering language.

The supported OData operators and functions depend on each individual

API Code Samples

The API code samples are located on github:

This is a community-supported, open

https://sort.veritas.com/public/documents/nbu/8.1.1/windowsandunix/productguides/html/index/[2/16/2018 9:16:34 AM]

NetBackup Authentication API

The JWT is acquired by executing a login API

NetBackup Adminisration API

NetBackup Catalog API

NetBackup Confguration API

NetBackup Recovery API

NetBackup Security API

https://sort.veritas.com/public/documents/nbu/8.1.1/windowsandunix/productguides/html/index/[2/16/2018 9:16:34 AM]

NetBackup Authentication API

200 Web service application details returned successfully. appdetailsResponse