NetBackup™ Web UI Administrator's Guide
- Introducing NetBackup
- About NetBackup
- NetBackup documentation
- NetBackup web UI features
- NetBackup administration interfaces
- Terminology
- First-time sign in to the NetBackup web UI
- Sign in to the NetBackup web UI
- Sign out of the NetBackup web UI
- Documentation for Catalog Recovery Wizard, disk array hosts, disk pools, and Host Properties in the NetBackup web UI
- Section I. Monitoring and notifications
- Monitoring NetBackup activity
- The NetBackup dashboard
- Activity monitor
- Job monitoring
- Workloads that require a custom RBAC role for specific job permissions
- View a job
- View the jobs in the List view
- View the jobs in the Hierarchy view
- Jobs: cancel, suspend, restart, resume, delete
- Search for or filter jobs in the jobs list
- Create a jobs filter
- Edit, copy, or delete a jobs filter
- Import or export job filters
- Troubleshooting the viewing of jobs
- Notifications
- Monitoring NetBackup activity
- Section II. Configuring hosts
- Managing host properties
- Managing credentials for workloads and systems that NetBackup accesses
- Overview of credential management in NetBackup
- Add a credential in NetBackup
- Add a credential for an external KMS
- Add a credential for NetBackup Callhome Proxy
- Edit or delete a named credential
- Add a credential for Network Data Management Protocol (NDMP)
- Edit or delete Network Data Management Protocol (NDMP) credentials in NetBackup
- Managing deployment
- Section III. Configuring storage
- Section IV. Configuring backups
- Section V. Managing security
- Security events and audit logs
- Managing security certificates
- Managing host mappings
- Managing user sessions
- Managing the security settings for the primary server
- Certificate authority for secure communication
- Disable communication with NetBackup 8.0 and earlier hosts
- Disable automatic mapping of NetBackup host names
- Configure the global data-in-transit encryption setting
- About NetBackup certificate deployment security levels
- Select a security level for NetBackup certificate deployment
- About TLS session resumption
- Set a passphrase for disaster recovery
- About trusted primary servers
- Using access keys, API keys, and access codes
- Configuring authentication options
- Managing role-based access control
- RBAC features
- Authorized users
- Configuring RBAC
- Notes for using NetBackup RBAC
- Add AD or LDAP domains
- View users in RBAC
- Add a user to a role (non-SAML)
- Add a smart card user to a role (non-SAML, without AD/LDAP)
- Add a user to a role (SAML)
- Remove a user from a role
- Disable web UI access for operating system (OS) administrators
- Disable command-line (CLI) access for operating system (OS) administrators
- Default RBAC roles
- Add a custom RBAC role
- Role permissions
- Manage access permission
- View access definitions
- Section VI. Detection and reporting
- Detecting malware
- About malware detection
- Configure a new scan host pool
- Add an existing scan host
- Manage credentials
- Remove the scan host
- Deactivate the scan host
- Scan a policy client backup images for malware
- Perform malware scanning
- Scan a VMware asset for malware
- View the malware scan status
- Actions for malware scanned images
- Recover from malware-affected images (clients protected by policies)
- Recover a VMware asset affected by malware
- Troubleshooting
- Detecting anomalies
- Usage reporting and capacity licensing
- Detecting malware
- Section VII. NetBackup workloads and NetBackup Flex Scale
- Section VIII. Disaster recovery and troubleshooting
API keys
A NetBackup API key is a pre-authenticated token that identifies a NetBackup user to NetBackup RESTful APIs. The user can use the API key in an API request header when a NetBackup API requires authentication. API keys can be created for authenticated NetBackup users (groups are not supported). A specific API key is only created one time and cannot be recreated. Each API key has a unique key value and API key tag. NetBackup audits operations that are performed with that key with the full identity of the user.
The 'View' RBAC permission is required to create an API key.
The following actions are available for administrators and API key users.
Administrators with the applicable role or RBAC permissions can manage API keys for all users. These roles are the Administrator, the Default Security Administrator, or a role with RBAC permissions for API keys.
An authenticated NetBackup user can add and manage their own API key in the NetBackup web UI. If a user does not have access to the web UI, they can use the NetBackup APIs to add or manage a key.
See User identity in the audit report.
See the NetBackup Security and Encryption Guide for information on using API keys with the bpnbat command.