com.dbhistory.powershell.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
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>com.dbhistory.powershell</name>
    </assembly>
    <members>
        <member name="T:com.dbhistory.powershell.AddServer">
            <summary>
            <para type="synopsis">Adds a SQL Server to DBHistory.com monitoring.</para>
            <para type="description">Configures a SQL Server instance to be monitored by DBHistory.com. This cmdlet is idempotent and can be run repeatedly.</para>
            <example>
            <code>Install-DBHistory -ServerName . -DBHistoryUserName you@example.com -DBHistoryUserPassword secret</code>
            <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.</para>
            </example>
            <example>
            <code>Install-DBHistory -ServerName MACHINE02\SQLEXPRESS `
                      -DBHistoryUserName you@example.com `
                      -DBHistoryUserPassword secret `
                      -SQLUserName sqllogin `
                      -SQLUserPassword sqlpassword `
                      -DatabaseMasterKeyPassword masterkeypassword</code>
            <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.</para>
            </example>
            <para type="link" uri="http://dbhistory.com">DBHistory.com</para>
            </summary>
        </member>
        <member name="P:com.dbhistory.powershell.AddServer.ServerName">
            <summary>
            <para type="description">The SQL Server your are adding to DBHistory.com. You must have CONTROL SERVER permission on the SQL Server instance.</para>
            <para type="description">Use ".", "local" or "localhost" to connect to a local default instance.</para>
            <para type="description">Use "machine_name" to connect to an default instance.</para>
            <para type="description">Use "machine_name"\"instance_name" to connect to a named instance.</para>
            <para type="description">The SQL Server must be able to connect TCP outbound to DBHistory.com on port 4022.</para>
            </summary>
        </member>
        <member name="P:com.dbhistory.powershell.AddServer.DBHistoryUserName">
            <summary>
            <para type="description">The user name for your DBHistory.com account.</para>
            <para type="description">If you ommit this parameter and don't provide an alternate DBUserCredential, the cmdlet will prompt for user name.</para> </summary> </member> <member name="P:com.dbhistory.powershell.AddServer.DBHistoryUserPassword"> <summary> <para type="description">The password you use on DBHistory.com.</para> <para type="description">If you ommit this parameter and don't provide an alternate DBUserCredential, the cmdlet will prompt for password.</para>
            </summary>
        </member>
        <member name="P:com.dbhistory.powershell.AddServer.DBHistoryCredential">
            <summary>
            <para type="description">Credentials used for DBHistory.com.</para>
            <para type="description">Use this as an alternative to DBHistoryUserName/DBHistoryUserPassword.</para>
            </summary>
        </member>
        <member name="P:com.dbhistory.powershell.AddServer.SQLUserName">
            <summary>
            <para type="description">The SQL Server login name if you do not want to use integrated authentication.</para>
            <para type="description">This parmeter is optional, if omitted then the cmdlet will use integrated authentication to connect to SQL Server.</para>
            </summary>
        </member>
        <member name="P:com.dbhistory.powershell.AddServer.SQLUserPassword">
            <summary>
            <para type="description">The SQL Server login password if you do not want to use integrated authentication.</para>
            <para type="description">This parmeter is optional, if omitted then the cmdlet will use integrated authentication to connect to SQL Server.</para>
            <para type="description">You can use SQLUserCredential parameter as an alternative for providing SQL user password as a clear text parameter.</para>
            </summary>
        </member>
        <member name="P:com.dbhistory.powershell.AddServer.SQLUserCredential">
            <summary>
            <para type="description">The SQL Server login credentials if you do not use integrated authentication.</para>
            <para type="description">This parmeter is optional, if omitted then the cmdlet will use integrated authentication to connect to SQL Server.</para>
            <para type="description">This parameter is an alternative for providing SQL user password as a clear text.</para>
            </summary>
        </member>
        <member name="P:com.dbhistory.powershell.AddServer.ListenerIP">
            <summary>
            <para type="description">SQL Server Service Broker Endpoint listener IP.</para>
            <para type="description">This parameter is optional. If omitted then the default listener IP will be used.</para>
            </summary>
        </member>
        <member name="P:com.dbhistory.powershell.AddServer.ListenerPort">
            <summary>
            <para type="description">SQL Server Service Broker Endpoint listener port.</para>
            <para type="description">This parameter is optional. If omitted then the default listener port will be used.</para>
            </summary>
        </member>
        <member name="P:com.dbhistory.powershell.AddServer.CertificateName">
            <summary>
            <para type="description">Name of the certificate used by SQL Server Service Broker.</para>
            <para type="description">This parameter is optional. If omitted then the certificate will be given the same name the SQL Server.</para>
            </summary>
        </member>
        <member name="P:com.dbhistory.powershell.AddServer.CertificateSubject">
            <summary>
            <para type="description">Subject of the certificate used by SQL Server Service Broker.</para>
            <para type="description">This parameter is optional. If omitted then the certificate will be given the same subject as the SQL Server name.</para>
            </summary>
        </member>
        <member name="P:com.dbhistory.powershell.AddServer.EndpointName">
            <summary>
            <para type="description">SQL Service Broker Endpoint name.</para>
            <para type="description">This parameter is optional. If omitted the name service_broker_endpoint will be used.</para>
            </summary>
        </member>
        <member name="P:com.dbhistory.powershell.AddServer.EventNotificationName">
            <summary>
            <para type="description">SQL Server Event Notification name used by DBHistory monitoring.</para>
            <para type="description">This parameter is optional. If omitted the name used will bd DBHistory.</para>
            </summary>
        </member>
        <member name="P:com.dbhistory.powershell.AddServer.ServiceRouteName">
            <summary>
            <para type="description">Service Broker route name in msdb database for DBHistory.com service.</para>
            <para type="description">This parameter is optional. If omitted the name used will be DBHistory.</para>
            </summary>
        </member>
        <member name="P:com.dbhistory.powershell.AddServer.DBHistoryRouteAddress">
            <summary>
            <para type="description">DBHistory.com Service Broker routing address for your account.</para>
            <para type="description">This parameter is only used for testing.</para>
            </summary>
        </member>
        <member name="P:com.dbhistory.powershell.AddServer.DBHistoryAPI">
            <summary>
            <para type="description">DBHistory.com HTTP REST Service API address.</para>
            <para type="description">This parameter is only used for testing.</para>
            </summary>
        </member>
        <member name="P:com.dbhistory.powershell.AddServer.DatabaseMasterKeyPassword">
            <summary>
            <para type="description">master database master key password.</para>
            <para type="description">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.</para>
            <para type="description">If you do not provide a database master password and one is needed, this cmdlet will prompt for a password.</para>
            <para type="description">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.</para>
            </summary>
        </member>
        <member name="P:com.dbhistory.powershell.AddServer.GAOptOut">
            <summary>
            <para type="description">Opt out of application analytics</para>
            <para type="description">Do not collect and report anonymized usage information.</para>
            </summary>
        </member>
    </members>
</doc>