Users Guide

Terminate the string with the sequence: $CLI$‑@. The limit is 75 characters.
component= component_name
• Used with: smart, verify, mount, properties, unmount, restore, selectiveRestore, createcollection,
modifycollection subcommands
• Specify the ‑component= parameter with the originating component name, such as an Exchange mailbox database name. If the
component name string contains an embedded space, you must enclose the string in quotation marks (""). You can obtain the
component name from the ASM/ME GUI Applications node by browsing an individual component’s properties. Alternatively, use the
following command to display all component names:
> ASMCLI ‑list ‑components ‑showobjectid
• The ‑component= parameter and the ‑objectID= parameter are mutually exclusive and the command parser processes the first
valid parameter, ignoring any subsequent parameters.
• The ‑component= parameter is an alternative to using the ‑document= parameter, the ‑volume= parameter or the
‑collection= parameter. If you redundantly specify either a document path or a volume letter, the command parser is the
redundant parameter.
• When used with the createcollection or modifycollection subcommands, the ‑component parameter identifies a
semicolon‑delimited list of supported component specified by name. If this parameter is used, the ‑volume= parameter cannot be
used.
components
• Used with: list subcommand
• Specify the ‑components parameter to display all supported components such as Exchange mailbox databases.
deletesnap
• Used with: unmount subcommand
• Specify the ‑deletesnap parameter to delete the Smart Copy Set from which the target volume was unmounted. If the Smart Copy
Set contains multiple volumes this parameter has the following effect:
• It unmounts all volumes included in the Smart Copy that are currently mounted.
• It deletes all the volumes included in the Smart Copy regardless of their current mount status.
disable
• Used with: alert subcommand
• Specify the numerical ID for the alert you would like to disable. To view the numerical ID for each alert, type asmcli -alert.
disableall
• Used with: alert subcommand
• Specify the category name (critical, warning, or informational) or the category abbreviation (C, W, or I) to disable all alerts of that
type.
document= “path”
• Used with: verify, mount, properties, unmount, restore, selectiveRestore subcommands
• Specify the ‑document= parameter with the full path to a backup (*.bcd) document that you want to verify or mount. If any path
variables contain embedded spaces, you must enclose the variable in quotation marks ("").
• You need only specify the unique portion of the path following the PS Series volume identifier (Ps Vol ID), including the file name, and
the folder in which the file is stored.
documentFolder= “path”
• Used with: configureASM subcommand
• Designates the full directory path to folder where the Smart Copy backup document and collection definition folders are located.
group= “name”
• Used with: configureCHAP subcommand
• Designates the name of the group for which credentials will be specified.
email
Used with: smart, verify, mount, restore, unmount, selectiveRestore, and delete subcommands
Specify the ‑email parameter to send an email message confirming the status of the operation. The email is sent when an alert is
triggered.
Using the Command Line Interface
103