NetBackup™ Web UI Security Administrator's Guide

Last Published:
Product(s): NetBackup (8.2)
  1. Introducing the NetBackup web user interface
    1.  
      About the NetBackup web user interface
    2.  
      Terminology
    3.  
      First-time sign in to a NetBackup master server from the NetBackup web UI
    4.  
      Sign in to the NetBackup web UI
    5.  
      Authorized users
    6.  
      The NetBackup dashboard
  2. Managing role-based access control
    1.  
      About role-based access control (RBAC) in NetBackup
    2.  
      NetBackup default RBAC roles
    3.  
      Configuring RBAC
    4.  
      Add a custom role
    5.  
      Edit or delete a custom role
    6.  
      About object groups
    7. Steps to create an object group
      1.  
        Selecting the assets for an object group
      2.  
        Selecting application servers for an object group
      3.  
        Selecting protection plans for an object group
      4.  
        Preview the objects in an object group
    8.  
      Edit or delete an object group
    9.  
      Add access for a user through access rules
    10.  
      Edit or remove user access rules
  3. Adding AD or LDAP domains
    1.  
      Add AD or LDAP domains
  4. Security events and audit logs
    1.  
      View security events and audit logs
    2. About NetBackup auditing
      1.  
        User identity in the audit report
      2.  
        Audit retention period and catalog backups of audit records
      3.  
        Viewing the detailed NetBackup audit report
  5. Managing hosts
    1.  
      View NetBackup host information
    2.  
      Approve or add mappings for a host that has multiple host names
    3.  
      Remove mappings for a host that has multiple host names
    4.  
      Reset a host's attributes
  6. Managing security certificates
    1.  
      About security management and certificates in NetBackup
    2.  
      NetBackup host IDs and host ID-based certificates
    3. Managing NetBackup security certificates
      1.  
        Reissue a NetBackup certificate
      2.  
        Managing NetBackup certificate authorization tokens
    4. Using external security certificates with NetBackup
      1.  
        View external certificate information for the NetBackup hosts in the domain
  7. Managing user sessions
    1.  
      Display a message to users when they sign in
    2.  
      Enable maximum sign-in attempts and idle time-out settings for user sessions
    3.  
      Sign out a NetBackup user session
    4.  
      Unlock a NetBackup user
  8. Managing master server security settings
    1.  
      Certificate authority for secure communication
    2.  
      Disable communication with NetBackup 8.0 and earlier hosts
    3.  
      Disable automatic mapping of NetBackup host names
    4.  
      About NetBackup certificate deployment security levels
    5.  
      Select a security level for NetBackup certificate deployment
    6.  
      Set a passphrase for disaster recovery
  9. Creating and using API keys
    1.  
      About API keys
    2.  
      Manage API keys
    3.  
      Use an API key with NetBackup REST APIs
    4.  
      View API keys
  10. Configuring smart card authentication
    1.  
      Configure user authentication with smart cards or digital certificates
    2.  
      Edit the configuration for smart card authentication
    3.  
      Add or delete a CA certificate that is used for smart card authentication
    4.  
      Disable or temporarily disable smart card authentication
  11. Troubleshooting access to the web UI
    1.  
      Tips for accessing the NetBackup web UI
    2.  
      If a user doesn't have the correct permissions or access in the NetBackup web UI
    3. Unable to add AD or LDAP domains with the vssat command
      1.  
        Connection cannot be established with the AD or the LDAP server
      2.  
        User credentials are not valid
      3.  
        An incorrect user base DN or group base DN was provided
      4.  
        Multiple users or groups exist with the same name under user base DN or group base DN
      5.  
        User or group does not exist

Manage API keys

NetBackup security administrators or NetBackup users with permissions to manage API keys can use the NetBackup web UI to add, edit, delete, or view the keys that are associated with all NetBackup users. A NetBackup-authenticated user can view and manage their own API key using the NetBackup APIs, if that user does not have RBAC permissions.

See Add access for a user through access rules.

Add an API key

You can create API keys 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.

Note: Only one API key can be associated with a specific user at a time. If a user requires a new API key, you must delete any active or any expired key for that user.

To add an API key

  1. On the left, select Security > API keys.
  2. In the upper-right corner, click Add.
  3. Enter a User name for which you want to create the API key.
  4. Indicate how long you want the API key to be valid, from today's date.

    NetBackup calculates the expiration date and displays it below.

  5. Click Add.
  6. To copy the API key, click Copy to clipboard.

    Store this key in a safe place until you can deliver the key to the user. After you click Close, the key cannot be retrieved again. If this API key replaces a previous key for the user, the user must update any scripts, etc. to reflect the new API key.

  7. Click Close.

Edit an API key

You can change the expiration date for an active API key. After an API key expires, a user's old key must be deleted and a new key created.

To edit an API key

  1. On the left, select Security > API keys.
  2. Select the API key and click Edit.
  3. Note the current expiration date for the key and extend the date as wanted.
  4. Click Save.

Delete an API key

You can delete an API key if you do not want a user to have access to the key or when it is no longer used. When you delete an API key, that key is permanently deleted. The associated user can no longer use that key for authentication or with the NetBackup APIs.

To delete an API key

  1. On the left, select Security > API keys.
  2. Select the API key and click Delete > Delete.