Permalink
Browse files

Updated docs ***NO_CI***

  • Loading branch information...
SQLDBAWithABeard committed Sep 29, 2018
1 parent 030e121 commit f089e580e8de11e7b0c797107d25e82901230a9f

Large diffs are not rendered by default.

Oops, something went wrong.
@@ -0,0 +1,80 @@
## Date 07/09/2018
Updated dbatools required module to 0.9.410
Renamed all dbatools commands to new naming convention
Fixed Bug with JSON file naming
Improved Server Checks to remove Red and improve speed for none contactable servers
Altered all server checks to use assertions and added pester Tests
Removed left over ogv entry

##Latest

## Date 05/09/2018
New Check for 2 digit cut off thanks @CláudioESSilva
https://claudioessilva.eu/2018/09/04/dont-cutoff-yourself-when-dealing-with-dates-in-t-sql-did-you-know/
Fixed bug with adding NoneContactable Instances to variable
Improved error handling for HADR checks

## Date 28/08/2018
Added MaxBehind to SupportedBuild Tests - Thank you @LowlyDBA
Ensured the Database paramter checks only the specified Databases - Thank you @jpomfret
Updated Set-DbcConifg to allow Append to append arrays to arrays closes #535
Altered json filename creation to avoid max characters error
Altered PowerBi to display information correctly with filename changes

## Date 24/08/2017
Fixed Error with using Credential and stopped changing path when runnign checks from custom repos - Thank you @sammyxx

## Date 23/08/2017
Update to the help message for clusters by @LowlyDBA
Potential Breaking Change - Removed Tags from names of json files so that PowerBi will correctly show Environment names

## Date 15/08/2018
Fixed issue 521 ExcludeDatabase parameter doesn't work - THANK YOU @jpomfret
THANK YOU @jpomfret - Issue 509 -Database should only check databases listed and exclude all others
Further update to Update-DbcPowerBiDataSource to allow Environment as well as specify filename
Improved performance of the Server checks
Improved performance of the Instance checks
Improved performance of the Database checks
Improved performance of the ErrorLog checks
Removed Send-DbcSendMailMessage until it can be re-coded

## Date 13/08/2018
Fixed #504 by enabling FileName parameter on Update-PowerBiDataSouce
Added in new function to begin to reduce the number of calls to each instance
Reduced required Pester version to 4.3.1
Further PowerShell V4 improvements

## Date 06/08/2018
Added New Check for tempdb data file sizes to be the same - Thank you @garethnewman #512
Altered Services Check so that clustered instances start mode is checked correctly thank you @kylejdoyle #516
Skip PowerPlan test if no connection thanks @cl #490
Fixed bug with XESession and PSv4 thank you @kylejdoyle #517
Error silently on failing Service check (thanks Rob ;-) )
Fixed dbatools command names
Fixed PSv4 support for importing the module also

## Date 31/07/2018

Added check for Database Exists - Thanks @sqldbawithbeard
Added excluded databases config to each Database Check and wrote Pester Test for that #506
Added msdb to exclusion fro duplicate index #506
Fixed offline install bug #484

## Date 30/07/2018

Updated Required Module versions - Thank you @cl
Updated Agent Checks to fail a test on no connection rather than throw all the PowerShell errors - Thanks @sqldbawithbeard
Updated HADR Checks for PS4 compatability Issue #513

## Date 28/06/2018

Don't check versions before 2008 for AdHocWorkloads Thank you John McCall @LowlyDBA
More Spelling! Thank you John McCall @LowlyDBA
Updated required version and dbatools error log command name Thank you Our Glorious Chrissy @cl

## Date 30/05/2018
New Release Notes command added
Spelling

## Date 29/05/2012

@@ -0,0 +1,92 @@
# Clear-DbcPowerBiDataSource

## SYNOPSIS
Clears the data source directory created by Update-DbcPowerBiDataSource

## SYNTAX

```
Clear-DbcPowerBiDataSource [[-Path] <String>] [[-Environment] <String>] [-EnableException] [<CommonParameters>]
```

## DESCRIPTION
Clears the data source directory created by Update-DbcPowerBiDataSource ("C:\windows\temp\dbachecks\*.json" by default).
This command makes it easier to clean up data used by PowerBI via Start-DbcPowerBi.

## EXAMPLES

### EXAMPLE 1
```
Clear-DbcPowerBiDataSource
```

Removes "$env:windir\temp\dbachecks\*.json"

### EXAMPLE 2
```
Clear-DbcPowerBiDataSource -Environment Production
```

Removes "$env:windir\temp\dbachecks\*Production*.json"

## PARAMETERS

### -Path
The directory to your JSON files, which will be removed.
"C:\windows\temp\dbachecks\*.json" by default

```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: "$env:windir\temp\dbachecks"
Accept pipeline input: False
Accept wildcard characters: False
```

### -Environment
Removes the JSON files for a specific environement

```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -EnableException
By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

## OUTPUTS

## NOTES

## RELATED LINKS
@@ -0,0 +1,75 @@
# Export-DbcConfig

## SYNOPSIS
Exports dbachecks configs from a json file to make it easier to modify or be used for specific configurations.

## SYNTAX

```
Export-DbcConfig [[-Path] <String>] [-EnableException] [<CommonParameters>]
```

## DESCRIPTION
Exports dbachecks configs from a json file to make it easier to modify or be used for specific configurations.

## EXAMPLES

### EXAMPLE 1
```
Export-DbcConfig
```

Exports config to "$script:localapp\config.json"

### EXAMPLE 2
```
Export-DbcConfig -Path \\nfs\projects\config.json
```

Exports config to \\\\nfs\projects\config.json

## PARAMETERS

### -Path
The path to export to, by default is "$script:localapp\config.json"

```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: "$script:localapp\config.json"
Accept pipeline input: False
Accept wildcard characters: False
```

### -EnableException
By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

## OUTPUTS

## NOTES

## RELATED LINKS
@@ -0,0 +1,75 @@
# Get-DbcCheck

## SYNOPSIS
Lists all checks, tags and unique identifiers

## SYNTAX

```
Get-DbcCheck [[-Pattern] <String>] [-EnableException] [<CommonParameters>]
```

## DESCRIPTION
Lists all checks, tags and unique identifiers

## EXAMPLES

### EXAMPLE 1
```
Get-DbcCheck
```

Retrieves all of the available checks

### EXAMPLE 2
```
Get-DbcCheck backups
```

Retrieves all of the available tags that match backups

## PARAMETERS

### -Pattern
May be any string, supports wildcards.

```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -EnableException
By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

## OUTPUTS

## NOTES

## RELATED LINKS
@@ -0,0 +1,73 @@
# Get-DbcConfig

## SYNOPSIS
Retrieves configuration elements by name.

## SYNTAX

```
Get-DbcConfig [[-Name] <String>] [-EnableException] [<CommonParameters>]
```

## DESCRIPTION
Retrieves configuration elements by name.

Can be used to search the existing configuration list.

## EXAMPLES

### EXAMPLE 1
```
Get-DbcConfig Lists.SqlServers
```

Retrieves the configuration element for the key "Lists.SqlServers"

## PARAMETERS

### -Name
Default: "*"
The name of the configuration element(s) to retrieve.
May be any string, supports wildcards.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: *
Accept pipeline input: False
Accept wildcard characters: False
```
### -EnableException
By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS
Oops, something went wrong.

0 comments on commit f089e58

Please sign in to comment.