Veritas NetBackup™ Virtual Appliance Documentation
- Getting to know the NetBackup Virtual Appliance
- NetBackup Virtual Appliance product description
- Preparing to deploy the appliance
- Deploying and configuring the appliance
- How to deploy and configure a NetBackup Virtual Appliance combined primary and media server
- How to deploy and configure a NetBackup Virtual Appliance media server
- How to deploy and configure a NetBackup Virtual Appliance primary server
- How to deploy and configure a NetBackup Virtual Appliance combined primary and media server
- Post initial configuration procedures
- Appliance common tasks
- Storage management
- About NetBackup Virtual Appliance storage configuration
- About viewing storage space information using the Show command
- About OpenStorage plugin installation
- About NetBackup Virtual Appliance storage configuration
- Deduplication pool catalog backup and recovery
- Network connection management
- Managing users
- About user name and password specifications
- About authenticating LDAP users
- About authenticating Active Directory users
- About authentication using Smart Cards and digital certificates
- About authenticating Kerberos-NIS users
- About user authorization on the NetBackup Virtual Appliance
- Creating NetBackup administrator user accounts
- Using the appliance
- About configuring Host parameters for your appliance on the NetBackup Virtual Appliance
- About Copilot functionality and Share management
- About NetBackup Virtual Appliance as a VMware backup host
- About running NetBackup commands from the appliance
- About mounting a remote NFS
- About Auto Image Replication from a NetBackup Virtual Appliance
- Monitoring the appliance
- About SNMP
- About Call Home
- Appliance security
- About Symantec Data Center Security on the NetBackup Virtual Appliance
- About data encryption
- Setting the appliance login banner
- Upgrading the appliance
- About upgrading to NetBackup Virtual Appliance software version 5.0
- Requirements and best practices for upgrading NetBackup appliances
- Methods for downloading appliance software release updates
- NetBackup client upgrades with VxUpdate
- Appliance restore
- Decommissioning and Reconfiguring
- Troubleshooting
- About disaster recovery
- About NetBackup support utilities
- Appliance logging
- About forwarding logs to an external server
- Commands overview
- Appendix A. Appliance commands
- Appendix B. Manage commands
- Appendix C. Monitor commands
- Appendix D. Network commands
- Appendix E. Reports commands
- Appendix F. Settings commands
- Appendix G. Support commands
- Appendix H. Available commands for a NetBackupCLI user
About implementing ECA certificates
NetBackup Virtual Appliance's web service uses the PKCS#12 standard and requires certificate files to be in the X.509 (.pem
) format. If the certificate files are in the .der
, .DER
, or .p7b
formats, NetBackup Virtual Appliance automatically converts the files to an accepted format.
To prevent errors while importing certificates, ensure that the external certificate files meet the following requirements.
Certificate files are in the
.pem
file format and begin with "-----BEGIN CERTIFICATE-----".Certificate files contain the host name and FQDN in the subject alternative name (SAN) field of the certificate. If the certificate is used in an HA environment, the SAN field must contain VIP, host name, and FQDN.
Subject name and common name fields are not empty.
Subject fields are unique for each host.
Subject fields contain a maximum of 255 characters.
Server and client authentication attributes are set in the certificate.
Only ASCII 7 characters are used in the subject and SAN fields of the certificate.
The private key file is in the PKCS#8 PEM format and begins with -----BEGIN ENCRYPTED PRIVATE KEY----- or -----BEGIN PRIVATE KEY-----.
Although optional, you can use the Settings > Security > Certificate > CertificateSigningRequest > Create command to generate a CSR. Copy the CSR content from the command line to your ECA portal to obtain the required external certificate files.
Example: Enter specified value or use the default value. Common Name (eg, your name or your server's hostname) [Default nbapp2ao]: Organizational Unit Name (eg, section) []:Appliance Organization Name (eg, company) [Default Company Ltd]:Veritas Locality Name (eg, city) [Default City]:Beijing State or Province Name (full name) []:Beijing Country Name (2 letter code) [XX]:CH Email Address []:support@veritas.com Please enter the following 'extra' attributes to be sent with your certificate request. ----- A challenge password []:123456 An optional company name []:VRTS Subject Alternative Name (DNS Names and/or IP Addresses comma separated): nbapp2ao,nbapp2ao.engba.veritas.com Subject Alternative Name (email comma separated): Certificate Signing Request Name [Default nbapp2ao.csr]: Validity period (in days) [Default 365 days]: Ensure that the Distinguished Name (DN) is specified as a string consisting of a sequence of key=value pairs separated by a comma: Then the generated certificate signing request will be shown on the screen. The private key file is /root/privkey.pem.
Starting from version 4.1, you can register an ECA on both NetBackup Virtual Appliance and NetBackup using the Settings > Security > Certificate > Import command.
Perform the following steps to import the host certificate, host private key, and trust store to register the ECA on NetBackup and NetBackup Virtual Appliance. Both NetBackup and NetBackup Virtual Appliance layers use the same host certificate, host private key, and trust store.
- Log in to the appliance as an Administrator user.
- From the NetBackup Virtual Appliance Shell Menu, run the Settings > Security > Certificate > Import command. The following NFS and CFS share locations are now accessible:
NFS:
/inst/share
CFS:
\\<ApplianceName>\general_share
- Upload the certificate file, trust store file, and private key file to either of the share locations and enter the paths to the files.
- Choose how to access the certificate revocation list (CRL). A CRL comprises a list of external certificates that have been revoked by the ECA and should not be trusted. Select either of the following options:
Use the CRL location provided in the certificate file.
Provide the location of a CRL file (
.crl
) in the local network.Do not use a CRL.
- Confirm the location of the certificate files you want to register on the appliance.
A detailed example of how to import the certificates is provided here.
Identify the certificate which should be imported.
After certificate uploaded, /inst/share/ may look like that: /inst/share # ls cacerts.pem cert_chain.pem crl key.pem /inst/share # ls crl NBAECA.crl NBAECA_INTERMEDIATE.crl NBRootCA.crl
Import the certificate.
Enter the certificate: Enter the following details for external certificate configuration: Enter the certificate file path: cert_chain.pem Enter the trust store file path: cacerts.pem Enter the private key path: key.pem Enter the password for the passphrase file path or skip security configuration (default: NONE): Should a CRL be honored for the external certificate? 1) Use the CRL defined in the certificate. 2) Use the specific CRL directory. 3) Do not use a CRL. q) Skip security configuration. CRL option (1): 2 Enter the CRL location path: crl Then confirm input information and answer the subsequent questions.
The certificate files are stored in the
/usr/openv/var/hostcert
directory after enrollment.
Before you use the Copilot feature on an appliance deployed with external certificates, ensure the following:
The appliance's certificate file (in
/etc/vxos-ssl/servers/certs/
) is same as the primary server's certificate file (in/usr/openv/var/global/appliance_certificates/
).The appliance's certificate file (in
/etc/vxos-ssl/servers/certs/
) is named in the<FQDN_hostname>-self.cert.pem
format.
Run the following commands on each of the associated appliances:
rm /etc/vxos-ssl/servers/certs/<FQDN_hostname>-self.cert.pem cp /etc/vxos-ssl/servers/certs/server.pem /etc/vxos-ssl/servers/certs/<FQDN_hostname>-self.cert.pem tpconfig -delete -nb_appliance <Short_hostname> /opt/NBUAppliance/scripts/copilot_users.pl --add
You can manage external certificates on NetBackup Virtual Appliance using the
commands.You can use the Settings > > > command to add a server CA, HTTPS proxy CA, or LDAP CA certificate to the certificate authority list. Ensure that you paste the CA certificate content in the PEM or P7B format. The Appliance appends this CA certificate to the certificate authority list. Before appending the CA certificate, the appliance verifies whether the CA certificate is already being used on the appliance. If yes, the appliance quits with a message. The newly added CA certificate is updated to the System wide trust store, Tomcat key store and NetBackup trust store.
System wide trust store:
The CA certificates is added to the system wide trust store. Copy the CA certificates to
/etc/pki/ca-trust/source/anchors/
, and add the CA certificates to all the locations under/etc/pki/ca-trust/extracted
. This includes the/etc/pki/ca-trust/extracted/openssl/ca-bundle.trust.crt
,/etc/pki/ca-trust/extracted/pem/email-ca-bundle.pem
,objsign-ca-bundle.pem tls-ca-bundle.pem
, and/etc/pki/ca-trust/extracted/java/cacerts
.Tomcat key store:
The CA certificate is added to the Tomcat trust store,
/opt/apache-tomcat/security/keystore
.NetBackup trust store:
If ECA is enabled by NetBackup, the CA is appended to the end of the
/usr/openv/var/hostcert/trustStorePath/cacerts.pem
file. Call configureWebServerCerts to update the NetBackup web service trust store. This includes/usr/openv/var/global/wsl/credentials/externalcacreds/nbwebservice.bcfks
and/usr/openv/var/global/wsl/credentials/tpcredentials/nbwebservice.bcfks
.
You can use the Settings > > > command to remove a server CA certificate from the certificate authority list. The available CA certificates are listed and you can select the certificate that you want to remove. The System wide trust store, Tomcat key store, and NetBackup trust stores are updated to remove the CA certificate.
System wide trust store:
The CA certificate file under
/etc/pki/ca-trust/source/anchors
is removed and the system wide trust store is updated. This includes/etc/pki/ca-trust/extracted/openssl/ca-bundle.trust.crt
,/etc/pki/ca-trust/extracted/pem/email-ca-bundle.pem
,objsign-ca-bundle.pem tls-ca-bundle.pem
, and/etc/pki/ca-trust/extracted/java/cacerts
.Tomcat key store:
The CA certificate is removed from the Tomcat key store.
NetBackup trust store:
Remove the CA certificate from the NetBackup relevant key store. The CA in the
/usr/openv/var/hostcert/trustStorePath/cacerts.pem
file is removed and then the CA in NetBackup web service trust store is removed. This includes the/usr/openv/var/global/wsl/credentials/externalcacreds/nbwebservice.bcfks
and/usr/openv/var/global/wsl/credentials/tpcredentials/nbwebservice.bcfks
.