Users Guide
Table Of Contents
- About This Guide
- Dell EqualLogic Auto-Snapshot Manager/Microsoft Edition Version 5.4 User's Guide
- Introduction to ASM/ME
- Functions Provided By ASM/ME
- Supported Applications
- HIT Groups and Multiple Machine Management
- ASM/ME Smart Copies
- Smart Copy Types
- Smart Copy Operations for Template and Thin Clone Volumes
- Robust Data Recovery
- Thin-Provisioning a Volume
- SAN Data Copy Offload
- Scripts and Command Generation
- Alerts and Event Notification
- Remote Installations
- Failover Cluster Support
- ASM/ME and the Virtual Snapshot Service
- Functions Provided By ASM/ME
- Configure ASM/ME
- PS Series Group Requirements
- Windows Computer Requirements
- Required Access Controls
- VSS/VDS Service Access to the Group
- Access to Volumes and Snapshots
- iSCSI Target Connections
- Volume Mount Point and Drive Letter Assignments
- Mount Point Constraints in Cluster Environments
- ASM/ME Settings
- ASM/ME Graphical User Interface
- Start the ASM/ME GUI
- Tree Panel
- Tree Panel Behavior in Failover Cluster Environments
- Tree Panel Nodes
- Tree Panel Icons
- Group SharePoint Farm Nodes, Clusters, or Host Nodes
- About Aliases
- Customize Color Themes
- HIT Groups
- General ASM/ME Operations
- About Volumes
- Operations on Failover Clusters
- About Collections
- About Schedules
- About Smart Copies
- Restoring Data
- View Multipath Information
- View I/O Details
- Using ASM/ME with Exchange
- View Exchange Applications in ASM/ME
- Exchange Operations
- Overview of Exchange Smart Copies
- Exchange eseutil.exe Utility
- Recovery Considerations for Exchange
- Checksum Verification and Soft Recovery
- Run Checksum Verification and Soft Recovery Immediately
- Run Checksum Verification and Soft Recovery After Smart Copy Creation
- Schedule a Global Verification Task for Checksum Verification and Soft Recovery
- Run Checksum Verification and Soft Recovery on a Remote Host
- View Checksum Verification and Soft Recovery Status
- Checksum Verification and Soft Recovery Logging and Notification
- Create Exchange Smart Copies
- Schedule Smart Copies for Exchange Components
- Recover Exchange Data
- Using ASM/ME with SQL Server
- Using ASM/ME with Hyper-V
- Using ASM/ME with SharePoint
- SharePoint Installation Considerations
- Plan to Install on a SharePoint Farm
- Example of ASM/ME Installed on a SharePoint Farm
- Example of a SharePoint Farm with a SQL Cluster
- Install ASM/ME on a SharePoint Farm
- About Changes to an Existing SharePoint Farm
- Remove a HIT Group Host From a SharePoint Farm
- Add a Writer Host to a SharePoint Farm
- Change a Writer Host in a SharePoint Farm
- Change the Writer Host and Disable the VSS Writer in a SharePoint Farm
- Respond to Changes in a SharePoint Farm
- View SharePoint Farm Components in ASM/ME
- SharePoint Smart Copies
- Restore Options for SharePoint Smart Copies
- Availability of SharePoint Data Restoration Operations
- Mount a SharePoint Smart Copy
- Restore Selected Databases from a SharePoint Smart Copy
- Restore a Database In-Place From a SharePoint Smart Copy
- Restore a Database From a SharePoint Smart Copy as a New Database
- Restore an SSA From a SharePoint Smart Copy
- Using the Command Line Interface
- Introduction to ASMCLI
- How to Use ASMCLI Commands
- General Command Syntax
- ASMCLI Command Summary
- Command Parameters
- ASMCLI Commands and Their Syntax
- ASMCLI -alert
- ASMCLI -breaksmartcopy
- ASMCLI -cloneReplica
- ASMCLI -configureASM
- ASMCLI -configureCHAP
- ASMCLI -createCollection
- ASMCLI -delete
- ASMCLI -deleteCollection
- ASMCLI -enumerateiSCSIPortals
- ASMCLI -enumerateSmartCopies
- ASMCLI -help
- ASMCLI -list
- ASMCLI -modifyCollection
- ASMCLI -mount
- ASMCLI -Properties
- ASMCLI -restore
- ASMCLI -selectiveRestore
- ASMCLI -shutdownsystray
- ASMCLI -shutdownverifier
- ASMCLI -smart
- ASMCLI -unmount
- ASMCLI -verify
- ASMCLI -version
- Use a Script to Create Smart Copies
- Recover a Clustered Volume From a Clone
- Index
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
Using the Command Line Interface
105