Search <book_title>...

NetBackup™ Release Notes

Last Published: 2022-02-03

Product(s): NetBackup (9.1)

RESTful APIs included in NetBackup 9.1

NetBackup 9.1 includes both updated and new RESTful application programming interfaces (APIs). These APIs provide a web-service-based interface that lets you configure and administer NetBackup in your environments.

You can find documentation for the NetBackup APIs in these locations:

On your master server
APIs are stored in YAML files on the master server:
https://<master_server>/api-docs/index.html
The APIs are documented in Swagger format. This format lets you review the code and test the functionality by making actual calls with the APIs. You must have the appropriate security permissions to access the master server and APIs to use the Swagger APIs.
Caution:
Veritas recommends that you test APIs only in a development environment. Because you can make actual API calls from the Swagger files, you should not test the APIs in a production environment.
On SORT
NetBackup API documentation is also available on SORT:
HOME > KNOWLEDGE BASE > Documents > Product Version > 9.1
Look under API Reference. A Getting Started document provides background information about using NetBackup APIs. The API YAML files are also available for reference, however, they are not functional. You cannot test the APIs from the documents on SORT.

Access control on jobs

The current version of several jobs APIs have added, finer-grained access control based on workload assets. Access to jobs can still be configured globally granting operations to all jobs by using the `|MANAGE|JOBS|` namespace. Now, access to jobs can be limited to specific workloads and even specific assets for which the jobs have been run. Object-level access to backup and restore jobs is enforced based on the access control ID (namespace) of the asset for which the job was created.

Previously, the permission to change the job state was controlled by a single update operation. Additional job-specific operations have been added to allow an administrator the ability to grant suspend, restart, resume and cancel jobs independently.

Previous versions of job APIs included the notion of "initiator-based" access control in which a user that initiates a backup job has full privilege on that job regardless of operations granted by an administrator. In this release, the initiator-based access has been removed in lieu of asset-based object-level access control.

New APIs

NetBackup 9.1 includes these new and enhanced APIs:

Agentless Hosts: Manage agentless hosts.
iSCSI Settings: Manage global iSCSI settings for AHV workloads.
Policies: Support for VMware policy type and new snapshot configuration validation.
SAML Certificates: Manage SAML certificates for single sign-on based authentication.
SLP: Update and check for conflicts with storage lifecycle policies (SLP).
SLP Settings: Manage the global storage lifecycle policy (SLP) settings.
SLP Windows: Manage storage lifecycle policy (SLP) windows.
Snapshot Management Server Extensions: Manage extensions registered with the CloudPoint server.
Snapshot Providers - Azure Domains: Retrieves information about configured Azure domains.
Recovery
- Cloud: Pre-recovery check for cloud asset recovery.
- Nutanix AHV: Full AHV VM recovery. Individual file and folder recovery both with NetBackup client and agentless.
- Oracle: Complete Oracle database recovery.
- Physical: Granular file and folder recovery from a physical system.
- VMware: Instant-Sync VM recovery.
User Certificate Login: Allows for client certificate authentication with an X.509 certificate.
GET /catalog/image-contents
This existing API has been augmented to support the request header `X-NetBackup-All-Copies`. This header is a boolean that indicates it should return all backups for each path in the date range rather than only the latest.

Versioned APIs

Jobs

The following attributes were removed from the job detail response in V6.0:

initiatorId

The following attributes were added to the job detail response in V6.0:

Attribute	Type
dteMode	String
dedupSpaceRatio	Float
compressionSpaceRatio	Float
workloadDisplayName	String

Other changes to Jobs APIs include:

GET:/admin/jobs
A new cursor-based pagination strategy has been implemented for the list jobs APIs.
RBAC enforcement has been expanded to include object-level enforcement based on workload assets.
A new operation, |OPERATIONS|MANAGE|JOBS|VIEW|, has been introduced to grant view permission on an asset-based job. This allows an administrator to delegate access to a job independently of the asset for which a job is run.
Initiator-based enforcement has been removed. Object-level enforcement support has made the initiator-based enforcement redundant.
```
GET:/admin/jobs/{jobId}
GET:/admin/jobs/{jobId}/progress-logs
GET:/admin/jobs/{jobId}/try-logs
GET:/admin/jobs/{jobId}/try-logs/{attempt}
GET:/admin/jobs/{jobId}/file-lists
```
RBAC enforcement has been expanded to include object-level enforcement based on workload assets.
A new operation, |OPERATIONS|MANAGE|JOBS|VIEW|, has been introduced to distinguish the ability to view a job and the asset for which jobs are run.
Initiator-based enforcement has been removed. Object-level enforcement support has made the initiator-based enforcement redundant.
```
GET:/admin/jobs/{jobId}/cancel
GET:/admin/jobs/{jobId}/suspend
GET:/admin/jobs/{jobId}/resume
GET:/admin/jobs/{jobId}/restart
```
RBAC enforcement has been expanded to include object-level enforcement based on workload assets.
The ability to cancel, suspend, resume and restart a job can now be granted independently at both the api-level and object-level.
Initiator-based enforcement has been removed. Object-level enforcement support has made the initiator-based enforcement redundant.