DbTool Agent Commands

The agent commands start, stop, and update the remote collection agents. The agent ad commands act on the Active Directory agents on domain controllers; the agent file-system commands act on the File System agents on monitored file servers.

For how to run DbTool, the common options, and the permissions it requires, see DbTool Command-Line Utility.

agent ad start

Starts the Active Directory agent service on every matching domain controller. If you do not specify a domain or server, every registered agent is started.

Requirements: You must be a Cygna Auditor Global Administrator; Cygna Auditor must be licensed for Active Directory.

Syntax

DbTool agent ad start [options]

Options

Option Description
-d, --domain <DOMAIN> Act only on the agents in this domain. Default: every domain that has a registered agent.
-s, --server <DOMAIN_CONTROLLER> Act only on the agent installed on this domain controller. Default: every domain controller that has a registered agent.
-u, --user <ACCOUNT> Account used to connect to the remote domain controllers. Default: the account running DbTool.
-p, --password <PASSWORD> Password for --user. Enter ? to be prompted for the password instead of typing it on the command line.

Example

DbTool agent ad start --domain contoso.com

agent ad stop

Stops the Active Directory agent service on every matching domain controller. Collection from those domain controllers pauses until the agents are started again.

Requirements: You must be a Cygna Auditor Global Administrator; Cygna Auditor must be licensed for Active Directory.

Syntax

DbTool agent ad stop [options]

Options

Option Description
-d, --domain <DOMAIN> Act only on the agents in this domain. Default: every domain that has a registered agent.
-s, --server <DOMAIN_CONTROLLER> Act only on the agent installed on this domain controller. Default: every domain controller that has a registered agent.
-u, --user <ACCOUNT> Account used to connect to the remote domain controllers. Default: the account running DbTool.
-p, --password <PASSWORD> Password for --user. Enter ? to be prompted for the password instead of typing it on the command line.

Example

DbTool agent ad stop --server dc01.contoso.com

agent ad update

Copies the agent installation files from this server to every matching domain controller and restarts the agent there. Run this command after you upgrade Cygna Auditor.

Requirements: You must be a Cygna Auditor Global Administrator; Cygna Auditor must be licensed for Active Directory.

Syntax

DbTool agent ad update [options]

Options

Option Description
-d, --domain <DOMAIN> Act only on the agents in this domain. Default: every domain that has a registered agent.
-s, --server <DOMAIN_CONTROLLER> Act only on the agent installed on this domain controller. Default: every domain controller that has a registered agent.
-u, --user <ACCOUNT> Account used to connect to the remote domain controllers. Default: the account running DbTool.
-p, --password <PASSWORD> Password for --user. Enter ? to be prompted for the password instead of typing it on the command line.
-m, --maxparallel <COUNT> Number of domain controllers to update at the same time. Each domain controller restarts its agent, so keep this value low in a small domain. Default: 1.
-a, --auditor <FQDN> Fully qualified domain name of the Cygna Auditor server that the updated agents report to. Default: the fully qualified domain name of this computer.

Example

DbTool agent ad update --domain contoso.com --maxparallel 4

agent file-system start

Starts the File System agent service on every matching file server. If you do not specify a server, every registered agent is started.

Requirements: You must be a Cygna Auditor Global Administrator; Cygna Auditor must be licensed for File System.

Syntax

DbTool agent file-system start --user <ACCOUNT> --password <PASSWORD> [options]

Options

Option Description
-s, --server <FILE_SERVER> Act only on the agent installed on this file server. Default: every file server that has a registered agent.
-u, --user <ACCOUNT> Required. Account used to connect to the remote file servers, in DOMAIN\user format.
-p, --password <PASSWORD> Required. Password for --user. Enter ? to be prompted for the password instead of typing it on the command line.

Example

DbTool agent file-system start --user CONTOSO\svc_auditor --password ?

agent file-system stop

Stops the File System agent service on every matching file server. Collection from those file servers pauses until the agents are started again.

Requirements: You must be a Cygna Auditor Global Administrator; Cygna Auditor must be licensed for File System.

Syntax

DbTool agent file-system stop --user <ACCOUNT> --password <PASSWORD> [options]

Options

Option Description
-s, --server <FILE_SERVER> Act only on the agent installed on this file server. Default: every file server that has a registered agent.
-u, --user <ACCOUNT> Required. Account used to connect to the remote file servers, in DOMAIN\user format.
-p, --password <PASSWORD> Required. Password for --user. Enter ? to be prompted for the password instead of typing it on the command line.

Example

DbTool agent file-system stop --server fs01 --user CONTOSO\svc_auditor --password ?