DH2I POWERSHELL ADMINISTRATION GUIDEdh2i.com/wp-content/uploads/DxPS-v19-Admin-Guide.pdfDH2i...

DH2i Software PowerShell Administration Guide 1

DH2I POWERSHELL

ADMINISTRATION GUIDE

DH2i Software Version 19.0

DH2i Company

Support: +1 (800) 380-5405 ext 2 support.dh2i.com

eFax: +1 970-295-4505 [email protected]

www.dh2i.com

http://support.dh2i.com/

mailto:[email protected]

http://www.dh2i.com/


END-USER SOFTWARE LICENSE AGREEMENT ...................................................................... 6

COPYRIGHT AND DISCLAIMER .......................................................................................... 14

Trademarks ................................................................................................................................................... 14

OVERVIEW ...................................................................................................................... 15

DXPOWERSHELL REQUIREMENTS .............................................................................................................................. 15

INSTALLING THE DXPOWERSHELL MODULE .................................................................................................................. 15

IMPORTING THE DXPOWERSHELL MODULE .................................................................................................................. 16

DXPOWERSHELL CLASSES AND CMDLETS ......................................................................... 17

DXRESULT ............................................................................................................................................................ 17

DX-ADDCONTACT .................................................................................................................................................. 17

DX-ADDDOCKER .................................................................................................................................................... 18

DX-ADDDISK ......................................................................................................................................................... 18

DX-ADDFILESHARE ................................................................................................................................................. 19

DX-ADDINSTANCE .................................................................................................................................................. 20

DX-ADDNODE ....................................................................................................................................................... 20

DX-ADDPOLICY...................................................................................................................................................... 21

DX-ADDSERVICE .................................................................................................................................................... 24

DX-ADDSMTP ...................................................................................................................................................... 25

DX-ADDVHOST ...................................................................................................................................................... 25

DX-CLEANDISK ...................................................................................................................................................... 26

DX-CLEARRESERVATION .......................................................................................................................................... 27

DX-CLUSTERGETDOCKERIMAGES .............................................................................................................................. 27

DX-CLUSTERGETINSTANCES ..................................................................................................................................... 28

DX-CLUSTERREHOSTDOCKER .................................................................................................................................... 28

DX-CLUSTERREHOSTINSTANCE.................................................................................................................................. 29

DX-CLUSTERREHOSTSERVICE .................................................................................................................................... 29

DX-CLUSTERRESYNC ............................................................................................................................................... 30

DX-COLLECTLOG .................................................................................................................................................... 30

DX-CREATEVOLUME ............................................................................................................................................... 31

DX-DELETEVOLUME ............................................................................................................................................... 31

DX-DISABLENODE .................................................................................................................................................. 32

DX-ENABLENODE ................................................................................................................................................... 32

DX-ENCRYPTTEXT .................................................................................................................................................. 33

DX-EXECUTEDEBUGCOMMAND ................................................................................................................................ 33

DX-EXTENDVOLUME ............................................................................................................................................... 34

DX-FORMATVOLUME.............................................................................................................................................. 34

DX-FORMATVOLUMEEX .......................................................................................................................................... 35

DX-FORMATVOLUMEEX2 ........................................................................................................................................ 36

DX-FREEZENODE ................................................................................................................................................... 37

DX-FREEZEVHOST .................................................................................................................................................. 38

DX-GETALERTS ...................................................................................................................................................... 38

DX-GETCLUSTERDISKS ............................................................................................................................................ 39


DX-GETCLUSTERMEMBERS ...................................................................................................................................... 39

DX-GETCONNECTIONINFO ....................................................................................................................................... 39

DX-GETCONTACTS ................................................................................................................................................. 40

DX-GETCOORDINATORS .......................................................................................................................................... 41

DX-GETCOORDINATORSTATUS ................................................................................................................................. 41

DX-GETCOUNTERS ................................................................................................................................................. 41

DX-GETDISKDETAIL ................................................................................................................................................ 42

DX-GETDISKINFO ................................................................................................................................................... 43

DX-GETDISKS ........................................................................................................................................................ 43

DX-GETDOCKERDETAIL ........................................................................................................................................... 44

DX-GETGLOBALSETTINGS ........................................................................................................................................ 44

DX-GETINSTANCEDETAIL ......................................................................................................................................... 45

DX-GETLICENSE ..................................................................................................................................................... 45

DX-GETLICENSEREQUEST ........................................................................................................................................ 46

DX-GETLICENSES ................................................................................................................................................... 47

DX-GETMONITOREDDOCKERS .................................................................................................................................. 47

DX-GETMONITOREDFILESHARES ............................................................................................................................... 48

DX-GETMONITOREDINSTANCES ................................................................................................................................ 48

DX-GETMONITOREDSERVICES .................................................................................................................................. 49

DX-GETNODEDETAIL .............................................................................................................................................. 49

DX-GETPOLICIES .................................................................................................................................................... 50

DX-GETPOLICY ...................................................................................................................................................... 50

DX-GETPRODUCTTYPE ............................................................................................................................................ 51

DX-GETRESERVATION ............................................................................................................................................. 51

DX-GETSERVICEDETAIL ........................................................................................................................................... 52

DX-GETSMTP ...................................................................................................................................................... 52

DX-GETSQLPATHS ................................................................................................................................................. 52

DX-GETUNUSEDDRIVELETTERS ................................................................................................................................. 53

DX-GETVERSION .................................................................................................................................................... 53

DX-GETVHOST ...................................................................................................................................................... 54

DX-GETVHOSTS ..................................................................................................................................................... 54

DX-GETVOLUMEDETAIL .......................................................................................................................................... 55

DX-INSTALLSQL..................................................................................................................................................... 55

DX-JOINCLUSTER ................................................................................................................................................... 57

DX-RELOADMONITOREDAPPS .................................................................................................................................. 57

DX-REFRESHMONITOREDPATHS ............................................................................................................................... 58

DX-RELOADMONITOREDDOCKERS ............................................................................................................................ 58

DX-RELOADMONITOREDFILESHARES ......................................................................................................................... 59

DX-RELOADMONITOREDINSTANCES .......................................................................................................................... 60

DX-RELOADMONITOREDSERVICES ............................................................................................................................. 60

DX-RELOCATESYSTEMDATABASES ............................................................................................................................. 61

DX-REMOVECLUSTERMEMBER ................................................................................................................................. 62

DX-REMOVECONTACT............................................................................................................................................. 62

DX-REMOVEDISK ................................................................................................................................................... 63

DX-REMOVEDOCKER .............................................................................................................................................. 63


DX-REMOVEFILESHARE ........................................................................................................................................... 64

DX-REMOVEGLOBALSETTING ................................................................................................................................... 64

DX-REMOVEINSTANCE ............................................................................................................................................ 68

DX-REMOVENODE ................................................................................................................................................. 69

DX-REMOVEPOLICY ................................................................................................................................................ 69

DX-REMOVESCRIPT ................................................................................................................................................ 70

DX-REMOVESERVICE .............................................................................................................................................. 71

DX-REMOVESMTP ................................................................................................................................................ 71

DX-REMOVEVHOST ................................................................................................................................................ 72

DX-RESCANDISK .................................................................................................................................................... 72

DX-RESTARTGROUPCOMMUNICATIONEX ................................................................................................................... 73

DX-SETAPPCOORDINATOR ....................................................................................................................................... 73

DX-SETCLUSTERID ................................................................................................................................................. 74

DX-SETCOORDINATOR ............................................................................................................................................ 74

DX-SETDEPENDS .................................................................................................................................................... 75

DX-SETDISKLABEL .................................................................................................................................................. 75

DX-SETDOCKERDESCRIPTION ................................................................................................................................... 76

DX-SETFAILBACK .................................................................................................................................................... 76

DX-SETGLOBALSETTING .......................................................................................................................................... 77

DX-SETINSTANCEDESCRIPTION ................................................................................................................................. 80

DX-SETLICENSE ...................................................................................................................................................... 81

DX-SETMOUNTPOINT ............................................................................................................................................. 81

DX-SETSCRIPT ....................................................................................................................................................... 82

DX-SETSCRIPTEMBEDDED ........................................................................................................................................ 83

DX-SETSECRET ...................................................................................................................................................... 84

DX-SETSERVER ...................................................................................................................................................... 84

DX-SETSTORCOORDINATOR ..................................................................................................................................... 85

DX-SETVHOSTPRIORITY ........................................................................................................................................... 85

DX-SETVOLUMELABEL ............................................................................................................................................ 86

DX-SHRINKVOLUME ............................................................................................................................................... 87

DX-STARTDISK ...................................................................................................................................................... 87

DX-STARTDISKASSOCIATES ...................................................................................................................................... 88

DX-STARTDISKGROUP ............................................................................................................................................ 88

DX-STARTDOCKER .................................................................................................................................................. 89

DX-STARTINSTANCE ................................................................................................................................................ 89

DX-STARTSERVICE .................................................................................................................................................. 90

DX-STARTVOLUME ................................................................................................................................................. 90

DX-STOPDISK ........................................................................................................................................................ 91

DX-STOPDISKASSOCIATES ........................................................................................................................................ 91

DX-STOPDISKGROUP .............................................................................................................................................. 92

DX-STOPDOCKER ................................................................................................................................................... 92

DX-STOPINSTANCE ................................................................................................................................................. 93

DX-STOPSERVICE ................................................................................................................................................... 94

DX-STOPVOLUME .................................................................................................................................................. 94

DX-TESTWITNESS .................................................................................................................................................. 95


DX-UNFREEZENODE ............................................................................................................................................... 95

DX-UNFREEZEVHOST .............................................................................................................................................. 96

DX-UPDATECONTACT ............................................................................................................................................. 96

DX-UPDATEFILESHARE ............................................................................................................................................ 97

DX-UPDATEPOLICY ................................................................................................................................................. 98

DX-UPDATEVHOST ............................................................................................................................................... 100

DX-UPGRADESQL ................................................................................................................................................ 101

DX-VHOSTGETDOCKERIMAGES ............................................................................................................................... 102

DX-VHOSTGETINSTANCES ...................................................................................................................................... 102

DX-VHOSTGETSERVICES ........................................................................................................................................ 103

DX-VHOSTSETDISKGROUP ..................................................................................................................................... 103

DX-VHOSTSETDOCKERIMAGE ................................................................................................................................. 104

DX-VHOSTSTARTNODE ......................................................................................................................................... 105

DX-VHOSTSTOPNODE ........................................................................................................................................... 105

SUPPORT AND OTHER RESOURCES................................................................................. 107

TROUBLESHOOTING .............................................................................................................................................. 107

HOW TO REQUEST TECHNICAL SUPPORT .................................................................................................................... 107

CONTACTING DH2I .............................................................................................................................................. 109


END-USER SOFTWARE LICENSE

AGREEMENT

DH2i COMPANY AND/OR ITS AFFILIATES (“DH2i”) IS WILLING TO LICENSE THE LICENSED SOFTWARE TO YOU AS THE

INDIVIDUAL, THE COMPANY AND/OR ITS AFFILIATES, OR THE LEGAL ENTITY THAT WILL BE UTILIZING THE LICENSED

SOFTWARE (REFERENCED BELOW AS “YOU” OR “YOUR”) ONLY ON THE CONDITION THAT YOU ACCEPT ALL OF THE

TERMS OF THIS END-USER SOFTWARE LICENSE AGREEMENT (“AGREEMENT”). READ THE TERMS AND CONDITIONS

OF THIS AGREEMENT CAREFULLY BEFORE USING THE LICENSED SOFTWARE. THIS IS A LEGAL AND ENFORCEABLE

CONTRACT BETWEEN YOU AND DH2I. BY CLICKING THE “I AGREE” OR “YES” BUTTON, OR OTHERWISE INDICATING

ASSENT ELECTRONICALLY, OR LOADING THE LICENSED SOFTWARE OR OTHERWISE USING THE LICENSED

SOFTWARE, YOU AGREE TO THE TERMS AND CONDITIONS OF THIS LICENSE AGREEMENT. IF YOU DO NOT AGREE

TO THESE TERMS AND CONDITIONS, CLICK THE “I DO NOT AGREE” OR “NO” BUTTON OR OTHERWISE INDICATE

REFUSAL AND MAKE NO FURTHER USE OF THE LICENSED SOFTWARE. UNLESS OTHERWISE DEFINED HEREIN,

CAPITALIZED TERMS WILL HAVE THE MEANING GIVEN IN THE “DEFINITIONS” SECTION OF THIS LICENSE

AGREEMENT AND SUCH CAPITALIZED TERMS MAY BE USED IN THE SINGULAR OR IN THE PLURAL, AS THE CONTEXT

REQUIRES.

1. DEFINITIONS.

“Content Updates” means content used by certain DH2i products which is updated from time to time, including

but not limited to: updated anti-spyware definitions for anti-spyware products; updated antispam rules for

antispam products; updated virus definitions for antivirus and crimeware products; updated URL lists for content

filtering and antiphishing products; updated firewall rules for firewall products; updated intrusion detection data

for intrusion detection products; updated lists of authenticated web pages for website authentication products;

updated policy compliance rules for policy compliance products; and updated vulnerability signatures for

vulnerability assessment products.

“Documentation” means the user documentation DH2i provides with the Licensed Software.

“License Instrument” means one or more of the following applicable documents which further defines Your

license rights to the Licensed Software: a DH2i license certificate, DH2i license key or a similar license document

issued by DH2i, or a written agreement between You and DH2i, that accompanies, precedes or follows this License

Agreement.

“Licensed Software” means the DH2i software product, in object code form, accompanying this License

Agreement, including any Documentation included in, or provided for use with, such software or that accompanies

this License Agreement.

“Support Certificate” means the certificate sent by DH2i confirming Your purchase of the applicable DH2i

maintenance/support for the Licensed Software.


“Upgrade” means any version of the Licensed Software that has been released to the public and which replaces

the prior version of the Licensed Software on DH2i’s price list pursuant to DH2i’s then-current upgrade policies.

“Use Level” means the license use meter or model (which may include operating system, hardware system,

application or machine tier limitations, if applicable) by which DH2i measures, prices and licenses the right to use

the Licensed Software, in effect at the time an order is placed for such Licensed Software, as indicated in this

License Agreement and the applicable License Instrument.

2. LICENSE GRANT. Subject to Your compliance with the terms and conditions of this License Agreement, DH2i

grants to You the following rights: (i) a non-exclusive, non-transferable (except as stated otherwise in Section 16.1)

license to use the Licensed Software solely in support of Your internal business operations in the quantities and at

the Use Levels described in this License Agreement and the applicable License Instrument(subject to Section 17.2);

and (ii) the right to make a single uninstalled copy of the Licensed Software for archival purposes.

2.1 TERM. The term of the Licensed Software license granted under this License Agreement shall be perpetual

(subject to Section 14) unless stated otherwise in Section 17 or unless You have obtained the Licensed Software on

a non-perpetual basis, such as, under a subscription or term-based license for the period of time indicated on the

applicable License Instrument. If You have obtained the Licensed Software on a non-perpetual basis, Your rights to

use such Licensed Software shall end on the applicable end date as indicated on the applicable License Instrument

and You shall cease use of the Licensed Software as of such applicable end date.

3. LICENSE RESTRICTIONS. You may not, without DH2i’s prior written consent, conduct, cause or permit the: (i)

use, copying, modification, rental, lease, sublease, sublicense, or transfer of the Licensed Software except as

expressly provided in this License Agreement; (ii) creation of any derivative works based on the Licensed Software;

(iii) reverse engineering, disassembly, or decompiling of the Licensed Software (except that You may decompile the

Licensed Software for the purposes of interoperability only to the extent permitted by and subject to strict

compliance under applicable law); (iv) use of the Licensed Software in connection with service bureau, facility

management, timeshare, service provider or like activity whereby You operate or use the Licensed Software for

the benefit of a third party; (v) use of the Licensed Software by any party other than You; (vi) use of a later version

of the Licensed Software other than the version that accompanies this License Agreement unless You have

separately acquired the right to use such later version through a License Instrument or Support Certificate; nor (vii)

use of the Licensed Software above the quantity and Use Level that have been licensed to You under this License

Agreement or the applicable License Instrument.

4. OWNERSHIP/TITLE. The Licensed Software is the proprietary property of DH2i or its licensors and is protected

by copyright law. DH2i and its licensors retain any and all rights, title and interest in and to the Licensed Software,

including in all copies, improvements, enhancements, modifications and derivative works of the Licensed Software.

Your rights to use the Licensed Software shall be limited to those expressly granted in this License Agreement. All

rights not expressly granted to You are retained by DH2i and/or its licensors.

5. CONTENT UPDATES. If You purchase a DH2i maintenance/support offering consisting of or including Content

Updates, as indicated on Your Support Certificate, You are granted the right to use, as part of the Licensed

Software, such Content Updates as and when they are made generally available to DH2i’s end user customers who

have purchased such maintenance/support offering and for such period of time as indicated on the face of the

applicable Support Certificate. This License Agreement does not otherwise permit You to obtain and use Content

Updates.


6. UPGRADES/CROSS-GRADES. DH2i reserves the right to require that any upgrades (if any) of the Licensed

Software may only be obtained in a quantity equal to the number indicated on the applicable License Instrument.

An upgrade to an existing license shall not be deemed to increase the number of licenses which You are authorized

to use. Additionally, if You upgrade a Licensed Software license, or purchase a Licensed Software license listed on

the applicable License Instrument to cross-grade an existing license (i.e. to increase its functionality, and/or

transfer it to a new operating system, hardware tier or licensing meter), then DH2i issues the applicable Licensed

Instrument based on the understanding that You agree to cease using the original license. Any such license

upgrade or cross-grade is provided under DH2i's policies in effect at the time of order. This License Agreement

does not separately license You for additional licenses beyond those which You have purchased, and which have

been authorized by DH2i as indicated on the applicable License Instrument.

7. LIMITED WARRANTY.

7.1. MEDIA WARRANTY. If DH2i provides the Licensed Software to You on tangible media, DH2i warrants that the

magnetic media upon which the Licensed Software is recorded will not be defective under normal use, for a period

of ninety (90) days from delivery. DH2i will replace any defective media returned to DH2i within the warranty

period at no charge to You. The above warranty is inapplicable in the event the Licensed Software media becomes

defective due to unauthorized use of the Licensed Software. THE FOREGOING IS YOUR SOLE AND EXCLUSIVE

REMEDY FOR DH2I’S BREACH OF THIS WARRANTY.

7.2. PERFORMANCE WARRANTY. DH2i warrants that the Licensed Software, as delivered by DH2i and when used

in accordance with the Documentation, will substantially conform to the Documentation for a period of ninety (90)

days from delivery. If the Licensed Software does not comply with this warranty and such non-compliance is

reported by You to DH2i within the ninety (90) day warranty period, DH2i will do one of the following, selected at

DH2i’s sole discretion: either (i) repair the Licensed Software, (ii) replace the Licensed Software with software of

substantially the same functionality, or (iii) terminate this License Agreement and refund the relevant license fees

paid for such non-compliant Licensed Software. The above warranty specifically excludes defects resulting from

accident, abuse, unauthorized repair, modifications or enhancements, or misapplication. THE FOREGOING IS YOUR

SOLE AND EXCLUSIVE REMEDY FOR DH2I’S BREACH OF THIS WARRANTY.

8. WARRANTY DISCLAIMERS. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, THE WARRANTIES

SET FORTH IN SECTIONS 7.1 AND 7.2 ARE YOUR EXCLUSIVE WARRANTIES AND ARE IN LIEU OF ALL OTHER

WARRANTIES, WHETHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES

OF MERCHANTABILITY, SATISFACTORY QUALITY, FITNESS FOR A PARTICULAR PURPOSE, AND

NONINFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS. DH2I MAKES NO WARRANTIES OR REPRESENTATIONS

THAT THE LICENSED SOFTWARE, CONTENT UPDATES OR UPGRADES WILL MEET YOUR REQUIREMENTS OR THAT

OPERATION OR USE OF THE LICENSED SOFTWARE, CONTENT UPDATES, AND UPGRADES WILL BE

UNINTERRUPTED OR ERROR-FREE. YOU MAY HAVE OTHER WARRANTY RIGHTS, WHICH MAY VARY FROM STATE

TO STATE AND COUNTRY TO COUNTRY.

9. LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW AND REGARDLESS OF

WHETHER ANY REMEDY SET FORTH HEREIN FAILS OF ITS ESSENTIAL PURPOSE, IN NO EVENT WILL DH2I OR ITS

LICENSORS, RESELLERS, SUPPLIERS OR AGENTS BE LIABLE TO YOU FOR (i) ANY COSTS OF PROCUREMENT OF

SUBSTITUTE OR REPLACEMENT GOODS AND SERVICES, LOSS OF PROFITS, LOSS OF USE, LOSS OF OR

CORRUPTION TO DATA, BUSINESS INTERRUPTION, LOSS OF PRODUCTION, LOSS OF REVENUES, LOSS OF

CONTRACTS, LOSS OF GOODWILL, OR ANTICIPATED SAVINGS OR WASTED MANAGEMENT AND STAFF TIME; OR

(ii) ANY SPECIAL, CONSEQUENTIAL, INCIDENTAL OR INDIRECT DAMAGES WHETHER ARISING DIRECTLY OR


INDIRECTLY OUT OF THIS LICENSE AGREEMENT, EVEN IF DH2I OR ITS LICENSORS, RESELLERS, SUPPLIERS OR

AGENTS HAS BEEN ADVISED SUCH DAMAGES MIGHT OCCUR. IN NO CASE SHALL DH2I’S LIABILITY EXCEED THE

FEES YOU PAID FOR THE LICENSED SOFTWARE GIVING RISE TO THE CLAIM. NOTHING IN THIS AGREEMENT SHALL

OPERATE SO AS TO EXCLUDE OR LIMIT DH2I’S LIABILITY TO YOU FOR DEATH OR PERSONAL INJURY ARISING OUT

OF NEGLIGENCE OR FOR ANY OTHER LIABILITY WHICH CANNOT BE EXCLUDED OR LIMITED BY LAW. THE

DISCLAIMERS AND LIMITATIONS SET FORTH ABOVE WILL APPLY REGARDLESS OF WHETHER OR NOT YOU ACCEPT

THE LICENSED SOFTWARE, CONTENT UPDATES OR UPGRADES.

10. MAINTENANCE/SUPPORT. DH2i has no obligation under this License Agreement to provide

maintenance/support for the Licensed Software. Any maintenance/support purchased for the Licensed Software is

subject to DH2i’s then-current maintenance/support policies.

11. SOFTWARE EVALUATION. If the Licensed Software is provided to You for evaluation purposes and You have an

evaluation agreement with DH2i for the Licensed Software, Your rights to evaluate the Licensed Software will be

pursuant to the terms of such evaluation agreement. If You do not have an evaluation agreement with DH2i for the

Licensed Software and if You are provided the Licensed Software for evaluation purposes, the following terms and

conditions shall apply. DH2i grants to You a nonexclusive, temporary, royalty-free, non-assignable license to use

the Licensed Software solely for internal non-production evaluation. Such evaluation license shall terminate (i) on

the end date of the pre-determined evaluation period, if an evaluation period is pre-determined in the Licensed

Software or (ii) thirty (30) days from the date of Your initial installation of the Licensed Software, if no such

evaluation period is pre-determined in the Licensed Software (“Evaluation Period”). The Licensed Software may

not be transferred and is provided “AS IS” without warranty of any kind. You are solely responsible to take

appropriate measures to back up Your system and take other measures to prevent any loss of files or data. The

Licensed Software may contain an automatic disabling mechanism that prevents its use after a certain period of

time. Upon expiration of the Licensed Software Evaluation Period, You will cease use of the Licensed Software and

destroy all copies of the Licensed Software. All other terms and conditions of this License Agreement shall

otherwise apply to Your evaluation of the Licensed Software as permitted herein.

12. U.S. GOVERNMENT RESTRICTED RIGHTS. If END-USER is a unit of the United States Government, the Software

and associated documentation are provided with restricted rights. Use, duplication, or disclosure by the United

States Government is subject to the restrictions as set forth in subpart 27-404-2 of the Federal Acquisition

Regulations, in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFAR

252.227-7013 and DFAR 252.227-7014 or the restrictions set forth in (c)(1) and (2) of the Commercial Computer

Software Restricted Rights at 48 CFR 52.227-19, as applicable, or in successor provisions, including the limitations

set forth herein. Manufacturer is DH2i Company, 320 East Vine Drive, Fort Collins, Colorado, U.S.A.

13. EXPORT REGULATION. You acknowledge that the Licensed Software and related technical data and services

(collectively "Controlled Technology") are subject to the import and export laws of the United States, specifically

the U.S. Export Administration Regulations (EAR), and the laws of any country where Controlled Technology is

imported or re-exported. You agree to comply with all relevant laws and will not to export any Controlled

Technology in contravention to U.S. law nor to any prohibited country, entity, or person for which an export

license or other governmental approval is required. All DH2i products, including the Controlled Technology are

prohibited for export or re-export to Cuba, North Korea, Iran, Syria and Sudan and to any country subject to

relevant trade sanctions. You hereby agree that You will not export or sell any Controlled Technology for use in

connection with chemical, biological, or nuclear weapons, or missiles, drones or space launch vehicles capable of

delivering such weapons.


14. TERMINATION. This License Agreement shall terminate upon Your breach of any term contained herein. Upon

termination, You shall immediately stop using and destroy all copies of the Licensed Software.

15. SURVIVAL. The following provisions of this License Agreement survive termination of this License Agreement:

Definitions, License Restrictions and any other restrictions on use of intellectual property, Ownership/Title,

Warranty Disclaimers, Limitation of Liability, U.S. Government Restricted Rights, Export Regulation, Survival, and

General.

16. GENERAL.

16.1. ASSIGNMENT. You may not assign the rights granted hereunder or this License Agreement, in whole or in

part and whether by operation of contract, law or otherwise, without DH2i’s prior express written consent.

16.2. COMPLIANCE WITH APPLICABLE LAW. You are solely responsible for Your compliance with, and You agree to

comply with, all applicable laws, rules, and regulations in connection with Your use of the Licensed Software.

16.3. AUDIT. An auditor, selected by DH2i and reasonably acceptable to You, may, upon reasonable notice and

during normal business hours, but not more often than once each year, inspect Your records and deployment in

order to confirm that Your use of the Licensed Software complies with this License Agreement and the applicable

License Instrument. DH2i shall bear the costs of any such audit, except where the audit demonstrates that the

Manufacturer’s Suggested Reseller Price (MSRP) value of Your non-compliant usage exceeds five percent (5%) of

the MSRP value of Your compliant deployments. In such case, in addition to purchasing appropriate licenses for

any over-deployed Licensed Software, You shall reimburse DH2i for the auditor’s reasonable actual fees for such

audit.

16.4. GOVERNING LAW; JURISDICTION; SEVERABILITY; WAIVER. This Agreement is to be construed in accordance

with and governed by the internal laws of the State of Colorado, without giving effect to any choice of law rule that

would cause the application of the laws of any jurisdiction other than the internal laws of the State of Colorado to

the rights and duties of the parties. Any proceeding seeking to enforce any provision of, or based on any right

arising out of, this Agreement may be brought only in the courts of the State of Colorado, County of Larimer, or, if

it has or can acquire the necessary jurisdiction, in the United States District Court for the District of Colorado. Each

of the Parties consents to the exclusive jurisdiction of such courts (and the appropriate appellate courts) in any

such Proceeding and waives any objection to venue laid therein. Process in any proceeding referred to in the

preceding sentence may be served on any Party anywhere in the world. If any provision of this License Agreement

is found partly or wholly illegal or unenforceable, such provision shall be enforced to the maximum extent

permissible, and remaining provisions of this License Agreement shall remain in full force and effect. A waiver of

any breach or default under this License Agreement shall not constitute a waiver of any other subsequent breach

or default. Any waiver or failure to enforce any provision of this Agreement on one occasion will not be deemed a

waiver of any other provision or of such provision on any other occasion.

16.5. REMEDIES. Except as provided in Sections 7, 8, 9 and 17.4, the parties’ rights and remedies under the

Agreement are cumulative. Customer acknowledges that the Software contains valuable trade secrets and

proprietary information of DH2i, that any actual or threatened breach of Sections 2 and/or 3 will constitute

immediate, irreparable harm to DH2i for which monetary damages would be an inadequate remedy, and that

injunctive relief is an appropriate remedy for such breach. If any legal action is brought by a party to enforce the

Agreement, the prevailing party will be entitled to receive its reasonable attorneys’ fees, court costs, and other

collection expenses, in addition to any other relief it may receive.


16.6. THIRD PARTY PROGRAMS. This Licensed Software may contain third party software programs (“Third Party

Programs”) that are available under open source or free software licenses. This License Agreement does not alter

any rights or obligations You may have under those open source or free software licenses. Notwithstanding

anything to the contrary contained in such licenses, the disclaimer of warranties and the limitation of liability

provisions in this License Agreement shall apply to such Third Party Programs.

16.7. CUSTOMER SERVICE. Should You have any questions concerning this License Agreement, or if You desire to

contact DH2i for any reason, please write to: (i) DH2i Customer Care, 320 East Vine Drive, Suite 321, Fort Collins,

CO 80524, U.S.A

16.8. CONSTRUCTION. The headings of Sections of this Agreement are for convenience and are not to be used in

interpreting this Agreement. As used in this Agreement, the word “including” means “including but not limited

to.”

16.9. PUBLICITY. Upon Customer’s written approval in each instance, which may be withdrawn at any time, DH2i

may (a) create a general announcement press release indicating that the parties have entered into this Agreement,

(b) use Customer’s business name and logo in written materials identifying DH2i’s customers and in other

appropriate promotional materials; (c) identify Customer in applicable case studies; and (d) identify Customer as a

reference for prospective customers and the media (provided that Customer shall not be obligated to comment in

any way).

16.9. ENTIRE AGREEMENT. This License Agreement and any related License Instrument are the complete and

exclusive agreement between You and DH2i relating to the Licensed Software and supersede any previous or

contemporaneous oral or written communications, proposals, and representations with respect to its subject

matter. This License Agreement prevails over any conflicting or additional terms of any purchase order, ordering

document, acknowledgement or confirmation or other document issued by You, even if signed and returned. This

License Agreement may only be modified by a License Instrument that accompanies or follows this License

Agreement.

17. ADDITIONAL TERMS AND CONDITIONS. Your use of the Licensed Software is subject to the terms and

conditions below in addition to those stated above.

17.1 ADDITIONAL DEFINITIONS.

A. “Client” or “Device” is defined as a single computer, storage drive or other device (i) on which licensee can

install and use the software, (ii) from which licensee accesses and uses the software installed on a network, or (iii)

a physical connection point that links together two separate devices.

B. “Server” is defined as an individual computer, acting as a service or resource provider to client computers by

sharing the resources within the network infrastructure. The server’s processor core count is determined by the

number of populated processor cores which are installed on a server, where each processor may include multiple

cores. A Server can run server software for other computers or devices.

C. Virtual Machines. For the purposes of this Agreement, a virtual machine is considered the same as a Server.

D. “Disaster” means an unforeseen occurrence causing the operation of the applicable products systems and the

Licensed Software installed on such production systems, to be substantially impaired or prevented, which

occurrence may include, without limitation, fires, earthquakes, floods and viruses.


17.2 USE LEVELS. The License Software that may be governed by this Agreement is licensed on the following Use

Levels:

Product Meter

DH2i Software Per Server/Core/CAL

17.3 PRIVACY; DATA PROTECTION. The Licensed Software may collect the IP address, Product type and version of

installed DH2i product, Computer name, Processor/core count, Local time set on computer, Machine ID GUID,

domain name, alias and/or hostname of each Server for the Licensed Software. The collected information is stored

on Your system and will not be automatically transmitted to DH2i. The collected information will only be

transmitted to DH2i if manually sent by You or Your network administrator as part of a technical support request.

If transmitted to DH2i, the collected information will be used only for the purpose of fulfilling the corresponding

technical support request received by You or Your network administrator. The collected information may be

transferred to the DH2i group in the United States or other countries that may have less protective data protection

laws than the region in which you are situated (including the European Union), but DH2i has taken steps so that

the collected information, if transferred, receives an adequate level of protection. Any collected information will

be maintained in a secure manner, and will not be correlated with any other personally identifiable information.

DH2i may disclose the collected information if asked to do so by a law enforcement official as required or

permitted by law or in response to a subpoena or other legal process.

17.4 INFRINGEMENT CLAIMS.

17.4.1 INDEMNITY. DH2i will defend at its own expense any action against Customer brought by a third party to

the extent that the action is based upon a claim that the Software infringes any U.S. patents or any copyrights or

misappropriates any trade secrets of a third party or otherwise infringes on the intellectual property rights of a

third party, and DH2i will pay those costs and damages finally awarded against Customer in any such action that

are specifically attributable to such claim or those costs and damages agreed to in a monetary settlement of such

action. The foregoing obligations are conditioned on Customer (a) notifying DH2i promptly in writing of such

action, (b) giving DH2i sole control of the defense thereof and any related settlement negotiations, and (c)

reasonably cooperating and, at DH2i’s request and expense, assisting in such defense; provided, that any such

settlement by DH2i shall not entail an admission or finding of liability or fault on the part of Customer. DH2I shall

have the exclusive right to defend any such action, suit or proceeding and make settlements thereof at its own

discretion, and Customer may not settle or compromise such action, suit or proceeding, except with the prior

written consent of DH2i.

17.4.2. INJUNCTION. If the Software becomes, or in DH2i’s opinion is likely to become, the subject of an

infringement claim, DH2i may, at its option and expense, either (a) procure for Customer the right to continue

using the Software, (b) replace or modify the Software so that it becomes non-infringing and remains functionally

equivalent, or (c) accept return of the Software, terminate this Agreement upon written notice to Customer and

refund Customer the Software and Software Support Fees paid for such Software and related support upon such

termination, computed according to a twelve (12) month straight-line amortization schedule beginning on the

Effective Date.


17.4.3 EXCLUSIONS. Notwithstanding the foregoing, DH2i will have no obligation under this Section 7 or otherwise

with respect to any infringement claim based upon (a) any use of the Software not in accordance with this

Agreement or the Documentation, (b) any use of the Software in combination with other products, hardware,

equipment, software, or data not authorized by DH2i to be used with the Software, (c) any use of any release of

the Software other than the most current release made available to Customer, or (d) any modification of the

Software by any person other than DH2i or its authorized agents or subcontractors. Customer shall indemnify and

hold harmless DH2i from and against any action, suit or proceeding for infringement and/or misappropriation that

arises or results from any of the exclusions set forth in Section 17.4.3 above. The foregoing obligations are

conditioned on DH2i (a) notifying Customer promptly in writing of such action, (b) giving Customer sole control of

the defense thereof and any related settlement negotiations, and (c) reasonably cooperating and, at Customer’s

request and expense, assisting in such defense; provided, that any such settlement by Customer shall not entail an

admission or finding of liability or fault on the part of DH2i. Customer shall have the exclusive right to defend any

such action, suit or proceeding and make settlements thereof at its own discretion, and DH2i may not settle or

compromise such action, suit or proceeding, except with the prior written consent of Customer.

17.4.4 SECTION 17.4 STATES THE ENTIRE LIABILITY OF THE PARTIES, AND THEIR EXCLUSIVE REMEDIES FOR

INFRINGEMENT CLAIMS AND ACTIONS.


Copyright and Disclaimer

The information in this documentation was prepared by DH2i Company with reasonable care and is believed to be

accurate. However, DH2i Company shall not assume responsibility for losses or damages resulting from any

omissions, inaccuracies, or errors contained herein. DH2i Company may make improvements or changes in this

documentation or in the product and programs described in this documentation, at any time and without notice

and as it sees fit. This publication describes the state of this product at the time of its publication, and may not

reflect the product at all times in the future.

No part of this documentation may be reproduced, stored in a retrieval system, or transmitted, in any form or by

any means, electronic, mechanical, by photocopying, recording, or otherwise, without the prior written permission

of DH2i Company

DH2i COMPANY MAKES NO WARRANTY EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY

IMPLIED WARRANTIES OR MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, REGARDING THESE

MATERIALS AND MAKES SUCH MATERIALS AVALIABLE SOLELY ON AN "AS-IS" BASIS.

IN NO EVENT SHALL DH2i COMPANY BE LIABLE TO ANYONE FOR SPECIAL, COLLATERAL, INCIDENTAL, OR

CONSEQUENTIAL DAMAGES IN CONNECTION WITH OR ARISING OUT OF PURCHASE OR USE OF THESE MATERIALS.

The End-User License Agreement, which is included with the software program and this manual, specifies the

permitted and prohibited uses of the software program.

Please read the terms and conditions of the End-User License Agreement before commencing use of the software program.

© Copyright 2011-2019 DH2i Company. All rights reserved.

Trademarks

InstanceMobility, Smart Availability, DxEnterprise, DxOdyssey, DxAdmin, DxConsole, unVPN, DxMotion, DxHADR,

DxTransfer and DH2i logo are registered trademarks of DH2i Company

Third-Party Trademarks:

Microsoft Windows Server 2008R2, 2012/R2, 2016, SQL Server, Availability Group and BranchCache are

trademarks of Microsoft Corporation. Docker and the Docker logo are trademarks or registered trademarks of

Docker, Inc. Red Hat, Red Hat Enterprise Linux, the Shadowman logo, and JBoss are trademarks or registered

trademarks of Red Hat, Inc. Ubuntu and Canonical are registered trademarks of Canonical Ltd. SUSE and the SUSE

logo are trademarks of SUSE IP Development Limited. Linux is the registered trademark of Linus Torvalds. All other

brand names, product names or registered names are property of their respective owners.


Overview

DH2i software includes Windows PowerShell cmdlets (DxPS) that you can use to control and administer

DxEnterprise cluster(s) locally or remotely. This admin guide includes all of the DxEnterprise cmdlets and

sample scripts to successfully manage a DxEnterprise cluster. For additional information on how to use

Windows PowerShell, please reference Microsoft Windows PowerShell documentation.

DxPowerShell Requirements

DxPS requires a minimum Windows PowerShell version 3. This version is installed by default on

Windows operating systems, such as Windows 2012 and Windows 8.

To confirm which version you have installed, check the Version property of the Get-Host cmdlet or the

PSVersion property of the $PSVersionTable variable.

If required, Windows PowerShell version 3 setup package can be downloaded from:

http://www.microsoft.com/en-gb/download/details.aspx?id=34595

Installing the DxPowerShell module

The DxPowerShell module (DxPS.dll) is installed as part of DxEnterprise software bundle. There are no

additional steps required.



Importing the DxPowerShell module

DxPowerShell module (DxPS.dll) must be imported before you can begin using it. The module can be

found in the \bin subdirectory where you install DH2i software. The default installation location is

\Program Files\DH2i\bin.

To import the DxPowerShell (DxPS.dll) module:

1. Use the Windows PowerShell Import-Module cmdlet with -DisableNameChecking option. If

nothing is returned, then the import was successful.

2. Execute the Start_DxPS.cmd in the DH2i\bin folder.

3. Select the “DxPowerShell Utility” option under Advanced Configuration in DxAdmin.


DxPowerShell Classes and Cmdlets

DxPowerShell module is defined by a set of classes and cmdlets. Through the following classes and

cmdlets, you can locally or remotely administer and manage a DxEnterprise cluster.

DxResult

This class represents the xml result set returned by DxPowerShell cmdlets.

Properties

Name Type Description

Status Integer Status code. Non-zero value represents an error has occurred.

Result String A well-formed xml string represents the output from the process.

Examples

PS C:\> [xml]$xml = Dx-GetVersion | Select-Object -ExpandProperty Result

PS C:\> $xml.result

Dx-AddContact

Add a contact to the address book.

Syntax

Dx-AddContact [-Name] <string> [-Email] <string> [<CommonParameters>]

Detailed Description

This cmdlet adds a contact to the address book for the currently connected cluster.

Parameters

Name Type Description Required Command-line Input

Name String Contact name. True True

Email String Contact email address. True True

Output

See DxResult.

Examples

Dx-AddContact “support” “[email protected]”


Dx-AddDocker

Add an instance of a Docker container to a Vhost.

Syntax

Dx-AddDocker [-VhostName] <string> [-DockerName] <string> [-Image] <string> [-DockerParams]

<string[]> [<CommonParameters>]


This cmdlet adds an instance of a Docker container to a Vhost.

Parameters


VhostName String The name of the Vhost. True True

DockerName String The name of the Docker container.

True True

Image String The name of the Docker image. True True

DockerParams String[] The parameters that the Docker instance will use on startup.

True True

Output

See DxResult.

Examples

Dx-AddDocker “VHOST1” “MSSQL1” “microsoft/mssql-server-linux” "-e|ACCEPT_EULA=Y|False”,”-

e|SA_PASSWORD=Pa$$word!|False”,”-p|50250:1433|False”,”-h|VHOST1|False”,“-

v|/mnt/mssql:/var/opt/mssql|False”,“-os|linux|False”

Dx-AddDisk

Add a disk to the current cluster.

Syntax

Dx-AddDisk [-DiskID] <string> [[-Label] <string>] [<CommonParameters>]


This cmdlet puts the disk under DxEnterprise management.

Parameters


DiskID String The GUID Disk ID. True True


Label String Name of the disk on the current cluster.

False True

Output

See DxResult.

Examples

Dx-AddDisk “dad7b407-b77a-b98b-edbb-df64556eeb17” “Cluster Disk 1”

Dx-AddFileshare

Add a network fileshare.

Syntax

Dx-AddFileshare [-VhostName] <string> [-ShareName] <string> [-SharePath] <string> -Grants <string[]> [-

Comments <string>] [-MaxAllowedUsers <int>] [-Caching {manual | BranchCache | documents |

programs | none}] [<CommonParameters>]


This cmdlet adds a network fileshare to a Vhost. The Windows file share will be created on all nodes

associated with the Vhost. The path must be accessible on all associated nodes.

Parameters



ShareName String The name of the fileshare. True True

SharePath String Local share path. True True

Grants String[] Grant parameter string array delimited by a comma (,). Each parameter name and value pair is delimited by a colon (:).

True True

Comments String User defined comment. False False

MaxAllowedUsers Integer Max concurrent users allowed to the share. Default is unlimited.

False False

Caching String Caching mode for the share. Possible mode: manual, BranchCache, documents, programs, none.

False False

Output

See DxResult.

Examples


Dx-AddFileshare “VHOST1” “SHARE1” “K:\Share1” “everyone,read:administrators,full”

Dx-AddInstance

Add an instance to a Vhost.

Syntax

Dx-AddInstance [-InstanceName] <string> [-TCPPort] <int> [-DataPath] <string> [-LogPath] <string> [[-

KeepExistingData]] [<CommonParameters>]


This cmdlet adds a named instance of SQL Server to a Vhost and puts it under DxEnterprise

management. The named instance must already be installed on all nodes associated with the Vhost. The

data and log paths must point to a SAN location that is accessible to all nodes. If the optional

KeepExistingData is specified, the current data and log files on the SAN are retained, otherwise they are

overwritten with the local data files.

Parameters


InstanceName String The name of the instance. True True

TCPPort Integer Static SQL Server listening port. True True

DataPath String Root path for SQL Server data (*.mdf, *.ndf).

True True

LogPath String Root path for SQL Server logs (*.ldf).

True True

KeepExistingData Switch Parameter

Whether to overwrite the target data in the DataPath and LogPath or to preserve it. Default is false if not specified.

False True

Output

See DxResult.

Examples

Dx-AddInstance “VHOST1\CUSTOMER” 44444 “S:\Sqldata\Customer\Data” “S:\Sqldata\Customer\Logs”

Dx-AddNode

Add node(s) to a Vhost.

Syntax

Dx-AddNode [-VhostName] <string> [-Nodes] <string> [<CommonParameters>]



This cmdlet adds node(s) to a Vhost. If the Vhost has any instances under its management, the node(s)

will undergo hosting readiness for these instances.

Parameters



Nodes String Node name(s). Delimited by comma.

True True

Output

See DxResult.

Examples

Dx-AddNode “VHOST1” “NODE1,NODE2,NODE3”

Dx-AddPolicy

Add a policy.

Syntax

Dx-AddPolicy -SYSTEM -ObjectName <string> [-Enabled] [-PolicyID <string>] [-Description <string>] [-

CounterName <string>] [-Threshold <int>] [-Operator <string>] [<CommonParameters>]

Dx-AddPolicy -PERF -ObjectName <string> -CounterName <string> -Threshold <int> [-Percent] [-

Loadbalance] [-Enabled] [-PolicyID <string>] [-Description <string>] [-Operator <string>] [-ScriptPath

<string>] [-Priority <int>] [<CommonParameters>]

Dx-AddPolicy -ALLOC -ObjectName <string> -CounterName <string> -Threshold <int> [-Enabled] [-

PolicyID <string>] [-Description <string>] [-Operator <string>] [-ScriptPath <string>]

[<CommonParameters>]

Dx-AddPolicy -FILTER [-Enabled] [-Information] [-Warning] [-Error] [-Critical] [-VhostFilter <string>] [-

InstanceFilter <string>] [-DockerFilter <string>] [-NodeFilter <string>] [-PolicyID <string>] [-Description

<string>] [-Operator <string>] [<CommonParameters>]


This cmdlet defines a SYSTEM/PERF/ALLOC/FILTER policy.

Parameters



SYSTEM Switch Parameter

System type policy. Used to alert when a system is down.

True False

PERF Switch Parameter

Performance type policy. True False

ALLOC Switch Parameter

Allocation type policy. True False

FILTER Switch Parameter

Global filter alert type policy. True False

PolicyID String Unique policy ID. False False

Description String User defined description. False False

ObjectName String Instance, Docker or System name.

False False

CounterName String Resource/counter name. Applicable to SYSTEM, PERF, and ALLOC policies. SYSTEM: system-down PERF: processor-consumption PERF: system-free-memory PERF: system-networking PERF: system-disk-io PERF: docker-processor PERF: docker-working-set PERF: docker-networking PERF: docker-disk-io PERF: instance-processor PERF: instance-working-set PERF: instance-networking PERF: instance-disk-io PERF: service-processor PERF: service-working-set PERF: service-networking PERF: service-disk-io ALLOC: alloc-docker-processor ALLOC: alloc-docker-memory ALLOC: alloc-docker-disk ALLOC: alloc-docker-network ALLOC: alloc-instance-processor ALLOC: alloc-instance-memory ALLOC: alloc-instance-disk ALLOC: alloc-instance-network ALLOC: alloc-node-processor ALLOC: alloc-node-memory ALLOC: alloc-node-disk ALLOC: alloc-node-network ALLOC: alloc-service-processor ALLOC: alloc-service-memory ALLOC: alloc-service-disk

False False


ALLOC: alloc-service-network

Threshold Integer Trigger limit applicable for PERF and ALLOC policies. When this threshold is met or exceeded the system will raise an alert and carry any predefined corrective actions.

False False

Percent Switch Parameter

Whether or not the threshold value is a percent of total system resource. Default is false.

False False

Operator String Email addresses to be sent when the policy is triggered. Delimited by comma.

False False

ScriptPath String Full path to the script file to be executed when the policy is triggered.

False False

Priority Integer Policy priority relative to other policies in the cluster. Valid values are between 1 and 5. With 1 being the lowest or least prioritized. Applicable to PERF policy.

False False

LoadBalance Switch Parameter

Whether or not to failover when the policy is triggered. Default is false.

False False

Enabled Switch Parameter

Whether or not the policy is enabled. Default is true.

False False

Information Switch Parameter

Whether or not filter only for Information severity alerts. Applicable to FILTER policy. Default is true.

False False

Warning Switch Parameter

Whether or not filter only for Warning severity alerts. Applicable to FILTER policy. Default is true.

False False

Error Switch Parameter

Whether or not filter only for Error severity alerts. Applicable to FILTER policy. Default is true.

False False

Critical Switch Parameter

Whether or not filter only for Critical severity alerts. Applicable to FILTER policy. Default is true.

False False

VhostFilter String Inclusive list of Vhosts to raise alert for. Applicable to FILTER policy. Default is all Vhosts.

False False


InstanceFilter String Inclusive list of instances to raise alert for. Applicable to FILTER policy. Default is all instances.

False False

NodeFilter String Inclusive list of nodes to raise alert for. Applicable to FILTER policy. Default is all nodes.

False False

DockerFilter String Inclusive list of containers to raise alert for. Applicable to FILTER policy. Default is all containers.

False False

Output

See DxResult.

Examples

Add-Policy -SYSTEM -ObjectName ”NODE1”

Add-Policy -PERF -ObjectName “CUSTOMER” -CounterName “instance-working-set” -Threshold 1000

Dx-AddPolicy -ALLOC -ObjectName “CUSTOMER” -CounterName “instance-working-set” -Threshold 2500

Dx-AddPolicy -FILTER -InstanceFilter “CUSTOMER” -Operator “[email protected]”

Dx-AddService

Add a service.

Syntax

Dx-AddService [-VhostName] <string> [-ServiceName] <string> [-Description <string>] [-

AssumeVhostName] [<CommonParameters>]


This cmdlet adds a service to a Vhost.

Parameters



ServiceName String The name of the service. True True

Description String User defined description. False True

AssumeVhostName Switch Parameter

Whether or not the service runs under the Vhost name.

False False

Output

See DxResult.


Examples

Dx-AddService “VHOST1” “ALG”

Dx-AddSMTP

Configure SMTP server and credentials for email alerts.

Syntax

DX-AddSMTP -ServerName <string> -Email <string> [-Port <int>] [-Protocol {NONE | TLS | SSL}] [-

EncryptedPassword] [-Password <string>] [-UserName <string>] [<CommonParameters>]


This cmdlet sets the SMTP information used to send email alerts.

Parameters


ServerName String SMTP server name or address True True

Email String Sender email address True True

Port Integer SMTP server connection port. Default is 25.

False False

Protocol String SMTP server protocol. Valid value is NONE, TLS, or SSL. Default is NONE.

False False

EncryptedPassword Switch Parameter

Whether or not the supplied password value is an encrypted string obtained from Dx-EncryptText cmdlet. Default is false.

False False

Password String Password used to connect to SMTP server.

False False

UserName String User name used to connect to SMTP server.

False False

Output

See DxResult.

Examples

DX-AddSMTP -ServerName “smtp.dh2i.com” -Email “[email protected]” -UserName “support” -

Password “Pa$$word!”

Dx-AddVhost

Add a Vhost to the cluster.


Syntax

Dx-AddVhost [-VhostName] <string> [-VIPs] <string> [-Nodes] <string> [[-AutoFailback]] [[-Priority] <int>]



This cmdlet adds a new Vhost to the cluster configuration.

Parameters



VIPs String IP address(es) of the Vhost. Delimited by comma.

True True

Nodes String List of nodes participating in the Vhost. Delimited by comma.

True True

AutoFailback Switch Parameter

Whether or not to support auto failback for the Vhost. Default is false.

False True

Priority Integer Vhost priority relative to other Vhosts in the cluster. Valid values are between 1 and 5. With 1 being the lowest or least prioritized.

False False

Output

See DxResult.

Examples

Dx-AddVhost “VHOST1” “10.1.200.151” “NODE1,NODE2,NODE3”

Dx-CleanDisk

Cleans the partition table on the disk.

Syntax

Dx-CleanDisk [-DiskID] <string> [<CommonParameters>]


This cmdlet deletes the partition table on the selected disk. All user data on disk will be destroyed.

Parameters


DiskID String The GUID Disk ID or disk label. True True


Output

See DxResult.

Examples

Dx-CleanDisk “dad7b407-b77a-b98b-edbb-df64556eeb17”

Dx-ClearReservation

Clears all reservations on the selected disk.

Syntax

Dx-ClearReservation [-DiskID] <string> [<CommonParameters>]


This cmdlet removes all SCSI-3 persistent reservations on the selected disk(s).

Parameters


DiskID String The GUID Disk ID(s) or disk label(s). Delimited by pipe (|).

True True

Output

See DxResult.

Examples

Dx-ClearReservation “dad7b407-b77a-b98b-edbb-df64556eeb17”

Dx-ClusterGetDockerImages

Returns a list of Docker images.

Syntax

Dx-ClusterGetDockerImages [<CommonParameters>]


This cmdlet returns a list of all Docker images available on each cluster node.

Output

See DxResult.

Examples


Dx-ClusterGetDockerImages

Dx-ClusterGetInstances

Returns a list of SQL Server instances.

Syntax

Dx-ClusterGetInstances [<CommonParameters>]


This cmdlet returns a list of all SQL Server instances available on each cluster node.

Output

See DxResult.

Examples

Dx-ClusterGetInstances

Dx-ClusterRehostDocker

Rehosts an instance of a Docker container from one Vhost to another.

Syntax

Dx-ClusterRehostDocker [-FromVhost] <string> [-ToVhost] <string> [-DockerName] <string>



This cmdlet removes the specified Docker instance from the source Vhost and adds it to the target

Vhost.

Parameters


FromVhost String The source Vhost name. True True

ToVhost String The target Vhost name. True True


True True

Output

See DxResult.

Examples

Dx-ClusterRehostDocker “VHOST1” “VHOST2” “MSSQL1”


Dx-ClusterRehostInstance

Rehosts a SQL Server instance from one Vhost to another.

Syntax

Dx-ClusterRehostInstance [-FromVhost] <string> [-ToVhost] <string> [-InstanceName] <string>



This cmdlet removes the specified instance from the source Vhost and adds it to the target Vhost.

Parameters





Output

See DxResult.

Examples

Dx-ClusterRehostInstance “VHOST1” “VHOST2” “INSTANCE1”

Dx-ClusterRehostService

Rehosts a service from one Vhost to another.

Syntax

Dx-ClusterRehostService [-FromVhost] <string> [-ToVhost] <string> [-ServiceName] <string>



This cmdlet removes the specified service from the source Vhost and adds it to the target Vhost.

Parameters





Output


See DxResult.

Examples

Dx-ClusterRehostService “VHOST1” “VHOST2” “SQLBrowser”

Dx-ClusterResync

Refresh cluster configuration for all members.

Syntax

Dx-ClusterResync [<CommonParameters>]


This cmdlet instructs all members to refresh their cluster configuration (DxVhost.xml) file. This ensures

every member has a consistent image of the cluster configuration.

Parameters

None.

Output

See DxResult.

Examples

Dx-ClusterResync

Dx-CollectLog

Run DxCollect utility on each cluster member.

Syntax

Dx-CollectLog [<CommonParameters>]


This cmdlet instructs all members to execute DxCollect.exe utility and return the status code and the

newly created log file.

Parameters

None.

Output

See DxResult.

Examples

Dx-CollectLog


PS C:\> [xml]$xml = Dx-CollectLog | Select-Object -ExpandProperty Result

PS C:\> $xml.SelectNodes("//node")

name exitcode filename

---- -------- --------

NODE1 0 [C:\Program Files\DH2i...




Dx-CreateVolume

Creates a volume.

Syntax

Dx-CreateVolume [-DiskSpace] <string> [<CommonParameters>]


This cmdlet creates a volume from any empty space available on the disk(s).

Parameters


DiskSpace String A pipe (|) delimited list of tuples – <GUID Disk ID or disk label>,<disk size in bytes>

True True

Output

See DxResult.

Examples

Dx-CreateVolume “dad7b407-b77a-b98b-edbb-df64556eeb17,17179869184”

Dx-DeleteVolume

Delete a specified volume.

Syntax

Dx-DeleteVolume [-VolID] <string> [<CommonParameters>]


This cmdlet deletes the specified volume. All user data on the volume will be destroyed.


Parameters


VolID String The GUID Volume ID. True True

Output

See DxResult.

Examples

Dx-DeleteVolume “deb7b407-a77b-889b-eddb-df63556eeb17”

Dx-DisableNode

Disable a cluster node.

Syntax

Dx-DisableNode [-NodeName] <string> [<CommonParameters>]


This cmdlet puts a node into a “disabled” state. A disabled node is a node that is still part of the cluster

but is no longer qualified to host any applications. If there are running/active applications on the node

prior to the state change, they will be relocated to other node(s) in the cluster.

Parameters


NodeName String The name of the node. True True

Output

See DxResult.

Examples

Dx-DisableNode “NODE1”

Dx-EnableNode

Enable a cluster node.

Syntax

Dx-EnableNode [-NodeName] <string> [<CommonParameters>]


This cmdlet clears the “disabled” state for a node, and potentially relocates applications on to it

according to allocation and auto-failback policies.


Parameters



Output

See DxResult.

Examples

Enable-Node “NODE1”

Dx-EncryptText

Encrypt a text value.

Syntax

Dx-EncryptText [-Text] <string> [<CommonParameters>]


This cmdlet encrypts a text value.

Parameters


Text String Text value to be encrypted. True True

Output

String.

Examples

Dx-EncryptText ”DH2i software”

Dx-ExecuteDebugCommand

Internal use only.

Syntax

Dx-ExecuteDebugCommand [[-Action] <string>] [-Values <string[]>] [<CommonParameters>]


This cmdlet executes a command. For internal use only.

Parameters



Action String The action to be executed. False True

Values String[] Applicable values for Action. False True

Output

See DxResult.

Examples

Dx-ExecuteDebugCommand “get-vhost” “VHOST1”

Dx-ExtendVolume

Extend the volume size.

Syntax

Dx-ExtendVolume [-VolID] <string> [-DiskSpace] <string> [<CommonParameters>]


This cmdlet extends the volume size.

Parameters


VolID String The GUID Volume ID of the volume to extend.

True True

DiskSpace String A pipe (|) delimited list of tuples – <GUID Disk ID or disk label>,<disk size in bytes>

True True

Output

See DxResult.

Examples

Dx-ExtendVolume “dad7b407-b77a-b98b-edbb-df64556eeb17” “deb7b407-a77b-889b-eddb-

df63556eeb17,17179869184”

The first GUID is the VolID. The second GUID is a Disk ID,(comma) 17179869184 (the size in bytes)

Dx-FormatVolume

Format a volume.

Syntax


Dx-FormatVolume [-VolID] <string> [-FileSystem {NTFS | FAT32 | ReFS}] [-VolumeLabel <string>] [-

BlockSize <int>] [-QuickFormat <bool>] [-Compression <bool>] [<CommonParameters>]


This cmdlet administratively formats the selected volume.

Parameters



FileSystem String Filesytem type. Valid values are NTFS, FAT32, or ReFS. Default is NTFS.

False False

VolumeLabel String Name of the volume. Default is New Dx Volume.

False False

BlockSize Integer Blockszie of the volume. Valid values are 512, 1024, 4096, 8192, 16384, 32768, or 65536. Default is 4096.

False False

QuickFormat Bool Whether or not to perform quick format. Quick format does not zero data on disk. Default is true.

False False

Compression Bool Enable compression support for the volume or not. Default is false.

False False

Output

See DxResult.

Examples

Dx-FormatVolume “dad7b407-b77a-b98b-edbb-df64556eeb17”

Dx-FormatVolumeEx

Format a volume with support for Windows format optional flags.

Syntax

Dx-FormatVolumeEx [-VolID] <string> [-FileSystem {NTFS | FAT32 | ReFS}] [-VolumeLabel <string>] [-

BlockSize <int>] [-QuickFormat <bool>] [-Compression <bool>] [-Optional <string>]



This cmdlet administratively formats the selected volume and allows Windows format optional flags to

be used.


Parameters



FileSystem String Filesytem type. Valid values are NTFS, FAT32, or ReFS. Default is NTFS.

False False


False False


False False


False False


False False

Optional String Optional flags available to Windows format.

False False

Output

See DxResult.

Examples

Dx-FormatVolumeEx “dad7b407-b77a-b98b-edbb-df64556eeb17”

Dx-FormatVolumeEx2

Format a volume with support for Windows format optional flags.

Syntax

Dx-FormatVolumeEx2 [-VolID] <string> [-FileSystem {NTFS | EXT4 | XFS | BTRFS}] [-VolumeLabel

<string>] [-BlockSize <int>] [-QuickFormat <bool>] [-Compression <bool>] [-Optional <string>]



This cmdlet administratively formats the selected volume and allows additional filesystem types to be

used.

Parameters




FileSystem String Filesytem type. Valid values are NTFS, EXT4, XFS and BTRFS. Default is NTFS.

False False


False False


False False


False False


False False

Optional String Optional flags available to Windows format.

False False

Output

See DxResult.

Examples

Dx-FormatVolumeEx2 “dad7b407-b77a-b98b-edbb-df64556eeb17”

Dx-FreezeNode

Freeze a cluster node.

Syntax

Dx-FreezeNode [-NodeName] <string> [<CommonParameters>]


This cmdlet administratively puts a node into “frozen” state. While the node is in this frozen state, all

applications continue to run on the node even if the DxEnterprise software is removed from the node. If

the node is rebooted, all SQL Server instances running on the node would require manual restart.

This cmdlet is designed to support in-place upgrade of DxEnterprise software.

Parameters



Output

See DxResult.


Examples

Dx-FreezeNode “NODE1”

Dx-FreezeVhost

Freeze a Vhost.

Syntax

Dx-FreezeVhost [-VhostName] <string> [<CommonParameters>]


This cmdlet administratively puts a Vhost into “frozen” state. While the Vhost is in this frozen state,

applications running under the Vhost can be stopped and started without causing the cluster to initiate

a failover. If the node is rebooted, all SQL Server instances running on the node would require manual

restart.

This cmdlet is applicable when maintenance of application registry or configuration is needed.

Parameters



Output

See DxResult.

Examples

Dx-FreezeVhost “VHOST1”

Dx-GetAlerts

Get all alerts for the cluster.

Syntax

Dx-GetAlerts [<CommonParameters>]


This cmdlet returns all active and persistent alerts for the current cluster.

Parameters

None.

Output

See DxResult.


Examples

Dx-GetAlerts

Dx-GetClusterDisks

Get a list of current cluster disks.

Syntax

Dx-GetClusterDisks [<CommonParameters>]


This cmdlet returns a list of known cluster disks, including disks that are inaccessible.

Parameters

None.

Output

See DxResult.

Examples

Dx-GetClusterDisks

Dx-GetClusterMembers

Get a list of current cluster members.

Syntax

Dx-GetClusterMembers [<CommonParameters>]


This cmdlet returns a list of known cluster members, including members that are inaccessible.

Parameters

None.

Output

See DxResult.

Examples

Dx-GetClusterMembers

Dx-GetConnectionInfo

Get current cluster connection details.


Syntax

Dx-GetConnectionInfo [<CommonParameters>]


This cmdlet returns a detailed list of properties for the current cluster connection.

Parameters

None.

Output

See DxResult.

Examples

Dx-GetConnectionInfo

Dx-GetContacts

Get a list of contacts.

Syntax

Dx-GetContacts [<CommonParameters>]


This cmdlet returns a list of contacts.

Parameters

None.

Output

See DxResult.

Examples

Dx-GetContacts

PS C:\> [xml]$xml = Dx-GetContacts | Select-Object -ExpandProperty Result

PS C:\> $xml.SelectNodes("//contact")

name email

---- -----

sales [email protected]

support [email protected]

info [email protected]

marketing [email protected]


Dx-GetCoordinators

Get a list of current coordinators.

Syntax

Dx-GetCoordinators [<CommonParameters>]


This cmdlet returns a list of the current cluster, application and storage coordinators.

Parameters

None.

Output

See DxResult.

Examples

Dx-GetCoordinators

Dx-GetCoordinatorStatus

Get status for the current cluster coordinator.

Syntax

Dx-GetCoordinatorStatus [<CommonParameters>]


This cmdlet returns the detailed status for the current cluster Coordinator.

Parameters

None.

Output

See DxResult.

Examples

Dx-GetCoordinatorStatus

Dx-GetCounters

Get system counters.

Syntax

Dx-GetCounters [<CommonParameters>]



This cmdlet returns a list of supported counters for DxEnterprise.

Parameters

None.

Output

See DxResult.

Examples

Dx-GetCounters

PS C:\> [xml]$xml = Dx-GetCounters | Select-Object -ExpandProperty Result

PS C:\> $xml.SelectNodes("//counter")

scope #text

----- -----

system system-down

system processor-consumption

system system-free-memory

system system-networking

system system-disk-io

instance instance-processor

instance instance-working-set

instance instance-networking

instance instance-disk-io

Dx-GetDiskDetail

Get detailed information from a specified disk.

Syntax

Dx-GetDiskDetail [-DiskID] <string> [<CommonParameters>]


This cmdlet returns the detail information from the specified disk.

Parameters


DiskID String The GUID Disk ID or disk label of the individual disk information is being requested about.

True True


Output

See DxResult.

Examples

Dx-GetDiskDetail “dad7b407-b77a-b98b-edbb-df64556eeb17”

Dx-GetDiskInfo

Get detailed information from a specified disk on a specified node.

Syntax

Dx-GetDiskInfo [-DiskID] <string> [[-NodeName] <string>] [<CommonParameters>]


This cmdlet returns the detail information from the specified disk on the specified node.

Parameters


DiskID String The GUID Disk ID or disk label of the individual disk information is being requested about.

True True

NodeName String Node name to retrieve the disk info from. The disk must be visible to the node specified.

False True

Output

See DxResult.

Examples

Dx-GetDiskInfo “dad7b407-b77a-b98b-edbb-df64556eeb17” “NODE1”

Dx-GetDisks

Get disk details organized by node.

Syntax

Dx-GetDisks [[-NodeName] <string>] [<CommonParameters>]


This cmdlet returns the disk information from the cluster or a specific node. If a node name is given only

information from that node is returned.

Parameters



NodeName String Node name to acquire the disk details from.

False True

Output

See DxResult.

Examples

Dx-GetDisks “NODE1”

Dx-GetDockerDetail

Get detailed information for a Docker container.

Syntax

Dx-GetDockerDetail [-VhostName] <string> [-DockerName] <string> [<CommonParameters>]


This cmdlet returns the detailed information regarding a Docker container that is currently managed by

DxEnterprise.

Parameters



DockerName String The name of the Docker container. True True

Output

See DxResult.

Examples

Dx-GetDockerDetail “VHOST1” “MSSQL1”

Dx-GetGlobalSettings

Get global settings.

Syntax

Dx-GetGlobalSettings [<CommonParameters>]


This cmdlet returns global settings that are explicitly set by the user.

Parameters


None.

Output

See DxResult.

Examples

Dx-GetGlobalSettings

Dx-GetInstanceDetail

Get detailed information for a SQL Server instance.

Syntax

Dx-GetInstanceDetail [-InstanceName] <string> [<CommonParameters>]


This cmdlet returns the detailed information regarding a SQL Server instance that is currently managed

by DxEnterprise.

Parameters


InstanceName String Target SQL Server instance name to be queried. The format is as follow:

1. Named Instance - <Vhost>\<InstanceName>

2. Default Instance - <Vhost>\MSSQLServer

True True

Output

See DxResult.

Examples

Dx-GetInstanceDetail “VHOST1\CUSTOMER”

Dx-GetLicense

Get a current license from a node.

Syntax

Dx-GetLicense [[-NodeName] <string>] [<CommonParameters>]


This cmdlet returns the license information from a node.


Parameters


NodeName String Node name to acquire the license from. Default is currently connected host.

False True

Output

See DxResult.

Examples

Dx-GetLicense “NODE1”

Dx-GetLicenseRequest

Get a current license request from a node.

Syntax

Dx-GetLicenseRequest [[-LicenseCode] <string>] [[-NodeName] <string>] [<CommonParameters>]


This cmdlet returns the license request information from a node.

Parameters


LicenseCode String License code to generate the license request. Default is blank. If not specified, license request is the existing one from the target node.

False True

NodeName String Node name to acquire the license request from. Default is the currently connected host.

False True

Output

See DxResult.

Examples

Get-LicenseRequest

Dx-GetLicenseRequest “0000-0000-0000-0000” “NODE1”


Dx-GetLicenses

Get a composite list of licenses from all nodes.

Syntax

Dx-GetLicenses [<CommonParameters>]


This cmdlet returns a composite list of licenses from all cluster member nodes.

Parameters

None

Output

See DxResult.

Examples

Dx-GetLicenses

Dx-GetMonitoredDockers

Get a list of all monitored Docker containers.

Syntax

Dx-GetMonitoredDockers [-NodeName] <string> [-DxHealth] [-DxReg] [<CommonParameters>]


This cmdlet returns a list of all monitored Docker containers by DxHealth and DxReg.

Parameters



DxHealth Switch Parameter

Whether or not to get list of monitored containers by DxHealth only.

False False

DxReg Switch Parameter

Whether or not to get list of monitored containers by DxReg only.

False False

Output

See DxResult.

Examples

Dx-GetMonitoredDockers “NODE1”


Dx-GetMonitoredFileShares

Get a list of all monitored fileshares.

Syntax

Dx-GetMonitoredFileShares [-NodeName] <string> [-DxHealth] [-DxReg] [<CommonParameters>]


This cmdlet returns a list of all monitored fileshares by DxHealth and DxReg.

Parameters




Whether or not to get list of monitored fileshares by DxHealth only.

False False


Whether or not to get list of monitored fileshares by DxReg only.

False False

Output

See DxResult.

Examples

Dx-GetMonitoredFileShares “NODE1”

Dx-GetMonitoredInstances

Get a list of all monitored SQL Server instances.

Syntax

Dx-GetMonitoredInstances [-NodeName] <string> [-DxHealth] [-DxReg] [<CommonParameters>]


This cmdlet returns a list of all monitored SQL Server instances by DxHealth and DxReg.

Parameters




Whether or not to get list of monitored instances by DxHealth only.

False False



Whether or not to get list of monitored instances by DxReg only.

False False

Output

See DxResult.

Examples

Dx-GetMonitoredIntances “NODE1”

Dx-GetMonitoredServices

Get a list of all monitored services.

Syntax

Dx-GetMonitoredServices [-NodeName] <string> [-DxHealth] [-DxReg] [<CommonParameters>]


This cmdlet returns a list of all monitored services by DxHealth and DxReg.

Parameters




Whether or not to get list of monitored services by DxHealth only.

False False


Whether or not to get list of monitored services by DxReg only.

False False

Output

See DxResult.

Examples

Dx-GetMonitoredServices “NODE1”

Dx-GetNodeDetail

Get a node detail.

Syntax

Dx-GetNodeDetail [-NodeName] <string> [<CommonParameters>]



This cmdlet returns system info for a cluster member node.

Parameters



Output

See DxResult.

Examples

Dx-GetNodeDetail “NODE1”

Dx-GetPolicies

Get a list of policies.

Syntax

Dx-GetPolicies [<CommonParameters>]


This cmdlet returns a list of policies currently configured for DxEnterprise.

Parameters

None

Output

See DxResult.

Examples

Dx-GetPolicies

Dx-GetPolicy

Get a policy detail.

Syntax

Dx-GetPolicy [-PolicyID] <string> [<CommonParameters>]


This cmdlet returns policy details.

Parameters



PolicyID String The ID of a policy. True True

Output

See DxResult.

Examples

Dx-GetPolicy "2D2E01D6-D912-4887-BAC0-9622CB1BE71E"

Dx-GetProductType

Get product type.

Syntax

Dx-GetProductType [<CommonParameters>]


This cmdlet returns the product type and version of the connected cluster.

Parameters

None

Output

See DxResult.

Examples

Dx-GetProductType

Dx-GetReservation

Get the SCSI reservations for a specific disk ID.

Syntax

Dx-GetReservation [-DiskID] <string> [<CommonParameters>]


This cmdlet returns the SCSI reservations for the specified DiskID.

Parameters


DiskID String The GUID Disk ID of the disk in which to query the reservations.

True True

Output

See DxResult.


Examples

Dx-GetReservation “dad7b407-b77a-b98b-edbb-df64556eeb17”

Dx-GetServiceDetail

Get service details.

Syntax

Dx-GetServiceDetail [-VhostName] <string> [-ServiceName] <string> [<CommonParameters>]


This cmdlet returns details about the specified service.

Parameters




Output

See DxResult.

Examples

Dx-GetServiceDetail “VHOST1" “ALG”

Dx-GetSMTP

Get SMTP settings for the cluster.

Syntax

Dx-GetSMTP [<CommonParameters>]


This cmdlet returns the SMTP configuration for the current cluster.

Parameters

None.

Output

See DxResult.

Dx-GetSQLPaths

Get SQL Server instance paths.


Syntax

Dx-GetSQLPaths [-InstanceName] <string> [<CommonParameters>]


This cmdlet returns the SQL Server instance start up path for master data, error log, and master log.

Parameters


InstanceName String The instance name in <Vhost>\<InstanceName> format.

True True

Output

See DxResult.

Examples

Dx-GetSQLPaths "VHOST1\CUSTOMER"

Dx-GetUnusedDriveLetters

Get a list of available drive letters.

Syntax

Dx-GetUnusedDriveLetters [-VolID] <string> [<CommonParameters>]


This cmdlet returns list of drive letters that are unused. If a volume ID is included, the drive letter for the

volume ID will be returned also.

Parameters


VolID String The GUID Volume ID. False True

Output

See DxResult.

Examples

Dx-GetUnusedDriveLetters "3caa25ce-3866-283c-1243-b48e92a6cd1d"

Dx-GetVersion

Get the DxLMonitor version.


Syntax

Dx-GetVersion [<CommonParameters>]


This cmdlet returns the current version of DxLMonitor being used.

Parameters

None

Output

See DxResult.

Examples

Dx-GetVersion

Dx-GetVhost

Get Vhost detail.

Syntax

Dx-GetVhost [-VhostName] <string> [<CommonParameters>]


This cmdlet returns the configuration of a specific Vhost, including the set of nodes associated with the

Vhost, and the set of instances, services or file shares associated with the Vhost.

Parameters



Output

See DxResult.

Examples

Dx-GetVhost "VHOST1"

Dx-GetVhosts

Get details for all Vhosts.

Syntax

Dx-GetVhosts [<CommonParameters>]



This cmdlet returns a complete contents of the cluster configuration (i.e. DxVhost.xml file).

Parameters

None

Output

See DxResult.

Examples

Dx-GetVhosts

Dx-GetVolumeDetail

Get the details of a specific volume.

Syntax

Dx-GetVolumeDetail [VolID] <string> [<CommonParameters>]


This cmdlet returns the details of the selected volume.

Parameters



Output

See DxResult.

Examples

Dx-GetVolumeDetail “3caa25ce-3866-283c-1243-b48e92a6cd1d”

Dx-InstallSQL

Install a Microsoft SQL Server instance.

Syntax

Dx-InstallSQL [-Nodes] <string> [-ExecutingCommand] <string> [[-CIFUserName] <string>] [[CIFPassword]

<string>] [[-ConfigFile] <string>] [-EncryptedPassword] [-IsSQL2005] [<CommonParameters>]


This cmdlet pushes an unattended installation of SQL Server instance to specified nodes. The instance

will not be virtualized automatically; see documentation for the add-instance command. Full command

line must be provided for the installer and the path to the installer must be accessible on all nodes

involved. Valid unattended commands and syntax for SQL Server can be found at:


a. SQL2005 unattended setup:

o http://msdn.microsoft.com/en-us/library/ms144259(v=SQL.90).aspx

b. SQL2008 unattended setup:


c. SQL2008R2 unattended setup:


d. SQL2012 unattended setup:


e. SQL2014 unattended setup:


f. SQL2016 unattended setup:


Parameters


Nodes String A list of nodes to execute the unattended SQL Server installation. Delimited by comma.

True True

ExecutingCommand String Subsequent <string> parameters after the Nodes list to form proper unattended SQL Server installation command.

True True

CIFSUserName String SQL Server Login username. False True

CIFSPassword String SQL Server Password. False True

ConfigFile String Path to file with detail install meta data

False True



False False

IsSQL2005 Switch Parameter

Specifies if the instance being installed is SQL Server 2005. Default is false.

False False

Output

See DxResult.

Examples

Dx-InstallSQL "NODE1,NODE2 " <Executing commands>

http://msdn.microsoft.com/en-us/library/ms144259(v=SQL.90).aspx











Dx-JoinCluster

Joins a new node to an existing cluster.

Syntax

Dx-JoinCluster [-ServerName] <string> -Passkey <string> -NatEnabled [-Activate]



This cmdlet removes the currently connected node from any existing cluster and adds it to the cluster of

the specified server.

Parameters


ServerName String The target member server of the cluster to join the currently connected node.

True True

Passkey String The configured cluster passkey of the target cluster member.

True True

NatEnabled Switch Parameter

For internal use only. False False

Activate Switch Parameter

Whether or not to activate the node after joining the new cluster.

False False

Output

See DxResult.

Examples

Dx-JoinCluster “NODE1” -Passkey “Pa$$word!” –Activate

Dx-ReloadMonitoredApps

Reloads the list of monitored apps.

Syntax

Dx-ReloadMonitoredApps [-NodeName] <string> [-DxHealth] [-DxReg] [<CommonParameters>]


This cmdlet reloads the list of monitored applications on the specified node.


Parameters


NodeName String The target node where DxHealth and/or DxReg must re-evaluate and monitor the active apps.

True True


Whether or not only DxHealth should reload.

False False


Whether or not only DxReg should reload.

False False

Output

See DxResult.

Examples

Dx-ReloadMonitoredApps “NODE1”

Dx-RefreshMonitoredPaths

Refresh the list of monitored paths

Syntax

Dx-RefreshMonitoredPaths [<CommonParameters>]


This cmdlet rechecks the system for all Data, Log and fileshare paths and makes sure an alert is raised if

a path is inaccessible by any cluster member nodes.

Parameters

None

Output

See DxResult.

Examples

Dx-RefreshMonitoredPaths

Dx-ReloadMonitoredDockers

Reload the list of monitored Docker containers.

Syntax

Dx-ReloadMonitoredDockers [-NodeName] <string> [-DxHealth] [-DxReg] [<CommonParameters>]



This cmdlet re-evaluates the list of active Docker containers and ensures DxHealth and/or DxReg

monitor them.

Parameters


NodeName String The target node where DxHealth and/or DxReg must re-evaluate and monitor the active containers.

True True



False False



False False

Output

See DxResult.

Examples

Dx-ReloadMonitoredDockers “NODE1”

Dx-ReloadMonitoredFileShares

Reload the list of monitored fileshares.

Syntax

Dx-ReloadMonitoredFileShares [-NodeName] <string> [-DxHealth] [-DxReg] [<CommonParameters>]


This cmdlet re-evaluates the list of active fileshares and ensures DxHealth and/or DxReg monitor them.

Parameters


NodeName String The target node where DxHealth and/or DxReg must re-evaluate and monitor the active fileshares.

True True



False False



False False

Output


See DxResult.

Examples

Dx-ReloadMonitoredFileShares “NODE1”

Dx-ReloadMonitoredInstances

Reload the list of monitored SQL Server instances.

Syntax

Dx-ReloadMonitoredInstances [-NodeName] <string> [-DxHealth] [-DxReg] [<CommonParameters>]


This cmdlet re-evaluates the list of active SQL Server instances and ensures DxHealth and/or DxReg

monitor them.

Parameters


NodeName String The target node where DxHealth and/or DxReg must re-evaluate and monitor the active instances.

True True



False False



False False

Output

See DxResult.

Examples

Dx-ReloadMonitoredInstances “NODE1”

Dx-ReloadMonitoredServices

Reload the list of monitored services.

Syntax

Dx-ReloadMonitoredServices [-NodeName] <string> [-DxHealth] [-DxReg] [<CommonParameters>]


This cmdlet re-evaluates the list of active services and ensures DxHealth and/or DxReg monitor them.

Parameters



NodeName String The target node where DxHealth and/or DxReg must re-evaluate and monitor the active services.

True True



False False



False False

Output

See DxResult.

Examples

Dx-ReloadMonitoredServices “NODE1”

Dx-RelocateSystemDatabases

Relocate system databases to a new location.

Syntax

Dx-RelocateSystemDatabases [-InstanceName] <string> -Datapath <string> -Logpath <string> [-Msdb] [-

Tempdb] [-Model] [<CommonParameters>]


This cmdlet relocates the master, msdb, model, and tempdb database to a new location.

Parameters


InstanceName String The target instance to be relocated. Valid format is <Vhost>\<InstanceName>.

True True

DataPath String New location for Data. True True

LogPath String New location for Logs. True True

Msdb Switch Parameter

Whether or not to relocate msdb database.

False False

Tempdb Switch Parameter

Whether or not to relocate tempdb database.

False False

Model Switch Parameter

Whether or not to relocate model database.

False False

Output

See DxResult.


Examples

Dx-RelocateSystemDatabases “VHOST1\CUSTOMER” “D:\Sqldata\CUSTOMER\Data”

“D:\Sqldata\CUSTOMER\Logs”

Dx-RemoveClusterMember

Remove a cluster member.

Syntax

Dx-RemoveClusterMember [-ServerName] <string> [<CommonParameters>]


This cmdlet removes a member from the cluster.

Parameters


ServerName String The target node to be removed from the cluster.

True True

Output

See DxResult.

Examples

Dx-RemoveClusterMember “NODE1”

Dx-RemoveContact

Remove a contact from address book.

Syntax

Dx-RemoveContact [-Name] <string> [<CommonParameters>]


This cmdlet removes a contact from the address book.

Parameters


Name String The contact to be removed from the address book.

True True

Output

See DxResult.


Examples

Dx-RemoveContact “support”

Dx-RemoveDisk

Remove a disk from the cluster.

Syntax

Dx-RemoveDisk [-DiskID] <string> [<CommonParameters>]


This cmdlet removes the disk from DxEnterprise management.

Parameters



Output

See DxResult.

Examples

Dx-RemoveDisk “3caa25ce-3866-283c-1243-b48e92a6cd1d”

Dx-RemoveDocker

Remove a Docker container from a Vhost.

Syntax

Dx-RemoveDocker [-VhostName] <string> [-DockerName] <string> [<CommonParameters>]


This cmdlet removes the Docker container from the specified Vhost.

Parameters




True True

Output

See DxResult.

Examples


Dx-RemoveDocker “VHOST1” “MSSQL1”

Dx-RemoveFileshare

Remove a fileshare from the cluster.

Syntax

Dx-RemoveFileshare [-VhostName] <string> [-ShareName] <string> [<CommonParameters>]


This cmdlet removes a fileshare from a Vhost. The Windows file share will be removed on all nodes

associated with the Vhost.

Parameters



ShareName String The name of the fileshare. True True

Output

See DxResult.

Examples

Dx-RemoveFileShare “VHOST1” “SHARE1”

Dx-RemoveGlobalSetting

Remove a global setting from the cluster.

Syntax

Dx-RemoveGlobalsetting [[-Name] <string>] [-ClusterDescription] [-IntervalProcessor] [-IntervalMemory]

[-IntervalDisk] [-IntervalNetwork] [-FileSystemTimeout] [-PingTimeout] [-PathRecheckTimeout] [-

VhostRetryTimeout] [-DelayStopNode] [-DelayStartNode] [-AllocatorEnabled] [-AllocatorAlerts] [-

RelayBroadcast] [-PassKey] [-WitnessPath] [-WitnessUser] [-WitnessUserPassword] [-DismountTimeout]

[-DockerTimeout] [-GratuitousARP] [-IntervalReservationCheck] [-IoTimeout] [-MaxProcesses] [-

PathWatcher] [-PerfBroadcastEnabled] [-ScriptTimeout] [-VdsWait] [-VolumeTimeout] [-AgsTimeout]



This cmdlet removes a user defined global setting value and resets it back to its default value.

Parameters



Name String The target setting name to be removed.

False False

ClusterDescription Switch Parameter

Whether or not to remove the cluster description.

False False

IntervalProcessor Switch Parameter

Whether or not to reset the sampling duration in seconds that the average is calculated for CPU. When set, the system defaults back to 120 seconds.

False False

IntervalMemory Switch Parameter

Whether or not to reset the sampling duration in seconds that the average is calculated for Memory. When set, the system defaults back to 1 seconds.

False False

IntervalDisk Switch Parameter

Whether or not to reset the sampling duration in seconds that the average is calculated for Disk I/O. When set, the system defaults back to 120 seconds.

False False

IntervalNetwork Switch Parameter

Whether or not to reset the sampling duration in seconds that the average is calculated for Network throughput. When set, the system defaults back to 120 seconds.

False False

FileSystemTimeout Switch Parameter

Whether or not to reset the timeout in seconds that the system waits for filesystem accessibility before taking actions. When set, the system defaults back to 120 seconds.

False False

PingTimeout Switch Parameter

Whether or not reset the timeout in seconds that the system waits for ping to complete before taking actions. When set, the system defaults back to 9 seconds.

False False

PathRecheckTimeout Switch Parameter

Whether or not to reset the number of seconds between the system attempts to check the inaccessible application paths. When set, the system defaults back to 120 seconds.

False False

VhostRetryTimeout Switch Parameter

Whether or not to reset the number of seconds between

False False


the system retries to start a Vhost after the last start-node failure. When set, the system defaults back to 120 seconds.

DelayStopNode Switch Parameter

Whether or not to reset the short delay in seconds that the system waits after stop-node operation to avoid duplicate IP address. When set, the system defaults back to 2 seconds.

False False

DelayStartNode Switch Parameter

Whether or not to reset the short delay in seconds that the system waits after add-ip operation. When set, the system defaults back to 4 seconds.

False False

AllocatorEnabled Switch Parameter

Whether or not to enable Allocation policies. Default is true.

False False

AllocatorAlerts Switch Parameter

Whether or not to raise alerts for Allocation policies. Default is true.

False False

RelayBroadcast Switch Parameter

Whether or not to support relay broadcast messages. Default is true.

False False

Passkey Switch Parameter

Whether or not to reset the passkey value. When set, the system clears and sets the current passkey for the cluster as empty. If a passkey is changed when one or more cluster nodes are unavailable or temporarily down, those nodes will be unable to join the cluster when they become available.

False False

WitnessPath Switch Parameter

Whether or not to reset the network share paths for Witness. When set, the system clears all path values.

False False

WitnessUser Switch Parameter

Whether or not to reset the User name for the Witness. When set, the system clears the credential.

False False

WitnessUserPassword Switch Parameter

Whether or not to reset the Password for the Witness. When set, the system clears the credential password.

False False


DismountTimeout Switch Parameter

Whether or not to reset timeout in seconds that the system waits for file handles to be closed on a volume before performing a forced dismount. When set, the system defaults back to 15 seconds.

False False

DockerTimeout Switch Parameter

Whether or not to reset the timeout in seconds that the system waits for a Docker container to return the running state when adding a container to a Vhost. When set, the system defaults back to 5 seconds.

False False

GratuitousARP Switch Parameter

Whether or not to enable sending gratuitous ARP. Default is false.

False False

IntervalReservationCheck Switch Parameter

Whether or not to reset the sampling duration in seconds that the system rechecks the reservation. When set, the system defaults back to 5 seconds.

False False

IoTmeout Switch Parameter

Whether or not to reset the timeout in seconds that the system waits for I/O API call to complete. When set, the system defaults back to 15 seconds.

False False

MaxProcesses Switch Parameter

Whether or not to reset the number of processes the system allows to be worked on in parallel. When set, the system defaults back to 10.

False False

PathWatcher Switch Parameter

Whether or not to enable Pathwatcher. Default is true.

False False

PerfBroadcastEnabled Switch Parameter

Whether or not to enable performance statistics broadcast. True via UDP. False via TCP. Default is false.

False False

ScriptTimeout Switch Parameter

Whether or not to reset the timeout in seconds that the system waits for a pre/post script to complete before taking actions. When set, the system defaults back to 300 seconds.

False False


VdsWait Switch Parameter

Whether or not to reset the timeout in seconds that the system will wait for a PnP-enumerated disk or volume to be noticed by VDS and reported. When set, the system defaults back to 15 seconds.

False False

VolumeTimeout Switch Parameter

Whether or not to reset the timeout in seconds that the system waits for a volume PnP device to appear after setting a disk to the online state. When set, the system defaults back to 15 seconds.

False False

AgsTimeout Integer The timeout in seconds that the system waits for an availability group to finish virtualizing.

False False

Output

See DxResult.

Examples

Dx-RemoveGlobalSetting -InternalProcessor

Dx-RemoveInstance

Remove an instance from a Vhost.

Syntax

Dx-RemoveInstance [-InstanceName] <string> [<CommonParameters>]


This cmdlet removes a named instance of SQL Server from a Vhost. Database files and log files on the

SAN are not modified or deleted by this process.

Parameters


InstanceName String The target instance name to be removed. Valid format is <Vhost>\<InstanceName>.

True True

Output

See DxResult.


Examples

Dx-RemoveInstance “VHOST1\CUSTOMER”

Dx-RemoveNode

Remove node(s) from a Vhost.

Syntax

Dx-RemoveNode [-VhostName] <string> [-Nodes] <string> [<CommonParameters>]


This cmdlet removes node(s) from a Vhost.

Parameters



Nodes String A set of nodes to be removed. Delimited by comma.

True True

Output

See DxResult.

Examples

Dx-RemoveNode “VHOST1” “NODE1,NODE2”

Dx-RemovePolicy

Remove a policy from the cluster.

Syntax

Dx-RemovePolicy [-SYSTEM] [-PolicyID] <string> [<CommonParameters>]

Dx-RemovePolicy [-PERF] [-PolicyID] <string> [<CommonParameters>]

Dx-RemovePolicy [-ALLOC] [-PolicyID] <string> [<CommonParameters>]

Dx-RemovePolicy [-FILTER] [-PolicyID] <string> [<CommonParameters>]


This cmdlet removes a policy from the cluster.

Parameters



Whether or not a SYSTEM type policy.

True True



Whether or not a PERF type policy.

True True


Whether or not a ALLOC type policy.

True True


Whether or not a FILTER type policy.

True True

PolicyID String The policy ID to be removed. True True

Output

See DxResult.

Examples

Dx-RemovePolicy -SYSTEM “NODE1”

Dx-RemovePolicy -PERF “CPU_CUSTOMER_80PC”

Dx-RemovePolicy -ALLOC “2D2E01D6-D912-4887-BAC0-9622CB1BE71E”

Dx-RemovePolicy -FILTER “D338E9DB-BA30-49C4-8A93-7C12AA1FC26A”

Dx-RemoveScript

Remove a script from an instance or Vhost.

Syntax

Dx-RemoveScript [-Name] <string> [-ScriptName] {PreStart | PostStart | PreStop | PostStop} [-

InstanceScriptType] [-VhostScriptType] [<CommonParameters>]


This cmdlet removes a PreStart, PostStart, PreStop or PostStop script from a SQL Server instance or

Vhost.

Parameters


Name String The target Vhost name or instance name. Valid value is <Vhost> or <Vhost>\<InstanceName>.

True True

ScriptName String Specifies whether it is a PreStart, PostStart, PreStop or PostStop script.

True True

InstanceScriptType Switch Parameter

Whether or not the script is at the Instance level. Default is true.

False False

VhostScriptType Switch Parameter

Whether or not the script is at the Vhost level. Default is false.

False False


Output

See DxResult.

Examples

Dx-RemoveScript “VHOST1” “PreStart” –VhostScriptType

Dx-RemoveService

Remove a service from a Vhost.

Syntax

Dx-RemoveService [-VhostName] <string> [-ServiceName] <string> [<CommonParameters>]


This cmdlet removes a service from a Vhost.

Parameters




Output

See DxResult.

Examples

Dx-RemoveService “VHOST1” “ALG”

Dx-RemoveSMTP

Remove a SMTP configuration from the cluster.

Syntax

Dx-RemoveSMTP [-ServerName] <string> [<CommonParameters>]


This cmdlet removes the SMTP configuration from the cluster.

Parameters


ServerName String The target server name to be removed.

True True


Output

See DxResult.

Examples

Dx-RemoveSMTP “smtp.dh2i.com”

Dx-RemoveVhost

Remove a Vhost.

Syntax

Dx-RemoveVhost [-VhostName] <string> [<CommonParameters>]


This cmdlet removes a Vhost from the cluster configuration.

Parameters



Output

See DxResult.

Examples

Dx-RemoveVhost “VHOST1”

Dx-RescanDisk

Rescan disk properties.

Syntax

Dx-RescanDisk [[-DiskID] <string>] [<CommonParameters>]


This cmdlet instructs the cluster to re-evaluate disk layout signature for all disks or a specific disk.

Parameters


DiskID String The GUID Disk ID(s) or disk label(s). Delimited by pipe (|).

False True

Output


See DxResult.

Examples

Dx-RescanDisk “3caa25ce-3866-283c-1243-b48e92a6cd1d”

Dx-RestartGroupCommunicationEx

Restart cluster group communication.

Syntax

Dx-RestartGroupCommunicationEx [<CommonParameters>]


This cmdlet restarts cluster group communications. This is an internal cmdlet to force the cluster to re-

establish cluster member communication channels.

Parameters

None

Output

See DxResult.

Examples

Dx-RestartGroupCommunicationEx

Dx-SetAppCoordinator

Set a cluster member node to be the new application coordinator.

Syntax

Dx-SetAppCoordinator [-Name] <string> [<CommonParameters>]


This cmdlet assigns application coordinator role to a cluster member node.

Parameters


Name String The target node name to be the new application coordinator.

True True

Output

See DxResult.

Examples


Dx-SetAppCoordinator “NODE1”

Dx-SetClusterID

Set a new cluster ID.

Syntax

Dx-SetClusterID [[-NewGUID] <string>] [<CommonParameters>]


This cmdlet assigns a new cluster ID.

Parameters


NewGUID String The new GUID to be used as the cluster ID. Default is system generated.

False True

Output

See DxResult.

Examples

Dx-SetClusterID

Dx-SetClusterID “A66E9911-8F30-400C-9A48-FE543E129E68”

Dx-SetCoordinator

Set a cluster member node to be the new cluster coordinator.

Syntax

Dx-SetCoordinator [-Name] <string> [<CommonParameters>]


This cmdlet assigns cluster coordinator role to a cluster member node.

Parameters


Name String The target node name to be the new cluster coordinator.

True True

Output

See DxResult.


Examples

Dx-SetCoordinator “NODE1”

Dx-SetDepends

Defines the startup order of services in a list of dependencies.

Syntax

Dx-SetDepends [-VhostName] <string> [-AppName] <string> [-DependsList] <string>



This cmdlet defines the startup order of services in a list of dependencies. When an instance or service is

depending on another instances or services, it would not start up until the depended on instances or

services start up first. If a circular reference is set for the dependencies (i.e. instance1 depends on

service1, and service1 depends on instance1), the system will break the dependency tree and revert

back to default behavior as if there is not a dependency set.

Parameters



AppName String The application type followed by a colon (:) and the name of the application. Valid types are SQL, SVC, VFS and DCK.

True True

DependsList String A comma (,) delimited list of services in startup order, or an empty string to clear.

True True

Output

None.

Examples

Dx-SetDepends “VHOST1” “SQLBrowser” “SQL:INSTANCE1”

Dx-SetDiskLabel

Update the disk label.

Syntax

Dx-SetDiskLabel [-DiskID] <string> [-Label] <string> [<CommonParameters>]



This cmdlet updates the disk label.

Parameters



Label String The new label name. True True

Output

See DxResult.

Examples

Dx-SetDiskLabel “3caa25ce-3866-283c-1243-b48e92a6cd1d” “Dx Cluster Disk 1”

Dx-SetDockerDescription

Update the Docker container description.

Syntax

Dx-SetDockerDescription [-DockerName] <string> [[-Description] <string>] [<CommonParameters>]


This cmdlet updates the description of a Docker container.

Parameters


DockerName String The name of the container. True True


Output

See DxResult.

Examples

Dx-SetDockerDescription “MSSQL1” “SQL Server Container”

Dx-SetFailback

Set failback option for a Vhost.

Syntax

Dx-SetFailback [-VhostName] <string> -AutoFailback [<CommonParameters>]



This cmdlet enables or disables autofailback for a Vhost.

Parameters



AutoFailback Switch Parameter

Enable or disable autofailback for the Vhost.

True True

Output

See DxResult.

Examples

Dx-SetFailback “VHOST1” $true

Dx-SetGlobalSetting

Set global setting value(s).

Syntax

Dx-SetGlobalsetting [-AllocatorEnabled <bool>] [-AllocatorAlerts] [-RelayBroadcast] [-Name <string>] [-

Value <string>] [-ClusterDescription <string>] [-IntervalProcessor <int>] [-IntervalMemory <int>] [-

IntervalDisk <int>] [-IntervalNetwork <int>] [-FileSystemTimeout <int>] [-PingTimeout <int>] [-

PathRecheckTimeout <int>] [-VhostRetryTimeout <int>] [-DelayStopNode <int>] [-DelayStartNode <int>]

[-PassKey <string>] [-WitnessPath <string>] [-WitnessUser <string>] [-WitnessUserPassword <string>] [-

DismountTimeout <int>] [-DockerTimeout <int>] [-GratuitousARP] [-IntervalReservationCheck <int>] [-

IoTimeout <int>] [-MaxProcesses <int>] [-PathWatcher] [-PerfBroadcastEnabled] [-ScriptTimeout <int>]

[-VdsWait <int>] [-VolumeTimeout <int>] [-AgsTimeout] [<CommonParameters>]


This cmdlet sets global setting values for the cluster.

Parameters


AgsTimeout Integer The timeout in seconds that the system waits for an availability group to finish virtualizing.

False False

AllocatorAlerts Switch Parameter

Whether or not to raise alerts for allocation policies.

False False

AllocatorEnabled Bool Whether or not to enable allocation policies.

False False


ClusterDescription String The cluster description to be set.

False False

DelayStartNode Integer The short delay in seconds that the system waits after add-ip operation.

False False

DelayStopNode Integer The short delay in seconds that the system waits after stop-node operation to avoid duplicate IP address.

False False

DismountTimeout Integer The timeout in seconds that the system waits for file handles to be closed on a volume before performing a forced dismount.

False False

DockerTimeout Integer The timeout in seconds that the system waits for a Docker container to return the running state when adding a container to a Vhost.

False False

FileSystemTimeout Integer The timeout in seconds that the system waits for filesystem accessibility before taking actions.

False False

GratuitousARP Switch Parameter

Enable or Disable sending gratuitous ARP.

False False

IntervalDisk Integer The sampling duration in seconds that the average is calculated for Disk I/O.

False False

IntervalMemory Integer The sampling duration in seconds that the average is calculated for Memory.

False False

IntervalNetwork Integer The sampling duration in seconds that the average is calculated for Network throughput.

False False

IntervalProcessor Integer The sampling duration in seconds that the average is calculated for CPU.

False False

IntervalReservationCheck Integer The sampling duration in seconds that the system rechecks the reservation.

False False

IoTimeout Integer The timeout in seconds that the system waits for I/O API call to complete.

False False


MaxProcesses Integer The number of processes the system allows to be worked on in parallel.

False False

Name String The target setting name to be set. Internal use.

False False

Passkey String The passkey value. Setting a passkey enables encryption of network data and prevents nodes from joining the cluster that do not have the same passkey configured. If an empty passkey is set, the passkey is removed. If a passkey is set when one or more cluster nodes are unavailable or temporarily down, those nodes will be unable to join the cluster when they become available.

False False

PathRecheckTimeout Integer The number of seconds between the system attempts to check the inaccessible application paths.

False False

PathWatcher Switch Parameter

Enable or Disable Pathwatcher.

False False

PerfBroadcastEnabled Switch Parameter

Enable or Disable performance statistics broadcast. True via UDP. False via TCP.

False False

PingTimeout Integer The timeout in seconds that the system waits for ping to complete before taking actions.

False False

RelayBroadcast Switch Parameter

Whether or not to support relay broadcast messages.

False False

ScriptTimeout Integer The timeout in seconds that the system waits for a pre/post script to complete before taking actions.

False False

Value String The target value for the Name setting. Internal use.

False False

VdsWait Integer The timeout in seconds that the system will wait for a PnP-enumerated disk or volume to be noticed by VDS and reported.

False False


VhostRetryTimeout Integer The number of seconds between the system retries to start a Vhost after the last start-node failure.

False False

VolumeTimeout Integer The timeout in seconds that the system waits for a volume PnP device to appear after setting a disk to the online state.

False False

WitnessPath String The network share paths for Witness. Delimited by comma.

False False

WitnessUser String The User name to access the witness share paths.

False False

WitnessUserPassword String The Password to access the witness share paths.

False False

Output

See DxResult.

Examples

Dx-SetGlobalSetting -ClusterDescription “Dx Cluster”

Dx-SetInstanceDescription

Set a description for an instance.

Syntax

Dx-SetInstanceDescription [-InstanceName] <string> [[-Description] <string>] [<CommonParameters>]


This cmdlet sets a description for an instance of SQL Server.

Parameters


InstanceName String The instance name. Valid value is <Vhost>\<InstanceName>.

True True

Description String User defined description. False True

Output

See DxResult.

Examples

Dx-SetInstanceDescription “VHOST1\CUSTOMER” “Customer Instance”


Dx-SetLicense

Activate a node.

Syntax

Dx-SetLicense [-LicenseCode] <string> [[-NodeName] <string>] [<CommonParameters>]

Dx-SetLicense [-LicenseCode] <string> [[-NodeName] <string>] -Manual -Answer <string>



This cmdlet activates the node with a license code either automatically if the node is connected to the

internet or manually if the node is not connected to the internet.

Parameters


LicenseCode String The assigned license code to be used to activate the node.

True True

NodeName String The target node name to be activated. Default is localhost if not specified.

False True

Manual Switch Parameter

Whether or not a manual activation. If set, the Answer must be provided.

False False

Answer String The Answer value obtained from DH2i portal when the target node is not connected to the internet.

False False

Output

See DxResult.

Examples

Dx-SetLicense “0000-0000-0000-0000” “NODE1”

Dx-SetMountpoint

Mount a volume to a mountpoint.

Syntax

Dx-SetMountpoint [-VolID] <string> [[-MountPath] <string>] [<CommonParameters>]



This cmdlet defines the mountpoint(s) for a volume.

Parameters



MountPath String The path(s) to mount the volume delimited by comma (,).

False False

Output

None.

Examples

Dx-SetMountpoint “3caa25ce-3866-283c-1243-b48e92a6cd1d” “C:\MountPoint1”

Dx-SetScript

Configure a script for an instance or Vhost.

Syntax

Dx-SetScript [-Name] <string> [-ScriptName] {PreStart | PostStart | PreStop | PostStop} [-FileName]

<string> [-InstanceScriptType] [-VhostScriptType] [<CommonParameters>]


This cmdlet sets a PreStart, PostStart, PreStop or Poststop script for an instance of SQL Server or a

Vhost.

Parameters



True True

ScriptName String Whether it is a PreStart, PostStart, PreStop, or PostStop script.

True True

FileName String The full path to the script file. The script must be located at a path accessible on all nodes.

True True



False False



False False


Output

See DxResult.

Examples

Dx-SetScript “VHOST1” “PreStart” “C:\utility\get_processes.cmd” -VhostScriptType

Dx-SetScriptEmbedded

Configure an embedded script for an instance or Vhost.

Syntax

Dx-SetScriptEmbedded [-Name] <string> [-ScriptName] {PreStart | PostStart | PreStop | PostStop} [-

ScriptContent] <string> [-ScriptExtension] <string> [-InstanceScriptType] [-VhostScriptType]



This cmdlet sets an embedded PreStart, PostStart, PreStop or PostStop script for an instance of SQL

Server or a Vhost. The advantage of having an embedded script is that it is part of the cluster

configuration and is always available to the cluster member nodes.

Parameters



True True

ScriptName String Whether it is a PreStart, PostStart, PreStop, or PostStop script.

True True

ScriptContent String The script content to be embedded into the cluster configuration.

True True

ScriptExtension String The file extension. E.g. CMD, BAT, PS1.

True True



False False



False False

Output

See DxResult.


Examples

Dx-SetScriptEmbedded “VHOST1” “PreStart” “echo %computername%” “CMD” -VhostScriptType

Dx-SetSecret

Set a passkey for the cluster.

Syntax

Dx-SetSecret [[-Passkey] <string>] [<CommonParameters>]


This cmdlet sets a passkey. Setting a passkey enables encryption of network data and prevents nodes

from joining the cluster that do not have the same passkey configured. If an empty passkey is set, the

passkey is removed. If a passkey is set when one or more cluster nodes are unavailable or temporarily

down, those nodes will be unable to join the cluster when they become available.

Parameters


Passkey String The passkey value. False True

Output

See DxResult.

Examples

Dx-SetSecret “Pa$$word!”

Dx-SetServer

Define connecting server info.

Syntax

Dx-SetServer [-EncryptedPasskey] [-UseTLS] [-Server <string>] [-Passkey <string>] [-TCPPort <int>] [-

Force] [<CommonParameters>]


This cmdlet defines the connection info for the Powershell session.

Parameters


EncryptedPasskey Switch Parameter

Whether or not the supplied passkey value is an encrypted string obtained from Dx-

False False


EncryptText cmdlet. Default is false.

UseTLS Switch Parameter

Enables TLS communication to authenticate by certificate.

False False

Server String The target node name to connect to. Default is localhost.

False False

Passkey String The passkey to be used to connect to the target server. Default is empty.

False False

TCPPort Integer The connecting TCP port of the target server. Default is 7979.

False False

Force Switch Parameter

Required if the passkey parameter is used.

False False

Output

None.

Examples

Dx-SetServer -Server “NODE1”

Dx-SetStorCoordinator

Set a cluster member node to be the new storage coordinator.

Syntax

Dx-SetStorCoordinator [-NodeName] <string> [<CommonParameters>]


This cmdlet assigns the storage coordinator role to a cluster member node.

Parameters


NodeName String The target node name to be the new storage coordinator.

True True

Output

See DxResult.

Examples

Dx-SetStorCoordinator “NODE1”

Dx-SetVhostPriority

Set priority for a Vhost.


Syntax

Dx-SetVhostPriority [-VhostName] <string> [-Priority] <int> [<CommonParameters>]


This cmdlet sets a priority value for a Vhost.

Parameters



Priority Integer Vhost priority relative to other Vhosts in the cluster. Valid values are between 1 and 5. With 1 being the lowest or least prioritized.

True True

Output

See DxResult.

Examples

Set-VhostPriority “VHOST1” 3

Dx-SetVolumeLabel

Set a new label for the specified volume.

Syntax

Dx-SetVolumeLabel [-VolID] <string> [-VolumeLabel] <string> [<CommonParameters>]


This cmdlet renames the specified volume with the new label.

Parameters



VolumeLabel String The new label of the volume. True True

Output

See DxResult.

Examples

Dx-SetVolumeLabel “3caa25ce-3866-283c-1243-b48e92a6cd1d” “ClusterVolOne”


Dx-ShrinkVolume

Shrink the volume size.

Syntax

Dx-ShrinkVolume [-VolID] <string> [-ToShrinkBy] <string> [<CommonParameters>]


This cmdlet shrinks the volume by the ‘ToShrinkBy’ size.

Parameters



ToShrinkBy String The size in bytes in which to shrink the volume by.

True True

Output

See DxResult.

Examples

Dx-ShrinkVolume “3caa25ce-3866-283c-1243-b48e92a6cd1d” “1048576”

Dx-StartDisk

Bring a disk online on a node.

Syntax

Dx-StartDisk [-DiskID] <string> [-NodeName] <string> [<CommonParameters>]


This cmdlet brings a disk online on a node. If the disk is online previously, the cluster will set if offline on

that node prior to bringing it online on the specified node.

Parameters



NodeName String The name of the node to start the specified disk.

True True

Output

See DxResult.


Examples

Dx-StartDisk “3caa25ce-3866-283c-1243-b48e92a6cd1d” “NODE1”

Dx-StartDiskAssociates

Starts a disk and all associated disks.

Syntax

Dx-StartDiskAssociates [-DiskID] <string> [-NodeName] <string> [<CommonParameters>]


This cmdlet starts a disk on the specified node. If the disk is part of a volume set, the system will start all

associated disks as well.

Parameters



NodeName String The name of the node to start the specified disk.

True True

Output

See DxResult.

Examples

Dx-StartDiskAssociates “3caa25ce-3866-283c-1243-b48e92a6cd1d” “NODE1”

Dx-StartDiskGroup

Administratively bring disk group(s) online on a specified node of a Vhost.

Syntax

Dx-StartDiskGroup [-VhostName] <string> [-NodeName] <string> [<CommonParameters>]


This cmdlet administratively brings diskgroup(s) online on a specified node of a Vhost. Applications

running on the previous node may be affected when the diskgroup(s) become offline/unavailable on the

previous node.

Parameters




NodeName String The name of the node to start the diskgroup.

True True

Output

See DxResult.

Examples

Dx- StartDiskGroup “VHOST1” “NODE1”

Dx-StartDocker

Start a Docker container on a Vhost.

Syntax

Dx-StartDocker [-VhostName] <string> [-DockerName] <string> [<CommonParameters>]


This cmdlet starts a Vhost and all associated Docker containers on a specific node.

Parameters



DockerName String The name of the container. True True

Output

See DxResult.

Examples

Dx-StartService “VHOST1” “MSSQL1”

Dx-StartInstance

Start an instance of SQL Server.

Syntax

Dx-StartInstance [-InstanceName] <string> [<CommonParameters>]


This cmdlet starts a named instance of SQL Server. The instance will be started on whichever node is

currently hosting the instance’s Vhost. If the instance is administratively disabled, it will be enabled.

Parameters



InstanceName String The target instance name. Valid value is <Vhost>\<InstanceName>.

True True

Output

See DxResult.

Examples

Dx-StartInstance “VHOST1\CUSTOMER”

Dx-StartService

Start a service on a Vhost.

Syntax

Dx-StartService [-VhostName] <string> [-ServiceName] <string> [<CommonParameters>]


This cmdlet starts a Vhost and all associated services on a specific node.

Parameters




Output

See DxResult.

Examples

Dx-StartService “VHOST1” “ALG”

Dx-StartVolume

Start volume on a node.

Syntax

Dx-StartVolume [-VolID] <string> [-NodeName] <string> [<CommonParameters>]


This cmdlet starts a volume on a specific node.


Parameters




Output

See DxResult.

Examples

Dx-StartVolume “3caa25ce-3866-283c-1243-b48e92a6cd1d” “NODE1”

Dx-StopDisk

Take a disk offline.

Syntax

Dx-StopDisk [-DiskID] <string> [<CommonParameters>]


This cmdlet takes a disk offline.

Parameters


DiskID String The GUID Disk ID or disk label of the disk to take offline.

True True

Output

See DxResult.

Examples

Dx-StopDisk “3caa25ce-3866-283c-1243-b48e92a6cd1d”

Dx-StopDiskAssociates

Take a disk and all associated disks offline.

Syntax

Dx-StopDiskAssociates [-DiskID] <string> [<CommonParameters>]


This cmdlet takes a disk offline. If the disk is part of a volume set, the system will take all associated

disks, as part of the volume, offline also.


Parameters


DiskID String The GUID Disk ID or disk label of the disk to take offline.

True True

Output

See DxResult.

Examples

Dx-StopDiskAssociates “3caa25ce-3866-283c-1243-b48e92a6cd1d”

Dx-StopDiskGroup

Administratively take a Vhosts’ diskgroup offline.

Syntax

Dx-StopDiskGroup [-VhostName] <string> [<CommonParameters>]


This cmdlet administratively takes a Vhost’s diskgroup offline. Applications that depend on the

diskgroup may be affected when the diskgroup goes offline.

Parameters



Output

See DxResult.

Examples

Dx-StopDiskGroup “VHOST1”

Dx-StopDocker

Stop an instance of a Docker container.

Syntax

Dx-StopDocker [-VhostName] <string> [-DockerName] <string> [[-IsDisabled] <bool>]



This cmdlet stops an instance of a Docker container and marks the instance as administratively disabled.


Parameters




True True

IsDisabled Bool Whether or not to administratively disable the Docker instance after stopping. This will prevent the instance from starting back up.

True True

Output

See DxResult.

Examples

Dx-StopDocker “VHOST1” “MSSQL1”

Dx-StopInstance

Stop an instance of SQL Server.

Syntax

Dx-StopInstance [-InstanceName] <string> [-IsDisabled] <bool> [<CommonParameters>]


This cmdlet stops a named instance of SQL Server and marks the instance as administratively disabled.

Parameters


InstanceName String The target instance name. Valid value is <Vhost>\<InstanceName>.

True True

IsDisabled Bool Whether or not to administratively disable the instance after stopping. This will prevent the instance from starting back up.

True True

Output

See DxResult.

Examples

Dx-StopInstance “VHOST1\CUSTOMER”


Dx-StopService

Stop a service on a Vhost.

Syntax

Dx-StopService [-VhostName] <string> [-ServiceName] <string> [[-IsDisabled] <bool>]



This cmdlet stops a service on a Vhost.

Parameters




IsDisabled Bool Whether or not to administratively disable the service after stopping. This will prevent the service from starting back up.

False False

Output

See DxResult.

Examples

Dx-StopService “VHOST1” “ALG”

Dx-StopVolume

Stop a running volume.

Syntax

Dx-StopVolume [-VolID] <string> [<CommonParameters>]


This cmdlet stops a specified volume.

Parameters


VolID String The GUID Volume ID of the volume to stop.

True True


Output

See DxResult.

Examples

Dx-StopVolume “dad325ce-3866-283c-1243-b48e92a6cd1d”

Dx-TestWitness

Test witness network share(s).

Syntax

Dx-TestWitness [-Shares] <string> [-UserName] <string> [-Password] <string> [-EncryptedPassword]



This cmdlet tests the availability and authentication to the witness network share(s).

Parameters


Shares String The share path(s). True True

UserName String The user name to access the witness share path(s).

True True

Password String The Password to access the witness share path(s).

True True



False False

Output

See DxResult.

Examples

Dx-TestWitness “\\SERVER1\Witness” “ShareAdmin” “Pa$$word!”

Dx-UnfreezeNode

Unfreeze a cluster node.

Syntax

Dx-UnfreezeNode [-NodeName] <string> [<CommonParameters>]



This cmdlet administratively takes a node out of “frozen” state and back into “active” state for all Vhosts

and continue to host running applications.

This cmdlet is designed to support in-place upgrade of DxEnterprise software.

Parameters



Output

See DxResult.

Examples

Dx-UnfreezeNode “NODE1”

Dx-UnfreezeVhost

Unfreeze a Vhost.

Syntax

Dx-UnfreezeVhost [-VhostName] <string> [<CommonParameters>]


This cmdlet administratively takes a Vhost out of the “frozen” state and back into “active” state.

Applications running on an active Vhost can now be moved around between the nodes within the Vhost.

Parameters



Output

See DxResult.

Examples

Dx-UnfreezeVhost “VHOST1”

Dx-UpdateContact

Update the email address for a contact.

Syntax


Dx-UpdateContact [-Name] <string> [-Email] <string> [<CommonParameters>]


This cmdlet updates the email address for a contact.

Parameters


Name String The contact name. True True

Email String The new email address. True True

Output

See DxResult.

Examples

Dx-UpdateContact “support” [email protected]

Dx-UpdateFileshare

Update a fileshare.

Syntax

Dx-UpdateFileshare [-VhostName] <string> [-ShareName] <string> -Grants <string[]> [-Comments

<string>] [-MaxAllowedUsers <int>] [-Caching <string> {manual | BranchCache | documents | programs

| none}] [<CommonParameters>]


This cmdlet updates a fileshare. This cmdlet can be used to modify permissions, add comments, change

the max users or change the caching type.

Parameters



ShareName String The name of the network share. True True

Grants String[] Grant parameter string array delimited by a comma (,). Each parameter name and value pair is delimited by a colon (:).

True True

Comments String User defined comment. False False

MaxAllowedUsers Integer Max concurrent users allowed to the share. Default is unlimited.

False False

Caching String Caching mode for the share. Possible mode: manual,

False False



BranchCache, documents, programs, none.

Output

See DxResult.

Examples

Dx-UpdateFileshare “VHOST1” “SHARE1” “Everyone:full”

Dx-UpdatePolicy

Update a policy.

Syntax

Dx-UpdatePolicy -SYSTEM -PolicyID <string> [-Enabled] [-Description <string>]

[-ObjectName <string>] [-Operator <string>] [<CommonParameters>]

Dx-UpdatePolicy -PERF -PolicyID <string> [-Percent] [-Loadbalance] [-Enabled] [-Description <string>] [-

ObjectName <string>] [-CounterName <string>] [-Threshold <int>] [-Operator <string>] [-ScriptPath

<string>] [-Priority <int>] [<CommonParameters>]

Dx-UpdatePolicy -ALLOC -PolicyID <string> [-Enabled] [-Description <string>] [-ObjectName <string>] [-

CounterName <string>] [-Threshold <int>] [-Operator <string>] [-ScriptPath <string>]


Dx-UpdatePolicy -FILTER -PolicyID <string> [-Enabled] [-Information] [-Warning] [-Error] [-Critical] [-

VhostFilter <string>] [-InstanceFilter <string>] [-NodeFilter <string>] [-Description <string>] [-Operator

<string>] [<CommonParameters>]


This cmdlet updates a SYSTEM/PERF/ALLOC/FILTER policy.

Parameters



System type policy. Used to alert when a system is down.

True False


Performance type policy. True False


Allocation type policy. True False


Global filter alert type policy. True False


PolicyID String Unique policy ID. False False


ObjectName String Instance or System name. False False

CounterName String Resource/counter name. False False

Threshold Integer Trigger limit applicable for PERF and ALLOC policies. When this threshold is met or exceeded the system will raise an alert and carry any predefined corrective actions.

False False

Percent Switch Parameter

Whether or not the threshold value is a percent of total system resource. Default is false.

False False

Operator String Email addresses to be sent when the policy is triggered. Delimited by comma.

False False

ScriptPath String Full path to the script file to be executed when the policy is triggered.

False False

Priority Integer Policy priority relative to other policies in the cluster. Valid values are between 1 and 5. With 1 being the lowest or least prioritized. Applicable to PERF policy.

False False

LoadBalance Switch Parameter

Whether or not to failover when the policy is triggered. Default is false.

False False

Enabled Switch Parameter

Whether or not the policy is enabled. Default is true.

False False

Information Switch Parameter

Whether or not filter only for Information severity alerts. Applicable to FILTER policy. Default is true.

False False

Warning Switch Parameter

Whether or not filter only for Warning severity alerts. Applicable to FILTER policy. Default is true.

False False

Error Switch Parameter

Whether or not filter only for Error severity alerts. Applicable to FILTER policy. Default is true.

False False

Critical Switch Parameter

Whether or not filter only for Critical severity alerts. Applicable to FILTER policy. Default is true.

False False


VhostFilter String Inclusive list of Vhosts to raise alert for. Applicable to FILTER policy. Default is all Vhosts.

False False

InstanceFilter String Inclusive list of instances to raise alert for. Applicable to FILTER policy. Default is all instances.

False False

NodeFilter String Inclusive list of nodes to raise alert for. Applicable to FILTER policy. Default is all nodes.

False False

Output

See DxResult.

Examples

Dx-UpdatePolicy -SYSTEM -PolicyID “NODE1” -Enabled:$false

Dx-UpdatePolicy -PERF -PolicyID “51A9353D-4D59-43B4-B722-04D4517CF277” -Enabled:$false

Dx-UpdatePolicy -ALLOC -PolicyID “8F257E80-E253-4FD7-B3CC-1715DA58A94B” -Enabled:$false

Dx-UpdatePolicy -FILTER -PolicyID “D92BA14F-F3D2-432A-BFA8-3BDF454B7140” -Enabled:$false

Dx-UpdateVhost

Update a Vhost.

Syntax

Dx-UpdateVhost [-VhostName] <string> [-Nodes <string>] [-AutoFailback <bool>] [-Priority <int>] [-

Force] [-VIPs <string>] [<CommonParameters>]


This cmdlet updates a Vhost. This cmdlet can be used to re-order the node list, set autofailback

property, set priority for a Vhost and/or change the IP address assignments.

Parameters



Nodes String List of nodes participating in the Vhost. Delimited by comma.

True True

AutoFailback Bool Whether or not to support auto failback for the Vhost. No change if not specified.

False True

Priority Integer Vhost priority relative to other Vhosts in the cluster. Valid

False True


values are between 1 and 5. With 1 being the lowest or least prioritized. No change if not specified.

Force Switch Parameter

Must be specified if the VIPs list is being modified.

False False

VIPs String Virtual IP addresse(s) to be assigned to the Vhost. Comma (,) delimited.

False False

Output

See DxResult.

Examples

Dx-UpdateVhost “VHOST1” “NODE2,NODE3,NODE1”

Dx-UpgradeSQL

Upgrade SQL Server instance.

Syntax

Dx-UpgradeSQL [-InstanceName] <string> [-Nodes] <string> [-ExecutingCommand] <string[]> [-

CIFSUserName] <string> [-CIFSPassword] <string> [-EncryptedPassword] [<CommonParameters>]


This cmdlet pushes an unattended upgrade/patch installation of SQL Server instance to specified nodes.

Full command line must be provided for the service pack executable and the path to the executable

must be accessible on all nodes involved. Check Microsoft website for appropriate supported

unattended patch commands and syntax.

Parameters



Nodes String A list of nodes to execute the unattended SQL Server installation. Delimited by comma.

True True

ExecutingCommand String[] Subsequent <string> parameters after the Nodes list to form proper unattended SQL Server patching command.

True True

CIFSUserName String SQL Server Login username. False True

CIFSPassword String SQL Server password. False True




False False

Output

See DxResult.

Examples

Dx-UpgradeSQL “CUSTOMER” “NODE1,NODE2” <commands>

Dx-VhostGetDockerImages

Get a list of Docker images and the running status from the specified Vhost.

Syntax

Dx-VhostGetDockerImages [-VhostName] <string> [<CommonParameters>]


This cmdlet returns a list of Docker images on the specified Vhost and the running status of the images.

Parameters



Output

See DxResult.

Examples

Dx-VhostGetDockerImages “VHOST1”

Dx-VhostGetInstances

Get a list of SQL Server instances and the running status from the specified Vhost.

Syntax

Dx-VhostGetInstances [-VhostName] <string> [<CommonParameters>]


This cmdlet returns a list of SQL Server instances on the specified Vhost and the running status of the

instance.


Parameters



Output

See DxResult.

Examples

Dx-VhostGetInstances “VHOST1”

Dx-VhostGetServices

Get a list of services and the running status from the specified Vhost.

Syntax

Dx-VhostGetServices [-VhostName] <string> [<CommonParameters>]


This cmdlet returns a list of services on the specified Vhost and the running status of the service.

Parameters



Output

See DxResult.

Examples

Dx-VhostGetService “VHOST1”

Dx-VhostSetDiskGroup

Associate a list of disks to a Vhost.

Syntax

Dx-VhostSetDiskGroup [-VhostName] <string> [-DiskIDs] <string> [<ComonParameters>]


A delimited list of disk IDs to be added to the specified Vhost. The disk(s) will be brought online on the

active node of the Vhost. The list of disk IDs must include all disk(s) that are to be assigned to the

diskgroup.


Parameters



DiskIDs String A delimited list of GUID Disk IDs or disk labels to be added. Pipe (|) or comma (,) delimited.

True True

Output

See DxResult.

Examples

Dx-VhostSetDiskGroup “VHOST1” “dad325ce-3866-283c-1243-b48e92a6cd1d,368525ce-3866-283c-

1243-b48e92a6c222”

Dx-VhostSetDockerImage

Set the Docker image assigned to the specified Vhost.

Syntax

Dx-VhostSetDockerImage [-VhostName] <string> [-DockerName] <string> [-Image] <string>



This cmdlet sets the Docker image that is assigned to the specified Vhost.

Parameters




True True

Image String The image name, image ID or both. Valid format is <ImageName>@<ImageID>.

True True

Output

See DxResult.

Examples

Dx-SetDockerImage “VHOST1” “MSSQL1” “microsoft/mssql-server-linux@ab1edc3f85cd”


Dx-VhostStartNode

Start hosting on a node.

Syntax

Dx-VhostStartNode [-VhostName] <string> [-NodeName] <string> [<CommonParameters>]


This cmdlet starts a Vhost and all associated instances on a specific node. Stops the Vhost, and all

associated instances, if it is currently running on a different node.

Parameters




Output

See DxResult.

Examples

Dx-VhostStartNode “VHOST1” “NODE1”

Dx-VhostStopNode

Stop hosting on a node.

Syntax

Dx-VhostStopNode [-VhostName] <string> [-NodeName <string>] [<CommonParameters>]


This cmdlet stops a Vhost and all associated instances, if the Vhost is active, it marks the Vhost as

administratively disabled. Administratively disabled Vhosts are not automatically restarted as part of

failover actions.

Parameters



NodeName String The name of the node. False False

Output

See DxResult.


Examples

Dx-VhostStopNode “VHOST1”


Support and Other Resources

Troubleshooting

This section includes several steps that can be performed if issues arise when using shared storage.

1. First, make sure Windows Management Framework version 3.0 is installed. If needed, please

download and install the package:

o http://www.microsoft.com/en-gb/download/details.aspx?id=34595

2. Confirm DxPowerShell module (DxPS.dll) is correctly loaded.

3. If remote access/execution of PowerShell is required, please confirm proper execution policy

and Windows Remote Management is properly configured.

o http://technet.microsoft.com/en-us/library/ee176961.aspx

o http://technet.microsoft.com/en-us/magazine/ff700227.aspx

4. Confirm network connectivity between all the machines in the cluster. This is especially

important on multi-homed systems (systems with several IP addresses). Make sure DH2i

software uses the correct IP addresses on the machines so SQL Server instances can

communicate across the network. Also ensure that all SQL Server instances are set to the same

port number (this applies to both TCP and UDP).

5. For further information please visit the Knowledge Base on our Support Portal.

o http://support.dh2i.com/

How to request technical support

For technical assistance, contact DH2i Technical Support through one of the following methods:

Email: [email protected]

Web: support.dh2i.com

Phone: U.S.: 970-295-4505 ext 2

Before you submit a support request, please collect the following information:

1. Technical support registration number 2. Information on your hardware and software

3. DH2i software version.

4. Describe the steps to reproduce the problem.

5. DxCollect logs from all machines participating in the Dx cluster.

6. Exact error message(s).

7. Specify how many times the problem has occurred.

8. State the actual results.

9. Describe the expected results.


http://technet.microsoft.com/en-us/library/ee176961.aspx

http://technet.microsoft.com/en-us/magazine/ff700227.aspx





1. Technical support registration number This number given with a valid support contract

2. Supply information on your hardware and software Use the All programs-> Accessories-> System tools -> System information or other product that will

give details about the software and hardware being run on the system.

Please describe the configuration of your central storage. Specify the type and speed of the

connection to the hosts, the type of the disk array - JBOD or RAID, the model of the hard disks. Also

describe the RAID controller, the RAID level, type of RAID (hardware/software), what software

achieves the RAID functionality (Windows or third-party). Describe the topology of your storage

network (how many hosts, how many disk arrays, how many loops, etc.).

3. Supply DH2i software version The version of DH2i software can be obtained by using the management console. Expand the

Search bar at the top and click on the DH2i logo on the right. Then write down the version

information in the message box.

Please make sure that you run the same version of DH2i software on all your machines. If for some

reason this is not the case, please state the version of DH2i software on each of the machines.

4. Describe the steps to reproduce the problem Please write down the exact steps that led to the problem. If DH2i Technical Support is unable to

reproduce the problem, it may be difficult to identify, investigate and fix the problem.

Due to the distributed nature of DH2i software, you will have to include some additional information

as well. Take notes of the order in which machines were started - this directly corresponds to the

order they enter the cluster and also affects some other aspects of DH2i software operation.

5. Supply System event logs Please send system and application event logs from all your systems forming a cluster. DH2i

software writes its information in the DH2i and System event log, but other software (e.g. MS SQL

Server) enters important information in the Application event log. The event logs should be in native

binary format (not as text files). To collect all the needed logs, please do the following on each

system:

A. Open Windows Explorer and browse to DH2i support folder (e.g. C:\Program

Files\DH2i\Support).

B. Execute the DxCollect.exe as Administrator.

C. Upload the zipped file to support.dh2i.com or ftp.dh2i.com.

To help DH2i Technical Support get as much information as possible out of log files, please provide

the approximate time the issue occurred.

6. Supply the error message(s)


ftp://ftp.dh2i.com/


If an error message is displayed in a message box, write down the exact text of the message. Please

translate the text into English, if the message is in some other language. Also you may perform a

screen capture of the error message as follows:

A. Make sure that the error message is the active window. Press Alt+PrtScn to place a bitmap copy

of the window in the Clipboard.

B. Open the built-in MS Paint bitmap editor, and paste the image.

C. Go to "File->Save as" and choose a filename.

In case a STOP error occurs that leads to a "blue screen of death", it is important to obtain the

kernel memory dump that should be created at %SystemDrive%:\Windows\Memory.dmp. If you

review the memory dump and suspect the STOP error may be filesystem related, compress and

upload the memory dump to support.dh2i.com or to ftp.dh2i.com. Then contact [email protected]

with a problem description according to the steps provided in this section. A DH2i Technical Support

engineer will analyze the memory dump and offer suggestions to resolve the error based on his/her

findings.

7. Specify how many times the problem has occurred The best property a problem may have is to be reproducible every time a particular test is run.

Unfortunately this is not always the case, if something shows up only once chances are it won't be

discovered.

Please specify the frequency with which a particular bug is occurring - every time you use the same

steps, intermittent (how many times in how many tests), just once.

8. State the actual results Describe the exact results achieved during the test using quantitative values, when possible. For

example, avoid saying just "the machine hangs". Instead say something along the lines of "Windows

Explorer stopped responding (hung), we waited for X minutes, nothing changed, we had to kill the

explorer process".

9. Describe the expected results Please describe in detail the expected test results.

Contacting DH2i

DH2i Company

Technical support:

Email: [email protected]

Web: support.dh2i.com

Phone: U.S.: 970-295-4505 ext 2

Information requests: [email protected]

Sales inquiries: [email protected]

Web site: www.dh2i.com


ftp://ftp.dh2i.com/




Mailing address:

DH2i Company

320 East Vine Drive, Ste 321

Fort Collins, CO 80528

USA

DH2I POWERSHELL ADMINISTRATION GUIDEdh2i.com/wp-content/uploads/DxPS-v19-Admin-Guide.pdfDH2i...

Documents

Transcript of DH2I POWERSHELL ADMINISTRATION GUIDEdh2i.com/wp-content/uploads/DxPS-v19-Admin-Guide.pdfDH2i...