NetBackup 9.0 Application Guide

Last Published:
Product(s): Appliances (2.0)
Platform: Flex Appliance OS
  1. Product overview
    1.  
      Introduction to NetBackup applications for Flex Appliance
    2.  
      About the Flex Appliance documentation
    3.  
      NetBackup 9.0 application new features, enhancements, and changes
    4.  
      Supported upgrade paths to this release
    5.  
      Operational notes
  2. Geting started
    1.  
      Prerequisites before you can create NetBackup application instances
    2.  
      Installing the NetBackup Administration Console and client packages
  3. Creating NetBackup application instances
    1. Creating application instances
      1.  
        Creating a NetBackup master server instance
      2.  
        Creating a NetBackup media server instance
      3.  
        Creating a NetBackup WORM storage server instance
  4. Managing NetBackup application instances
    1.  
      Managing application instances from Flex Appliance and NetBackup
    2. Accessing NetBackup master and media server instances for management tasks
      1. Managing users on a master or media server instance
        1.  
          Adding and removing local users on a master or media server instance
        2.  
          Connecting a remote user domain to a master or media server instance
        3.  
          Changing a user password on a master or media server instance
      2. Running NetBackup commands on a master or media server application instance
        1.  
          Creating a NetBackup touch file on a master or media server application instance
      3.  
        Monitoring NetBackup services on a NetBackup master server instance
      4.  
        Mounting an NFS share on a NetBackup master server instance
      5.  
        Setting environment variables on master and media server instances
      6.  
        Storing custom data on a master or media server instance
      7.  
        Modifying or disabling the nbdeployutil utility on a master server instance
      8.  
        Establishing trust with a NetBackup 7.7.3 master server instance
    3. Accessing NetBackup WORM storage server instances for management tasks
      1. About the NetBackup WORM storage server shell
        1.  
          About the dedupe command
        2.  
          About the retention command
        3.  
          About the setting command
        4.  
          About the support command

About the setting command

Thie setting command lets you manage the deduplication and system configuration settings.

The following table describes the options and arguments for the setting command.

Table: The options and arguments for the setting command.

Option and its description

Argument

Description

certificate

Configure settings for CA certificates.

remove-enrollment

Removes the external certificate details with respect to the specified master server from the local certificate store.

get-external-certificates

Download and replace the external certificates.

This command requires the following parameters:

  • private_key

    Enter the RSA private key of the host certificate.

  • cert

    Enter the X.509 certificate of the host in PEM format.

  • scp_host

    Specify the host that stores the external certificates.

  • scp_port

    Specify the port to connect to on the remote host.

  • passphrase

    Enter the passphrase of the RSA private key if the key is encrypted.

set-CRL-check-level

Sets the revocation check level for the external certificates. Use the check_level parameter to enter the value for the revocation check level.

show-CA-cert-detail

Displays the NetBackup CA certificate details of the specified master server.

get-CA-certificate

Obtains the NetBackup CA certificate from the master server. By default, the command uses the first master server entry in the NetBackup configuration file.

You can specify an alternate master server using the master_server parameter.

For example:

setting certificate get-CA-certificate master_serveralternate master server

external-CA-health-check

Verifies the entered certificates, RSA keys, and the trust store.

disable-CA

Disable the NetBackup CA support from this NetBackup host. Use the host ID and the CA fingerprint of the NetBackup host whose CA you want to disable.

For example:

setting certificate disable-CA host_ID specify hostID cafp host CA fingerprint

install-external-certificates

Download and install the external CA certificates.

This command requires the following parameters:

  • private_key

    Enter the RSA private key of the host certificate.

  • cert

    Enter the X.509 certificate of the host in PEM format.

  • scp_host

    Specify the host that stores the external certificates.

  • scp_port

    Specify the port to connect to on the remote host.

  • cacert

    Enter the external CA trust store in PEM format.

  • passphrase

    Enter the passphrase of the RSA private key if the key is encrypted.

list-certificates

Lists details of all the security certificates that are available on the NetBackup host.

list-CA-cert-details

Lists the CA details from the local NetBackup trust store.

show-CRL-check-level

Retrieves the revocation check level for the external certificates.

get-external-CA-certificate

Download and install the external CA certificate.

This command requires the following parameters:

  • scp_host

    Specify the host that stores the external certificates.

  • scp_port

    Specify the port to connect to on the remote host.

  • cacert

    Enter the external CA trust store in PEM format.

get-certificate

Requests a NetBackup certificate for the host from the master server.

This command requires the following parameters:

  • master_server

    Specify an alternate master server. By default, this command uses the first master server entry in the NetBackup configuration file.

  • force

    Overwrite the certificate if it already exists.

  • token

    Securely enter an authorization token if the command prompts that a token is required for the request.

list-enrollment-status

Retrieves the enrollment status of the associated master servers from the local certificate store.

host-self-check

Verifies whether the host certificate is in the certificate revocation list.

show-external-CA-cert-detail

Displays the External CA certificate details of the specified master server.

FIPS

Manage FIPS settings.

disable

Disable FIPS in MSDP.

enable

Enable FIPS in MSDP.

status

Display the status of FIPS in MSDP.

MSDP-VLAN

Configure the settings for MSDP VLAN.

add

Add a VLAN for the NetBackup WORM storage server.

Use the interface parameter to enter the IP address for the VLAN that you want to add.

remove

Remove a VLAN for the NetBackup WORM storage server.

Use the interface parameter to enter the IP address for the VLAN that you want to remove.

list

List all the VLANs for the NetBackup WORM storage server.

user

Configure the settings for the SSH user.

show-password-exp-date

Displays the password expiration date of the user.

Use the username parameter to display the password expiration date of the user.

change-password

Change the password for a user.

This command requires the following parameters:

  • username

    Enter the username to change its password.

  • password

    Enter the password for the user. The password must have characters between 15 but not greater than 32. The password requires at least one uppercase character, one lowercase character, one number, and one special character ( _, ., /, @, *, !, %, #, &).

random-password

Generate a random password.

show-user

Display the user information.

Use the username parameter to display the information of that user.

set-password-exp-date

Set the expiration date for the user password.

This command requires the following parameters:

  • username

    Enter the username to set the user's password expiration date.

  • password_exp_date

    Set a password expiration date in the YYYY-MM-DD format.

delete-user

Disable an SSH user.

Use the username parameter to disable the user.

list-users

List all the SSH users.

add-user

Create an SSH user.

This command requires the following parameters:

  • username

    Enter the username of the new user.

  • password

    Enter the password for the newuser that you want to create. The password must have characters between 4 but not greater than 30. The characters can be uppercase (A-Z), lowercase letters (a-z), numbers (0-9), and special characters ( _, ., /, @, *, !, %, #, &).

network

Configure the network settings.

ping

Ping the network for a connection status.

Use the ip parameter to enter the IP address of the network to check the connection status.

ifconfig

Display the IP address of the network.

route

Display the network route information.

WORM

Configure the settings for immutable and indelible storage.

status

Display the status of WORM storage.

set-max

Specify the maximum duration to keep the storage immutable and indelible.

Use the worm_max parameter to specify the maximum duration in seconds to keep the storage immutable and indelible (WORM).

set-min

Specify the minimum duration to keep the storage immutable and indelible.

Use the worm_min parameter to specify the minimum duration in seconds to keep the storage immutable and indelible (WORM).

show-mode

Display the WORM mode.

set-MSDP-param

Set the parameters in the MSDP configuration files.

write-thread-num

Get and set the <WriteThreadNum> parameter.

Use the value parameter to enter the value that is used by the MSDP parameters.

spoold-logging

Get and set the <SpooldLogging> parameter.

allocation-unit-size

Get and set the <AllocationUnitSize> parameter.

data-check-days

Get and set the <DataCheckDays> parameter.

max-fp-cache-size

Get and set the <MaxFPCacheSize> parameter.

max-retry-count

Get and set the <MaxRetryCount> parameter.

spad-logging

Get and set the <SpadLogging> parameter.

log-retention

Get and set the <LogRetention> parameter.

get-MSDP-param

Get the parameters from the MSDP configuration files.

write-thread-num

Get and set the <WriteThreadNum> parameter.

spoold-logging

Get and set the <SpooldLogging> parameter.

allocation-unit-size

Get and set the <AllocationUnitSize> parameter.

data-check-days

Get and set the <DataCheckDays> parameter.

max-fp-cache-size

Get and set the <MaxFPCacheSize> parameter.

max-retry-count

Get and set the <MaxRetryCount> parameter.

spad-logging

Get and set the <SpadLogging> parameter.

log-retention

Get and set the <LogRetention> parameter.

MSDP-user

Configure the settings for the MSDP user.

random-password

Generates a random password.

list

List all the MSDP users.

verify-user

Verify user password and user role.

add-MSDP-user

Create an MSDP user.

reset-password

Reset the password for the MSDP user.

encryption

Configure the settings for MSDP encryption.

enable-kms

Enable KMS for MSDP.

This command requires the following parameters:

  • kms_server

    Enter the hostname of the KMS server.

  • key_group

    Enter the KMS key group name..

status

Display the current encryption status.

enable

Enable encryption for MSDP.

kms-status

Display the current KMS status.

kernel

Get the information about the kernel.

search-param

Search for a keyword in the kernel parameters.

Use the keyword to specify a keyword to search in the keyword parameters.