Veritas NetBackup™ Commands Reference Guide
- Introduction
- Appendix A. NetBackup Commands
- acsd
- add_media_server_on_clients
- backupdbtrace
- backuptrace
- bmrc
- bmrconfig
- bmrepadm
- bmrprep
- bmrs
- bmrsrtadm
- bp
- bparchive
- bpbackup
- bpbackupdb
- bpcatarc
- bpcatlist
- bpcatres
- bpcatrm
- bpcd
- bpchangeprimary
- bpclient
- bpclimagelist
- bpclntcmd
- bpclusterutil
- bpcompatd
- bpconfig
- bpdbjobs
- bpdbm
- bpdgclone
- bpdown
- bpduplicate
- bperror
- bpexpdate
- bpfis
- bpflist
- bpgetconfig
- bpgetdebuglog
- bpimage
- bpimagelist
- bpimmedia
- bpimport
- bpinst
- bpkeyfile
- bpkeyutil
- bplabel
- bplist
- bpmedia
- bpmedialist
- bpminlicense
- bpnbat
- bpnbaz
- bppficorr
- bpplcatdrinfo
- bpplclients
- bppldelete
- bpplinclude
- bpplinfo
- bppllist
- bpplsched
- bpplschedrep
- bpplschedwin
- bppolicynew
- bpps
- bprd
- bprecover
- bprestore
- bpretlevel
- bpschedule
- bpschedulerep
- bpsetconfig
- bpstsinfo
- bpstuadd
- bpstudel
- bpstulist
- bpsturep
- bptestbpcd
- bptestnetconn
- bptpcinfo
- bpup
- bpverify
- cat_convert
- cat_export
- cat_import
- configurePorts
- configureTPCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig throttle
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- manageClientCerts
- mklogdir
- nbauditreport
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcldutil
- nbcloudrestore
- nbcomponentupdate
- nbcplogs
- nbdb_admin
- nbdb_backup
- nbdb_move
- nbdb_ping
- nbdb_restore
- nbdb_unload
- nbdbms_start_server
- nbdbms_start_stop
- nbdc
- nbdecommission
- nbdelete
- nbdeployutil
- nbdevconfig
- nbdevquery
- nbdiscover
- nbdna
- nbemm
- nbemmcmd
- nbfindfile
- nbfirescan
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhypervtool
- nbinstallcmd
- nbjm
- nbkmsutil
- nboraadm
- nborair
- nbpem
- nbpemreq
- nbperfchk
- nbplupgrade
- nbrb
- nbrbutil
- nbregopsc
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbsetconfig
- nbsnapimport
- nbsnapreplicate
- nbsqladm
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- resilient_clients
- restoretrace
- stopltid
- tl4d
- tl8d
- tl8cd
- tldd
- tldcd
- tlhd
- tlhcd
- tlmd
- tpautoconf
- tpclean
- tpconfig
- tpext
- tpreq
- tpunmount
- verifytrace
- vltadm
- vltcontainers
- vlteject
- vltinject
- vltoffsitemedia
- vltopmenu
- vltrun
- vmadd
- vmchange
- vmcheckxxx
- vmd
- vmdelete
- vmoprcmd
- vmphyinv
- vmpool
- vmquery
- vmrule
- vmupdate
- vnetd
- vssat
- vwcp_manage
- vxlogcfg
- vxlogmgr
- vxlogview
- W2KOption
Name
nbemmcmd — update and view information in the EMM database
SYNOPSIS
[-addhost] [-changesetting] [-deletehost] [-errorsdb] [-getemmserver] [-help] [-listhosts] [-listmedia] [-listsettings] [-machinealias] [-renamehost] [-resethost] [-servercontrol] [-setemmserver] [-updatehost]
-addhost [-activenodename string] [-brief] [-clustername string] [-displayname string] [-machinedescription string] -machinename string -machinetype api | app_cluster | cluster | master | media | ndmp [-masterserver string] [-netbackupversion level[.major_level[minor_level]]] [-operatingsystem hpux | linux | rs6000 | solaris | windows] [-scanability unsigned_integer]
-changesetting -machinename string [-ALLOW_MULTIPLE_RETENTIONS_PER_MEDIA 0|1|no|yes] [-AUDIT DISABLED | ENABLED] [-AUDIT_ RETENTION_PERIOD number_of_days] [-COMMON_SERVER_FOR_DUP default | preferred | required] [-DISABLE_AUTOMATIC_HOST_NAME_ADD 0|1|no|yes] [-DISABLE_BACKUPS_SPANNING_DISK 0|1|no|yes] [-DISABLE_DISK_STU_JOB_THROTTLING 0|1|no|yes] [-DISABLE_STANDALONE_DRIVE_EXTENSIONS 0|1|no|yes] [-DISALLOW_NONNDMP_ON_NDMP_DRIVE 0|1|no|yes] [-DO_NOT_EJECT_STANDALONE 0|1|no|yes] [-DONT_USE_SLAVE 0|1|no|yes] [-DRIVE_ERROR_THRESHOLD unsigned_integer] [-DRIVE_NAME_SEED 0|1|no|yes] [-emmname string] [-emmport unsigned_integer] [-MAX_REALLOC_TRIES unsigned_integer] [-MEDIA_ERROR_THRESHOLD unsigned_integer] [-MEDIA_REQUEST_DELAY unsigned_integer] [-MPMS_DISABLE_EVENTS 0|1|no|yes] [-MPMS_DISABLE_RANK unsigned_integer] [-MUST_USE_LOCAL_DRIVE 0|1|no|yes] [-NBUFS_DESTINATION_DSU string] [-NBUFS_DUP_TSU_TO_DSU 0|1|no|yes] [-NBUFS_RETENTION_LEVEL unsigned_integer] [-NON_ROBOTIC_MEDIA_ID_PREFIX string] [-PREFER_NDMP_PATH_FOR_RESTORE 0|1|no|yes] [-RETURN_UNASSIGNED_MEDIA_TO_SCRATCH_POOL 0|1|no|yes] [-SCSI_PROTECTION NONE | SPR | SR] [-SHAREDISK_MOUNT_POINT string] [-TIME_WINDOW unsigned_integer] [-UNRESTRICTED_SHARING 0|1|no|yes] [-USE_POTENTIAL_FREESPACE_FOR_ALLOCATION 0|1|no|yes] [-VALIDATE_HOST_NAME 0|1|no|yes] [-VAULT_CLEAR_MEDIA_DESC 0|1|no|yes]
-deletealldevices [-allrecords] | [-machinename string] | [-machinetype api | app_cluster | appliance | client | cluster | disk_array | foreign_media | master | media | nbwss_endpoint | ndmp | remote_master | replication_host | virtual_machine] [-emmname string] [-emmport unsigned_integer]
-deletehost [-brief] -machinename string -machinetype api | app_cluster | cluster | master | media | ndmp | master | media | ndmp-mediaid string
-errorsdb [-brief] [-prune [-days no_of_days] [-hours no_of_hours] [-minutes no_of_minutes]]
-getemmserver [-masterserver string] [-timeout unsigned_integer]
-listhosts [-brief] [-verbose] [-parsable] [-list_snap_vault_filers -machinename string] [-list_snap_vault_media_servers -masterserver string] [-list_sts_hosts -machinename string] [-list_sts_media_servers -masterserver string] [-list_app_clusters -masterserver string] [-servers_in_emm_cluster -clustername string] [-servers_in_app_cluster -clustername string] [-nbservers [-masterserver string]] [-display_server -machinename string -machinetype string] [-netbackupversion level[.major_level[minor_level]]]
-listmedia [-allrecords] [-mediaid string] [-mediatype unsigned_integer] [-poolname string] [-robotnumber unsigned integer] [-vaultcontainer string]
-listsettings -machinename string [-brief] [-emmname string] [-emmport unsigned_integer]
-machinealias [-addalias -alias string -machinename string] [-deletealias -alias string] [-deleteallaliases -machinename string] [-getaliases -machinename string] -machinetype api | app_cluster | cluster | master | media | ndmp
-releasecache -machinename string [-brief] [-emmname string] [-emmport unsigned_integer]
-renamehost [-brief] -machinename string -machinetype api | app_cluster | cluster | master | media | ndmp -newmachinename string
-resethost -machinename string
-servercontrol [-brief] [-resume] [-suspend]
-setemmserver [-brief] -emmservername string [-masterserver string] -newemmservername string [-timeout unsigned_integer]
-updatehost [-activenodename string] [-add_server_to_app_cluster] [-brief] [-clustername string] [-delete_server_from_app_cluster] [-displayname string] [-machinedescription string] -machinename string [-machinestateop clr_admin_pause | clr_admin_pause_and_set_active | clr_disk_active | clr_ltid_restart | clr_master_server_connectivity | clr_tape_active | reset_all | set_admin_pause | set_disk_active | set_master_server_connectivity | set_tape_active] [-machinetype pi | app_cluster | cluster | master | media | ndmp] [-masterserver string] [-netbackupversion level[.major_level[minor_level]]] [-operatingsystem hpux | linux | rs6000 | solaris | windows]
On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/admincmd/
On Windows systems, the directory path to this command is install_path\NetBackup\bin\admincmd\
DESCRIPTION
The nbemmcmd command enables users to update a limited set of EMM database information. In addition, this command enables you to manage host entries, configuration options, and other miscellaneous items in the EMM database.
OPTIONS
The following commands contain a variety of options that enable you to manage the EMM database. The names of the options are purposely long to provide the user with a better understanding of how the options are to be used. Because of the option name length, you need only type the first letter or letters of the command that make it a unique option. For example, to use the -changesetting option, type -c because no other command option starts with the letter c.
- -addhost
This option adds the specified host to the EMM database. The following entries can be adjusted by using this command option:
- -activenodename string
Identifies the active node in a cluster.
- -brief
Makes the output of the command less verbose.
- -clustername string
Identifies the cluster to which this computer belongs.
- -displayname string
Sets the display name of the computer.
- -machinedescription string
Describes the computer or system being used.
- -machinename string
Specifies the name of the computer to be updated.
- -machinetype api | app_cluster | cluster | master | media | ndmp
Defines how the computer is used.
- -masterserver string
Defines the host master server in a particular domain.
- -netbackupversion level[.major_level[minor_level]]
Specifies the version that the added host is running. The level variable has a range of 0-99. The major_level and minor_level variables are optional single-digit fields. No spaces are allowed between the major_level and minor_level variables.
For example, enter the following information to specify NetBackup 7.0:
-netbackupversion 7.0 or -netbackupversion 7
- -operatingsystem hpux | linux | rs6000 | solaris | windows
Adds a host with a designated operating system.
- -scanability unsigned_integer
This option applies only to NetBackup Enterprise Servers that use the Shared Storage Option (SSO) feature.
A scan ability factor can range from zero to 9, with a default value of 5. This factor allows the assignment of scan hosts to be prioritized if a drive's scan host changes. Scan hosts with higher scan ability factors are chosen first.
Caution:
A drive is unavailable for use until a scan host can be assigned to it. If all hosts that register for a particular drive use scan_factor = 0, the drive is unusable. The drive remains unusable until a host with a non-zero scan_factor registers for the drive. If all hosts with a non-zero scan_factor have the drive DOWN, then again the drive becomes unavailable.
The decision to use a scan_factor of zero for a server reduces the level of resiliency in your SSO configuration. Be aware of the servers that can be a scan host for a drive. If a drive loses a scan host, it makes the drive unavailable to any server.
- -changesetting -machinename string
Changes the configuration setting for a specified host and adds the settings that did not previously exist.
To change these configuration options, use -changesetting with the option name and the enable designator (1 or yes) or the disable designator (0 or no). For example, the following command disables the ability of EMM to add a host name automatically:
# nbemmcmd -changesetting -DISABLE_AUTOMATIC_HOST_NAME_ADD no
- -ALLOW_MULTIPLE_RETENTIONS_PER_MEDIA 0 | 1 | no | yes
Allows NetBackup to mix retention levels on media. The default condition is that each volume can contain backups of only a single retention level.
- -AUDIT [DISABLED | ENABLED]
Enables and disables NetBackup auditing. An audit trail is a record of user-initiated actions in a NetBackup environment. Auditing gathers and records the information to help answer who changed what and when they changed it. The default condition is audit enabled.
- -AUDIT_RETENTION_PERIOD number_of_days
Specifies the number of days that user actions are to be retained for the audit report. If no retention period is indicated, the default audit retention period is 90 days. A value of 0 (zero) indicates that the records are never purged.
- -COMMON_SERVER_FOR_DUP default | preferred | required
Determines how NetBackup finds the desired media server(s) to duplicate the data.
The media server that is used to read the image is the 'read media server'. The media server that is used to write the image is the 'write media server'. By default, when the source image is on a tape device, the read media server is the one that writes the backup image. Also, when the source image is on a disk pool with multiple media servers, any of those media servers can be the read media server. The choice for the write media server is limited to those that have access to the storage unit or storage unit group specified as the destination of the duplication operation.
The following are the possible settings of this option:
Default. NetBackup does not perform an exhaustive search for possible common servers (same read and write media server). If the common media servers are busy or unavailable, NetBackup uses a different write media server than the read media server. Use this option when you don't want an exhaustive search to affect the performance of the Resource Broker. This scenario can occur when a large job queue with duplication jobs waits for resources to become available.
Preferred. Look for a common media server to use. If one or more common media servers are found, but their resources (for example, DSUs or tape drives) are busy, do the following: Run the duplication job anyway by using two separate media servers (sending images over the network).
Required. NetBackup makes an exhaustive search to find a common server. If the common media servers are busy, NetBackup queues the resource request and waits for the resources to become available. NetBackup runs the job with two separate media servers, sending the images over the network, if the following is true: No common servers are in the NetBackup domain, or if a common server exists but is down.
- -DISABLE_AUTOMATIC_HOST_NAME_ADD 0|1|no|yes
Disables the ability of EMM to add a host name automatically if it appears to be valid. An example of an invalid host name is a name that duplicates another host.
- -DISABLE_BACKUPS_SPANNING_DISK 0|1|no|yes
Disables the ability of a backup operation to disk to continue when a file system full condition occurs on a disk storage unit volume. It disables by using image fragments on multiple storage unit volumes.
- -DISABLE_DISK_STU_JOB_THROTTLING 0|1|no|yes
Disables the disk storage unit job throttle action that occurs when disk storage units approach their high-water mark. Disk storage unit throttling limits the number of jobs that are started simultaneously to approach the high-water mark more accurately. Default: Throttle disk storage units that approach their high-water mark.
- -DISABLE_STANDALONE_DRIVE_EXTENSIONS 0|1|no|yes
Disables the non-robotic drive operations. During a backup, NetBackup does not automatically try to use whatever labeled or unlabeled media it finds in a non-robotic drive. Default condition is that standalone drive extensions are enabled.
- -DISALLOW_NONNDMP_ON_NDMP_DRIVE 0|1|no|yes
The MDS logic on the EMM server reads this option. NetBackup tries to use an available drive that is based on the type of request as follows:
For a non-NDMP request of any kind, NetBackup tries to find an available non-NDMP drive. If a non-NDMP drive is not available and an NDMP drive is available, the slower NDMP drive is used. Non-NDMP requests include all type of requests apart from storage unit-related requests (backups and write side of duplicates) and NDMP image restores.
- -DO_NOT_EJECT_STANDALONE 0|1|no|yes
If this entry is enabled, tapes in standalone drives are not ejected when a backup has completed on that host. (Tapes are ejected if end-of-media is reached during a backup.) Use when you want to keep a standalone drive ready after successful backups are performed.
- -DONT_USE_SLAVE 0|1|no|yes
Deselects the use of drive name rules to assign names to drives automatically.
- -DRIVE_ERROR_THRESHOLD unsigned_integer
Changes the threshold or number of drive errors that can occur before NetBackup changes the drive state to DOWN. Default: 2.
- -DRIVE_NAME_SEED 0|1|no|yes
Selects the use of drive name rules to assign names to drives automatically.
- -emmname string
Specifies the name of the EMM database server. This server contains the database that stores the media information and device configuration information.
- -emmport unsigned_integer
Specifies the EMM port.
- -machinename string
Names the computer whose settings are changed.
- -MAX_REALLOC_TRIES unsigned_integer
Specifies the maximum number of tries that NetBackup attempts to reallocate the media for future backups.
- -MEDIA_ERROR_THRESHOLD unsigned_integer
Changes the threshold or number of media errors that can occur before the media is frozen. Default: 2.
- -MEDIA_REQUEST_DELAY unsigned_integer
Specifies the number of seconds that NetBackup waits for a drive to become ready. Applies only to non-robotic drives. Default: 0 seconds. For example, assume that the delay is 150 seconds:
MEDIA_REQUEST_DELAY = 150
Add this information to the
bp.conffile on NetBackup servers or enter a value for Media Request Delay in the Media host properties.- -MPMS_DISABLE_EVENTS 0|1|no|yes, -MPMS_DISABLE_RANK 0|1|no|yes, -MUST_USE_LOCAL_DRIVE 0|1|no|yes
If the client is also a master server and this option is active, backups for this client must occur on a local drive. If the client is not a master server, this entry has no effect.
Add this option to the
bp.conffile on master servers. Or check the Must Use Local Drive setting in the General Server host properties dialog box.- -NBUFS_DESTINATION_DSU string, -NBUFS_DUP_TSU_TO_DSU 0|1|no|yes, -NBUFS_RETENTION_LEVEL unsigned_integer, -NON_ROBOTIC_MEDIA_ID_PREFIX string
Specifies the media ID prefix that is used for creating non-robotic media. It applies to the host that the -machinename option specifies. The media ID prefix is an alphanumeric string of characters from one to three characters in length.
- -PREFER_NDMP_PATH_FOR_RESTORE 0|1|no|yes, -RETURN_UNASSIGNED_MEDIA_TO_SCRATCH_POOL 0|1|no|yes
This EMM global option applies to every host that uses the EMM server. It is not a host option.
YES: The Media Manager automatically returns the expired and unassigned media that originated in the scratch volume pool to the scratch volume pool.
NO: Disables the automatic behavior of returning media to the scratch pool. Use one of the Media Manager administration interfaces to move media.
- -SCSI_PROTECTION NONE | SPR | SR
Allows the exclusive access protection for tape drives. With access protection, other host bus adaptors cannot issue commands to control the drives during the reservation. The three possible settings for this option are:
NONE - No protection
SPR - SCSI persistent reserve
SR - SPC-2 SCSI reserve (default condition)
- -TIME_WINDOW unsigned_integer
Enables you to set a value that is equal to the amount of time in which errors can be tracked. You can use this value with an error threshold (for example, media_error_threshold) to monitor the number of media errors that occur within the time window. The default setting is 12 hours.
- -UNRESTRICTED_SHARING 0|1|no|yes
Enables the unrestricted media sharing for all media servers.
- USE_POTENTIAL_FREESPACE_FOR_ALLOCATION 0|1|no|yes
Allows the memory allocation of the available free space. The High Water Mark normally triggers image cleanup on BasicDisk storage units and disk pools. When the High water mark is reached in a storage lifecycle policy, it can prevent the use of any more memory space.
For example, the High water mark is 90%, but the potential free space is 50%. When the free space that is left on disk is only available past the High water mark, the backup fails. Turn on this parameter (1) to allow the use of the 40% free space between the potential free space and the High water mark.
The default setting is no (0).
- -VALIDATE_HOST_NAME 0|1|no|yes
Enables the host name character validation according to NetBackup standard. If this option is disabled, you can use a name like "_host1", which does not follow the standard.
- -VAULT_CLEAR_MEDIA_DESC 0|1|no|yes
This option is an EMM global option that applies to every host that uses the EMM server. It is not a host option. When NetBackup media is returned from the off-site vault during a typical tape rotation, it is expired and is ready for reuse by new backups. To avoid confusion, it may be helpful to clear the old media description information when an expired tape is returned to the robot. If this entry is specified, the media description field is cleared when other Vault information is cleared from the Media Manager volume database.
- -deletealldevices
Deletes all tape devices.
- -allrecords
Deletes all tape devices across all computers. You cannot use this option with the -machinename option.
- -emmname string
Name of the EMM server.
- -emmport unsigned_integer
Port number for the EMM server
- -machinename string
Deletes all tape devices that are attached to the specified media server. You cannot use this option with the -allrecords option.
- -machinetype api | app_cluster | appliance | client | cluster | disk_array | foreign_media | master | media | nbwss_endpoint | ndmp | remote_master | replication_host | virtual_machine
Specifies the type of the computer name. You cannot use this option with the -allrecords option.
- -deletehost
Deletes an EMM computer record by using the required computer name and computer type.
- -brief
Generates a less verbose output of the command.
- -machinename string
Removes the specified host from the EMM database.
- -Machinetype api | app_cluster | cluster | master | media | ndmp
Identifies by type the computer to be removed.
- -errorsdb
- -brief
Generates a less verbose output of the command.
- -prune [-days no_of_days] [-hours no_of_hours] [-minutes no_of_minutes]
Removes the entries from the error database. The optional days, hours, and minutes arguments determine which database entries to delete. It removes any entries older than the specified time.
- -getemmserver
Displays the information on all the hosts in a particular EMM domain. Use this command to ensure a level of consistency in a newly installed domain or modified domain.
- -brief
Generates a less verbose output of the command.
- -masterserver string
Specifies a name of a master server for an EMM domain. If you omit this option when you use this command, the current computer is assumed.
- -timeout unsigned integer
Specifies a temporary timeout value in seconds to be used during the duration of this command.
- -help
Displays usage information for the specified command by entering the following:
nbemmcmd -help command
- -listhosts
This option dumps the table structure for each known host.
- -display_server -machinename string -machinetype string
Displays only the specified computer by the computer name and computer type.
- -list_app_clusters -masterserver string
Lists all of the application clusters of the specified master server.
- -list_snap_vault_filers -machinename string
Lists all of the SnapVault filers of the specified computer name See the -machinename option description that follows.
- -list_snap_vault_media_servers -masterserver string
Lists all of the SnapVault media servers of the specified master server.
- -list_sts_hosts -machinename string
Lists all OpenStorage hosts connected to the specified computer name.
- -list_sts_media_servers -masterserver string
Lists all OpenStorage media servers that are connected to the specified master server.
- -machinename api | app_cluster | cluster | master | media | ndmp
Defines the type of computer to list.
- -nbservers -masterserver string
Displays only the media servers and master servers. The default for -listhosts is to display all servers.
- -netbackupversion level[.major_level[minor_level]]
Specifies the computer version. The level variable has a range of 0-99. The major_level and minor_level variables are optional single-digit fields. There should be no spaces between major_level and minor_level.
For example, enter the following information to specify NetBackup 7.0:
-netbackupversion 7.0 or -netbackupversion 7
- -servers_in_emm_cluster -clustername string
Lists all servers in the specified cluster.
- -server_in_app_cluster -clustername string
Lists all of the application cluster servers of the specified cluster.
- -brief
Makes the output of the command less verbose.
- -parsable
Makes the output of the command parsable.
- -verbose
Controls how host information is displayed. Multiple lines of output are printed, one for each parameter of a host.
- -listmedia
- -allrecords
Displays all media records.
- -mediaid string
Specifies the media ID of the EMM media record.
- -mediatype unsigned integer
Queries the volumes by media type.
Valid media types for NetBackup Enterprise Server are:
4mm, 8mm, 8mm2, 8mm3, dlt, dlt2, dlt3, dtf, hcart, hcart2, hcart3, qcart, 4mm_clean, 8mm_clean, 8mm2_clean, 8mm3_clean, dlt_clean, dlt2_clean, dlt3_clean, dtf_clean, hcart_clean, hcart2_clean, hcart3_clean.
Valid media types for a NetBackup server are:
4mm, 8mm, dlt, hcart, qcart, 4mm_clean, 8mm_clean, dlt_clean, hcart_clean.
- -poolname string
Queries the volumes by pool number, an index into the volume pool. Use vmpool -listall to determine the index for a given pool name.
- -robotnumber unsigned_integer
Queries the volumes by robot number. A robot number is a unique, logical identification number for the robot where the volume is located.
- -vaultcontainer string
Lists the volumes that are stored in the container. The string variable is the vault_container_id, a string of up to 29 alphanumeric characters.
- -listsettings
- -machinename string
Specifies which computer to list settings for.
- -brief
Generates a less verbose output of the command.
- -emmname string
Specifies the host name of the pertinent EMM server. If -emmname is not specified, the default name is located in the
bp.conffile.- -emmport unsigned_integer
Specifies the port number of the EMM server to where calls are made. If -emmport is not specified, the default port is specified in the
bp.conffile.
- -machinealias
The following parameters are used to maintain the alias list for a particular computer. Use them to view current aliases, add new aliases, or delete current aliases for an identified computer.
- -addalias -alias alias -machinename name -machinetype type
Adds an alias name to a computer. Identify the computer name that is to receive the alias as well as the computer type.
For example, to create a media server with the alias name blue, use the following command:
machinealias -machinename 10.10.10.1 -machinetype media -addalias -alias blue
- -deletealias -alias name -machinetype type
Deletes an alias name from the database. This operation requires that you identify the alias to be deleted by using the -alias string command and computer type with this option.
- -deleteallaliases -alias name -machinetype type
Deletes all aliases for a particular computer. To perform this operation you must identify the computer name and the computer type.
- -getaliases
Retrieves all aliases for a particular computer. To perform this operation you must identify the computer name and the computer type.
- -alias string
Specifies the string that identifies the alias name of a computer.
- -machinename string
Specifies the name of a computer.
- -Machinetype api | app_cluster | cluster | master | media | ndmp
Defines what the computer is used as.
- -releasecache
Release cache memory that the EMM server has used.
- -brief
Generates a less verbose output of the command.
- -emmname string
Specifies the host name of the pertinent EMM server. If -emmname is not specified, the default name is located in the
bp.conffile.- -emmport unsigned_integer
Specifies the port number of the EMM server to where calls are made. If -emmport is not specified, the default port is specified in the
bp.conffile.
- -renamehost
This command, with the required computer name and new computer name options, renames the current computer name to a new computer name.
- -machinename string
Defines the current computer name.
- -newmachinename string
Defines the new computer name.
- -resethost
Use this command to reset the Host Properties for an updated host. The Host Properties section displays the additional information that the host web service collects.
Run this command if you have downgraded the NetBackup version on a computer or removed a host from your NetBackup environment. You only need to run this command if you downgrade to NetBackup 8.0 or earlier. You may need to restart the NetBackup Administration Console for the changes to take effect.
Before you run the nbemmcmd - resethost command, you must run the bpnbat -login -loginType WEB command. This command authenticates your web services login. After you successfully run the bpnbat command, run the nbemmcmd - resethost command.
- -machinename string
Defines the name of the computer that was downgraded or removed from the NetBackup environment.
- -servercontrol
This command suspends and resumes control of a specified server. You can perform database maintenance without the corruption of existing data because a job began to run during this time.
- -resume
Resumes the control of a specified server.
- -suspend
Suspends the control of a specified server.
- -setemmserver
This command changes the EMM server name for certain hosts in the domain whose name matches the old EMM server name. This command has the following options:
- -emmservername string
Specifies the EMM server name to be changed.
- -newemmservername string
Specifies the new, or replacement, value for the EMM server.
- -masterserver string
Specifies a name of a master server for an EMM domain. If you omit this option when you use this command, the current computer is assumed.
- -timeout unsigned integer
Specifies a temporary timeout value in seconds to use for the duration of this command.
- -updatehost -machinename string
This command, when used with the following options, enables you to change a computer record that was specified by using the required -machinename option.
- -add_server_to_app_cluster
This option designates that the computer should be added to the application cluster that is specified in the -clustername option.
- -activenodename string
Identifies the active node in a cluster.
- -clustername string
Identifies a cluster to which this computer belongs.
- -delete_server_from_app_cluster
Designates that the computer should be removed from the application cluster that is specified in the -clustername option.
- -displayname string
Displays the assigned name of a computer that is equivalent to the numbered identifier for that computer.
- -machinename string
Specifies the computer name to update.
- -machinestateop clr_admin_pause | clr_admin_pause_and_set_active | clr_disk_active | clr_ltid_restart | clr_master_server_connectivity | clr_tape_active | reset_all | set_admin_pause | set_disk_active | set_master_server_connectivity | set_tape_active
Sets or clears the specified computer state.
- -Machinetype api | app_cluster |cluster | master | media | ndmp
Defines what the computer is used as.
- -masterserver string
Defines the host's master server in the domain.
- -netbackupversion level[.major_level[minor_level]]
Adds a host and specifies the version it is running. The level variable as a range of 0-99. The major_level and minor_level variables are optional single-digit fields. There should be no spaces between the major_level and minor_level variables.
For example, enter the following to specify NetBackup 7.0: -netbackupversion 7.0
- -operatingsystem hpux | linux | rs6000 | solaris | windows
This option enables you to update the operating system of the computer.
EXAMPLES
Example 1 - Display the information on all the hosts in a particular EMM domain.
# nbemmcmd -getemmserver These hosts were found in this domain: throttle, upwords Checking with host: throttle... Checking with host: upwords... Server Type Host Version Host Name EMM Server MEDIA UNKNOWN RELEASE (0) throttle throttle MASTER 7.6 upwords upwords One or more hosts had mismatched EMM Servers. Run-time failure: The consistency check either failed or was incomplete. Command did not complete successfully.
Example 2 - Change the EMM server name for certain hosts in the domain whose name matches the old EMM server name.
# nbemmcmd -setemmserver -emmservername throttle -newemm upwords These hosts were found in this domain: throttle, upwords Checking with host: throttle... Checking with host: upwords... Server Type Host Version Host Name EMM Server MEDIA UNKNOWN RELEASE (0) throttle throttle EMM server name was changed. MASTER 7.6 upwords upwords One media hosts had EMM Server name changed. Command was completed successfully.
Example 3 - List the settings for computer name orbitvm1.
# nbemmcmd -listsettings -machinename orbitvm1 NBEMMCMD, Version:7.1 The following configuration settings were found: ALLOW_MULTIPLE_RETENTIONS_PER_MEDIA="no" DISABLE_DISK_STU_JOB_THROTTLING="no" DISABLE_STANDALONE_DRIVE_EXTENSIONS="no" MEDIA_REQUEST_DELAY="0" MUST_USE_LOCAL_DRIVE="no" NON_ROBOTIC_MEDIA_ID_PREFIX="A" MAX_REALLOC_TRIES="1000" DISABLE_BACKUPS_SPANNING_DISK="no" DISALLOW_NONNDMP_ON_NDMP_DRIVE="no" DO_NOT_EJECT_STANDALONE="no" PREFER_NDMP_PATH_FOR_RESTORE="yes" DONT_USE_SLAVE="no" DRIVE_ERROR_THRESHOLD="2" MEDIA_ERROR_THRESHOLD="2" TIME_WINDOW="12" SCSI_PROTECTION="SR" NBUFS_DUP_TSU_TO_DSU="no" NBUFS_DESTINATION_DSU="NONE" NBUFS_RETENTION_LEVEL="0" MPMS_DISABLE_RANK="0" MPMS_DISABLE_EVENTS="no" UNRESTRICTED_SHARING="no" FATPIPE_USAGE_PREFERENCE="Preferred" FATPIPE_WAIT_PERIOD="15" FATPIPE_RESTORE_WAIT_PERIOD="5" FT_MAX_CLIENT_PORTS_PER_SERVER="2" FT_MAX_CLIENTS_PER_PORT="2" SHAREDDISK_MOUNT_POINT="/nbushareddisk" AUDIT="ENABLED" AUDIT_RETENTION_PERIOD="90" RETURN_UNASSIGNED_MEDIA_TO_SCRATCH_POOL="yes" VAULT_CLEAR_MEDIA_DESC="no" SCSI_PERSISTENT_RESERVE="0" Command completed successfully.