Using the Command Line Interface › ca_vcbpopulatedb - VMware VCB Utility Command › ca_vcbpopulatedb - Usage

ca_vcbpopulatedb - Usage

The ca_vcbpopulatedb command contains arguments and options that are used to define actions to follow when populating VM information into the CA ARCserve Backup database.

The ca_vcbpopulatedb command includes the following arguments and options:

• -Primary <PrimaryServerName>

  Specifies the host name of the Primary CA ARCserve Backup system.

• -carootUser <ARCserve caroot User>

  Specifies the user name, with caroot privileges, for the Primary CA ARCserve Backup system.

• -carootPass <ARCserve caroot password>

  Specifies the password for the root user name.

• -vcb <VCBMachineName>

  Specifies the name of the VCB Proxy machine.

  Note: This is an optional argument. If you omit this argument, the utility assumes that the current machine name will be used as VCB machine name.

• -esxserver <ESXServerName>

  Indicates the name of the VMware ESX Host system or the VMware vCenter Server system containing the VMs residing on the iSCSI/SAN LUN.

• -esxUser <ESXAdmin>

  Specifies the name of the VMware ESX Host system user with Administrator privileges.

• -esxUserPass <ESXAdminPassword>

  Specifies the password for the VMware ESX Host system Admin User.

• -proto <https/http>

  Indicates the communication protocol between the backup proxy system and the VMware ESX Host system or the VMware vCenter Server system.

  Note: This is an optional argument. If you omit this argument, the utility assumes https is to be used as the communication protocol.

• -VCBMountableVM

  If this switch is specified as a parameter, the utility will populate the database with the running VMs that are residing only on the iSCSI/SAN LUN storage device. With this switch specified, the utility would skip VMs in the VMware ESX Host system residing on any storage media other than the iSCSI/SAN LUN.

  You should run the ca_vcbpopulatedb command line utility with this switch, when you have VMs in VMware ESX Host systems residing on multiple storage media, such as the local disk of ESX Host systems, SAN LUN, NAS/NFS, or iSCSI storage device.

  With this switch included, the utility would only populate the CA ARCserve Backup primary server database with information from the running VMs residing on the iSCSI/SAN LUN storage device.

  Notes:

  If you run the ca_vcbpopulatedb command line utility with this switch, you must run the utility on VCB proxy system.

  If you run this utility with the VCBMountableVM switch, the utility would take longer to run, because it performs a mount and unmount operation of each running VM that is residing on the SAN LUN storage device.

• -DelProxydb

  Deletes all the VMs available in the database for the given VMware ESX Host system or the VMware vCenter Server system under the given backup proxy system.

• -retainVMinDB

  Lets you retain data (backup information) for VMs that are not available when you execute this command.

  By default, this utility captures information from VMs that are available when you execute this utility. If a VM is not available (for example, the VM is powered off or deleted from the environment), CA ARCserve Backup deletes the data relating to the VM from the CA ARCserve Backup database. With this option enabled, CA ARCserve Backup captures information from VMs that are available, and retains the backup information from VMs that are not available.

• -silent

  Specifies to prevent the utility from printing messages to the command line console.

• -debug

  Specifies to direct the utility to write a detailed debug log. The log will be created in the current working directory.

  Note: The name of the log file is ca_vcbpopulatedb.log.

• -insertVM

  Lets you add information about a specific VM that resides in the VM host system to the CA ARCserve Backup database.

  Note: You cannot combine this argument with any other argument when you execute ca_vcbpopulateDB.

• -deleteVM

  Lets you delete information about a specific VM from the CA ARCserve Backup database.

  Note: You cannot combine this argument with any other argument when you execute ca_vcbpopulateDB.

• -stopAutoPopulate

  Lets you disable the auto-populate process for the specified backup proxy system.

• –config <config_file_name>

  Specifies the name of the ca_vcbpopulatedb configuration file.

  The ca_vcbpopulatedb utilty uses the information specified in the configuration file to populate the CA ARCserve Backup database.

  This configuration file contains details about Primary Server Machine, Primary User, Primary User's Password, VCB Systems Name, VMware ESX Host Name, and VMware ESX Host system User credentials.

  You can have only one entry in the configuration file.

  Note: You must create a configuration file to use this utility.