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 ID 5 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=2.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,
            "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,
            "retentionLevel": 0,
            "compression": 0,
            "status": 1,
            "state": "DONE",
            "done": 1,
            "numberOfFiles": 0,
            "estimatedFiles": 0,
            "kilobytesTransferred": 0,
            "kilobytesToTransfer": 0,
            "transferRate": 0,
            "percentComplete": 0,
            "currentFile": "",
            "restartable": 0,
            "suspendable": 0,
            "resumable": 0,
            "killable": 1,
            "frozenImage": 0,
            "transportType": "LAN",
            "dedupRatio": 0,
            "currentOperation": 0,
            "jobQueueReason": 0,
            "jobQueueResource": "",
            "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=2.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 the webRootCert 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 file cacert.pem.

curl -X GET https://masterservername:1556/netbackup/security/cacert \
     -H 'content-type: application/vnd.netbackup+json;version=2.0'   \
     --cacert cacert.pem

Authorization

A given NetBackup API may require that one or more Permissions are assigned to a given principal before the request is allowed to run on the server. In this document, any required permissions for a given resource path are documented in the Description section of the resource as below:

Requires Permission: [Permission value]

When multiple permissions are listed, the enforcement is a logical OR, meaning the principal must have at least one of the expected permissions. Permissions are granted to a principal through the roles that are assigned in their NetBackup RBAC access rules.

Note
 Internally, NetBackup uses API Permissions to authorize individual API requests. A permission is composed of one or more API permissions. The authorization context for an authorized principal is represented in their JWT and contains one or more API Permission values that are derived from assigned permissions. However, API Permissions are not exposed to end users for delegation and configuration.

The following table describes the permissions that are assigned to the system-defined roles that are present at installation.

Workload administrator Backup administrator Security administrator

Recover/Restore

Manage Jobs

Manage Access Rules

Instant Access

Manage Protection Plans

Manage Global Security Settings

Download Files

Manage Assets

Manage Certificates

Restore Files

Manage NetBackup

View Audit Logs

Manage Assets

View Usage Data

Manage Hosts

Manage SLPs

View Application Servers

Manage Policies

View Assets

Manage Application Servers and Asset Groups

View Cloud Application Servers

Manage Cloud Application Servers

View Protection Plans

View Recovery Points

Manage API Keys

View API Keys

View Domains

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=2.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

  • If the API client expects a particular endpoint or field in the NetBackup response, then removing the endpoint or field results in a new version.

  • If NetBackup expects a new required field in the request from the API client, then adding it results in a new version.

  • As you develop your API client, as a best practice you should ignore any new fields that are returned to you. Do not treat unrecognized fields as an error. This way your API clients can continue to work with future releases of NetBackup without any change.

Pagination

Some NetBackup APIs use pagination to limit the number of resources returned in a response. These APIs use the page[offset] and page[limit] query parameters to set the 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: http://docs.oasis-open.org/odata/odata/v4.01/csprd01/part2-url-conventions/odata-v4.01-csprd01-part2-url-conventions.html#_Filter_System_Query.

Note
 The supported OData operators and functions depend on each individual NetBackup API, as described in the NetBackup API reference.

Date and time formatting

All NetBackup APIs accept and return date and time values using the ISO 8601 format in UTC with the Z zone designator.

More information on the details of the ISO spec can be found in the Wikipedia article, "ISO 8601": https://en.wikipedia.org/wiki/ISO_8601.

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.2

Versioned APIs

This is a list of APIs that have been versioned in 8.1.2. The previous version of these APIs is still supported specifying the correct version. See the Versioning section above for more details. See the 8.1.2 documentation for the APIs listed below to see the new definition of these APIs.

  • GET /admin/jobs

  • GET /admin/jobs/{jobId}

  • GET /config/policies/{policyName}

  • PUT /config/policies/{policyName}/schedules/{scheduleName}

  • GET /config/servers/vmservers

  • GET /security/cacert

NetBackup 8.1.2 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 Asset API

The NetBackup Asset API provides access to NetBackup asset information.

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 Manage API

The NetBackup Manage API provide access to the alerting operations. The APIs can generate alerts, fetch alert details, and send alert notifications. The APIs also provide a facility to exclude the status codes for which you do not want to send alert notifications.

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 Storage API

The NetBackup Storage API provides details of backup storage consumption. The API returns the total consumption of backup storage for all the master servers or the current master server. It also supports filtering backup storage consumption based on client name.

NetBackup Licensing API

The NetBackup Licensing API provides details of FEDS consumption. The Front-end Terabytes (FETBs) consumption is provided for a single master server or for multiple trusted master servers. Details include consumption by policy type and the trend of capacity consumption.

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 : 2.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.

Requires Permission: []

Responses

HTTP Code Description Schema

200

Web service application details returned successfully.

appdetailsResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

GET /authorization-context

Description

Lists the JWT claims.

Requires Permission: []

Responses

HTTP Code Description Schema

200

Successful response.

authorizationContextResource

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Resource not found.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

Server busy. Try again later.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

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. Requires Permission: []

Parameters

Type Name Schema

Body

login
required

userPassLoginRequest

Responses

HTTP Code Description Schema

201

Successfully logged in.
Headers :
Location (string) : The URI that contains the authentication token.

loginResponse

400

Bad request

errorResponse

401

Wrong username or password.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

POST /logout

Description

Removes the current access token (JWT), which invalidates that token for future API calls.

Requires Permission: []

Responses

HTTP Code Description Schema

200

Logout successful.

No Content

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Security

Type Name

apiKey

rbacSecurity

GET /ping

Description

Test the connection with the master server.

Requires Permission: []

Responses

HTTP Code Description Schema

200

Ping successful. Master server time in milliseconds.
Headers :
X-NetBackup-API-Version (string) : The current API version of this server.

string

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

string

Produces

  • text/vnd.netbackup+plain;version=2.0

Example HTTP response

Response 200
"1519397648169"

GET /tokenkey

Description

Gets the public key that can be used to validate the JSON Web Token (JWT).

Requires Permission: []

Responses

HTTP Code Description Schema

200

Successfully retrieved the token key.

string

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

string

Produces

  • text/vnd.netbackup+html;version=2.0

GET /user-sessions

Description

Obtains the details for all active user sessions.

Requires Permission: [Manage Certificates]

Responses

HTTP Code Description Schema

200

Successfully returned the details for all active user sessions.

getActiveUsers

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

DELETE /user-sessions

Description

Logs out all users. Removes the current access tokens (JWT) issued to all users, which invalidates them for all future API calls.

Requires Permission: [Manage Certificates]

Responses

HTTP Code Description Schema

204

Successfully logged out all users.

No Content

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

Security

Type Name

apiKey

rbacSecurity

Definitions

appdetailsResponse

Type : < appdetailsResponse > array

appdetailsResponse

Name Description Schema

appName
required

Web services application name.

string

status
required

Current run-time status of the application.

string

authorizationContext

Name Schema

attributes
optional

attributes

id
optional

string

links
optional

object

meta
optional

object

type
required

string

attributes

Name Description Schema

authToken
optional

The internal NetBackup authorization token issued by the gateway.

string

expireDate
optional

Expiration date of the JWT.

string (date-time)

isAdmin
optional

Indicate if the subject of the JWT is an admin user.

boolean

isMachine
optional

Indicate if the subject of the JWT is a machine.

boolean

issuedAt
optional

The date of the JWT was issued.

string (date-time)

issuer
optional

JWT issuer.

string

permissions
optional

The mapping of API permissions to object collection IDs.

< permissions > array

subject
optional

Contain domain name, username, and domain type.

string

permissions

Name Description Schema

collections
optional

Array of object collection IDs for which the user had this permission.

< string > array

permission
optional

string

authorizationContextResource

Details of JWT claims.

Name Schema

data
optional

authorizationContext

errorResponse

Name Description Schema

details
optional

A map containing error field and error field message to provide more context to nature of the error.

object

errorCode
required

The NetBackup error code.

integer (int64)

errorMessage
required

The NetBackup error code description.

string

getActiveUsers

Details for active user session.

Name Schema

data
optional

< data > array

links
optional

links

meta
optional

meta

data

Name Schema

attributes
optional

attributes

id
optional

string

type
optional

enum (user-session)

attributes

Name Schema

expiresAt
optional

string (date-time)

subject
optional

string

links

Name Schema

first
optional

first

last
optional

last

next
optional

next

previous
optional

previous

self
optional

self

first

Name Schema

href
optional

string

last

Name Schema

href
optional

string

next

Name Schema

href
optional

string

previous

Name Schema

href
optional

string

self

Name Schema

href
optional

string

meta

Name Schema

pagination
optional

pagination

pagination

Name Schema

count
optional

integer

first
optional

integer

last
optional

integer

limit
optional

integer

next
optional

integer

offset
optional

integer

page
optional

integer

pages
optional

integer

prev
optional

integer

loginResponse

Name Description Schema

token
required

The token to use for subsequent API requests.

string

tokenType
required

The token type for the token that is returned.

string

validity
required

The time in seconds that this token will be valid.

integer

userPassLoginRequest

Name Description Schema

domainName
optional

The domain name for the user.

string

domainType
optional

The domain type for the user.

enum (NT, vx, unixpwd, ldap)

password
required

The user password.

string

userName
required

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 : 2.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)

parentJobId

eq ne lt gt le ge

The parent job identifier.

integer(int64)

clientName

eq ne contains, startswith, endswith

The name of the client to protect. If the client name contains a space or “%”, encode these characters as '%20' or '%25', respectively.

string

endTime

eq ne lt gt le ge

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, 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, DATASTORE, LOTUS_NOTES, NCR_TERADATA, VAX_VMS, HP3000_MPE, FBU_WINDOWS, VAULT, BE_SQL_SERVER, BE_EXCHANGE, MAC, DS, NBU_CATALOG, GENERIC, CMS_DB, PUREDISK_EXPORT, ENTERPRISE_VAULT, VMWARE, HYPERV, BIGDATA, HYPERSCALE, NBU_SEARCHSERVER

string

restoreBackupIDs

eq, ne, contains, startswith, endswith

Specifies the backup images used for restore. If the client name contains a space or “%”, encode these characters as '%20' or '%25', respectively.

string

initiatorId

eq, ne, contains, startswith, endswith

Specifies the initiator of the job.

string

Requires Permission: [View Jobs, Manage Jobs]

A given principal can also view the jobs that they initiate even if they are not granted the View Jobs permission.

Parameters

Type Name Description Schema

Query

filter
optional

Specifies filters according to OData standards.

string

Query

page[limit]
optional

The number of records on one page after the offset.

integer (int64)

Query

page[offset]
optional

The job record number offset.

integer (int64)

Query

sort
optional

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. No data is returned if no jobs are found.

getJobsResponse

400

Bad request.

errorResponse

405

Method not allowed. The specified HTTP operation is invalid.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

The server is busy.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

Example HTTP response

Response 200
{
  "data" : [ {
    "links" : {
      "self" : {
        "href" : "/admin/jobs/1"
      },
      "file-lists" : {
        "href" : "https://dummyHost:1556/netbackup/admin/jobs/1/file-lists"
      },
      "try-logs" : {
        "href" : "https://dummyHost:1556/netbackup/admin/jobs/1/try-logs"
      }
    },
    "type" : "job",
    "id" : 1,
    "attributes" : {
      "jobId" : 1,
      "parentJobId" : 0,
      "activeProcessId" : 8624,
      "mainProcessId" : 0,
      "productType" : 0,
      "jobType" : "IMAGEDELETE",
      "jobSubType" : "IMMEDIATE",
      "policyName" : "",
      "scheduleType" : "FULL",
      "scheduleName" : "",
      "clientName" : "",
      "controlHost" : "",
      "jobOwner" : "user",
      "jobGroup" : "",
      "backupId" : "",
      "sourceMediaId" : "",
      "sourceStorageUnitName" : "",
      "sourceMediaServerName" : "",
      "destinationMediaId" : "",
      "destinationStorageUnitName" : "",
      "destinationMediaServerName" : "",
      "dataMovement" : "STANDARD",
      "streamNumber" : 0,
      "copyNumber" : 0,
      "priority" : 0,
      "retentionLevel" : 0,
      "compression" : 0,
      "status" : 0,
      "state" : "DONE",
      "done" : 1,
      "numberOfFiles" : 0,
      "estimatedFiles" : 0,
      "kilobytesTransferred" : 0,
      "kilobytesToTransfer" : 0,
      "transferRate" : 0,
      "percentComplete" : 100,
      "restartable" : 0,
      "suspendable" : 0,
      "resumable" : 0,
      "killable" : 1,
      "frozenImage" : 0,
      "transportType" : "LAN",
      "currentOperation" : 0,
      "jobQueueReason" : 0,
      "jobQueueResource" : "",
      "robotName" : "",
      "vaultName" : "",
      "profileName" : "",
      "sessionId" : 0,
      "numberOfTapeToEject" : 0,
      "submissionType" : 0,
      "dumpHost" : "",
      "instanceDatabaseName" : "",
      "auditUserName" : "",
      "auditDomainName" : "",
      "auditDomainType" : 0,
      "restoreBackupIDs" : "",
      "startTime" : "2018-06-25T19:00:32.000Z",
      "endTime" : "2018-06-25T19:00:38.000Z",
      "activeTryStartTime" : "2018-06-25T19:00:32.000Z",
      "lastUpdateTime" : "2018-06-25T19:00:38.407Z",
      "kilobytesDataTransferred" : 0,
      "initiatorId" : "",
      "try" : 1
    }
  }, {
    "links" : {
      "self" : {
        "href" : "/admin/jobs/2"
      },
      "file-lists" : {
        "href" : "https://dummyHost:1556/netbackup/admin/jobs/2/file-lists"
      },
      "try-logs" : {
        "href" : "https://dummyHost:1556/netbackup/admin/jobs/2/try-logs"
      }
    },
    "type" : "job",
    "id" : 2,
    "attributes" : {
      "jobId" : 2,
      "parentJobId" : 0,
      "activeProcessId" : 8625,
      "mainProcessId" : 0,
      "productType" : 0,
      "jobType" : "IMAGEDELETE",
      "jobSubType" : "IMMEDIATE",
      "policyName" : "",
      "scheduleType" : "FULL",
      "scheduleName" : "",
      "clientName" : "",
      "controlHost" : "",
      "jobOwner" : "user",
      "jobGroup" : "",
      "backupId" : "",
      "sourceMediaId" : "",
      "sourceStorageUnitName" : "",
      "sourceMediaServerName" : "",
      "destinationMediaId" : "",
      "destinationStorageUnitName" : "",
      "destinationMediaServerName" : "",
      "dataMovement" : "STANDARD",
      "streamNumber" : 0,
      "copyNumber" : 0,
      "priority" : 0,
      "retentionLevel" : 0,
      "compression" : 0,
      "status" : 0,
      "state" : "DONE",
      "done" : 1,
      "numberOfFiles" : 0,
      "estimatedFiles" : 0,
      "kilobytesTransferred" : 0,
      "kilobytesToTransfer" : 0,
      "transferRate" : 0,
      "percentComplete" : 100,
      "restartable" : 0,
      "suspendable" : 0,
      "resumable" : 0,
      "killable" : 1,
      "frozenImage" : 0,
      "transportType" : "LAN",
      "currentOperation" : 0,
      "jobQueueReason" : 0,
      "jobQueueResource" : "",
      "robotName" : "",
      "vaultName" : "",
      "profileName" : "",
      "sessionId" : 0,
      "numberOfTapeToEject" : 0,
      "submissionType" : 0,
      "dumpHost" : "",
      "instanceDatabaseName" : "",
      "auditUserName" : "",
      "auditDomainName" : "",
      "auditDomainType" : 0,
      "restoreBackupIDs" : "",
      "startTime" : "2018-06-25T19:00:32.000Z",
      "endTime" : "2018-06-25T19:00:38.000Z",
      "activeTryStartTime" : "2018-06-25T19:00:32.000Z",
      "lastUpdateTime" : "2018-06-25T19:00:38.407Z",
      "kilobytesDataTransferred" : 0,
      "initiatorId" : "",
      "try" : 1
    }
  } ]
}

GET /admin/jobs/{jobId}

Description

Gets the job details for the specified job.

Requires Permission: [View Jobs, Manage Jobs]

A given principal can also view the jobs that they initiate even if they are not granted the View Jobs permission.

Parameters

Type Name Description Schema

Path

jobId
required

The job identifier.

integer (int64)

Responses

HTTP Code Description Schema

200

Successfully retrieved the job details for the specified job.

getJobResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No entity found.

errorResponse

405

Method not allowed. The specified HTTP operation is invalid.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

The server is busy.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

DELETE /admin/jobs/{jobId}

Description

Deletes the specified job.

Requires Permission: [Manage Jobs]

A given principal can also manage the jobs that they initiate even if they are not granted the Manage Jobs permission.

Parameters

Type Name Description Schema

Header

X-NetBackup-Audit-Reason
optional

The audit reason for deleting the job.

string

Path

jobId
required

The job identifier.

integer (int64)

Responses

HTTP Code Description Schema

202

Request accepted.

No Content

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No entity found.

errorResponse

405

Method not allowed. The specified HTTP operation is invalid.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

The server is busy.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

POST /admin/jobs/{jobId}/cancel

Description

Cancels the specified job.

Requires Permission: [Manage Jobs]

A given principal can also manage the jobs that they initiate even if they are not granted the Manage Jobs permission.

Parameters

Type Name Description Schema

Header

X-NetBackup-Audit-Reason
optional

The audit reason for cancelling the job.

string

Path

jobId
required

The job identifier.

integer (int64)

Responses

HTTP Code Description Schema

202

Request accepted.

No Content

400

Bad request.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No entity found.

errorResponse

405

Method not allowed. The specified HTTP operation is invalid.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

The server is busy.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /admin/jobs/{jobId}/file-lists

Description

Gets the file list for the specified job.

Requires Permission: [View Jobs, Manage Jobs]

A given principal can also view the related file-lists for the jobs that they initiate even if they are not granted the View Jobs permission.

Parameters

Type Name Description Schema

Path

jobId
required

The job identifier.

integer (int64)

Responses

HTTP Code Description Schema

200

Successfully retrieved the file list for the specified job.

getJobFileListResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No entity found.

errorResponse

405

Method not allowed. The specified HTTP operation is invalid.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

The server is busy.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

Example HTTP response

Response 200
{
  "data" : {
    "links" : {
      "self" : {
        "href" : "/admin/jobs/1/file-lists"
      }
    },
    "type" : "file-lists",
    "id" : 1,
    "attributes" : {
      "fileList" : [ "C:\\BackupSource\\MyFolder" ]
    }
  }
}

POST /admin/jobs/{jobId}/restart

Description

Restarts the specified job.

Requires Permission: [Manage Jobs]

A given principal can also manage the jobs that they initiate even if they are not granted the Manage Jobs permission.

Parameters

Type Name Description Schema

Header

X-NetBackup-Audit-Reason
optional

The audit reason for restarting the job.

string

Path

jobId
required

The job identifier.

integer (int64)

Responses

HTTP Code Description Schema

202

Request accepted.

No Content

400

Bad request.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No entity found.

errorResponse

405

Method not allowed. The specified HTTP operation is invalid.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

The server is busy.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

POST /admin/jobs/{jobId}/resume

Description

Resumes the specified job.

Requires Permission: [Manage Jobs]

A given principal can also manage the jobs that they initiate even if they are not granted the Manage Jobs permission.

Parameters

Type Name Description Schema

Header

X-NetBackup-Audit-Reason
optional

The audit reason for resuming the job.

string

Path

jobId
required

The job identifier.

integer (int64)

Responses

HTTP Code Description Schema

202

Request accepted.

No Content

400

Bad request.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No entity found.

errorResponse

405

Method not allowed. The specified HTTP operation is invalid.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

The server is busy.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

POST /admin/jobs/{jobId}/suspend

Description

Suspends the specified job.

Requires Permission: [Manage Jobs]

A given principal can also manage the jobs that they initiate even if they are not granted Manage Jobs permission.

Parameters

Type Name Description Schema

Header

X-NetBackup-Audit-Reason
optional

The audit reason for suspending the job.

string

Path

jobId
required

The job identifier.

integer (int64)

Responses

HTTP Code Description Schema

202

Request accepted.

No Content

400

Bad request.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No entity found.

errorResponse

405

Method not allowed. The specified HTTP operation is invalid.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

The server is busy.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /admin/jobs/{jobId}/try-logs

Description

Gets logs for the specified job.

Requires Permission: [View Jobs, Manage Jobs]

A given principal can also view the related try-logs for the jobs that they initiate even if they are not granted the View Jobs permission.

Parameters

Type Name Description Schema

Path

jobId
required

The job identifier.

integer (int64)

Responses

HTTP Code Description Schema

200

Successfully retrieved the try-logs for the specified job.

getJobTryLogsResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No entity found.

errorResponse

405

Method not allowed. The specified HTTP operation is invalid.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

The server is busy.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

Example HTTP response

Response 200
{
  "data" : {
    "links" : {
      "self" : {
        "href" : "/admin/jobs/1/try-logs"
      }
    },
    "type" : "try-logs",
    "id" : 1,
    "attributes" : {
      "log" : [ "Try 1", "LOG 1529953232 4 bpdbm 8624 image catalog cleanup", "LOG 1529953232 4 bpdbm 8624 Cleaning up tables in the relational database", "LOG 1529953232 4 bpdbm 8624 deleting images which expire before Mon Jun 25 12:00:21 2018 (1529953221)", "LOG 1529953238 4 bpdbm 8624 deleted 0 expired records, compressed 0, tir removed 0, deleted 0 expired copies", "Started 1529953232", "ActivePid 8624", "Status 0", "Ended 1529953238" ]
    }
  }
}

Definitions

errorResponse

Name Description Schema

details
optional

A map containing error field and error field message to provide more context to nature of the error.

object

errorCode
required

The NetBackup error code.

integer (int64)

errorMessage
required

The NetBackup error code description.

string

getJobDetailsResponse

Name Schema

attributes
optional

attributes

id
optional

string

links
optional

links

type
optional

string

attributes

Name Description Schema

acceleratorOptimization
optional

The percentage of optimization achieved if the job uses NetBackup Accelerator

integer (int64)

activeProcessId
optional

The process that is active now.

integer (int64)

activeTryStartTime
optional

A UTC timestamp of when the current try started.

string

auditDomainName
optional

The domain name for auditing.

string

auditDomainType
optional

The auditing domain type. 0=INVALID, 1=ACTIVE_DIRECTORY, 2=NIS_PLUS, 3=VXAT_PRIVATE, 4=UNIX_PASSWORD, 5=NIS, 6=LOCAL_HOST, 7=UNKNOWN_AUTH

integer (int64)

auditUserName
optional

The user name in the audit record.

string

backupId
optional

The backup ID or image ID.

string

clientName
optional

The name of the client to be protected.

string

compression
optional

Indicates if compression is enabled for the backup policy. 0=disabled, 1=enabled

integer (int64)

controlHost
optional

The host from which the job was initiated.

string

copyNumber
optional

The backup image copy number.

integer (int64)

currentFile
optional

The current file being protected.

string

currentOperation
optional

The current operation being performed. Negative values should be ignored. 0=MOUNTING, 1=POSITIONING, 2=CONNECTING, 3=WRITING, 4=VLT_INIT, 5=VLT_DUPIMG, 6=VLT_DUPCMP, 7=VLT_BK_NBCAT, 8=VLT_EJRPT, 9=VLT_COMPLETE, 10=READING, 11=DUPLICATE, 12=IMPORT, 13=VERIFY, 14=RESTORE, 15=BACKUPDB, 16=VAULT, 17=LABEL, 18=ERASE, 19=SYNTH_DBQUERY, 20=SYNTH_PROCESS_EXTENTS, 21=SYNTH_PLAN, 22=CREATE_SNAPSHOT, 23=DELETE_SNAPSHOT, 24=RECOVERDB, 25=MCONTENTS, 26=SYNTH_REQUERESOURCES, 27=PARENT_JOB, 28=INDEXING, 29=REPLICATE, 30=RUNNING, 31=ASSEMBLING_FILE_LIST, 32=ALLOCATING_MEDIA

integer (int64)

dataMovement
optional

The type of data movement used for this job.

enum (STANDARD, INSTANTRECOVERYDISK, INSTANTRECOVERYDISKANDTAPE, SYNTHETIC, DISKSTAGING, SNAPSHOT)

dedupRatio
optional

The deduplication rate achieved.

number (float)

destinationMediaId
optional

The destination media server. Used for deduplication jobs.

string

destinationMediaServerName
optional

The destination media server name. Used for deduplication jobs.

string

destinationStorageUnitName
optional

The destination storage unit. Used for deduplication jobs.

string

done
optional

Indicates if the job is complete.

integer (int64)

dumpHost
optional

The recovery appliance host name for Copilot.

string

endTime
optional

The job end time.

string (date-time)

estimatedFiles
optional

The estimated number of files to be protected.

integer (int64)

frozenImage
optional

Used internally to flag snapshots. Also used to determine if the job type is snapshot.

integer (int64)

initiatorId
optional

The initiator of the job.

string

instanceDatabaseName
optional

The database instance and/or database name itself.

string

jobGroup
optional

The group name of the job initiator.

string

jobId
optional

The job identifier.

integer (int64)

jobOwner
optional

The user name of the job initiator.

string

jobQueueReason
optional

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
optional

The name of the resource for which the queued job is waiting.

string

jobSubType
optional

The job sub-type.

enum (IMMEDIATE, SCHEDULED, USERBACKUP, ERASETYPE_QUICK, ERASETYPE_LONG, DBBACKUP_STAGING, DBBACKUP_COLD, RMAN_CATALOG)

jobType
optional

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
optional

Indicates if the job can be stopped.

integer (int64)

kilobytesDataTransferred
optional

The actual data transferred in kilobytes. For some jobs, data transferred is different than the final image size.

integer (int64)

kilobytesToTransfer
optional

The remaining kilobytes to be transferred.

integer (int64)

kilobytesTransferred
optional

The estimated amount of data transferred in kilobytes.

integer (int64)

lastUpdateTime
optional

The UTC timestamp when the job was modified.

string (date-time)

mainProcessId
optional

The process ID of the main controlling process for restore and image cleanup.

integer (int64)

numberOfFiles
optional

The actual number of files protected.

integer (int64)

numberOfTapeToEject
optional

For vault jobs, the total number of tape media to be ejected.

integer (int64)

parentJobId
optional

The parent job ID.

integer (int64)

percentComplete
optional

The estimated completion percentage of this job.

integer (int64)

policyName
optional

The name of the policy used by this job.

string

policyType
optional

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, DATASTORE, LOTUS_NOTES, NCR_TERADATA, VAX_VMS, HP3000_MPE, FBU_WINDOWS, VAULT, BE_SQL_SERVER, BE_EXCHANGE, MAC, DS, NBU_CATALOG, GENERIC, CMS_DB, PUREDISK_EXPORT, ENTERPRISE_VAULT, VMWARE, HYPERV, NBU_SEARCHSERVER, HYPERSCALE, BIGDATA)

priority
optional

The priority of this job.

integer (int64)

productType
optional

The product type number.

integer (int64)

profileName
optional

The name of the Vault profile.

string

restartable
optional

Indicates if the job can be restarted.

integer (int64)

restoreBackupIDs
optional

The list of backup IDs needed for the restore job.

string

resumable
optional

Indicates if the job can be resumed.

integer (int64)

retentionLevel
optional

The retention level of the backup image.

integer (int64)

robotName
optional

The name of the robot in the Vault job.

string

scheduleName
optional

The name of the backup schedule used by the backup job.

string

scheduleType
optional

The type of schedule used by the backup job.

enum (FULL, DIFFERENTIAL_INCREMENTAL, USER_BACKUP, USER_ARCHIVE, CUMULATIVE_INCREMENTAL, TRANSACTION_LOG)

sessionId
optional

The Vault session ID.

integer (int64)

sourceMediaId
optional

The source media ID for the duplication job.

string

sourceMediaServerName
optional

The source media server name for the duplication job.

string

sourceStorageUnitName
optional

The source storage unit.

string

startTime
optional

The UTC timestamp when the job was started.

string (date-time)

state
optional

The current state of the job.

enum (QUEUED, ACTIVE, REQUEUED, DONE, SUSPENDED, INCOMPLETE)

status
optional

The final job status code.

integer (int64)

streamNumber
optional

The job stream number.

integer (int64)

submissionType
optional

The job submission type.

integer (int64)

suspendable
optional

Indicates if the job can be suspended.

integer (int64)

transferRate
optional

The data transfer rate in kilobytes (KB) per second.

integer (int64)

transportType
optional

The data transport type used for the job.

enum (LAN, FAT)

try
optional

The current try number to execute this job.

integer (int64)

vaultName
optional

The Vault name used by the job.

string

links

Name Schema

file-lists
optional

file-lists

self
optional

self

try-logs
optional

try-logs

file-lists

Name Schema

href
optional

string

self

Name Schema

href
optional

string

try-logs

Name Schema

href
optional

string

getJobFileListResponse

Name Schema

data
optional

data

data

Name Schema

attributes
optional

attributes

id
optional

integer (int64)

links
optional

links

type
optional

string

attributes

Name Schema

fileList
optional

< string > array

links

Name Schema

self
optional

self

self

Name Schema

href
optional

string

getJobResponse

Name Schema

data
optional

getJobDetailsResponse

getJobTryLogsResponse

Name Schema

data
optional

data

data

Name Schema

attributes
optional

attributes

id
optional

integer (int64)

links
optional

links

type
optional

string

attributes

Name Schema

log
optional

< string > array

links

Name Schema

self
optional

self

self

Name Schema

href
optional

string

getJobsResponse

Name Schema

data
optional

< getJobDetailsResponse > array

links
optional

links

meta
optional

meta

links

Name Schema

first
optional

first

last
optional

last

next
optional

next

prev
optional

prev

self
optional

self

first

Name Schema

href
optional

string

last

Name Schema

href
optional

string

next

Name Schema

href
optional

string

prev

Name Schema

href
optional

string

self

Name Schema

href
optional

string

meta

Name Schema

pagination
optional

pagination

pagination

Name Schema

count
optional

integer (int64)

first
optional

integer (int64)

last
optional

integer (int64)

limit
optional

integer (int64)

next
optional

integer (int64)

offset
optional

integer (int64)

page
optional

integer (int64)

pages
optional

integer (int64)

prev
optional

integer (int64)

Security

rbacSecurity

Type : apiKey
Name : Authorization
In : HEADER

NetBackup Asset API

Overview

The NetBackup Asset API provides access to NetBackup asset information.

Version information

Version : 2.0

URI scheme

Host : <masterserver>:1556
BasePath : /netbackup
Schemes : HTTPS

Paths

POST /asset-groups

Description

Creates a new asset group. Currently the only workload type accepted by this API is VMware. When creating a filter for the asset group, asset filtering is supported for the following attributes:

Name Supported Operators Description Schema

extendedAttributes/instanceUuid

eq ne contains startswith endswith

The asset’s instance UUID.

string

extendedAttributes/vCenter

eq ne ge gt le lt contains startswith endswith

The vCenter name of the VMware asset.

string

extendedAttributes/hostName

eq ne ge gt le lt contains startswith endswith

The host name of the VMware asset.

string

extendedAttributes/vmFolder

eq ne ge gt le lt containts startswith endswith

The folder of the VMware asset.

string

extendedAttributes/dnsName

eq ne ge gt le lt contains startswith endswith

The DNS name of the asset.

string

extendedAttributes/tag

eq ne ge gt le lt contains startswith endswith

The VMware asset tag.

string

extendedAttributes/resourcepool

eq ne ge gt le lt contains startswith endswith

The VMware asset resource pool.

string

extendedAttributes/powerState

eq ne

The power state of the virtual machine.

string

extendedAttributes/host

eq ne ge gt le lt contains startswith endswith

The ESXi server.

string

extendedAttributes/displayName

eq ne ge gt le lt contains startswith endswith

The display name of the asset.

string

extendedAttributes/datastoreCluster

eq ne ge gt le lt contains startswith endswith

The datastore cluster of the VMware asset.

string

extendedAttributes/datastore

eq ne ge gt le lt contains startswith endswith

The datastore of the VMware asset.

string

extendedAttributes/datacenter

eq ne ge gt le lt contains startswith endswith

The datacenter of the VMware asset.

string

extendedAttributes/cluster

eq ne ge gt le lt contains startswith endswith

The cluster of the VMware asset.

string

Requires Permission: [Manage Appservers and Asset Groups]

Parameters

Type Name Description Schema

Body

newAssetGroupDetails
required

Specifies the JSON body that contains asset information. This request payload may not exceed 2 MB in size.

postAssetGroupRequest

Responses

HTTP Code Description Schema

201

Successfully created the group record in the asset database.

assetGroupDetail

400

The request body is not valid.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

409

The resource already exists.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /asset-groups

Description

Retrieves the list of asset groups based on the specified filters. If no filters are specified, information for the newest 10 asset groups are retrieved, sorted in ascending order by their displayName. All the filters are based on OData standards. Filtering is supported for the following attributes:

Name Supported Operators Description Schema

id

eq ne

Specifies the asset group’s GUID.

string

displayName

eq ne ge gt le lt contains startswith endswith

Specifies the asset group’s display name.

string

description

eq ne ge gt le lt contains startswith endswith

Specifies the asset group’s description.

string

createdDateTime

eq ne ge gt le lt

The asset group’s creation time in ISO 8601 format.

date-time

lastModifiedDateTime

eq ne ge gt le lt

The asset group’s last modified time in ISO 8601 format.

date-time

assetType

eq ne ge gt le lt contains startswith endswith

Specifies the group’s asset type.

string

workloadType

eq ne ge gt le lt contains startswith endswith

Specifies the group’s workload type.

string

filterConstraint

eq ne ge gt le lt contains startswith endswith

Specifies the filter constraint.

string

Requires Permission: [Manage Assets, Manage Appservers and Asset Groups]

Parameters

Type Name Description Schema Default

Query

filter
optional

Specifies filters according to OData standards.

string

Query

page[limit]
optional

The maximum number of asset group records on one page.

integer

10

Query

page[offset]
optional

The asset group record number offset.

integer

0

Query

sort
optional

Sort in ascending order on the specified property. Prefix with '-' for descending order.

string

"displayName"

Responses

HTTP Code Description Schema

200

Retrieved the asset groups based on the applied filters.

getAssetGroupsResponse

400

Invalid filter criteria.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /asset-groups/{assetGroupGuid}

Description

Retrieves the details of the asset group.

Requires Permission: [Manage Assets, Manage Appservers and Asset Groups]

Parameters

Type Name Description Schema

Path

assetGroupGuid
required

An asset group’s global unique identifier.

string

Responses

HTTP Code Description Schema

200

Request successful.

assetGroupDetail

400

Malformed asset group GUID.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No asset group was found based on the given GUID.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

DELETE /asset-groups/{assetGroupGuid}

Description

Deletes the asset group specified by the GUID.

Requires Permission: [Manage Appservers and Asset Groups]

Parameters

Type Name Description Schema

Path

assetGroupGuid
required

An asset group’s global unique identifier.

string

Responses

HTTP Code Description Schema

204

Successfully deleted the asset group.

No Content

400

Malformed asset group ID.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No asset group was found based on the given GUID.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

PATCH /asset-groups/{assetGroupGuid}

Description

Replaces all or some the details of the existing asset group with the specified details.

Requires Permission: [Manage Appservers and Asset Groups]

Parameters

Type Name Description Schema

Path

assetGroupGuid
required

An asset group’s global unique identifier.

string

Body

assetGroupDetails
required

Specifies the JSON body that contains the updated asset information. This request payload may not exceed 2 MB in size.

patchAssetGroupRequest

Responses

HTTP Code Description Schema

200

Successfully updated the asset group.

assetGroupDetail

400

Malformed asset group GUID, or the request body is not valid.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No asset group was found based on the given GUID.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

POST /assets

Description

Creates a new entry in the asset database. This operation is a batch request to store asset data, which is a result of auto-discovery for different workloads.

Requires Permission: [Manage NetBackup]

This API is used by NetBackup hosts to post discovered assets to the asset database.

Parameters

Type Name Description Schema

Body

body
required

Specifies the JSON body that contains asset information. This request payload may not exceed 2 MB.

postAssetsRequest

Responses

HTTP Code Description Schema

201

Successfully created the record in the asset database.

postAssetsResponse

400

The request body is not valid.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /assets

Description

Retrieves the list of assets based on specified filters. If no filters are specified, information for 10 assets are retrieved, and sorted in descending order based on the time the assets were discovered. All the filters are based on OData standards. Filtering is supported for the following attributes:

Name Supported Operators Description Schema

providerGeneratedID

eq ne gt ge lt le and or not () contains endswith startswith

ID given to an asset by its workload.

string

displayName

eq ne gt ge lt le and or not () contains endswith startswith

Specifies an asset’s name.

string

description

eq ne gt ge lt le and or not () contains endswith startswith

Describes an asset.

string

version

eq ne gt ge lt le and or not () contains endswith startswith

Specifies version number.

string

firstDiscoveryTime

eq ne gt ge lt le and or not () contains endswith startswith

Specifies the first time an asset was discovered in ISO 8601 format.

date-time

lastDiscoveryTime

eq ne gt ge lt le and or not () contains endswith startswith

Specifies the most recent time an asset was discovered in ISO 8601 format.

date-time

assetType

eq ne gt ge lt le and or not () contains endswith startswith

Specifies asset type. Could be a VM, ESX Server, etc.

string

workloadType

eq ne gt ge lt le and or not () contains endswith startswith

Specifies the workload type. Possible values: CLOUD ORACLE SQL_SERVER VMWARE HYPER_V UNIX_FS WINDOWS_FS

string

extendedAttributes/{extendedAttributeName}

eq ne gt ge lt le and or not () contains endswith startswith

Specifies the dynamic extended attribute key and value.

object

Requires Permission: [View Assets, Manage Assets]

Parameters

Type Name Description Schema Default

Query

filter
optional

Specifies filters according to OData standards.

string

Query

include
optional

Appends a section in the response payload with details about the relationships that are specified in the include query.

enum (assetGroups)

Query

page[limit]
optional

The number of records on one page, after the offset.

integer

10

Query

page[offset]
optional

The asset record number offset.

integer

0

Query

sort
optional

Sort in ascending order on the specified property. Prefix with "-" for descending order.

string

"-lastDiscoveredTime"

Responses

HTTP Code Description Schema

200

Retrieved the assets based on the applied filters.

getAssetsResponse

400

Invalid filter criteria.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No assets were found based on the specified query or filters.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

POST /assets/asset-cleanup

Description

Cleans up assets from the database. This API cleans up assets from the given list whose lastDiscoveredTime is older than the given cleanupTime, do not have a backup status, and are not individually subscribed to a protection plan.

Requires Permission: [Manage NetBackup]

Parameters

Type Name Description Schema

Body

postAssetCleanupRequest
required

Specifies the JSON body that contains asset cleanup information.

postAssetCleanupRequest

Responses

HTTP Code Description Schema

204

Successfully cleaned up assets.

No Content

400

Malformed cleanup time.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /assets/{GUID}

Description

Retrieves the details of the asset.

Requires Permission: [View Assets, Manage Assets]

Parameters

Type Name Description Schema

Path

GUID
required

An asset’s global unique identifier.

string

Query

include
optional

Appends a section in the response payload with details about the relationships that are specified in the include query.

enum (assetGroups)

Responses

HTTP Code Description Schema

200

Request successful.

assetDetail

400

Invalid asset ID.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No assets were found based on the specified query or filters.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /assets/{GUID}/asset-groups

Description

Retrieves the asset groups to which the given asset belongs.

Requires Permission: [View Assets, Manage Assets]

Parameters

Type Name Schema

Path

GUID
required

string

Responses

HTTP Code Description Schema

200

Request successful.

relatedResources

400

Malformed asset GUID.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No asset was found based on the given GUID.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

POST /preview-asset-group

Description

Retrieves a list of assets that would be included in an asset group without actually creating one.

Requires Permission: [Manage Assets, Manage Appservers and Asset Groups]

Parameters

Type Name Description Schema

Body

previewDetails
required

Specifies the details needed to preview the list of assets for this asset group.

postAssetGroupPreviewRequest

Responses

HTTP Code Description Schema

200

Retrieved the assets based on the applied filters.

getAssetsResponse

400

Malformed filter.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

Definitions

allLinks

Name Schema

first
optional

first

last
optional

last

next
optional

next

prev
optional

prev

self
optional

self

first

Name Schema

href
optional

string

last

Name Schema

href
optional

string

next

Name Schema

href
optional

string

prev

Name Schema

href
optional

string

self

Name Schema

href
optional

string

assetAttributesRequest

Name Description Schema

assetType
required

The type of the asset that is provided by the workload.
Maximal length : 128

string

description
optional

The description of the asset.

string

discoveryHosts
optional

The list of NetBackup hosts that have discovered this asset. When an asset is updated with new discovery hosts, they will be appended to the existing list of discovery hosts.

< machine > array

displayName
optional

The display name of this asset in the NetBackup Web UI.
Maximal length : 1024

string

extendedAttributes
optional

The workload attributes that can be searched. Values are truncated if they exceed the character-length limit.

< string, AnyValue > map

firstDiscoveredTime
optional

The ISO 8601 formatted time at which the asset was first discovered.

string (date-time)

lastDiscoveredTime
required

The ISO 8601 formatted time at which the asset was last discovered.

string (date-time)

masters
required

The list of NetBackup master servers associated with this asset. When an asset is updated with new master servers, they will be appended to the existing list of master servers.

< machine > array

properties
optional

All the workload-specific data. This data cannot be searched.

string

protectionMethods
optional

The protection methods that are available for this asset.

< protectionMethods > array

providerGeneratedId
required

The provider identifier, which is unique within the workloadType context that is provided by the workload.
Maximal length : 1024

string

version
optional

The version of the asset.
Maximal length : 128

string

workloadType
required

The workload type to which this asset belongs.
Maximal length : 64

string

protectionMethods

Name Description Schema

protectionMethodName
optional

Maximal length : 128

string

assetAttributesResponse

Name Description Schema

assetLastBackupStatuses
optional

lastBackupStatusList

assetSubscriptions
optional

assetSubscriptionList

assetType
required

The type of the asset that is provided by the workload.
Maximal length : 128

string

description
optional

The description of the asset.

string

discoveryHosts
optional

The list of NetBackup hosts that have discovered this asset. When an asset is updated with new discovery hosts, they will be appended to the existing list of discovery hosts.

< machine > array

displayName
optional

The display name of this asset in the NetBackup Web UI.
Maximal length : 1024

string

extendedAttributes
optional

The workload attributes that can be searched. Values are truncated if they exceed the character-length limit.

< string, AnyValue > map

firstDiscoveredTime
optional

The ISO 8601 formatted time at which the asset was first discovered.

string (date-time)

lastDiscoveredTime
required

The ISO 8601 formatted time at which the asset was last discovered.

string (date-time)

masters
required

The list of NetBackup master servers associated with this asset. When an asset is updated with new master servers, they will be appended to the existing list of master servers.

< machine > array

properties
optional

All the workload-specific data. This data cannot be searched.

string

protectionMethods
optional

The protection methods that are available for this asset.

< protectionMethods > array

providerGeneratedId
required

The provider identifier, which is unique within the workloadType context that is provided by the workload.
Maximal length : 1024

string

version
optional

The version of the asset.
Maximal length : 128

string

workloadType
required

The workload type to which this asset belongs.
Maximal length : 64

string

protectionMethods

Name Description Schema

protectionMethodName
optional

Maximal length : 128

string

assetDetail

Name Schema

data
required

getAsset

included
optional

< includedAssetGroupInfo > array

assetGroup

Name Description Schema

attributes
required

assetGroupAttributes

id
required

The global unique identifier (GUID) of the asset group.

string

links
required

Contains links to related APIs.

links

type
required

The type of resource. This should always be "assetGroup".

string

links

Name Schema

self
optional

self

self

Name Schema

href
optional

string

assetGroupAttributes

Name Description Schema

assetGroupSubscriptions
optional

The list of protection plans this asset group is subscribed to.

< assetGroupSubscriptions > array

assetType
required

The name of the asset type contained within this asset group.

string

createdDateTime
required

The timestamp that indicates when the asset group was created, in ISO 8601 format.

string (date-time)

description
optional

The description of the asset group.

string

displayName
required

The display name of the asset group.

string

filterConstraint
required

The filter constraint. For VMware workloads, this indicates the vCenter or the ESXi host name.

string

lastModifiedDateTime
required

The timestamp that indicates when the asset group was last modified, in ISO 8601 format.

string (date-time)

oDataQueryFilter
required

The filter criteria in OData query format.

string

vipQueryFilter
optional

The filter criteria in VIP query format, converted from the oDataQueryFilter.

string

workloadType
required

The name of the workload type contained within this asset group.

enum (VMware)

assetGroupSubscriptions

Name Description Schema

policyName
required

The NetBackup policy that is used when the asset group is protected.

string

sloId
required

The unique ID of the protection plan protecting the asset group.

string

sloName
required

Name of the protection plan protecting the asset group.

string

subscriptionId
required

The unique ID of the asset group’s subscription to the protection plan.

string

assetGroupDetail

Name Schema

data
required

assetGroup

assetSubscription

Asset subscription details.

Name Description Schema

sloId
optional

The unique ID of the protection plan protecting the asset.

string

sloName
optional

Name of the protection plan protecting the asset.

string

subscriptionId
optional

The unique ID of the asset’s subscription to the protection plan.

string

assetSubscriptionList

List of asset subscriptions.

Type : < assetSubscription > array

createAssetGroupAttributes

Name Description Schema

assetType
required

The name of the asset type contained within this asset group.

string

description
optional

The description of the asset group. Maximum 1024 characters.

string

displayName
required

The display name of the asset group. Maximum 256 characters.

string

filterConstraint
required

The filter constraint. For VMware workloads, this indicates the vCenter or the ESXi host name.

string

oDataQueryFilter
optional

The filter criteria in OData query format. Maximum 4096 characters. If no filter is supplied, all assets matching the filter constraint will be included.

string

workloadType
required

The name of the workload type contained within this asset group.

enum (VMware)

errorResponse

Name Description Schema

details
optional

A map containing error field and error field message to provide more context to nature of the error.

object

errorCode
required

The NetBackup error code.

integer (int64)

errorMessage
required

The NetBackup error code description.

string

getAsset

Name Description Schema

attributes
optional

assetAttributesResponse

id
required

The global unique identifier (GUID) of the asset.

string

links
required

links

relationships
optional

relationships

type
required

Type as 'asset'

enum (asset)

links

Name Schema

self
optional

self

self

Name Schema

href
optional

string

relationships

Name Schema

assetGroups
optional

relatedResources

getAssetGroupsResponse

Name Schema

data
required

< assetGroup > array

links
required

allLinks

meta
required

meta

meta

Name Schema

pagination
optional

paginationAttributes

getAssetsResponse

Name Schema

data
required

< getAsset > array

included
optional

< includedAssetGroupInfo > array

links
required

allLinks

meta
optional

meta

meta

Name Schema

pagination
optional

paginationAttributes

includedAssetGroupInfo

Name Schema

attributes
required

attributes

id
required

string

type
required

string

attributes

Name Description Schema

displayName
required

The display name of the asset group.

string

lastBackupStatusAttributes

Name Description Schema

backupTime
required

The ISO 8601 formatted time when the asset was last backed up.

string (date-time)

jobId
required

The NetBackup job ID that last protected the asset.

integer

jobStatus
required

The status of the last job.

integer

masterUuid
required

The NetBackup master server UUID protecting the asset.

string

policyName
required

The NetBackup policy that is used when the asset is protected.

string

scheduleName
required

The NetBackup schedule name used when protecting the asset.

string

scheduleType
required

The NetBackup schedule type used when protecting the asset.

enum (FULL, DIFFERENTIAL_INCREMENTAL, CUMULATIVE_INCREMENTAL, USER_BACKUP, USER_ARCHIVE, TRANSACTION_LOG)

lastBackupStatusList

Type : < lastBackupStatusAttributes > array

machine

Name Description Schema

hostName
required

Maximal length : 1024

string

ipAddress
optional

Maximal length : 20

string

uuid
required

Maximal length : 1024

string

paginationAttributes

Name Schema

count
optional

integer

first
optional

integer

last
optional

integer

limit
optional

integer

next
optional

integer

offset
optional

integer

page
optional

integer

pages
optional

integer

prev
optional

integer

patchAssetGroupRequest

Specifies all or some fields of an asset group record in the database to be updated.

Name Schema

data
required

data

data

Name Schema

attributes
required

updateAssetGroupAttributes

postAssetCleanupRequest

Specifies the request body for cleaning up assets in the database.

Name Schema

data
required

data

data

Name Description Schema

attributes
required

attributes

type
required

The type of data being represented.

enum (assetCleanup)

attributes

Name Description Schema

assetIds
required

The list of global unique identifiers (GUID) of the assets to be deleted.

< string > array

cleanupTime
required

Specifies an ISO-8601 formatted time. Assets from the given list that were discovered before this time are eligible to be deleted.

string (date-time)

postAssetGroupPreviewRequest

Specifies the necessary information to preview the list of assets for an asset group before it is created.

Name Schema

data
required

data

data

Name Description Schema

attributes
required

attributes

type
required

The type of data being represented.

enum (assetGroupPreview)

attributes

Name Description Schema

filterConstraint
required

The filter constraint. For VMware workloads, this indicates the vCenter or the ESXi host name.

string

oDataQueryFilter
optional

The filter criteria in OData query format. Maximum 4096 characters. If no filter is supplied, all assets matching the filter constraint will be returned.

string

pageLimit
optional

The number of asset records on one page.

integer

pageOffset
optional

The page offset for pagination.

integer

sort
optional

Sort in ascending order on the specified property. Prefix with '-' for descending order.
Default : "-lastDiscoveredTime"

string

workloadType
required

The name of the workload type contained within this asset group.

enum (VMware)

postAssetGroupRequest

Creates a record in the database to store asset group details.

Name Schema

data
required

data

data

Name Description Schema

attributes
required

createAssetGroupAttributes

type
required

This should always be set to "assetGroup"

string

relatedResources

Name Schema

data
optional

< data > array

links
optional

links

meta
optional

meta

data

Name Schema

id
optional

string

type
optional

string

links

Name Schema

related
optional

related

self
optional

self

related

Name Schema

href
optional

string

self

Name Schema

href
optional

string

meta

Name Schema

pagination
optional

paginationAttributes

updateAssetGroupAttributes

Name Schema

description
optional

string

displayName
optional

string

odataFilterCriteria
optional

string

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 : 2.0

URI scheme

Host : <masterserver>:1556
BasePath : /netbackup
Schemes : HTTPS

Paths

GET /catalog/images

Description

Returns the list of images based on the specified filters. All the filters are based on OData standards and filtering on the following attributes is supported.

Name Supported Operators Description Schema

backupId

eq

The identifier for the backup image.

string

backupTime

ge le

The backup time range in ISO 8601 format. By default, backupTime ge is set to 24 hours ago and backupTime le is set to the current time.

date-time

clientName

eq

The client name.

string

policyType

eq

The policy type.

string

policyName

eq

The policy name.

string

scheduleType

eq

The schedule type. Possible values: FULL DIFFERENTIAL_INCREMENTAL USER_BACKUP USER_ARCHIVE CUMULATIVE_INCREMENTAL

string

providerGeneratedId

eq

The provider generated id.

string

Requires Permission: [View Recovery Points, Recover/Restore, Instant Access, Download Files, Restore Files]

Parameters

Type Name Description Schema Default

Query

filter
optional

The filter criteria in OData format.

string

Query

page[limit]
optional

The number of images on one page.

integer

10

Query

page[offset]
optional

The image record number offset.

integer

0

Responses

HTTP Code Description Schema

200

Returned the list of catalog images based on the filter criteria.

imageList

400

Invalid filter criteria.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /catalog/images/contents/{requestId}

Description

Gets the next page of file contents for the specified request ID. Continue to call this API with the same request ID to retrieve all files for the image specified with the request ID. When there are no more contents to retrieve, this API returns status 404, and the request ID is deleted automatically. The pagination values 'last' and 'first' are for informational purpose only. These values cannot be used to traverse to the last or the first page in the image contents array. Note that there is a timeout between calls of this API. Each successful call to this API resets the timeout. The timeout limit is 6 minutes.

Requires Permission: [Recover/Restore, Instant Access, Download Files, Restore Files]

Parameters

Type Name Schema

Path

requestId
required

string

Responses

HTTP Code Description Schema

200

Returned the next page of file contents successfully.

imageContents

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The request ID was not found, or the user has already retrieved the last page of contents.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

DELETE /catalog/images/contents/{requestId}

Description

Deletes the specified request ID.

Requires Permission: [Recover/Restore, Instant Access, Download Files, Restore Files]

Parameters

Type Name Schema

Path

requestId
required

string

Responses

HTTP Code Description Schema

204

Request ID deleted successfully.

No Content

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The request ID was not found.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /catalog/images/{backupId}

Description

Requests the details of an image.

Requires Permission: [View Recovery Points, Recover/Restore, Instant Access, Download Files, Restore Files]

Parameters

Type Name Schema

Path

backupId
required

string

Responses

HTTP Code Description Schema

200

Image details were returned successfully.

imageDetail

400

The backup ID is invalid.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No images were found with the specified backup ID.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /catalog/images/{backupId}/contents

Description

Gets a request ID that is used to retrieve the file contents of an image.

Requires Permission: [Recover/Restore, Instant Access, Download Files, Restore Files]

Parameters

Type Name Description Schema Default

Path

backupId
required

The backup ID of the specified image.

string

Query

page[limit]
optional

The number of file contents on one page rounded to the next highest multiple of 50.

integer

200

Responses

HTTP Code Description Schema

202

Generated a request ID for the search.

requestId

400

The format of the backup ID is invalid.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No images were found with the specified backup ID.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /catalog/latest-vmware-images

Description

Gets the list of VMware images based on the specified filters, then only returns the latest backed up image per unique client. If no filters are specified, page[offset] defaults to 0 and page[limit] defaults to 10. All of the filters are based on OData standards. Filtering on the following attributes is supported:

Name Supported Operators Description Schema

vCenter

eq ge gt le lt contains startswith endswith

Specifies the vCenter Server that the machine belonged to.

string

instanceUUID

eq

Specifies the Instance UUID of the machine.

uuid

backupTime

eq ge gt le lt

The backup time range in ISO 8601 format. If one of backupTime eq/ge/gt is not set, backupTime ge is set to 24 hours ago by default.

date-time

vmDisplayName

eq ge gt le lt contains startswith endswith

Specifies the virtual machine display name.

string

vmHostName

eq ge gt le lt contains startswith endswith

Specifies the virtual machine host name.

string

biosUUID

eq ge gt le lt contains startswith endswith

Specifies the virtual machine BIOS UUID.

uuid

vmDNSName

eq ge gt le lt contains startswith endswith

Specifies the virtual machine DNS name.

string

client

eq ge gt le lt contains startswith endswith

Specifies client machine name of the virtual machine.

string

Requires Permission: [View Recovery Points, Recover/Restore, Instant Access, Download Files, Restore Files]

Parameters

Type Name Description Schema Default

Query

filter
optional

The filter criteria in OData format.

string

Query

page[limit]
optional

The number of images on one page.

integer

10

Query

page[offset]
optional

The image record number offset.

integer

0

Responses

HTTP Code Description Schema

200

The list of catalog VMware images was returned successfully.

vmwareImageList

400

Invalid filter criteria.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /catalog/vmware-images

Description

Gets the list of VMWare images based on the specified filters. If no filters are specified, page[offset] defaults to 0 and page[limit] defaults to 10. All of the filters are based on OData standards. Filtering on the following attributes is supported:

Name Supported Operators Description Schema

vCenter

eq ge gt le lt contains startswith endswith

Specifies the vCenter Server that the machine belonged to.

string

instanceUUID

eq

Specifies the Instance UUID of the machine.

uuid

backupTime

eq ge gt le lt

The backup time range in ISO 8601 format. If one of backupTime eq/ge/gt is not set, backupTime ge is set to 24 hours ago by default.

date-time

vmDisplayName

eq ge gt le lt contains startswith endswith

Specifies the virtual machine display name.

string

vmHostName

eq ge gt le lt contains startswith endswith

Specifies the virtual machine host name.

string

biosUUID

eq

Specifies the virtual machine BIOS UUID.

uuid

vmDNSName

eq ge gt le lt contains startswith endswith

Specifies the virtual machine DNS name.

string

client

eq ge gt le lt contains startswith endswith

Specifies client machine name of the virtual machine.

string

Requires Permission: [View Recovery Points, Recover/Restore, Instant Access, Download Files, Restore Files]

Parameters

Type Name Description Schema Default

Query

filter
optional

The filter criteria in OData format.

string

Query

page[limit]
optional

The number of images on one page.

integer

10

Query

page[offset]
optional

The image record number offset.

integer

0

Responses

HTTP Code Description Schema

200

The list of catalog VMWare images was returned successfully.

vmwareImageList

400

Invalid filter criteria.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /catalog/vmware-images/{backupId}

Description

Requests the details of a VMware image. The following relationship may be used in the include parameter:

Name Description

optionalVmwareInfo

Currently includes vmNetworks and vmDisks

Requires Permission: [View Recovery Points, Recover/Restore, Instant Access, Download Files, Restore Files]

Parameters

Type Name Description Schema

Path

backupId
required

The backup ID of the specified VMware image.

string

Query

include
optional

Optional relationships to include.

string

Responses

HTTP Code Description Schema

200

VMware image details returned successfully.

vmwareImageDetail

400

The backup ID is invalid.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The VMware image was not found.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

Definitions

diskInfo

Name Description Schema

filePath
required

The path at which the disk file resides.

string

fileSize
required

The uncompressed size in bytes.

integer (int64)

lastModifiedTime
optional

The ISO 8601 timestamp that indicates when the disk file was last modified.

string (date-time)

errorResponse

Name Description Schema

details
optional

A map containing error field and error field message to provide more context to nature of the error.

object

errorCode
required

The NetBackup error code.

integer (int64)

errorMessage
required

The NetBackup error code description.

string

fragment

Name Description Schema

blockSize
optional

The block size used when writing the backup.

integer

checkpoint
optional

Internal use.

integer

copyDate
optional

For the first fragment of each copy in NetBackup 6.5 and later, the ISO-8601 timestamp on which the copy was written. The value is 0 for versions before NetBackup 6.5.

string (date-time)

copyNumber
optional

The copy number for this record.

integer

dataFormat
optional

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
optional

The NetBackup density of the media written to.

integer

deviceWrittenOn
optional

The device that the copy was written on. This is the tape drive index, or -1 for non-tape media based backups.

integer

expiration
optional

The ISO 8601 timestamp of the expiration date of this copy.

string (date-time)

fileNumber
optional

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
optional

Internal use.

integer

fragmentFlags
optional

Internal use.

integer

fragmentNumber
optional

The fragment number of this record within this copy.

integer

host
optional

The name of the host that wrote this image copy to media.

string

kbytes64
optional

The size of the fragment in kilobytes.

integer

lastBlock
optional

Internal use.

integer

mediaDate
optional

The ISO-8601 formatted timestamp for the tape media.

string (date-time)

mediaDesc
optional

Internal use.

string

mediaId
optional

The media ID or path this fragment is written to.

string

mediaSequenceNumber
optional

Internal use.

integer

mediaSubtype
optional

Internal use.

integer

mediaType
optional

Internal use.

integer

multiplex
optional

Internal use.

integer

offset
optional

Internal use.

integer

remainder
optional

Internal use.

integer

resumeNumber
optional

Internal use.

integer

retentionLevel
optional

Internal use.

integer

slpTryToKeepDate
optional

Internal use.

integer

image

Name Schema

attributes
required

imageAttributes

id
required

string

links
required

links

relationships
optional

imageRelationships

type
required

string

links

Name Schema

self
required

self

self

Name Schema

href
required

string

imageAttributes

Name Description Schema

backupCopyType
required

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)

backupStatus
required

The NetBackup exit status of the backup job.

integer

backupTime
required

The ISO 8601 timestamp used for backup image ID.

string (date-time)

blockIncrementalFullTime
required

The time used for Block Level Incremental Backups (BLIB). A non-zero value indicates the current backup time if BLIB is performed.

integer

clientCharset
required

Integer representation of the character set used when the client calls bpcd.

integer

clientName
required

The name of the client protected by this image.

string

compression
required

Indicates whether software compression is used.

boolean

contentFile
required

The filename of the content (*.f) file.

string

contentFileCompressed
required

Type of compression used on the content file (*.f).

enum (UNKNOWN, NOT, LEGACY, SCRIPT_OLD, SCRIPT_NEW, ZLIB)

contentFileSize
required

The size of content file.

string

creator
required

The user name of backup initiator.

string

dataClassification
required

The data class specified in the policy.

string

drMediaList
required

A list of tape media IDs required for DR.

< string > array

elapsedTimeSeconds
required

The amount of time (in seconds) that the backup took to run to completion.

integer

encryption
required

The type of encryption used.

enum (NONE, LEGACY, CIPHER)

expiration
required

The ISO 8601 timestamp format for the expiration of this image.

string (date-time)

extendedSecurityInfo
required

True if extended security information was used.

boolean

fileSystemOnly
required

This is a type of recovery option.

boolean

fragments
optional

The fragment list for all copies of the image.

< fragment > array

imageDumpLevel
required

The NDMP dump level.

integer

imageType
required

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
required

The backup job ID.

integer

kbytes
required

The number of kilobytes (KB) backed up.

integer

kbytesDataTransferred
required

The number of bytes transferred.

integer

keyword
required

The backup policy keyword.

string

mpx
required

Indicates if the image is multiplexed on tape.

boolean

numCopies
required

The number of copies of this image.

integer

numFiles
required

The number of files backed up.

integer

numberFragments
required

The total number of fragments including all copies, that is, the length of the "fragments" array.

integer

originMasterServer
required

The name of the origin master server.

string

policyName
required

The name of the backup policy.

string

policyType
required

This value describes which agent generated the image. "Standard", "Oracle", "MS-Windows", "VMware", "Hyper-V", "MS-SQL-Server", "MS-Exchange-Server", etc.

string

primaryCopy
required

The default copy to use for restores and duplications.

integer

providerGeneratedId
required

The identifier assigned by the asset’s provider, if any. Prepended with the asset type.

string

proxyClient
required

The host name of the proxy client used for the backup.

string

remoteExpiration
required

The UTC timestamp for the REMOTE expiration of this image. See "Auto Image Replication".

integer

retentionLevel
required

The retention level of the image.

integer

scheduleName
required

The name of the schedule used to create the backup.

string

scheduleType
required

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
required

Indicates that the storage lifecycle policy (SLP) has satisfied all its operations on this image.

integer

slpName
required

The name of the SLP that manages this image.

string

slpVersion
required

The version number of the SLP that manages this image.

integer

snapshotTime
optional

The time in ISO-8601 format when the snapshot was taken.

string (date-time)

tirExpiration
required

The UTC timestamp for the expiration of the True Image Restore (TIR) data.

integer

version
required

The image format version.

integer

vmType
required

The type of virtual machine backed up by this image.

integer

imageContents

Name Schema

data
required

< imageContentsAttributes > array

links
required

links

meta
required

meta

links

Name Description Schema

next
required

Contains a link to the next page of values.

next

next

Name Description Schema

href
required

The URL to obtain the next page of values. For this API, this link should be identical to the current URL.

string

meta

Name Schema

pagination
required

paginationValues

imageContentsAttributes

Name Schema

attributes
required

imageFileContentEntry

id
required

string

type
required

string

imageDetail

Name Schema

data
required

image

imageFileContentEntry

Name Description Schema

blockNumber
required

The block number on which the file resides.

integer (int64)

compressedFileSize
required

The compressed size in bytes. This values is 0 if the file is not compressed.

integer (int64)

deviceNumber
required

The device number of the file or directory.

integer

filePath
required

The path at which the disk file resides.

string

fileSize
required

The actual size in bytes. Directories are reported as 0 bytes.

integer (int64)

group
optional

The group to which the file record belongs.

string

inImageFlag
required

Detects if the file is in the image. Is Set to 0 if file is not in the image. Is Set to 1 if file is in the image. Is Set to 2 if the image contains only True Image Restore data.

integer

inodeLastModified
optional

The ISO 8601 timestamp that indicates when the file’s inode was last modified.

string (date-time)

lastAccessTime
optional

The ISO 8601 timestamp that indicates when the file record was last accessed.

string (date-time)

lastModifiedTime
optional

The ISO 8601 timestamp that indicates when the file record was last modified.

string (date-time)

pathMode
optional

File/directory mode bits in decimal.

integer

rawPartitionSize
required

The size of the raw partition. This value is a non-zero number if the file is a raw partition.

integer

user
optional

The owner of the file record.

string

imageList

Name Schema

data
required

< image > array

meta
required

meta

meta

Name Schema

pagination
required

paginationValues

imageRelationships

Name Schema

vmwareImage
optional

vmwareImage

vmwareImage

Name Schema

data
required

data

links
required

links

data

Name Schema

id
required

string

type
required

string

links

Name Schema

related
required

related

related

Name Schema

href
required

string

optionalVmwareInfo

Name Schema

attributes
required

attributes

id
required

string

type
required

string

attributes

Name Description Schema

vmDisks
required

A list of disks on the image.

< diskInfo > array

vmNetworks
required

A list of the networks to which the machine belongs.

< string > array

vmTemplate
optional

True if the virtual machine is a template.

boolean

vmVersion
required

The version of virtual machine.

string

paginationValues

Name Schema

count
optional

integer

first
optional

integer

last
optional

integer

limit
optional

integer

next
optional

integer

offset
optional

integer

prev
optional

integer

requestId

Name Description Schema

requestId
required

The ID for subsequent requests.

string

vmwareImage

Name Schema

attributes
required

attributes

id
required

string

links
required

links

relationships
required

relationships

type
required

string

attributes

Name Description Schema

backupTime
required

The ISO 8601 timestamp used for backup image ID in ISO-8601 format.

string (date-time)

biosUUID
required

The BIOS UUID of the virtual machine.

string

client
required

The name of the client protected by this image.

string

cluster
required

The cluster that the virtual machine belongs to.

string

clusterPath
required

The data center path of the cluster that the virtual machine belongs to.

string

datacenter
required

The data center of the virtual machine.

string

esxiServer
required

The ESX server name of the virtual machine.

string

instanceUUID
required

The Instance UUID of the virtual machine.

string

ipAddress
required

The IP address of the client that is protected by this image.

string

policyName
required

The name of the backup policy.

string

resourcePoolOrVapp
required

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
required

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
required

The name of the vCloud Director Organization or tenant that a VM belonged to if the backup was a vCloud Director backup.

string

vCDOrgVDC
required

The name of the Virtual DataCenter the VM resided in if the backup was a vCloud Director backup.

string

vCDServer
required

The name of the vCloud Director server if the backup was a vCloud Director backup.

string

vCDVApp
required

The name of the vApp that the VM is part of if the backup was a vCloud Director backup.

string

vCDVmName
required

The logical name of the VM inside the vApp if the backup was a vCloud Director backup.

string

vCenter
required

The name of the vCenter hosting the virtual machine.

string

vmDNSName
required

The DNS name of the virtual machine.

string

vmDisplayName
required

The display name of the virtual machine.

string

vmFolder
required

The datastore path where the virtual machine is stored.

string

vmHostName
required

The host name of the virtual machine.

string

vmxDatastore
required

The name of the datastore where the VM configuration files were located.

string

links

Name Schema

self
required

self

self

Name Schema

href
required

string

relationships

Name Schema

image
required

image

optionalVmwareInfo
optional

optionalVmwareInfo

image

Name Schema

data
required

data

links
required

links

data

Name Schema

id
required

string

type
required

string

links

Name Schema

related
required

related

related

Name Schema

href
required

string

optionalVmwareInfo

Name Schema

data
required

data

data

Name Schema

id
required

string

type
required

string

vmwareImageDetail

Name Schema

data
required

vmwareImage

included
optional

< optionalVmwareInfo > array

vmwareImageList

Name Schema

data
required

< vmwareImage > array

meta
required

meta

meta

Name Schema

pagination
required

paginationValues

Security

rbacSecurity

Type : apiKey
Name : Authorization
In : HEADER

NetBackup Configuration API

Overview

The NetBackup Configuration API provides access to NetBackup configuration.

Version information

Version : 2.0

URI scheme

Host : <masterserver>:1556
BasePath : /netbackup
Schemes : HTTPS

Paths

POST /config/hosts

Description

Creates a host entry in database.

Requires Permission: [Manage Hosts]

Parameters

Type Name Description Schema

Header

X-NetBackup-Audit-Reason
optional

The audit reason for creating the host.

string

Body

Host Data
required

The properties of the host to be added in the database.

postCreateHostRequest

Responses

HTTP Code Description Schema

201

Successfully created a host database entry.
Headers :
Location (string) : The URI of the created host entry.

No Content

400

Bad or invalid request.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

409

The server already exists in the database.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /config/hosts

Description

Gets all hosts information.

Requires Permission: [Manage Hosts]

Responses

HTTP Code Description Schema

200

Successfully fetched all hosts information.

hostsResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

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.

Requires Permission: [Manage Hosts]

Parameters

Type Name Description Schema

Query

isaddedmanually
optional

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
optional

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
optional

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
optional

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
optional

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.

hostsResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /config/hosts/{hostId}

Description

Gets information for the specified host ID.

Requires Permission: [Manage Hosts]

Parameters

Type Name Description Schema

Path

hostId
required

The host ID of the host.

string

Responses

HTTP Code Description Schema

200

Successfully retrieved host information.

hostResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No host exists with host ID.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

PATCH /config/hosts/{hostId}

Description

Updates information for a host with the specified host ID. Only the NetBackup security administrator can update the 'autoReissue' parameter.

Requires Permission: [Manage Hosts]

Parameters

Type Name Description Schema

Header

X-NetBackup-Audit-Reason
optional

The audit reason for updating the host properties.

string

Path

hostId
required

Host ID of the host.

string

Body

Host Properties
required

Properties of the host to be updated.

patchHostProperties

Responses

HTTP Code Description Schema

204

Host information is successfully updated.

No Content

400

Bad or Invalid Request.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No host associated with the specified host ID.

errorResponse

409

The host already exists.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

An unexpected system error occurred.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

PUT /config/hosts/{hostId}/comment

Description

Updates comment for the host that is associated with the specified host ID.

Requires Permission: [Manage Hosts]

Parameters

Type Name Description Schema

Path

hostId
required

The host ID of the host.

string

Body

HostCommentDetails
required

Host-specific comment to be updated.

putHostCommentDetails

Responses

HTTP Code Description Schema

200

Successfully updated the host information.

No Content

400

Bad or invalid request.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No host associated with the specified host ID exists.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

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.

Requires Permission: [Manage Hosts]

Parameters

Type Name Description Schema

Path

hostId
required

Specifies the host ID for which you want to add mappings.

string

Query

isapproved
optional

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.

hostMappingsDetails

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No host exists with specified host ID.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

PUT /config/hosts/{hostId}/hostmappings/{mappedHostName}

Description

Adds mappings for the specified host ID.

Requires Permission: [Manage Hosts]

Parameters

Type Name Description Schema

Header

X-NetBackup-Audit-Reason
optional

Specifies the audit reason for adding the host ID-to-host name mapping.

string

Path

hostId
required

Specifies the host ID for which you want to add mappings.

string

Path

mappedHostName
required

Host ID-to-host name mapping to be added.

string

Body

HostMappingDetails
required

The properties of the host to be mapped.

putAddHostMapping

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.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

409

A conflict in the host ID-to-host name mapping was detected.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

DELETE /config/hosts/{hostId}/hostmappings/{mappedHostName}

Description

Deletes host mappings that are associated with the specified host ID.

Requires Permission: [Manage Hosts]

Parameters

Type Name Description Schema

Header

X-NetBackup-Audit-Reason
optional

Specifies the reason for deleting the host ID-to-host name mapping.

string

Path

hostId
required

Specifies the host ID that is associated with the mapping that you want to delete.

string

Path

mappedHostName
required

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 Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The specified host mapping was not found.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

PUT /config/hosts/{hostId}/reset

Description

Resets the host information that is associated with the specified host ID.

Requires Permission: [Manaage Hosts]

Parameters

Type Name Description Schema

Header

X-NetBackup-Audit-Reason
optional

The audit reason for resetting the host.

string

Path

hostId
required

The host ID of the host.

string

Responses

HTTP Code Description Schema

200

Successfully reset the host entry.

No Content

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No host exists with the specified host ID.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

500

An unexpected system error occurred.

errorResponse

Security

Type Name

apiKey

rbacUserSecurity

GET /config/hosts?name={hostName}

Description

Gets information for a host with name specified.

Requires Permission: [Manage Hosts]

Parameters

Type Name Description Schema

Query

hostName
required

The name of the host.

string

Responses

HTTP Code Description Schema

200

Successfully retrieved host information.

hostResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No host exists with the specified host name.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

POST /config/policies/

Description

Creates the policy. Cloud, Oracle, MS SQL Server, and VMware policy types are supported with the policy type specific schemas. For other policy types, the Generic schema can be used with the request header specified below. The Generic schema exposes all possible values of a policy and depends on the user to provide all values that are relevant to the workload type. Requires Permission: [Manage Policies]

Parameters

Type Name Description Schema

Header

X-NetBackup-Audit-Reason
optional

The audit reason for creating the policy.

string

Header

X-NetBackup-Policy-Use-Generic-Schema
optional

Indicates whether the Generic policy schema is used.

boolean

Body

policyDetails
required

The details of the policy to be created.

policyRequest

Responses

HTTP Code Description Schema

204

Successfully created the policy.
Headers :
ETag (integer) : The current generation ID of the policy.
Location (string (url)) : A link to the created policy.

No Content

400

Failed to parse the JSON body.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

409

The policy already exists.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

An unexpected system error occurred.

errorResponse

501

Not implemented for policies other than Cloud, Oracle, MS SQL Server, and VMware. For other policy types, the Generic schema can be used with the request header X-NetBackup-Policy-Use-Generic-Schema set to true.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /config/policies/

Description

Lists all of the NetBackup policies.

Requires Permission: [Manage Policies]

Responses

HTTP Code Description Schema

200

Successfully retrieved the list of policies.

listPoliciesResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

500

An unexpected system error.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /config/policies/{policyName}

Description

Get the details for a specified policy. Cloud, Oracle, MS SQL Server, and VMware policy types are supported with the policy type specific schemas. For other policy types, the Generic schema will be used. The Generic schema gets all the possible fields of a policy that are not specific to policy type.

Requires Permission: [Manage Policies]

Parameters

Type Name Description Schema

Header

X-NetBackup-Policy-Use-Generic-Schema
optional

Indicates whether the Generic policy schema is used.

boolean

Path

policyName
required

The name of the policy.

string

Responses

HTTP Code Description Schema

200

Successfully retrieved the policy details.
Headers :
ETag (integer) : The current generation ID of the policy.

policyResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The specified policy was not found.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

500

An unexpected system error.

errorResponse

501

Not implemented for policies other than Cloud, Oracle, MS SQL Server, and VMware. For other policy types, the Generic schema can be used with the request header X-NetBackup-Policy-Use-Generic-Schema set to true.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

PUT /config/policies/{policyName}

Description

Updates the policy details with specified policy name. Cloud, Oracle, MS SQL Server, and VMware policy types are supported with the policy type specific schemas. For other policy types, the Generic schema can be used with the request header specified below. The Generic schema exposes all the possible values of a policy and depends on user to provide all values relevant to policy type. Requires Permission: [Manage Policies]

Parameters

Type Name Description Schema

Header

If-Match
optional

The current generation ID of the policy.

string

Header

X-NetBackup-Audit-Reason
optional

The audit reason for updating the policy.

string

Header

X-NetBackup-Policy-Use-Generic-Schema
optional

Indicates whether the Generic policy schema is used.

boolean

Path

policyName
required

The name of the policy.

string

Body

policyDetails
required

The details of the policy to be updated.

policyRequest

Responses

HTTP Code Description Schema

204

Successfully updated the policy.
Headers :
ETag (integer) : The current generation ID of the policy.

No Content

400

Failed to parse the JSON body.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No policy exists with the specified policy name.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

An unexpected system error occurred.

errorResponse

501

Not implemented for policies other than Cloud, Oracle, MS SQL Server, and VMware. For other policy types, the Generic schema can be used with the request header X-NetBackup-Policy-Use-Generic-Schema set to true.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

DELETE /config/policies/{policyName}

Description

Deletes a specified policy.

Requires Permission: [Manage Policies]

Parameters

Type Name Description Schema

Path

policyName
required

The name of the policy.

string

Responses

HTTP Code Description Schema

204

Successfully deleted the policy.

No Content

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No policy exists with the specified policy name.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

500

An unexpected system error occurred.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

Unknown

rbacSecurity

PUT /config/policies/{policyName}/backupselections

Description

Replaces the existing backup selections with the specified list of backup selections.

Requires Permission: [Manage Policies]

Parameters

Type Name Description Schema

Header

If-Match
optional

The generation ID of the policy.

string

Header

X-NetBackup-Audit-Reason
optional

The audit reason for changing the policy.

string

Path

policyName
required

The name of the policy.

string

Body

backupSelections
required

The list of paths for the policy backup.

putIncludeRequest

Responses

HTTP Code Description Schema

204

Successfully updated the backup selections.

No Content

400

Failed to parse the JSON body.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The specified policy was not found.

errorResponse

412

A conditional update failed because of mismatched generation IDs.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

Unexpected system error.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

DELETE /config/policies/{policyName}/backupselections

Description

Removes the existing backup selections for the specified policy.

Requires Permission: [Manage Policies]

Parameters

Type Name Description Schema

Header

If-Match
optional

The generation ID of the policy.

string

Header

X-NetBackup-Audit-Reason
optional

The audit reason for changing the policy.

string

Path

policyName
required

The name of the policy.

string

Responses

HTTP Code Description Schema

204

Successfully removed the backup selection.

No Content

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The specified policy was not found.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

412

A conditional update failed because of mismatched generation IDs.

errorResponse

500

Unexpected system error.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

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.

Requires Permission: [Manage Policies]

Parameters

Type Name Description Schema

Header

If-Match
optional

The generation ID of the policy.

string

Header

X-NetBackup-Audit-Reason
optional

The audit reason for changing the policy.

string

Path

clientName
required

The host name of the client.

string

Path

policyName
required

The name of the policy.

string

Body

client
required

The client to be backed up.

putClientRequest

Responses

HTTP Code Description Schema

201

Successfully added a client, instance group, instance, or database for the specified policy.
Headers :
ETag (integer) : The current generation ID of the policy.

No Content

204

Successfully updated the specified client in the policy.

No Content

400

Failed to parse the JSON body.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The specified policy was not found.

errorResponse

412

A conditional update failed because of mismatched generation IDs.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

Unexpected system error.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

DELETE /config/policies/{policyName}/clients/{clientName}

Description

Removes the existing client for the specified policy.

Requires Permission: [Manage Policies]

Parameters

Type Name Description Schema

Header

If-Match
optional

The generation ID of the policy.

string

Header

X-NetBackup-Audit-Reason
optional

The audit reason for changing the policy.

string

Path

clientName
required

The host name of the client.

string

Path

policyName
required

The name of the policy.

string

Responses

HTTP Code Description Schema

204

Successfully removed the client.

No Content

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The specified policy or client was not found.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

412

A conditional update failed because of mismatched generation IDs.

errorResponse

500

Unexpected system error.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

PUT /config/policies/{policyName}/schedules/{scheduleName}

Description

Adds or updates a schedule in the specified policy.

Requires Permission: [Manage Policies]

Parameters

Type Name Description Schema

Header

If-Match
optional

The generation ID of the policy.

string

Header

X-NetBackup-Audit-Reason
optional

The audit reason for changing the policy.

string

Path

policyName
required

The name of the policy.

string

Path

scheduleName
required

The name of the schedule.

string

Body

schedule
required

The policy schedule to add or update.

putScheduleRequest

Responses

HTTP Code Description Schema

201

Successfully created the schedule.
Headers :
ETag (integer) : The current generation ID of the policy.

No Content

204

Successfully updated the schedule.

No Content

400

Failed to parse the JSON body.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The specified policy was not found.

errorResponse

412

A conditional update failed because of mismatched generation IDs.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

Unexpected system error.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

DELETE /config/policies/{policyName}/schedules/{scheduleName}

Description

Removes a schedule from the specified policy.

Requires Permission: [Manage Policies]

Parameters

Type Name Description Schema

Header

If-Match
optional

The generation ID of the policy.

string

Header

X-NetBackup-Audit-Reason
optional

The audit reason for changing the policy.

string

Path

policyName
required

The name of the policy.

string

Path

scheduleName
required

The name of the schedule.

string

Responses

HTTP Code Description Schema

204

Successfully deleted the schedule.

No Content

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The specified policy or schedule was not found.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

412

A conditional update failed because of mismatched generation IDs.

errorResponse

500

Unexpected system error.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /config/retentionlevels

Description

Get all retention levels.

Requires Permission: [Manage NetBackup]

Responses

HTTP Code Description Schema

200

Successfully fetched all retention levels.

retentionLevelResponseArray

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Cannot get retention levels.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /config/servers/trusted-master-servers

Description

Gets the list of all trusted master servers.

Requires Permission: [Manage Hosts]

Responses

HTTP Code Description Schema

200

Successfully returned the list of all trusted master servers.

getTrustedMasterServersResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

POST /config/servers/vmservers

Description

Creates VM server credentials.

Requires Permission: [Manage Appservers and Asset Groups]

Parameters

Type Name Schema

Body

vmserver
required

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.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

An unexpected system error occurred.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /config/servers/vmservers

Description

Retrieves the list of VM server credentials based on the specified filters. If no filters are specified, information for all the VM server credentials are retrieved. All the filters are based on OData standards. Filtering is supported for the following attributes:

Name Supported Operators Description Schema

serverName

eq ne ge gt le lt contains startswith endswith

Specifies the VM server name.

string

serverType

eq ne

Specifies the VM server’s server type.

string

Requires Permission: [Manage Assets, Manage Appservers and Asset Groups]

Parameters

Type Name Description Schema

Query

filter
optional

Specifies filters according to OData standards.

string

Responses

HTTP Code Description Schema

200

Successfully retrieved the list of VM server credentials.

vmserverResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /config/servers/vmservers/{serverName}

Description

Lists the VM server credentials.

Requires Permission: [Manage Assets, Manage Appservers and Asset Groups]

Parameters

Type Name Schema

Path

serverName
required

string

Responses

HTTP Code Description Schema

200

VM server credentials found.

vmserverResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No VM server credentials found.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /config/servers/wssendpoints

Description

Lists all the hosts that serve as NetBackup WebSocket servers.

Requires Permission: [Manage NetBackup]

Responses

HTTP Code Description Schema

200

List of available hosts.

hostGenericSchemaArray

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.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.

Requires Permission: [Manage NetBackup]

Parameters

Type Name Description Schema

Body

Host configuration
required

The details for the host.

hostGenericSchema

Responses

HTTP Code Description Schema

201

The host was added successfully to the list of NetBackup WebSocket Servers.

emptyResponse

400

Bad request.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

The certificate did not match with the one accepted by the user.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.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.

Requires Permission: [Manage NetBackup]

Parameters

Type Name Description Schema

Body

Host configuration
required

The hostname and state to update.

updateHostSchema

Responses

HTTP Code Description Schema

200

Host details saved successfully.

emptyResponse

400

Bad request.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

An unexpected system error occurred.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

POST /config/servers/wssendpoints/validatehost

Description

Checks if the host is valid using the information provided in the JSON file.

Requires Permission: [Manage NetBackup]

Parameters

Type Name Description Schema

Body

Host configuration
required

The details for the host.

hostGenericSchema

Responses

HTTP Code Description Schema

200

Host validation successful.

hostGenericSchema

400

Bad request.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

Unable to establish a connection to the specified URL.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

POST /config/servers/wssendpoints/validateurl

Description

Checks if the host is valid using the URL provided.

Requires Permission: [Manage NetBackup]

Parameters

Type Name Description Schema

Body

URL
required

The NetBackup WebSocket Service (WSS) endpoint URL.

urlSchema

Responses

HTTP Code Description Schema

200

Host validation successful.

hostGenericSchema

400

Bad request.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

An unexpected system error occurred.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

DELETE /config/servers/wssendpoints/{hostName}

Description

Deletes the specified host name from the NetBackup WebSocket servers list.

Requires Permission: [Manage NetBackup]

Parameters

Type Name Description Schema

Path

hostName
required

The host name of the host to delete.

string

Responses

HTTP Code Description Schema

200

The host name was deleted successfully.

emptyResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The host name could not be found.

emptyResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

POST /config/slps

Description

Create a new storage lifecycle policy (SLP).

Requires Permission: [Manage SLPs]

Parameters

Type Name Description Schema

Header

X-NetBackup-Audit-Reason
optional

The audit reason for creating the storage lifecycle policy (SLP).

string

Body

body
required

The storage lifecycle policy (SLP) definition to add.

postCreateSlpRequest

Responses

HTTP Code Description Schema

201

Successfully created the storage lifecycle policy (SLP).
Headers :
Location (string) : URI of the created storage lifecycle policy (SLP) entry.

postCreateSlpRequest

400

Bad Request.

createSLPErrorResponse

401

Authentication failed.

errorResponse

409

A storage lifecycle policy (SLP) with the same name already exists.

errorResponse

500

Internal Server Error.

SLPInternalServerError

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /config/slps

Description

Obtains a list of all defined storage lifecycle policies (SLPs).

Requires Permission: [Manage SLPs]

Responses

HTTP Code Description Schema

200

Successfully returned the list of storage lifecycle policies (SLPs).

getSLPsResponse

401

Authentication failed.

errorResponse

500

Internal Server Error.

SLPInternalServerError

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /config/slps/{slpName}

Description

Returns the definition of the storage lifecycle policy (SLP). By default, the latest version is returned.

Requires Permission: [Manage SLPs]

Parameters

Type Name Description Schema

Path

slpName
required

The name of the storage lifecycle policy (SLP).

string

Responses

HTTP Code Description Schema

200

Successfully returned the details of the storage lifecycle policy (SLP).

getSLPResponse

401

Authentication failed.

errorResponse

404

A storage lifecycle policy with the specified name was not found.

errorResponse

500

Internal Server Error.

SLPInternalServerError

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

DELETE /config/slps/{slpName}

Description

Removes the storage lifecycle policy (SLP)

Requires Permission: [Manage SLPs]

Parameters

Type Name Description Schema

Path

slpName
required

The name of the storage lifecycle policy (SLP).

string

Responses

HTTP Code Description Schema

204

Successfully removed the storage lifecycle policy (SLP).

No Content

401

Authentication failed.

errorResponse

404

The specified storage lifecycle policy (SLP) was not found.

errorResponse

409

The specified storage lifecycle policy (SLP) is used in one or more backup policies, or the execution of the SLP is in progress.

errorResponse

500

Internal Server Error.

SLPInternalServerError

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

PATCH /config/slps/{slpName}

Description

Updates specified attributes of the storage lifecycle policy (SLP)

Requires Permission: [Manage SLPs]

Parameters

Type Name Description Schema

Header

X-NetBackup-Audit-Reason
optional

The audit reason for updating the storage lifecycle policy (SLP) attributes.

string

Path

slpName
required

The name of the storage lifecycle policy (SLP).

string

Body

body
required

The storage lifecycle policy (SLP) attributes to update.

patchSlpRequest

Responses

HTTP Code Description Schema

200

Successfully updated the storage lifecycle policy (SLP).

postCreateSlpRequest

400

Bad Request.

createSLPErrorResponse

401

Authentication failed.

createSLPErrorResponse

404

The specified storage lifecycle policy (SLP) was not found.

createSLPErrorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /config/slps/{slpName}/versions/{versionNumber}

Description

Returns the definition of the storage lifecycle policy (SLP) for the specified version.

Requires Permission: [Manage SLPs]

Parameters

Type Name Description Schema

Path

slpName
required

The name of the storage lifecycle policy (SLP).

string

Path

versionNumber
required

The version of the storage lifecycle policy (SLP).

integer

Responses

HTTP Code Description Schema

200

Successfully returned the details of the storage lifecycle policy (SLP).

getSLPResponse

404

A storage lifecycle policy with the specified name or version was not found.

errorResponse

500

Internal Server Error.

SLPInternalServerError

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /config/smtpserver

Description

Fetches the SMTP server configuration.

Requires Permission: [Manage NetBackup]

Responses

HTTP Code Description Schema

200

Successfully fetched the SMTP configuration details.

smtpConfigurationGetResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Resource cannot be found.

errorResponse

500

System error occurred.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

PUT /config/smtpserver

Description

Creates a new SMTP server configuration or updates an existing configuration.

Requires Permission: [Manage NetBackup]

Parameters

Type Name Description Schema

Body

smtpConfigurationRecord
required

JSON object for the SMTP server configuration.

smtpConfigurationRequest

Responses

HTTP Code Description Schema

204

Successfully added or updated the SMTP server configuration.

No Content

400

Bad request, invalid parameter with request payload.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

500

System error occurred.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /config/snapshotproviders/configuredplugins

Description

Returns the list of configured plug-in types.

Requires Permission: [Manage Cloud Appservers]

Responses

HTTP Code Description Schema

200

Successfully returned the list of configured plug-in types.

pluginTypeResponseArray

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

405

Method not allowed. The specified HTTP operation is invalid.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

POST /config/snapshotproviders/configuredplugins/{pluginType}/instances

Description

Adds a new configuration instance for the plug-in for Integrated Snapshot Management.

Requires Permission: [Manage Cloud Appservers]

Parameters

Type Name Description Schema

Path

pluginType
required

The type of plug-in. This value can be retrieved from GET /config/snapshotproviders/supportedplugins API. For example, "aws" or "azure".

string

Body

configurationRequest
required

The details of the configuration instance for the plug-in.

configurationRequest

Responses

HTTP Code Description Schema

201

Successfully added the configuration instance.
Headers :
Location (string (url)) : A link to the configuration instance of the plug-in.

configurationResponse

400

Bad request. The body of the request is not valid.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The specified plug-in type is not supported for the cloud vendor.

errorResponse

405

Method not allowed. The specified HTTP operation is invalid.

errorResponse

409

A configuration instance with the same configuration details already exists.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /config/snapshotproviders/configuredplugins/{pluginType}/instances

Description

Returns the details of the configuration instances added to the specified plug-in type.

Requires Permission: [Manage Cloud Appservers]

Parameters

Type Name Description Schema

Path

pluginType
required

The type of plug-in. This value can be retrieved from GET /config/snapshotproviders/supportedplugins API. For example, "aws" or "azure".

string

Responses

HTTP Code Description Schema

200

Successfully returned the details of the configuration instances added to the specified plug-in type.

configurationResponseArray

400

Bad request.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The specified plug-in type is not supported for the cloud vendor.

errorResponse

405

Method not allowed. The specified HTTP operation is invalid.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /config/snapshotproviders/configuredplugins/{pluginType}/instances/{instanceName}

Description

Returns the details of the specified configuration instance.

Requires Permission: [Manage Cloud Appservers]

Parameters

Type Name Description Schema

Path

instanceName
required

The unique name that is specified by the NetBackup user for the configuration instance.

string

Path

pluginType
required

The type of plug-in. This value can be retrieved from GET /config/snapshotproviders/supportedplugins API. For example, "aws" or "azure".

string

Responses

HTTP Code Description Schema

200

Successfully returned the details of the specified configuration instance.

configurationResponse

400

Bad request.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The specified plug-in type or configuration instance not found.

errorResponse

405

Method not allowed. The specified HTTP operation is invalid.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

PUT /config/snapshotproviders/configuredplugins/{pluginType}/instances/{instanceName}

Description

Updates the existing configuration instance of the plug-in.

Requires Permission: [Manage Cloud Appservers]

Parameters

Type Name Description Schema

Path

instanceName
required

The unique name that is specified by the NetBackup user for the configuration instance.

string

Path

pluginType
required

The type of plug-in. This value can be retrieved from GET /config/snapshotproviders/supportedplugins API. For example, "aws" or "azure".

string

Body

configurationRequest
required

The details of configuration instance for the plug-in.

configurationRequest

Responses

HTTP Code Description Schema

200

Successfully updated the existing configuration instance of the plug-in.
Headers :
Location (string (url)) : A link to the configuration instance of the plug-in.

configurationResponse

400

Bad request. The body of the request is not valid.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The specified plug-in type or configuration instance not found.

errorResponse

405

Method not allowed. The specified HTTP operation is invalid.

errorResponse

409

A configuration instance with the same configuration details already exists.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

PATCH /config/snapshotproviders/configuredplugins/{pluginType}/instances/{instanceName}

Description

Updates few attributes of specified configuration instance.

Requires Permission: [Manage Cloud Appservers]

Parameters

Type Name Description Schema

Path

instanceName
required

The unique name that is specified by the NetBackup user for the configuration instance.

string

Path

pluginType
required

The type of plug-in. This value can be retrieved from GET /config/snapshotproviders/supportedplugins API. For example, "aws" or "azure".

string

Body

configurationPatchRequest
required

The details of configuration instance for the plug-in.

configurationPatchRequest

Responses

HTTP Code Description Schema

200

Successfully updated the existing configuration instance of the plug-in.
Headers :
Location (string (url)) : A link to the configuration instance of the plug-in.

configurationResponse

400

Bad request. The body of the request is not valid.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The specified plug-in type or configuration instance not found.

errorResponse

405

Method not allowed. The specified HTTP operation is invalid.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /config/snapshotproviders/supportedplugins

Description

Returns the list of all supported plug-in types.

Requires Permission: [Manage Cloud Appservers]

Responses

HTTP Code Description Schema

200

Successfully returned the list of supported plug-in types.

supportedPluginResponseArray

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /config/snapshotproviders/supportedplugins/{pluginType}

Description

Returns the configuration attributes of the specified plug-in type.

Requires Permission: [Manage Cloud Appservers]

Parameters

Type Name Description Schema

Path

pluginType
required

The type of plug-in. This value can be retrieved from GET /config/snapshotproviders/supportedplugins API. For example, "aws" or "azure".

string

Responses

HTTP Code Description Schema

200

Successfully returned the configuration attributes of the specified plug-in type.

supportedPluginResponse

400

Bad request.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The specified plug-in type is not supported for the cloud vendor.

errorResponse

405

Method not allowed. The specified HTTP operation is invalid.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /config/workloads/vmware/vcenter-recovery-topologies/{vcenter-id}

Description

Gets the vCenter recovery topology information for the given vCenter ID.

Requires Permission: [Recover/Restore]

Parameters

Type Name Description Schema

Path

vcenter-id
required

The ID of the vCenter. This ID is the server name and must match the name (short name or fully qualified domain name) that was specified when the server was added.

string

Responses

HTTP Code Description Schema

200

Successfully returned the vCenter topology information for the specified vCenter ID.

workloadData

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No entity found.

errorResponse

500

An unexpected system error occurred.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

Example HTTP response

Response 200
{
  "data" : {
    "links" : {
      "self" : {
        "href" : "/config/workloads/vmware/vcenter-recovery-topologies/b3079apphp2b6.engba.veritas.com"
      }
    },
    "type" : "/vmware/vcenter-topologies",
    "id" : "b3079apphp2b6.engba.veritas.com",
    "attributes" : {
      "hierarchy" : {
        "type" : "VCENTER",
        "name" : "b3079apphp2b6.engba.veritas.com",
        "children" : [ {
          "type" : "DATACENTER",
          "name" : "ha-datacenter",
          "children" : [ {
            "type" : "HOST",
            "name" : "b3079apphp2b6.engba.veritas.com",
            "children" : [ ]
          } ]
        } ]
      }
    }
  }
}

GET /config/workloads/vmware/vcenter-topologies/{vcenter-id}

Description

Gets the vCenter topology information for the given vCenter ID.

Requires Permission: [Recover/Restore]

Parameters

Type Name Description Schema

Path

vcenter-id
required

The ID of the vCenter. This ID is the server name and must match the name (short name or fully qualified domain name) that was specified when the server was added.

string

Responses

HTTP Code Description Schema

200

Successfully returned the vCenter topology information for the specified vCenter ID.

workloadData

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No entity found.

errorResponse

500

An unexpected system error occurred.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

Example HTTP response

Response 200
{
  "data" : {
    "links" : {
      "self" : {
        "href" : "/config/workloads/vmware/vcenter-recovery-topologies/b3079apphp2b6.engba.veritas.com"
      }
    },
    "type" : "/vmware/vcenter-topologies",
    "id" : "b3079apphp2b6.engba.veritas.com",
    "attributes" : {
      "hierarchy" : {
        "type" : "VCENTER",
        "name" : "b3079apphp2b6.engba.veritas.com",
        "children" : [ {
          "type" : "DATACENTER",
          "name" : "ha-datacenter",
          "children" : [ {
            "type" : "HOST",
            "name" : "b3079apphp2b6.engba.veritas.com",
            "children" : [ ]
          } ]
        } ]
      }
    }
  }
}

GET /config/workloads/vmware/vcenters/{vcenter-id}/esxiservers/{esxiserver-id}/datastores

Description

Returns the list of datastores available for the given host or cluster on the specified vCenter.

Requires Permission: [Recover/Restore]

Parameters

Type Name Description Schema

Path

esxiserver-id
required

The name of the host or cluster exactly as configured in the VMware server topology view whether short or fully-qualified.

string

Path

vcenter-id
required

The ID of the vCenter. This ID is the server name and must match the name (short name or fully qualified domain name) that was specified when the server was added.

string

Responses

HTTP Code Description Schema

200

Successfully returned the list of datastores available for the given host or cluster on the specified vCenter.

datastoreResource

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No entity found.

errorResponse

500

An unexpected system error occurred.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

Example HTTP response

Response 200
{
  "data" : {
    "links" : {
      "self" : {
        "href" : "/config/workloads/vmware/vcenters/dummy.vcenter.server.com/esxiservers/dummy.esxi.server.com/datastores"
      }
    },
    "type" : "datastores",
    "id" : "dummy.vcenter.server.com_dummy.esxi.server.com",
    "attributes" : {
      "datastores" : [ {
        "name" : "hp2b12-ds1",
        "type" : "VMFS",
        "freeSpaceInBytes" : 34354676834,
        "physicalDevice" : "ds:///vmfs/volumes/57f6dc7d-83dd7f32-6849-0017a477049c",
        "children" : [ ]
      } ]
    }
  }
}

GET /config/workloads/vmware/vcenters/{vcenter-id}/esxiservers/{esxiserver-id}/networks

Description

Returns the list of networks available for the given host or cluster on the specified vCenter.

Requires Permission: [Recover/Restore]

Parameters

Type Name Description Schema

Path

esxiserver-id
required

The name of the host or cluster exactly as configured in the VMware server topology view whether short or fully-qualified.

string

Path

vcenter-id
required

The ID of the vCenter. This ID is the server name and must match the name (short name or fully qualified domain name) that was specified when the server was added.

string

Responses

HTTP Code Description Schema

200

Successfully returned the list of networks available for the given host or cluster on the specified vCenter.

networkResource

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No entity found.

errorResponse

500

An unexpected system error occurred.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

Example HTTP response

Response 200
{
  "data" : {
    "links" : {
      "self" : {
        "href" : "/config/workloads/vmware/vcenters/dummy.vcenter.server.com/esxiservers/dummy.esxi.server.com/networks"
      }
    },
    "type" : "networks",
    "id" : "dummy.vcenter.server.com_dummy.esxi.server.com",
    "attributes" : {
      "networks" : [ "VM Network1", "VM Network2", "VM Network3" ]
    }
  }
}

GET /config/workloads/vmware/vcenters/{vcenter-id}/esxiservers/{esxiserver-id}/resource-pools

Description

Returns the list of resource pools available for the given host or cluster on the specified vCenter.

Requires Permission: [Recover/Restore]

Parameters

Type Name Description Schema

Path

esxiserver-id
required

The name of the host or cluster exactly as configured in the VMware server topology view whether short or fully-qualified.

string

Path

vcenter-id
required

The ID of the vCenter. This ID is the server name and must match the name (short name or fully qualified domain name) that was specified when the server was added.

string

Responses

HTTP Code Description Schema

200

Successfully returned the list of resource pools available for the given host or cluster on the specified vCenter.

resourcePoolResource

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No entity found.

errorResponse

500

An unexpected system error occurred.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

Example HTTP response

Response 200
{
  "data" : {
    "links" : {
      "self" : {
        "href" : "/config/workloads/vmware/vcenters/dummy.vcenter.server.com/esxiservers/dummy.esxi.server.com/resource-pools"
      }
    },
    "type" : "resourcepools",
    "id" : "dummy.vcenter.server.com_dummy.esxi.server.com",
    "attributes" : {
      "resourcePools" : [ {
        "name" : "MTV",
        "type" : "ResourcePool",
        "path" : "/Minions-DC/host/dummy.esxi.server.com/Resources/MTV",
        "children" : [ ]
      }, {
        "name" : "ROS",
        "type" : "ResourcePool",
        "path" : "/Minions-DC/host/dummy.esxi.server.com/Resources/ROS",
        "children" : [ ]
      } ]
    }
  }
}

Definitions

SLPInternalServerError

Name Description Schema

details
optional

A mapping of error code to error description to provide more context about the nature of the error.

object

errorCode
required

The NetBackup error code.

integer (int64)

errorMessage
required

The NetBackup error code description.

string

configAttributeList

Name Description Schema

multivalue
optional

< string > array

name
required

The name of the key for the key-value pair. For example, an access key or a list of regions. The value of this key can be either singlevalue or multivalue.

string

singlevalue
optional

The value of the key. For example, the user name for an access key or the password for a Secret Access Key.

string

configAttributes

Name Schema

configurationAttributes
required

< configAttributeList > array

configPatchAttribute

Name Description Schema

isDisable
required

Indicates whether asset discovery for this configuration instance is enabled.

boolean

configinstanceAttributes

Name Description Schema

attributeType
optional

The type of attribute.

string

attributeValue
optional

The list of possible values for the attribute. For example, valid names of the supported regions for a cloud provider.

< string > array

caseSensitive
optional

Indicates if this attribute is case-sensitive.

boolean

displayName
optional

The external (displayed on the interface) name of the attribute. For example, "Access Key" or "Secret Key".

string

isAttributeList
optional

Indicates if this attribute supports list operations.

boolean

isAttributeRequired
optional

Indicates if this attribute is mandatory.

boolean

name
optional

The internal name of the attribute. For example, "accesskey" or "secretkey".

string

configurationPatchRequest

Name Schema

data
required

configurationPatchRequestData

configurationPatchRequestData

Name Description Schema

attributes
required

configPatchAttribute

id
required

The unique name that is specified by the NetBackup user for the configuration instance.

string

type
required

The type of resource. For example, "plugininstance".

enum (plugininstance)

configurationRequest

Name Schema

data
required

configurationRequestData

configurationRequestData

Name Description Schema

attributes
required

configAttributes

id
required

The unique name that is specified by the NetBackup user for the configuration instance.

string

type
required

The type of resource. For example, "plugininstance".

enum (plugininstance)

configurationResponse

Name Schema

data
required

configurationResponseData

configurationResponseArray

Name Schema

data
required

< configurationResponse > array

configurationResponseData

Name Description Schema

attributes
required

instanceResponse

id
required

The unique name that is specified by the NetBackup user for the configuration instance.

string

links
required

links

type
required

The type of resource. For example, "plugininstance".

enum (plugininstance)

links

Name Schema

self
required

self

self

Name Schema

href
optional

string

configuredPluginMetadata

Name Description Schema

name
required

The valid name of the plug-in type. For example, for Amazon AWS the name value is "aws".

string

pluginInstanceCount
required

The configured instances count of the plug-in.

integer

configuredPluginType

Name Description Schema

attributes
optional

The metadata for the plug-in.

configuredPluginMetadata

id
required

The unique identifier (name) of the plug-in type. For example, the unique identifier for Amazon AWS is "aws".

string

links
required

links

type
optional

The type of resource. For example, "plugin".

enum (plugin)

links

Name Schema

self
required

self

self

Name Schema

href
optional

string

createSLPErrorResponse

Name Description Schema

details
optional

A mapping of error code to error description to provide more context about the nature of the error.

object

errorCode
required

The NetBackup error code.

integer (int64)

errorMessage
required

The NetBackup error code description.

string

operationErrors
optional

List of errors in POST storage lifecycle policy (SLP) operations.

< createSLPOperationError > array

createSLPOperationError

Name Description Schema

errorCode
required

The NetBackup error code.

integer (int64)

errorMessage
required

The NetBackup error code description for an invalid operation.

string

operationId
required

'The operation index that corresponds to the identified invalid operation. This index is generated based on the sequence of operations in input payload. A value of "0" indicates an error in the entire storage lifecycle policy (SLP).'

integer

datastoreNode

The properties of the datastore.

Name Description Schema

children
optional

< datastoreNode > array

freespace
optional

The size in Bytes.

integer (int64)

name
optional

string

physicalDevice
optional

string

type
optional

string

datastoreResource

The properties of the list of datastores available on the ESXi or Cluster server.

Name Schema

data
optional

data

data

Name Schema

attributes
optional

attributes

id
optional

string

links
optional

links

type
optional

string

attributes

Name Description Schema

datastores
optional

The list of datastores.

< datastoreNode > array

links

Name Schema

self
optional

self

self

Name Schema

href
optional

string

emptyResponse

Type : object

errorResponse

Name Description Schema

details
optional

A map containing error field and error field message to provide more context to nature of the error.

object

errorCode
required

The NetBackup error code.

integer (int64)

errorMessage
required

The NetBackup error code description.

string

getSLPResponse

Name Schema

data
optional

slpDefinition

getSLPsResponse

Name Schema

data
optional

< slpDefinition > array

links
optional

links

meta
optional

meta

links

Name Schema

first
optional

first

last
optional

last

next
optional

next

prev
optional

prev

self
optional

self

first

Name Schema

href
optional

string

last

Name Schema

href
optional

string

next

Name Schema

href
optional

string

prev

Name Schema

href
optional

string

self

Name Schema

href
optional

string

meta

Name Schema

pagination
optional

pagination

pagination

Name Schema

count
optional

integer

first
optional

integer

last
optional

integer

limit
optional

integer

next
optional

integer

offset
optional

integer

page
optional

integer

pages
optional

integer

prev
optional

integer

getTrustedMasterServersResponse

Name Schema

data
optional

< data > array

links
optional

links

data

Name Schema

attributes
optional

attributes

id
optional

string

type
optional

enum (trustedMasterServer)

attributes

Name Schema

trustedMasterServerName
optional

string

links

Name Schema

self
optional

self

self

Name Schema

href
optional

string

hostGenericSchema

Name Description Schema

certificate
required

The signing certificate that is provided by the master server to establish a secure connection.

string

connectionState
optional

Indicates whether or not the host is connected. Possible values are null, connected, and disconnected.

enum (CONNECTED, DISCONNECTED)

groupId
required

The group identifier of the host.

string

hostName
required

The host name for the communicating host.

string

priority
required

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
optional

Indicates the state of the host. Possible values are null, activated, and deactivated.

enum (ACTIVATED, DEACTIVATED)

token
required

The authentication token that is required to make API calls.

string

url
required

The NetBackup WebSocket Service (WSS) endpoint URL.

string

hostGenericSchemaArray

Type : < hostGenericSchema > array

hostMappingsDetails

Name Description Schema

hostMappings
optional

The list of host mappings associated with the specified host.

< mappingDetails > array

timeToLiveInMin
optional

The time duration (in minutes) for which the response provided by the URI is valid.

integer

hostResponse

Name Description Schema

autoReissue
required

Specifies whether the host requires a reissue token to reissue a certificate or not.

boolean

autoReissueDuration
required

The time duration (in milliseconds) for which the certificate can be deployed on the host without requiring a reissue token.

number

comment
required

Comment provided for the host.

string

cpuArchitecture
required

The CPU architecture of the host.

string

createdDateTime
required

The time that the host entry was made, in UTC.

integer

hostMappings
required

The list of host mappings that are associated with the host.

< mappingDetails > array

hostName
required

The name of the host.

string

hwDescription
required

The hardware description of the host.

string

installedEEBs
required

The NetBackup EEBs that are installed on the host.

string

isSecureEnabled
required

Specifies whether the host can communicate securely or not.

boolean

lastUpdatedDateTime
required

The time when the host entry was last updated, in UTC.

integer

masterServer
required

The NetBackup master server that is associated with the host.

string

nbuVersion
required

The NetBackup version on the host.

string

osType
required

The operating system type of the host.

string

osVersion
required

The operating system of the host.

string

servers
required

A list of servers associated with the host.

< string > array

uuid
required

The unique ID of the host.

string

hostStatus

Name Description Schema

connectionDecision
required

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
required

The NetBackup error code.

integer

errorMessage
required

NetBackup error code string that describes the error code.

string

hostId
optional

The host ID of the peer host.

string

timeToLiveInMin
required

The time duration (in minutes) for which the response provided by the URI is valid.

integer

hostsResponse

Name Schema

hosts
optional

< hostResponse > array

instanceResponse

Name Description Schema

configID
optional

The unique configuration instance identifier.

string

configurationAttributes
optional

< configAttributeList > array

errMsg
optional

The error message to display if the configuration instance of the plug-in fails.

string

isDisable
optional

Indicates whether asset discovery for this configuration instance is enabled.

boolean

status
optional

The status of the configured instance of the plug-in.

string

listPoliciesResponse

Name Schema

data
optional

< data > array

data

Name Description Schema

attributes
optional

object

id
optional

The name of the policy.

string

links
optional

A list of URIs to get more information about each policy.

links

type
optional

The type of the policy.

string

links

Name Schema

self
optional

self

self

Name Description Schema

href
optional

A link to the policy details.

string

listVmserverResponse

Name Schema

data
optional

< data > array

data

Name Schema

attributes
optional

attributes

id
optional

string

links
optional

links

type
optional

string

attributes

Name Schema

vmServer
optional

vmserver

links

Name Schema

self
optional

self

self

Name Schema

href
optional

string

mappingDetails

Name Description Schema

createdOn
required

The time the host ID-to-host name mapping was created, in UTC.

integer (int64)

isAddedManually
required

Specifies whether the mapping was added manually or not.

boolean

isApproved
required

Specifies whether the new mapping is approved or not.

boolean

isConflicting
required

Specifies whether mapping already exists for another host ID.

boolean

isShared
required

Specifies whether the mapping is shared across hosts.

boolean

mappedHostName
required

The name of the mapped host that is associated with the mapping details.

string

origin
required

Specifies how the host ID-to-host name mapping was added.

enum (CERTIFICATE_DEPLOYMENT, USER_ADDED, HOST_DISCOVERY, COMMUNICATION_DISCOVERY, ADD_HOST)

updatedOn
required

Specifies the time when the host ID-to-host name mapping was last updated.

integer (int64)

msdpServerAttributes

Name Description Schema

caCertHash
required

SHA-1 hash of the associated CA certificate for the given host ID.

string

hostname
required

The MSDP machine name associated with the given host ID.

string

lastUpdateDateTimeUTC
required

The ISO 8601 formatted time when this record was last updated.

string (date-time)

msdpServerCredResponse

Name Description Schema

hostname
required

The MSDP host name that corresponds to the given host id.

string

password
optional

The encrypted password of MSDP.

string

username
optional

The username of MSDP.

string

msdpServerResponse

Name Schema

data
required

msdpServerResponseData

msdpServerResponseArray

Name Schema

data
required

< msdpServerResponseData > array

msdpServerResponseData

Name Description Schema

attributes
required

msdpServerAttributes

id
required

NetBackup host ID; used as unique ID to identify MSDP hosts.

string

type
required

enum (msdpServerCACertHash)

networkResource

The properties of the list of networks available on the ESXi or Cluster server.

Name Schema

data
optional

data

data

Name Schema

attributes
optional

attributes

id
optional

string

links
optional

links

type
optional

string

attributes

Name Description Schema

networks
optional

The list of networks.

< string > array

links

Name Schema

self
optional

self

self

Name Schema

href
optional

string

patchHostProperties

Name Description Schema

autoReissue
optional

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
optional

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
optional

The CPU architecture of the host.

string

hostName
optional

The name of the host.

string

hwDescription
optional

The hardware description of the host.

string

installedEEBs
optional

The NetBackup EEBs installed on the host.

string

isSecureEnabled
optional

Specifies whether or not the host can communicate securely.

boolean

masterServer
optional

The NetBackup master server that is associated with the host.

string

nbuVersion
optional

The NetBackup version on the host.

string

osType
optional

The operating system type of the host.

string

osVersion
optional

The operating system of the host.

string

servers
optional

A list of servers associated with the host.

< string > array

patchSlpDefinition

Name Description Schema

attributes
optional

attributes

id
optional

The name of the storage lifecycle policy (SLP).

string

type
optional

Type of the object.

enum (slp)

attributes

Name Description Schema

operationList
optional

The operations that need to be updated.

< patchSlpOperationDefinition > array

patchSlpOperationDefinition

Name Description Schema

operationIndex
required

Indicates the execution order of the operations in the storage lifecycle policy (SLP), starting from index 1.

integer

storage
optional

storage

targetImportSLP
optional

The name of the storage lifecycle policy (SLP) created for the import operation to the target master server.

string

targetMasterServer
optional

The name of the target master server to replicate the image to.

string

storage

Name Description Schema

name
optional

The name of the storage unit or storage unit group to use for this operation.

string

patchSlpRequest

Name Schema

data
optional

patchSlpDefinition

peerHostInfo

Name Description Schema

hostId
optional

The host ID of the discovered peer host.

string

hostName
required

The name of the peer host that is used for the connection.

string

pluginInfoAttribute

Name Description Schema

configinstanceAttributesArray
optional

List the configuration instance attributes for the plug-in type.

< configinstanceAttributes > array

displayName
required

The external (displayed on the interface) name of the plug-in. For example, "Amazon AWS".

string

multipleConfigs
required

Indicates if multiple configuration instances for a plug-in are supported.

boolean

name
required

The valid name of the plug-in type. For example, for Amazon AWS the name value is "aws".

string

onHost
required

Indicates if the agent must reside on the host. For application-consistent snapshots, the agent must reside on the host. Crash-consistent snapshots require an off-host agent.

boolean

version
required

The version of the plug-in.

string

pluginTypeResponseArray

Name Schema

data
required

< configuredPluginType > array

policyCloud

Name Description Schema

backupSelections
optional

A string that identifies the elements within Cloud asset that will be protected.

backupSelections

clients
optional

For Cloud policy, it will be details of the details of asset to be protected.

< clients > array

policyAttributes
optional

The attributes of the policy.

policyAttributes

policyName
required

The name of the policy.

string

policyType
required

The type of the policy. For example, Cloud.

string

schedules
optional

The list of schedules information.

< schedules > array

backupSelections

Name Schema

selections
optional

< string > array

clients

Name Description Schema

OS
optional

The host’s operating system and the value for Cloud asset OS is CLOUD.

string

hardware
optional

The host’s hardware and the value for Clooud asset hardware is CLOUD.

string

hostName
optional

The asset ID of Cloud asset.

string

policyAttributes

Name Description Schema

active
optional

Indicates if the policy is active or disabled. For example, if you want to activate the policy set the flag to true.
Default : true

boolean

autoManagedLabel
optional

The label for automatically managed policy.

string

autoManagedType
optional

If non-zero, the policy is automatically managed. A value of 1 means managed by protection plan.
Minimum value : 0
Maximum value : 1

integer

dataClassification
optional

The data classification type such as Bronze, Silver, Gold, and Platinum. You can customize these values. This is an optional field.

string

effectiveDateUTC
optional

The date and time the policy goes into effect, in UTC format.

string (date-time)

jobLimit
optional

The maximum number of jobs that originate from this policy and can concurrently run at any given time. If the number of jobs is 0, maximum limit is not enforced.

integer

keyword
optional

An optional keyword phrase.

string

mediaOwner
optional

The media server or group that owns the media.
Default : "ANY"

string

priority
optional

The priority of jobs associated with this policy. The higher the number, the higher the priority (relative to other NetBackup jobs).
Minimum value : 0
Maximum value : 99999

integer

storage
optional

The name of the storage unit associated with the policy. For protecting Cloud asset set storage to ANY.

string

storageIsSLP
optional

Indicates if the storage unit is defined with a storage lifecycle policy (SLP).
Default : false

boolean

volumePool
optional

The volume pool that is associated with the policy.
Default : "NetBackup"

enum (NetBackup)

schedules

Name Description Schema

acceleratorForcedRescan
optional

Indicates if file checksums are stored to aid in change detection. This parameter applies only to to NetBackup Accelerator backups.

boolean

backupCopies
optional

The copy details for the policy. Entry 1 reflects the primary schedule copy, which is always enabled.

backupCopies

backupType
optional

The backup type of the schedule.

enum (Full Backup)

excludeDates
optional

The recurring days of the week, recurring days of the month, and exact dates on which this policy will not run. This parameter only applies to calendar-based schedules.

excludeDates

frequencySeconds
optional

For frequency schedule types, the frequency at which to perform the backup, in seconds.

integer

includeDates
optional

The recurring days of the week, recurring days of the month, and exact dates on which this policy will run. This is applicable only for calendar schedule types.

includeDates

mediaMultiplexing
optional

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

retriesAllowedAfterRunDay
optional

Specifies if the backups are retried on any day when there is an open backup window. This is applicable only for the calendar schedule type.

boolean

scheduleName
optional

The name of the schedule.

string

scheduleType
optional

The type of the schedule.

enum (Calendar, Frequency)

snapshotOnly
optional

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.
Default : false

boolean

startWindow
optional

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
optional

Indicates if the storage unit is defined with a storage lifecycle policy (SLP).

boolean

syntheticBackup
optional

Specifies if a synthetic backup is performed.
Default : false

boolean

backupCopies

Name Description Schema

copies
optional

The list of copy information.

< copies > array

priority
optional

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
optional

The approach taken if a particular image fails to copy.

enum (Fail All Copies)

mediaOwner
optional

The media server or group that owns this copy.

string

retentionPeriod
optional

The retention period for the copy to be specified in quantity and units.

retentionPeriod

storage
optional

The name of the storage unit that is associated with the copy.

string

volumePool
optional

The name of the volume pool that is associated with the copy.

string

retentionPeriod

Name Description Schema

unit
optional

The unit of the retention period in terms of time,for example,weeks,months,years and so on.

enum (SECONDS, MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS, INFINITE)

value
optional

The value of the retention period in terms of unit defined.

integer

excludeDates

Name Description Schema

lastDayOfMonth
optional

Indicates if the last day of the month is included.

boolean

recurringDaysOfMonth
optional

The recurring days of the month.

< integer > array

recurringDaysOfWeek
optional

The recurring days of the week.

< string > array

specificDates
optional

A list of specific dates.

< string > array

includeDates

Name Description Schema

lastDayOfMonth
optional

Indicates if the last day of the month is included.

boolean

recurringDaysOfMonth
optional

The recurring days of the month.

< integer > array

recurringDaysOfWeek
optional

The recurring days of the week.

< string > array

specificDates
optional

A list of specific dates.

< string > array

startWindow

Name Description Schema

dayOfWeek
optional

The day of the week the backup window starts. Possible values for DAY are 1 (Sunday) through 7 (Saturday).

integer

durationSeconds
optional

The duration of the backup window, in seconds.

integer

startSeconds
optional

The start time of the backup window, expressed in seconds elapsed since the beginning of the day.

integer

policyGeneric

Name Description Schema

backupSelections
optional

The pathnames, VIP query and directives reflecting data to be backed up covered by this policy.

backupSelections

clients
optional

The list of client information.

< clients > array

policyAttributes
optional

The attributes of the policy.

policyAttributes

policyName
required

The name of the policy.

string

policyType
required

The type of the policy.

string

schedules
optional

The list of schedules information.

< schedules > array

backupSelections

Name Schema

selections
optional

< string > array

clients

Name Description Schema

OS
optional

The host’s operating system.

string

databaseName
optional

The name of the database to be used with Protect Instances and Databases.

string

hardware
optional

The host’s hardware.

string

hostName
optional

The name of the host to be backed up.

string

instanceGroup
optional

The name of the instance group to be backed up.

string

instanceName
optional

The name of the instance to be used with Protect Instances and Databases.

string

policyAttributes

Name Description Schema

active
optional

Indicates if the policy is active or disabled.
Default : true

boolean

alternateClientHostname
optional

If performing offhost backups with an alternate client, the name of the alternate client (or a supported directive, such as MEDIA_SERVER).

string

applicationConsistent
optional

Indicates whether application consistent (quiesced) backups are enabled. When useReplicationDirector is enabled, application consistent (quiesced) backups can be enabled or disbaled.

boolean

applicationDiscovery
optional

Indicates whether VMware Intelligent Policy is selected. When useReplicationDirector is enabled, VMware Intelligent Policy is selected automatically.

boolean

applicationProtection
optional

Used with VMware policy.

< enum (Exchange Recovery, Exchange Recovery, Truncate Logs, MSSQL Server Recovery, MSSQL Server Recovery, Truncate Logs, SharePoint Recovery) > array

archivedRedoLogOptions
optional

A collection of optional specifications related to archived redo logs. Not used with the 'Clients for use with scripts or templates' client selection type.

archivedRedoLogOptions

autoManagedLabel
optional

The label for automatically managed policy.

string

autoManagedType
optional

If non-zero, the policy is automatically managed. A value of 1 means managed by a protection plan.
Minimum value : 0
Maximum value : 1

integer

backupFileNameFormatOverrides
optional

Defined variations to the standard backup file name format. 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.

backupFileNameFormatOverrides

backupHost
optional

The hostname of a NetBackup client that performs backups on behalf of the virtual machines.

string

backupSelectionType
optional

The backup selection type within Oracle and SQL that the selections belong to. For clientType value with 'Clients', backupSelectionType should be 'Clients'.

enum (Whole Database, Whole Database - Datafile Copy Share, Partial Database - Tablespace, Partial Database - Datafiles, Fast Recovery Area (FRA), Clients, Database Backup Shares, File Group)

backupSetIdentifier
optional

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
optional

Indicates whether the policy performs block level incremental backups. When useReplicationDirector is enabled, block-level backups for the virtual machine are disabled automatically.

boolean

checkpointIntervalMinutes
optional

The number of minutes between each checkpoint.

integer

clientCompress
optional

Indicates if the backup is compressed.

boolean

clientEncrypt
optional

Indicates if the backup is encrypted.

boolean

clientType
optional

The type of Oracle or MS-SQL-Server elements targeted for backup under this policy.

enum (Protect Instances and Databases, Protect Instance Groups, Clients)

collectBareMetalRestoreInfo
optional

If enabled, collects Bare Metal Restore information.

boolean

collectTrueImageRestoreInfo
optional

The method of collecting true image restore information.

enum (Collect true image restore information, Collect true image restore information with move detection, Off)

crossMountPoints
optional

Indicates if the crossMountPoints is enabled.

boolean

dataClassification
optional

An optional classification tag. NetBackup comes with Bronze, Silver, Gold, and Platinum tags defined, but these values can be customized.

string

dataMoverMachine
optional

For offhost backups using Data Mover, this reflects the Data Mover type.

enum (None, Third Party Copy Device, NetBackup Media Server, Network Attached Storage, NDMP)

databaseBackupShareOptions
optional

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. Maps to Oracle policy.

databaseBackupShareOptions

databaseOptions
optional

A collection of tuning parameters that can improve the performance of MS-SQL-Server backups. Not used with the 'Clients for use with batch files' client selection type.

databaseOptions

datafileCopyTag
optional

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
optional

Indicates if client-side deduplication is disabled.

boolean

discoveryLifetime
optional

The number of seconds to honor the original query results. After this interval, the query will be reused to account for changes to the virtual machine environment. Applicable only if virtual machines are being selected via a query.

integer

effectiveDateUTC
optional

The date and time the policy goes into effect, in UTC format.

string

exchangeDatabaseBackupSource
optional

The Exchange DAG or Exchange 2007 replication backup source within Exchange that the selections belong to.

enum (Passive copy if available, else active copy, Passive copy only, Active copy only, Off)

exchangeServerList
optional

A list of Exchange-2010-preferred servers.

< string > array

followNFSMounts
optional

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

granularRecovery
optional

If enabled, performs granular restore.

boolean

hypervServer
optional

The Hyper-V server on which the virtual machine clients are hosted. Maps to Hyper-V policy.

string

jobLimit
optional

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
optional

An optional keyword phrase.

string

maximumLimits
optional

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.

maximumLimits

mediaOwner
optional

The media server or group that owns the media.
Default : "ANY"

string

offhostBackup
optional

Indicates if the backup is an offhost backup. When useReplicationDirector is enabled, the offhost backup can be enabled or disabled.

boolean

offlineDatabaseBackup
optional

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

optimizedBackup
optional

If enable, indicates that the backup is optimized on supporting Windows OS.

boolean

parallelStreams
optional

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.
Minimum value : 1
Maximum value : 255

integer

priority
optional

The priority of jobs associated with this policy. The higher the number, the higher the priority (relative to other NetBackup jobs).
Minimum value : 0
Maximum value : 99999

integer

readOnlyTablespaceOptions
optional

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
optional

Indicates that the snapshot is retained for instant recovery or for storage lifecycle policy (SLP) management. This parameter only applies to snapshot backups.

boolean

secondarySnapshotMethodArgs
optional

The value for the maximum number of snapshots when useReplicationDirector is enabled, for example, max_snapshots=1.

string

skipOfflineDatafiles
optional

If enabled, offline data files are skipped during the backup. This parameter is not used with the backupSelectionType value Legacy client with scripts or templates.

boolean

snapshotBackup
optional

Indicates whether this is a snapshot backup (frozen image). When useReplicationDirector is enabled, the snapshot backup (frozen image) is selected automatically.

boolean

snapshotMethod
optional

The snapshot method.

string

snapshotMethodArgs
optional

The snapshot arguments in the form of key-value pairs separated by comma.

string

storage
optional

The name of the storage unit that is associated with the policy.

string

storageIsSLP
optional

Indicates if the storage unit is defined with a storage lifecycle policy (SLP).
Default : false

boolean

transactionLogOptions
optional

A collection of tuning parameters that can improve the performance of MS-SQL-Server backups. Not used with the 'Clients for use with batch files' client selection type.

transactionLogOptions

useAccelerator
optional

Indicates if NetBackup Accelerator is used.

boolean

useMultipleDataStreams
optional

Indicates if multiple data streams are used.

boolean

useReplicationDirector
optional

Indicates if Replication Director is used to manage hardware snapshots.

boolean

useVirtualMachine
optional

Enabled for FlashBackup-Windows policies. Value of 0 -> 'No Virtual machine', 1 -> 'VMware Virtual Machine' and 2 -> 'Hyper-V virtual machine'.
Minimum value : 0
Maximum value : 2

integer

volumePool
optional

The volume pool that is associated with the policy.
Default : "NetBackup"

enum (NetBackup, DataStore)

archivedRedoLogOptions

Name Description Schema

backupSetSize
optional

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
optional

If non-zero, archived redo logs are deleted after the specified number of copies are successful.
Minimum value : 0
Maximum value : 1000

integer

filesPerBackupSet
optional

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
optional

If enabled, archived redo logs are included in full and incremental schedules.

boolean

parallelStreams
optional

The maximum number of connections between RMAN and a database instance.
Minimum value : 1
Maximum value : 255

integer

backupFileNameFormatOverrides

Name Schema

archivedRedoLogs
optional

string

controlFile
optional

string

datafiles
optional

string

fastRecoveryArea
optional

string

databaseBackupShareOptions

Name Description Schema

deleteBackupCopies
optional

Indicates if the backup copies are automatically deleted.

boolean

deleteBackupSets
optional

Indicates if the backup sets are automatically deleted.

boolean

deleteProtectedBackupCopiesMinutes
optional

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

integer

deleteProtectedBackupSetsMinutes
optional

The number of minutes to pass before protected backup sets are automatically deleted.

integer

databaseOptions

Name Description Schema

backupBlockSize
optional

The incremental size used by SQL Server for reading and writing backup images.

enum (0.5 KB, 1 KB, 2 KB, 4 KB, 8 KB, 16 KB, 32 KB, 64 KB)

backupStripes
optional

The number of concurrent streams which the backup operation is divided into.
Minimum value : 1
Maximum value : 32

integer

clientBuffersPerStripe
optional

The number of buffers to allocate for reading or writing each datastream during a backup operation.
Minimum value : 1
Maximum value : 32

integer

convertDiffBackupsToFull
optional

If enabled, a differential backup is converted to a full backup if no previous full backup exists for the database or file group.

boolean

copyOnlyBackup
optional

If enabled, SQL Server is allowed to create an out-of-band backup so that it does not interfere with the normal backup sequence.

boolean

maxTransferSize
optional

The buffer size used by SQL Server for reading and writing backup images.

enum (64 KB, 128 KB, 256 KB, 512 KB, 1 MB, 2 MB, 4 MB)

parallelBackupOps
optional

The number of backup operations to start simultaneously, per database instance.
Minimum value : 1
Maximum value : 32

integer

skipReadOnlyFilegroups
optional

If enabled, file groups that are read-only are excluded from the backups. Used only with the 'Whole Database' backup selection type.

boolean

skipUnavailableDatabases
optional

If enabled, any database with a status that prevents NetBackup from successfully backing up the database is skipped.

boolean

sqlServerChecksum
optional

The option for SQL Server backup checksums.

enum (None, Continue on error, Fail on error)

useSQLServerCompression
optional

If enabled, SQL Server is used to compress the backup image. Not supported for snapshot backups.

boolean

maximumLimits

Name Description Schema

backupPiece
optional

In kilobytes (KB), the maximum size of each backup piece that is created on this channel. Maps to the Oracle MAXPIECESIZE property.

integer

backupSetSize
optional

In kilobytes (KB), the maximum size for a backup set. Maps to the Oracle MAXSETSIZE property.

integer

filesPerBackupSet
optional

The maximum number of input files to include in each output backup set. Maps to the Oracle FILESPERSET property.

integer

openFiles
optional

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
optional

The maximum number of kilobytes (KB) that RMAN reads each second on this channel. Maps to the Oracle RATE property.

integer

transactionLogOptions

Name Description Schema

backupBlockSize
optional

The incremental size used by SQL Server for reading and writing backup images.

enum (0.5 KB, 1 KB, 2 KB, 4 KB, 8 KB, 16 KB, 32 KB, 64 KB)

backupStripes
optional

The number of concurrent streams which the backup operation is divided into.
Minimum value : 1
Maximum value : 32

integer

clientBuffersPerStripe
optional

The number of buffers to allocate for reading or writing each datastream during a backup operation.
Minimum value : 1
Maximum value : 32

integer

convertLogBackupsToFull
optional

If enabled, a transaction backup is converted to a full backup if no previous full backup exists for the database.

boolean

maxTransferSize
optional

The buffer size used by SQL Server for reading and writing backup images.

enum (64 KB, 128 KB, 256 KB, 512 KB, 1 MB, 2 MB, 4 MB)

parallelBackupOps
optional

The number of backup operations to start simultaneously, per database instance.
Minimum value : 1
Maximum value : 32

integer

skipUnavailableDatabases
optional

If enabled, any database with a status that prevents NetBackup from successfully backing up the database is skipped.

boolean

sqlServerChecksum
optional

The option for SQL Server backup checksums.

enum (None, Continue on error, Fail on error)

truncateLogsAfterBackup
optional

If enabled, the transaction log is backed up and the inactive part of the transaction log is removed.

boolean

useSQLServerCompression
optional

If enabled, SQL Server is used to compress the backup image. Not supported for snapshot backups.

boolean

schedules

Name Description Schema

acceleratorForcedRescan
optional

Indicates if file checksums are stored to aid in change detection. This parameter applies only to to NetBackup Accelerator backups.

boolean

backupCopies
optional

The copy details for the policy. Entry 1 reflects the primary schedule copy, which is always enabled. Entries 2-4 reflect (optional) additional copies.

backupCopies

backupType
optional

The backup type of the schedule.

enum (Application Backup, Archived Redo Log Backup, Cumulative Incremental Backup, Differential Incremental Backup, Full Backup)

excludeDates
optional

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

excludeDates

frequencySeconds
optional

For frequency schedule types, the frequency at which to perform the backup, in seconds.

integer

includeDates
optional

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

includeDates

mediaMultiplexing
optional

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

retriesAllowedAfterRunDay
optional

Indicates if backups can retry on any day that has an open backup window. This parameter only applies to calendar-based schedules.

boolean

scheduleName
optional

The name of the schedule.

string

scheduleType
optional

The type of the schedule.

enum (Calendar, Frequency)

snapshotOnly
optional

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
optional

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
optional

Indicates if the storage unit is defined with a storage lifecycle policy (SLP).

boolean

syntheticBackup
optional

Specifies if a synthetic backup is performed.

boolean

backupCopies

Name Description Schema

copies
optional

The list of copy information.

< copies > array

priority
optional

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
optional

The approach taken if a particular image fails to copy.

enum (Continue, Fail All Copies)

mediaOwner
optional

The media server or group that owns this copy.

string

retentionPeriod
optional

The retention period for the copy to be specified in quantity and units.

retentionPeriod

storage
optional

The name of the storage unit that is associated with the copy.

string

volumePool
optional

The name of the volume pool that is associated with the copy.

string

retentionPeriod

Name Description Schema

unit
optional

The unit of the retention period in terms of time,for example,weeks,months,years and so on.

enum (SECONDS, MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS, INFINITE)

value
optional

The value of the retention period in terms of unit defined.

integer

excludeDates

Name Description Schema

lastDayOfMonth
optional

Indicates if the last day of the month is excluded.

boolean

recurringDaysOfMonth
optional

Recurring days of the month.

< integer > array

recurringDaysOfWeek
optional

Recurring days of a week.

< string > array

specificDates
optional

A list of specific dates.

< string > array

includeDates

Name Description Schema

lastDayOfMonth
optional

Indicates if the last day of the month is included.

boolean

recurringDaysOfMonth
optional

Recurring days of the month.

< integer > array

recurringDaysOfWeek
optional

Recurring days of a week.

< string > array

specificDates
optional

A list of specific dates.

< string > array

startWindow

Name Description Schema

dayOfWeek
optional

The day of the week the backup window starts. Possible values for DAY are 1 (Sunday) through 7 (Saturday).

integer

durationSeconds
optional

The duration of the backup window expressed in seconds.

integer

startSeconds
optional

The start time of the backup window, expressed in seconds elapsed since the beginning of the day.

integer

policyMS-SQL-Server

Name Description Schema

backupSelections
optional

The pathnames and directives reflecting data to be backed up for the MS-SQL-Server elements covered by this policy.

backupSelections

clients
optional

The list of client information.

< clients > array

policyAttributes
optional

The attributes of the policy.

policyAttributes

policyName
required

The name of the policy.

string

policyType
required

The type of the policy.

string

schedules
optional

The list of schedules information.

< schedules > array

backupSelections

Name Schema

selections
optional

< string > array

clients

Name Description Schema

OS
optional

The host’s operating system. The sample values for the MS-SQL-Server client OS are HP-UX11.31, Debian2.6.32, RedHat2.6.32, SuSE3.0.76, IBMzSeriesRedHat2.6.32, 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.

string

databaseName
optional

The name of the database to be used with Protect Instances.

string

hardware
optional

The host’s hardware. The sample values for the MS-SQL-Server client Hardware are HP-UX-IA64, Linux, Linux-s390x, NDMP, Novell, OpenVMS4, RS6000, Solaris, Windows-x64, Windows-x86.

string

hostName
optional

The name of the host to be backed up.

string

instanceGroup
optional

The name of the instance group to be backed up.

string

instanceName
optional

The name of the instance to be used with Protect Instances.

string

policyAttributes

Name Description Schema

active
optional

Indicates if the policy is active or disabled.
Default : true

boolean

alternateClientHostname
optional

If performing offhost backups with an alternate client, the name of the alternate client (or a supported directive, such as MEDIA_SERVER).

string

autoManagedLabel
optional

The label for automatically managed policies.

string

autoManagedType
optional

If non-zero, the policy is automatically managed. The value of 1 means that the policy is managed by a protection plan.
Minimum value : 0
Maximum value : 1

integer

backupSelectionType
optional

The backup seletion type within MS-SQL-Server that the selections belong to.
Default : "Whole Database"

enum (Clients, Whole Database, File Group, Partial Database - Datafiles)

clientCompress
optional

Indicates if the backup is compressed.
Default : false

boolean

clientEncrypt
optional

Indicates if the backup is encrypted.
Default : false

boolean

clientType
optional

The type of MS-SQL-Server elements targeted for backup under this policy.
Default : "Protect Instances and Databases"

enum (Protect Instances and Databases, Protect Instance Groups, Clients)

dataClassification
optional

An optional classification tag. NetBackup comes with Bronze, Silver, Gold, and Platinum tags defined, but these values can be customized.

string

dataMoverMachine
optional

For offhost backups using Data Mover, this reflects the Data Mover type.

enum (Third Party Copy Device, NetBackup Media Server)

databaseOptions
optional

A collection of tuning parameters that can improve the performance of MS-SQL-Server backups. Not used with the 'Clients for use with batch files' client selection type.

databaseOptions

disableClientSideDeduplication
optional

Indicates if client-side deduplication is disabled.
Default : false

boolean

effectiveDateUTC
optional

The date and time the policy goes into effect, in UTC format.

string

jobLimit
optional

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
optional

An optional keyword phrase.

string

mediaOwner
optional

The media server or group that owns the media.
Default : "ANY"

string

offhostBackup
optional

Indicates if the backup is an offhost backup. When useReplicationDirector is enabled, the offhost backup can be enabled or disabled.
Default : false

boolean

priority
optional

The priority of jobs associated with this policy. The higher the number, the higher the priority (relative to other NetBackup jobs).
Minimum value : 0
Maximum value : 99999

integer

retainSnapshot
optional

Indicates that the snapshot is retained for instant recovery or for storage lifecycle policy (SLP) management. This parameter only applies to snapshot backups.
Default : false

boolean

snapshotBackup
optional

Indicates whether this is a snapshot backup (frozen image).
Default : false

boolean

snapshotMethod
optional

Indicates the snapshot method if this is a snapshot backup. Valid values are auto, VSS, vxvm.

string

snapshotMethodArgs
optional

Indicates the snapshot arguments corresponding to the snapshot method if this is a snapshot backup. This is a comma separated list of key-value pairs.

string

storage
optional

The name of the storage unit that is associated with the policy.

string

storageIsSLP
optional

Indicates if the storage unit is defined with a storage lifecycle policy (SLP).
Default : false

boolean

transactionLogOptions
optional

A collection of tuning parameters that can improve the performance of MS-SQL-Server backups. Not used with the 'Clients for use with batch files' client selection type.

transactionLogOptions

volumePool
optional

The volume pool that is associated with the policy.
Default : "NetBackup"

enum (NetBackup, DataStore)

databaseOptions

Name Description Schema

backupBlockSize
optional

The incremental size used by SQL Server for reading and writing backup images.
Default : "64 KB"

enum (0.5 KB, 1 KB, 2 KB, 4 KB, 8 KB, 16 KB, 32 KB, 64 KB)

backupStripes
optional

The number of concurrent streams which the backup operation is divided into.
Minimum value : 1
Maximum value : 32

integer

clientBuffersPerStripe
optional

The number of buffers to allocate for reading or writing each datastream during a backup operation.
Minimum value : 1
Maximum value : 32

integer

convertDiffBackupsToFull
optional

If enabled, a differential backup is converted to a full backup if no previous full backup exists for the database or file group.
Default : false

boolean

copyOnlyBackup
optional

If enabled, SQL Server is allowed to create an out-of-band backup so that it does not interfere with the normal backup sequence.
Default : false

boolean

maxTransferSize
optional

The buffer size used by SQL Server for reading and writing backup images.
Default : "4 MB"

enum (64 KB, 128 KB, 256 KB, 512 KB, 1 MB, 2 MB, 4 MB)

parallelBackupOps
optional

The number of backup operations to start simultaneously, per database instance.
Minimum value : 1
Maximum value : 32

integer

skipReadOnlyFilegroups
optional

If enabled, file groups that are read-only are excluded from the backups. Used only with the 'Whole Database' backup selection type.
Default : false

boolean

skipUnavailableDatabases
optional

If enabled, any database with a status that prevents NetBackup from successfully backing up the database is skipped.
Default : false

boolean

sqlServerChecksum
optional

The option for SQL Server backup checksums.
Default : "None"

enum (None, Continue on error, Fail on error)

useSQLServerCompression
optional

If enabled, SQL Server is used to compress the backup image. Not supported for snapshot backups.
Default : false

boolean

transactionLogOptions

Name Description Schema

backupBlockSize
optional

The incremental size used by SQL Server for reading and writing backup images.
Default : "64 KB"

enum (0.5 KB, 1 KB, 2 KB, 4 KB, 8 KB, 16 KB, 32 KB, 64 KB)

backupStripes
optional

The number of concurrent streams which the backup operation is divided into.
Minimum value : 1
Maximum value : 32

integer

clientBuffersPerStripe
optional

The number of buffers to allocate for reading or writing each datastream during a backup operation.
Minimum value : 1
Maximum value : 32

integer

convertLogBackupsToFull
optional

If enabled, a transaction backup is converted to a full backup if no previous full backup exists for the database.
Default : false

boolean

maxTransferSize
optional

The buffer size used by SQL Server for reading and writing backup images.
Default : "4 MB"

enum (64 KB, 128 KB, 256 KB, 512 KB, 1 MB, 2 MB, 4 MB)

parallelBackupOps
optional

The number of backup operations to start simultaneously, per database instance.
Minimum value : 1
Maximum value : 32

integer

skipUnavailableDatabases
optional

If enabled, any database with a status that prevents NetBackup from successfully backing up the database is skipped.
Default : false

boolean

sqlServerChecksum
optional

The option for SQL Server backup checksums.
Default : "None"

enum (None, Continue on error, Fail on error)

truncateLogsAfterBackup
optional

If enabled, the transaction log is backed up and the inactive part of the transaction log is removed.
Default : true

boolean

useSQLServerCompression
optional

If enabled, SQL Server is used to compress the backup image. Not supported for snapshot backups.
Default : false

boolean

schedules

Name Description Schema

acceleratorForcedRescan
optional

Indicates if file checksums are stored to aid in change detection. This parameter applies only to NetBackup Accelerator backups.

boolean

backupCopies
optional

The copy details for the policy. Entry 1 reflects the primary schedule copy, which is always enabled. Entries 2-4 reflect (optional) additional copies.

backupCopies

backupType
optional

The backup type of the schedule.

enum (Application Backup, Differential Incremental Backup, Full Backup, Transaction Log Backup)

excludeDates
optional

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

excludeDates

frequencySeconds
optional

For frequency schedule types, the frequency at which to perform the backup, in seconds.

integer

includeDates
optional

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

includeDates

mediaMultiplexing
optional

The maximum number of jobs from the schedule that NetBackup can multiplex onto any single drive. Valid values are 1 (no multiplexing) to 32.

integer

retriesAllowedAfterRunDay
optional

Indicates if backups can retry on any day that has an open backup window. This parameter only applies to calendar-based schedules.

boolean

scheduleName
optional

The name of the schedule.

string

scheduleType
optional

The type of the schedule.

enum (Calendar, Frequency)

snapshotOnly
optional

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
optional

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
optional

Indicates if the storage unit is defined with a storage lifecycle policy (SLP).

boolean

syntheticBackup
optional

Specifies if a synthetic backup is performed.

boolean

backupCopies

Name Description Schema

copies
optional

The list of copy information.

< copies > array

priority
optional

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
optional

The approach taken if a particular image fails to copy.

enum (Continue, Fail All Copies)

mediaOwner
optional

The media server or group that owns this copy.

string

retentionPeriod
optional

The retention period for the copy to be specified in quantity and units.

retentionPeriod

storage
optional

The name of the storage unit that is associated with the copy.

string

volumePool
optional

The name of the volume pool that is associated with the copy.

string

retentionPeriod

Name Description Schema

unit
optional

The unit of the retention period in terms of time,for example,weeks,months,years and so on.

enum (SECONDS, MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS, INFINITE)

value
optional

The value of the retention period in terms of unit defined.

integer

excludeDates

Name Description Schema

lastDayOfMonth
optional

Indicates if the last day of the month is excluded.

boolean

recurringDaysOfMonth
optional

Recurring days of the month.

< integer > array

recurringDaysOfWeek
optional

Recurring days of a week.

< string > array

specificDates
optional

A list of specific dates.

< string > array

includeDates

Name Description Schema

lastDayOfMonth
optional

Indicates if the last day of the month is included.

boolean

recurringDaysOfMonth
optional

Recurring days of the month.

< integer > array

recurringDaysOfWeek
optional

Recurring days of a week.

< string > array

specificDates
optional

A list of specific dates.

< string > array

startWindow

Name Description Schema

dayOfWeek
optional

The day of the week the backup window starts. Possible values for DAY are 1 (Sunday) through 7 (Saturday).

integer

durationSeconds
optional

The duration of the backup window expressed in seconds.

integer

startSeconds
optional

The start time of the backup window, expressed in seconds elapsed since the beginning of the day.

integer

policyOracle

Name Description Schema

backupSelections
optional

The pathnames and directives reflecting data to be backed up for the Oracle elements covered by this policy.

backupSelections

clients
optional

The list of client information.

< clients > array

policyAttributes
optional

The attributes of the policy.

policyAttributes

policyName
required

The name of the policy.

string

policyType
required

The type of the policy.

string

schedules
optional

The list of schedules information.

< schedules > array

backupSelections

Name Schema

selections
optional

< string > array

clients

Name Description Schema

OS
optional

The host’s operating system. The sample values for the Oracle client OS are HP-UX11.31, Debian2.6.32, RedHat2.6.32, SuSE3.0.76, IBMzSeriesRedHat2.6.32, 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.

string

databaseName
optional

The name of the database to be used with Protect Instances and Databases.

string

hardware
optional

The host’s hardware. The sample values for the Oracle client Hardware are HP-UX-IA64, Linux, Linux-s390x, NDMP, Novell, OpenVMS4, RS6000, Solaris, Windows-x64, Windows-x86.

string

hostName
optional

The name of the host to be backed up.

string

instanceGroup
optional

The name of the instance group to be backed up.

string

instanceName
optional

The name of the instance to be used with Protect Instances and Databases.

string

policyAttributes

Name Description Schema

active
optional

Indicates if the policy is active or disabled.
Default : true

boolean

alternateClientHostname
optional

If performing offhost backups with an alternate client, the name of the alternate client (or a supported directive, such as MEDIA_SERVER).

string

archivedRedoLogOptions
optional

A collection of optional specifications related to archived redo logs. Not used with the 'Clients for use with scripts or templates' client selection type.

archivedRedoLogOptions

autoManagedLabel
optional

The label for automatically managed policy.

string

autoManagedType
optional

If non-zero, the policy is automatically managed. A value of 1 means managed by a protection plan.
Minimum value : 0
Maximum value : 1

integer

backupFileNameFormatOverrides
optional

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.

backupFileNameFormatOverrides

backupSelectionType
optional

The backup seletion type within Oracle that the selections belong to. For clientType value with 'Clients', backupSelectionType should be 'Clients' also interpreted as 'Legacy Client with scripts or templates'.
Default : "Whole Database"

enum (Whole Database, Whole Database - Datafile Copy Share, Partial Database - Tablespace, Partial Database - Datafiles, Fast Recovery Area (FRA), Clients, Database Backup Shares)

backupSetIdentifier
optional

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.
Default : ""

string

blockIncremental
optional

Indicates whether the policy performs block level incremental backups.
Default : false

boolean

clientCompress
optional

Indicates if the backup is compressed.
Default : false

boolean

clientEncrypt
optional

Indicates if the backup is encrypted.
Default : false

boolean

clientType
optional

The type of Oracle elements targeted for backup under this policy.
Default : "Protect Instances and Databases"

enum (Protect Instances and Databases, Protect Instance Groups, Clients)

dataClassification
optional

An optional classification tag. NetBackup comes with Bronze, Silver, Gold, and Platinum tags defined, but these values can be customized.

string

dataMoverMachine
optional

For offhost backups using Data Mover, this reflects the Data Mover type.

enum (Third Party Copy Device, NetBackup Media Server, Network Attached Storage, NDMP)

databaseBackupShareOptions
optional

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.

databaseBackupShareOptions

datafileCopyTag
optional

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
optional

Indicates if client-side deduplication is disabled.
Default : false

boolean

effectiveDateUTC
optional

The date and time the policy goes into effect, in UTC format.

string

followNFSMounts
optional

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.
Default : false

boolean

jobLimit
optional

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
optional

An optional keyword phrase.

string

maximumLimits
optional

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.

maximumLimits

mediaOwner
optional

The media server or group that owns the media.
Default : "ANY"

string

offhostBackup
optional

Indicates if the backup is an offhost backup. When useReplicationDirector is enabled, the offhost backup can be enabled or disabled.
Default : false

boolean

offlineDatabaseBackup
optional

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.
Default : false

boolean

parallelStreams
optional

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.
Minimum value : 1
Maximum value : 255

integer

priority
optional

The priority of jobs associated with this policy. The higher the number, the higher the priority (relative to other NetBackup jobs).
Minimum value : 0
Maximum value : 99999

integer

readOnlyTablespaceOptions
optional

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
optional

Indicates that the snapshot is retained for instant recovery or for storage lifecycle policy (SLP) management. This parameter only applies to snapshot backups.
Default : false

boolean

skipOfflineDatafiles
optional

If enabled, offline data files are skipped during the backup. This parameter is not used with the backupSelectionType value Legacy client with scripts or templates.
Default : false

boolean

snapshotBackup
optional

Indicates whether this is a snapshot backup (frozen image). When useReplicationDirector is enabled, the snapshot backup (frozen image) is selected automatically.
Default : false

boolean

snapshotMethod
optional

Indicates the snapshot method if this is a snapshot backup.

string

snapshotMethodArgs
optional

Indicates the snapshot arguments corresponding to the snapshot method if this is a snapshot backup. This is a comma separated list of key-value pairs.

string

storage
optional

The name of the storage unit that is associated with the policy.

string

storageIsSLP
optional

Indicates if the storage unit is defined with a storage lifecycle policy (SLP).
Default : false

boolean

useAccelerator
optional

Indicates if NetBackup Accelerator is used.
Default : false

boolean

useReplicationDirector
optional

Indicates if Replication Director is used to manage hardware snapshots.
Default : false

boolean

volumePool
optional

The volume pool that is associated with the policy.
Default : "NetBackup"

enum (NetBackup, DataStore)

archivedRedoLogOptions

Name Description Schema

backupSetSize
optional

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
optional

If non-zero, archived redo logs are deleted after the specified number of copies are successful.
Minimum value : 0
Maximum value : 1000

integer

filesPerBackupSet
optional

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
optional

If enabled, archived redo logs are included in full and incremental schedules.
Default : true

boolean

parallelStreams
optional

The maximum number of connections between RMAN and a database instance.
Minimum value : 1
Maximum value : 255

integer

backupFileNameFormatOverrides

Name Description Schema

archivedRedoLogs
optional

Default : "arch_d%d_u%u_s%s_p%p_t%t"

string

controlFile
optional

Default : "ctrl_d%d_u%u_s%s_p%p_t%t"

string

datafiles
optional

Default : "bk_d%d_u%u_s%s_p%p_t%t"

string

fastRecoveryArea
optional

Default : "fra_d%d_u%u_s%s_p%p_t%t"

string

databaseBackupShareOptions

Name Description Schema

deleteBackupCopies
optional

Indicates if the backup copies are automatically deleted.
Default : false

boolean

deleteBackupSets
optional

Indicates if the backup sets are automatically deleted.
Default : false

boolean

deleteProtectedBackupCopiesMinutes
optional

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

integer

deleteProtectedBackupSetsMinutes
optional

The number of minutes to pass before protected backup sets are automatically deleted.

integer

maximumLimits

Name Description Schema

backupPiece
optional

In kilobytes (KB), the maximum size of each backup piece that is created on this channel. Maps to the Oracle MAXPIECESIZE property.

integer

backupSetSize
optional

In kilobytes (KB), the maximum size for a backup set. Maps to the Oracle MAXSETSIZE property.

integer

filesPerBackupSet
optional

The maximum number of input files to include in each output backup set. Maps to the Oracle FILESPERSET property.

integer

openFiles
optional

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
optional

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
optional

Indicates if file checksums are stored to aid in change detection. This parameter applies only to NetBackup Accelerator backups.

boolean

backupCopies
optional

The copy details for the policy. Entry 1 reflects the primary schedule copy, which is always enabled. Entries 2-4 reflect (optional) additional copies.

backupCopies

backupType
optional

The backup type of the schedule.

enum (Application Backup, Archived Redo Log Backup, Cumulative Incremental Backup, Differential Incremental Backup, Full Backup)

excludeDates
optional

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

excludeDates

frequencySeconds
optional

For frequency schedule types, the frequency at which to perform the backup, in seconds.

integer

includeDates
optional

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

includeDates

mediaMultiplexing
optional

The maximum number of jobs from the schedule that NetBackup can multiplex onto any single drive. Valid values are 1 (no multiplexing) to 32.

integer

retriesAllowedAfterRunDay
optional

Indicates if backups can retry on any day that has an open backup window. This parameter only applies to calendar-based schedules.

boolean

scheduleName
optional

The name of the schedule.

string

scheduleType
optional

The type of the schedule.

enum (Calendar, Frequency)

snapshotOnly
optional

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
optional

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
optional

Indicates if the storage unit is defined with a storage lifecycle policy (SLP).

boolean

syntheticBackup
optional

Specifies if a synthetic backup is performed.

boolean

backupCopies

Name Description Schema

copies
optional

The list of copy information.

< copies > array

priority
optional

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
optional

The approach taken if a particular image fails to copy.

enum (Continue, Fail All Copies)

mediaOwner
optional

The media server or group that owns this copy.

string

retentionPeriod
optional

The retention period for the copy to be specified in quantity and units.

retentionPeriod

storage
optional

The name of the storage unit that is associated with the copy.

string

volumePool
optional

The name of the volume pool that is associated with the copy.

string

retentionPeriod

Name Description Schema

unit
optional

The unit of the retention period in terms of time,for example,weeks,months,years and so on.

enum (SECONDS, MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS, INFINITE)

value
optional

The value of the retention period in terms of unit defined.

integer

excludeDates

Name Description Schema

lastDayOfMonth
optional

Indicates if the last day of the month is excluded.

boolean

recurringDaysOfMonth
optional

Recurring days of the month.

< integer > array

recurringDaysOfWeek
optional

Recurring days of a week.

< string > array

specificDates
optional

A list of specific dates.

< string > array

includeDates

Name Description Schema

lastDayOfMonth
optional

Indicates if the last day of the month is included.

boolean

recurringDaysOfMonth
optional

Recurring days of the month.

< integer > array

recurringDaysOfWeek
optional

Recurring days of a week.

< string > array

specificDates
optional

A list of specific dates.

< string > array

startWindow

Name Description Schema

dayOfWeek
optional

The day of the week the backup window starts. Possible values for DAY are 1 (Sunday) through 7 (Saturday).

integer

durationSeconds
optional

The duration of the backup window expressed in seconds.

integer

startSeconds
optional

The start time of the backup window, expressed in seconds elapsed since the beginning of the day.

integer

policyRequest

Name Schema

data
required

data

data

Name Description Schema

attributes
required

The attributes of the policy. Must be specified by the property named policy. Use the schema that corresponds to the policy type.

attributes

id
required

The policy name.

string

type
required

The resource type. Must be set to "policy".

string

attributes

Name Description Schema

policyCloud
optional

The schema details for the policy of type "Cloud".

policyCloud

policyGeneric
optional

The details for the policy that uses the generic policy schema.

policyGeneric

policyOracle
optional

The schema details for the policy of type "Oracle".

policyOracle

policySQLServer
optional

The schema details for the policy of type "MS-SQL-Server".

policyMS-SQL-Server

policyVMware
optional

The schema details for the policy of type "VMware".

policyVMware

policyResponse

Name Schema

data
optional

data

data

Name Description Schema

attributes
optional

The policy attributes that are returned reflect the property named policy. The schema corresponds to the policy type.

attributes

id
required

The policy name.

string

links
optional

The links to the URLs for the details on each policy.

links

type
required

The resource type. Must be set to "policy".

string

attributes

Name Description Schema

policyCloud
optional

The schema details for the policy of type "Cloud".

policyCloud

policyGeneric
optional

The details for the policy that uses the generic policy schema.

policyGeneric

policyOracle
optional

The schema details for the policy of type "Oracle".

policyOracle

policySQLServer
optional

The schema details for the policy of type "MS-SQL-Server".

policyMS-SQL-Server

policyVMware
optional

The schema details for the policy of type "VMware".

policyVMware

links

Name Schema

self
optional

self

self

Name Description Schema

href
optional

The URI to get details for the policy.

string

policyVMware

Name Description Schema

backupSelections
optional

It will be the VIP query, If not the VIP query then it will be ALL_LOCAL_DRIVES.

backupSelections

clients
optional

The list of client information.

< clients > array

policyAttributes
optional

policyAttributes

policyName
required

The name of the policy.

string

policyType
required

The type of the policy.

string

schedules
optional

< schedules > array

backupSelections

Name Schema

selections
optional

< string > array

clients

Name Description Schema

OS
required

The host’s operating system and the value for the Vmware client OS is VMware for VIP and will be Virtual_Machine in case of manual selection.

string

hardware
required

The host’s hardware and the value for the VMware client Hardware is VMware for both VIP and manual selection.

string

hostName
required

The name of the host to be backed up.For VIP this will be the discover host and could be a MEDIA_SERVER.

string

policyAttributes

Name Description Schema

active
optional

Indicates if the policy is active or disabled.
Default : true

boolean

applicationConsistent
optional

Indicates whether application consistent (quiesced) backups are enabled. When useReplicationDirector is enabled, application consistent (quiesced) backups can be enabled or disbaled.
Default : true

boolean

applicationDiscovery
optional

Indicates whether VMware Intelligent Policy is selected. When useReplicationDirector is enabled, VMware Intelligent Policy is selected automatically.
Default : true

boolean

applicationProtection
optional

Options to enable the type of recovery.

< enum (Exchange Recovery, Exchange Recovery, Truncate Logs, MSSQL Server Recovery, MSSQL Server Recovery, Truncate Logs, SharePoint Recovery) > array

autoManagedLabel
optional

The label for automatically managed policy.

string

autoManagedType
optional

If non-zero, the policy is automatically managed. A value of 1 means managed by a protection plan.
Minimum value : 0
Maximum value : 1

integer

backupHost
optional

The hostname of a NetBackup client that performs backups on behalf of the virtual machines.
Default : "MEDIA_SERVER"

string

blockIncremental
optional

Indicates whether block-level backups of the virtual machine are performed. When useReplicationDirector is enabled, block-level backups for the virtual machine are disabled automatically.
Default : true

boolean

dataClassification
optional

An optional classification tag. NetBackup comes with Bronze, Silver, Gold, and Platinum tags defined, but these values can be customized.

string

disableClientSideDeduplication
optional

Indicates if client-side deduplication is disabled.
Default : false

boolean

discoveryLifetime
optional

The number of seconds to honor the original query results. After this interval, the query will be reused to account for changes to the virtual machine environment. Applicable only if virtual machines are being selected via a query.

integer

effectiveDateUTC
optional

The date and time the policy goes into effect, in UTC format.

string

jobLimit
optional

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
optional

An optional keyword phrase.

string

mediaOwner
optional

The media server or group that owns the media.
Default : "ANY"

string

priority
optional

The priority of jobs associated with this policy. The higher the number, the higher the priority (relative to other NetBackup jobs).

integer

secondarySnapshotMethodArgs
optional

The value for the maximum number of snapshots when useReplicationDirector is enabled, for example, max_snapshots=1. If no value is specified, the default value (max_snapshots=1) is used.

string

snapshotMethodArgs
optional

The snapshot arguments in the form of key-value pairs separated by comma.
Default : "skipnodisk=0,post_events=1,multi_org=0,Virtual_machine_backup=2,continue_discovery=1,nameuse=0,exclude_swap=1,tags_unset=0,ignore_irvm=1,rLim=10,snapact=3,enable_quiesce_failover=0,file_system_optimization=1,drive_selection=0,disable_quiesce=0,enable_vCloud=0,trantype=san:hotadd:nbd:nbdssl,rHz=10,rTO=0"

string

storage
optional

The name of the storage unit associated with the policy.

string

storageIsSLP
optional

Indicates if the storage unit is defined with a storage lifecycle policy (SLP).
Default : false

boolean

useAccelerator
optional

Indicates if Accelerator is used.
Default : false

boolean

useReplicationDirector
optional

Indicates if NetBackup Replication Director should be used to manage hardware snapshots.
Default : false

boolean

volumePool
optional

The volume pool associated with the policy.
Default : "NetBackup"

enum (NetBackup, DataStore)

schedules

Name Description Schema

acceleratorForcedRescan
optional

Indicates if file checksums are stored to aid in change detection. Applicable only to Accelerator backups.

boolean

backupCopies
optional

The copy details for the policy. Entry 1 reflects the primary schedule copy, which is always enabled. Entries 2-4 reflect (optional) additional copies.

backupCopies

backupType
optional

The backup type of the schedule.

enum (Cumulative Incremental Backup, Differential Incremental Backup, Full Backup)

excludeDates
optional

Recurring days of the week, recurring days of the month, and exact dates on which this policy will not run.

excludeDates

frequencySeconds
optional

For frequency schedule types, the frequency at which to perform the backup, in seconds.

integer

includeDates
optional

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.

includeDates

mediaMultiplexing
optional

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

retriesAllowedAfterRunDay
optional

Indicates if backups can retry on any day there is an open backup window. Applicable only for the calendar schedule type.

boolean

scheduleName
optional

The name of the schedule.

string

scheduleType
optional

The type of the schedule.

enum (Calendar, Frequency)

snapshotOnly
optional

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
optional

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
optional

Indicates if the storage unit is defined with a storage lifecycle policy (SLP).

boolean

syntheticBackup
optional

Specifies if a synthetic backup is performed.For VMware, Use accelerator performs thsi function.
Default : false

boolean

backupCopies

Name Description Schema

copies
optional

< copies > array

priority
optional

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
optional

The approach taken if a particular image fails to copy.

enum (Continue, Fail All Copies)

mediaOwner
optional

The media server or group that owns this copy.

string

retentionPeriod
optional

The retention period for the copy to be specified in quantity and units.

retentionPeriod

storage
optional

The name of the storage unit associated with the copy.

string

volumePool
optional

The name of the volume pool associated with the copy.

string

retentionPeriod

Name Description Schema

unit
optional

The unit of the retention period in terms of time,for example,weeks,months,years and so on.

enum (SECONDS, MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS, INFINITE)

value
optional

The value of the retention period in terms of unit defined..

integer

excludeDates

Name Description Schema

lastDayOfMonth
optional

Indicates if the last day of the month is included.

boolean

recurringDaysOfMonth
optional

Recurring days of the month.

< integer > array

recurringDaysOfWeek
optional

Recurring days of a week.

< string > array

specificDates
optional

A list of specific dates.

< string > array

includeDates

Name Description Schema

lastDayOfMonth
optional

Indicates if the last day of the month is included.

boolean

recurringDaysOfMonth
optional

Recurring days of the month.

< integer > array

recurringDaysOfWeek
optional

Recurring days of a week.

< string > array

specificDates
optional

A list of specific dates.

< string > array

startWindow

Name Description Schema

dayOfWeek
optional

The day of the week the backup window starts. Possible values for DAY are 1 (Sunday) through 7 (Saturday).

integer

durationSeconds
optional

The duration of the backup window expressed in seconds.

integer

startSeconds
optional

The start time of the backup window, expressed in seconds elapsed since the beginning of the day.

integer

postCreateHostRequest

Name Description Schema

cpuArchitecture
optional

The CPU architecture of the host.

string

hostMappings
optional

The list of host mappings that are associated with the host.

< hostMappings > array

hostName
required

The name of the host.

string

hwDescription
optional

The hardware description of the host.

string

installedEEBs
optional

The NetBackup EEBs installed on the host.

string

isSecureEnabled
optional

Specifies whether the host can communicate securely or not.

boolean

masterServer
optional

The NetBackup master server that is associated with the host.

string

nbuVersion
optional

The NetBackup version on the host.

string

osType
optional

The operating system type of the host.

string

osVersion
optional

The operating system of the host.

string

servers
optional

The list of servers associated with the host.

< string > array

hostMappings

Name Description Schema

mappedHostName
optional

The name of the mapped host for which the details are provided.

string

postCreateSlpRequest

Name Schema

data
optional

slpDefinition

postRecreateHostRequest

Name Description Schema

cpuArchitecture
optional

The CPU architecture of the host.

string

hostMappings
optional

The list of host mappings that are associated with the host.

< hostMappings > array

hostName
required

The name of the host.

string

hwDescription
optional

The hardware description of the host.

string

installedEEBs
optional

The NetBackup EEBs installed on the host.

string

isSecureEnabled
optional

Specifies whether the host can communicate securely or not.

boolean

masterServer
optional

The NetBackup master server that is associated with the host.

string

nbuVersion
optional

The NetBackup version on the host.

string

osType
optional

The operating system type of the host.

string

osVersion
optional

The operating system of the host.

string

servers
optional

The list of servers associated with the host.

< string > array

uuid
required

The UUID of the host.

string

hostMappings

Name Description Schema

mappedHostName
optional

The name of the mapped host for which the details are provided.

string

putAddHostMapping

Name Description Schema

isApproved
optional

Specifies whether or not the mapping is approved. This field is optional.

boolean

isShared
required

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
required

The data about the client.

data

data

Name Description Schema

attributes
required

The attributes for the host, instance, or instance database. These attributes do not apply for instance groups.

attributes

id
required

The name of the host/instance group to be backed up. Attribute section is not needed when protecting instance group.

string

type
required

The resource type. Must be set to client.

string

attributes

Name Description Schema

OS
optional

The host’s operating system. For example HP-UX11.31, Solaris10, or Windows10.

string

databaseName
optional

The name of the database. This property only applies for the clientType value Protect Instances and Databases.

string

hardware
optional

The host’s hardware. For example HP-UX-IA64, Novel, or RS600.

string

instanceName
optional

The name of the instance. This property only applies for the clientType value Protect Instances and Databases.

string

putHostCommentDetails

Name Description Schema

comment
optional

Host-specific comment to be updated.

string

putIncludeRequest

Name Schema

data
required

data

data

Name Description Schema

attributes
required

attributes

type
required

The resource type. Must be set to "backupSelection".

string

attributes

Name Schema

selections
required

< string > array

putMsdpServerAttributes

Name Description Schema

caCertHash
required

SHA-1 hash of the associated CA certificate for the given host ID (via URL path).

string

putMsdpServerRequest

Name Schema

data
required

putMsdpServerRequestData

putMsdpServerRequestData

Name Schema

attributes
required

putMsdpServerAttributes

type
required

enum (msdpServerCACertHash)

putScheduleRequest

Name Schema

data
required

data

data

Name Description Schema

attributes
required

attributes

id
required

The name of the schedule.

string

type
required

The resource type. Must be set to "schedule".

string

attributes

Name Description Schema

acceleratorForcedRescan
required

Indicates if file checksums are stored to aid in change detection. Applicable only to NetBackup Accelerator backups.

boolean

backupCopies
required

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).

backupCopies

backupType
required

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
optional

Recurring days of the week, recurring days of the month, and exact dates on which this policy will not run.

excludeDates

frequencySeconds
required

For frequency schedule types, the frequency at which to perform the backup, in seconds.

integer

includeDates
optional

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.

includeDates

mediaMultiplexing
required

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

retriesAllowedAfterRunDay
required

Indicates if backups can retry on any day there is an open backup window. Applicable only for the calendar schedule type.

boolean

scheduleType
required

The type of the schedule.

enum (Calendar, Frequency)

snapshotOnly
required

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
required

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
required

Indicates if the storage unit is defined with a storage lifecycle policy (SLP).

boolean

syntheticBackup
required

Indicates if NetBackup performs a synthetic backup.

boolean

backupCopies

Name Description Schema

copies
required

< copies > array

priority
required

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
optional

The approach taken if a particular image fails to copy.

enum (Continue, Fail All Copies)

mediaOwner
optional

The media server or group that owns this copy.

string

retentionPeriod
optional

retentionPeriod

storage
optional

The name of the storage unit associated with the copy.

string

volumePool
optional

The name of the volume pool associated with the copy.

string

excludeDates

Name Description Schema

lastDayOfMonth
required

Indicates if the last day of the month is included.

boolean

recurringDaysOfMonth
required

Recurring days of the month.

< integer > array

recurringDaysOfWeek
required

Recurring days of a week.

< string > array

specificDates
required

A list of specific dates.

< string > array

includeDates

Name Description Schema

lastDayOfMonth
required

Indicates if the last day of the month is included.

boolean

recurringDaysOfMonth
required

Recurring days of the month.

< integer > array

recurringDaysOfWeek
required

Recurring days of a week.

< string > array

specificDates
required

A list of specific dates.

< string > array

startWindow

Name Description Schema

dayOfWeek
required

The day of the week the backup window starts. Possible values for DAY are 1 (Sunday) through 7 (Saturday).

integer

durationSeconds
required

The duration of the backup window expressed in seconds.

integer

startSeconds
required

The start time of the backup window, expressed in seconds elapsed since the beginning of the day.

integer

resourcePoolNode

The properties of the resource pool.

Name Schema

children
optional

< resourcePoolNode > array

name
optional

string

path
optional

string

type
optional

string

resourcePoolResource

The properties of the list of resource pools available on the ESXi or Cluster server.

Name Schema

data
optional

data

data

Name Schema

attributes
optional

attributes

id
optional

string

links
optional

links

type
optional

string

attributes

Name Description Schema

resourcePools
optional

The list of resource pools.

< resourcePoolNode > array

links

Name Schema

self
optional

self

self

Name Schema

href
optional

string

retentionLevelResponseArray

Name Schema

data
optional

< retentionLevelResponseData > array

retentionLevelResponseData

Name Description Schema

attributes
optional

retentionlevelAttributes

id
optional

Value for the retention level.

string

type
optional

Specify 'retentionlevel' as the retention level type.

enum (retentionlevel)

retentionPeriod

The retention period for the image copy.

Name Description Schema

unit
optional

The unit of retention period in terms of time. For example, WEEKS, MONTHS etc. Note that INFINITE applies a retention period of infinity to the image copy, regardless of the value that is specified.

enum (SECONDS, MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS, INFINITE)

value
optional

The value for the retention period for the image copy. Valid values are -1 and above. A value of -1 indicates a retention period of infinity. A value of 0 immediately expires the image copy, regardless of the unit that is specified.

integer

retentionlevelAttributes

Name Schema

retentionPeriod
optional

retentionPeriod

retentionPeriodInSeconds
optional

integer

retentionPeriodLabel
optional

string

slpDefinition

Name Description Schema

attributes
optional

attributes

id
optional

The name of the storage lifecycle policy (SLP).

string

relationships
optional

relationships

type
optional

Type of the object.

enum (slp)

attributes

Name Description Schema

activationTime
optional

Indicates the time at which the storage lifecycle policy (SLP) is activated, in UTC. This parameter is applicable only for an inactive storage lifecycle policy (SLP).

string (date-time)

dataClassification
optional

'Defines the level or classification of data that the storage lifecycle policy (SLP) is allowed to process. The name of the data classification this image is compatible with. "Any" indicates it is able to import and manage any image regardless of data classification. "None" indicates no data classification.'

string

duplicationPriority
optional

The priority of duplication jobs initiated by this storage lifecycle policy (SLP). Valid range is 0 to 99999.

integer

flagValues
optional

'The list of storage lifecycle policy (SLP)-specific flag values. Supported input/output flag values: inactive: If this flag is specified, the storage lifecycle policy (SLP) is inactive. Supported output flag values: snaponly: This flag indicates that the storage lifecycle policy (SLP) contains only a "Snapshot" operation. snapdupe: This flag indicates that the storage lifecycle policy (SLP) contains a "Snapshot" operation and a "Backup From Snapshot" operation. snapreplicate: This flag indicates that the storage lifecycle policy (SLP) contains a "Snapshot" operation and a "Replication" operation. snapindex: This flag indicates that the storage lifecycle policy (SLP) contains a "Snapshot" operation and an "Index From Snapshot" operation.'

< string > array

operationList
optional

The list of operations that the storage lifecycle policy (SLP) will perform on the backup copies.

< slpOperationDefinition > array

slpName
required

The name of the storage lifecycle policy (SLP).

string

versionNumber
optional

The version number of this storage lifecycle policy (SLP) for which data is being returned. This parameter is ignored if passed in the request to create a storage lifecycle policy (SLP).

integer

relationships

Name Schema

versions
optional

versions

versions

Name Schema

data
optional

< data > array

data

Name Description Schema

id
optional

The storage lifecycle policy (SLP) version number.

integer

type
optional

This value is always set to "version".

string

slpOperationDefinition

Name Description Schema

alternateReadServer
optional

The host name to use for reading in a duplication job.

string

flagValues
optional

'The list of operation-specific flag values. Supported input/output flag values: inactive: If this flag is specified, the operation is inactive. deferred_op: If this flag is specified for duplication operation, the operation is deferred until the source copy is about to expire. Supported output flag values: AIR_enabled: This flag indicates that the operation is an "Auto Image Replication (AIR)" operation. snapdupe: This flag indicates that the operation is a "Backup From Snapshot" operation. snapreplicate: This flag indicates that the operation is a "Replication" operation with a "Snapshot" operation as source. snapindex: This flag indicates that the operation is an "Index From Snapshot" operation.'

< string > array

operationActivationTime
optional

'The UTC timestamp at which the operation is activated. This parameter is applicable only for a "suspended" operation.'

string (date-time)

operationIndex
optional

Indicates the execution order of the operations in the storage lifecycle policy (SLP), starting from index 1. This parameter is ignored if passed in the request to create a storage lifecycle policy (SLP).

integer

operationPriority
optional

'Specifies the job priority for each storage lifecycle policy (SLP) operation index. Valid range is 0 to 99999. "-1" indicates that the default duplication priority is effective.'

integer

operationType
required

The operation that is performed for this step in the storage lifecycle policy.

enum (BACKUP, SNAPSHOT, IMPORT, BACKUP_FROM_SNAPSHOT, INDEX_FROM_SNAPSHOT, DUPLICATION, REPLICATION, REPLICATE_TO_REMOTE_MASTER)

preserveMultiplexing
optional

Sets the preserve multiplexing flag for duplication copies. The flag is relevant only for tape copies.

boolean

retentionPeriod
required

retentionPeriod

retentionType
optional

Indicates how to manage the retention of this copy.

enum (FIXED, EXPIRE_AFTER_COPY, MAXIMUM_SNAPSHOT_LIMIT, MIRROR, TARGET_RETENTION, CAPACITY_MANAGED)

serverGroup
optional

The name of the media sharing group that shares the tape media.

string

slpWindowClose
optional

'The action to take if the image processing is not complete or if the images cannot be suspended by the time the storage lifecycle policy (SLP) window closes. This parameter is not applicable for the "Backup" and "Snapshot" operations.'

enum (CANCEL, FINISH)

slpWindowName
optional

The name of the window that defines when the storage lifecycle policy operation can run.

string

sourceOperationIndex
required

Specifies the source copy of the image to duplicate or replicate.

integer

storage
required

storage

targetImportSLP
optional

The name of the storage lifecycle policy (SLP) created for the import operation to the target master server.

string

targetMasterServer
optional

The name of the target master server to replicate the image to.

string

storage

Name Description Schema

dpCapabilities
optional

'The disk pool capabilities of the storage unit or storage unit group to use for this operation. For operationType REPLICATE_TO_REMOTE_MASTER in GET storage lifecycle policy (SLP) operation, this parameter has the value "null" in response.'

< string > array

name
optional

'The name of the storage unit or storage unit group to use for this operation. For operationType REPLICATE_TO_REMOTE_MASTER in GET storage lifecycle policy (SLP) operation, this parameter has the value "null" in response. For operationType REPLICATE_TO_REMOTE_MASTER in POST storage lifecycle policy (SLP) operation, this parameter must be specified as "null".'

string

ssCapabilities
optional

'The storage server capabilities of the storage unit or storage unit group to use for this operation. For operationType REPLICATE_TO_REMOTE_MASTER in GET storage lifecycle policy (SLP) operation, this parameter has the value "null" in response.'

< string > array

stype
optional

'The type of the storage unit or storage unit group to use for this operation. For operationType REPLICATE_TO_REMOTE_MASTER in GET storage lifecycle policy (SLP) operation, this parameter has the value "null" in response.'

string

smtpConfigurationAttributes

Name Description Schema

emailConfigurationEnabled
required

Indicates if email configuration is enabled.

boolean

password
optional

The password for the SMTP server. The password is mandatory if you have provided the user name.

string

port
required

The SMTP server port.

integer

recipientEmailAddress
required

The comma-separated email addresses of the recipients. Maximum 4096 characters.

string

senderDisplayName
optional

The display name of the sender. Maximum 512 characters.

string

senderEmailAddress
required

The email address of the sender. Maximum 256 characters.

string

serverName
required

The name of the SMTP server. Maximum 1024 characters.

string

updateCredentials
optional

Indicates whether the SMTP server credentials are to be updated or not. The credentials are updated if the parameter is set to true.

boolean

userName
optional

The user name for the SMTP server. Maximum 1024 characters.

string

smtpConfigurationDetails

Name Description Schema

emailConfigurationEnabled
optional

Indicates if email configuration is enabled.

boolean

port
optional

The SMTP server port.

integer

recipientEmailAddress
optional

The comma-separated email addresses of the recipients.

string

senderDisplayName
optional

The display name of the sender.

string

senderEmailAddress
optional

The email address of the sender.

string

serverName
optional

The name of the SMTP server.

string

userName
optional

The user name of the SMTP server.

string

smtpConfigurationGetResponse

Name Schema

data
optional

smtpConfigurationGetResponseData

smtpConfigurationGetResponseData

Name Description Schema

attributes
optional

smtpConfigurationDetails

id
optional

string

type
optional

The response for the SMTP server configuration. Must be set to smtpconfiguration.

enum (smtpconfiguration)

smtpConfigurationRequest

JSON object for SMTP server configuration.

Name Schema

data
required

smtpConfigurationRequestData

smtpConfigurationRequestData

Name Description Schema

attributes
required

smtpConfigurationAttributes

type
required

The request for the SMTP server configuration. Must be set to smtpconfiguration.

enum (smtpconfiguration)

supportPluginConfigMetadata

Name Description Schema

attributes
required

The set of plug-in type and configuration instance attributes.

pluginInfoAttribute

id
required

The unique identifier (name) of the plug-in type. For example, the unique identifier for Amazon AWS is "aws".

string

links
required

links

type
optional

The type of resource. For example, "plugin".

enum (plugin)

links

Name Schema

self
required

self

self

Name Schema

href
optional

string

supportedPluginResponse

Name Schema

data
required

supportPluginConfigMetadata

supportedPluginResponseArray

Name Schema

data
required

< supportPluginConfigMetadata > array

updateHostSchema

Name Description Schema

hostName
required

The identifier for the communicating host.

string

state
required

Indicates the state of the host. Possible values are activated, deactivated.

enum (ACTIVATED, DEACTIVATED)

urlSchema

Name Description Schema

url
required

The URL of the WebSocket endpoint that NetBackup connects to.

string

vCenterTopology

The vCenter topology.

Name Schema

children
optional

< vCenterTopology > array

name
optional

string

type
optional

string

vmserver

Name Description Schema

password
required

The password for the credentials.

string

port
optional

The port used to connect to the server.

integer

serverName
required

The name of the VM server.

string

userId
required

The username for the credentials.

string

vmType
required

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, NUTANIX_ACROPOLIS_CLUSTER)

vmserverResponse

Name Schema

data
optional

data

data

Name Schema

attributes
optional

attributes

id
optional

string

links
optional

links

type
optional

string

attributes

Name Schema

vmServer
optional

vmserver

links

Name Schema

self
optional

self

self

Name Schema

href
optional

string

workloadData

Name Schema

data
optional

data

data

Name Schema

attributes
optional

attributes

id
optional

string

links
optional

links

type
optional

string

attributes

Name Description Schema

hierarchy
optional

The vCenter hierarchy.

vCenterTopology

links

Name Schema

self
optional

self

self

Name Schema

href
optional

string

workloadSummary

Name Schema

data
optional

data

data

Name Schema

id
optional

string

links
optional

links

type
optional

string

links

Name Schema

self
optional

self

self

Name Schema

href
optional

string

Security

rbacCertSecurity

Type : apiKey
Name : Authorization
In : HEADER

rbacUserSecurity

Type : apiKey
Name : Authorization
In : HEADER

NetBackup Manage API

Overview

The NetBackup Manage APIs provide access to the alerting operations. The APIs can generate alerts, fetch alert details, and send alert notifications. The APIs also provide a facility to exclude the status codes for which you do not want to send alert notifications.

Version information

Version : 2.0

URI scheme

Host : <masterserver>:1556
BasePath : /netbackup
Schemes : HTTPS

Paths

GET /manage/alerts

Description

Retrieves the list of alerts based on the specified filters. If no filters are specified, information for 10 alerts is retrieved, sorted in descending order by the time they were created. All the filters are based on OData standards and filtering on the following attributes is supported.

Name Supported Operators Description Schema

alertId

eq ne lt gt le ge

The alert ID

integer

severity

eq ne

The severity of the alert. Possible values: INFO,WARNING,ERROR

string

category

eq ne

The category of the alert. Possible values: JOB

string

subCategory

eq ne

The subcategory of the alert. Possible values: STANDARD,PROXY,NONSTANDARD,APOLLO-WBAK,ORACLE,ANY,INFORMIX-ON-BAR,SYBASE,MS-SHAREPOINT,MS-WINDOWS,NETWARE, DATATOOLS-SQL-BACKTRACK,AUSPEX-FASTBACK,OS2,MS-SQL-SERVER,MS-EXCHANGE-SERVER,SAP,DB2,NDMP,FLASHBACKUP,SPLIT-MIRROR,AFS,DFS, DATASTORE,LOTUS-NOTES,TERADATA,OPENVMS,MPE/iX,FLASHBACKUP-WINDOWS,VAULT,BE-MS-SQL-SERVER,BE-MS-EXCHANGE-SERVER,MACINTOSH, DISK STAGING,NBU-CATALOG,GENERIC,CMS-DATABASE,PUREDISK-EXPORT,ENTERPRISE-VAULT,VMWARE,HYPER-V,NBU-SEARCHSERVER,HYPERSCALE, BIGDATA,CLOUD,DEPLOYMENT

string

createdDateTime

eq ne lt gt le ge

The created date time of the alert.

date-time

Requires Permission: [Manage NetBackup]

Parameters

Type Name Description Schema

Query

filter
optional

Specifies the filters according to OData standards.

string

Query

page[limit]
optional

The number of records on one page after the offset.

integer

Query

page[offset]
optional

The alert record number offset.

integer

Query

sort
optional

Sorts values of the specified property in ascending order. Use -sort to sort the values in descending order.

string

Responses

HTTP Code Description Schema

200

Successfully fetched the list of alerts.

alertResponse

400

Bad request.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

500

Internal server error.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

Example HTTP response

Response 200
{
  "links" : {
    "self" : {
      "href" : "/manage/alerts?page[offset]=0&page[limit]=10&sort =-createdDateTime"
    },
    "next" : {
      "href" : "/manage/alerts?page[offset]=10&page[limit]=10&sort=-createdDateTime"
    },
    "prev" : {
      "href" : "/manage/alerts?page[offset]=10&page[limit]=10&sort=-createdDateTime"
    },
    "first" : {
      "href" : "/manage/alerts?page[offset]=0&page[limit]=10&sort=-createdDateTime"
    },
    "last" : {
      "href" : "/manage/alerts?page[offset]=70&page[limit]=10&sort=-createdDateTime"
    }
  },
  "data" : [ {
    "type" : "alert",
    "id" : 2,
    "links" : {
      "self" : {
        "href" : "/manage/alerts/2"
      }
    },
    "attributes" : {
      "titleId" : 1,
      "title" : "Job details are as follows:",
      "descriptionId" : 1,
      "description" : "Job 4 failed with status code 2074 on client",
      "category" : "JOB",
      "subCategory" : "WINDOWS",
      "severity" : "ERROR",
      "context" : "JOB_STATE_FAILED",
      "createdDateTime" : "2018-04-26T13:41:31.751Z",
      "tags" : [ "JOB", "2074" ],
      "systemDefined" : true,
      "params" : {
        "scheduleName" : "TE_FULL",
        "clientName" : "client",
        "status" : "2074",
        "jobId" : "4",
        "policyType" : "WINDOWS_NT",
        "jobType" : "BACKUP",
        "erroMsg" : "Disk volume is down",
        "startTime" : "2018-04-26 09:20:32.0",
        "endTime" : "2018-04-26 09:22:33.0",
        "parentJobId" : "66"
      }
    }
  } ],
  "meta" : {
    "pagination" : {
      "prev" : 0,
      "next" : 10,
      "first" : 0,
      "last" : 70,
      "count" : 0,
      "page" : 0,
      "offset" : 0,
      "pages" : 8,
      "limit" : 0
    }
  }
}

GET /manage/alerts/{alertId}

Description

Get alert based on specified alertId.

Requires Permission: [Manage NetBackup]

Parameters

Type Name Description Schema

Path

alertId
required

The ID of the alert to fetch.

integer

Responses

HTTP Code Description Schema

200

Successfully fetched the alert for the specified alertId.

createAlertResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Resource cannot be found.

errorResponse

500

Internal server error.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

Example HTTP response

Response 200
{
  "data" : {
    "type" : "alert",
    "id" : 2,
    "links" : {
      "self" : {
        "href" : "/manage/alerts/2"
      }
    },
    "attributes" : {
      "titleId" : 1,
      "title" : "Job details are as follows:",
      "descriptionId" : 1,
      "description" : "Job 4 failed with status code 2074 on client",
      "category" : "JOB",
      "subCategory" : "MS-WINDOWS",
      "severity" : "ERROR",
      "context" : "JOB_STATE_FAILED",
      "createdDateTime" : "2018-04-26T13:41:31.751Z",
      "tags" : [ "JOB", "2074" ],
      "systemDefined" : true,
      "params" : {
        "scheduleName" : "TE_FULL",
        "clientName" : "client",
        "status" : "2074",
        "jobId" : "4",
        "policyType" : "WINDOWS_NT",
        "jobType" : "BACKUP",
        "erroMsg" : "Disk volume is down",
        "startTime" : "2018-04-26 09:20:32.0",
        "endTime" : "2018-04-26 09:22:33.0"
      }
    }
  }
}

GET /manage/notification-categories

Description

Fetches the exclusion status of all alert categories and the list of respective status codes for which alert notifications are not sent. If no filters are specified, information for 10 record is retrieved, sorted in ascending order by the id. All the filters are based on OData standards and filtering on the following attributes is supported.

Name Supported Operators Description Schema

id

eq ne lt gt le ge

The alert category ID

integer

category

eq ne

The category of the alert. Possible values: JOB

string

categoryExcluded

eq ne

Flag to determine category is excluded from send alert notificaion

boolean

Requires Permission: [Manage NetBackup]

Parameters

Type Name Description Schema

Query

filter
optional

Specifies the filters according to OData standards.

string

Query

page[limit]
optional

The number of records on one page after the offset.

integer

Query

page[offset]
optional

The record number offset.

integer

Query

sort
optional

Sorts values of the specified property in ascending order. Use -sort to sort the values in descending order.

string

Responses

HTTP Code Description Schema

200

Returned the exclusion status of all alert categories and the list of respective status codes for which alert notifications are not sent.

getNotificationCategoriesResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

500

Internal server error.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

Example HTTP response

Response 200
{
  "data" : [ {
    "type" : "notificationCategory",
    "id" : 1,
    "links" : {
      "self" : {
        "href" : "https://localhost:1556/netbackup/manage/notification-categories/1"
      }
    },
    "attributes" : {
      "category" : "JOB",
      "categoryExcluded" : false,
      "excludedStatusCodes" : "2074, 219, 4400-4430",
      "createdDateTime" : "2018-05-04T10:18:36.271Z",
      "lastUpdatedDateTime" : "2018-05-07T07:39:59.181Z"
    }
  } ],
  "meta" : {
    "pagination" : {
      "pages" : 1,
      "offset" : 0,
      "last" : 0,
      "first" : 0,
      "count" : 2,
      "page" : 0,
      "limit" : 10
    }
  },
  "links" : {
    "self" : {
      "href" : "https://localhost:1556/netbackup/manage/notification-categories?page[offset]=0&page[limit]=10&sort=-id"
    },
    "first" : {
      "href" : "https://localhost:1556/netbackup/manage/notification-categories?page[offset]=0&page[limit]=10&sort=-id"
    },
    "last" : {
      "href" : "https://localhost:1556/netbackup/manage/notification-categories?page[offset]=0&page[limit]=10&sort=-id"
    }
  }
}

GET /manage/notification-categories/{categoryId}

Description

Fetches the exclusion status of the specified alert category and the list of respective status codes for which alert notifications are not sent.

Requires Permission: [Manage NetBackup]

Parameters

Type Name Description Schema

Path

categoryId
required

The ID of the alert category.

integer

Responses

HTTP Code Description Schema

200

Returned the exclusion status of the specified alert category and the list of respective status codes for which alert notifications are not sent.

getNotificationCategoryResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Resource could not be found.

errorResponse

500

Internal server error.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

Example HTTP response

Response 200
{
  "data" : {
    "type" : "notificationCategory",
    "id" : 1,
    "links" : {
      "self" : {
        "href" : "https://localhost:1556/netbackup/manage/notification-categories/1"
      }
    },
    "attributes" : {
      "category" : "JOB",
      "categoryExcluded" : false,
      "excludedStatusCodes" : "2074, 219, 4400-4430",
      "createdDateTime" : "2018-05-04T10:18:36.271Z",
      "lastUpdatedDateTime" : "2018-05-07T07:39:59.181Z"
    }
  }
}

PATCH /manage/notification-categories/{categoryId}

Description

Updates the exclusion status of the specified alert category and the list of respective status codes for which alert notifications are not sent.

Requires Permission: [Manage NetBackup]

Parameters

Type Name Description Schema

Path

categoryId
required

The ID of the alert category.

integer

Body

requestData
required

Request data to be updated.

patchNotificationCategoryRequest

Responses

HTTP Code Description Schema

200

Updated the exclusion status of the specified alert category and the list of respective status codes for which alert notifications are not sent.

getNotificationCategoryResponse

400

Bad request, invalid parameter with request payload.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Resource could not be found.

errorResponse

500

Internal server error.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

Example HTTP request

Request body
{
  "data" : {
    "type" : "notificationCategory",
    "id" : "1",
    "attributes" : {
      "categoryExcluded" : false,
      "excludedStatusCodes" : "2074, 219, 4400-4430"
    }
  }
}

Example HTTP response

Response 200
{
  "data" : {
    "type" : "notificationCategory",
    "id" : 1,
    "links" : {
      "self" : {
        "href" : "https://localhost:1556/netbackup/manage/notification-categories/1"
      }
    },
    "attributes" : {
      "category" : "JOB",
      "categoryExcluded" : false,
      "excludedStatusCodes" : "2074, 219, 4400-4430",
      "createdDateTime" : "2018-05-04T10:18:36.271Z",
      "lastUpdatedDateTime" : "2018-05-07T07:39:59.181Z"
    }
  }
}

Definitions

alertDetails

Name Description Schema

category
optional

The category that applies to the alert.

enum (JOB)

context
optional

Indicates the reason the alert was generated.

enum (GENERAL, JOB_STATE_FAILED, JOB_STATE_SUSPEND, JOB_TYPE_BACKUP, CREDENTIAL)

createdDateTime
optional

A UTC timestamp of when the alert was created.

string

description
optional

The description of the alert.

string

descriptionId
optional

The ID for the description of the alert.

integer

params
optional

The list of alert parameters.

< string, string > map

severity
optional

The severity of alert.

enum (INFO, WARNING, ERROR)

subCategory
optional

The subcategory that applies to the alert.

enum (STANDARD, PROXY, NONSTANDARD, APOLLO-WBAK, ORACLE, ANY, INFORMIX-ON-BAR, SYBASE, MS-SHAREPOINT, MS-WINDOWS, NETWARE, DATATOOLS-SQL-BACKTRACK, AUSPEX-FASTBACK, OS2, MS-SQL-SERVER, MS-EXCHANGE-SERVER, SAP, DB2, NDMP, FLASHBACKUP, SPLIT-MIRROR, AFS, DFS, DATASTORE, LOTUS-NOTES, TERADATA, OPENVMS, MPE/iX, FLASHBACKUP-WINDOWS, VAULT, BE-MS-SQL-SERVER, BE-MS-EXCHANGE-SERVER, MACINTOSH, DISK STAGING, NBU-CATALOG, GENERIC, CMS-DATABASE, PUREDISK-EXPORT, ENTERPRISE-VAULT, VMWARE, HYPER-V, NBU-SEARCHSERVER, HYPERSCALE, BIGDATA, CLOUD, DEPLOYMENT)

systemDefined
optional

Indicates if the alert was system-generated or user-defined.

boolean

tags
optional

The tags that are associated with the alert.

< string > array

title
optional

The title of the alert.

string

titleId
optional

The title ID for the alert.

integer

alertDetailsResponseData

Name Description Schema

attributes
optional

alertDetails

id
optional

string

links
optional

links

type
optional

The response for the alert. Must be set to alert.

enum (alert)

links

Name Schema

self
optional

linkObject

alertResponse

Name Description Schema

data
optional

The list of alerts.

< alertDetailsResponseData > array

links
optional

links

meta
optional

meta

links

Name Schema

first
optional

first

last
optional

last

next
optional

next

prev
optional

prev

self
optional

self

first

Name Schema

href
optional

string

last

Name Schema

href
optional

string

next

Name Schema

href
optional

string

prev

Name Schema

href
optional

string

self

Name Schema

href
optional

string

meta

Name Schema

pagination
optional

pagination

pagination

Name Schema

count
optional

integer

first
optional

integer

last
optional

integer

limit
optional

integer

next
optional

integer

offset
optional

integer

page
optional

integer

pages
optional

integer

prev
optional

integer

alertResponseData

Name Description Schema

attributes
optional

alertDetails

id
optional

string

links
optional

links

type
optional

The response for the alert. Must be set to alert.

enum (alert)

links

Name Schema

self
optional

linkObject

createAlertResponse

The JSON object for alert.

Name Schema

data
required

alertResponseData

errorResponse

Name Description Schema

details
optional

A map containing error field and error field message to provide more context to nature of the error.

object

errorCode
required

The NetBackup error code.

integer (int64)

errorMessage
required

The NetBackup error code description.

string

getNotificationCategoriesResponse

Name Description Schema

data
optional

The list of notification categories.

< notificationCategoryData > array

links
optional

links

meta
optional

meta

links

Name Schema

first
optional

first

last
optional

last

next
optional

next

prev
optional

prev

self
optional

self

first

Name Schema

href
optional

string

last

Name Schema

href
optional

string

next

Name Schema

href
optional

string

prev

Name Schema

href
optional

string

self

Name Schema

href
optional

string

meta

Name Schema

pagination
optional

pagination

pagination

Name Schema

count
optional

integer

first
optional

integer

last
optional

integer

limit
optional

integer

next
optional

integer

offset
optional

integer

page
optional

integer

pages
optional

integer

prev
optional

integer

getNotificationCategoryResponse

Name Schema

data
optional

notificationCategoryData

linkObject

Name Schema

href
optional

string

notificationCategoryAttributes

Name Description Schema

category
optional

The alert category.

enum (JOB)

categoryExcluded
optional

Determines whether alert notifications should be sent for the specified alert category or not.

boolean

createdDateTime
optional

A UTC timestamp of when the record was created.

string

excludedStatusCodes
optional

Specify the status codes to be excluded as comma delimited. Specify the range to be excluded with a hyphen.
Example : "2074, 219, 4400-4430"

string

lastUpdatedDateTime
optional

A UTC timestamp of when the record was updated.

string

notificationCategoryData

Name Description Schema

attributes
optional

notificationCategoryAttributes

id
optional

string

links
optional

links

type
optional

Fetches the list of excluded status codes.

enum (notificationCategory)

links

Name Schema

self
optional

linkObject

patchNotificationAttributes

Name Description Schema

categoryExcluded
optional

Determines whether alert notifications should be sent for the specified alert category or not.

boolean

excludedStatusCodes
optional

Specify the status codes to be excluded as comma delimited. Specify the range to be excluded with a hyphen.
Example : "2074, 219, 4400-4430"

string

patchNotificationCategoryRequest

Name Description Schema

attributes
required

patchNotificationAttributes

id
required

string

type
required

Specify the status codes to be excluded.

enum (notificationCategory)

Security

rbacSecurity

Type : apiKey
Name : Authorization
In : HEADER

NetBackup RBAC Administration API

Overview

The NetBackup RBAC Admin API provides access to NetBackup role based access control configuration.

Version information

Version : 2.0

URI scheme

Host : <masterserver>:1556
BasePath : /netbackup/rbac
Schemes : HTTPS

Paths

POST /access-rules

Description

Creates a new access rule that defines the permissions for a user and the object groups the user can access.

Requires Permission: [Manage Access Rules]

Parameters

Type Name Description Schema

Body

body
required

The access rule resource to create.

accessRuleResource

Responses

HTTP Code Description Schema

201

The access rule was created.
Headers :
Location (string (url)) : The link to the newly created access rule.

accessRuleResource

400

The request is not valid. Ensure that the correct format is used for the request. Also ensure that the principal, role, or objectgroup ID in the request exists and is valid.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

409

An access rule already exists with the combination of this principal, this object group, and this role.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

Server busy. Try again later.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /access-rules

Description

Gets a list of configured access rules.

Requires Permission: [View Access Rules, Manage Access Rules]

Parameters

Type Name Description Schema

Query

include
optional

Appends the included section in the response payload with details about the relationships that are specified in the include query. The include query is a comma-separated list of relationships that can include role, objectGroup, userPrincipal, or groupPrincipal.

enum (role, objectGroup, userPrincipal, groupPrincipal)

Responses

HTTP Code Description Schema

200

Successful response.

accessRulesResource

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Resource not found.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

Server busy. Try again later.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /access-rules/{ruleId}

Description

Gets a specific access rule by ID.

Requires Permission: [View Access Rules, Manage Access Rules]

Parameters

Type Name Description Schema

Path

ruleId
required

string

Query

include
optional

Appends the included section in the response payload with details about the relationships that are specified in the include query. The include query is a comma-separated list of relationships that can include role, objectGroup, userPrincipal, or groupPrincipal.

enum (role, objectGroup, userPrincipal, groupPrincipal)

Responses

HTTP Code Description Schema

200

Successful response.

accessRuleResource

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Resource not found.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

Server busy. Try again later.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

PUT /access-rules/{ruleId}

Description

Updates an access rule resource.

Requires Permission: [Manage Access Rules]

Parameters

Type Name Description Schema

Path

ruleId
required

The ID of the access rule to update.

integer

Body

body
required

The role resource to update.

accessRuleResource

Responses

HTTP Code Description Schema

200

The access rule was successfully updated.

accessRuleResource

400

The request is not valid. Ensure that the correct format is used.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

403

Forbidden. An attempt to alter system-defined data was denied.

errorResponse

404

Resource not found.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

Server busy. Try again later.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

DELETE /access-rules/{ruleId}

Description

Deletes an access rule resource.

Requires Permission: [Manage Access Rules]

Parameters

Type Name Schema

Path

ruleId
required

string

Responses

HTTP Code Description Schema

204

Successful response. Access rule was deleted.

No Content

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

403

Forbidden. An attempt to delete system-defined data was denied.

errorResponse

404

Resource not found.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

Server busy. Try again later.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

GET /identities

Description

Obtains the list of users or the user groups based on the specified filters provided the specified user or user groups are present in the directory service or the local domain. All the filter criteria are in OData format. Currently, filters are supported for the following attributes:

Name Supported Operators Description Schema

id

eq

The name that identifies the user or the user group. Standard formats are supported for this value.

string

Requires Permission: [View Access Rules, Manage Access Rules]

Parameters

Type Name Description Schema

Query

filter
required

The filter criteria in OData format.

string

Responses

HTTP Code Description Schema

200

Validated and retrieved the identity details of the user or user group from directory service or local domain successfully based on the given filter criteria.

identitiesResource

400

Bad request. The request contains invalid characters in the user name or user group name.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

POST /object-groups

Description

Create a new object group resource.

Requires Permission: [Manage Access Rules]

Parameters

Type Name Description Schema

Body

body
required

The object group resource to be created.

objectGroupResource

Responses

HTTP Code Description Schema

201

The object group resource was created.
Headers :
Location (string (url)) : A link to the new object group.

objectGroupResource

400

The request is not valid. Ensure that the correct format is used.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

409

The object group already exists.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

Server busy. Try again later.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /object-groups

Description

Lists the object groups.

Requires Permission: [View Access Rules, Manage Access Rules]

Responses

HTTP Code Description Schema

200

Successful response.

objectGroupsResource

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Resource not found.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

Server busy. Try again later.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /object-groups/{objectGroupId}

Description

Gets the object group by ID.

Requires Permission: [View Access Rules, Manage Access Rules]

Parameters

Type Name Description Schema

Path

objectGroupId
required

The ID of the object group to return.

string

Responses

HTTP Code Description Schema

200

Successful response.

objectGroupResource

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Resource not found.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

Server busy. Try again later.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

PUT /object-groups/{objectGroupId}

Description

Updates an object group.

Requires Permission: [Manage Access Rules]

Parameters

Type Name Description Schema

Path

objectGroupId
required

The ID of the object group to update.

string

Body

body
required

The object group record to update.

objectGroupResource

Responses

HTTP Code Description Schema

204

Successfully updated the object group.

No Content

400

The request is not valid. Ensure that the correct format is used..

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

403

An attempt to alter system-defined data was denied.

errorResponse

404

Resource not found.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

Server busy. Try again later.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

DELETE /object-groups/{objectGroupId}

Description

Deletes an object group resource.

Requires Permission: [Manage Access Rules]

Parameters

Type Name Schema

Path

objectGroupId
required

string

Responses

HTTP Code Description Schema

204

No Content. The object group was successfully deleted.

No Content

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

403

An attempt to alter system-defined data was denied.

errorResponse

404

Resource not found.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

Server busy. Try again later.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

GET /object-types

Description

Returns the list of all valid RBAC object types.

Requires Permission: [View Access Rules, Manage Access Rules]

Responses

HTTP Code Description Schema

200

Successfully returned the list of all the valid RBAC object types.

rbacObjectTypesResource

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Resource not found.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

Server busy. Try again later.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /permission-categories

Description

Returns a list of permission category resources.

Requires Permission: [View Access Rules, Manage Access Rules]

Responses

HTTP Code Description Schema

200

Successfully returned the list of permission categories.

permissionCategoriesResource

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Resource not found.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

Server busy. Try again later.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /permissions

Description

Gets all permission objects.

Requires Permission: [View Access Rules, Manage Access Rules]

Responses

HTTP Code Description Schema

200

Successful response.

permissionsResource

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Resource not found.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

Server busy. Try again later.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /permissions/{permissionId}

Description

Gets the permission object for a given resource ID.

Requires Permission: [View Access Rules, Manage Access Rules]

Parameters

Type Name Description Schema

Path

permissionId
required

The ID of the permission resource to fetch.

integer

Responses

HTTP Code Description Schema

200

Successful response.

permissionResource

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Resource not found.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

Server busy. Try again later.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

POST /roles

Description

Creates a new role resource.

Requires Permission: [Manage Access Rules]

Parameters

Type Name Description Schema

Body

body
required

The role resource to create.

role

Responses

HTTP Code Description Schema

201

New role resource created.
Headers :
Location (string (url)) : A link to the new role resource.

roleResource

400

The request is not valid. Ensure that the correct format is used.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

409

The role already exists.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

Server busy. Try again later.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /roles

Description

Returns a list of configured roles.

Requires Permission: [View Access Rules, Manage Access Rules]

Parameters

Type Name Description Schema

Query

include
optional

Appends the included section in the response payload with details about the relationships that are specified in the include query. The include query is the name of the relationship, which is "permissions".

enum (permissions)

Responses

HTTP Code Description Schema

200

Successful response.

rolesResource

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Resource not found.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

Server busy. Try again later.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /roles/{roleId}

Description

Gets the role object for the specified role ID.

Requires Permission: [View Access Rules, Manage Access Rules]

Parameters

Type Name Description Schema

Path

roleId
required

The role resource ID.

string

Query

include
optional

Appends the included section in the response payload with details about the relationships that are specified in the include query. The include query is the name of the relationship, which is "permissions".

enum (permissions)

Responses

HTTP Code Description Schema

200

Successful response.

roleResource

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Resource not found.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

Server busy. Try again later.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

PUT /roles/{roleId}

Description

Updates a role resource.

Requires Permission: [Manage Access Rules]

Parameters

Type Name Description Schema

Path

roleId
required

The ID of the role to be updated.

string

Body

body
required

The role resource to update.

roleResource

Responses

HTTP Code Description Schema

204

The role was successfully updated.

No Content

400

The request is not valid. Ensure that the correct format is used.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

403

Forbidden. An attempt to alter system-defined data was denied.

errorResponse

404

Resource not found.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

Server busy. Try again later.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

DELETE /roles/{roleId}

Description

Deletes a role resource for a given role ID.

Requires Permission: [Manage Access Rules]

Parameters

Type Name Description Schema

Path

roleId
required

The ID of the role to delete.

string

Responses

HTTP Code Description Schema

204

No content. The role was deleted.

No Content

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

403

Forbidden. An attempt to alter system-defined data was denied.

errorResponse

404

The entity was not found. The role to delete does not exist.

errorResponse

500

An unexpected system error occurred.

errorResponse

503

Server busy. Try again later.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

Definitions

accessRule

Name Schema

attributes
optional

attributes

id
optional

string

links
optional

object

meta
optional

object

relationships
required

relationships

type
required

enum (access-rule)

attributes

Name Description Schema

description
optional

The description about the access rule being configured. Maximum 256 bytes.

string

isSystemDefined
optional

Indicates if the access rule is predefined in NetBackup. Predefined access rules cannot be modified.

boolean

relationships

Name Description Schema

groupPrincipal
optional

The user group that is configured for the access rule. Either userPrincipal or groupPrincipal is required. The format should be <domain name>:<group name>:<domain type>:<group id>. Use the /rbac/identities API to get the identity details of the group principal to pass with this API. The type should be group-principal.

groupPrincipal

objectGroup
required

Defines the NetBackup objects that are configured for the access rule. The type should be object-group.

objectGroup

role
required

Defines the roles that are configured for the access rule.

role

userPrincipal
optional

The user that is configured for the access rule. Either userPrincipal or groupGrincipal is required. The format should be <domain name>:<user name>:<domain type>:<user id>. Use the /rbac/identities API to get the identity details of the user principal to pass with this API. The type should be user-principal.

userPrincipal

groupPrincipal

Name Schema

data
required

resourceIdentifierObject

objectGroup

Name Schema

data
required

resourceIdentifierObject

role

Name Schema

data
required

resourceIdentifierObject

userPrincipal

Name Schema

data
required

resourceIdentifierObject

accessRuleResource

Defines the users, roles, and object groups that make up an access rule. An access rule is only valid if it contains all three of these elements.

Name Schema

data
required

accessRule

accessRulesResource

The collection of configured access rules.

Name Schema

data
required

< accessRule > array

links
optional

object

meta
optional

object

collectionCriteria

The filtering rules that create the dynamic list of objects in the object group. Use the API GET /object-types to get the valid objectType and valid attributes that you can use for objectCriterion.

Name Description Schema

criterionId
optional

integer

isSystemDefined
optional

Indicates if the collection criteria is predefined in NetBackup. Predefined collection criteria cannot be modified.

boolean

objectCriterion
required

The filtering rules that create the dynamic list of objects in the object group. The rules should be based on OData standards. Maximum 4096 bytes.

string

objectType
required

string

errorResponse

Name Description Schema

details
optional

A map containing error field and error field message to provide more context to nature of the error.

object

errorCode
required

The NetBackup error code.

integer (int64)

errorMessage
required

The NetBackup error code description.

string

identitiesResource

Collection of identityResource objects.

Name Schema

data
optional

< identityResource > array

identityResource

A user or a user group represented in the directory service or local domain.

Name Schema

data
optional

data

data

Name Description Schema

attributes
optional

The attributes of the identity.

attributes

id
optional

The name that identifies the user or the user group.

string

links
optional

The links to the URLs for the identity.

links

type
optional

string

attributes

Name Description Schema

description
optional

The description of the user or the user group.

string

displayName
required

The display name of the user or the user group.

string

domainName
optional

The domain name of the user or the user group. If the domain name is not provided as an input, this value is set to the broker’s hostname.

string

domainType
optional

The domain type of the user or the user group.

enum (ldap, nt, unixpwd)

groupList
optional

Indicates the membership of the account. This value is null for user groups.

< string > array

id
required

The unique ID of the user or the user group in the directory service or the local domain.

string

identityType
required

The identity type.

enum (User, Group)

isLocked
optional

Indicates if the account is disabled or locked by the operating system. For user groups and some operating systems, this value is always set to FALSE.

boolean

name
optional

The name of the principal, either the user or user group.

string

links

Name Schema

self
optional

self

self

Name Description Schema

href
optional

The URI to get details for the identity.

string

objectGroup

Name Schema

attributes
required

attributes

id
optional

string

links
optional

object

meta
optional

object

type
required

enum (object-group)

attributes

Name Description Schema

criteria
required

The rules for filtering NetBackup objects, in OData format.

< collectionCriteria > array

description
optional

A user-defined description for the object group. Maximum 256 bytes.

string

isSystemDefined
optional

Indicates if the object group is predefined in NetBackup. Predefined object groups cannot be modified.

boolean

name
required

A user-defined name for the object group. Maximum 256 bytes.

string

objectGroupResource

Defines the dynamic list of NetBackup objects for the access rule.

Name Schema

data
required

objectGroup

objectGroupsResource

Name Schema

data
required

< objectGroup > array

links
optional

object

meta
optional

object

objectType

Name Schema

attributes
optional

attributes

id
optional

string

links
optional

object

meta
optional

object

type
required

enum (object-type)

attributes

Name Schema

filterableAttributes
required

< validAttributeObject > array

permission

Name Schema

attributes
required

attributes

id
optional

string

links
optional

object

meta
optional

object

type
required

enum (permission)

attributes

Name Description Schema

isSystemDefined
optional

Indicates if the permission is predefined in NetBackup. Predefined permissions cannot be modified.

boolean

name
required

The name of the permission.

string

permissionCategoriesResource

The list of permission category resources.

Name Schema

data
optional

< permissionCategory > array

links
optional

object

meta
optional

object

permissionCategory

Name Description Schema

attributes
required

attributes

id
optional

The unique permission category resource ID.

string

links
optional

object

meta
optional

object

relationships
optional

relationships

type
required

string

attributes

Name Description Schema

description
optional

The description of the permission category.

string

isSystemDefined
optional

Indicates if the permission category is predefined in NetBackup. Predefined permission category cannot be modified.

boolean

name
required

The NetBackup-defined name for the permission category.

string

relationships

Name Description Schema

permissions
required

The permissions included in this permission category.

permissions

permissions

Name Schema

data
optional

< resourceIdentifierObject > array

permissionCategoryResource

The permission category resource that defines the list of permissions.

Name Schema

data
optional

permissionCategory

permissionResource

A system-defined resource that groups the permissions that are needed to perform a NetBackup operation.

Name Schema

data
required

permission

permissionsResource

The collection of permissions.

Name Schema

data
required

< permission > array

links
optional

object

meta
optional

object

rbacObjectTypesResource

The collection of valid RBAC object types.

Name Schema

data
optional

< objectType > array

links
optional

object

meta
optional

object

resourceIdentifierObject

A resource identifier object representing an individual resource.

Name Schema

id
required

string

meta
optional

object

type
required

enum (role, object-group, user-principal, group-principal, access-rule, permission)

role

Name Description Schema

attributes
required

attributes

id
optional

The unique role resource ID.

string

links
optional

object

meta
optional

object

relationships
optional

relationships

type
required

string

attributes

Name Description Schema

description
optional

The user-defined description for the role. Maximum 256 bytes.

string

isSystemDefined
optional

Indicates if the role is predefined in NetBackup. Predefined roles cannot be modified.

boolean

name
required

The user-defined name for the role. Maximum 256 bytes.

string

relationships

Name Description Schema

permissions
required

The permissions allowed for this role. The type should be permission.

permissions

permissions

Name Schema

data
optional

< resourceIdentifierObject > array

roleResource

The role resource that defines the permissions.

Name Schema

data
optional

role

rolesResource

The collection of role resources.

Name Schema

data
optional

< role > array

links
optional

object

meta
optional

object

validAttributeObject

A resource identifier object that represents an individual attribute.

Name Schema

name
required

string

type
required

string

Security

rbacSecurity

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 : 2.0

URI scheme

Host : <masterserver>:1556
BasePath : /netbackup
Schemes : HTTPS

Paths

POST /recovery/workloads/cloud/scenarios/asset/recover

Description

Recovers a cloud asset.

Requires Permission: [Recover/Restore]

Parameters

Type Name Description Schema

Body

recoveryRequest
required

The request for a cloud asset recovery.

cloudAssetRecoveryRequest

Responses

HTTP Code Description Schema

201

The recovery job started successfully.
Headers :
Location (string) : Contains the link to the created recovery job.

recoveryResponse

400

Bad request. The request JSON has an invalid syntax or illegal values.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Not found. The specified sourceAsset or backup image was not found.

errorResponse

405

Method not allowed. The specified HTTP operation is invalid.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

Internal server error. Failed to start recovery.

errorResponse

503

The server is busy. Failed to start recovery.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

Example HTTP request

Request body
{
  "data" : {
    "type" : "recoveryRequest",
    "attributes" : {
      "recoveryPoint" : {
        "sourceAssetId" : "example-asset-id",
        "filter" : "backupTime ge '2017-11-20T23:20:50Z' and backupTime le '2018-12-20T23:20:50Z'"
      },
      "recoveryObject" : {
        "destinationAssetId" : "example-asset-id-2"
      }
    }
  }
}

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
      }
    }
  }
}

POST /recovery/workloads/vmware/instant-access-mounts

Description

Creates a new instant access mount.

Requires Permission: [Download Files, Restore Files]

Parameters

Type Name Schema

Body

body
required

instantAccessMountRequest

Responses

HTTP Code Description Schema

201

Successfully created the instant access mount.
Headers :
Location (string (url)) : A link to newly created instant access mount.

instantAccessMountResponse

400

Bad request. The request JSON has an invalid syntax or illegal values.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Not found. The specified backup image was not found.

errorResponse

405

Method not allowed. The specified HTTP operation is invalid.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

Internal server error. Failed to create instant access mount.

errorResponse

503

The server is busy. Failed to create instant access mount.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /recovery/workloads/vmware/instant-access-mounts

Description

Gets the list of mounts based on specified filters. If no filters are specified, information for all mounts is retrieved. Filters are based on OData standards, and filtering on the following attributes is supported.

clientName eq ne contains, startswith, endswith The name of the client. string

Requires Permission: [Download Files, Restore Files]

Responses

HTTP Code Description Schema

200

Successfully retrieved a list of existing instant access mounts.

instantAccessMountResponseArray

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /recovery/workloads/vmware/instant-access-mounts/{mountId}

Description

Gets detailed information about the specified instant access mount.

Requires Permission: [Download Files, Restore Files]

Parameters

Type Name Description Schema

Path

mountId
required

Instant access mount id.

string

Responses

HTTP Code Description Schema

200

Successfully retrieved instant access mount information.

instantAccessMountResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The instant access mount was not found.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

DELETE /recovery/workloads/vmware/instant-access-mounts/{mountId}

Description

Deletes the existing instant access mount.

Requires Permission: [Download Files, Restore Files]

Parameters

Type Name Description Schema

Path

mountId
required

Instant access mount id.

string

Responses

HTTP Code Description Schema

204

Successfully deleted the existing instant access mount.

No Content

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The instant access mount was not found.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /recovery/workloads/vmware/instant-access-mounts/{mountId}/download

Description

Fetches the download link of the file from the instant access mount.

Requires Permission: [Download Files]

Parameters

Type Name Description Schema

Path

mountId
required

Instant access mount id.

string

Query

id
optional

The path of the file to be downloaded.

string

Responses

HTTP Code Description Schema

200

The download link of the file was successfully fetched from the instant access mount.
Headers :
Location (string (url)) : The download URL of the Storage Platform Web Service.

getDownloadUrlResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The instant access mount was not found.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /recovery/workloads/vmware/instant-access-mounts/{mountId}/files

Description

Gets the content of a specified directory inside instant access mount.

Requires Permission: [Download Files, Restore Files]

Parameters

Type Name Description Schema Default

Path

mountId
required

Instant access mount id.

string

Query

filter
optional

The filter criteria in OData format. The filter parameter will provide the internal path of instant-access-mount. This internal path should specify an directory and this directory’s content will be returned.

string

Query

page[limit]
optional

The number of items to be returned on this call.

integer

10

Query

page[offset]
optional

The offset of the first item to be returned on this call. All the filters are based on OData standards and filtering on the following attributes is supported. [width="90%", cols="3, ^4, ^8, 2", options="header"] |========================================================= |Name|Supported Operators|Description|Schema |path|startsWith|The internal path which content will be returned. By default, path is set to '/'|string |id|eq|The id of the file to be downloaded |=========================================================

integer

0

Responses

HTTP Code Description Schema

200

Successfully retrieved directory content of instant access mount.

instantAccessMountContentItemResponseArray

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The instant access mount was not found.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

POST /recovery/workloads/vmware/instant-access-mounts/{mountId}/restore

Description

Restores the specified file in instant access mount to the specified VM path without requiring a NetBackup client.

Requires Permission: [Restore Files]

Parameters

Type Name Description Schema

Path

mountId
required

Instant access mount id.

string

Body

body
required

instantAccessMountSFRRequest

Responses

HTTP Code Description Schema

201

Successfully restore the file into the VM.

instantAccessMountSFRResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The instant access mount was not found.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

POST /recovery/workloads/vmware/instant-access-vms

Description

Creates a new instant access VM.

Requires Permission: [Instant Access]

Parameters

Type Name Schema

Body

body
required

instantAccessVmRequest

Responses

HTTP Code Description Schema

201

Successfully created the instant access vm.
Headers :
Location (string (url)) : A link to newly created instant access vm.

instantAccessVmResponse

400

Bad request. The request JSON has an invalid syntax or illegal values.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Not found. The specified backup image was not found.

errorResponse

405

Method not allowed. The specified HTTP operation is invalid.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

Internal server error. Failed to create instant access vm.

errorResponse

503

The server is busy. Failed to create instant access vm.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /recovery/workloads/vmware/instant-access-vms

Description

Returns a list of all existing instant access VMs.

Requires Permission: [Instant Access]

Responses

HTTP Code Description Schema

200

Successfully retrieved a list of existing instant access vms.

instantAccessVmResponseArray

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /recovery/workloads/vmware/instant-access-vms/{mountId}

Description

Gets detailed information about the specified instant access VM.

Requires Permission: [Instant Access]

Parameters

Type Name Description Schema

Path

mountId
required

Instant access mount id.

string

Responses

HTTP Code Description Schema

200

Successfully retrieved instant access mount information.

instantAccessVmResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The instant access vm was not found.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

DELETE /recovery/workloads/vmware/instant-access-vms/{mountId}

Description

Deletes the existing instant access VM.

Requires Permission: [Instant Access]

Parameters

Type Name Description Schema

Path

mountId
required

Instant access mount id.

string

Responses

HTTP Code Description Schema

204

Successfully deleted the existing instant access vm.

No Content

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The instant access vm was not found.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

POST /recovery/workloads/vmware/scenarios/full-vm/recover

Description

Recovers a full VMware virtual machine.

Requires Permission: [Recover/Restore, Instant Access, Download Files, Restore Files]

Parameters

Type Name Description Schema

Body

recoveryRequest
required

The request for a full VMware VM recovery.

vmwareFullVmRecoveryRequest

Responses

HTTP Code Description Schema

201

The recovery job started successfully.
Headers :
Location (string) : Contains the link to the created recovery job.

recoveryResponse

400

Bad request. The request JSON has an invalid syntax or illegal values.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Not found. The specified client or backup image was not found.

errorResponse

405

Method not allowed. The specified HTTP operation is invalid.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

Internal server error. Failed to start recovery.

errorResponse

503

The server is busy. Failed to start recovery.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

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

cloudAssetRecoveryRequest

The recovery request schema for cloud asset recovery.

Name Description Schema

data
required

Contains the recovery request data.

data

data

Name Description Schema

attributes
required

Contains the recovery request attributes.

attributes

type
required

The resource type. Must be set to recoveryRequest.
Default : "recoveryRequest"

enum (recoveryRequest)

attributes

Name Description Schema

recoveryObject
optional

The asset that is specified for the recovery.

recoveryObject

recoveryPoint
required

Selects the recovery point for this recovery based on the specified options.

recoveryPoint

recoveryObject

Name Description Schema

destinationAssetId
optional

Represents the Cloud asset ID for the recovery destination. If not specified, the asset is restored to its original location.

string

recoveryPoint

Name Description Schema

backupId
optional

The backup image identifier to use for this recovery. You must specify either backupId or the sourceAssetId. Also see sourceAssetId.

string

filter
optional

Optional. Selects the backup images for recovery based on the specified filter. Use with sourceAssetId. If more than one backup image matches the filter, NetBackup selects the most recent one. All the filters are based on the OData standard and filtering on the following attributes is supported.

Name Supported Operators Description Schema
backupTime ge le The backup timestamp in ISO 8601 format date-time

string

sourceAssetId
optional

The asset identifier that was used at the time of backup. You must specify either sourceAssetId or the backupId. Also see backupId. Recovery is performed using the most recent backup image, unless a filter is specified.

string

errorResponse

Name Description Schema

details
optional

A map containing error field and error field message to provide more context to nature of the error.

object

errorCode
required

The NetBackup error code.

integer (int64)

errorMessage
required

The NetBackup error code description.

string

getDownloadUrlResponse

Name Description Schema

data
required

Contains the download link from the instant access mount response data.

data

data

Name Description Schema

attributes
required

attributes

id
required

The instant access mount id

string

type
required

Specifies the restore type as 'getDownloadUrlRequest'.

enum (GetDownloadUrlFromIAMount)

attributes

Name Description Schema

securityKey
required

The authorization details of the download link (URL) from the instant access mount.

string

url
required

The download link (URL) of the Storage Platform Web Service.

string

instantAccessMountAttributes

Name Description Schema

backupId
required

The backup ID.

string

clientName
required

The name of the client. Not available if status is 'inprogress'.

string

exportPath
required

The file path to which the mount is exported. Not available if status is 'inprogress'.

string

nfsServer
required

The hostname of the NFS server. Not available if status is 'inprogress'.

string

policyName
required

The name of the backup policy.

string

state
required

Indicates the current state of Instant access mount. Possible values are inprogress/created/exported. 'created' - instant access mount is available. 'exported' - instant access mount is exported to some client. 'inprogress' - instant access mount creation is in-progress.

string

status
required

The status indicates health of the instant access mount. Possible values are 'active/inactive/expired'. 'active' - In good health. 'inactive' - Some issue with instant access mount. Possibly corrupt. 'expired' - Is expired and can be deleted any time.

string

timestamp
required

Instant access mount creation time. Not available if status is 'inprogress'.

string

instantAccessMountContentItemAttributes

Name Description Schema

itemType
required

The type of content item. valid values are 'dir' and 'file'.

string

name
required

The name of the content item.

string

path
optional

The path of the content item.

string

instantAccessMountContentItemResponseArray

Name Schema

data
required

< instantAccessMountContentItemResponseData > array

instantAccessMountContentItemResponseData

Name Description Schema

attributes
required

instantAccessMountContentItemAttributes

id
required

the path to the content item.

string

links
required

links

type
required

Specify 'instantAccessMountContentItem' as a type.

string

links

Name Schema

self
optional

linkObject

instantAccessMountRelationships

Name Description Schema

image
required

The backup image associated with this instant access mount.

image

image

Name Schema

data
optional

resourceIdentifierObject

links
optional

links

links

Name Schema

related
optional

linkObject

instantAccessMountRequest

Name Schema

data
required

data

data

Name Description Schema

attributes
required

attributes

type
required

Specify 'instantAccessMount' as a type.

string

attributes

Name Description Schema

backupId
required

The backup image identifier to be used for creating instant access mount. Required.

string

instantAccessMountResponse

Name Schema

data
required

instantAccessMountResponseData

instantAccessMountResponseArray

Name Schema

data
required

< instantAccessMountResponseData > array

instantAccessMountResponseData

Name Description Schema

attributes
required

instantAccessMountAttributes

id
required

A unique identifier for instant access mount.

string

links
required

links

relationships
optional

instantAccessMountRelationships

type
required

Specify 'instantAccessMount' as a type.

string

links

Name Schema

self
optional

linkObject

instantAccessMountSFRRequest

Name Schema

data
required

data

data

Name Description Schema

attributes
required

attributes

type
required

Specifies the restore type as 'SingleFileRestoreVM'.

enum (SingleFileRestoreVM)

attributes

Name Description Schema

esxiHost
required

The ESXi server name. If not specified, the default is the one used at the time of backup.

string

fileId
required

The file in the instant access mount to be restored. This is a mandatory parameter.

string

restorePath
required

The VM path where the file is to be restored.This is a mandatory parameter.

string

vCenter
required

The vCenter server name. If not specified, the default is the one used at the time of backup.

string

vmBiosUuid
required

The BIOS UUID of the VM associated with the file to be restored. use to identify the VM. Not required if vmInstUuid or vmName is specified.

string

vmInstUuid
required

The Instance UUID of the VM associated with the file to be restored. use to identify the VM. Not required if vmBiosUuid or vmName is specified.

string

vmName
required

The name of the VM associated with the file to be restored. use to identify the VM Not required if vmInstUuid or vmBiosUuid is specified.

string

vmPassword
required

The password of the VM where the file is to be restored. This is a mandatory parameter.

string

vmUsername
required

The user name of the VM where the file is to be restored. This is a mandatory parameter.

string

instantAccessMountSFRResponse

Name Description Schema

data
required

Contains the single file restore response data.

data

data

Name Description Schema

attributes
required

Contains the single file restore job attributes.

attributes

fileId
optional

The file in the instant access mount to be restored.

string

id
required

A unique identifier for instant access mount.

string

links
required

links

type
required

Specifies the restore type as 'singleFileRestoreVM'

string

attributes

Name Description Schema

jobId
required

The single file restore job identifier.

string

mountId
required

The instant access mount from where the file is to be restored. .

string

restorePath
required

The VM path where the file is to be restored.

string

vmName
required

The name of the VM where the file is to be restored.

string

links

Name Schema

self
optional

linkObject

instantAccessVmAttributes

Name Description Schema

backupId
required

string

clientName
required

The name of the client. Not available if status is 'inprogress'.

string

esxiHost
required

string

guestFullName
required

string

guestId
required

string

hostName
required

string

instanceUuid
required

string

ipAddress
required

string

memorySizeMB
required

string

mountId
required

string

numCpu
required

string

numEthernetCards
required

string

numVirtualDisks
required

string

resourcePool
required

string

retention
required

integer (int64)

toolsRunningStatus
required

string

toolsVersionStatus2
required

string

uuid
required

string

vCenter
required

string

version
required

string

vmFolder
required

string

vmName
required

string

instantAccessVmRelationships

Name Description Schema

image
required

Backup image associated with this instant access VM.

image

image

Name Schema

data
optional

resourceIdentifierObject

links
optional

links

links

Name Schema

related
optional

linkObject

instantAccessVmRequest

Name Schema

data
required

data

data

Name Description Schema

attributes
required

attributes

type
required

Specify 'InstantAccessVm' as a type.

string

attributes

Name Description Schema

backupId
required

The backup image identifier to be used for creating instant access mount. Required.

string

esxiHost
optional

The ESXi server name. If not specified, the default is the one used at the time of backup.

string

powerOn
optional

If true, the VM is powered on after the creation. If false, the VM remains powered off after creation. If not specified, the VM remains powered off after creation.
Default : false

boolean

removeBackingInfo
optional

Remove the backing info for devices such as CD-ROM, DVD, etc. Default is true.
Default : true

boolean

removeEthCards
optional

Remove the VM’s network interfaces. If not specified, VM’s network interfaces will be removed after creation.
Default : true

boolean

resetBiosUuid
optional

Create new BIOS UUID for the VM. Default is false.
Default : false

boolean

resetInstanceUuid
optional

Create new Instance UUID for the VM. Default is true.
Default : true

boolean

resourcePoolOrVapp
optional

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

retention
optional

Even though default is 2592000, which is 30 days, in this release VM is never automatically expired.

integer (int64)

vCenter
optional

The vCenter server name. If not specified, the default is the one used at the time of backup.

string

vmFolder
optional

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

vmName
required

The display name of the virtual machine. Must not contain more than 80 characters.

string

instantAccessVmResponse

Name Schema

data
required

instantAccessVmResponseData

instantAccessVmResponseArray

Name Schema

data
required

< instantAccessVmResponseData > array

instantAccessVmResponseData

Name Description Schema

attributes
required

instantAccessVmAttributes

id
required

A unique identifier for VM.

string

links
required

links

relationships
optional

instantAccessVmRelationships

type
required

Specify 'instantAccessVm' as a type.

string

links

Name Schema

self
optional

linkObject

linkObject

Name Schema

href
optional

string

recoveryResponse

The recovery response.

Name Description Schema

data
required

Contains the recovery response data.

data

relationships
required

Contains the resources related to the recovery operation, such as recoveryJob.

relationships

data

Name Description Schema

attributes
required

Contains the recovery response attributes.

attributes

id
required

The response identifier.

integer (int64)

type
required

The response type.
Default : "recoveryResponse"

string

attributes

Name Description Schema

msg
required

The response message.

string

relationships

Name Description Schema

recoveryJob
required

Represents the job created by this recovery operation.

recoveryJob

recoveryJob

Name Description Schema

data
required

Contains the recovery job data.

data

links
required

Contains the links to get the job details.

links

data

Name Description Schema

id
required

The job identifier.

integer (int64)

type
required

The resource type. Set to job.

string

links

Name Description Schema

related
required

Gets a list of recent jobs.

string

self
required

Gets the details about this recovery job.

string

resourceIdentifierObject

A resource identifier object representing an individual resource.

Name Schema

id
required

string

type
required

string

vmwareFullVmRecoveryRequest

The recovery request schema for VMware full VM recovery.

Name Description Schema

data
required

Contains the recovery request data.

data

data

Name Description Schema

attributes
required

Contains the recovery request attributes.

attributes

type
required

The resource type. Must be set to recoveryRequest.
Default : "recoveryRequest"

enum (recoveryRequest)

attributes

Name Description Schema

recoveryObject
optional

Represents the virtual machine being recovered.

recoveryObject

recoveryOptions
optional

Describes the recovery options to be used for this recovery.

recoveryOptions

recoveryPoint
required

Selects the recovery point for this recovery based on the specified options. Required.

recoveryPoint

recoveryObject

Name Description Schema

vmDisks
optional

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
optional

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
optional

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.

vmEnvironment

vmDisks

Name Description Schema

destination
optional

The destination path of the virtual machine disk.

string

source
optional

The source path of the virtual machine disk.

string

vmEnvironment

Name Description Schema

datacenter
optional

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
optional

The ESXi server name. If not specified, the default is the one used at the time of backup.

string

network
optional

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
optional

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
optional

The vCenter server name. If not specified, the default is the one used at the time of backup.

string

vmFolder
optional

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
optional

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
optional

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
optional

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
optional

If true, overwrites the VM and its associated resources, if they already exist with the same name. If false, does not overwrite the VM and its associated resources, if they already exist with the same name. If not specified, does not overwrite the VM and its associated resources, if they already exist with the same name.
Default : false

boolean

powerOnAfterRecovery
optional

If true, the VM is powered on after the recovery. If false, the VM remains powered off after the recovery. If not specified, the VM remains powered off after the recovery.
Default : false

boolean

recoverToVmxDatastore
optional

If true, recovers the VMDK files to the same datastore as the VMX file. If false, recovers the VMDK files to their original location at the time of backup. If not specified, recovers the VMDK files to their original location at the time of backup. If a different virtual disk destination path is assigned in vmEnvironment section, it overrides this option.
Default : false

boolean

recoveryHost
optional

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
optional

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

boolean

removeNetworkInterfaces
optional

If true, removes any network interfaces attached to the VM after recovery. If false, retains the network interfaces attached to the VM after recovery. If not specified, retains the network interfaces attached to the VM after recovery.
Default : false

boolean

removeTagAssociations
optional

If true, removes any associated VMware tags from this VM. If false, retains the associated VMware tags for this VM. If not specified, retains the associated VMware tags for this VM.
Default : false

boolean

retainBiosUuid
optional

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

boolean

retainHardwareVersion
optional

If true, recovers the VM with the same hardware version as it had at the time of backup. If false, recovers the VM with the default hardware version for the destination ESXi server. If not specified, recovers the VM with the same hardware version as it had at the time of backup.
Default : true

boolean

retainInstanceUuid
optional

If true, recovers the VM with the same instance UUID (vCenter-specific unique identifier) as it had at the time of backup. If false, recovers the VM with a newly assigned instance UUID. If not specified, recovers the VM with the same instance UUID as it had at the time of backup. If the VM is being recovered to a standalone ESXi host, this option is ignored. If another VM with the same instance UUID exists at the destination, vCenter server assigns a new UUID to the VM.
Default : true

boolean

transportMode
optional

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 hotadd:nbd:nbdssl:san. The order of the specified modes is significant, as NetBackup attempts each mode in that order until the recovery is successful. If none of the modes are successful, the recovery fails. If not specified, the default is san:hotadd:nbd:nbdssl.
Default : "san:hotadd:nbd:nbdssl"

string

recoveryPoint

Name Description Schema

backupId
optional

The backup image identifier to be used for this recovery. Required, if client is not specified. Cannot be used along with client and filter.

string

client
optional

The client identifier that was used at the time of backup. Required, if backupId is not specified. Cannot be used along with backupId. If a filter is not specified along with client, recovery will be performed using the most recent backup image.

string

filter
optional

Selects the backup images for recovery based on the specified filter. Optional. Cannot be used along with backupId. If more than one backup images match the filter, NetBackup selects the most recent one. All the filters are based on the OData standard and filtering on the following attributes is supported.

Name Supported Operators Description Schema
backupTime ge le The backup timestamp in ISO 8601 format date-time
The filter can be used to specify a time interval, such as backupTime ge '2016-11-20T23:20:50Z' and backupTime le '2016-12-20T23:20:50Z'. If the filter only specifies the start of the time interval, such as backupTime ge '2016-11-20T23:20:50Z', then the end of the interval is assumed to be the current time. If the filter only specifies the end of the time interval, such as backupTime le '2016-11-20T23:20:50Z', then the start of the interval is assumed to be 6 months prior to that. If the filter is not specified, the end of the time interval is assumed to be the current time and the start of the interval is assumed to be 6 months prior to that.

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 : 2.0

URI scheme

Host : <masterserver>:1556
BasePath : /netbackup
Schemes : HTTPS

Paths

GET /security/auditlogs

Description

Views the NetBackup audit logs.

Requires Permission: [View Audit Logs]

Parameters

Type Name Description Schema Default

Query

category
optional

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 20-DATAACCESS 21-CONFIG 22-ALERT

integer

0

Query

datalimit
optional

The number of audit records to be fetched.

integer

500

Query

domain
optional

The domain name of the user.

string

""

Query

domaintype
optional

The domain type of the user.

integer

0

Query

endtime
optional

The end time for the audit records. The audit records are fetched until this time.

integer (int64)

0

Query

locale
optional

The locale value.

string

"en"

Query

operation
optional

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

0

Query

starttime
optional

The start time for the audit records. NetBackup starts fetching the audit records at this time.

integer (int64)

0

Query

username
optional

The name of the user.

string

""

Responses

HTTP Code Description Schema

200

The list of audit records.

getAuditRecordResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No audit record found.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

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 as well as extracted details from these certificates. Each NetBackup host must establish trust with the NetBackup web service CA before it can make secure calls to NetBackup APIs.

Requires Permission: []

Responses

HTTP Code Description Schema

200

On successful response, the CA certificate is sent.

getCACertificateResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.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.

Requires Permission: []

Responses

HTTP Code Description Schema

200

On successful response, the latest CRL file is sent.

file

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

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.
Headers :
Retry-After (integer)

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.

Requires Permission: [Manage Certificates]

Responses

HTTP Code Description Schema

200

On successful response, the list of details for the latest certificate for each host is sent.

getCertificateListResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

POST /security/certificates/revoke

Description

Revokes the NetBackup host ID-based certificate for the specified host ID.

Requires Permission: [Manage Certificates]

Parameters

Type Name Description Schema

Query

hostId
required

The unique ID assigned to the NetBackup host.

string

Body

Reason
optional

The reason for a certification revocation.

postRevokeCertificateRequest

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.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The specified host was not found.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /security/certificates/{serialNumber}

Description

Returns the certificate details of the certificate with the specified serial number.

Requires Permission: [Manage Certificates]

Parameters

Type Name Description Schema

Path

serialNumber
required

The serial number of the certificate.

string

Responses

HTTP Code Description Schema

200

On successful response, the certificate details are sent.

getCertificateResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The certificate entry does not exist.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

PUT /security/credentials

Description

Sets the security credentials.

Requires Permission: [Manage Certificates]

Parameters

Type Name Description Schema

Body

Security credentials
required

The security credential that needs to be set.

secCredDef

Responses

HTTP Code Description Schema

200

The request was successful.

No Content

400

Bad request. The request contains an invalid parameter.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /security/credentials/{credname}/isset

Description

Verifies whether a certain security credential is set or not.

Requires Permission: [Manage Certificates]

Parameters

Type Name Description Schema

Path

credname
required

The name of the security credential key.

string

Responses

HTTP Code Description Schema

200

The request was successful.

credIsSetResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

500

There was an error when attempting to query the security credential.

errorResponse

Security

Type Name

apiKey

rbacUserSecurity

GET /security/logindetails

Description

Views the logs that are specific to the NetBackup login audit records.

Requires Permission: []

Parameters

Type Name Description Schema Default

Query

datalimit
optional

The number of audit records to be fetched.

integer

0

Query

domaintype
optional

The domain type of the user.

integer

0

Query

lastlogon
optional

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

"false"

Query

locale
optional

The locale value.

string

"en"

Responses

HTTP Code Description Schema

200

The list of audit records.

getAuditRecordResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

No audit record found.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /security/ping

Description

Tests the connection for the security service from the client. It returns the master server time in milliseconds.

Requires Permission: []

Responses

HTTP Code Description Schema

200

Ping successful - master server time in milliseconds

time

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • text/vnd.netbackup+plain;version=2.0

  • application/vnd.netbackup+json;version=2.0

POST /security/properties

Description

Configures NetBackup security options, such as certificate deployment security level, secure communication with hosts, automatic addition of host ID-to-host name mappings and use of external Certificate Authority (CA).

Requires Permission: [Manage Global Security Settings]

Parameters

Type Name Description Schema

Body

Security configuration properties
required

The security configurations that need to be updated.

postSecPropertyRequest

Responses

HTTP Code Description Schema

200

Request successful.

No Content

400

Bad request. The request contains an invalid parameter.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /security/properties

Description

Fetches the configuration settings for NetBackup security.

Requires Permission: []

Responses

HTTP Code Description Schema

200

On successful response, security configurations are sent in the JSON format.

getSecPropertyResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

GET /security/properties/default

Description

Fetches the default settings specific to NetBackup security.

Requires Permission: []

Responses

HTTP Code Description Schema

200

On successful response, default security configuration settings are sent in the JSON format.

getSecPropertyResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

POST /security/securitytokens

Description

Creates an authorization token based on the properties that are sent with the request payload.

Requires Permission: [Manage Certificates]

Parameters

Type Name Description Schema

Body

Create Token Data
required

The properties of the token to be created.

postCreateTokenRequest

Responses

HTTP Code Description Schema

201

On successful response, the token value is sent.

postCreateTokenResponse

400

Bad request. The request contains an invalid parameter.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

In case of reissue-token, the host ID that is specified does not exist.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

409

The token already exists.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

Failed to create the token.

errorResponse

503

Server busy. Try again later.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /security/securitytokens

Description

Returns the data for all tokens in the form of a list.

Requires Permission: [Manage Certificates]

Responses

HTTP Code Description Schema

200

On successful response, a list of tokens is sent.

getTokenResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

POST /security/securitytokens/delete/invalid

Description

Cleans all invalid authorization tokens.

Requires Permission: [Manage Certificates]

Parameters

Type Name Description Schema

Body

Reason
optional

Specify the reason for deleting the invalid tokens.

postDeleteTokenRequest

Responses

HTTP Code Description Schema

204

Request successful.

No Content

400

Bad request. The request contains an invalid parameter.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /security/securitytokens/state/valid

Description

Returns the data for all valid tokens.

Requires Permission: [Manage Certificates]

Responses

HTTP Code Description Schema

200

On successful response, a list of valid tokens is sent.

getTokenResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /security/securitytokens/{tokenName}

Description

Returns the token data for the specified token.

Requires Permission: [Manage Certificates]

Parameters

Type Name Description Schema

Path

tokenName
required

The token name.

string

Responses

HTTP Code Description Schema

200

On successful response, the token data is sent.

getTokenData

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The token does not exist.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

POST /security/securitytokens/{tokenName}/delete

Description

Deletes an authorization token based on the token name that is specified in the URI.

Requires Permission: [Manage Certificates]

Parameters

Type Name Description Schema

Path

tokenName
required

The token name.

string

Body

Reason
optional

Specify the reason for deleting the token.

postDeleteTokenRequest

Responses

HTTP Code Description Schema

204

Request successful.

No Content

400

Bad request. The request contains an invalid parameter.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The token does not exist.

errorResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacUserSecurity

GET /security/serverinfo

Description

Returns NetBackup master server information.

Requires Permission: []

Responses

HTTP Code Description Schema

200

On successful response, the NetBackup master server information is sent.

getServerInfoResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

GET /security/servertime

Description

Returns the master server time in milliseconds in the JSON format.

Requires Permission: []

Responses

HTTP Code Description Schema

200

On successful response, the master server time in milliseconds is sent in the JSON format.

getServerTimeResponse

406

Invalid Accept type. Make sure your Accept header matches what this API produces.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.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
optional

The list of the audit placeholder values.

< auditRecordKey > array

auditRecordAttributeList
optional

The list of the audit record attributes.

< auditRecordAttribute > array

auditTime
optional

time

auditUserIdentity
optional

User information.

object

categoryId
optional

The category ID of the fetched audit record.

integer

categoryIdDisplayString
optional

The resolved category value from the categoryId field.

string

messageId
optional

The UMI message ID of the fetched audit record.

integer

messageIdDisplayString
optional

The resolved message value from the messageId UMI.

string

operationId
optional

The operation ID of the fetched audit record.

integer

operationIdDisplayString
optional

The resolved operation value from the operationId field.

string

reason
optional

The reason value of the audit record.

string

auditRecordKey

Name Description Schema

typeId
optional

The data type of the placeholder.

integer

typeIdDisplayString
optional

The value of the placeholder for the audit description message.

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

certificateDetails

Name Description Schema

caCert
optional

An x.509 certificate in a PEM-formatted string.

string

caCertDetails
optional

extractedCertDetails

certificateRegistrationRequest

Requests data for the registration of the host certificate that was issued by a third-party CA.

Name Description Schema

data
required

Contains payload for TPCA issued certificate registration with NetBackup.

data

data

Name Description Schema

attributes
required

Contains the payload attributes.

attributes

id
required

The request identifier.

string

type
required

The type of the certificate registration request.

enum (certificateRegistrationRequest)

attributes

Name Description Schema

domainContext
optional

For internal use only.

integer

hostInfo
required

hostRegistrationData

registrationToken
optional

The authorization token. Depending on the certificate deployment security setting, NetBackup hosts may require an authorization token to register the host certificate that is issued by a third-party CA with NetBackup.

string

certificateRegistrationResponse

The response after the registration of the certificate that is issued by a third-party CA.

Name Description Schema

data
required

The response payload after the certificate issued by a third-party CA is registered with NetBackup.

data

data

Name Description Schema

attributes
required

The attributes of the certificate registration response.

attributes

id
required

The response identifier.

string

type
required

The type of the certificate registration response.

enum (certificateRegistrationResponse)

attributes

Name Description Schema

externalCaUsage
required

Here, TPCA = Third-party certificate authority. NBCA = NetBackup certificate authority. In response payload, externalCaUsage is a global security setting that specifies if the TCPA should be enforced or not. Possible values can be > Disabled (0) - Only NBCA is used for NetBackup communication Enabled (1) - If one of the communicating hosts has only NBCA certificate, communication happens through NBCA. If both hosts have TCPA certificate, communication happens through TCPA. Enforced (2) - Communication happens only through TCPA certificates, Communication through NBCA is not allowed.
Minimum value : 0
Maximum value : 2

integer

hostId
required

The unique ID assigned to the NetBackup host.

string

masterHostId
required

The host ID of the NetBackup master server.

string

securityLevel
required

The certificate deployment level of the master server of the host that initiated the certificate registration.
Minimum value : 0
Maximum value : 2

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

details
optional

A map containing error field and error field message to provide more context to nature of the error.

object

errorCode
required

The NetBackup error code.

integer (int64)

errorMessage
required

The NetBackup error code description.

string

externalCaUsage

Here are the defined values for the external CA usage parameter. 0 - Disabled - Use of external CA is disabled. 1 - Enabled - Use of external CA is enabled.

Type : integer

extractedCertDetails

Name Description Schema

fingerprint
optional

A certificate’s fingerprint is the unique identifier of the certificate. It is a digest (hash function) of a certificate in x509 binary format calculated using SHA1 algorithm.

string

notAfter
optional

Gets the date and time after which a certificate is no longer valid.

string (date-time)

notBefore
optional

Gets the date and time on which a certificate becomes valid.

string (date-time)

serialNumber
optional

serialNo

subjectCN
optional

The subject common name (CN)

string

subjectOU
optional

The subject Organizational Unit (OU)

string

getAuditRecordResponse

Name Description Schema

auditRecordList
optional

The list of audit record details.

< auditRecordDetails > array

isDataTruncated
optional

Indicates whether the data is truncated or not.

boolean

getCACertificateResponse

Name Description Schema

caCertificateData
required

A list of certificates of the NetBackup certificate authority (VxAT) in a pem-formatted string.

< certificateDetails > array

webRootCertificateData
required

< certificateDetails > array

getCertificateListResponse

Name Description Schema

certificateList
required

A list of certificate details.

< getCertificateResponse > array

getCertificateResponse

Name Description Schema

certificateKey
required

For internal use.

integer

createOn
required

time

hostId
required

hostID

hostName
required

hostName

hostType
required

hostType

notAfter
required

time

notBefore
required

time

publicKey
required

The public key of the host for which the certificate is issued.

string

revocationReason
required

revocationReason

serialNumber
required

serialNo

state
required

certificateState

tokenType
optional

certificateTokenType

updatedOn
required

time

getSecPropertyResponse

List of security settings.

Name Schema

aliasAutoAdd
required

aliasAutoAdd

allowInsecureBackLevelHost
required

allowInsecureBackLevelHost

certificateAutoDeployLevel
required

certificateAutoDeployLevel

externalCaUsage
required

externalCaUsage

getServerInfoResponse

Name Description Schema

masterHostId
optional

The host ID of the NetBackup master server.

hostID

serverName
optional

The name of the NetBackup master server.

string

getServerTimeResponse

Name Schema

serverTime
required

time

getTokenData

Name Description Schema

allowedCount
required

The maximum usage count of the token.

integer

hostId
required

hostID

tokenActivationTime
required

time

tokenExpirationTime
required

time

tokenKey
required

For internal use.

integer

tokenName
required

The token name to be created.

string

tokenState
required

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
required

tokenType

tokenValue
required

token

usedCount
required

The used count of the token.

integer

getTokenResponse

Name Description Schema

tokenList
required

List of tokens.

< getTokenData > array

hostID

The unique ID assigned to the NetBackup host.

Type : string

hostInformation

Name Description Schema

csr
required

csr

hostAlias
required

A list of host aliases of the specified host. The specified hostName property must be present in this hostAlias array.

< hostName > array

hostName
required

hostName

hostName

The name of the host for which the certificate is issued or is to be issued.

Type : string

hostRegistrationData

Name Schema

hostName
required

hostName

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
required

certificate

crl
required

The certificate revocation list.

string (byte)

hostId
required

The host ID of the NetBackup host that has requested a certificate.

hostID

masterHostId
required

The host ID of the NetBackup master server.

hostID

securityLevel
required

The level of host checking for certificate registration and the frequency of updates for CRLs.

integer

postCreateTokenRequest

Name Description Schema

allowedCount
required

The maximum usage count of the token. The default value is 1.
Maximum value : 99999

integer

hostId
optional

hostID

reason
optional

The reason for creating the token.

string

tokenName
required

The token name to be created.

string

type
optional

tokenType

validFor
required

The validity of the token in seconds. The default validity is 1 day.
Maximum value : 86313600

integer

postCreateTokenResponse

Name Description Schema

tokenValue
required

The token value. Use for certificate deployment.

string

postDeleteTokenRequest

Name Description Schema

reason
optional

The reason for deleting the token.

string

postRevokeCertificateRequest

Name Schema

revocationReason
optional

revocationReason

postSecPropertyRequest

Name Schema

aliasAutoAdd
optional

aliasAutoAdd

allowInsecureBackLevelHost
optional

allowInsecureBackLevelHost

certificateAutoDeployLevel
optional

certificateAutoDeployLevel

externalCaUsage
optional

externalCaUsage

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
required

The name of the security credential key.

string

credValue
required

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

APIs for the Service Catalog

Overview

Version information

Version : 2.0

URI scheme

Host : <masterserver>:1556
BasePath : /netbackup/servicecatalog
Schemes : HTTPS

Paths

POST /slos

Description

Creates a new SLO definition.

Requires Permission: [Manage Protection Plans]

Parameters

Type Name Schema

Body

body
required

postSloRequest

Responses

HTTP Code Description Schema

201

Successfully created the SLO definition.
Headers :
Location (string (url)) : A link to the SLO definition.

sloResponse

400

Bad request. The body of the request is not valid.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /slos

Description

Retrieves the list of SLO definitions based on specified filters. If no filters are specified, information for 10 SLO definitions is retrieved, sorted in descending order by the name. All the filters are based on OData standards. Filtering is supported for the following attributes:

Name Supported Operators Description Schema

id

eq ne gt ge lt le and or not () contains endswith startswith

Specifies the SLO ID.

string

name

eq ne gt ge lt le and or not () contains endswith startswith

Specifies the SLO name.

string

description

eq ne gt ge lt le and or not () contains endswith startswith

Specifies the SLO description.

string

subscriptionCount

eq ne gt ge lt le

Specifies the SLO subscription count.

integer

Requires Permission: [View Protection Plans, Manage Protection Plans, Manage Assets, Manage Appservers and Asset Groups]

Parameters

Type Name Description Schema Default

Query

filter
optional

Specifies filters according to OData standards

string

Query

page[limit]
optional

The number of records on one page, after the offset.

integer

10

Query

page[offset]
optional

The subscription record number offset.

integer

0

Query

sort
optional

Sort in ascending order on the specified property. Prefix with '-' for descending order.

string

"-name"

Responses

HTTP Code Description Schema

200

Successfully retrieved a list of existing SLOs.

sloResponseArray

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /slos/{sloID}

Description

Gets the specified SLO definition.

Requires Permission: [View Protection Plans, Manage Protection Plans, Manage Assets, Manage Appservers and Asset Groups]

Parameters

Type Name Description Schema

Path

sloID
required

The unique ID for the SLO definition.

string

Responses

HTTP Code Description Schema

200

Successfully retrieved the specified SLO definition.

sloResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The SLO definition was not found.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

PUT /slos/{sloID}

Description

Updates the existing SLO definition.

Requires Permission: [Manage Protection Plans]

Parameters

Type Name Description Schema

Path

sloID
required

The unique ID for the SLO definition.

string

Body

body
required

The updated SLO definition.

putSloRequest

Responses

HTTP Code Description Schema

204

Successfully updated the SLO definition.

No Content

400

Bad request. The request body is not valid.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The SLO definition was not found.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

DELETE /slos/{sloID}

Description

Deletes the existing SLO definition.

Requires Permission: [Manage Protection Plans]

Parameters

Type Name Description Schema

Path

sloID
required

The unique ID for the SLO definition.

string

Responses

HTTP Code Description Schema

204

Successfully removed the existing SLO.

No Content

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The SLO definition was not found.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

PATCH /slos/{sloID}

Description

Updates few attributes of SLO definition for existing SLO.

Requires Permission: [Manage Protection Plans]

Parameters

Type Name Description Schema

Path

sloID
required

The unique ID for the SLO definition.

string

Body

body
required

The updated SLO definition.

patchSloRequest

Responses

HTTP Code Description Schema

200

Successfully updated the SLO definition.

sloResponse

400

Bad request. The body of the request is not valid.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

POST /slos/{sloID}/subscriptions

Description

Creates a subscription for the specified SLO.

Requires Permission: [View Protection Plans, Manage Protection Plans, Manage Assets, Manage Appservers and Asset Groups]

Parameters

Type Name Description Schema

Path

sloID
required

The unique ID for the SLO definition.

string

Body

body
required

postSubscriptionRequest

Responses

HTTP Code Description Schema

201

Successfully created the subscription.
Headers :
Location (string (url)) : A link to the subscription.

subscriptionResponse

400

Bad request. The request body is not valid.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Specified SLO was not found.

errorResponse

Consumes

  • application/vnd.netbackup+json;version=2.0

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /slos/{sloID}/subscriptions/{subscriptionID}

Description

Gets an existing subscription.

Requires Permission: [View Protection Plans, Manage Protection Plans, Manage Assets, Manage Appservers and Asset Groups]

Parameters

Type Name Description Schema

Path

sloID
required

The unique ID for the SLO definition.

string

Path

subscriptionID
required

A unique ID for the subscription.

string

Responses

HTTP Code Description Schema

200

Successfully retrieved the subscription.

subscriptionResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The subscription was not found.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

DELETE /slos/{sloID}/subscriptions/{subscriptionID}

Description

Deletes the subscription.

Requires Permission: [View Protection Plans, Manage Protection Plans, Manage Assets, Manage Appservers and Asset Groups]

Parameters

Type Name Description Schema

Path

sloID
required

The unique ID for the SLO definition.

string

Path

subscriptionID
required

A unique ID for the subscription.

string

Responses

HTTP Code Description Schema

204

Successfully removed the specified subscription.

No Content

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The specified subscription was not found.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

Definitions

allLinks

Name Schema

first
optional

linkObject

last
optional

linkObject

next
optional

linkObject

prev
optional

linkObject

self
optional

linkObject

backupWindows

The window during which the backup is allowed to start. Each day of the week is defined independently.

Type : < backupWindows > array

backupWindows

Name Description Schema

dayOfWeek
required

The day of the week the backup window starts. Possible values for DAY are 1 (Sunday) through 7 (Saturday).

integer

durationSeconds
required

The duration of the backup window expressed in seconds.

integer

startSeconds
required

The start time of the backup window, expressed in seconds elapsed since the beginning of the day.

integer

duplication

Name Schema

retention
required

retention

storageUnit
required

string

errorResponse

Name Description Schema

details
optional

A map containing error field and error field message to provide more context to nature of the error.

object

errorCode
required

The NetBackup error code.

integer (int64)

errorMessage
required

The NetBackup error code description.

string

frequency

Name Schema

unit
required

enum (HOURS, DAYS, WEEKS, MONTHS, YEARS)

value
required

integer

linkObject

Name Schema

href
optional

string

paginationAttributes

Name Schema

count
optional

integer

first
optional

integer

last
optional

integer

limit
optional

integer

next
optional

integer

offset
optional

integer

page
optional

integer

pages
optional

integer

prev
optional

integer

patchSchedule

Name Schema

backupStorageUnit
optional

string

duplication
optional

duplication

replication
optional

replication

duplication

Name Schema

storageUnit
required

string

replication

Name Schema

replicationTarget
required

replicationTarget

patchSloAttributes

Name Schema

description
optional

string

name
optional

string

schedules
optional

< patchSchedule > array

patchSloRequest

Name Schema

data
required

patchSloRequestData

patchSloRequestData

Name Description Schema

attributes
required

patchSloAttributes

id
required

A unique identifier for SLO definition, such as GUID.

string

type
required

Specify 'slo' as the SLO type.

enum (slo)

postSloAttributes

Name Description Schema

description
optional

string

isSnapshotStorageOnly
required

Indicates whether the SLO uses snapshot storage only.

boolean

name
required

string

schedules
required

< schedule > array

postSloRequest

Name Schema

data
required

postSloRequestData

postSloRequestData

Name Description Schema

attributes
required

postSloAttributes

type
required

Specify 'slo' as the SLO type.

enum (slo)

postSubscriptionRequest

Name Schema

data
required

postSubscriptionRequestData

postSubscriptionRequestData

Name Description Schema

attributes
required

subscriptionAttributes

type
required

Specify 'subscription' as the subscription type.

enum (subscription)

putSloRequest

Name Schema

data
required

putSloRequestData

putSloRequestData

Name Description Schema

attributes
required

postSloAttributes

id
required

A unique identifier for SLO definition, such as GUID.

string

type
required

Specify 'slo' as the SLO type.

enum (slo)

replication

Name Schema

replicationTarget
required

replicationTarget

retention
required

retention

replicationTarget

Name Schema

targetMasterServer
required

string

targetSlp
required

string

resourceIdentifierObject

A resource identifier object representing an individual resource.

Name Schema

id
required

string

type
required

string

retention

Name Schema

unit
required

enum (HOURS, DAYS, WEEKS, MONTHS, YEARS)

value
required

integer

schedule

Name Schema

backupStorageUnit
optional

string

backupWindows
required

backupWindows

duplication
optional

duplication

frequency
required

frequency

replication
optional

replication

retention
required

retention

sloAttributes

Name Description Schema

capabilities
optional

< string > array

description
optional

string

isSnapshotStorageOnly
required

Indicates whether the SLO uses snapshot storage only.

boolean

name
required

string

schedules
required

< schedule > array

subscriptionCount
required

Number of subscriptions associated with SLO.

integer

sloResponse

Name Schema

data
required

sloResponseData

sloResponseArray

Name Schema

data
required

< sloResponseData > array

sloResponseData

Name Description Schema

attributes
required

sloAttributes

id
required

A unique identifier for SLO definition, such as GUID.

string

links
required

links

type
required

Specify 'slo' as the SLO type.

enum (slo)

links

Name Schema

self
optional

linkObject

subscriptionAttributes

Name Description Schema

selectionId
required

The asset ID or asset group ID.

string

selectionType
required

The asset selection type.

enum (ASSET, ASSETGROUP)

subscriptionRelationships

Name Description Schema

slo
required

SLO associated with this subscription.

slo

slo

Name Schema

data
optional

resourceIdentifierObject

links
optional

links

links

Name Schema

related
optional

linkObject

subscriptionResponse

Name Schema

data
required

subscriptionResponseData

included
optional

< sloResponseData > array

subscriptionResponseArray

Name Schema

data
required

< subscriptionResponseData > array

included
optional

< sloResponseData > array

links
optional

allLinks

meta
required

meta

meta

Name Schema

pagination
optional

paginationAttributes

subscriptionResponseData

Name Description Schema

attributes
optional

subscriptionAttributes

id
required

A unique ID for the subscription.

string

links
required

links

relationships
optional

subscriptionRelationships

type
required

Subscription type as 'subscription'.

enum (subscription)

links

Name Schema

self
optional

linkObject

Security

rbacSecurity

Type : apiKey
Name : Authorization
In : HEADER

NetBackup Storage API

Overview

The NetBackup Storage API provides access to the backup storage of the NetBackup master servers.

Version information

Version : 2.0

URI scheme

Host : <masterserver>:1556
BasePath : /netbackup
Schemes : HTTPS

Paths

GET /storage/backup-sizes

Description

Returns the total backup size information based on the specified filters. All the filters are based on OData standards and filtering on the following attributes is supported.

Name Supported Operators Description Schema

clientName

eq

The client name.

string

masterServerName

eq

The master server name.

string

Requires Permission: [View Usage Data]

Parameters

Type Name Description Schema Default

Query

filter
optional

The filter criteria in OData format.

string

Query

page[limit]
optional

The number of backup size records on one page.

integer

10

Query

page[offset]
optional

The backup size record number offset.

integer

0

Responses

HTTP Code Description Schema

200

Successfully returned the total backup size information.

getbackupSizesResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The client name was not found.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /storage/storage-units

Description

Returns the list of attributes for all storage units.

Requires Permission: [Manage SLPs]

Responses

HTTP Code Description Schema

200

Successfully returned the list of attributes for all storage units.

getStorageUnitsResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /storage/storage-units/{storageUnitName}

Description

Returns the definition of the storage unit.

Requires Permission: [Manage SLPs]

Parameters

Type Name Description Schema

Path

storageUnitName
required

The name of the storage unit.

string

Responses

HTTP Code Description Schema

200

Successfully returned the details of the storage unit.

storageUnitDefinition

400

Bad Request.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

A storage unit with the specified name was not found.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

Unknown

rbacUserSecurity

GET /storage/storage-units/{storageUnitName}/replication-relationships

Description

Fetches the list of storage lifecycle policies (SLPs) of type "import" from the target master servers. All the filters are based on OData standards and filtering on the following attributes is supported.

Name

Supported Operators

Description

Schema

targetMaster

eq

The target master from which to fetch the import storage lifecycle policies (SLPs).

string

dataClassification

eq

The data classification type. For example, Platinum, Gold, or Silver.

string

Returns an empty list of storage lifecycle policies of type "import" for the storage units that are not capable of replication.

Requires Permission: [Manage SLPs]

Parameters

Type Name Description Schema

Path

storageUnitName
required

The name of the storage unit.

string

Query

filter
optional

Specifies the filters according to OData standards.

string

Responses

HTTP Code Description Schema

200

Successfully fetched the list of import storage lifecycle policies (SLPs) from the target master server.

getImportSLPResponse

400

Bad request.

errorResponse

401

Authentication failed.

errorResponse

404

The specified storage unit was not found.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

Definitions

backupSize

Name Schema

attributes
required

backupSizeAttributes

type
required

enum (BackupSize)

backupSizeAttributes

Name Schema

clientBackupSizeDetails
required

< clientBackupSizeDetails > array

createDateTime
required

string (date-time)

masterServerName
required

string

clientBackupSizeDetails

Name Description Schema

clientName
required

The name of the client.

string

policyName
required

The name of the policy.

string

policyType
required

The type of the policy.

string

storageType
required

The type of the storage unit.

string

storageUnitName
required

The name of the storage unit.

string

totalBackupSizeMB
required

The total backup size, in MB.

number (double)

errorResponse

Name Description Schema

details
optional

A map containing error field and error field message to provide more context to nature of the error.

object

errorCode
required

The NetBackup error code.

integer (int64)

errorMessage
required

The NetBackup error code description.

string

getImportSLPResponse

Name Schema

data
optional

< data > array

links
optional

links

data

Name Schema

attributes
optional

attributes

id
optional

string

type
optional

enum (importSLPData)

attributes

Name Schema

dataClassification
optional

string

slpName
optional

string

targetMasterServer
optional

string

links

Name Schema

self
optional

self

self

Name Schema

href
optional

string

getStorageUnitsResponse

Name Schema

data
optional

< storageUnitDefinition > array

getbackupSizesResponse

Name Schema

data
required

< backupSize > array

meta
required

meta

meta

Name Schema

pagination
optional

pagination

pagination

Name Schema

count
optional

integer

first
optional

integer

last
optional

integer

limit
optional

integer

next
optional

integer

offset
optional

integer

storageUnitDefinition

Name Description Schema

attributes
optional

attributes

id
optional

The name of the storage unit.

string

type
optional

Type of the object.

enum (storage-unit)

attributes

Name Description Schema

accelerator
optional

Indicates if the storage unit supports NetBackup Accelerator.

boolean

cloudAttributes
optional

Specifies the cloud-specific attributes for this storage unit. This object is returned only for cloud storage units.

cloudAttributes

diskPoolCapabilities
optional

The capabilities of the disk pool associated with this storage unit.

< string > array

diskPoolState
optional

The state of the disk pool associated with this storage unit.

enum (UP, DOWN)

freeCapacityBytes
optional

The space that is available for the storage unit, in bytes.

integer (int64)

instantAccessEnabled
optional

Indicates if the storage unit supports instant access.

boolean

isCloudSTU
optional

Indicates if the storage unit is a cloud storage unit.

boolean

replicationCapable
optional

Indicates if the storage unit (used as a source, target, or both) supports replication.

boolean

replicationSourceCapable
optional

Indicates if the storage unit can be used as a source for replicating backup images.

boolean

replicationTargetCapable
optional

Indicates if the storage unit can be used as a target for replicating backup images.

boolean

scaleOutEnabled
optional

Indicates if the storage unit supports scale-out storage.

boolean

storageServerCapabilities
optional

The capabilities of the storage server associated with this storage unit.

< string > array

storageServerName
optional

The name of the storage server associated with this storage unit.

string

storageServerState
optional

The state of the storage server associated with this storage unit.

enum (UP, DOWN)

storageServerType
optional

The type of the storage server associated with this storage unit.

string

storageSubType
optional

The subtype of storage unit.

enum (Basic, DiskPool)

storageType
optional

The type of storage unit.

enum (Disk, Tape, NDMP)

totalCapacityBytes
optional

The total capacity of the storage unit, in bytes.

integer (int64)

usedCapacityBytes
optional

The space in the storage unit that is used, in bytes.

integer (int64)

cloudAttributes

Name Description Schema

catalyst
optional

Indicates if the storage unit supports NetBackup CloudCatalyst.

boolean

cloudProvider
optional

The name of the cloud vendor.

string

compressed
optional

Indicates if the storage unit is configured to compress data before sending to the cloud storage.

boolean

encrypted
optional

Indicates if the storage unit is configured to encrypt data before sending to the cloud storage.

boolean

Security

rbacSecurity

Type : apiKey
Name : Authorization
In : HEADER

NetBackup Licensing API

Overview

The NetBackup Capacity Licensing Data Usage API obtains the details of the front-end data usage of the NetBackup master servers and clients.

Version information

Version : 2.0

URI scheme

Host : <masterserver>:1556
BasePath : /netbackup
Schemes : HTTPS

Paths

GET /licensing/capacity

Description

Returns the front-end data usage details of a single or multiple NetBackup master servers, based on specified filters. If no filters are specified, details are returned for the last 10 NetBackup master servers queried. All the filters are based on OData standards and filtering is supported using the following attributes:

Name Supported Operators Description Schema

masterServer

eq

The name of the NetBackup master server.

string

Requires Permission: [View Usage Data]

Parameters

Type Name Description Schema Default

Query

filter
optional

The filter criteria in OData format.

string

Query

page[limit]
optional

The number of results on one page.

integer

10

Query

page[offset]
optional

The record number offset.

integer

0

Responses

HTTP Code Description Schema

200

success response.

masterResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Entity not found.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

An unexpected system error occurred.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

GET /licensing/capacity/client-details

Description

Returns the front-end data usage details of a specified NetBackup master server and client. If no filters are specified, details are returned for the last 10 NetBackup master servers queried. All the filters are based on OData standards and filtering is supported using the following attributes:

Name Supported Operators Description Schema

masterServer

eq

Specifies the NetBackup master server name.

string

clientName

eq

Specifies the NetBackup client name. This is a required input parameter.

string

Requires Permission: [View Usage Data]

Parameters

Type Name Description Schema

Query

filter
optional

The filter criteria in OData format.

string

Responses

HTTP Code Description Schema

200

success response.

clientDetailsResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

Entity not found.

errorResponse

415

Unsupported Media Type. The media type specified in the Content-Type header is not supported by this API.

errorResponse

500

An unexpected system error occurred.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

Definitions

clientDetailsResponse

Type : < clientDetailsResponse > array

clientDetailsResponse

Name Schema

clientConsumptionMB
required

number (double)

clientName
required

string

policyDetails
optional

policyDetailsResponse

errorResponse

Name Description Schema

details
optional

A map containing error field and error field message to provide more context to nature of the error.

object

errorCode
required

The NetBackup error code.

integer (int64)

errorMessage
required

The NetBackup error code description.

string

masterDetailsConsolidation

Name Schema

consolidatedMasterConsumptionMB
required

number (double)

mastersCount
required

number

masterDetailsResponse

Type : < masterDetailsResponse > array

masterDetailsResponse

Name Schema

attributes
required

attributes

id
required

string

type
required

string

attributes

Name Schema

clientDetails
optional

clientDetailsResponse

masterConsumptionMB
optional

number (double)

masterResponse

Name Schema

data
required

masterDetailsResponse

meta
required

meta

meta

Name Schema

pagination
required

paginationValues

paginationValues

Name Schema

count
optional

integer (int64)

first
optional

integer (int64)

last
optional

integer (int64)

limit
optional

integer (int64)

next
optional

integer (int64)

offset
optional

integer (int64)

prev
optional

integer (int64)

policyDetailsResponse

Type : < policyDetailsResponse > array

policyDetailsResponse

Name Schema

backupId
required

string

masterServer
required

string

policyConsumptionMB
required

number (double)

policyName
required

string

policyType
required

string

Security

rbacSecurity

Type : apiKey
Name : Authorization
In : HEADER

NetBackup Troubleshooting API

Overview

The NetBackup Troubleshooting API provides information about the NetBackup status codes.

Version information

Version : 2.0

URI scheme

Host : <masterserver>:1556
BasePath : /netbackup
Schemes : HTTPS

Paths

GET /status-codes/{statusCode}

Description

Provides information about the specified NetBackup status code.

Requires Permission: []

Parameters

Type Name Description Schema

Path

statusCode
required

The NetBackup status code.

integer (int64)

Responses

HTTP Code Description Schema

200

Successfully returned information about the specified NetBackup status code.

getStatusCodeResponse

400

The specified NetBackup status code is invalid.

errorResponse

401

The Authorization header is missing, the token is invalid, or you do not have permission for this action.

errorResponse

404

The NetBackup status code was not found.

errorResponse

Produces

  • application/vnd.netbackup+json;version=2.0

Security

Type Name

apiKey

rbacSecurity

Example HTTP response

Response 200
{
  "data" : {
    "type" : "statusCode",
    "id" : 156,
    "attributes" : {
      "statusMessage" : "snapshot error encountered"
    }
  }
}

Definitions

errorResponse

Name Description Schema

details
optional

A map containing error field and error field message to provide more context to nature of the error.

object

errorCode
required

The NetBackup error code.

integer (int64)

errorMessage
required

The NetBackup error code description.

string

getStatusCodeResponse

The status code information.

Name Description Schema

data
required

Contains the status code information.

data

data

Name Description Schema

attributes
required

The status code information.

attributes

id
required

The status code identifier.

string

type
required

The resource type.
Default : "statusCode"

string

attributes

Name Description Schema

statusMessage
required

The message corresponding to the specified NetBackup status code.

string

Security

rbacSecurity

Type : apiKey
Name : Authorization
In : HEADER