< Back
New-DbsDocTemplate
Post
NAME New-DbsDocTemplate
SYNOPSIS
Creates a documentation template in markdown that makes it easy to provide the necessary documentation to auditors
SYNTAX
New-DbsDocTemplate [-FilePath] <String> [[-Version] <Int32>] [-EnableException] [<CommonParameters>]
DESCRIPTION
Creates a documentation template in markdown that makes it easy to provide the necessary documentation to auditors
PARAMETERS
-FilePath <String>
The output markdown file path
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Version <Int32>
The SQL Server version. 2016 by default.
Required? false
Position? 2
Default value 2016
Accept pipeline input? false
Accept wildcard characters? false
-EnableException [<SwitchParameter>]
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.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-DbsDocTemplate -FilePath C:\\temp\\sql2016.md
Creates a DISA documentation template for 2016
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>New-DbsDocTemplate -FilePath C:\\temp\\sql2014.md -Version 2014
Creates a DISA documentation template for 2014
RELATED LINKS
SYNOPSIS
Creates a documentation template in markdown that makes it easy to provide the necessary documentation to auditors
SYNTAX
New-DbsDocTemplate [-FilePath] <String> [[-Version] <Int32>] [-EnableException] [<CommonParameters>]
DESCRIPTION
Creates a documentation template in markdown that makes it easy to provide the necessary documentation to auditors
PARAMETERS
-FilePath <String>
The output markdown file path
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Version <Int32>
The SQL Server version. 2016 by default.
Required? false
Position? 2
Default value 2016
Accept pipeline input? false
Accept wildcard characters? false
-EnableException [<SwitchParameter>]
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.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-DbsDocTemplate -FilePath C:\\temp\\sql2016.md
Creates a DISA documentation template for 2016
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>New-DbsDocTemplate -FilePath C:\\temp\\sql2014.md -Version 2014
Creates a DISA documentation template for 2014
RELATED LINKS