com.dbhistory.powershell.dll-Help.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh">
  <!-- Cmdlet: Install-DBHistory -->
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <command:details>
      <command:name>Install-DBHistory</command:name>
      <command:verb>Install</command:verb>
      <command:noun>DBHistory</command:noun>
      <maml:description>
        <maml:para>Adds a SQL Server to DBHistory.com monitoring.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Configures a SQL Server instance to be monitored by DBHistory.com. This cmdlet is idempotent and can be run repeatedly.</maml:para>
    </maml:description>
    <command:syntax>
      <!-- Parameter set: __AllParameterSets -->
      <command:syntaxItem>
        <maml:name>Install-DBHistory</maml:name>
        <!-- Parameter: ServerName -->
        <command:parameter required="true" globbing="false" pipelineInput="false" position="0">
          <maml:name>ServerName</maml:name>
          <maml:description>
            <maml:para>The SQL Server your are adding to DBHistory.com. You must have CONTROL SERVER permission on the SQL Server instance.</maml:para>
            <maml:para>Use ".", "local" or "localhost" to connect to a local default instance.</maml:para>
            <maml:para>Use "machine_name" to connect to an default instance.</maml:para>
            <maml:para>Use "machine_name"\"instance_name" to connect to a named instance.</maml:para>
            <maml:para>The SQL Server must be able to connect TCP outbound to DBHistory.com on port 4022.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: CertificateName -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>CertificateName</maml:name>
          <maml:description>
            <maml:para>Name of the certificate used by SQL Server Service Broker.</maml:para>
            <maml:para>This parameter is optional. If omitted then the certificate will be given the same name the SQL Server.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: CertificateSubject -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>CertificateSubject</maml:name>
          <maml:description>
            <maml:para>Subject of the certificate used by SQL Server Service Broker.</maml:para>
            <maml:para>This parameter is optional. If omitted then the certificate will be given the same subject as the SQL Server name.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: DatabaseMasterKeyPassword -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>DatabaseMasterKeyPassword</maml:name>
          <maml:description>
            <maml:para>master database master key password.</maml:para>
            <maml:para>This parameter is only needed if the cmdlet needs to create a database master key password in master database. If a database master key password already exists in master database then this parameter is ignored, even if provided.</maml:para>
            <maml:para>If you do not provide a database master password and one is needed, this cmdlet will prompt for a password.</maml:para>
            <maml:para>If a new database master key password is created by this cmdlet you will need to remember this password for normal database cryptography related operations. Do not forget the password you provided.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: DBHistoryAPI -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>DBHistoryAPI</maml:name>
          <maml:description>
            <maml:para>DBHistory.com HTTP REST Service API address.</maml:para>
            <maml:para>This parameter is only used for testing.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: DBHistoryCredential -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>DBHistoryCredential</maml:name>
          <maml:description>
            <maml:para>Credentials used for DBHistory.com.</maml:para>
            <maml:para>Use this as an alternative to DBHistoryUserName/DBHistoryUserPassword.</maml:para>
          </maml:description>
          <command:parameterValue required="true">PSCredential</command:parameterValue>
          <dev:type>
            <maml:name>System.Management.Automation.PSCredential</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: DBHistoryRouteAddress -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>DBHistoryRouteAddress</maml:name>
          <maml:description>
            <maml:para>DBHistory.com Service Broker routing address for your account.</maml:para>
            <maml:para>This parameter is only used for testing.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: DBHistoryUserName -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>DBHistoryUserName</maml:name>
          <maml:description>
            <maml:para>The user name for your DBHistory.com account.</maml:para>
            <maml:para>If you ommit this parameter and don't provide an alternate DBUserCredential, the cmdlet will prompt for user name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DBHistoryUserPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DBHistoryUserPassword</maml:name> <maml:description> <maml:para>The password you use on DBHistory.com.</maml:para> <maml:para>If you ommit this parameter and don't provide an alternate DBUserCredential, the cmdlet will prompt for password.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: EndpointName -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>EndpointName</maml:name>
          <maml:description>
            <maml:para>SQL Service Broker Endpoint name.</maml:para>
            <maml:para>This parameter is optional. If omitted the name service_broker_endpoint will be used.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: EventNotificationName -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>EventNotificationName</maml:name>
          <maml:description>
            <maml:para>SQL Server Event Notification name used by DBHistory monitoring.</maml:para>
            <maml:para>This parameter is optional. If omitted the name used will bd DBHistory.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: GAOptOut -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>GAOptOut</maml:name>
          <maml:description>
            <maml:para>Opt out of application analytics</maml:para>
            <maml:para>Do not collect and report anonymized usage information.</maml:para>
          </maml:description>
          <command:parameterValue required="true">bool</command:parameterValue>
          <dev:type>
            <maml:name>System.Boolean</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
        <!-- Parameter: ListenerIP -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>ListenerIP</maml:name>
          <maml:description>
            <maml:para>SQL Server Service Broker Endpoint listener IP.</maml:para>
            <maml:para>This parameter is optional. If omitted then the default listener IP will be used.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: ListenerPort -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>ListenerPort</maml:name>
          <maml:description>
            <maml:para>SQL Server Service Broker Endpoint listener port.</maml:para>
            <maml:para>This parameter is optional. If omitted then the default listener port will be used.</maml:para>
          </maml:description>
          <command:parameterValue required="true">ushort</command:parameterValue>
          <dev:type>
            <maml:name>System.UInt16</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>0</dev:defaultValue>
        </command:parameter>
        <!-- Parameter: ServiceRouteName -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>ServiceRouteName</maml:name>
          <maml:description>
            <maml:para>Service Broker route name in msdb database for DBHistory.com service.</maml:para>
            <maml:para>This parameter is optional. If omitted the name used will be DBHistory.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: SQLUserCredential -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>SQLUserCredential</maml:name>
          <maml:description>
            <maml:para>The SQL Server login credentials if you do not use integrated authentication.</maml:para>
            <maml:para>This parmeter is optional, if omitted then the cmdlet will use integrated authentication to connect to SQL Server.</maml:para>
            <maml:para>This parameter is an alternative for providing SQL user password as a clear text.</maml:para>
          </maml:description>
          <command:parameterValue required="true">PSCredential</command:parameterValue>
          <dev:type>
            <maml:name>System.Management.Automation.PSCredential</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: SQLUserName -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>SQLUserName</maml:name>
          <maml:description>
            <maml:para>The SQL Server login name if you do not want to use integrated authentication.</maml:para>
            <maml:para>This parmeter is optional, if omitted then the cmdlet will use integrated authentication to connect to SQL Server.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: SQLUserPassword -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>SQLUserPassword</maml:name>
          <maml:description>
            <maml:para>The SQL Server login password if you do not want to use integrated authentication.</maml:para>
            <maml:para>This parmeter is optional, if omitted then the cmdlet will use integrated authentication to connect to SQL Server.</maml:para>
            <maml:para>You can use SQLUserCredential parameter as an alternative for providing SQL user password as a clear text parameter.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <!-- Parameter: ServerName -->
      <command:parameter required="true" globbing="false" pipelineInput="false" position="0">
        <maml:name>ServerName</maml:name>
        <maml:description>
          <maml:para>The SQL Server your are adding to DBHistory.com. You must have CONTROL SERVER permission on the SQL Server instance.</maml:para>
          <maml:para>Use ".", "local" or "localhost" to connect to a local default instance.</maml:para>
          <maml:para>Use "machine_name" to connect to an default instance.</maml:para>
          <maml:para>Use "machine_name"\"instance_name" to connect to a named instance.</maml:para>
          <maml:para>The SQL Server must be able to connect TCP outbound to DBHistory.com on port 4022.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: DBHistoryUserName -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>DBHistoryUserName</maml:name>
        <maml:description>
          <maml:para>The user name for your DBHistory.com account.</maml:para>
          <maml:para>If you ommit this parameter and don't provide an alternate DBUserCredential, the cmdlet will prompt for user name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DBHistoryUserPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DBHistoryUserPassword</maml:name> <maml:description> <maml:para>The password you use on DBHistory.com.</maml:para> <maml:para>If you ommit this parameter and don't provide an alternate DBUserCredential, the cmdlet will prompt for password.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: DBHistoryCredential -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>DBHistoryCredential</maml:name>
        <maml:description>
          <maml:para>Credentials used for DBHistory.com.</maml:para>
          <maml:para>Use this as an alternative to DBHistoryUserName/DBHistoryUserPassword.</maml:para>
        </maml:description>
        <command:parameterValue required="true">PSCredential</command:parameterValue>
        <dev:type>
          <maml:name>System.Management.Automation.PSCredential</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: SQLUserName -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>SQLUserName</maml:name>
        <maml:description>
          <maml:para>The SQL Server login name if you do not want to use integrated authentication.</maml:para>
          <maml:para>This parmeter is optional, if omitted then the cmdlet will use integrated authentication to connect to SQL Server.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: SQLUserPassword -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>SQLUserPassword</maml:name>
        <maml:description>
          <maml:para>The SQL Server login password if you do not want to use integrated authentication.</maml:para>
          <maml:para>This parmeter is optional, if omitted then the cmdlet will use integrated authentication to connect to SQL Server.</maml:para>
          <maml:para>You can use SQLUserCredential parameter as an alternative for providing SQL user password as a clear text parameter.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: SQLUserCredential -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>SQLUserCredential</maml:name>
        <maml:description>
          <maml:para>The SQL Server login credentials if you do not use integrated authentication.</maml:para>
          <maml:para>This parmeter is optional, if omitted then the cmdlet will use integrated authentication to connect to SQL Server.</maml:para>
          <maml:para>This parameter is an alternative for providing SQL user password as a clear text.</maml:para>
        </maml:description>
        <command:parameterValue required="true">PSCredential</command:parameterValue>
        <dev:type>
          <maml:name>System.Management.Automation.PSCredential</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: ListenerIP -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>ListenerIP</maml:name>
        <maml:description>
          <maml:para>SQL Server Service Broker Endpoint listener IP.</maml:para>
          <maml:para>This parameter is optional. If omitted then the default listener IP will be used.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: ListenerPort -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>ListenerPort</maml:name>
        <maml:description>
          <maml:para>SQL Server Service Broker Endpoint listener port.</maml:para>
          <maml:para>This parameter is optional. If omitted then the default listener port will be used.</maml:para>
        </maml:description>
        <command:parameterValue required="true">ushort</command:parameterValue>
        <dev:type>
          <maml:name>System.UInt16</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>0</dev:defaultValue>
      </command:parameter>
      <!-- Parameter: CertificateName -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>CertificateName</maml:name>
        <maml:description>
          <maml:para>Name of the certificate used by SQL Server Service Broker.</maml:para>
          <maml:para>This parameter is optional. If omitted then the certificate will be given the same name the SQL Server.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: CertificateSubject -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>CertificateSubject</maml:name>
        <maml:description>
          <maml:para>Subject of the certificate used by SQL Server Service Broker.</maml:para>
          <maml:para>This parameter is optional. If omitted then the certificate will be given the same subject as the SQL Server name.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: EndpointName -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>EndpointName</maml:name>
        <maml:description>
          <maml:para>SQL Service Broker Endpoint name.</maml:para>
          <maml:para>This parameter is optional. If omitted the name service_broker_endpoint will be used.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: EventNotificationName -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>EventNotificationName</maml:name>
        <maml:description>
          <maml:para>SQL Server Event Notification name used by DBHistory monitoring.</maml:para>
          <maml:para>This parameter is optional. If omitted the name used will bd DBHistory.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: ServiceRouteName -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>ServiceRouteName</maml:name>
        <maml:description>
          <maml:para>Service Broker route name in msdb database for DBHistory.com service.</maml:para>
          <maml:para>This parameter is optional. If omitted the name used will be DBHistory.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: DBHistoryRouteAddress -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>DBHistoryRouteAddress</maml:name>
        <maml:description>
          <maml:para>DBHistory.com Service Broker routing address for your account.</maml:para>
          <maml:para>This parameter is only used for testing.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: DBHistoryAPI -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>DBHistoryAPI</maml:name>
        <maml:description>
          <maml:para>DBHistory.com HTTP REST Service API address.</maml:para>
          <maml:para>This parameter is only used for testing.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: DatabaseMasterKeyPassword -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>DatabaseMasterKeyPassword</maml:name>
        <maml:description>
          <maml:para>master database master key password.</maml:para>
          <maml:para>This parameter is only needed if the cmdlet needs to create a database master key password in master database. If a database master key password already exists in master database then this parameter is ignored, even if provided.</maml:para>
          <maml:para>If you do not provide a database master password and one is needed, this cmdlet will prompt for a password.</maml:para>
          <maml:para>If a new database master key password is created by this cmdlet you will need to remember this password for normal database cryptography related operations. Do not forget the password you provided.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: GAOptOut -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>GAOptOut</maml:name>
        <maml:description>
          <maml:para>Opt out of application analytics</maml:para>
          <maml:para>Do not collect and report anonymized usage information.</maml:para>
        </maml:description>
        <command:parameterValue required="true">bool</command:parameterValue>
        <dev:type>
          <maml:name>System.Boolean</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>False</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes />
    <command:returnValues />
    <command:examples>
      <command:example>
        <maml:title>----------  EXAMPLE 1  ----------</maml:title>
        <dev:code>Install-DBHistory -ServerName . -DBHistoryUserName you@example.com -DBHistoryUserPassword secret</dev:code>
        <dev:remarks>
          <maml:para>Adds the localhost default SQL Server instance to DBHistory.com monitoring on the account associated with you@example.com. Uses Integrated Authentication to connect to SQL Server.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>----------  EXAMPLE 2  ----------</maml:title>
        <dev:code>Install-DBHistory -ServerName MACHINE02\SQLEXPRESS `
                      -DBHistoryUserName you@example.com `
                      -DBHistoryUserPassword secret `
                      -SQLUserName sqllogin `
                      -SQLUserPassword sqlpassword `
                      -DatabaseMasterKeyPassword masterkeypassword</dev:code>
        <dev:remarks>
          <maml:para>Adds the SQL Server named instance named SQLEXPRESS from the machine MACHINE02 to DBHistory.com monitoring on the account associated with you@example.com. Connects to SQL Server using SQL Authentication with the login name 'sqllogin' and password 'sqlpassword'. The database master key in master database is created with the password 'masterkeypassword'. This example uses the PowerShell back-tick ` line continuation escape to split each parameter on a new line for clarity, but this is not required.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <maml:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>DBHistory.com</maml:linkText>
        <maml:uri>http://dbhistory.com</maml:uri>
      </maml:navigationLink>
    </maml:relatedLinks>
  </command:command>
</helpItems>