Start-ClassificationInstanceScan
Published 25 September 2019
Start scan of a registered instance.
Syntax
Start-ClassificationInstanceScan [-FullyQualifiedInstanceName] <string> [<CommonParameters>]
Description
Scans the instance for new databases. Updates data stored in SQL Data Catalog based on metadata read from the live instance provided.
Parameters
-FullyQualifiedInstanceName
<String>
The fully-qualified name of the SQL Server instance to be registered. For a named instance, this should take the form 'fully-qualified-host-name\instance-name' (e.g. "myserver.mydomain.com\myinstance"). For the default instance on a machine, just the fully-qualified name of the machine will suffice (e.g. "myserver.mydomain.com").
| Aliases | None |
| Required? | true |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| Accept Wildcard Characters | false |
-ProgressAction
<ActionPreference>
{{ Fill ProgressAction Description }}
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see http://technet.microsoft.com/en-us/library/hh847884.aspx.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
None.
You cannot pipe input to this cmdlet.
Return values
The output type is the type of the objects that the cmdlet emits.
-
A hashtable with the following properties:
- type: string
- title: string
- status: int
- detail: string
- instance: string
Examples
-------------------------- EXAMPLE 1 --------------------------
Start-ClassificationInstanceScan -FullyQualifiedInstanceName 'mysqlserver.mydomain.com\myinstancename'
Start a scan of a live instance "myinstancename" running on the "mysqlserver.mydomain.com" machine, which results in updating data about this instance stored in SQL Data Catalog.
