Command Line Interface - Configuration - Notes Document iDataAgent

Available Commands

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

Note

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

qdelete
client
dataagent

Qdelete client

Description

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

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

Note

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 or deletes the specified agent.

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

Upon completion, qdelete dataagent displays a message that the agent was successfully deleted 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 agent [-deconfigure] [-y] [-tf tokenfile] [-tk token] [-h]
Options

-c

Client computer name

-a

The agent to be deleted (see Argument Values - Agent Types)

-d

Deconfigures the agent 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 agent named MyDataAgent under client client1.

    qdelete dataagent -c client1 -a MyDataAgent
    This command deconfigures and deletes an agent, do you want to configure (y/n)
  • Deconfigure an agent named MyDataAgent under client client1 without any confirmation.

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

Loading...