Getting Started
Introduction
The NetBackup API provides a web-service based interface to configure and administer NetBackup, the industry 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 most widely used style 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 applications, 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 request and response messages.
The client-server relationship
The NetBackup API employs client-server communication in the form of HTTP requests and responses.
-
The API client (your program) uses the HTTP protocol to make an API request to the NetBackup server.
-
The NetBackup server processes the request. The server responds to the client with an appropriate HTTP status 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 requests based on the JSON Web Token (JWT) that needs to be provided in the Authorization
HTTP header when making the API requests.
This JSON Web Token (JWT) is acquired by executing a login
API request first.
Tip
|
The port that is used to access the NetBackup API is the standard NetBackup PBX port, 1556 .
|
Example
The following procedure provides a sample workflow to retrieve job information from NetBackup.
This procedure involves logging in to NetBackup to receive a JWT and then requesting job information for a specific job (job ID 5
in this scenario).
- Step 1
-
Use the NetBackup API endpoint
POST /login
to create a login request:
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
request contains the JSON Web Token (JWT):
Note
|
This response contains three attributes: token , tokenType and validity . 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_F01EFZcLnZJgS3MOBNxEhDhNGYi9Tr7KLdJZ4JXBYsgUM0nUtnFFfmirQ7ZBUUZzm6EwEHClDmbTBKczEtacZK55kkXJuwrjcflm6gq45Tgne7I1_o9XF8CNPqdMTnIZEUnYvXLIjQZPnEIoQS2yjAwPVuJLrIFioFfYy4VQ-6JY70hLgERGiv6gad2SYVR9Ya822h6mOKI3sSXRnwSGEWBJMnTLsszTZhpbfarnh9cfI9_saN08DbzZF87m6RcSxyqAKoK63o9RsrJWnPd2zdq-5A8MRqUjUNllN6I4BgpQTuU44S7zzHOqQyeJdboDjAKiVor2YK8_nMutL7DQJux-m_KIIYukvnrthumPCbaS9BCbwkB5j8vW0cYZGfPVrXZHqrHrvU7tfsWmY9wf0Onakt7d3AAAA__8.VVE25rQqbrC-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 ID5
is requested.
Note
|
The Authorization header uses the value of the token attribute from the response to the login
request made in the previous step.
|
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_F01EFZcLnZJgS3MOBNxEhDhNGYi9Tr7KLdJZ4JXBYsgUM0nUtnFFfmirQ7ZBUUZzm6EwEHClDmbTBKczEtacZK55kkXJuwrjcflm6gq45Tgne7I1_o9XF8CNPqdMTnIZEUnYvXLIjQZPnEIoQS2yjAwPVuJLrIFioFfYy4VQ-6JY70hLgERGiv6gad2SYVR9Ya822h6mOKI3sSXRnwSGEWBJMnTLsszTZhpbfarnh9cfI9_saN08DbzZF87m6RcSxyqAKoK63o9RsrJWnPd2zdq-5A8MRqUjUNllN6I4BgpQTuU44S7zzHOqQyeJdboDjAKiVor2YK8_nMutL7DQJux-m_KIIYukvnrthumPCbaS9BCbwkB5j8vW0cYZGfPVrXZHqrHrvU7tfsWmY9wf0Onakt7d3AAAA__8.VVE25rQqbrC-isGOqbRTqMPoK4ts5-9_6zSgz0fUg11m9GCClq10PS9u1DlaXye-S2MYYyHVEHSVs6uKcPVvN2WGBHkv7t-c4Hixc9O8zrJYhJaP979wF_gn08YnRlX7_o4Qj6muc1IWHjK0hPMIgq0X-sBU2Git9uppVW1jbLA'
The response to the GET
request 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 certificate validation
The NetBackup web service always sends its certificate during SSL handshakes. This certificate can be validated by the API client. To validate the certificate, you will need to get the Certificate Authority (CA) certificate from the master server and then use the CA certificate in the API requests.
Tip
|
It is a good practice to validate the SSL certificate. This action ensures that you are communicating with the correct web service. |
- Step 1
-
Get the CA certificate from the master server using the
GET /security/cacert
API:
Note
|
You cannot make a secure request with certificate validation until you have the CA certificate. To obtain the initial CA certificate you must skip the certificate validation, with the "--insecure" curl option. |
curl -X GET https://masterservername:1556/netbackup/security/cacert \ -H 'content-type: application/vnd.netbackup+json;version=1.0' \ --insecure
The response to the cacert
request contains two certificates:
{
"webRootCert": "-----BEGIN CERTIFICATE-----\nMIICljCCAf+gAwIBAgIIcte7aAAAAAAwDQYJKoZIhvcNAQENBQAwTTEOMAwGA1UE\nAxMFbmJhdGQxLjAsBgNVBAsUJXJvb3RAbW9ybGV5dm01LnJtbnVzLnNlbi5zeW1h\nbnRlYy5jb20xCzAJBgNVBAoTAnZ4MB4XDTE4MDEwODE0MjcyNloXDTM4MDEwMzE1\nNDIyNlowTTEOMAwGA1UEAxMFbmJhdGQxLjAsBgNVBAsUJXJvb3RAbW9ybGV5dm01\nLnJtbnVzLnNlbi5zeW1hbnRlYy5jb20xCzAJBgNVBAoTAnZ4MIGfMA0GCSqGSIb3\nDQEBAQUAA4GNADCBiQKBgQDpRc/yo0utxcKrftPeOzn1o1MR5b42uGWrwg9kU4VM\nZN++0kvrtRWt4wz8zdtNU4wtg/MHWt0ffj6FRYYAZBbM8fu56GFux3wCPJSHWl6B\nZ0nD1vZxFUwTXkRAAObuHrYphjBNf1oUU+4GS44KD4/UW/bucKdZsUI1+HcfCQZw\nNwIDAQABo38wfTAPBgNVHRMBAf8EBTADAQH/MAsGAyoDBQQEcm9vdDAPBgMqAwYE\nCDAwMDAwMDE3MC0GAyoDCAQmezg2ZDY5MDU0LWY0OGEtMTFlNy1hNDAyLTYwYWQy\nMTZjYTdlZX0wHQYDVR0OBBYEFE/mpo7PbWs7p/zkAHWi/BDwpdn+MA0GCSqGSIb3\nDQEBDQUAA4GBAAmZJ98XLqG0H+qwyuZ97YdzE2dWKpRduuARYJp437Sc6tpL6nFn\nuzbtGV30tDdhROYPf1AoNRmZHvz40Hra1B8j4VFggPZOAmmk+UJPjzeHn6qhlRxl\nHjCdEqUZ//+1Aqgj6f/6bqPO5boCVP1qw8N60fkBaV3zLwAOY6CKiHS0\n-----END CERTIFICATE-----\n",
"cacert": [
"-----BEGIN CERTIFICATE-----\nMIICljCCAf+gAwIBAgIIcte7aAAAAAAwDQYJKoZIhvcNAQENBQAwTTEOMAwGA1UE\nAxMFbmJhdGQxLjAsBgNVBAsUJXJvb3RAbW9ybGV5dm01LnJtbnVzLnNlbi5zeW1h\nbnRlYy5jb20xCzAJBgNVBAoTAnZ4MB4XDTE4MDEwODE0MjcyNloXDTM4MDEwMzE1\nNDIyNlowTTEOMAwGA1UEAxMFbmJhdGQxLjAsBgNVBAsUJXJvb3RAbW9ybGV5dm01\nLnJtbnVzLnNlbi5zeW1hbnRlYy5jb20xCzAJBgNVBAoTAnZ4MIGfMA0GCSqGSIb3\nDQEBAQUAA4GNADCBiQKBgQDpRc/yo0utxcKrftPeOzn1o1MR5b42uGWrwg9kU4VM\nZN++0kvrtRWt4wz8zdtNU4wtg/MHWt0ffj6FRYYAZBbM8fu56GFux3wCPJSHWl6B\nZ0nD1vZxFUwTXkRAAObuHrYphjBNf1oUU+4GS44KD4/UW/bucKdZsUI1+HcfCQZw\nNwIDAQABo38wfTAPBgNVHRMBAf8EBTADAQH/MAsGAyoDBQQEcm9vdDAPBgMqAwYE\nCDAwMDAwMDE3MC0GAyoDCAQmezg2ZDY5MDU0LWY0OGEtMTFlNy1hNDAyLTYwYWQy\nMTZjYTdlZX0wHQYDVR0OBBYEFE/mpo7PbWs7p/zkAHWi/BDwpdn+MA0GCSqGSIb3\nDQEBDQUAA4GBAAmZJ98XLqG0H+qwyuZ97YdzE2dWKpRduuARYJp437Sc6tpL6nFn\nuzbtGV30tDdhROYPf1AoNRmZHvz40Hra1B8j4VFggPZOAmmk+UJPjzeHn6qhlRxl\nHjCdEqUZ//+1Aqgj6f/6bqPO5boCVP1qw8N60fkBaV3zLwAOY6CKiHS0\n-----END CERTIFICATE-----\n"
]
}
- Step 2
-
Save the
webRootCert
certificate. To do this save thewebRootCert
string to a file. Make sure to convert the\n
escape sequences to new lines (carriage returns).
For example, your file 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 certificate in your API requests. For example, to securely use the
cacert
API remove the--insecure
option and use the--cacert <filename>
option. In the following example, the CA certificate was saved in the filecacert.pem
.
curl -X GET https://masterservername:1556/netbackup/security/cacert \ -H 'content-type: application/vnd.netbackup+json;version=1.0' \ --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 requesting.
A new vendor-specific 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 request.
If you send both Accept
and Content-Type
HTTP headers, their values must 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 must be specified.
Tip
|
The value of the Content-Type or Accept HTTP header in a NetBackup API request must 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 list 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 field or attribute |
No |
Remove output field or attribute |
Yes |
Add required input field or attribute |
Yes |
Add non-required input field or attribute |
No |
Note
|
|
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 starting point (offset) and the page size (limit).
The results are returned in a page-by-page format.
Tip
|
The default page size is 10 resources. The type of resource depends on the individual API.
For example: For the API that gets a list of jobs, the page contains job-related information for up to 10 NetBackup jobs.
|
Filtering
Some NetBackup APIs use the 'filter' 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 filtering language.
Note
|
The supported OData operators and functions depend on each individual 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 different 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 officially 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 list 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 requests.
The JWT is acquired by executing a login
API request and can be invalidated by executing a logout
API request.
NetBackup Administration API
The NetBackup Administration API provides management of NetBackup jobs. The API can get job details for a specific job or get a list of jobs based on filter criteria, restart
or resume
a job, suspend
, cancel
, or delete
a job, get a job’s file list, 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 list backup images based on filters or get details for a specific backup image ID.
NetBackup Configuration API
The NetBackup Configuration API provides configuration and management controls for NetBackup hosts, 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, host ID-based certificates, security configuration 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 requests.
Version information
Version : 1.0
URI scheme
Host : <masterserver>:1556
BasePath : /netbackup
Schemes : HTTPS
Paths
GET /appdetails
Description
Gets the web service application details. The application names and status are returned.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Web service application details returned successfully. |
|
406 |
Invalid |
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 requests.
Parameters
Type | Name | Schema |
---|---|---|
Body |
login |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Login successful. |
|
400 |
Bad request |
|
401 |
Wrong username or password. |
|
406 |
Invalid |
|
415 |
Unsupported Media Type. The media type specified in the |
Consumes
-
application/vnd.netbackup+json;version=1.0
Produces
-
application/vnd.netbackup+json;version=1.0
POST /logout
Description
Removes the current access token (JWT), which invalidates that token for future API calls.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Logout successful. |
No Content |
401 |
The |
|
406 |
Invalid |
Security
Type | Name |
---|---|
apiKey |
GET /ping
Description
Tests the connection to the gateway service from the client and returns the master server time in milliseconds.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Ping successful. Master server time in milliseconds. |
string |
406 |
Invalid |
string |
Produces
-
text/plain
GET /tokenkey
Description
Gets the public key that can be used to validate the JSON Web Token (JWT).
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully retrieved the token key. |
string |
406 |
Invalid |
string |
Produces
-
text/html
Definitions
appdetailsResponse
Type : < appdetailsResponse > array
appdetailsResponse
Name | Description | Schema |
---|---|---|
appName |
Application name. |
string |
status |
Current run-time status of the application. |
string |
errorResponse
Name | Description | Schema |
---|---|---|
errorCode |
The NetBackup error code. |
integer (int64) |
errorMessage |
The NetBackup error code description. |
string |
loginResponse
Name | Description | Schema |
---|---|---|
token |
The token to use for subsequent API requests. |
string |
tokenType |
The token type for the token that is returned. |
string |
validity |
The time in seconds that this token will be valid. |
integer |
userPassLoginRequest
Name | Description | Schema |
---|---|---|
domainName |
The domain name for the user. |
string |
domainType |
The domain type for the user. |
enum (NIS, NIS+, NT, vx, unixpwd) |
password |
The user password. |
string |
userName |
The user account name. |
string |
Security
rbacSecurity
Type : apiKey
Name : Authorization
In : HEADER
NetBackup Administration API
Overview
The NetBackup Administration API provides access to administrative operations in NetBackup.
Version information
Version : 1.0
URI scheme
Host : <masterserver>:1556
BasePath : /netbackup
Schemes : HTTPS
Paths
GET /admin/jobs
Description
Gets the list of jobs based on specified filters. If no filters are specified, information for 10 jobs sorted in descending order by job start time is retrieved. All the filters are based on OData standards, and filtering 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[Offset]" & "page[limit]" which allows for subsequent requests to "page" through the rest of the results until the end is reached.
Name | Supported Operators | Description | Schema |
---|---|---|---|
jobId |
eq ne lt gt le ge |
The job identifier. |
integer(int64) |
clientName |
contains, startswith, endswith |
The name of the client to be protected. |
string |
endTime |
eq ne lt gt le ge |
Specifies the time when the job finished. |
date-time |
startTime |
eq ne lt gt le ge |
Specifies the time when the job started. |
date-time |
state |
eq ne |
Specifies the state of the job. Possible values: QUEUED, ACTIVE, REQUEUED, DONE, SUSPENDED, INCOMPLETE |
string |
status |
eq ne lt gt le ge |
Specifies the final job status code. |
integer(int64) |
jobType |
eq ne |
Specifies the type of the job. Possible values: BACKUP, ARCHIVE, RESTORE, VERIFY, DUPLICATE, IMPORT, DBBACKUP, VAULT, LABEL, ERASE, TPREQ, TPCLEAN, TPFORMAT, VMPHYSINV, DQTS, DBRECOVER, MCONTENTS, IMAGEDELETE, 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 |
string |
policyName |
contains, startswith, endswith |
The name of the policy used by this job. |
string |
policyType |
eq ne |
Specifies the type of the policy. Possible values: STANDARD, PROXY, NONSTANDARD, APOLLO_WBAK, OBACKUP, ANY, INFORMIX, SYBASE, SHAREPOINT, WINDOWS, NETWARE, BACKTRACK, AUSPEX_FASTBACK, WINDOWS_NT, OS2, SQL_SERVER, EXCHANGE, SAP, DB2, NDMP, FLASHBACKUP, SPLITMIRROR, AFS, DFS 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 |
string |
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
filter |
Specifies filters according to OData standards. |
string |
Query |
page[limit] |
The number of records on one page after the offset. |
integer (int64) |
Query |
page[offset] |
The job record number offset. |
integer (int64) |
Query |
sort |
Sorts in ascending order on the specified property. Prefix with '-' for descending order. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully retrieved the list of jobs based on the specified filters. |
|
400 |
Bad request. |
|
401 |
The |
|
404 |
No entity found. |
|
405 |
Method not allowed. The specified HTTP operation is invalid. |
|
406 |
Invalid |
|
415 |
Unsupported Media Type. The media type specified in the |
|
500 |
An unexpected system error occurred. |
|
503 |
The server is busy. |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
GET /admin/jobs/{jobId}
Description
Gets the job details for the specified job.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
jobId |
The job identifier. |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully retrieved the job details for the specified job. |
|
401 |
The |
|
404 |
No entity found. |
|
405 |
Method not allowed. The specified HTTP operation is invalid. |
|
406 |
Invalid |
|
415 |
Unsupported Media Type. The media type specified in the |
|
500 |
An unexpected system error occurred. |
|
503 |
The server is busy. |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
DELETE /admin/jobs/{jobId}
Description
Deletes the specified job.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
X-NetBackup-Audit-Reason |
The audit reason for deleting the job. |
string |
Path |
jobId |
The job identifier. |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Request accepted. |
No Content |
401 |
The |
|
404 |
No entity found. |
|
405 |
Method not allowed. The specified HTTP operation is invalid. |
|
415 |
Unsupported Media Type. The media type specified in the |
|
500 |
An unexpected system error occurred. |
|
503 |
The server is busy. |
Consumes
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
POST /admin/jobs/{jobId}/cancel
Description
Cancels the specified job.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
X-NetBackup-Audit-Reason |
The audit reason for cancelling the job. |
string |
Path |
jobId |
The job identifier. |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Request accepted. |
No Content |
400 |
Bad request. |
|
401 |
The |
|
404 |
No entity found. |
|
405 |
Method not allowed. The specified HTTP operation is invalid. |
|
415 |
Unsupported Media Type. The media type specified in the |
|
500 |
An unexpected system error occurred. |
|
503 |
The server is busy. |
Consumes
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
GET /admin/jobs/{jobId}/file-lists
Description
Gets the file list for the specified job.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
jobId |
The job identifier. |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully retrieved the file list for the specified job. |
|
401 |
The |
|
404 |
No entity found. |
|
405 |
Method not allowed. The specified HTTP operation is invalid. |
|
406 |
Invalid |
|
415 |
Unsupported Media Type. The media type specified in the |
|
500 |
An unexpected system error occurred. |
|
503 |
The server is busy. |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
POST /admin/jobs/{jobId}/restart
Description
Restarts the specified job.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
X-NetBackup-Audit-Reason |
The audit reason for restarting the job. |
string |
Path |
jobId |
The job identifier. |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Request accepted. |
No Content |
400 |
Bad request. |
|
401 |
The |
|
404 |
No entity found. |
|
405 |
Method not allowed. The specified HTTP operation is invalid. |
|
415 |
Unsupported Media Type. The media type specified in the |
|
500 |
An unexpected system error occurred. |
|
503 |
The server is busy. |
Consumes
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
POST /admin/jobs/{jobId}/resume
Description
Resumes the specified job.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
X-NetBackup-Audit-Reason |
The audit reason for resuming the job. |
string |
Path |
jobId |
The job identifier. |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Request accepted. |
No Content |
400 |
Bad request. |
|
401 |
The |
|
404 |
No entity found. |
|
405 |
Method not allowed. The specified HTTP operation is invalid. |
|
415 |
Unsupported Media Type. The media type specified in the |
|
500 |
An unexpected system error occurred. |
|
503 |
The server is busy. |
Consumes
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
POST /admin/jobs/{jobId}/suspend
Description
Suspends the specified job.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
X-NetBackup-Audit-Reason |
The audit reason for suspending the job. |
string |
Path |
jobId |
The job identifier. |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
202 |
Request accepted. |
No Content |
400 |
Bad request. |
|
401 |
The |
|
404 |
No entity found. |
|
405 |
Method not allowed. The specified HTTP operation is invalid. |
|
415 |
Unsupported Media Type. The media type specified in the |
|
500 |
An unexpected system error occurred. |
|
503 |
The server is busy. |
Consumes
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
GET /admin/jobs/{jobId}/try-logs
Description
Gets logs for the specified job.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
jobId |
The job identifier. |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully retrieved the try-logs for the specified job. |
|
401 |
The |
|
404 |
No entity found. |
|
405 |
Method not allowed. The specified HTTP operation is invalid. |
|
406 |
Invalid |
|
415 |
Unsupported Media Type. The media type specified in the |
|
500 |
An unexpected system error occurred. |
|
503 |
The server is busy. |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
Definitions
errorResponse
Name | Description | Schema |
---|---|---|
errorCode |
The NetBackup error code. |
integer (int64) |
errorMessage |
The NetBackup error code description. |
string |
getJobDetailsResponse
Name | Schema |
---|---|
data |
data
Name | Schema |
---|---|
attributes |
|
id |
string |
links |
|
type |
string |
attributes
Name | Description | Schema |
---|---|---|
acceleratorOptimization |
The percentage of optimization achieved if the job uses NetBackup Accelerator. |
integer (int64) |
activeProcessId |
The process that is active now. |
integer (int64) |
activeTryStartTime |
A UTC timestamp of when the current try started. |
string |
auditDomainName |
The domain name for auditing. |
string |
auditDomainType |
The auditing domain type. |
integer (int64) |
auditUserName |
The user name in the audit record. |
string |
backupId |
The backup ID or image ID. |
string |
clientName |
The name of the client to be protected. |
string |
compression |
Indicates if compression is enabled for the backup policy. |
integer (int64) |
controlHost |
The host from which the job was initiated. |
string |
copyNumber |
The backup image copy number. |
integer (int64) |
currentFile |
The current file being protected. |
string |
currentOperation |
The current operation being performed. |
integer (int64) |
dataMovement |
The type of data movement used for this job. |
enum (STANDARD, INSTANTRECOVERYDISK, INSTANTRECOVERYDISKANDTAPE, SYNTHETIC, DISKSTAGING, SNAPSHOT) |
dedupRatio |
The deduplication rate achieved. |
number (float) |
destinationMediaId |
The destination media server. Used for deduplication jobs. |
string |
destinationMediaServerName |
The destination media server name. Used for deduplication jobs. |
string |
destinationStorageUnitName |
The destination storage unit. Used for deduplication jobs. |
string |
done |
Indicates if the job is complete. |
integer (int64) |
dumpHost |
The recovery appliance host name for Copilot. |
string |
endTime |
The job end time. |
string (date-time) |
estimatedFiles |
The estimated number of files to be protected. |
integer (int64) |
frozenImage |
Used internally to flag snapshots. Also used to determine if the job type is snapshot. |
integer (int64) |
instanceDatabaseName |
The database instance and/or database name itself. |
string |
jobGroup |
The group name of the job initiator. |
string |
jobId |
The job identifier. |
integer (int64) |
jobOwner |
The user name of the job initiator. |
string |
jobQueueReason |
The reason the job is queued. A value of -99 indicates that an invalid value was returned. 1=MEDIA_IN_USE, 2=DRIVES_IN_USE, 3=MEDIA_SERVER_OFFLINE, 4=ROBOT_DOWN, 5=MAX_STORAGE_UNIT_JOBS, 6=MEDIA_REQUEST_DELAY, 7=LOCAL_DRIVES_DOWN, 8=MEDIA_IN_DRIVE_IN_USE, 9=PHYSICAL_DRIVE_UNAVAILABLE, 10=CLEANING_MEDIA_UNAVAILABLE, 11=DRIVE_SCAN_HOST_OFFLINE, 12=DISK_MEDIA_SERVER_OFFLINE, 13=NO_MASTER_MEDIA_CONNECTIVITY, 14=MEDIA_SERVER_NON_ACTIVE_MODE, 15=STORAGEUNIT_JOB_COUNTS_THROTTLED, 16=JOB_HISTORY_DRIVES_IN_USE, 17=DISK_VOLUME_UNAVAILABLE, 18=MAX_CONCURRENT_VOLUME_READERS, 19=DISK_GROUP_UNAVAILABLE, 20=FAT_PIPE_IN_USE, 21=DISK_VOLUME_UNMOUNTING, 22=DISK_VOLUME_IN_USE, 23=MAX_PARTIAL_MEDIA, 24=LOGICAL_RESOURCE, 25=DRIVES_IN_STORAGE_UNIT_IN_USE, 26=STOP_DRIVE_SCAN, 27=DISK_VOLUME_MOUNTING, 28=MOUNT_FILE_EXISTS, 29=PENDING_ACTION, 30=DISK_VOLUME_STREAM_LIMIT |
integer (int64) |
jobQueueResource |
The name of the resource for which the queued job is waiting. |
string |
jobSubType |
The job sub-type. |
enum (IMMEDIATE, SCHEDULED, USERBACKUP, ERASETYPE_QUICK, ERASETYPE_LONG, DBBACKUP_STAGING, DBBACKUP_COLD, RMAN_CATALOG) |
jobType |
The job type. |
enum (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) |
killable |
Indicates if the job can be stopped. |
integer (int64) |
kilobytesDataTransferred |
The actual data transferred in kilobytes. For some jobs, data transferred is different than the final image size. |
integer (int64) |
kilobytesToTransfer |
The remaining kilobytes to be transferred. |
integer (int64) |
kilobytesTransferred |
The estimated amount of data transferred in kilobytes. |
integer (int64) |
lastUpdateTime |
The UTC timestamp when the job was modified. |
string (date-time) |
mainProcessId |
The process ID of the main controlling process for restore and image cleanup. |
integer (int64) |
numberOfFiles |
The actual number of files protected. |
integer (int64) |
numberOfTapeToEject |
For vault jobs, the total number of tape media to be ejected. |
integer (int64) |
parentJobId |
The parent job ID. |
integer (int64) |
percentComplete |
The estimated completion percentage of this job. |
integer (int64) |
policyName |
The name of the policy used by this job. |
string |
policyType |
The backup policy type used by the job. |
enum (STANDARD, PROXY, NONSTANDARD, APOLLO_WBAK, OBACKUP, ANY, INFORMIX, SYBASE, SHAREPOINT, WINDOWS, NETWARE, BACKTRACK, AUSPEX_FASTBACK, WINDOWS_NT, OS2, SQL_SERVER, EXCHANGE, SAP, DB2, NDMP, FLASHBACKUP, SPLITMIRROR, AFS, DFS, 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, NBU_SEARCHSERVER, HYPERSCALE, BIGDATA) |
priority |
The priority of this job. |
integer (int64) |
productType |
The product type number. |
integer (int64) |
profileName |
The name of the Vault profile. |
string |
restartable |
Indicates if the job can be restarted. |
integer (int64) |
restoreBackupIDs |
The list of backup IDs needed for the restore job. |
string |
resumable |
Indicates if the job can be resumed. |
integer (int64) |
retention |
The retention level of the backup image. |
integer (int64) |
robotName |
The name of the robot in the Vault job. |
string |
scheduleName |
The name of the backup schedule used by the backup job. |
string |
scheduleType |
The type of schedule used by the backup job. |
enum (FULL, DIFFERENTIAL_INCREMENTAL, USER_BACKUP, USER_ARCHIVE, CUMULATIVE_INCREMENTAL, TRANSACTION_LOG) |
sessionId |
The Vault session ID. |
integer (int64) |
sourceMediaId |
The source media ID for the duplication job. |
string |
sourceMediaServerName |
The source media server name for the duplication job. |
string |
sourceStorageUnitName |
The source storage unit. |
string |
startTime |
The UTC timestamp when the job was started. |
string (date-time) |
state |
The current state of the job. |
enum (QUEUED, ACTIVE, REQUEUED, DONE, SUSPENDED, INCOMPLETE) |
status |
The final job status code. |
integer (int64) |
streamNumber |
The job stream number. |
integer (int64) |
submissionType |
The job submission type. |
integer (int64) |
suspendable |
Indicates if the job can be suspended. |
integer (int64) |
transferRate |
The data transfer rate in kilobytes (KB) per second. |
integer (int64) |
transportType |
The data transport type used for the job. |
enum (LAN, FAT) |
try |
The current try number to execute this job. |
integer (int64) |
vaultName |
The Vault name used by the job. |
string |
links
Name | Schema |
---|---|
file-lists |
|
self |
|
try-logs |
file-lists
Name | Schema |
---|---|
href |
string |
self
Name | Schema |
---|---|
href |
string |
try-logs
Name | Schema |
---|---|
href |
string |
getJobFileListResponse
Name | Schema |
---|---|
data |
data
Name | Schema |
---|---|
attributes |
|
id |
integer (int64) |
links |
|
type |
string |
attributes
Name | Schema |
---|---|
fileList |
< string > array |
links
Name | Schema |
---|---|
self |
self
Name | Schema |
---|---|
href |
string |
getJobTryLogsResponse
Name | Schema |
---|---|
data |
data
Name | Schema |
---|---|
attributes |
|
id |
integer (int64) |
links |
|
type |
string |
attributes
Name | Schema |
---|---|
log |
< string > array |
links
Name | Schema |
---|---|
self |
self
Name | Schema |
---|---|
href |
string |
getJobsResponse
Name | Schema |
---|---|
data |
|
links |
|
meta |
data
Name | Schema |
---|---|
attibutes |
< getJobDetailsResponse > array |
id |
integer (int64) |
type |
string |
links
Name | Schema |
---|---|
first |
|
last |
|
next |
|
prev |
|
self |
first
Name | Schema |
---|---|
href |
string |
last
Name | Schema |
---|---|
href |
string |
next
Name | Schema |
---|---|
href |
string |
prev
Name | Schema |
---|---|
href |
string |
self
Name | Schema |
---|---|
href |
string |
meta
Name | Schema |
---|---|
pagination |
pagination
Name | Schema |
---|---|
count |
integer (int64) |
first |
integer (int64) |
last |
integer (int64) |
limit |
integer (int64) |
next |
integer (int64) |
offset |
integer (int64) |
page |
integer (int64) |
pages |
integer (int64) |
prev |
integer (int64) |
Security
rbacSecurity
Type : apiKey
Name : Authorization
In : HEADER
NetBackup Catalog API
Overview
The NetBackup Catalog API provides access to the NetBackup catalog.
Version information
Version : 1.0
URI scheme
Host : <masterserver>:1556
BasePath : /netbackup
Schemes : HTTPS
Paths
GET /catalog/images
Description
Get the list of images based on specified filters. If no filters are specified, information for the last 10 images made within the last 24 hours is returned. All the filters are based on OData standards and filtering on the following attributes is supported.
Name | Supported Operators | Description | Schema |
---|---|---|---|
backupId |
eq |
Specifies the backup ID. |
string |
backupTime |
ge le |
Specifies the backup time. |
date-time |
clientName |
eq |
Specifies the client name. |
string |
policyType |
eq |
Specifies the policy type. |
string |
policyName |
eq |
Specifies the policy name. |
string |
scheduleType |
eq |
Specifies the schedule type. Possible values: FULL DIFFERENTIAL_INCREMENTAL USER_BACKUP USER_ARCHIVE CUMULATIVE_INCREMENTAL |
string |
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
filter |
The filter criteria in OData format. |
string |
|
Query |
page[limit] |
The number of images on one page. |
integer |
|
Query |
page[offset] |
The image record number offset. |
integer |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Returned the list of catalog images based on the filter criteria. |
|
400 |
Invalid filter criteria. |
|
401 |
The |
|
404 |
No images were found that met the filter criteria. |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
GET /catalog/images/{backupId}
Description
Requests the details of an image.
Parameters
Type | Name | Schema |
---|---|---|
Path |
backupId |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Image details were returned successfully. |
|
400 |
The backup ID is invalid. |
|
401 |
The |
|
404 |
No images were found with the specified backup ID. |
|
406 |
Invalid |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
GET /catalog/vmware-images/{backupId}
Description
Requests the details of a VMware image.
Parameters
Type | Name | Schema |
---|---|---|
Path |
backupId |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
VMware image details returned successfully. |
|
400 |
The backup ID is invalid. |
|
401 |
The |
|
404 |
The VMware image was not found. |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
Definitions
errorResponse
Name | Description | Schema |
---|---|---|
errorCode |
The NetBackup error code. |
integer (int64) |
errorMessage |
The NetBackup error code description. |
string |
fragment
Name | Description | Schema |
---|---|---|
blockSize |
The block size used when writing the backup. |
integer |
checkpoint |
Internal use. |
integer |
copyDate |
In NetBackup 6.5 and later, for the first fragment of each copy, the ISO-8601 timestamp that the copy was written. Otherwise the value is 0. |
string (date-time) |
copyNumber |
The copy number for this record. |
integer |
dataFormat |
The backup data format. These enums are the same as the "data format types" in NetBackup (for example, DF_TAR, DF_SNAPSHOT and DF_NDMP). |
enum (TAR, SNAPSHOT, NDMP_DUMP) |
density |
The NetBackup density of the media written to. |
integer |
deviceWrittenOn |
The device that the copy was written on. This is the tape drive index, or -1 for non-tape media based backups. |
integer |
expiration |
The ISO-8601 timestamp of expiration date of this copy. |
string (date-time) |
fileNumber |
The file number. This number is a numeric value that indicates the file number on the media. This number is displayed in the Activity Monitor under the Job Detailed Status as "positioning to file". |
integer |
firstBlock |
Internal use. |
integer |
fragmentFlags |
Internal use. |
integer |
fragmentNumber |
The fragment number of this record within this copy. |
integer |
host |
The name of the host that wrote this image copy to media. |
string |
kbytes64 |
The size of the fragment in kilobytes. |
integer |
lastBlock |
Internal use. |
integer |
mediaDate |
The UTC timestamp of the AssignTime for tape media. |
integer |
mediaDesc |
Internal use. |
string |
mediaId |
The media ID or path this fragment is written to. |
string |
mediaSequenceNumber |
Internal use. |
integer |
mediaSubtype |
Internal use. |
integer |
mediaType |
Internal use. |
integer |
multiplex |
Internal use. |
integer |
offset |
Internal use. |
integer |
remainder |
Internal use. |
integer |
resumeNumber |
Internal use. |
integer |
retentionLevel |
Internal use. |
integer |
slpTryToKeepDate |
Internal use. |
integer |
image
Name | Schema |
---|---|
attributes |
|
id |
string |
links |
|
relationships |
|
type |
string |
links
Name | Schema |
---|---|
self |
self
Name | Schema |
---|---|
href |
string |
imageAttributes
Name | Description | Schema |
---|---|---|
backupCopyType |
The type of backup copy. These enums are the same as the "backup copy constants" in NetBackup, for example, BC_DEFAULT, BC_TPC, etc. |
enum (DEFAULT, TPC, MEDIA_SERVER, NAS, SNAPSHOT, NDMP) |
backupId |
The backup ID of the backup image record. |
string |
backupStatus |
The NetBackup exit status of the backup job. |
integer |
backupTime |
The time used for backup image ID in ISO-8601 format |
string (date-time) |
blockIncrementalFullTime |
The time used for Block Level Incremental Backups (BLIB). A non-zero value indicates the current backup time if BLIB is performed. |
integer |
clientCharset |
Integer representation of the character set used when the client calls bpcd. |
integer |
clientName |
The name of the client protected by this image. |
string |
compression |
Indicates whether software compression is used. |
boolean |
contentFile |
The filename of the content (*.f) file. |
string |
contentFileCompressed |
Type of compression used on the content file (*.f). |
enum (UNKNOWN, NOT, LEGACY, SCRIPT_OLD, SCRIPT_NEW, ZLIB) |
contentFileSize |
The size of content file. |
string |
creator |
The user name of backup initiator. |
string |
dataClassification |
The data class specified in the policy. |
string |
drMediaList |
A list of tape media IDs required for DR. |
< string > array |
elapsedTimeSeconds |
The amount of time (in seconds) that the backup took to run to completion. |
integer |
encryption |
Type of encryption used. |
enum (NONE, LEGACY, CIPHER) |
expiration |
The ISO 8601 timestamp for the expiration of this image. |
string (date-time) |
extendedSecurityInfo |
True if extended security information was used. |
boolean |
fileSystemOnly |
This is a type of recovery option. |
boolean |
fragments |
The fragment list for all copies of the image. |
< fragment > array |
imageDumpLevel |
The NDMP dump level. |
integer |
imageType |
Identifies the image as one of the following types: 0 = REGULAR or normal backup, 1 = PRE_IMPORT or Phase 1 import of this image is completed, 2 = IT_IMPORTED or Phase 2 import of this image is completed; this value also means that an imported image was backed up. |
enum (NORMAL, PRE_IMPORT, IMPORTED) |
jobId |
The backup job ID. |
integer |
kbytes |
The number of kilobytes (KB) backed up. |
integer |
kbytesDataTransferred |
The number of bytes transferred. |
integer |
keyword |
The backup policy keyword. |
string |
mpx |
Indicates if the image is multiplexed on tape. |
boolean |
numCopies |
The number of copies of this image. |
integer |
numFiles |
The number of files backed up. |
integer |
numberFragments |
The total number of fragments including all copies, that is, the length of the "fragments" array. |
integer |
originMasterServer |
The name of the origin master server. |
string |
policyName |
The name of the backup policy. |
string |
policyType |
This value describes what agent generated the image "Standard", "Oracle", "MS-Windows", "VMware", "Hyper-V", "MS-SQL-Server", "MS-Exchange-Server", etc. |
string |
primaryCopy |
The default copy to use for restores and duplications. |
integer |
proxyClient |
The host name of the proxy client used for the backup. |
string |
remoteExpiration |
The UTC timestamp for the REMOTE expiration of this image. See "Auto Image Replication". |
integer |
retentionLevel |
The retention level of the image. |
integer |
scheduleName |
The name of the schedule used to create the backup. |
string |
scheduleType |
The type of schedule. These enums are the same as the "schedule types" in NetBackup, for example, ST_FULL, ST_DINC, ST_UBACKUP, ST_UARCHIVE and ST_CINC. |
enum (FULL, DIFFERENTIAL_INCREMENTAL, USER_BACKUP, USER_ARCHIVE, CUMULATIVE_INCREMENTAL) |
slpCompleted |
Indicates that the storage lifecycle policy (SLP) has satisfied all its operations on this image. |
integer |
slpName |
The name of the SLP managing this image. |
string |
slpVersion |
The version number of the SLP managing this image. |
integer |
snapshotTime |
The time in ISO-8601 format when the snapshot was taken. |
string (date-time) |
tirExpiration |
The UTC timestamp for the expiration of the True Image Recovery (TIR) data. |
integer |
version |
The image format version. |
integer |
imageDetail
Name | Schema |
---|---|
data |
imageList
Name | Schema |
---|---|
data |
< image > array |
imageRelationships
Name | Schema |
---|---|
vmwareImage |
vmwareImage
Name | Schema |
---|---|
data |
|
links |
data
Name | Schema |
---|---|
id |
string |
type |
string |
links
Name | Schema |
---|---|
related |
Name | Schema |
---|---|
href |
string |
vmwareImage
Name | Schema |
---|---|
attributes |
|
id |
string |
links |
|
relationships |
|
type |
string |
attributes
Name | Description | Schema |
---|---|---|
backupTime |
The time used for backup image ID in ISO-8601 format |
string (date-time) |
biosUUID |
The BIOS UUID of the virtual machine. |
string |
client |
The name of the client protected by this image. |
string |
cluster |
The cluster that the virtual machine belongs to. |
string |
datacenter |
The data center of the virtual machine. |
string |
esxiServer |
The ESX server name of the virtual machine. |
string |
instanceUUID |
The Instance UUID of the virtual machine. |
string |
ipAddress |
The IP address of the client that is protected by this image. |
string |
policyName |
The name of the backup policy. |
string |
resourcePoolOrVapp |
The name of the resource pool or a vApp that was assigned to the VM when it was backed up. A resource pool is a way of controlling resources. A VM is always in a resource pool. |
string |
scheduleType |
The type of schedule. These enums are the same as the "schedule types" in NetBackup, for example, ST_FULL, ST_DINC, ST_UBACKUP, ST_UARCHIVE and ST_CINC. |
enum (FULL, DIFFERENTIAL_INCREMENTAL, USER_BACKUP, USER_ARCHIVE, CUMULATIVE_INCREMENTAL) |
vCDOrg |
The name of the vCloud Director Organization or tenant that a VM belonged to if the backup was a vCloud Director backup. |
string |
vCDOrgVDC |
The name of the Virtual DataCenter the VM resided in if the backup was a vCloud Director backup. |
string |
vCDServer |
The name of the vCloud Director server if the backup was a vCloud Director backup. |
string |
vCDVApp |
The name of the vApp that the VM is part of if the backup was a vCloud Director backup. |
string |
vCDVmName |
The logical name of the VM inside the vApp if the backup was a vCloud Director backup. |
string |
vCenter |
The name of the vCenter hosting the virtual machine. |
string |
vmDNSName |
The DNS name of the virtual machine. |
string |
vmDisplayName |
The display name of the virtual machine. |
string |
vmFolder |
The datastore path where the virtual machine is stored. |
string |
vmHostName |
The host name of the virtual machine. |
string |
vmxDatastore |
The name of the datastore where the VM configuration files were located. |
string |
links
Name | Schema |
---|---|
self |
self
Name | Schema |
---|---|
href |
string |
relationships
Name | Schema |
---|---|
image |
image
Name | Schema |
---|---|
data |
|
links |
data
Name | Schema |
---|---|
id |
string |
type |
string |
links
Name | Schema |
---|---|
related |
Name | Schema |
---|---|
href |
string |
vmwareImageDetail
Name | Schema |
---|---|
data |
Security
rbacSecurity
Type : apiKey
Name : Authorization
In : HEADER
NetBackup Configuration API
Overview
The NetBackup Configuration API provides access to NetBackup configuration.
Version information
Version : 1.0
URI scheme
Host : <masterserver>:1556
BasePath : /netbackup
Schemes : HTTPS
Paths
POST /config/hosts
Description
Creates a host entry in database.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
X-NetBackup-Audit-Reason |
The audit reason for creating the host. |
string |
Body |
Host Data |
The properties of the host to be added in the database. |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Successfully created a host database entry. |
No Content |
400 |
Bad or invalid request. |
|
401 |
The |
|
409 |
The server already exists in the database. |
|
415 |
Unsupported Media Type. The media type specified in the |
Consumes
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
GET /config/hosts
Description
Gets all hosts information.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully fetched all hosts information. |
|
401 |
The |
|
406 |
Invalid |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
GET /config/hosts/hostmappings
Description
Fetches a list of hosts and the details of their host ID-to-host 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 specified conditions are true.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
isaddedmanually |
Fetches a list of hosts and the details of their host ID-to-hostname mappings based on the value of the isaddedmanually parameter. |
boolean |
Query |
isapproved |
Fetches a list of hosts and the details of their host ID-to-host name mappings based on the value of the isapproved parameter. |
boolean |
Query |
isconflict |
Fetches a list of hosts and the details of their host ID-to-hostname mappings based on the value of the isconflict parameter. |
boolean |
Query |
isshared |
Fetches a list of hosts and the details of their host ID-to-hostname mappings based on the value of the isshared parameter. |
boolean |
Query |
mappedHostName |
Fetches a list of hosts and the details of their host ID-to-host name mappings based on the value of the mappedhostname parameter. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully fetched host information. |
|
401 |
The |
|
406 |
Invalid |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
GET /config/hosts/{hostId}
Description
Gets information for the specified host ID.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
hostId |
The host ID of the host. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully retrieved host information. |
|
401 |
The |
|
404 |
No host exists with host ID. |
|
406 |
Invalid |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
PATCH /config/hosts/{hostId}
Description
Updates information for a host with the specified host ID. Only the NetBackup administrator can update the 'autoReissue' parameter. To update all other parameters, you must have certificate authentication.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
X-NetBackup-Audit-Reason |
The audit reason for updating the host properties. |
string |
Path |
hostId |
Host ID of the host. |
string |
Body |
Host Properties |
Properties of the host to be updated. |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Host information is successfully updated. |
No Content |
400 |
Bad or Invalid Request. |
|
401 |
The |
|
404 |
No host associated with the specified host ID. |
|
409 |
The host already exists. |
|
415 |
Unsupported Media Type. The media type specified in the |
|
500 |
An unexpected system error occurred. |
Consumes
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
PUT /config/hosts/{hostId}/comment
Description
Updates comment for the host that is associated with the specified host ID.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
hostId |
The host ID of the host. |
string |
Body |
HostCommentDetails |
Host-specific comment to be updated. |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully updated the host information. |
No Content |
400 |
Bad or invalid request. |
|
401 |
The |
|
404 |
No host associated with the specified host ID exists. |
|
415 |
Unsupported Media Type. The media type specified in the |
Consumes
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
GET /config/hosts/{hostId}/hostmappings
Description
Fetches the details of the host ID-to-host name mappings that are associated with the specified host ID.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
hostId |
Specifies the host ID for which you want to add mappings. |
string |
Query |
isapproved |
Provides a list of approved or pending mappings of the host ID based on the specified parameter value. |
boolean |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully retrieved host information. |
|
401 |
The |
|
404 |
No host exists with specified host ID. |
|
406 |
Invalid |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
PUT /config/hosts/{hostId}/hostmappings/{mappedHostName}
Description
Adds mappings for the specified host ID.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
X-NetBackup-Audit-Reason |
Specifies the audit reason for adding the host ID-to-host name mapping. |
string |
Path |
hostId |
Specifies the host ID for which you want to add mappings. |
string |
Path |
mappedHostName |
Host ID-to-host name mapping to be added. |
string |
Body |
HostMappingDetails |
The properties of the host to be mapped. |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully updated the host mapping properties for the specified host ID. |
No Content |
201 |
Successfully added the host mapping to the specified host ID. |
No Content |
400 |
Invalid parameter with request payload. |
|
401 |
The |
|
409 |
A conflict in the host ID-to-host name mapping was detected. |
|
415 |
Unsupported Media Type. The media type specified in the |
Consumes
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
DELETE /config/hosts/{hostId}/hostmappings/{mappedHostName}
Description
Deletes host mappings that are associated with the specified host ID.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
X-NetBackup-Audit-Reason |
Specifies the reason for deleting the host ID-to-host name mapping. |
string |
Path |
hostId |
Specifies the host ID that is associated with the mapping that you want to delete. |
string |
Path |
mappedHostName |
Specifies the host ID-to-host name mapping that you want to delete. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Successfully deleted the host mapping for the specified host ID. |
No Content |
401 |
The |
|
404 |
The specified host mapping was not found. |
|
406 |
Invalid |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
PUT /config/hosts/{hostId}/reset
Description
Resets information for a host with host ID specified.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
X-NetBackup-Audit-Reason |
The audit reason for resetting the host. |
string |
Path |
hostId |
The host ID of the host. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully reset the host entry. |
No Content |
401 |
The |
|
404 |
No host exists with the specified host ID. |
|
406 |
Invalid |
|
500 |
An unexpected system error occurred. |
Security
Type | Name |
---|---|
apiKey |
GET /config/hosts?name={hostName}
Description
Gets information for a host with name specified.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
hostName |
The name of the host. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully retrieved host information. |
|
401 |
The |
|
404 |
No host exists with the specified host name. |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
GET /config/policies/
Description
Lists all of the NetBackup policies.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully retrieved the list of policies. |
|
401 |
The |
|
406 |
Invalid |
|
500 |
Unexpected system error. |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
GET /config/policies/{policyName}
Description
Get the details for a specified Oracle policy.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
policyName |
The name of the policy. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully retrieved the policy details. |
|
401 |
The |
|
404 |
The specified policy was not found. |
|
406 |
Invalid |
|
500 |
Unexpected system error. |
|
501 |
Not implemented for policies other than Oracle policies. |
Produces
-
application/vnd.netbackup+json;version=1.0
Tags
-
Public
Security
Type | Name |
---|---|
apiKey |
PUT /config/policies/{policyName}/backupselections
Description
Replaces the existing backup selections with the specified list of backup selections.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
If-Match |
The generation ID of the policy. |
string |
Header |
X-NetBackup-Audit-Reason |
The audit reason for changing the policy. |
string |
Path |
policyName |
The name of the policy. |
string |
Body |
backupSelections |
The list of paths for the policy backup. |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Successfully updated the backup selections. |
No Content |
400 |
Failed to parse the JSON body. |
|
401 |
The |
|
404 |
The specified policy was not found. |
|
412 |
A conditional update failed because of mismatched generation IDs. |
|
415 |
Unsupported Media Type. The media type specified in the |
|
500 |
Unexpected system error. |
Consumes
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
DELETE /config/policies/{policyName}/backupselections
Description
Removes the existing backup selections for the specified policy.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
If-Match |
The generation ID of the policy. |
string |
Header |
X-NetBackup-Audit-Reason |
The audit reason for changing the policy. |
string |
Path |
policyName |
The name of the policy. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Successfully removed the backup selection. |
No Content |
401 |
The |
|
404 |
The specified policy was not found. |
|
406 |
Invalid |
|
412 |
A conditional update failed because of mismatched generation IDs. |
|
500 |
Unexpected system error. |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
PUT /config/policies/{policyName}/clients/{clientName}
Description
Adds or modifies a client for the specified policy. It can also modify an instance group, instance, or database for the specified policy.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
If-Match |
The generation ID of the policy. |
string |
Header |
X-NetBackup-Audit-Reason |
The audit reason for changing the policy. |
string |
Path |
clientName |
The host name of the client. |
string |
Path |
policyName |
The name of the policy. |
string |
Body |
client |
The client to be backed up. |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Successfully added a client, instance group, instance, or database for the specified policy. |
No Content |
204 |
Successfully updated the specified client in the policy. |
No Content |
400 |
Failed to parse the JSON body. |
|
401 |
The |
|
404 |
The specified policy was not found. |
|
412 |
A conditional update failed because of mismatched generation IDs. |
|
415 |
Unsupported Media Type. The media type specified in the |
|
500 |
Unexpected system error. |
Consumes
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
DELETE /config/policies/{policyName}/clients/{clientName}
Description
Removes the existing client for the specified policy.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
If-Match |
The generation ID of the policy. |
string |
Header |
X-NetBackup-Audit-Reason |
The audit reason for changing the policy. |
string |
Path |
clientName |
The host name of the client. |
string |
Path |
policyName |
The name of the policy. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Successfully removed the client. |
No Content |
401 |
The |
|
404 |
The specified policy or client was not found. |
|
406 |
Invalid |
|
412 |
A conditional update failed because of mismatched generation IDs. |
|
500 |
Unexpected system error. |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
PUT /config/policies/{policyName}/schedules/{scheduleName}
Description
Adds or updates a schedule in the specified policy.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
If-Match |
The generation ID of the policy. |
string |
Header |
X-NetBackup-Audit-Reason |
The audit reason for changing the policy. |
string |
Path |
policyName |
The name of the policy. |
string |
Path |
scheduleName |
The name of the schedule. |
string |
Body |
schedule |
The policy schedule to add or update. |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Successfully created the schedule. |
No Content |
204 |
Successfully updated the schedule. |
No Content |
400 |
Failed to parse the JSON body. |
|
401 |
The |
|
404 |
The specified policy was not found. |
|
412 |
A conditional update failed because of mismatched generation IDs. |
|
415 |
Unsupported Media Type. The media type specified in the |
|
500 |
Unexpected system error. |
Consumes
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
DELETE /config/policies/{policyName}/schedules/{scheduleName}
Description
Removes a schedule from the specified policy.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
If-Match |
The generation ID of the policy. |
string |
Header |
X-NetBackup-Audit-Reason |
The audit reason for changing the policy. |
string |
Path |
policyName |
The name of the policy. |
string |
Path |
scheduleName |
The name of the schedule. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Successfully deleted the schedule. |
No Content |
401 |
The |
|
404 |
The specified policy or schedule was not found. |
|
406 |
Invalid |
|
412 |
A conditional update failed because of mismatched generation IDs. |
|
500 |
Unexpected system error. |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
POST /config/servers/vmservers
Description
Creates VM server credentials.
Parameters
Type | Name | Schema |
---|---|---|
Body |
vmserver |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Successfully added the VM server credentials. |
No Content |
400 |
Failed to parse the JSON body, or the entity already exists. |
|
401 |
The |
|
415 |
Unsupported Media Type. The media type specified in the |
Consumes
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
GET /config/servers/vmservers/{serverName}
Description
Lists the VM server credentials.
Parameters
Type | Name | Schema |
---|---|---|
Path |
serverName |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
VM server credentials found. |
|
401 |
The |
|
404 |
No VM server credentials found. |
|
406 |
Invalid |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
GET /config/servers/wssendpoints
Description
Lists all the hosts that serve as NetBackup WebSocket servers.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List of available hosts. |
|
401 |
The |
|
406 |
Invalid |
|
503 |
Service unavailable. |
Produces
-
application/vnd.netbackup+json;version=1.0
POST /config/servers/wssendpoints/save
Description
Adds the host to the list of NetBackup WebSocket Servers. Note: VALIDATEHOST or VALIDATEURL API needs to be called before the SAVE endpoint is called.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Host configuration |
The details for the host. |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
The host was added successfully to the list of NetBackup WebSocket Servers. |
|
400 |
Bad request. |
|
401 |
The |
|
415 |
Unsupported Media Type. The media type specified in the |
|
500 |
The certificate did not match with the one accepted by the user. |
|
503 |
Service unavailable. |
Consumes
-
application/vnd.netbackup+json;version=1.0
POST /config/servers/wssendpoints/update
Description
Updates the state of the specified host in the WebSocket Servers list. Note: SAVE API needs to be called before the update API is called.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Host configuration |
The hostname and state to update. |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Host details saved successfully. |
|
400 |
Bad request. |
|
401 |
The |
|
415 |
Unsupported Media Type. The media type specified in the |
|
500 |
An unexpected system error occurred. |
|
503 |
Communication with the Enterprise Media Manager failed. |
Consumes
-
application/vnd.netbackup+json;version=1.0
POST /config/servers/wssendpoints/validatehost
Description
Checks if the host is valid using the information provided in the JSON file.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Host configuration |
The details for the host. |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Host validation successful. |
|
400 |
Bad request. |
|
401 |
The |
|
406 |
Invalid |
|
415 |
Unsupported Media Type. The media type specified in the |
|
500 |
Unable to establish a connection to the specified URL. |
Consumes
-
application/vnd.netbackup+json;version=1.0
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
POST /config/servers/wssendpoints/validateurl
Description
Checks if the host is valid using the URL provided.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
URL |
The NetBackup WebSocket Service (WSS) endpoint URL. |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Host validation successful. |
|
400 |
Bad request. |
|
401 |
The |
|
406 |
Invalid |
|
415 |
Unsupported Media Type. The media type specified in the |
|
500 |
An unexpected system error occurred. |
|
503 |
Communication with the Enterprise Media Manager server failed. |
Consumes
-
application/vnd.netbackup+json;version=1.0
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
DELETE /config/servers/wssendpoints/{hostName}
Description
Deletes the specified host name from the NetBackup WebSocket servers list.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
hostName |
The host name of the host to delete. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The host name was deleted successfully. |
|
401 |
The |
|
404 |
The host name could not be found. |
|
415 |
Unsupported Media Type. The media type specified in the |
|
503 |
Service unavailable. |
Consumes
-
application/vnd.netbackup+json;version=1.0
Definitions
emptyResponse
Type : object
errorResponse
Name | Description | Schema |
---|---|---|
errorCode |
The NetBackup error code. |
integer (int64) |
errorMessage |
The NetBackup error code description. |
string |
hostGenericSchema
Name | Description | Schema |
---|---|---|
certificate |
The signing certificate that is provided by the master server to establish a secure connection. |
string |
connectionState |
Indicates whether or not the host is connected. Possible values are null, connected, and disconnected. |
enum (CONNECTED, DISCONNECTED) |
groupId |
The group identifier of the host. |
string |
hostName |
The host name for the communicating host. |
string |
priority |
Specifies the order in which to attempt to connect to the host. NetBackup attempts to connect to the host that has the highest priority. |
integer |
state |
Indicates the state of the host. Possible values are null, activated, and deactivated. |
enum (ACTIVATED, DEACTIVATED) |
token |
The authentication token that is required to make API calls. |
string |
url |
The NetBackup WebSocket Service (WSS) endpoint URL. |
string |
hostGenericSchemaArray
Type : < hostGenericSchema > array
hostMappingsDetails
Name | Description | Schema |
---|---|---|
hostMappings |
The list of host mappings associated with the specified host. |
< mappingDetails > array |
timeToLiveInMin |
The time duration (in minutes) for which the response provided by the URI is valid. |
integer |
hostResponse
Name | Description | Schema |
---|---|---|
autoReissue |
Specifies whether the host requires a reissue token to reissue a certificate or not. |
boolean |
autoReissueDuration |
The time duration (in milliseconds) for which the certificate can be deployed on the host without requiring a reissue token. |
number |
comment |
Comment provided for the host. |
string |
cpuArchitecture |
The CPU architecture of the host. |
string |
createdDateTime |
The time that the host entry was made, in UTC. |
integer |
hostMappings |
The list of host mappings that are associated with the host. |
< mappingDetails > array |
hostName |
The name of the host. |
string |
hwDescription |
The hardware description of the host. |
string |
installedEEBs |
The NetBackup EEBs that are installed on the host. |
string |
isSecureEnabled |
Specifies whether the host can communicate securely or not. |
boolean |
lastUpdatedDateTime |
The time when the host entry was last updated, in UTC. |
integer |
masterServer |
The NetBackup master server that is associated with the host. |
string |
nbuVersion |
The NetBackup version on the host. |
string |
osType |
The operating system type of the host. |
string |
osVersion |
The operating system of the host. |
string |
servers |
A list of servers associated with the host. |
< string > array |
uuid |
The unique ID of the host. |
string |
hostStatus
Name | Description | Schema |
---|---|---|
connectionDecision |
Specifies whether the connection between the hosts should proceed or should be dropped. The master server sends either of the following connection decisions: CONTINUE, DROP Communication between the hosts is proceeded or dropped depending on the connection decision. |
enum (CONTINUE, DROP) |
errorCode |
The NetBackup error code. |
integer |
errorMessage |
NetBackup error code string that describes the error code. |
string |
hostId |
The host ID of the peer host. |
string |
timeToLiveInMin |
The time duration (in minutes) for which the response provided by the URI is valid. |
integer |
hostsResponse
Name | Schema |
---|---|
hosts |
< hostResponse > array |
listPoliciesResponse
Name | Schema |
---|---|
data |
< data > array |
data
Name | Description | Schema |
---|---|---|
attributes |
object |
|
id |
The name of the policy. |
string |
links |
A list of URIs to get more information about each policy. |
|
type |
The type of the policy. |
string |
links
Name | Schema |
---|---|
self |
self
Name | Description | Schema |
---|---|---|
href |
A link to the policy details. |
string |
mappingDetails
Name | Description | Schema |
---|---|---|
createdOn |
The time the host ID-to-host name mapping was created, in UTC. |
integer (int64) |
isAddedManually |
Specifies whether the mapping was added manually or not. |
boolean |
isApproved |
Specifies whether the new mapping is approved or not. |
boolean |
isConflicting |
Specifies whether mapping already exists for another host ID. |
boolean |
isShared |
Specifies whether the mapping is shared across hosts. |
boolean |
mappedHostName |
The name of the mapped host that is associated with the mapping details. |
string |
origin |
Specifies how the host ID-to-host name mapping was added. |
enum (CERTIFICATE_DEPLOYMENT, USER_ADDED, HOST_DISCOVERY, COMMUNICATION_DISCOVERY, ADD_HOST) |
updatedOn |
Specifies the time when the host ID-to-host name mapping was last updated. |
integer (int64) |
patchHostProperties
Name | Description | Schema |
---|---|---|
autoReissue |
Specifies whether or not an automatic reissue of the certificate is allowed. If this parameter is set and is valid, a certificate can be deployed on the host without requiring a reissue token. |
boolean |
clusterSharedNames |
A list of cluster shared names that are associated with the host. This is an optional field. Host Mappings only get ADDED if "clusterSharedNames" is specified. Administrator approval is required for the new cluster shared name. |
< string > array |
cpuArchitecture |
The CPU architecture of the host. |
string |
hostName |
The name of the host. |
string |
hwDescription |
The hardware description of the host. |
string |
installedEEBs |
The NetBackup EEBs installed on the host. |
string |
isSecureEnabled |
Specifies whether or not the host can communicate securely. |
boolean |
masterServer |
The NetBackup master server that is associated with the host. |
string |
nbuVersion |
The NetBackup version on the host. |
string |
osType |
The operating system type of the host. |
string |
osVersion |
The operating system of the host. |
string |
servers |
A list of servers associated with the host. |
< string > array |
peerHostInfo
Name | Description | Schema |
---|---|---|
hostId |
The host ID of the discovered peer host. |
string |
hostName |
The name of the peer host that is used for the connection. |
string |
policy
Name | Description | Schema |
---|---|---|
backupSelections |
The pathnames and directives reflecting data to be backed up for the Oracle elements covered by this policy. |
|
clients |
The list of client information. |
< clients > array |
policyAttributes |
The attributes of the policy. |
|
policyName |
The name of the policy. |
string |
policyType |
The type of the policy. |
string |
schedules |
The list of schedules information. |
< schedules > array |
backupSelections
Name | Schema |
---|---|
selections |
< string > array |
clients
Name | Description | Schema |
---|---|---|
OS |
The host’s operating system. |
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, Solaris_x86_10_64, Windows, Windows10, Windows2003, Windows2008, Windows2012, Windows2012_R2, Windows2016, Windows7, Windows8, Windows8.1, WindowsVista, WindowsXP) |
databaseName |
The name of the database to be used with Protect Instances and Databases. |
string |
hardware |
The host’s hardware. |
enum (HP-UX-IA64, Linux, Linux-s390x, NDMP, Novell, OpenVMS4, RS6000, Solaris, Windows-x64, Windows-x86) |
hostName |
The name of the host to be backed up. |
string |
instanceGroup |
The name of the instance group to be backed up. |
string |
instanceName |
The name of the instance to be used with Protect Instances and Databases. |
string |
policyAttributes
Name | Description | Schema |
---|---|---|
active |
Indicates if the policy is active or disabled. |
boolean |
alternateClientHostname |
If performing off-host backups with an alternate client, the name of the alternate client (or a supported directive, such as MEDIA_SERVER). |
string |
archivedRedoLogOptions |
A collection of optional specifications related to archived redo logs. Not used with the 'Clients for use with scripts or templates' client selection type. |
|
backupFileNameFormatOverrides |
Optional overrides to the default formats for the various backup file names. Ensure that the format specified for all RMAN backup piece names ends with _%t to guarantee that each backup piece has a unique name in the catalog. |
|
backupSelectionType |
The backup seletion type within Oracle that the selections belong to. |
enum (Whole Database, Whole Database - Datafile Copy Share, Partial database - Tablespace, Partial database - Datafiles, Fast Recovery Area (FRA), Legacy Client with scripts or templates, Database Backup Shares) |
backupSetIdentifier |
A user-specified tag name for a backup set, proxy copy, data file copy, or control file copy. This value maps to the Oracle property TAG. Not used with the 'Clients for use with scripts or templates' client selection type. |
string |
blockIncremental |
Indicates whether the policy performs block level incremental backups. |
boolean |
clientCompress |
Indicates if the backup is compressed. |
boolean |
clientEncrypt |
Indicates if the backup is encrypted. |
boolean |
clientType |
The type of Oracle elements targeted for backup under this policy. |
enum (Protect Instances and Databases, Protect Instance Groups, Clients) |
dataClassification |
An optional classification tag. NetBackup comes with Bronze, Silver, Gold, and Platinum tags defined, but these values can be customized. |
string |
dataMoverMachine |
For off-host backups using Data Mover, this reflects the Data Mover type. |
enum (None (not using off-host backups with Data Mover), Third Party Copy Device, NetBackup Media Server, Network Attached Storage, NDMP) |
databaseBackupShareOptions |
For the 'Database Backup Shares' backup selection scope type, a collection of optional specifications for the point when backup sets and backup copies are automatically deleted from the appliance share. |
|
datafileCopyTag |
For the 'Whole Database - Datafile Copy Share' backup selection scope type, a user-specified tag name associated with data files that are located on the appliance. |
string |
disableClientSideDeduplication |
Indicates if client side deduplication is disabled. |
boolean |
effectiveDateUTC |
The date and time the policy goes into effect, in UTC format. |
integer |
followNFSMounts |
Indicates whether NetBackup will back up or archive any Network File System (NFS) mounts that are named in the backup selection list, or by the user in the case of a user backup or archive. |
boolean |
jobLimit |
The maximum number of jobs originating from this policy that can be running concurrently at any given time. If 0, no maximum is enforced. |
integer |
keyword |
An optional keyword phrase. |
string |
maximumLimits |
A collection of optional I/O and backup set limits. A value of 0 indicates that the limit is not enabled. Not used with the 'Clients for use with scripts or templates' client selection type. |
|
mediaOwner |
The media server or group that owns the media. |
string |
offhostBackup |
Indicates if the backup is an off-host backup. |
boolean |
offlineDatabaseBackup |
If enabled, the Oracle database is shut down and put into the mount state. Not used with the 'Clients for use with scripts or templates' client selection type. |
boolean |
parallelStreams |
The number of parallel backup streams that can be used in a backup operation. Not used with the 'Clients for use with scripts or templates' client selection type. |
integer |
priority |
The priority of jobs associated with this policy. The higher the number, the higher the priority (relative to other NetBackup jobs). |
integer |
readOnlyTablespaceOptions |
If specified, overrides the default Oracle read-only tablespace options. Not used with the 'Clients for use with scripts or templates' client selection type. |
enum (Skip, Force) |
retainSnapshot |
Indicates the snapshot is retained for instant recovery or for storage lifecycle policy (SLP) management. This parameter only applies to snapshot backups. |
boolean |
skipOfflineDatafiles |
If enabled, offline data files are skipped during the backup. This parameter is not used with the |
boolean |
snapshotBackup |
Indicates whether this is a snapshot backup (frozen image). |
boolean |
storage |
The name of the storage unit that is associated with the policy. |
string |
storageIsSLP |
Indicates if the storage unit is a storage lifecycle policy (SLP). |
boolean |
useAccelerator |
Flag reflecting if NetBackup Accelerator is used. |
boolean |
useReplicationDirector |
Indicates if Replication Director is used to manage hardware snapshots. |
boolean |
volumePool |
The volume pool that is associated with the policy. |
enum (NetBackup, DataStore) |
archivedRedoLogOptions
Name | Description | Schema |
---|---|---|
backupSetSize |
In kilobytes (KB), the maximum size for a backup set of archived redo logs. A value of 0 indicates that the limit is not enabled. |
integer |
deleteAfterMakingCopies |
If non-zero, archived redo logs are deleted after the specified number of copies are successful. |
integer |
filesPerBackupSet |
The maximum number of archived redo log files to include in each output backup set. A value of 0 indicates that the limit is not enabled. |
integer |
include |
If enabled, archived redo logs are included in full and incremental schedules. |
boolean |
parallelStreams |
The maximum number of connections between RMAN and a database instance. |
integer |
backupFileNameFormatOverrides
Name | Description | Schema |
---|---|---|
archivedRedoLogs |
Default : |
string |
controlFile |
Default : |
string |
datafiles |
Default : |
string |
fastRecoveryArea |
Default : |
string |
Name | Description | Schema |
---|---|---|
deleteProtectedBackupCopiesMinutes |
The number of minutes to pass before protected backup copies are automatically. deleted. |
integer |
deleteProtectedBackupSetsMinutes |
The number of minutes to pass before protected backup sets are automatically deleted. |
integer |
maximumLimits
Name | Description | Schema |
---|---|---|
backupPiece |
In kilobytes (KB), the maximum size of each backup piece that is created on this channel. Maps to the Oracle MAXPIECESIZE property. |
integer |
backupSetSize |
In kilobytes (KB), the maximum size for a backup set. Maps to the Oracle MAXSETSIZE property. |
integer |
filesPerBackupSet |
The maximum number of input files to include in each output backup set. Maps to the Oracle FILESPERSET property. |
integer |
openFiles |
The maximum number of input files that the backup operation can have open at any given time. Maps to the Oracle MAXOPENFILES property. |
integer |
readRate |
The maximum number of kilobytes (KB) that RMAN reads each second on this channel. Maps to the Oracle RATE property. |
integer |
schedules
Name | Description | Schema |
---|---|---|
acceleratorForcedRescan |
Indicates if file checksums are stored to aid in change detection. This parameter applies only to to NetBackup Accelerator backups. |
boolean |
backupCopies |
The copy details for the policy. Entry 1 reflects the primary schedule copy, which is always enabled. Entries 2-4 reflect (optional) additional copies. |
|
backupType |
The backup type of the schedule. |
enum (Application Backup, Archived Redo Log Backup, Cumulative Incremental Backup, Differential Incremental Backup, Full Backup) |
excludeDates |
Recurring days of the week, recurring days of the month, and exact dates on which this policy does not run. This parameter only applies to calendar-based schedules |
|
frequencySeconds |
For frequency schedule types, the frequency at which to perform the backup, in seconds. |
integer |
includeDates |
Recurring days of the week, recurring days of the month, and exact dates on which this policy does run. This parameter only applies to calendar-based schedules |
|
mediaMultiplexing |
The maximum number of jobs from the schedule that NetBackup can multiplex onto any one drive. Valid values are 1 (no multiplexing) to 32. |
integer |
retentionLevel |
The retention level that is associated with the schedule. Possible values are 0 - 100. |
integer |
retriesAllowedAfterRunDay |
Indicates if backups can retry on any day there is an open backup window. This parameter only applies to calendar-based schedules. |
boolean |
scheduleName |
The name of the schedule. |
string |
scheduleType |
The type of the schedule. |
enum (Calendar, Frequency) |
snapshotOnly |
Indicates if NetBackup should create only an Instant Recovery snapshot (leaving the storage unit unused). If disabled, NetBackup both creates a snapshot and copies the snapshot to a storage unit. |
boolean |
startWindow |
The window during which the backup is allowed to start. Each day of the week is defined independently. Entry 1 is Sunday, entry 2 is Monday, and so on. |
< startWindow > array |
storageIsSLP |
Indicates if the storage unit is a storage lifecycle policy (SLP). |
boolean |
syntheticBackup |
Specifies if a synthetic backup is performed. |
boolean |
backupCopies
Name | Description | Schema |
---|---|---|
copies |
The list of copy information. |
< copies > array |
priority |
The priority of jobs that are associated with any additional copies that are specified. The higher the number, the higher the priority (relative to other NetBackup jobs). Note this has no impact on the primary copy. |
integer |
copies
Name | Description | Schema |
---|---|---|
failStrategy |
The approach taken if a particular image fails to copy. |
integer |
mediaOwner |
The media server or group that owns this copy. |
string |
retentionLevel |
The retention level for the copy. |
integer |
storage |
The name of the storage unit that is associated with the copy. |
string |
volumePool |
The name of the volume pool that is associated with the copy. |
string |
excludeDates
Name | Description | Schema |
---|---|---|
lastDayOfMonth |
Indicates if the last day of the month is excluded. |
boolean |
recurringDaysOfMonth |
Recurring days of the month. |
< integer > array |
recurringDaysOfWeek |
Recurring days of a week. |
< string > array |
specificDates |
A list of specific dates. |
< string > array |
includeDates
Name | Description | Schema |
---|---|---|
lastDayOfMonth |
Indicates if the last day of the month is included. |
boolean |
recurringDaysOfMonth |
Recurring days of the month. |
< integer > array |
recurringDaysOfWeek |
Recurring days of a week. |
< string > array |
specificDates |
A list of specific dates. |
< string > array |
startWindow
Name | Description | Schema |
---|---|---|
dayOfWeek |
The day of the week the backup window starts. Possible values for DAY are 1 (Sunday) through 7 (Saturday). |
integer |
durationSeconds |
The duration of the backup window expressed in seconds. |
integer |
startSeconds |
The start time of the backup window, expressed in seconds elapsed since the beginning of the day. |
integer |
policyOracleResponse
Name | Schema |
---|---|
data |
data
Name | Description | Schema |
---|---|---|
attributes |
The attributes of the policy. |
|
id |
The policy name. |
string |
links |
The links to the URLs for the details on each policy. |
|
type |
string |
attributes
Name | Schema |
---|---|
policy |
links
Name | Schema |
---|---|
self |
self
Name | Description | Schema |
---|---|---|
href |
The URI to get details for the policy. |
string |
postCreateHostRequest
Name | Description | Schema |
---|---|---|
cpuArchitecture |
The CPU architecture of the host. |
string |
hostMappings |
The list of host mappings that are associated with the host. |
< hostMappings > array |
hostName |
The name of the host. |
string |
hwDescription |
The hardware description of the host. |
string |
installedEEBs |
The NetBackup EEBs installed on the host. |
string |
isSecureEnabled |
Specifies whether the host can communicate securely or not. |
boolean |
masterServer |
The NetBackup master server that is associated with the host. |
string |
nbuVersion |
The NetBackup version on the host. |
string |
osType |
The operating system type of the host. |
string |
osVersion |
The operating system of the host. |
string |
servers |
The list of servers associated with the host. |
< string > array |
hostMappings
Name | Description | Schema |
---|---|---|
mappedHostName |
The name of the mapped host for which the details are provided. |
string |
postRecreateHostRequest
Name | Description | Schema |
---|---|---|
cpuArchitecture |
The CPU architecture of the host. |
string |
hostMappings |
The list of host mappings that are associated with the host. |
< hostMappings > array |
hostName |
The name of the host. |
string |
hwDescription |
The hardware description of the host. |
string |
installedEEBs |
The NetBackup EEBs installed on the host. |
string |
isSecureEnabled |
Specifies whether the host can communicate securely or not. |
boolean |
masterServer |
The NetBackup master server that is associated with the host. |
string |
nbuVersion |
The NetBackup version on the host. |
string |
osType |
The operating system type of the host. |
string |
osVersion |
The operating system of the host. |
string |
servers |
The list of servers associated with the host. |
< string > array |
uuid |
The UUID of the host. |
string |
hostMappings
Name | Description | Schema |
---|---|---|
mappedHostName |
The name of the mapped host for which the details are provided. |
string |
putAddHostMapping
Name | Description | Schema |
---|---|---|
isApproved |
Specifies whether or not the mapping is approved. This field is optional. |
boolean |
isShared |
Specifies whether the mapping is shared between two or more host IDs. |
boolean |
putClientRequest
By default, the clientType
for a policy is Clients
. For Intelligent Policies, select either Protect Instances and Databases
or Protect Instance Groups
.
Name | Description | Schema |
---|---|---|
data |
The data about the client. |
data
Name | Description | Schema |
---|---|---|
attributes |
The attributes for the host, instance, or instance database. These attributes do not apply for instance groups. |
|
id |
For hosts or instance databases, this value is the host name. For instance groups, this value is the instance group. |
string |
type |
The resource type. Must be set to |
string |
attributes
Name | Description | Schema |
---|---|---|
OS |
The host’s operating system. |
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, Solaris_x86_10_64, Windows, Windows10, Windows2003, Windows2008, Windows2012, Windows2012_R2, Windows2016, Windows7, Windows8, Windows8.1, WindowsVista, WindowsXP) |
databaseName |
The name of the database. This property only applies for the |
string |
hardware |
The host’s hardware. |
enum (HP-UX-IA64, Linux, Linux-s390x, NDMP, Novell, OpenVMS4, RS6000, Solaris, Windows-x64, Windows-x86) |
instanceName |
The name of the instance. This property only applies for the clientType value Protect Instances and Databases. |
string |
putHostCommentDetails
Name | Description | Schema |
---|---|---|
comment |
Host-specific comment to be updated. |
string |
putIncludeRequest
Name | Schema |
---|---|
data |
data
Name | Description | Schema |
---|---|---|
attributes |
||
type |
The resource type. Must be set to "backupSelection". |
string |
attributes
Name | Schema |
---|---|
selections |
< string > array |
putScheduleRequest
Name | Schema |
---|---|
data |
data
Name | Description | Schema |
---|---|---|
attributes |
||
id |
The name of the schedule. |
string |
type |
The resource type. Must be set to "schedule". |
string |
attributes
Name | Description | Schema |
---|---|---|
acceleratorForcedRescan |
Indicates if file checksums are stored to aid in change detection. Applicable only to NetBackup Accelerator backups. |
boolean |
backupCopies |
The copy details for the policy. Entry 1 reflects the primary schedule copy, which is always enabled. Entries 2-4 reflect (optional) additional copies. The use of multiple copies is inferred from number of copies specified (Valid values 1-not used 2-4-used) (default in policy file is 0). |
|
backupType |
The backup type of the schedule. |
enum (Archived Redo Log Backup, Automatic Backup, Automatic Full Backup, Automatic Vault, Automatic Cumulative Incremental Backup, Automatic Differential Incremental Backup, Automatic Incremental Backup, Application Backup, Cumulative Incremental Backup, Differential Incremental Backup, Full Backup, Transaction Log Backup, User Archive, User Backup) |
excludeDates |
Recurring days of the week, recurring days of the month, and exact dates on which this policy will not run. |
|
frequencySeconds |
For frequency schedule types, the frequency at which to perform the backup, in seconds. |
integer |
includeDates |
Recurring days of the week, recurring days of the month, and exact dates on which this policy will run. Applicable only to calendar schedule types. |
|
mediaMultiplexing |
The maximum number of jobs from the schedule that NetBackup can multiplex onto any one drive. Valid values are 1 (no multiplexing) to 32. |
integer |
retentionLevel |
The retention level associated with the schedule. Possible values are 0 - 100. |
integer |
retriesAllowedAfterRunDay |
Indicates if backups can retry on any day there is an open backup window. Applicable only for the calendar schedule type. |
boolean |
scheduleType |
The type of the schedule. |
enum (Calendar, Frequency) |
snapshotOnly |
Indicates if NetBackup should create only an Instant Recovery snapshot (leaving the storage unit unused). If disabled, NetBackup both creates a snapshot and copies the snapshot to a storage unit. |
boolean |
startWindow |
The window during which the backup is allowed to start. Each day of the week is defined independently. Entry 1 is Sunday, entry 2 is Monday, and so on. |
< startWindow > array |
syntheticBackup |
Indicates if NetBackup performs a synthetic backup. |
boolean |
backupCopies
Name | Description | Schema |
---|---|---|
copies |
< copies > array |
|
priority |
The priority of jobs associated with any additional copies specified. The higher the number, the higher the priority (relative to other NetBackup jobs). Note this has no impact on the primary copy. |
integer |
copies
Name | Description | Schema |
---|---|---|
failStrategy |
The approach taken if a particular image fails to copy. |
enum (Continue, Fail All Copies) |
mediaOwner |
The media server or group that owns this copy. |
string |
retentionLevel |
The retention level for the copy. |
integer |
storage |
The name of the storage unit associated with the copy. |
string |
volumePool |
The name of the volume pool associated with the copy. |
string |
excludeDates
Name | Description | Schema |
---|---|---|
lastDayOfMonth |
Indicates if the last day of the month is included. |
boolean |
recurringDaysOfMonth |
Recurring days of the month. |
< integer > array |
recurringDaysOfWeek |
Recurring days of a week. |
< string > array |
specificDates |
A list of specific dates. |
< string > array |
includeDates
Name | Description | Schema |
---|---|---|
lastDayOfMonth |
Indicates if the last day of the month is included. |
boolean |
recurringDaysOfMonth |
Recurring days of the month. |
< integer > array |
recurringDaysOfWeek |
Recurring days of a week. |
< string > array |
specificDates |
A list of specific dates. |
< string > array |
startWindow
Name | Description | Schema |
---|---|---|
dayOfWeek |
The day of the week the backup window starts. Possible values for DAY are 1 (Sunday) through 7 (Saturday). |
integer |
durationSeconds |
The duration of the backup window expressed in seconds. |
integer |
startSeconds |
The start time of the backup window, expressed in seconds elapsed since the beginning of the day. |
integer |
updateHostSchema
Name | Description | Schema |
---|---|---|
hostName |
The identifier for the communicating host. |
string |
state |
Indicates the state of the host. Possible values are activated, deactivated. |
enum (ACTIVATED, DEACTIVATED) |
urlSchema
Name | Description | Schema |
---|---|---|
url |
The URL of the WebSocket endpoint that NetBackup connects to. |
string |
vmserver
Name | Description | Schema |
---|---|---|
password |
The password for the credentials. |
string |
port |
The port used to connect to the server. |
integer |
serverName |
The name of the VM server. |
string |
userId |
The username for the credentials. |
string |
vmType |
The type of VM server. |
enum (VMWARE_VIRTUAL_CENTER_SERVER, VMWARE_ESX_SERVER, VMWARE_RESTORE_ESX_SERVER, VMWARE_VCLOUD_DIRECTOR, HYPERV_SERVER, SYSTEM_CENTER_VMM_SERVER, HYPERV_CLUSTER_SERVER, HYPERSCALE_SERVER) |
vmserverResponse
Name | Description | Schema |
---|---|---|
links |
A link to the newly created resource. |
< links > array |
vmServer |
links
Name | Description | Schema |
---|---|---|
href |
The URI to retrieve information about the VM server. |
string (url) |
rel |
The relationship of the link to the specified VM server. This value is always "self". |
string |
Security
rbacCertSecurity
Type : apiKey
Name : Authorization
In : HEADER
rbacUserSecurity
Type : apiKey
Name : Authorization
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
Host : <masterserver>:1556
BasePath : /netbackup
Schemes : HTTPS
Paths
POST /recovery/workloads/vmware/scenarios/full-vm/recover
Description
Recovers a full VMware virtual machine.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
recoveryRequest |
The request for a full VMware VM recovery. |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
The recovery job started successfully. |
|
400 |
Bad request. The request JSON has an invalid syntax or illegal values. |
|
401 |
The |
|
404 |
Not found. The specified client or backup image was not found. |
|
405 |
Method not allowed. The specified HTTP operation is invalid. |
|
406 |
Invalid |
|
415 |
Unsupported Media Type. The media type specified in the |
|
500 |
Internal server error. Failed to start recovery. |
|
503 |
The server is busy. Failed to start recovery. |
Consumes
-
application/vnd.netbackup+json;version=1.0
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
Example HTTP request
Request 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
}
}
}
}
Definitions
errorResponse
Name | Description | Schema |
---|---|---|
errorCode |
The NetBackup error code. |
integer (int64) |
errorMessage |
The NetBackup error code description. |
string |
recoveryResponse
The recovery response.
Name | Description | Schema |
---|---|---|
data |
Contains the recovery response data. |
|
relationships |
Contains the resources related to the recovery operation, such as |
data
Name | Description | Schema |
---|---|---|
attributes |
Contains the recovery response attributes. |
|
id |
The response identifier. |
integer (int64) |
type |
The response type. |
string |
attributes
Name | Description | Schema |
---|---|---|
msg |
The response message. |
string |
relationships
Name | Description | Schema |
---|---|---|
recoveryJob |
Represents the job created by this recovery operation. |
recoveryJob
Name | Description | Schema |
---|---|---|
data |
Contains the recovery job data. |
|
links |
Contains the links to get the job details. |
data
Name | Description | Schema |
---|---|---|
id |
The job identifier. |
integer (int64) |
type |
The resource type. Set to |
string |
links
Name | Description | Schema |
---|---|---|
related |
Gets a list of recent jobs. |
string |
self |
Gets the details about this recovery job. |
string |
vmwareFullVmRecoveryRequest
The recovery request schema for VMware full VM recovery.
Name | Description | Schema |
---|---|---|
data |
Contains the recovery request data. |
data
Name | Description | Schema |
---|---|---|
attributes |
Contains the recovery request attributes. |
|
type |
The resource type. Must be set to |
enum (recoveryRequest) |
attributes
Name | Description | Schema |
---|---|---|
recoveryObject |
Represents the virtual machine being recovered. |
|
recoveryOptions |
Describes the recovery options to be used for this recovery. |
|
recoveryPoint |
Selects the recovery point for this recovery based on the specified options. Required. |
recoveryObject
Name | Description | Schema |
---|---|---|
vmDisks |
Represents one or more virtual machine disks. If not specified, the default is the disk or disks used at the time of backup. |
< vmDisks > array |
vmDisplayName |
The display name of the virtual machine. Must not contain more than 80 characters. If not specified, the default is the one used at the time of backup. |
string |
vmEnvironment |
Describes the VMware environment where this virtual machine is to be recovered. If not specified, the default is the one used at the time of backup. |
vmDisks
Name | Description | Schema |
---|---|---|
destination |
The destination path of the virtual machine disk. |
string |
source |
The source path of the virtual machine disk. |
string |
vmEnvironment
Name | Description | Schema |
---|---|---|
datacenter |
The datacenter path. Must begin with a forward slash '/'. If not specified, the default is the one used at the time of backup. |
string |
esxiServer |
The ESXi server name. If not specified, the default is the one used at the time of backup. |
string |
network |
The VM network name. Multiple VM networks can be specified using comma-separated values. If multiple VM networks are specified, they are attached to the recovered VM in the specified order. The default is the VM network or networks that were used at the time of backup. |
string |
resourcePoolOrVapp |
The resource pool or vApp path. Must begin with a forward slash '/'. If not specified, the default is the one used at the time of backup. |
string |
vCenter |
The vCenter server name. If not specified, the default is the one used at the time of backup. |
string |
vmFolder |
The VM folder path. Must begin with a forward slash '/'. If not specified, the default is the one used at the time of backup. |
string |
vmxDatastore |
The name of the datastore to restore the VMX file to. If not specified, the default is the one used at the time of backup. |
string |
recoveryOptions
Name | Description | Schema |
---|---|---|
defaultVmDiskProvisioning |
The default disk provisioning format that is to be used for all of the virtual disks created during recovery. If not specified, the default is the one used at the time of backup. |
enum (thin, thick-lazy-zeroed, thick-eager-zeroed) |
diskMediaServer |
The media server that is to be used to perform this recovery. If not specified, the default is the one used at the time of backup. |
string |
overwriteExistingVm |
If |
boolean |
powerOnAfterRecovery |
If |
boolean |
recoverToVmxDatastore |
If |
boolean |
recoveryHost |
The server that is to be used as the VM recovery host to perform this recovery. If not specified, the default is the one used at the time of backup. |
string |
removeBackingInformation |
If |
boolean |
removeNetworkInterfaces |
If |
boolean |
removeTagAssociations |
If |
boolean |
retainBiosUuid |
If |
boolean |
retainHardwareVersion |
If |
boolean |
retainInstanceUuid |
If |
boolean |
transportMode |
The transport mode combination that is to be used to perform this recovery. The string must be specified all in lowercase, with colon separated values such as |
string |
recoveryPoint
Name | Description | Schema | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
backupId |
The backup image identifier to be used for this recovery. Required, if |
string |
||||||||
client |
The client identifier that was used at the time of backup. Required, if |
string |
||||||||
filter |
Selects the backup images for recovery based on the specified
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. |
string |
Security
rbacSecurity
Type : apiKey
Name : Authorization
In : HEADER
NetBackup Security API
Overview
The NetBackup Security APIs provide access to the security-related resources of NetBackup. These APIs manage authorization tokens, host ID-based certificates, security configuration options, and auditing.
Version information
Version : 1.0
URI scheme
Host : <masterserver>:1556
BasePath : /netbackup
Schemes : HTTPS
Paths
GET /security/auditlogs
Description
Views the NetBackup audit logs.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
category |
The category ID of the required audit record. 0-GENERAL 1-POLICY 2-AUDITCFG 3-JOB 4-AUDITSVC 5-STU 6-POOL 7-STORAGESRV 8-BPCONF 9-AUDITDB 10-HOLD 11-USER 12-AZFAILURE 13-CATALOG 14-TOKEN 15-CERT 16-LOGIN 17-SEC_CONFIG 18-HOST 19-CONNECTION |
integer |
|
Query |
datalimit |
The number of audit records to be fetched. |
integer |
|
Query |
domain |
The domain name of the user. |
string |
|
Query |
domaintype |
The domain type of the user. |
integer |
|
Query |
endtime |
The end time for the audit records. The audit records are fetched until this time. |
integer (int64) |
|
Query |
locale |
The locale value. |
string |
|
Query |
operation |
The operation ID of the audit record. 0-GENERAL 1-CREATE 2-MODIFY 3-DELETE 4-START 5-STOP 6-CANCEL 7-RESUME 8-ACCESS |
integer |
|
Query |
starttime |
The start time for the audit records. NetBackup starts fetching the audit records at this time. |
integer (int64) |
|
Query |
username |
The name of the user. |
string |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The list of audit records. |
|
401 |
The |
|
404 |
No audit record found. |
|
406 |
Invalid |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
GET /security/cacert
Description
Returns the certificate of the NetBackup web service certificate authority(CA) and the list of certificates of the NetBackup CA in the pem formatted string. Each NetBackup host must establish trust with the NetBackup web service CA before it can make secure calls to NetBackup APIs.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
On successful response, the CA certificate is sent. |
|
406 |
Invalid |
Produces
-
application/vnd.netbackup+json;version=1.0
GET /security/certificates/crl
Description
Returns the latest Certificate Revocation List (CRL) as a DER-encoded file. The file conforms to the standard X.509 CRL format and semantics.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
On successful response, the latest CRL file is sent. |
file |
406 |
Invalid |
|
500 |
There was an internal error with output of the Certificate Revocation List (CRL). Please try again. |
string |
503 |
Not found, the CRL is not generated yet. |
string |
Produces
-
application/pkix-crl
GET /security/certificates/current
Description
Returns the list of details for the latest certificate for each host from the certificate database.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
On successful response, the list of details for the latest certificate for each host is sent. |
|
401 |
The |
|
406 |
Invalid |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
POST /security/certificates/revoke
Description
Revokes the NetBackup host ID-based certificate for the specified host ID.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
hostId |
The unique ID assigned to the NetBackup host. |
string |
Body |
Reason |
The reason for a certification revocation. |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Request successful. |
No Content |
400 |
Bad request. The request contains an invalid parameter, or the certificate has already been revoked. |
|
401 |
The |
|
404 |
The specified host was not found. |
|
415 |
Unsupported Media Type. The media type specified in the |
Consumes
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
GET /security/certificates/{serialNumber}
Description
Returns the certificate details of the certificate with the specified serial number.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
serialNumber |
The serial number of the certificate. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
On successful response, the certificate details are sent. |
|
401 |
The |
|
404 |
The certificate entry does not exist. |
|
406 |
Invalid |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
PUT /security/credentials
Description
Sets the security credentials.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Security credentials |
The security credential that needs to be set. |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The request was successful. |
No Content |
400 |
Bad request. The request contains an invalid parameter. |
|
401 |
The |
|
415 |
Unsupported Media Type. The media type specified in the |
Consumes
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
GET /security/credentials/{credname}/isset
Description
Verifies whether a certain security credential is set or not.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
credname |
The name of the security credential key. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The request was successful. |
|
401 |
The |
|
406 |
Invalid |
|
500 |
There was an error when attempting to query the security credential. |
Security
Type | Name |
---|---|
apiKey |
GET /security/logindetails
Description
Views the logs that are specific to the NetBackup login audit records.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
datalimit |
The number of audit records to be fetched. |
integer |
|
Query |
domaintype |
The domain type of the user. |
integer |
|
Query |
lastlogon |
Set the value to true to view the audit records for the last failed and the last successful login attempts. If the value is set to false, audit records for all login attempts are fetched. |
boolean |
|
Query |
locale |
The locale value. |
string |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The list of audit records. |
|
401 |
The |
|
404 |
No audit record found. |
|
406 |
Invalid |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
GET /security/ping
Description
Tests the connection for the security service from the client. It returns the master server time in milliseconds.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Ping successful - master server time in milliseconds |
|
406 |
Invalid |
Produces
-
text/plain
POST /security/properties
Description
Configures NetBackup security, such as the certificate deployment security level, communication with insecure hosts, and automatic host aliases.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Security configuration properties |
The security configurations that need to be updated. |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Request successful. |
No Content |
400 |
Bad request. The request contains an invalid parameter. |
|
401 |
The |
|
415 |
Unsupported Media Type. The media type specified in the |
Consumes
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
GET /security/properties
Description
Fetches the configuration settings for NetBackup security.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
On successful response, security configurations are sent in the JSON format. |
|
406 |
Invalid |
Produces
-
application/vnd.netbackup+json;version=1.0
GET /security/properties/default
Description
Fetches the default settings specific to NetBackup security.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
On successful response, default security configuration settings are sent in the JSON format. |
|
406 |
Invalid |
Produces
-
application/vnd.netbackup+json;version=1.0
POST /security/securitytokens
Description
Creates an authorization token based on the properties that are sent with the request payload.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Create Token Data |
The properties of the token to be created. |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
On successful response, the token value is sent. |
|
400 |
Bad request. The request contains an invalid parameter. |
|
401 |
The |
|
404 |
In case of reissue-token, the host ID that is specified does not exist. |
|
406 |
Invalid |
|
409 |
The token already exists. |
|
415 |
Unsupported Media Type. The media type specified in the |
Consumes
-
application/vnd.netbackup+json;version=1.0
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
GET /security/securitytokens
Description
Returns the data for all tokens in the form of a list.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
On successful response, a list of tokens is sent. |
|
401 |
The |
|
406 |
Invalid |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
POST /security/securitytokens/delete/invalid
Description
Cleans all invalid authorization tokens.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
Reason |
Specify the reason for deleting the invalid tokens. |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Request successful. |
No Content |
400 |
Bad request. The request contains an invalid parameter. |
|
401 |
The |
Consumes
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
GET /security/securitytokens/state/valid
Description
Returns the data for all valid tokens.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
On successful response, a list of valid tokens is sent. |
|
401 |
The |
|
406 |
Invalid |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
GET /security/securitytokens/{tokenName}
Description
Returns the token data for the specified token.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
tokenName |
The token name. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
On successful response, the token data is sent. |
|
401 |
The |
|
404 |
The token does not exist. |
|
406 |
Invalid |
Produces
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
POST /security/securitytokens/{tokenName}/delete
Description
Deletes an authorization token based on the token name that is specified in the URI.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
tokenName |
The token name. |
string |
Body |
Reason |
Specify the reason for deleting the token. |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Request successful. |
No Content |
400 |
Bad request. The request contains an invalid parameter. |
|
401 |
The |
|
404 |
The token does not exist. |
|
406 |
Invalid |
Consumes
-
application/vnd.netbackup+json;version=1.0
Security
Type | Name |
---|---|
apiKey |
GET /security/serverinfo
Description
Returns NetBackup master server information.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
On successful response, the NetBackup master server information is sent. |
|
406 |
Invalid |
Produces
-
application/vnd.netbackup+json;version=1.0
GET /security/servertime
Description
Returns the master server time in milliseconds in the JSON format.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
On successful response, the master server time in milliseconds is sent in the JSON format. |
|
406 |
Invalid |
Produces
-
application/vnd.netbackup+json;version=1.0
Definitions
aliasAutoAdd
Here are the defined values for the aliasAutoAdd setting. 0 - OFF - The NetBackup administrator’s approval is required to add host aliases. 1 - ON - Aliases can be automatically added without the NetBackup administrator’s approval.
Type : integer
allowInsecureBackLevelHost
Here are the defined values for the allowInsecureBackLevelHost setting: 0 - OFF - The NetBackup host cannot communicate with insecure hosts. 1 - ON - The NetBackup host can communicate with insecure hosts.
Type : integer
auditRecordDetails
Name | Description | Schema |
---|---|---|
auditKeyList |
The list of the audit placeholder values. |
< auditRecordKey > array |
auditRecordAttributeList |
The list of the audit record attributes. |
< auditRecordAttribute > array |
auditTime |
||
auditUserIdentity |
User information. |
object |
categoryId |
The category ID of the fetched audit record. |
integer |
categoryIdDisplayString |
The resolved category value from the categoryId field. |
string |
messageId |
The UMI message ID of the fetched audit record. |
integer |
messageIdDisplayString |
The resolved message value from the messageId UMI. |
string |
operationId |
The operation ID of the fetched audit record. |
integer |
operationIdDisplayString |
The resolved operation value from the operationId field. |
string |
reason |
The reason value of the audit record. |
string |
auditRecordKey
Name | Description | Schema |
---|---|---|
typeId |
The data type of the placeholder. |
integer |
typeIdDisplayString |
The value of the placeholder for the audit description message. |
string |
certificate
An x.509 certificate in a PEM-formatted string.
Type : string
certificateAutoDeployLevel
Here are the defined values for the certificate deployLevel level. 0 - Very High - Automatic certificate deployment is disabled. 1 - High - Certificates are automatically deployed on known hosts. 2 - Medium - Certificates are automatically deployed on all hosts.
Type : integer
certificateState
The certificate state. Here are the defined values for the certificate state. 1 - Active. 2 - Revoked.
Type : integer
certificateTokenType
Indicates the type of token that was used to issue the certificate or the scenario in which the certificate was issued. Here are the defined values for token types. 0 - No token. 1 - Single-use token. 2 - Multi-use token. 3 - Reissue token. Here are the defined values based on these scenarios. 4 - Certificate renewal. 5 - Auto created (catalog recovery).
Type : integer
credIsSetResponse
A flag that specifies 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 certificate applicant to a certificate authority (CA). The CSR validates the information the NetBackup CA requires to issue a certificate.
Type : string
errorResponse
Name | Description | Schema |
---|---|---|
errorCode |
The NetBackup error code. |
integer (int64) |
errorMessage |
The NetBackup error code description. |
string |
getAuditRecordResponse
Name | Description | Schema |
---|---|---|
auditRecordList |
The list of audit record details. |
< auditRecordDetails > array |
isDataTruncated |
Indicates whether the data is truncated or not. |
boolean |
getCACertificateResponse
Name | Description | Schema |
---|---|---|
cacert |
A list of certificates of the NetBackup certificate authority (VxAT) in a pem-formatted string. |
< certificate > array |
webRootCert |
getCertificateListResponse
Name | Description | Schema |
---|---|---|
certificateList |
A list of certificate details. |
< getCertificateResponse > array |
getCertificateResponse
Name | Description | Schema |
---|---|---|
certificateKey |
For internal use. |
integer |
createOn |
||
hostId |
||
hostName |
||
hostType |
||
notAfter |
||
notBefore |
||
publicKey |
The public key of the host for which the certificate is issued. |
string |
revocationReason |
||
serialNumber |
||
state |
||
tokenType |
||
updatedOn |
getSecPropertyResponse
List of security settings.
Name | Schema |
---|---|
aliasAutoAdd |
|
allowInsecureBackLevelHost |
|
certificateAutoDeployLevel |
getServerInfoResponse
Name | Description | Schema |
---|---|---|
masterHostId |
The host ID of the NetBackup master server. |
|
serverName |
The name of the NetBackup master server. |
string |
getServerTimeResponse
Name | Schema |
---|---|
serverTime |
getTokenData
Name | Description | Schema |
---|---|---|
allowedCount |
The maximum usage count of the token. |
integer |
hostId |
||
tokenActivationTime |
||
tokenExpirationTime |
||
tokenKey |
For internal use. |
integer |
tokenName |
The token name to be created. |
string |
tokenState |
The validity of the token. A token is invalid if the usedCount has exceeded the allowedCount, the token is not active yet, or the token has expired. It is valid otherwise. Here are the defined values for token states: 0 - Not Valid. 1 - Valid. |
integer |
tokenType |
||
tokenValue |
||
usedCount |
The used count of the token. |
integer |
getTokenResponse
Name | Description | Schema |
---|---|---|
tokenList |
List of tokens. |
< getTokenData > array |
hostID
The unique ID assigned to the NetBackup host.
Type : string
hostInformation
Name | Description | Schema |
---|---|---|
csr |
||
hostAlias |
A list of host aliases of the specified host. The specified hostName property must be present in this hostAlias array. |
< hostName > array |
hostName |
hostName
The name of the host for which the certificate is issued or is to be issued.
Type : string
hostType
The type of host (server or client). Here are the defined values for the host type: 0 - Unknown. 1 - Server. 2 - Client.
Type : integer
postCertificateResponse
Name | Description | Schema |
---|---|---|
certificate |
||
crl |
The certificate revocation list. |
string (byte) |
hostId |
The host ID of the NetBackup host that has requested a certificate. |
|
masterHostId |
The host ID of the NetBackup master server. |
|
securityLevel |
The level of host checking for certificate registration and the frequency of updates for CRLs. |
integer |
postCreateTokenRequest
Name | Description | Schema |
---|---|---|
allowedCount |
The maximum usage count of the token. The default value is 1. |
integer |
hostId |
||
reason |
The reason for creating the token. |
string |
tokenName |
The token name to be created. |
string |
type |
||
validFor |
The validity of the token in seconds. The default validity is 1 day. |
integer |
postCreateTokenResponse
Name | Description | Schema |
---|---|---|
tokenValue |
The token value. Use for certificate deployment. |
string |
postDeleteTokenRequest
Name | Description | Schema |
---|---|---|
reason |
The reason for deleting the token. |
string |
postRevokeCertificateRequest
Name | Schema |
---|---|
revocationReason |
postSecPropertyRequest
Name | Schema |
---|---|
aliasAutoAdd |
|
allowInsecureBackLevelHost |
|
certificateAutoDeployLevel |
revocationReason
The reason for a certificate revocation. Here are the defined values for the revocation reason. 0 = Unspecified. 1 = Key Compromise. 2 = CA Compromise. 3 = Affiliation Changed. 4 = Superseded. 5 = Cessation Of Operation. 6 = Certificate Hold. 7 = Others.
Type : integer
secCredDef
Name | Description | Schema |
---|---|---|
credName |
The name of the security credential key. |
string |
credValue |
The value associated with the security credential key. |
string |
serialNo
The serial number of the certificate.
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 standard token, reissue token. Depending on the certificate deployment security setting, NetBackup hosts may require an authorization token to obtain a host ID-based certificate from the certificate authority (master server). To request a certificate reissue, the token is mandatory and should be of type reissue.
Type : string
tokenType
The type of the token to be created. Here are the defined values for the token types. 0 - Standard Token. 1 - Reissue Token.
Type : integer
Security
rbacCertSecurity
Type : apiKey
Name : Authorization
In : HEADER
rbacUserSecurity
Type : apiKey
Name : Authorization
In : HEADER