Dell EqualLogic PS6210XV EqualLogic Auto-Snapshot Manager/Microsoft Edition Ve - Page 100

How to Use ASMCLI Commands, General Command Syntax, ASMCLI Command Summary

Get Dell EqualLogic PS6210XV PDF manuals and user guides View all Dell EqualLogic PS6210XV manuals
Add to My Manuals
Save this manual to your list of manuals

Page 100 highlights

How to Use ASMCLI Commands The ASMCLI executable is located under the default installation folder, or the folder that you specified for ASM/ME during installation. The default folder is C:\Program Files\EqualLogic\bin. You execute a command by starting the Windows command prompt: 1. Click Start → Run. Then type cmd. 2. In the command window, change the directory to C:\Program Files\EqualLogic\bin or add the ASM/ME CLI commands folder to your path by editing your Windows PATH environment variable. General Command Syntax The general command syntax is as follows: command [‑|/]sub_command required_parameter="argument" optional_parameter... The following constraints apply to the syntax: • [‑|/]sub_command-Prefix subcommands with a hyphen (-) or a forward slash (/). Depending on the width of the help window, the hyphen (or forward slash) preceding a subcommand might appear on the next line in command examples. This is a constraint of the help system formatting, and you should always make sure that you specify the prefix (-) or (/). • " argument "- An argument requires quotation marks only when the argument variable contains an embedded space. • Arguments consist of the following components: • A unique identifier assigned to an object, such as a volume or a collection. • A keyword, such as copy or full • A user‑defined string, such as a time or a comment • Several parameters that are mutually exclusive. The command parser automatically ignores any redundant parameters. The following table lists the typographical conventions for ASMCLI. Table 35. ASMCLI Typographical Conventions Convention fixed width font bold fixed width Usage Command, parameter, output, file name, link, button, field, URL address, or email address Input to command prompt fixed_width_italics Indicates that you replace the variable with a command, parameter, file name, and so on. {text1 | text2} Indicates that you can choose one of the items presented. parameter... Trailing dots indicate that you can enter multiple parameters on a command line, separated by spaces. option[,...] Trailing dots, preceded by a comma, indicate you can enter multiple variables, separated by commas and no spaces. [parameter] Brackets indicate that the item inside the bracket is optional. > A greater than symbol represents a Windows system prompt. The following command example demonstrates the syntax of a typical command that you might use to create a Smart Copy schedule. > ASMCLI ‑smart ‑scheduleID=ee05bb76‑6ccc‑431a‑99b9‑37886a1d7748 ‑objectID=Psv{18a09060‑3be0‑3fa8‑0a7a‑e4120000e045;32256} ‑shadowType=Transportable ‑backupType=copy ‑snapshotType=Snapshot ‑keepCount=14 ASMCLI Command Summary The following table provides an alphabetical summary of the commands and describes the function of each command. You must prefix subcommands and parameters with either a hyphen (-) or a forward slash (/). 100 Using the Command Line Interface

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
How to Use ASMCLI Commands
The ASMCLI executable is located under the default installation folder, or the folder that you specified for ASM/ME during installation.
The default folder is
C:\Program Files\EqualLogic\bin.
You execute a command by starting the Windows command prompt:
1.
Click
Start
→
Run
. Then type
cmd
.
2.
In the command window, change the directory to
C:\Program Files\EqualLogic\bin
or add the ASM/ME CLI commands
folder to your path by editing your Windows PATH environment variable.
General Command Syntax
The general command syntax is as follows:
command [
‑
|/]sub_command required_parameter="argument" optional_parameter...
The following constraints apply to the syntax:
•
[
‑
|/]sub_command
—Prefix subcommands with a hyphen (
-
) or a forward slash (
/
).
Depending on the width of the help window, the hyphen (or forward slash) preceding a subcommand might appear on the next line in
command examples. This is a constraint of the help system formatting, and you should always make sure that you specify the prefix
(
–
) or (
/
).
•
"
argument
"
— An argument requires quotation marks only when the argument variable contains an embedded space.
•
Arguments consist of the following components:
•
A unique identifier assigned to an object, such as a volume or a collection.
•
A keyword, such as
copy
or
full
•
A user
‑
defined string, such as a time or a comment
•
Several parameters that are mutually exclusive. The command parser automatically ignores any redundant parameters.
The following table lists the typographical conventions for ASMCLI.
Table 35. ASMCLI Typographical Conventions
Convention
Usage
fixed width font
Command, parameter, output, file name, link, button, field, URL address, or email address
bold fixed width
Input to command prompt
fixed_width_italics
Indicates that you replace the variable with a command, parameter, file name, and so on.
{text1 | text2}
Indicates that you can choose one of the items presented.
parameter...
Trailing dots indicate that you can enter multiple parameters on a command line, separated by
spaces.
option[,...]
Trailing dots, preceded by a comma, indicate you can enter multiple variables, separated by
commas and no spaces.
[parameter]
Brackets indicate that the item inside the bracket is optional.
>
A greater than symbol represents a Windows system prompt.
The following command example demonstrates the syntax of a typical command that you might use to create a Smart Copy schedule.
> ASMCLI
‑
smart
‑
scheduleID=ee05bb76
‑
6ccc
‑
431a
‑
99b9
‑
37886a1d7748
‑
objectID=Psv{18a09060
‑
3be0
‑
3fa8
‑
0a7a
‑
e4120000e045;32256}
‑
shadowType=Transportable
‑
backupType=copy
‑
snapshotType=Snapshot
‑
keepCount=14
ASMCLI Command Summary
The following table provides an alphabetical summary of the commands and describes the function of each command. You must prefix
subcommands and parameters with either a hyphen (-) or a forward slash (/).
100
Using the Command Line Interface