User guide

If the parameter is used with the list tape_libraries (p. 59), list vms (p. 27) or list

vmservers (p. 27) command, the software will display objects whose names coincide with the

values you have specified.

If the parameter is used with the list exchange_mailboxes (p. 32), list mssql_instances (p.

37), or list mssql_databases (p. 37) command, the software will display objects whose names

contain the values you have specified.

Without this parameter, objects with any name will be displayed.

3.10.11 filter_state

--filter_state=<states>

States for selecting objects to be output. The parameter is used with the list activities (p. 63),

list tasks (p. 68), list plans (p. 65), and list vms (p. 27) commands. If the parameter is not

specified, objects with any state will be listed.

For the list activities command, you can specify one or more of the following states: running,

paused, waiting, waiting_for_children, or completed.

For the list tasks and list plans commands, you can specify one or more of the following

states: idle, waiting, running, or need_interaction.

For the list vms command, you can specify one or more of the following states: running,

stopped, suspended, wait_input, or unknown.

3.10.12 filter_status

--filter_status=<statuses>

Statuses for selecting objects to be output. The parameter is used with the list vms (p. 27) and

list plans (p. 65) commands. If not specified, objects with any status will be displayed.

A virtual machine status shows how successful the machine is backed up. It depends on the statuses

of all backup plans related to this virtual machine.

You can specify one or more of the following statuses: ok, warning, error, or unknown.

3.10.13 filter_type

Types for selecting objects to be output.

Commands: list archives, list backups

--filter_type=<types>

In the list archives (p. 40) command, you can specify one or more of the following types: disk,

file, exchange_db, and exchange_doc.

In the list backups (p. 44) command, you can specify one or more of the following types: full,

incremental, differential, and transaction_log.

Command: list vmservers

--filter_type=<server types>