Get‑SqlDscManagedComputerInstance - dsccommunity/SqlServerDsc GitHub Wiki

Returns managed computer server instance information.

Get-SqlDscManagedComputerInstance [-ServerName <String>] [-InstanceName <String>]
 [<CommonParameters>]

Get-SqlDscManagedComputerInstance [-InstanceName <String>] -ManagedComputerObject <ManagedComputer>
 [<CommonParameters>]

Returns managed computer server instance information for a SQL Server instance using SMO (SQL Server Management Objects). The command can retrieve a specific instance or all instances on a managed computer.

Get-SqlDscManagedComputerInstance -InstanceName 'MSSQLSERVER'

Returns the default SQL Server instance information from the local computer.

Get-SqlDscManagedComputerInstance -ServerName 'MyServer' -InstanceName 'MyInstance'

Returns the MyInstance SQL Server instance information from the MyServer computer.

Get-SqlDscManagedComputerInstance -ServerName 'MyServer'

Returns all SQL Server instances information from the MyServer computer.

Get-SqlDscManagedComputer -ServerName 'MyServer' | Get-SqlDscManagedComputerInstance -InstanceName 'MyInstance'

Uses pipeline input to retrieve a specific instance from a managed computer object.

Specifies the name of the SQL Server instance to retrieve. If not specified, all instances are returned.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Specifies a managed computer object from which to retrieve server instances. This parameter accepts pipeline input from Get-SqlDscManagedComputer.

Type: ManagedComputer
Parameter Sets: ByManagedComputerObject
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

Specifies the name of the server where the SQL Server instance is running. Defaults to the local computer name.

Type: String
Parameter Sets: ByServerName
Aliases:

Required: False
Position: Named
Default value: (Get-ComputerName)
Accept pipeline input: False
Accept wildcard characters: False

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

This command uses SMO (SQL Server Management Objects) to retrieve server instance information from the specified managed computer.