Generated/com.dbhistory.powershell.dll-Help.xml
|
<?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> <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> <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> |