Name
nboracmd — utility for configuring NetBackup Oracle assets
SYNOPSIS
add database [-S primary_server] -name database_name -unique_name db_unique_name -id database_id -type RAC | RAC_ONE_NODE -scan_name scan_name -service_name service_name -port port [-load_balanced_node_count number] [-wallet_path path]
add database [-S primary_server] -name database_name -unique_name db_unique_name -id database_id -type SINGLE_INSTANCE [-tns_name tns_name] [-wallet_path path]
add instance [-S primary_server] -name instance_name -client_name client_name -oracle_home oracle_home -database_asset_id db_asset_id [-base_config base_config] [-base_home base_home] [-override_tns_admin tns_admin] [-backup_client_name backup_client_name]
add rman_catalog [-S primary_server] -name name [-tns_name tns_name]
add data_guard [-S primary_server] -name data_guard_name -database_name database_name -id database_id -database_asset_id id1 [-database_asset_id id2 ...]
delete database [-S primary_server] ASSET_ID
delete pdb [-S primary_server] ASSET_ID
delete instance [-S primary_server] ASSET_ID
delete rman_catalog [-S primary_server] ASSET_ID
delete data_guard [-S primary_server] ASSET_ID
discover databases [-S primary_server] -client_name client_name
discover pdbs [-S primary_server] -database_asset_id db_asset_id
list data_guards [-S primary_server] [-format {csv,json}] [-limit limit] [-filter filter] [-sort sort]
list databases [-S primary_server] [-format {csv, json}][-limit limit] [-filter filter] [-sort sort]
list pdbs [-S primary_server] [-format {csv, json}] [-limit limit] [-filter filter] [-sort sort]
list instances [-S primary_server] [-format {csv, json}] [-limit limit] [-filter filter] [-sort sort] [-show_connect_descriptor]
list credentials [-S primary_server] [-format {csv, json}] [-limit limit] [-filter filter] [-sort sort]
list jobs [-S primary_server] [-format {csv, json}] [-limit limit] [-filter filter] [-sort sort]
list rman_catalogs [-S primary_server] [-format {csv, json}] [-limit limit] [-filter filter] [-sort sort]
list job_details -job_id job_id [-S primary_server] [-format {csv, json}]
modify database [-S primary_server] [-wallet_path path] [-tns_name tns_name] [-type SINGLE_INSTANCE | RAC | RAC_ONE_NODE] [-port port] [-service_name service_name] [-scan_name scan_name] [-state ACTIVE | INACTIVE] [-load_balanced_node_count number] [-rman_catalog rman_catalog] ASSET_ID
modify instance [-S primary_server] [-backup_client_name backup_client_name] [-oracle_home oracle_home] [-base_config base_config] [-base_home base_home] [-override_tns_admin tns_admin] [-state ACTIVE | INACTIVE] ASSET_ID
backup -policy policy [-S primary_server] [-schedule schedule] ASSET_ID
manage credentials -name credential_name [-S primary_server] [-force] ASSET_ID
On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/
On Windows systems, the directory path to this command is install_path\NetBackup\bin\
DESCRIPTION
The nboracmd command can list, modify, and backup Oracle assets. The nboracmd command performs the following operations:
add database adds a RAC database or a single instance database asset.
add instance adds an instance asset.
add rman_catalog adds an RMAN catalog asset.
add data_guard adds a Data Guard asset.
delete database deletes an Oracle database asset.
delete data guard deletes an Oracle Data Guard asset.
delete pdb deletes an Oracle pluggable database (PDB) asset.
delete instance deletes an Oracle instance asset.
delete rman catalog deletes an Oracle RMAN catalog asset.
discover databases discovers Oracle databases.
discover pdbs discovers Oracle pluggable databases (PDBs).
list data guards lists Oracle Data Guard assets.
list databases lists Oracle database assets.
list pdbs lists Oracle pdb assets.
list instances lists oracle instance assets.
list credentials lists NetBackup CMS Oracle credentials.
list jobs lists NetBackup Oracle jobs.
list rman_catalogs lists Oracle RMAN catalog assets.
list job_details lists Oracle job details.
modify database modifies an Oracle database asset with the given asset ID.
modify instance modifies an Oracle instance asset with the given asset ID.
backup runs an immediate backup with the provided policy and asset ID.
manage credentials associates the given credential with an asset.
OPTIONS
- ASSET_ID
A positional argument that must be specified at the end of the command. The asset ID of the asset to be backed up, modified, or managed.
- -backup_client_name name
The backup client name to be used with the given asset ID. When you use the nboracmd add instance command, this option applies only when you add a RAC or a RAC One Node instance asset.
- -base_config path
The base config path to be set on the asset with the given asset ID.
- -base_home home
The base home path to be set on the asset with the given asset ID.
- -client_name client_name
The client name that is associated with the database or the instance.
- -database_asset_id db_asset_id or -database_asset_id id1 [-database_asset_id id2...]
The ID of the database asset. When the option is used with the add data_guardcommand, you can specify one or more IDs.
- -filter filter
Filters the data in the list. The filter value must be in OData format. Can only be used with -format json.
- -force
Used with manage credentials to associate a credential with an asset without validating the credential.
- -format {csv | json}
Specifies the format to be used for the output. Defaults to csv.
- -help
Prints the usage of a given action.
- -id database_id
The database ID that is defined by Oracle.
- -job_id ID
The ID of the job to print details of.
- -limit limit
The maximum items to return as a list. The maximum is 100.
- -load_balanced_node_count number
An integer that defines the maximum number of nodes NetBackup uses for backup. Backups proceed with a lower number, if the number of nodes that is specified is not available. If you specify 0 (zero) NetBackup uses all the available nodes.
- -name name or -name database_name or -name instance_name
The name of the CMS credentials to associate with a given asset.
When the option is used with the manage credentials command, it is the name of the CMS credentials. When the option is used with the add database command, it is the name of the database. When the option when used with the add instance command, it is the name of the instance.
- -oracle_home oracle_home
Specifies the file path of the Oracle home directory where the instance resides.
- -override_tns_admin tns_admin
Used to override default TNS_ADMIN path.
- -policy name
The policy name the backup request uses.
- -port port
The port to be assigned to the database asset.
- -rman_catalog ID
The asset ID of an RMAN catalog to be associated with a given database.
- -S primary_server
Specifies the primary server that contains the asset to be listed or modified.
- -scan_name name
Specifies the new SCAN name to be associated with the given database asset.
- -schedule schedule
Specifies the schedule to be used when backing up an asset. If not specified, it defaults to a full schedule.
- -service_name name
Specifies the new service name to be associated with the given database asset.
- -show_connect_descriptor
Optional flag with list instances to include the connect descriptor for the RAC instances.
- -sort sort
Sorts the data in the list. The sort value must be in OData format. Can only be used with -format json.
- -state ACTIVE | INACTIVE
Specifies the new state to be assigned to the given instance or database asset.
- -tns_name name
Specifies the new TNS name to be assigned to the given database asset.
- -type SINGLE_INSTANCE | RAC | RAC_ONE_NODE
Specifies the new database type to be assigned to the given database asset.
- -unique_name db_unique_name
The unique name of the database.
- -wallet_path path
Specifies the new wallet path to be assigned to the given database asset.
EXAMPLES
Example 1: List the databases, filtering on the database name.
nboracmd list databases -format json -filter "commonAssetAttributes/displayName eq 'orcl'"
Example 2: List the RMAN catalogs, sorting on the first discovered time.
nboracmd list rman_catalogs -format json -sort "commonAssetAttributes.detection.firstDiscoveredTime"
Example 3: Modify the database to ACTIVE and set the load_balanced_node_count to 1.
nboracmd modify database -state ACTIVE -load_balanced_node_count 1 b8402e70e3f788a43e643142cc27854f75c8e3d357dc
Example 4: Modify an instance's backup client name and state.
nboracmd modify instance -backup_client_name backup.client.name.com -state ACTIVE 2efa9157344448d40d001870e3ff75c8e3d357dc
Example 5: Run an immediate backup of a database.
nboracmd backup -policy oracle -schedule inc b8402e70e3f788a43e643142cc27854f75c8e3d357dc
Example 6: Manage an asset's credentials without validating.
nboracmd manage credentials -name oracle_creds -force b8402e70e3f788a43e643142cc27854f75c8e3d357dc
Example 7: Add a Data Guard asset with multiple database asset IDs.
nboracmd add data_guard -name dg_config -database_name orac19 -id 1384408790 -database_asset_id 2f47b5a143c737b2ed85de111c796c4829cd2183590f86f7809052daba7c33ad -database_asset_id cd2183590f86f7809052daba7c33ad372f47b5a143c729b2ed85de111c796c48 -database_asset_id ad372f47b5a143c729b2ed85de1cd2183590f86f7809052daba7c3311c796c48