Command Line Interface - Configuration - DB2 MultiNode iDataAgent

Configuration Backup Restore
Table of Contents

Available Commands

The following section provides a list of commands that can be used by the DB2 MultiNode iDataAgent.

Before executing a command, make sure to log on to the CommServe using the qlogin command. Similarly, use the qlogout command to log off from the CommServe.

qinfo

backupset

subclient

qlist

backupset

subclient

qmodify

subclient

qdelete

client

dataagent

 

Qinfo Backupset

Description

This command displays information about a given backup set. If the agent supports instances above backup sets, only the backup sets under the specified instance are listed.

In case of an error, an error code and description are displayed as: "backupset: Error errorcode: errordescription"

Usage

qinfo backupset -c client -a dataagenttype -i instance -b backupset [-desc] [-tf tokenfile] [-tk token] [-h]

Options

-c Client computer name
-a Agent type installed on client computer (see Argument Values - Agent Types)
-i Instance name, required for a few agents
-b Backup set name
-desc Displays description provided by the user

To display the entire user description for the backup set without any other information, be sure to include the -desc option when you run the command. Otherwise, all the requested information along with only a partial description will be displayed.

-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Display information about a backup set defaultBackupSet in client client1 and Agent Q_DB2_DPF.

qinfo backupset -c client1 -a Q_DB2_DPF -b defaultBackupSet

Sample Output:

Name         : defaultBackupSet
Default      : Yes
OnDemand     : No
Description  : Backup Set description

Qinfo Subclient

Description

This command displays information about a subclient under a specified client, agent, and instance/backup set. The backup set name and instance name should be specified based on the agent, as certain agents place subclients under backup sets, and others place them under the instance.

In case of an error, an error code and description are displayed as: "subclient: Error errorcode: errordescription"

Usage

qinfo subclient -c client -a dataagenttype -i instance -b backupset -s subclient [-desc] [-tf tokenfile] [-tk token] [-h]

Options

-c Client computer name
-a Agent type installed on client computer (see Argument Values - Agent Types)
-i Instance name, required for a few agents
-b Backup set name, required for a few agents
-s Subclient name
-desc Displays description provided by the user

To display the entire user description for the backup set without any other information, be sure to include the -desc option when you run the command. Otherwise, all the requested information along with only a partial description will be displayed.

-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Display information about a subclient sc1 in the client client1, Agent Q_DB2_DPF and backup set bs1.

qinfo subclient -c client1 -a Q_DB2_DPF -b bs1 -s sc1

Sample Output:

Name             : sc1
Default          : Yes
Storage Policy   : No
Description      : Subclient description

Qlist Backupset

Description

This command lists the names of all the backup sets in the specified client and agent. If the agent supports instances above the backup set level, then only the backup sets under the specified instance are listed. Whenever more than one backup set is found, each backup set is listed in its own line on the command prompt. No message is displayed whenever backup sets are not found.

In case of an error, an error code and description are displayed as: "backupset: Error errorcode: errordescription"

Usage

qlist backupset -c client -a dataagenttype -i instance [-tf tokenfile][-tk token] [-h]

Options

-c Client computer name
-a Agent type installed on client computer (see Argument Values - Agent Types)
-i Instance name, required for certain agents
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

List all the Backup sets in the client client1, agent MyDataAgent.

qlist backupset -c client1 -a MyDataAgent

The output for the qlist backupset command is:

defaultBackupSet
bs1

Qlist Subclient

Description

This command lists the names of all the subclients in a specified client, agent, and instance/backup set. Whenever more than one subclient is found, each subclient is listed in its own line on the command prompt. No message is displayed whenever subclients are not found.

In case of an error, an error code and description are displayed as: "subclient: Error errorcode: errordescription"

Usage

qlist subclient -c client -a dataagenttype -i instance -b backupset [-tf tokenfile] [-tk token] [-h]

Options

-c Client computer name
-a Agent type installed on client computer (see Argument Values - Agent Types)
-i Instance name, required for certain agents
-b Backup set name, required for certain agents
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

List all the Subclients in the client client1, Agent Q_DB2_DPF and backup set bs1.

qlist subclient -c client1 -a Q_DB2_DPF -b bs1 default sc1

The output for the qlist command is:

default
sc1

Qmodify Subclient

Description

This command modifies the storage policy, content, or user-defined description of a given subclient.

Upon successful completion, the qmodify subclient command displays the message "Modified subclient successfully" on the command prompt. In case of an error, an error code and description are displayed as: "subclient: Error errorcode: errordescription"

To use this command, you must ensure that the  QCMD_SUPPORT_MODIFY_SUBCLIENT additional setting is set to 1.

Usage

qmodify subclient -c client -a dataagenttype -i instance -b backupset -s subclient -sp storagepolicy -f content [-ow overwrite] [-drs datareaders] [-wc y|n] [-af ArgumentFilepath] [-tf tokenfile] [-tk token] [-h]

Options

-c Client computer name
-a Agent type installed on client computer (see Argument Values - Agent Types)
-i Instance name, required for a few agents
-b Backup set name, required for a few agents
-s Name of the subclient to be modified
-sp Name of the storage policy to be associated with the subclient
-f File/Directory Path to be added to the existing content

When using the -f content option, you must verify that the subclient content is in the correct format path. This command does not enforce the content format, and any path (including an incorrect path) can be specified. This may result in incorrect content being assigned to a file system subclient and a "pending" subclient scan.

-wc Do file/directory paths have wildcards (y|n)
-ow If the contents needs to be overwritten (0:1)
-drs Number of data readers
-af Input file containing arguments
-tf Reads token from a file
-tk Token string
-h Displays help

Argument File

client Client computer name
dataagent Agent type installed on source client computer (see Argument Values - Agent Types)
instance Instance name to which the subclient belongs, required for certain agents
backupset Backup set name to which the subclient belongs, required for certain agents
subclient Name of the subclient to be modified
sp New storage policy for the subclient
content List of files/directories to be added to the existing content

The content option is supported for file system Agents. Although, changing the storage policy association of a subclient is supported for all agents.

datareaders Number of data readers
wildcard Do file/directory paths have wildcards (y|n)
description User-defined description

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Modify a subclient with name sc1 under client client1 and Agent Q_DB2_DPF and backup set bs1 by changing its storage policy to sp2.

qmodify subclient -c client1 -a Q_DB2_DPF -b bs1 -s sc1 -sp sp2

Qdelete Client

Description

This command can be used to deconfigure and/or delete a client, along with its iDataAgents.

By default, the qdelete client command asks for confirmation before deleting the client. You can skip the confirmation prompt with the -y option.

Upon successful completion, qdelete client displays the message "Deleted the client successfully" on the command prompt. In case of an error, an error code and description are displayed as: "client: Error errorcode: errordescription

Usage

qdelete client [-cs <commserve_host_name>] -c <client> [-deconfigure] [-y] [-tf <tokenfile>] [-tk <token>] [-af <clientfile>] [-h]

Options

-cs CommServe host name
-c Client computer name
-deconfigure Deconfigures a client without deleting it
-y Delete without confirmation
-tf Reads token from a file
-tk Token string
-af Reads client name from a file
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Examples

  • Delete a client with name client1.

    qdelete client -c client1
    This command deconfigures and deletes a client, do you want to continue (y/n)? [n]

  • Deconfigure, but do not delete, a client with name client1

    qdelete client -c client1 -deconfigure -y

  • Delete a set of clients specified in an argument file.

    qdelete client -af "E:\clients.txt"

    In this example, clients.txt is a text file containing a list of client names. Ensure that the file is in the following format:

    [client]
    Client01
    Client02
    ClientXX

You can mass-delete clients with or without their associated MediaAgents using the qdelete client command. You can include this command (along with the qdelete mediaagent command, if desired) in a script. Mass deletion of these items is useful if you want to remove them after a split of a CommCell. To mass-delete items where the CommCell is not split, be sure to run the script from the install location of the CommServe.

Qdelete dataagent

Description

This command deconfigures and/or deletes a given iDataAgent.

By default, the qdelete dataagent command asks for confirmation before deletion. You can skip the confirmation prompt using the "-y" option.

Upon successful completion, qdelete dataagent displays the message "Deleted the iDataAgent successfully" on the command prompt. In case of an error, an error code and description are displayed as: "dataagent: Error errorcode: errordescription"

Usage

qdelete dataagent -c client -a iDataAgent [-deconfigure] [-y] [-tf tokenfile] [-tk token] [-h]

Options

-c Client computer name
-a iDataAgent to be deleted (see Argument Values - Agent Types)
-d Deconfigures the iDataAgent without deleting it
-y Delete without confirmation
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Examples

  • Delete an iDataAgent MyDataAgent under client client1.

    qdelete dataagent -c client1 -a MyDataAgent
    This command deconfigures and deletes an iDataAgent, do you want to configure (y/n)

  • Deconfigure an iDataAgent MyDataAgent under client client1 without any confirmation.

    qdelete client -c client1 -a MyDataAgent -deconfigure - y