diff --git a/Add-ConnectionHashValue.html b/Add-ConnectionHashValue.html new file mode 100644 index 00000000..ec46fa13 --- /dev/null +++ b/Add-ConnectionHashValue.html @@ -0,0 +1,542 @@ + + + + + + + dbatools docs | Add-ConnectionHashValue + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Add-ConnectionHashValue

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Add-ConnectionHashValue -Key -Value []

+

Description

+

Syntax

+
Add-ConnectionHashValuesyntaxItem----------{@{name=
+
+Add-ConnectionHashValue; CommonParameters=True; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-Key
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-Value
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Add-ConnectionHashValue on GitHub. +
+Want to see the Bill Of Health for this command? Check out Add-ConnectionHashValue.

+ + + + + + + + diff --git a/Add-DbaAgDatabase.html b/Add-DbaAgDatabase.html index dca8948f..3acf8a95 100644 Binary files a/Add-DbaAgDatabase.html and b/Add-DbaAgDatabase.html differ diff --git a/Add-DbaAgListener.html b/Add-DbaAgListener.html index 19cee8fa..e5507428 100644 Binary files a/Add-DbaAgListener.html and b/Add-DbaAgListener.html differ diff --git a/Add-DbaAgReplica.html b/Add-DbaAgReplica.html index 50bf3641..bada215d 100644 Binary files a/Add-DbaAgReplica.html and b/Add-DbaAgReplica.html differ diff --git a/Add-DbaComputerCertificate.html b/Add-DbaComputerCertificate.html index 5f9f19a6..d4af0a94 100644 Binary files a/Add-DbaComputerCertificate.html and b/Add-DbaComputerCertificate.html differ diff --git a/Add-DbaDbMirrorMonitor.html b/Add-DbaDbMirrorMonitor.html index 98bc9562..b383066c 100644 Binary files a/Add-DbaDbMirrorMonitor.html and b/Add-DbaDbMirrorMonitor.html differ diff --git a/Add-DbaDbRoleMember.html b/Add-DbaDbRoleMember.html index ba74ff7d..92b9201e 100644 Binary files a/Add-DbaDbRoleMember.html and b/Add-DbaDbRoleMember.html differ diff --git a/Add-DbaExtendedProperty.html b/Add-DbaExtendedProperty.html index 1eb448a9..2b3c39f0 100644 Binary files a/Add-DbaExtendedProperty.html and b/Add-DbaExtendedProperty.html differ diff --git a/Add-DbaPfDataCollectorCounter.html b/Add-DbaPfDataCollectorCounter.html index cf687258..3027e0dd 100644 Binary files a/Add-DbaPfDataCollectorCounter.html and b/Add-DbaPfDataCollectorCounter.html differ diff --git a/Add-DbaRegServer.html b/Add-DbaRegServer.html index 0885a717..6cc41390 100644 Binary files a/Add-DbaRegServer.html and b/Add-DbaRegServer.html differ diff --git a/Add-DbaRegServerGroup.html b/Add-DbaRegServerGroup.html index 2a63de1e..4e1114fb 100644 Binary files a/Add-DbaRegServerGroup.html and b/Add-DbaRegServerGroup.html differ diff --git a/Add-DbaServerRoleMember.html b/Add-DbaServerRoleMember.html index 4a1bb37b..5baff8b8 100644 Binary files a/Add-DbaServerRoleMember.html and b/Add-DbaServerRoleMember.html differ diff --git a/Add-TeppCacheItem.html b/Add-TeppCacheItem.html new file mode 100644 index 00000000..48ca8870 --- /dev/null +++ b/Add-TeppCacheItem.html @@ -0,0 +1,576 @@ + + + + + + + dbatools docs | Add-TeppCacheItem + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Add-TeppCacheItem

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal function to add an item to the TEPP cache.

+

Description

+

Internal function to add an item to the TEPP cache.

+

Syntax

+
Add-TeppCacheItem
+    [-SqlInstance] <DbaInstanceParameter>
+    [-Type] <String>
+    [-Name] <String>
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Add-TeppCacheItem -SqlInstance $server -Type database -Name AdventureWorks
+Adds an entry for the database AdventureWorks in the TEPP cache.

+

Required Parameters

+
-SqlInstance
+

The SQL Server instance.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-Type
+

The type of object. Must be part of "[Sqlcollaborative.Dbatools.TabExpansion.TabExpansionHost]::Cache.Keys".

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-Name
+

The name of the object that should be added to the cache. Will not be added if already in cache.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Add-TeppCacheItem on GitHub. +
+Want to see the Bill Of Health for this command? Check out Add-TeppCacheItem.

+ +
+
+
+
+ + + diff --git a/Backup-DbaComputerCertificate.html b/Backup-DbaComputerCertificate.html index 636686cd..d46c3b24 100644 Binary files a/Backup-DbaComputerCertificate.html and b/Backup-DbaComputerCertificate.html differ diff --git a/Backup-DbaDatabase.html b/Backup-DbaDatabase.html index 12229e3d..13f46c3f 100644 Binary files a/Backup-DbaDatabase.html and b/Backup-DbaDatabase.html differ diff --git a/Backup-DbaDbCertificate.html b/Backup-DbaDbCertificate.html index 11f260ba..8ea5f940 100644 Binary files a/Backup-DbaDbCertificate.html and b/Backup-DbaDbCertificate.html differ diff --git a/Backup-DbaDbMasterKey.html b/Backup-DbaDbMasterKey.html index 6c655187..231a1973 100644 Binary files a/Backup-DbaDbMasterKey.html and b/Backup-DbaDbMasterKey.html differ diff --git a/Backup-DbaServiceMasterKey.html b/Backup-DbaServiceMasterKey.html index c86136ef..032c99fb 100644 Binary files a/Backup-DbaServiceMasterKey.html and b/Backup-DbaServiceMasterKey.html differ diff --git a/Clear-DbaConnectionPool.html b/Clear-DbaConnectionPool.html index 10f0ab07..a8153e80 100644 Binary files a/Clear-DbaConnectionPool.html and b/Clear-DbaConnectionPool.html differ diff --git a/Clear-DbaLatchStatistics.html b/Clear-DbaLatchStatistics.html index 665b3495..11ded22c 100644 Binary files a/Clear-DbaLatchStatistics.html and b/Clear-DbaLatchStatistics.html differ diff --git a/Clear-DbaPlanCache.html b/Clear-DbaPlanCache.html index b2db7e29..c27d4953 100644 Binary files a/Clear-DbaPlanCache.html and b/Clear-DbaPlanCache.html differ diff --git a/Clear-DbaWaitStatistics.html b/Clear-DbaWaitStatistics.html index 493ab504..da744aff 100644 Binary files a/Clear-DbaWaitStatistics.html and b/Clear-DbaWaitStatistics.html differ diff --git a/Compare-DbaCollationSensitiveObject.html b/Compare-DbaCollationSensitiveObject.html new file mode 100644 index 00000000..1cedaed0 --- /dev/null +++ b/Compare-DbaCollationSensitiveObject.html @@ -0,0 +1,740 @@ + + + + + + + dbatools docs | Compare-DbaCollationSensitiveObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Compare-DbaCollationSensitiveObject

+ + + + + + + + + + + + + + + + + +
AuthorCharles Hightower
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Filters InputObject, Compares a property to value(s) using a given sql server collation

+

Description

+

The Compare-DbaCollationSensitiveObject command filters an Inputobject using a string comparer builder provided by the SMO, for a given sql server collation.

+

Syntax

+
Compare-DbaCollationSensitiveObject -InputObject <PSObject> -Property <String> -In
+    [-Value <Object>] -Collation <String>
+    [<CommonParameters>]
+
+Compare-DbaCollationSensitiveObject -InputObject <PSObject> -Property <String> -NotIn
+    [-Value <Object>] -Collation <String>
+    [<CommonParameters>]
+
+Compare-DbaCollationSensitiveObject -InputObject <PSObject> -Property <String> -Eq
+    [-Value <Object>] -Collation <String>
+    [<CommonParameters>]
+
+Compare-DbaCollationSensitiveObject -InputObject <PSObject> -Property <String> -Ne
+    [-Value <Object>] -Collation <String>
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> $server = Connect-DbaInstance -SqlInstance localhost
+PS C:\> $lastCopyOnlyBackups = Get-DbaDbBackupHistory -SqlInstance $server -LastFull -IncludeCopyOnly | Where-Object IsCopyOnly
+PS C:\> $server.Databases | Compare-DbaCollationSensitiveObject -Property Name -In -Value $lastCopyOnlyBackups.Database -Collation $server.Collation
+
+

Returns all databases on the local default SQL Server instance with copy only backups using the collation of the SqlInstance

+
Example: 2
+
PS C:\> $server = Connect-DbaInstance -SqlInstance localhost
+PS C:\> $lastFullBackups = Get-DbaDbBackupHistory -SqlInstance $server -LastFull
+PS C:\> $server.Databases | Compare-DbaCollationSensitiveObject -Property Name -NotIn -Value $lastFullBackups.Database -Collation $server.Collation
+
+

Returns only the databases on the local default SQL Server instance without a Full Backup, using the collation of the SqlInstance

+

Required Parameters

+
-InputObject
+

The Object to Filter

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinetrue (ByValue)
Default Value
+
-Property
+

Name of the Property of InputObject to compare

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-In
+

Members of InputObject where the value of the Property is within the Value set are returned

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default ValueFalse
+
-NotIn
+

Members of InputObject where the value of the Property is not within the Value set are returned

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default ValueFalse
+
-Eq
+

Members of InputObject where the value of the Property is equivalent to the Value

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default ValueFalse
+
-Ne
+

Members of InputObject where the value of the Property is not not equivalent to the Value

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default ValueFalse
+
-Collation
+

Name of the collation to use for comparison

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-Value
+

Object that Property is compared against

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Compare-DbaCollationSensitiveObject on GitHub. +
+Want to see the Bill Of Health for this command? Check out Compare-DbaCollationSensitiveObject.

+ +
+
+
+
+ + + diff --git a/Connect-AsServer.html b/Connect-AsServer.html new file mode 100644 index 00000000..7b57afd8 --- /dev/null +++ b/Connect-AsServer.html @@ -0,0 +1,548 @@ + + + + + + + dbatools docs | Connect-AsServer + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Connect-AsServer

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal function that creates SMO server object.

+

Description

+

Internal function that creates SMO server object.

+

Syntax

+
Connect-AsServer
+    [-AsServer] <Object>
+    [-ParameterConnection]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Connect-AsServer -AsServer localhost
+Connects to SSAS on the local server

+

Required Parameters

+
-AsServer
+

Analysis Server

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-ParameterConnection
+

Shorten the timeout

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Connect-AsServer on GitHub. +
+Want to see the Bill Of Health for this command? Check out Connect-AsServer.

+ +
+
+
+
+ + + diff --git a/Connect-ConnstringInstance.html b/Connect-ConnstringInstance.html new file mode 100644 index 00000000..66a47b8d --- /dev/null +++ b/Connect-ConnstringInstance.html @@ -0,0 +1,669 @@ + + + + + + + dbatools docs | Connect-ConnstringInstance + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Connect-ConnstringInstance

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal function to establish smo connections using a connstring

+

Description

+

Internal function to establish smo connections using a connstring

+

Can interpret any of the following types of information:

+
    +
  • String
    • +
  • Smo Server objects
    • +
+

Syntax

+
Connect-ConnstringInstance
+    [-SqlInstance] <DbaInstanceParameter>
+    [[-SqlCredential] <PSCredential>]
+    [[-StatementTimeout] <Int32>]
+    [[-MinimumVersion] <Int32>]
+    [-AzureUnsupported]
+    [-NonPooled]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Connect-DbaInstance -SqlInstance sql2014
+Connect to the Server sql2014 with native credentials.

+

Required Parameters

+
-SqlInstance
+

The SQL Server instance to restore to.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-SqlCredential
+

Allows you to login to servers using SQL Logins as opposed to Windows Auth/Integrated/Trusted.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-StatementTimeout
+

Sets the number of seconds a statement is given to run before failing with a timeout error.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value0
+
-MinimumVersion
+

The minimum version that the calling command will support

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value0
+
-AzureUnsupported
+

Throw if Azure is detected but not supported

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-NonPooled
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Connect-ConnstringInstance on GitHub. +
+Want to see the Bill Of Health for this command? Check out Connect-ConnstringInstance.

+ +
+
+
+
+ + + diff --git a/Connect-DbaInstance.html b/Connect-DbaInstance.html index 094054ee..b8377b10 100644 Binary files a/Connect-DbaInstance.html and b/Connect-DbaInstance.html differ diff --git a/Connect-ReplicationDB.html b/Connect-ReplicationDB.html new file mode 100644 index 00000000..eed70389 --- /dev/null +++ b/Connect-ReplicationDB.html @@ -0,0 +1,570 @@ + + + + + + + dbatools docs | Connect-ReplicationDB + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Connect-ReplicationDB

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Connect-ReplicationDB [-Server ] [-Database ] -EnableException

+

Description

+

Syntax

+
Connect-ReplicationDBsyntaxItem----------{@{name=
+
+Connect-ReplicationDB; CommonParameters=False; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-Database
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-EnableException
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Server
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Connect-ReplicationDB on GitHub. +
+Want to see the Bill Of Health for this command? Check out Connect-ReplicationDB.

+ + + + + + + + diff --git a/Convert-ByteToHexString.html b/Convert-ByteToHexString.html new file mode 100644 index 00000000..83f7b893 --- /dev/null +++ b/Convert-ByteToHexString.html @@ -0,0 +1,526 @@ + + + + + + + dbatools docs | Convert-ByteToHexString + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Convert-ByteToHexString

+ + + + + + + + + + + + + + + + + +
AuthorKirill Kravtsov (@nvarscar)
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Converts byte object into hex string

+

Description

+

Converts byte object ([byte[]]@(1,100,23,54)) into the hex string (e.g. '0x01641736') +Used when working with SMO logins and their byte parameters: sids and hashed passwords

+

Syntax

+
Convert-ByteToHexString
+    [[-InputObject] <Byte[]>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Convert-ByteToHexString ([byte[]]@(1,100,23,54))
+Returns hex string '0x01641736'

+
Example: 2
+

PS > Convert-ByteToHexString 18,52
+Returns hex string '0x1234'

+

Optional Parameters

+
-InputObject
+

Input byte[] object (e.g. [byte[]]@(18,52))

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Convert-ByteToHexString on GitHub. +
+Want to see the Bill Of Health for this command? Check out Convert-ByteToHexString.

+ +
+
+
+
+ + + diff --git a/Convert-ConnectionString.html b/Convert-ConnectionString.html new file mode 100644 index 00000000..10e0954d --- /dev/null +++ b/Convert-ConnectionString.html @@ -0,0 +1,514 @@ + + + + + + + dbatools docs | Convert-ConnectionString + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Convert-ConnectionString

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Convert-ConnectionString -ConnectionString <string[]> []

+

Description

+

Syntax

+
Convert-ConnectionStringsyntaxItem----------{@{name=
+
+Convert-ConnectionString; CommonParameters=True; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-ConnectionString
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinetrue (ByValue)
Default Value
+

 

+

Want to see the source code for this command? Check out Convert-ConnectionString on GitHub. +
+Want to see the Bill Of Health for this command? Check out Convert-ConnectionString.

+ +
+
+
+
+ + + diff --git a/Convert-DbVersionToSqlVersion.html b/Convert-DbVersionToSqlVersion.html new file mode 100644 index 00000000..1d19948a --- /dev/null +++ b/Convert-DbVersionToSqlVersion.html @@ -0,0 +1,518 @@ + + + + + + + dbatools docs | Convert-DbVersionToSqlVersion + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Convert-DbVersionToSqlVersion

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal function that makes db versions human readable

+

Description

+

Internal function that makes db versions human readable

+

Syntax

+
Convert-DbVersionToSqlVersion
+    [[-dbversion] <String>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Convert-DbVersionToSqlVersion -dbversion 856
+Returns "SQL Server vNext CTP1"

+

Optional Parameters

+
-dbversion
+

Analysis Server

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Convert-DbVersionToSqlVersion on GitHub. +
+Want to see the Bill Of Health for this command? Check out Convert-DbVersionToSqlVersion.

+ +
+
+
+
+ + + diff --git a/Convert-DbaIndexToTable.html b/Convert-DbaIndexToTable.html new file mode 100644 index 00000000..b01a2748 --- /dev/null +++ b/Convert-DbaIndexToTable.html @@ -0,0 +1,710 @@ + + + + + + + dbatools docs | Convert-DbaIndexToTable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Convert-DbaIndexToTable

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Convert-DbaIndexToTable [-SqlInstance ] [-SqlCredential ] [-Database <string[]>] [-Schema <string[]>] [-Table <string[]>] [-Index <string[]>] -Unique -EnableException []

+

Description

+

Syntax

+
Convert-DbaIndexToTablesyntaxItem----------{@{name=
+
+Convert-DbaIndexToTable; CommonParameters=True; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-Database
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-EnableException
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Index
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Schema
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-SqlCredential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-SqlInstance
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Table
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Unique
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Convert-DbaIndexToTable on GitHub. +
+Want to see the Bill Of Health for this command? Check out Convert-DbaIndexToTable.

+ +
+
+
+
+ + + diff --git a/Convert-DbaLSN.html b/Convert-DbaLSN.html new file mode 100644 index 00000000..0bb3dbb4 --- /dev/null +++ b/Convert-DbaLSN.html @@ -0,0 +1,550 @@ + + + + + + + dbatools docs | Convert-DbaLSN + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Convert-DbaLSN

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Converts Lsns betweent Hex and/or numeric formats

+

Description

+

Function takes an LSN in either split Hexadecimal format () or numberic

+

It then returns both formats in an object

+

Syntax

+
Convert-DbaLSN
+    [[-LSN] <String>]
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > PS C:\ $output = Convert-DbaLSN -LSN 0000002f:000044aa:002b
+Will return object $Output with the following value
+$Output.HexLSN = 0000002f:000044aa:002b
+$Output.NumbericLSN =

+

Optional Parameters

+
-LSN
+

The LSN value to be converted

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-EnableException
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Convert-DbaLSN on GitHub. +
+Want to see the Bill Of Health for this command? Check out Convert-DbaLSN.

+ +
+
+
+
+ + + diff --git a/Convert-DbaMaskingValue.html b/Convert-DbaMaskingValue.html new file mode 100644 index 00000000..e6321df6 --- /dev/null +++ b/Convert-DbaMaskingValue.html @@ -0,0 +1,624 @@ + + + + + + + dbatools docs | Convert-DbaMaskingValue + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Convert-DbaMaskingValue

+ + + + + + + + + + + + + + + + + +
AuthorSander Stad (@sqlstad, sqlstad.nl)
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Convert a value to a TSQL format that be used in queries

+

Description

+

The command will take a value and with the data type return it in a format +that can be used in queries.

+

For instance, a value "this is text" with data type 'varchar' will be returned as +'this is text' with the single quotes

+

It returns an object with the following properties

+
    +
  • OriginalValue
    • +
  • NewValue +-DataType +-ErrorMessage
    • +
+

Syntax

+
Convert-DbaMaskingValue
+    [[-Value] <Object[]>]
+    [[-DataType] <String>]
+    [-Nullable]
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Convert-DbaMaskingValue -Value "please convert this" -DataType varchar
+Will convert ""please convert this" to "'please convert this'"

+
Example: 2
+

PS > Convert-DbaMaskingValue -Value $null -DataType varchar -Nullable
+Will convert null to "NULL"

+

Optional Parameters

+
-Value
+

The value to be converted

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinetrue (ByValue)
Default Value
+
-DataType
+

Data type the value needs to be converted to

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Nullable
+

It's possible to send a null value. It will then be converted to 'NULL' for SQL Server

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Convert-DbaMaskingValue on GitHub. +
+Want to see the Bill Of Health for this command? Check out Convert-DbaMaskingValue.

+ +
+
+
+
+ + + diff --git a/Convert-DbaMessageException.html b/Convert-DbaMessageException.html new file mode 100644 index 00000000..d6548239 --- /dev/null +++ b/Convert-DbaMessageException.html @@ -0,0 +1,578 @@ + + + + + + + dbatools docs | Convert-DbaMessageException + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Convert-DbaMessageException

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Transforms the Exception input to the message system.

+

Description

+

Transforms the Exception input to the message system.

+

If there is an exception running a transformation scriptblock, it will log the error in the transform error queue and return the original object instead.

+

Syntax

+
Convert-DbaMessageException
+    [-Exception] <Object>
+    [-FunctionName] <String>
+    [-ModuleName] <String>
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Convert-DbaMessageException -Exception $Exception -FunctionName 'Get-Test' -ModuleName 'MyModule'
+
+

Checks internal storage for definitions that require a Exception transform, and either returns the original object or the transformed object.

+

Required Parameters

+
-Exception
+

The input Exception object, that might have to be transformed (may not either)

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-FunctionName
+

The function writing the message

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-ModuleName
+

The module, that the function writing the message is part of

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Convert-DbaMessageException on GitHub. +
+Want to see the Bill Of Health for this command? Check out Convert-DbaMessageException.

+ +
+
+
+
+ + + diff --git a/Convert-DbaMessageLevel.html b/Convert-DbaMessageLevel.html new file mode 100644 index 00000000..2923a792 --- /dev/null +++ b/Convert-DbaMessageLevel.html @@ -0,0 +1,640 @@ + + + + + + + dbatools docs | Convert-DbaMessageLevel + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Convert-DbaMessageLevel

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Processes the effective message level of a message

+

Description

+

Processes the effective message level of a message

+
    +
  • Applies level decrements
    • +
  • Applies message level modifiers
    • +
+

Syntax

+
Convert-DbaMessageLevel
+    [-OriginalLevel] {Critical | Important | Output | Significant | VeryVerbose | Verbose | SomewhatVerbose | System | Debug | InternalComment | Warning}
+    [-FromStopFunction] <Boolean>
+    [-Tags] <String[]>
+    [-FunctionName] <String>
+    [-ModuleName] <String>
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Convert-DbaMessageLevel -OriginalLevel $Level -FromStopFunction $fromStopFunction -Tags $Tag -FunctionName $FunctionName -ModuleName $ModuleName
+This will convert the original level of $Level based on the transformation rules for levels.

+

Required Parameters

+
-OriginalLevel
+

The level the message was originally written to

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-FromStopFunction
+

Whether the message was passed through Stop-Function first. +This is used to increment the automatic message level decrement counter by 1 (so it ignores the fact, that it was passed through Stop-Function). +The automatic message level decrement functionality allows users to make nested commands' messages be less verbose.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default ValueFalse
+
-Tags
+

The tags that were added to the message

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-FunctionName
+

The function that wrote the message.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-ModuleName
+

The module the function writing the message comes from.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Convert-DbaMessageLevel on GitHub. +
+Want to see the Bill Of Health for this command? Check out Convert-DbaMessageLevel.

+ +
+
+
+
+ + + diff --git a/Convert-DbaMessageTarget.html b/Convert-DbaMessageTarget.html new file mode 100644 index 00000000..3868cd1b --- /dev/null +++ b/Convert-DbaMessageTarget.html @@ -0,0 +1,578 @@ + + + + + + + dbatools docs | Convert-DbaMessageTarget + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Convert-DbaMessageTarget

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Transforms the target input to the message system.

+

Description

+

Transforms the target input to the message system.

+

If there is an exception running a transformation scriptblock, it will log the error in the transform error queue and return the original object instead.

+

Syntax

+
Convert-DbaMessageTarget
+    [-Target] <Object>
+    [-FunctionName] <String>
+    [-ModuleName] <String>
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Convert-DbaMessageTarget -Target $Target -FunctionName 'Get-Test' -ModuleName 'MyModule'
+
+

Checks internal storage for definitions that require a target transform, and either returns the original object or the transformed object.

+

Required Parameters

+
-Target
+

The input target object, that might have to be transformed (may not either)

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-FunctionName
+

The function writing the message

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-ModuleName
+

The module, that the function writing the message is part of

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Convert-DbaMessageTarget on GitHub. +
+Want to see the Bill Of Health for this command? Check out Convert-DbaMessageTarget.

+ +
+
+
+
+ + + diff --git a/Convert-DbaTimelineStatusColor.html b/Convert-DbaTimelineStatusColor.html new file mode 100644 index 00000000..e44678ac --- /dev/null +++ b/Convert-DbaTimelineStatusColor.html @@ -0,0 +1,529 @@ + + + + + + + dbatools docs | Convert-DbaTimelineStatusColor + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Convert-DbaTimelineStatusColor

+ + + + + + + + + + + + + + + + + +
AuthorMarcin Gminski (@marcingminski)
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Converts literal string status to a html color

+

Description

+

This function acceptes Agent Job status as literal string input and covnerts to html color. +This is internal function, part of ConvertTo-DbaTimeline

+

Syntax

+
Convert-DbaTimelineStatusColor
+    [-Status] <String>
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Convert-DbaTimelineStatusColor ("Succeeded")
+Returned string: #36B300

+

Required Parameters

+
-Status
+

The Status input parameter must be a valid SQL Agent Job status as literal string as defined in MS Books: +Status of the job execution: +Failed +Succeeded +Retry +Canceled +In Progress

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Convert-DbaTimelineStatusColor on GitHub. +
+Want to see the Bill Of Health for this command? Check out Convert-DbaTimelineStatusColor.

+ +
+
+
+
+ + + diff --git a/Convert-HexStringToByte.html b/Convert-HexStringToByte.html new file mode 100644 index 00000000..f765001a --- /dev/null +++ b/Convert-HexStringToByte.html @@ -0,0 +1,526 @@ + + + + + + + dbatools docs | Convert-HexStringToByte + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Convert-HexStringToByte

+ + + + + + + + + + + + + + + + + +
AuthorKirill Kravtsov (@nvarscar)
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Converts hex string into byte object

+

Description

+

Converts hex string (e.g. '0x01641736') into the byte object ([byte[]]@(1,100,23,54)) +Used when working with SMO logins and their byte parameters: sids and hashed passwords

+

Syntax

+
Convert-HexStringToByte
+    [[-InputObject] <String>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Convert-HexStringToByte '0x01641736'
+Returns byte[] object [byte[]]@(1,100,23,54)

+
Example: 2
+

PS > Convert-HexStringToByte '1234'
+Returns byte[] object [byte[]]@(18,52)

+

Optional Parameters

+
-InputObject
+

Input hex string (e.g. '0x1234' or 'DBA2FF')

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Convert-HexStringToByte on GitHub. +
+Want to see the Bill Of Health for this command? Check out Convert-HexStringToByte.

+ +
+
+
+
+ + + diff --git a/ConvertFrom-SecurePass.html b/ConvertFrom-SecurePass.html new file mode 100644 index 00000000..e8383f5a --- /dev/null +++ b/ConvertFrom-SecurePass.html @@ -0,0 +1,514 @@ + + + + + + + dbatools docs | ConvertFrom-SecurePass + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

ConvertFrom-SecurePass

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

ConvertFrom-SecurePass [-InputObject ] []

+

Description

+

Syntax

+
ConvertFrom-SecurePasssyntaxItem----------{@{name=
+
+ConvertFrom-SecurePass; CommonParameters=True; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-InputObject
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinetrue (ByValue)
Default Value
+

 

+

Want to see the source code for this command? Check out ConvertFrom-SecurePass on GitHub. +
+Want to see the Bill Of Health for this command? Check out ConvertFrom-SecurePass.

+ +
+
+
+
+ + + diff --git a/ConvertTo-DbaDataTable.html b/ConvertTo-DbaDataTable.html index c392e5d4..ce992c72 100644 Binary files a/ConvertTo-DbaDataTable.html and b/ConvertTo-DbaDataTable.html differ diff --git a/ConvertTo-DbaTimeline.html b/ConvertTo-DbaTimeline.html index a253d0e9..d38819e1 100644 Binary files a/ConvertTo-DbaTimeline.html and b/ConvertTo-DbaTimeline.html differ diff --git a/ConvertTo-DbaXESession.html b/ConvertTo-DbaXESession.html index fb2f21ef..66814611 100644 Binary files a/ConvertTo-DbaXESession.html and b/ConvertTo-DbaXESession.html differ diff --git a/ConvertTo-JsDate.html b/ConvertTo-JsDate.html new file mode 100644 index 00000000..a0e590e4 --- /dev/null +++ b/ConvertTo-JsDate.html @@ -0,0 +1,525 @@ + + + + + + + dbatools docs | ConvertTo-JsDate + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

ConvertTo-JsDate

+ + + + + + + + + + + + + + + + + +
AuthorMarcin Gminski (@marcingminski)
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Converts Datetime input to a Java Script date format

+

Description

+

This function acceptes date time input and converts to a Java script compatible format. +Java Script date time format: +New date (yyyy, MM, dd, HH, mm, ss)

+

This is internal function part of ConvertTo-DbaTimeline

+

Syntax

+
ConvertTo-JsDate
+    [-InputDate] <DateTime>
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > ConvertTo-JsDate (Get-Date)
+Returned output: new Date(2018, 7, 14, 07, 40, 42)

+

Required Parameters

+
-InputDate
+

The InputDate parameter must be a valid datetime type

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out ConvertTo-JsDate on GitHub. +
+Want to see the Bill Of Health for this command? Check out ConvertTo-JsDate.

+ +
+
+
+
+ + + diff --git a/Copy-DbaAgentAlert.html b/Copy-DbaAgentAlert.html index 02bc8e9e..4972868c 100644 Binary files a/Copy-DbaAgentAlert.html and b/Copy-DbaAgentAlert.html differ diff --git a/Copy-DbaAgentJob.html b/Copy-DbaAgentJob.html index db213284..6ae384eb 100644 Binary files a/Copy-DbaAgentJob.html and b/Copy-DbaAgentJob.html differ diff --git a/Copy-DbaAgentJobCategory.html b/Copy-DbaAgentJobCategory.html index 4aab42ec..cdded852 100644 Binary files a/Copy-DbaAgentJobCategory.html and b/Copy-DbaAgentJobCategory.html differ diff --git a/Copy-DbaAgentOperator.html b/Copy-DbaAgentOperator.html index dad12ed1..f4bf248c 100644 Binary files a/Copy-DbaAgentOperator.html and b/Copy-DbaAgentOperator.html differ diff --git a/Copy-DbaAgentProxy.html b/Copy-DbaAgentProxy.html index 1788970d..a2ca93a8 100644 Binary files a/Copy-DbaAgentProxy.html and b/Copy-DbaAgentProxy.html differ diff --git a/Copy-DbaAgentSchedule.html b/Copy-DbaAgentSchedule.html index 051af571..94656980 100644 Binary files a/Copy-DbaAgentSchedule.html and b/Copy-DbaAgentSchedule.html differ diff --git a/Copy-DbaAgentServer.html b/Copy-DbaAgentServer.html index d7ac12ae..7526b98e 100644 Binary files a/Copy-DbaAgentServer.html and b/Copy-DbaAgentServer.html differ diff --git a/Copy-DbaBackupDevice.html b/Copy-DbaBackupDevice.html index c9b4d55b..07ae9b44 100644 Binary files a/Copy-DbaBackupDevice.html and b/Copy-DbaBackupDevice.html differ diff --git a/Copy-DbaCredential.html b/Copy-DbaCredential.html index a2f8dcbd..91ded824 100644 Binary files a/Copy-DbaCredential.html and b/Copy-DbaCredential.html differ diff --git a/Copy-DbaCustomError.html b/Copy-DbaCustomError.html index 48c09b30..cb296c0b 100644 Binary files a/Copy-DbaCustomError.html and b/Copy-DbaCustomError.html differ diff --git a/Copy-DbaDataCollector.html b/Copy-DbaDataCollector.html index a14af451..e7db4e7f 100644 Binary files a/Copy-DbaDataCollector.html and b/Copy-DbaDataCollector.html differ diff --git a/Copy-DbaDatabase.html b/Copy-DbaDatabase.html index 7f94a6cf..01f0addd 100644 Binary files a/Copy-DbaDatabase.html and b/Copy-DbaDatabase.html differ diff --git a/Copy-DbaDbAssembly.html b/Copy-DbaDbAssembly.html index 0480d603..6465448f 100644 Binary files a/Copy-DbaDbAssembly.html and b/Copy-DbaDbAssembly.html differ diff --git a/Copy-DbaDbCertificate.html b/Copy-DbaDbCertificate.html index 10ebd7d5..0303cf0a 100644 Binary files a/Copy-DbaDbCertificate.html and b/Copy-DbaDbCertificate.html differ diff --git a/Copy-DbaDbMail.html b/Copy-DbaDbMail.html index b471c441..ccd79bab 100644 Binary files a/Copy-DbaDbMail.html and b/Copy-DbaDbMail.html differ diff --git a/Copy-DbaDbQueryStoreOption.html b/Copy-DbaDbQueryStoreOption.html index e7d2fa4b..7f0abdd9 100644 Binary files a/Copy-DbaDbQueryStoreOption.html and b/Copy-DbaDbQueryStoreOption.html differ diff --git a/Copy-DbaDbTableData.html b/Copy-DbaDbTableData.html index fa968d4d..c322746d 100644 Binary files a/Copy-DbaDbTableData.html and b/Copy-DbaDbTableData.html differ diff --git a/Copy-DbaDbViewData.html b/Copy-DbaDbViewData.html index 3ed5a9a2..8c70bb07 100644 Binary files a/Copy-DbaDbViewData.html and b/Copy-DbaDbViewData.html differ diff --git a/Copy-DbaEndpoint.html b/Copy-DbaEndpoint.html index 0c91f66f..a6243796 100644 Binary files a/Copy-DbaEndpoint.html and b/Copy-DbaEndpoint.html differ diff --git a/Copy-DbaInstanceAudit.html b/Copy-DbaInstanceAudit.html index c2000fbd..0e88530b 100644 Binary files a/Copy-DbaInstanceAudit.html and b/Copy-DbaInstanceAudit.html differ diff --git a/Copy-DbaInstanceAuditSpecification.html b/Copy-DbaInstanceAuditSpecification.html index bbffb842..735644ae 100644 Binary files a/Copy-DbaInstanceAuditSpecification.html and b/Copy-DbaInstanceAuditSpecification.html differ diff --git a/Copy-DbaInstanceTrigger.html b/Copy-DbaInstanceTrigger.html index bba17287..99e19159 100644 Binary files a/Copy-DbaInstanceTrigger.html and b/Copy-DbaInstanceTrigger.html differ diff --git a/Copy-DbaLinkedServer.html b/Copy-DbaLinkedServer.html index ea634a4a..f0ed980b 100644 Binary files a/Copy-DbaLinkedServer.html and b/Copy-DbaLinkedServer.html differ diff --git a/Copy-DbaLogin.html b/Copy-DbaLogin.html index b6f458d8..2f6b183e 100644 Binary files a/Copy-DbaLogin.html and b/Copy-DbaLogin.html differ diff --git a/Copy-DbaPolicyManagement.html b/Copy-DbaPolicyManagement.html index a9f7685d..214a2bb2 100644 Binary files a/Copy-DbaPolicyManagement.html and b/Copy-DbaPolicyManagement.html differ diff --git a/Copy-DbaRegServer.html b/Copy-DbaRegServer.html index 51a8fb56..98219167 100644 Binary files a/Copy-DbaRegServer.html and b/Copy-DbaRegServer.html differ diff --git a/Copy-DbaResourceGovernor.html b/Copy-DbaResourceGovernor.html index 9fd957b7..7726344f 100644 Binary files a/Copy-DbaResourceGovernor.html and b/Copy-DbaResourceGovernor.html differ diff --git a/Copy-DbaSpConfigure.html b/Copy-DbaSpConfigure.html index 9c969a08..4b608f9d 100644 Binary files a/Copy-DbaSpConfigure.html and b/Copy-DbaSpConfigure.html differ diff --git a/Copy-DbaStartupProcedure.html b/Copy-DbaStartupProcedure.html index e6e82936..a6b1d865 100644 Binary files a/Copy-DbaStartupProcedure.html and b/Copy-DbaStartupProcedure.html differ diff --git a/Copy-DbaSysDbUserObject.html b/Copy-DbaSysDbUserObject.html index 90f692a2..77c34eb0 100644 Binary files a/Copy-DbaSysDbUserObject.html and b/Copy-DbaSysDbUserObject.html differ diff --git a/Copy-DbaXESession.html b/Copy-DbaXESession.html index 46053786..c20142aa 100644 Binary files a/Copy-DbaXESession.html and b/Copy-DbaXESession.html differ diff --git a/Copy-DbaXESessionTemplate.html b/Copy-DbaXESessionTemplate.html index d4a91088..86caa5d4 100644 Binary files a/Copy-DbaXESessionTemplate.html and b/Copy-DbaXESessionTemplate.html differ diff --git a/Disable-DbaAgHadr.html b/Disable-DbaAgHadr.html index 7da7043d..643f1fdc 100644 Binary files a/Disable-DbaAgHadr.html and b/Disable-DbaAgHadr.html differ diff --git a/Disable-DbaDbEncryption.html b/Disable-DbaDbEncryption.html index 38ab060a..edce1782 100644 Binary files a/Disable-DbaDbEncryption.html and b/Disable-DbaDbEncryption.html differ diff --git a/Disable-DbaFilestream.html b/Disable-DbaFilestream.html index 32b369fd..c98030d2 100644 Binary files a/Disable-DbaFilestream.html and b/Disable-DbaFilestream.html differ diff --git a/Disable-DbaForceNetworkEncryption.html b/Disable-DbaForceNetworkEncryption.html index 2b1d83cb..247f34c0 100644 Binary files a/Disable-DbaForceNetworkEncryption.html and b/Disable-DbaForceNetworkEncryption.html differ diff --git a/Disable-DbaHideInstance.html b/Disable-DbaHideInstance.html index 97385f8c..17556606 100644 Binary files a/Disable-DbaHideInstance.html and b/Disable-DbaHideInstance.html differ diff --git a/Disable-DbaStartupProcedure.html b/Disable-DbaStartupProcedure.html index f705f156..44c694b6 100644 Binary files a/Disable-DbaStartupProcedure.html and b/Disable-DbaStartupProcedure.html differ diff --git a/Disable-DbaTraceFlag.html b/Disable-DbaTraceFlag.html index c8b48641..b259885d 100644 Binary files a/Disable-DbaTraceFlag.html and b/Disable-DbaTraceFlag.html differ diff --git a/Disconnect-DbaInstance.html b/Disconnect-DbaInstance.html index d2216624..36073aad 100644 Binary files a/Disconnect-DbaInstance.html and b/Disconnect-DbaInstance.html differ diff --git a/Disconnect-Regserver.html b/Disconnect-Regserver.html new file mode 100644 index 00000000..1c7c38cf --- /dev/null +++ b/Disconnect-Regserver.html @@ -0,0 +1,514 @@ + + + + + + + dbatools docs | Disconnect-Regserver + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Disconnect-Regserver

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Disconnect-Regserver [-Server ]

+

Description

+

Syntax

+
Disconnect-RegserversyntaxItem----------{@{name=
+
+Disconnect-Regserver; CommonParameters=False; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-Server
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Disconnect-Regserver on GitHub. +
+Want to see the Bill Of Health for this command? Check out Disconnect-Regserver.

+ + + + + + + + diff --git a/Dismount-DbaDatabase.html b/Dismount-DbaDatabase.html index 26722c6d..2bc1d9ce 100644 Binary files a/Dismount-DbaDatabase.html and b/Dismount-DbaDatabase.html differ diff --git a/Enable-DbaAgHadr.html b/Enable-DbaAgHadr.html index 6a5d5cda..7513a140 100644 Binary files a/Enable-DbaAgHadr.html and b/Enable-DbaAgHadr.html differ diff --git a/Enable-DbaDbEncryption.html b/Enable-DbaDbEncryption.html index 5563e3c4..1cf34719 100644 Binary files a/Enable-DbaDbEncryption.html and b/Enable-DbaDbEncryption.html differ diff --git a/Enable-DbaFilestream.html b/Enable-DbaFilestream.html index 91fbe9ef..586650c3 100644 Binary files a/Enable-DbaFilestream.html and b/Enable-DbaFilestream.html differ diff --git a/Enable-DbaForceNetworkEncryption.html b/Enable-DbaForceNetworkEncryption.html index e84abea7..27609c14 100644 Binary files a/Enable-DbaForceNetworkEncryption.html and b/Enable-DbaForceNetworkEncryption.html differ diff --git a/Enable-DbaHideInstance.html b/Enable-DbaHideInstance.html index 7212fabc..3adb1f0a 100644 Binary files a/Enable-DbaHideInstance.html and b/Enable-DbaHideInstance.html differ diff --git a/Enable-DbaStartupProcedure.html b/Enable-DbaStartupProcedure.html index b5761f99..3559b223 100644 Binary files a/Enable-DbaStartupProcedure.html and b/Enable-DbaStartupProcedure.html differ diff --git a/Enable-DbaTraceFlag.html b/Enable-DbaTraceFlag.html index 58d6af51..ee608fd3 100644 Binary files a/Enable-DbaTraceFlag.html and b/Enable-DbaTraceFlag.html differ diff --git a/Expand-DbaDbLogFile.html b/Expand-DbaDbLogFile.html index 051dc9e7..6a356dc7 100644 Binary files a/Expand-DbaDbLogFile.html and b/Expand-DbaDbLogFile.html differ diff --git a/Export-DbaCredential.html b/Export-DbaCredential.html index 7cd1c101..ed73fd03 100644 Binary files a/Export-DbaCredential.html and b/Export-DbaCredential.html differ diff --git a/Export-DbaDacPackage.html b/Export-DbaDacPackage.html index 0b103209..c9fb4f64 100644 Binary files a/Export-DbaDacPackage.html and b/Export-DbaDacPackage.html differ diff --git a/Export-DbaDbRole.html b/Export-DbaDbRole.html index 3c191667..677066e9 100644 Binary files a/Export-DbaDbRole.html and b/Export-DbaDbRole.html differ diff --git a/Export-DbaDbTableData.html b/Export-DbaDbTableData.html index eff564b9..e86afba8 100644 Binary files a/Export-DbaDbTableData.html and b/Export-DbaDbTableData.html differ diff --git a/Export-DbaDiagnosticQuery.html b/Export-DbaDiagnosticQuery.html index fce22874..dc259ab0 100644 Binary files a/Export-DbaDiagnosticQuery.html and b/Export-DbaDiagnosticQuery.html differ diff --git a/Export-DbaExecutionPlan.html b/Export-DbaExecutionPlan.html index 02805d2d..8dd1dec9 100644 Binary files a/Export-DbaExecutionPlan.html and b/Export-DbaExecutionPlan.html differ diff --git a/Export-DbaInstance.html b/Export-DbaInstance.html index c44237cd..2fa8cda6 100644 Binary files a/Export-DbaInstance.html and b/Export-DbaInstance.html differ diff --git a/Export-DbaLinkedServer.html b/Export-DbaLinkedServer.html index 69cea80a..c26e229b 100644 Binary files a/Export-DbaLinkedServer.html and b/Export-DbaLinkedServer.html differ diff --git a/Export-DbaLogin.html b/Export-DbaLogin.html index 34cde6a3..1a50df36 100644 Binary files a/Export-DbaLogin.html and b/Export-DbaLogin.html differ diff --git a/Export-DbaPfDataCollectorSetTemplate.html b/Export-DbaPfDataCollectorSetTemplate.html index e65b2614..7ddc74e5 100644 Binary files a/Export-DbaPfDataCollectorSetTemplate.html and b/Export-DbaPfDataCollectorSetTemplate.html differ diff --git a/Export-DbaRegServer.html b/Export-DbaRegServer.html index 4ae91cbe..8f32a0a5 100644 Binary files a/Export-DbaRegServer.html and b/Export-DbaRegServer.html differ diff --git a/Export-DbaRepServerSetting.html b/Export-DbaRepServerSetting.html index d4922d35..23365d38 100644 Binary files a/Export-DbaRepServerSetting.html and b/Export-DbaRepServerSetting.html differ diff --git a/Export-DbaScript.html b/Export-DbaScript.html index ed312acd..06b88961 100644 Binary files a/Export-DbaScript.html and b/Export-DbaScript.html differ diff --git a/Export-DbaServerRole.html b/Export-DbaServerRole.html index 2a6e3da4..11710697 100644 Binary files a/Export-DbaServerRole.html and b/Export-DbaServerRole.html differ diff --git a/Export-DbaSpConfigure.html b/Export-DbaSpConfigure.html index 8dd24c47..32680254 100644 Binary files a/Export-DbaSpConfigure.html and b/Export-DbaSpConfigure.html differ diff --git a/Export-DbaSysDbUserObject.html b/Export-DbaSysDbUserObject.html index f824cbe4..fcc2e002 100644 Binary files a/Export-DbaSysDbUserObject.html and b/Export-DbaSysDbUserObject.html differ diff --git a/Export-DbaUser.html b/Export-DbaUser.html index 8fa329a1..a43eab5b 100644 Binary files a/Export-DbaUser.html and b/Export-DbaUser.html differ diff --git a/Export-DbaXECsv.html b/Export-DbaXECsv.html index 20c6ad3e..b9d46825 100644 Binary files a/Export-DbaXECsv.html and b/Export-DbaXECsv.html differ diff --git a/Export-DbaXESession.html b/Export-DbaXESession.html index 02cd450f..06756a44 100644 Binary files a/Export-DbaXESession.html and b/Export-DbaXESession.html differ diff --git a/Export-DbaXESessionTemplate.html b/Export-DbaXESessionTemplate.html index cb6f9a38..0947a471 100644 Binary files a/Export-DbaXESessionTemplate.html and b/Export-DbaXESessionTemplate.html differ diff --git a/Export-DbatoolsConfig.html b/Export-DbatoolsConfig.html index 1bfcb234..c872a914 100644 Binary files a/Export-DbatoolsConfig.html and b/Export-DbatoolsConfig.html differ diff --git a/Find-DbaAgentJob.html b/Find-DbaAgentJob.html index a9a9e211..8d3b067a 100644 Binary files a/Find-DbaAgentJob.html and b/Find-DbaAgentJob.html differ diff --git a/Find-DbaBackup.html b/Find-DbaBackup.html index 5535dd19..0ba5da20 100644 Binary files a/Find-DbaBackup.html and b/Find-DbaBackup.html differ diff --git a/Find-DbaCommand.html b/Find-DbaCommand.html index 1ad5100a..24cd5781 100644 Binary files a/Find-DbaCommand.html and b/Find-DbaCommand.html differ diff --git a/Find-DbaDatabase.html b/Find-DbaDatabase.html index 02e0862d..92381c9a 100644 Binary files a/Find-DbaDatabase.html and b/Find-DbaDatabase.html differ diff --git a/Find-DbaDbDisabledIndex.html b/Find-DbaDbDisabledIndex.html index 1c15b3aa..0cabd895 100644 Binary files a/Find-DbaDbDisabledIndex.html and b/Find-DbaDbDisabledIndex.html differ diff --git a/Find-DbaDbDuplicateIndex.html b/Find-DbaDbDuplicateIndex.html index 4c28c6aa..f890215a 100644 Binary files a/Find-DbaDbDuplicateIndex.html and b/Find-DbaDbDuplicateIndex.html differ diff --git a/Find-DbaDbGrowthEvent.html b/Find-DbaDbGrowthEvent.html index faad3917..613a671c 100644 Binary files a/Find-DbaDbGrowthEvent.html and b/Find-DbaDbGrowthEvent.html differ diff --git a/Find-DbaDbUnusedIndex.html b/Find-DbaDbUnusedIndex.html index 824baa6d..402a30a6 100644 Binary files a/Find-DbaDbUnusedIndex.html and b/Find-DbaDbUnusedIndex.html differ diff --git a/Find-DbaInstance.html b/Find-DbaInstance.html index fb8f394e..20489a1c 100644 Binary files a/Find-DbaInstance.html and b/Find-DbaInstance.html differ diff --git a/Find-DbaLoginInGroup.html b/Find-DbaLoginInGroup.html index 5abdbc9c..54cadc61 100644 Binary files a/Find-DbaLoginInGroup.html and b/Find-DbaLoginInGroup.html differ diff --git a/Find-DbaOrphanedFile.html b/Find-DbaOrphanedFile.html index 98c47035..de41ea27 100644 Binary files a/Find-DbaOrphanedFile.html and b/Find-DbaOrphanedFile.html differ diff --git a/Find-DbaSimilarTable.html b/Find-DbaSimilarTable.html index 044e965f..fcb95ce6 100644 Binary files a/Find-DbaSimilarTable.html and b/Find-DbaSimilarTable.html differ diff --git a/Find-DbaStoredProcedure.html b/Find-DbaStoredProcedure.html index eb7f3e8e..52932a84 100644 Binary files a/Find-DbaStoredProcedure.html and b/Find-DbaStoredProcedure.html differ diff --git a/Find-DbaTrigger.html b/Find-DbaTrigger.html index 73fa0ba2..5e2d91b7 100644 Binary files a/Find-DbaTrigger.html and b/Find-DbaTrigger.html differ diff --git a/Find-DbaUserObject.html b/Find-DbaUserObject.html index 465ae1d9..f115dc49 100644 Binary files a/Find-DbaUserObject.html and b/Find-DbaUserObject.html differ diff --git a/Find-DbaView.html b/Find-DbaView.html index f22ef811..2b997a30 100644 Binary files a/Find-DbaView.html and b/Find-DbaView.html differ diff --git a/Find-SqlInstanceSetup.html b/Find-SqlInstanceSetup.html new file mode 100644 index 00000000..6ff281e1 --- /dev/null +++ b/Find-SqlInstanceSetup.html @@ -0,0 +1,651 @@ + + + + + + + dbatools docs | Find-SqlInstanceSetup + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Find-SqlInstanceSetup

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Returns a SQL Server setup.exe filesystem object based on parameters

+

Description

+

Recursively searches specified folder for a setup.exe file that has the following .VersionInfo:

+
    +
  • FileDescription in : +
      +
    • Sql Server Setup Bootstrapper
      • +
    • Native SQL Install Bootstrapper
      • +
    +
    • +
  • Product: +Microsoft SQL Server +Microsoft SQL Server Setup
    • +
  • ProductVersion: Major and Minor versions should be the same
    • +
+

Syntax

+
Find-SqlInstanceSetup
+    [[-ComputerName] <DbaInstanceParameter>]
+    [[-Credential] <PSCredential>]
+    [[-Authentication] <String>]
+    [-Version] <Version>
+    [[-Path] <String[]>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS>Find-SqlInstanceSetup -Version 11.0 -Path \my\updates
+Looks for setup.exe in \my\updates and all the subfolders

+

Required Parameters

+
-Version
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-ComputerName
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value$env:COMPUTERNAME
+
-Credential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Authentication
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueDefault
Accepted ValuesDefault,Basic,Negotiate,NegotiateWithImplicitCredential,Credssp,Digest,Kerberos
+
-Path
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Find-SqlInstanceSetup on GitHub. +
+Want to see the Bill Of Health for this command? Check out Find-SqlInstanceSetup.

+ +
+
+
+
+ + + diff --git a/Find-SqlInstanceUpdate.html b/Find-SqlInstanceUpdate.html new file mode 100644 index 00000000..d79c9e2f --- /dev/null +++ b/Find-SqlInstanceUpdate.html @@ -0,0 +1,702 @@ + + + + + + + dbatools docs | Find-SqlInstanceUpdate + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Find-SqlInstanceUpdate

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Returns a SQL Server KB filesystem object based on parameters

+

Description

+

Recursively searches specified folder for a file that matches the following pattern: +"SQLServer$MajorVersion-KB$KB-$Architecture*.exe"

+

Syntax

+
Find-SqlInstanceUpdate
+    [[-ComputerName] <DbaInstanceParameter>]
+    [[-Credential] <PSCredential>]
+    [[-Authentication] <String>]
+    [-MajorVersion] <String>
+    [-KB] <String>
+    [[-Architecture] <String>]
+    [[-Path] <String[]>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS>Find-SqlInstanceUpdate -MajorVersion 2016 -KB 412348 -Path \my\updates
+Looks for SQLServer2016-KB412348-x64*.exe in \my\updates and all the subfolders

+

Required Parameters

+
-MajorVersion
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-KB
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-ComputerName
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Credential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Authentication
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueDefault
Accepted ValuesDefault,Basic,Negotiate,NegotiateWithImplicitCredential,Credssp,Digest,Kerberos
+
-Architecture
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Valuex64
Accepted Valuesx86,x64
+
-Path
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value(Get-DbatoolsConfigValue -Name 'Path.SQLServerUpdates')
+

 

+

Want to see the source code for this command? Check out Find-SqlInstanceUpdate on GitHub. +
+Want to see the Bill Of Health for this command? Check out Find-SqlInstanceUpdate.

+ +
+
+
+
+ + + diff --git a/Format-DbaBackupInformation.html b/Format-DbaBackupInformation.html index c336e004..44c52a57 100644 Binary files a/Format-DbaBackupInformation.html and b/Format-DbaBackupInformation.html differ diff --git a/Get-ADSConnection.html b/Get-ADSConnection.html new file mode 100644 index 00000000..5dfe0113 --- /dev/null +++ b/Get-ADSConnection.html @@ -0,0 +1,485 @@ + + + + + + + dbatools docs | Get-ADSConnection + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-ADSConnection

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Get-ADSConnection

+

Description

+

Syntax

+
Get-ADSConnectionsyntaxItem----------{@{name=
+
+Get-ADSConnection; CommonParameters=False; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

 

+

Want to see the source code for this command? Check out Get-ADSConnection on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-ADSConnection.

+ +
+
+
+
+ + + diff --git a/Get-AdjustedTotalRowsCopied.html b/Get-AdjustedTotalRowsCopied.html new file mode 100644 index 00000000..80a22d44 --- /dev/null +++ b/Get-AdjustedTotalRowsCopied.html @@ -0,0 +1,554 @@ + + + + + + + dbatools docs | Get-AdjustedTotalRowsCopied + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-AdjustedTotalRowsCopied

+ + + + + + + + + + + + + + + + + +
AuthorAdam Lancaster https://github.com/lancasteradam
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

The legacy bulk copy library still uses a 4 byte integer to track the number of rows copied. That 4 byte integer is subject to overflow/wraparound +if the number of rows copied is greater than an integer can support. The SqlRowsCopiedEventArgs.RowsCopied property is defined as an Int64 +but a 4 byte integer is used in the underlying legacy library. See https://github.com/dataplat/dbatools/issues/6927 for more details.

+

Description

+

Determines the accurate total rows copied even if the bulkcopy.RowsCopied has experienced integer wrap. +This internal function is used from:

+

Copy-DbaDbTableData.ps1 +Import-DbaCsv.ps1 +Write-DbaDbTableData.ps1

+

Syntax

+
Get-AdjustedTotalRowsCopied
+    [[-ReportedRowsCopied] <Object>]
+    [[-PreviousRowsCopied] <Object>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-ReportedRowsCopied
+

The number of rows copied as reported by the bulk copy library (i.e. https://docs.microsoft.com/en-us/dotnet/api/system.data.sqlclient.sqlrowscopiedeventargs.rowscopied)

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-PreviousRowsCopied
+

The previous number of rows reported by the bulk copy library.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Get-AdjustedTotalRowsCopied on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-AdjustedTotalRowsCopied.

+ +
+
+
+
+ + + diff --git a/Get-BackupAncientHistory.html b/Get-BackupAncientHistory.html new file mode 100644 index 00000000..69a98723 --- /dev/null +++ b/Get-BackupAncientHistory.html @@ -0,0 +1,636 @@ + + + + + + + dbatools docs | Get-BackupAncientHistory + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-BackupAncientHistory

+ + + + + + + + + + + + + + + + + +
AuthorStuart Moore (@napalmgram), stuart-moore.com
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Returns details of the last full backup of a SQL Server 2000 database

+

Description

+

Backup History command to pull limited history from a SQL 2000 instance. If not using SQL 2000, please use Get-DbaDbBackupHistory which pulls more infomation, and has more options. This is just here to cope with 2k and copy-DbaDatabase issues

+

Syntax

+
Get-BackupAncientHistory
+    [-SqlInstance] <DbaInstanceParameter>
+    [[-SqlCredential] <PSCredential>]
+    [[-Database] <Object[]>]
+    [[-FileNameStub] <String>]
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-SqlInstance
+

SQL Server name or SMO object representing the SQL Server to connect to. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-SqlCredential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Database
+

Specifies one or more database(s) to process. If unspecified, all databases will be processed.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-FileNameStub
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-EnableException
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Get-BackupAncientHistory on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-BackupAncientHistory.

+ +
+
+
+
+ + + diff --git a/Get-BulkRowsCopiedCount.html b/Get-BulkRowsCopiedCount.html new file mode 100644 index 00000000..c1fe9955 --- /dev/null +++ b/Get-BulkRowsCopiedCount.html @@ -0,0 +1,529 @@ + + + + + + + dbatools docs | Get-BulkRowsCopiedCount + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-BulkRowsCopiedCount

+ + + + + + + + + + + + + + + + + +
AuthorJason Chester (@jasonchester)
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Gets the number of rows returned by a sql bulk copy

+

Description

+

Uses reflection to return the _rowsCopied private field value from a SqlBulkCopy object +see http://stackoverflow.com/questions/1188384/sqlbulkcopy-row-count-when-complete

+

Syntax

+
Get-BulkRowsCopiedCount
+    [[-BulkCopy] <SqlBulkCopy>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Get-BulkRowsCopied $bulkObject
+Returns a integer containing the number of rows copied by SqlBulkCopy

+

Optional Parameters

+
-BulkCopy
+

The Bulk copy object to retrieve the rows copied field from +This is internal function is used by

+
    +
  • Copy-DbaDbTableData
    • +
  • Copy-DbaDbViewData
    • +
  • Import-DbaCsv
    • +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Get-BulkRowsCopiedCount on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-BulkRowsCopiedCount.

+ +
+
+
+
+ + + diff --git a/Get-CodePage.html b/Get-CodePage.html new file mode 100644 index 00000000..3693a150 --- /dev/null +++ b/Get-CodePage.html @@ -0,0 +1,518 @@ + + + + + + + dbatools docs | Get-CodePage + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-CodePage

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Converts Microsoft's code page ID to human readable format

+

Description

+

Converts Microsoft's code page ID to human readable format

+

Syntax

+
Get-CodePage
+    [[-id] <Int32>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Get-CodePage 1252
+Returns a pscustomobject with id, alias and name

+

Optional Parameters

+
-id
+

The code page ID

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value0
+

 

+

Want to see the source code for this command? Check out Get-CodePage on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-CodePage.

+ +
+
+
+
+ + + diff --git a/Get-ConnectionParent.html b/Get-ConnectionParent.html new file mode 100644 index 00000000..69cf9f8e --- /dev/null +++ b/Get-ConnectionParent.html @@ -0,0 +1,543 @@ + + + + + + + dbatools docs | Get-ConnectionParent + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-ConnectionParent

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Get-ConnectionParent -InputObject -Database []

+

Description

+

Syntax

+
Get-ConnectionParentsyntaxItem----------{@{name=
+
+Get-ConnectionParent; CommonParameters=True; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-InputObject
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinetrue (ByValue)
Default Value
+

Optional Parameters

+
-Database
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Get-ConnectionParent on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-ConnectionParent.

+ + + + + + + + diff --git a/Get-DbaADObject.html b/Get-DbaADObject.html new file mode 100644 index 00000000..0175c5d4 --- /dev/null +++ b/Get-DbaADObject.html @@ -0,0 +1,704 @@ + + + + + + + dbatools docs | Get-DbaADObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-DbaADObject

+ + + + + + + + + + + + + + + + + +
AuthorNiphlod, https://github.com/niphlod
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Get-DbaADObject tries to facilitate searching AD with dbatools, which ATM can't require AD cmdlets.

+

Description

+

As working with multiple domains, forests, ldap filters, partitions, etc is quite hard to grasp, let's try to do "the right thing" here and +facilitate everybody's work with it. It either returns the exact matched result or None if it isn't found. You can inspect the raw object +calling GetUnderlyingObject() on the returned object.

+

Syntax

+
Get-DbaADObject
+    [[-ADObject] <String[]>]
+    [[-Type] <String>]
+    [[-IdentityType] <String>]
+    [[-Credential] <PSCredential>]
+    [-SearchAllDomains]
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Get-DbaADObject -ADObject "contoso\ctrlb" -Type User
+Searches in the contoso domain for a ctrlb user

+
Example: 2
+

PS > Get-DbaADObject -ADObject "ctrlb@contoso.com" -Type User -IdentityType UserPrincipalName
+Searches in the contoso domain for a ctrlb user using the UserPrincipalName format. Again, beware of the UPN suffixes in elaborate AD structures!

+
Example: 3
+

PS > Get-DbaADObject -ADObject "contoso\ctrlb@super.contoso.com" -Type User -IdentityType UserPrincipalName
+Searches in the contoso domain for a ctrlb@super.contoso.com user using the UserPrincipalName format. This kind of search is better than the previous one
+because it takes into account possible UPN suffixes

+
Example: 4
+

PS > Get-DbaADObject -ADObject "ctrlb@super.contoso.com" -Type User -IdentityType UserPrincipalName -SearchAllDomains
+As a last resort, searches in all the current forest for a ctrlb@super.contoso.com user using the UserPrincipalName format

+
Example: 5
+

PS > Get-DbaADObject -ADObject "contoso\sqlcollaborative" -Type Group
+Searches in the contoso domain for a sqlcollaborative group

+
Example: 6
+

PS > Get-DbaADObject -ADObject "contoso\SqlInstance2014$" -Type Group
+Searches in the contoso domain for a SqlInstance2014 computer (remember the ending $ for computer objects)

+
Example: 7
+

PS > Get-DbaADObject -ADObject "contoso\ctrlb" -Type User -EnableException
+Searches in the contoso domain for a ctrlb user, suppressing all error messages and throw exceptions that can be caught instead

+

Optional Parameters

+
-ADObject
+

Pass in both the domain and the login name in Domain\sAMAccountName format (the one everybody is accustomed to) +You can also pass a UserPrincipalName format (with the correct IdentityType, either with Domain\UserPrincipalName or UserPrincipalName@Domain) +Beware: the "Domain" part of the UPN can be different from the real domain, see "UPN suffixes" (https://msdn.microsoft.com/en-us/library/windows/desktop/aa380525(v=vs.85).aspx) +It's always best to pass the real domain name in (see the examples) +For any other format, please beware that the domain part must always be specified (again, for the best result, before the slash)

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Type
+

You should always know what you are asking for. Please pass in Computer,Group or User to help speeding up the search

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
Accepted ValuesUser,Group,Computer
+
-IdentityType
+

By default objects are searched using sAMAccountName format, here you can pass different representation that need to match the passed in ADObject

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueSamAccountName
Accepted ValuesDistinguishedName,Guid,Name,SamAccountName,Sid,UserPrincipalName
+
-Credential
+

Use this credential to connect to the domain and search for the needed ADObject. If not passed, uses the current process' one.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-SearchAllDomains
+

Search for the object in all domains connected to the current one. If you are unsure what domain the object is coming from, +using this switch will search through all domains in your forest and also in the ones that are trusted. This is HEAVY, but it can save +some headaches.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Get-DbaADObject on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-DbaADObject.

+ +
+
+
+
+ + + diff --git a/Get-DbaAgBackupHistory.html b/Get-DbaAgBackupHistory.html index 8523ec51..dc41218b 100644 Binary files a/Get-DbaAgBackupHistory.html and b/Get-DbaAgBackupHistory.html differ diff --git a/Get-DbaAgDatabase.html b/Get-DbaAgDatabase.html index 8dd4b742..05c665c7 100644 Binary files a/Get-DbaAgDatabase.html and b/Get-DbaAgDatabase.html differ diff --git a/Get-DbaAgHadr.html b/Get-DbaAgHadr.html index 4d4edb97..d109858d 100644 Binary files a/Get-DbaAgHadr.html and b/Get-DbaAgHadr.html differ diff --git a/Get-DbaAgListener.html b/Get-DbaAgListener.html index 7da90c03..ce3132fc 100644 Binary files a/Get-DbaAgListener.html and b/Get-DbaAgListener.html differ diff --git a/Get-DbaAgReplica.html b/Get-DbaAgReplica.html index e551fbbf..b296c4e3 100644 Binary files a/Get-DbaAgReplica.html and b/Get-DbaAgReplica.html differ diff --git a/Get-DbaAgentAlert.html b/Get-DbaAgentAlert.html index 4c4485a9..4e643ad0 100644 Binary files a/Get-DbaAgentAlert.html and b/Get-DbaAgentAlert.html differ diff --git a/Get-DbaAgentAlertCategory.html b/Get-DbaAgentAlertCategory.html index 2d51fdf9..b7b78f4c 100644 Binary files a/Get-DbaAgentAlertCategory.html and b/Get-DbaAgentAlertCategory.html differ diff --git a/Get-DbaAgentJob.html b/Get-DbaAgentJob.html index 919df234..343bc17c 100644 Binary files a/Get-DbaAgentJob.html and b/Get-DbaAgentJob.html differ diff --git a/Get-DbaAgentJobCategory.html b/Get-DbaAgentJobCategory.html index 92a88516..62ea3216 100644 Binary files a/Get-DbaAgentJobCategory.html and b/Get-DbaAgentJobCategory.html differ diff --git a/Get-DbaAgentJobHistory.html b/Get-DbaAgentJobHistory.html index 8588bbe8..f29a9b12 100644 Binary files a/Get-DbaAgentJobHistory.html and b/Get-DbaAgentJobHistory.html differ diff --git a/Get-DbaAgentJobOutputFile.html b/Get-DbaAgentJobOutputFile.html index b746e9ce..5bfa1602 100644 Binary files a/Get-DbaAgentJobOutputFile.html and b/Get-DbaAgentJobOutputFile.html differ diff --git a/Get-DbaAgentJobStep.html b/Get-DbaAgentJobStep.html index 45261359..885df516 100644 Binary files a/Get-DbaAgentJobStep.html and b/Get-DbaAgentJobStep.html differ diff --git a/Get-DbaAgentLog.html b/Get-DbaAgentLog.html index 28d1d648..cf3e2af8 100644 Binary files a/Get-DbaAgentLog.html and b/Get-DbaAgentLog.html differ diff --git a/Get-DbaAgentOperator.html b/Get-DbaAgentOperator.html index cccc32f0..85b27ef6 100644 Binary files a/Get-DbaAgentOperator.html and b/Get-DbaAgentOperator.html differ diff --git a/Get-DbaAgentProxy.html b/Get-DbaAgentProxy.html index b41964d2..094ba887 100644 Binary files a/Get-DbaAgentProxy.html and b/Get-DbaAgentProxy.html differ diff --git a/Get-DbaAgentSchedule.html b/Get-DbaAgentSchedule.html index adcf51c5..ffdef7b0 100644 Binary files a/Get-DbaAgentSchedule.html and b/Get-DbaAgentSchedule.html differ diff --git a/Get-DbaAgentServer.html b/Get-DbaAgentServer.html index 884322ef..485831ab 100644 Binary files a/Get-DbaAgentServer.html and b/Get-DbaAgentServer.html differ diff --git a/Get-DbaAvailabilityGroup.html b/Get-DbaAvailabilityGroup.html index 8b39482a..08433205 100644 Binary files a/Get-DbaAvailabilityGroup.html and b/Get-DbaAvailabilityGroup.html differ diff --git a/Get-DbaAvailableCollation.html b/Get-DbaAvailableCollation.html index 05bee746..d0ed1d94 100644 Binary files a/Get-DbaAvailableCollation.html and b/Get-DbaAvailableCollation.html differ diff --git a/Get-DbaBackupDevice.html b/Get-DbaBackupDevice.html index 401d27f6..03dc8242 100644 Binary files a/Get-DbaBackupDevice.html and b/Get-DbaBackupDevice.html differ diff --git a/Get-DbaBackupInformation.html b/Get-DbaBackupInformation.html index e5c807d3..f41dff9c 100644 Binary files a/Get-DbaBackupInformation.html and b/Get-DbaBackupInformation.html differ diff --git a/Get-DbaBuild.html b/Get-DbaBuild.html index 4f9e3b86..c4577a60 100644 Binary files a/Get-DbaBuild.html and b/Get-DbaBuild.html differ diff --git a/Get-DbaClientAlias.html b/Get-DbaClientAlias.html index 8d7967d7..b5aaca02 100644 Binary files a/Get-DbaClientAlias.html and b/Get-DbaClientAlias.html differ diff --git a/Get-DbaClientProtocol.html b/Get-DbaClientProtocol.html index 41255e92..0b11d647 100644 Binary files a/Get-DbaClientProtocol.html and b/Get-DbaClientProtocol.html differ diff --git a/Get-DbaCmConnection.html b/Get-DbaCmConnection.html index d8a793ac..e06ed76b 100644 Binary files a/Get-DbaCmConnection.html and b/Get-DbaCmConnection.html differ diff --git a/Get-DbaCmObject.html b/Get-DbaCmObject.html index 8be1df55..109e3cc6 100644 Binary files a/Get-DbaCmObject.html and b/Get-DbaCmObject.html differ diff --git a/Get-DbaComputerCertificate.html b/Get-DbaComputerCertificate.html index e8726985..d0fbe83c 100644 Binary files a/Get-DbaComputerCertificate.html and b/Get-DbaComputerCertificate.html differ diff --git a/Get-DbaComputerSystem.html b/Get-DbaComputerSystem.html index 6c240dfc..9777036e 100644 Binary files a/Get-DbaComputerSystem.html and b/Get-DbaComputerSystem.html differ diff --git a/Get-DbaConnectedInstance.html b/Get-DbaConnectedInstance.html index 4d5e522c..0f5a080f 100644 Binary files a/Get-DbaConnectedInstance.html and b/Get-DbaConnectedInstance.html differ diff --git a/Get-DbaConnection.html b/Get-DbaConnection.html index 4c6f9cf4..cf78e581 100644 Binary files a/Get-DbaConnection.html and b/Get-DbaConnection.html differ diff --git a/Get-DbaCpuRingBuffer.html b/Get-DbaCpuRingBuffer.html index d98c3034..e9382b84 100644 Binary files a/Get-DbaCpuRingBuffer.html and b/Get-DbaCpuRingBuffer.html differ diff --git a/Get-DbaCpuUsage.html b/Get-DbaCpuUsage.html index d588e6af..b8f5c156 100644 Binary files a/Get-DbaCpuUsage.html and b/Get-DbaCpuUsage.html differ diff --git a/Get-DbaCredential.html b/Get-DbaCredential.html index f35dcded..1fbdcada 100644 Binary files a/Get-DbaCredential.html and b/Get-DbaCredential.html differ diff --git a/Get-DbaCustomError.html b/Get-DbaCustomError.html index 8eb2ffff..ae2baf3d 100644 Binary files a/Get-DbaCustomError.html and b/Get-DbaCustomError.html differ diff --git a/Get-DbaDatabase.html b/Get-DbaDatabase.html index b89438de..a40d48e4 100644 Binary files a/Get-DbaDatabase.html and b/Get-DbaDatabase.html differ diff --git a/Get-DbaDbAssembly.html b/Get-DbaDbAssembly.html index c310343f..4e094ef0 100644 Binary files a/Get-DbaDbAssembly.html and b/Get-DbaDbAssembly.html differ diff --git a/Get-DbaDbAsymmetricKey.html b/Get-DbaDbAsymmetricKey.html index 261dbfb9..d6c184ea 100644 Binary files a/Get-DbaDbAsymmetricKey.html and b/Get-DbaDbAsymmetricKey.html differ diff --git a/Get-DbaDbBackupHistory.html b/Get-DbaDbBackupHistory.html index 97ea33a2..ebf38fd0 100644 Binary files a/Get-DbaDbBackupHistory.html and b/Get-DbaDbBackupHistory.html differ diff --git a/Get-DbaDbCertificate.html b/Get-DbaDbCertificate.html index 21b04a94..718b8e56 100644 Binary files a/Get-DbaDbCertificate.html and b/Get-DbaDbCertificate.html differ diff --git a/Get-DbaDbCheckConstraint.html b/Get-DbaDbCheckConstraint.html index c225940f..0f095923 100644 Binary files a/Get-DbaDbCheckConstraint.html and b/Get-DbaDbCheckConstraint.html differ diff --git a/Get-DbaDbCompatibility.html b/Get-DbaDbCompatibility.html index 3f8a3e56..bb0feeef 100644 Binary files a/Get-DbaDbCompatibility.html and b/Get-DbaDbCompatibility.html differ diff --git a/Get-DbaDbCompression.html b/Get-DbaDbCompression.html index e4472ee0..49c4a3ac 100644 Binary files a/Get-DbaDbCompression.html and b/Get-DbaDbCompression.html differ diff --git a/Get-DbaDbDbccOpenTran.html b/Get-DbaDbDbccOpenTran.html index 7c7816ef..882d0944 100644 Binary files a/Get-DbaDbDbccOpenTran.html and b/Get-DbaDbDbccOpenTran.html differ diff --git a/Get-DbaDbDetachedFileInfo.html b/Get-DbaDbDetachedFileInfo.html index d3952ca0..4272a7c6 100644 Binary files a/Get-DbaDbDetachedFileInfo.html and b/Get-DbaDbDetachedFileInfo.html differ diff --git a/Get-DbaDbEncryption.html b/Get-DbaDbEncryption.html index bc0cc1bb..fb58d818 100644 Binary files a/Get-DbaDbEncryption.html and b/Get-DbaDbEncryption.html differ diff --git a/Get-DbaDbEncryptionKey.html b/Get-DbaDbEncryptionKey.html index 8af5c213..c631be86 100644 Binary files a/Get-DbaDbEncryptionKey.html and b/Get-DbaDbEncryptionKey.html differ diff --git a/Get-DbaDbExtentDiff.html b/Get-DbaDbExtentDiff.html index f252982b..b1f1d20a 100644 Binary files a/Get-DbaDbExtentDiff.html and b/Get-DbaDbExtentDiff.html differ diff --git a/Get-DbaDbFeatureUsage.html b/Get-DbaDbFeatureUsage.html index d96dad59..6eafcaf8 100644 Binary files a/Get-DbaDbFeatureUsage.html and b/Get-DbaDbFeatureUsage.html differ diff --git a/Get-DbaDbFile.html b/Get-DbaDbFile.html index f24eb8c1..0f89561a 100644 Binary files a/Get-DbaDbFile.html and b/Get-DbaDbFile.html differ diff --git a/Get-DbaDbFileGroup.html b/Get-DbaDbFileGroup.html index 34619b99..6fef405c 100644 Binary files a/Get-DbaDbFileGroup.html and b/Get-DbaDbFileGroup.html differ diff --git a/Get-DbaDbFileGrowth.html b/Get-DbaDbFileGrowth.html index ee44616b..477fda28 100644 Binary files a/Get-DbaDbFileGrowth.html and b/Get-DbaDbFileGrowth.html differ diff --git a/Get-DbaDbFileMapping.html b/Get-DbaDbFileMapping.html index 6158699f..4c82725d 100644 Binary files a/Get-DbaDbFileMapping.html and b/Get-DbaDbFileMapping.html differ diff --git a/Get-DbaDbForeignKey.html b/Get-DbaDbForeignKey.html index 7d6a46f8..05cb07a6 100644 Binary files a/Get-DbaDbForeignKey.html and b/Get-DbaDbForeignKey.html differ diff --git a/Get-DbaDbIdentity.html b/Get-DbaDbIdentity.html index 84ebe681..04c4ce2b 100644 Binary files a/Get-DbaDbIdentity.html and b/Get-DbaDbIdentity.html differ diff --git a/Get-DbaDbLogShipError.html b/Get-DbaDbLogShipError.html index fa0325df..0a24bcfd 100644 Binary files a/Get-DbaDbLogShipError.html and b/Get-DbaDbLogShipError.html differ diff --git a/Get-DbaDbLogSpace.html b/Get-DbaDbLogSpace.html index ee1abd8e..bcdd7cf3 100644 Binary files a/Get-DbaDbLogSpace.html and b/Get-DbaDbLogSpace.html differ diff --git a/Get-DbaDbMail.html b/Get-DbaDbMail.html index 704de1fa..2c97707b 100644 Binary files a/Get-DbaDbMail.html and b/Get-DbaDbMail.html differ diff --git a/Get-DbaDbMailAccount.html b/Get-DbaDbMailAccount.html index 757f03bb..3ab5e9d8 100644 Binary files a/Get-DbaDbMailAccount.html and b/Get-DbaDbMailAccount.html differ diff --git a/Get-DbaDbMailConfig.html b/Get-DbaDbMailConfig.html index d14a0d3d..c92e767a 100644 Binary files a/Get-DbaDbMailConfig.html and b/Get-DbaDbMailConfig.html differ diff --git a/Get-DbaDbMailHistory.html b/Get-DbaDbMailHistory.html index 1ed77ec9..19b73e3f 100644 Binary files a/Get-DbaDbMailHistory.html and b/Get-DbaDbMailHistory.html differ diff --git a/Get-DbaDbMailLog.html b/Get-DbaDbMailLog.html index 6c0f079c..5cbcfa33 100644 Binary files a/Get-DbaDbMailLog.html and b/Get-DbaDbMailLog.html differ diff --git a/Get-DbaDbMailProfile.html b/Get-DbaDbMailProfile.html index 6a828338..5dc7cca2 100644 Binary files a/Get-DbaDbMailProfile.html and b/Get-DbaDbMailProfile.html differ diff --git a/Get-DbaDbMailServer.html b/Get-DbaDbMailServer.html index 820aef1c..00ce3b7a 100644 Binary files a/Get-DbaDbMailServer.html and b/Get-DbaDbMailServer.html differ diff --git a/Get-DbaDbMasterKey.html b/Get-DbaDbMasterKey.html index eb37a367..267348a6 100644 Binary files a/Get-DbaDbMasterKey.html and b/Get-DbaDbMasterKey.html differ diff --git a/Get-DbaDbMemoryUsage.html b/Get-DbaDbMemoryUsage.html index 1d789261..396f4348 100644 Binary files a/Get-DbaDbMemoryUsage.html and b/Get-DbaDbMemoryUsage.html differ diff --git a/Get-DbaDbMirror.html b/Get-DbaDbMirror.html index 48c7e584..efbb1234 100644 Binary files a/Get-DbaDbMirror.html and b/Get-DbaDbMirror.html differ diff --git a/Get-DbaDbMirrorMonitor.html b/Get-DbaDbMirrorMonitor.html index 0b8cf9f0..0be323a5 100644 Binary files a/Get-DbaDbMirrorMonitor.html and b/Get-DbaDbMirrorMonitor.html differ diff --git a/Get-DbaDbObjectTrigger.html b/Get-DbaDbObjectTrigger.html index 03588bbb..0f566598 100644 Binary files a/Get-DbaDbObjectTrigger.html and b/Get-DbaDbObjectTrigger.html differ diff --git a/Get-DbaDbOrphanUser.html b/Get-DbaDbOrphanUser.html index 14cb19e9..8410b680 100644 Binary files a/Get-DbaDbOrphanUser.html and b/Get-DbaDbOrphanUser.html differ diff --git a/Get-DbaDbPageInfo.html b/Get-DbaDbPageInfo.html index bb3cf6d0..f2fd1ac4 100644 Binary files a/Get-DbaDbPageInfo.html and b/Get-DbaDbPageInfo.html differ diff --git a/Get-DbaDbPartitionFunction.html b/Get-DbaDbPartitionFunction.html index 75006420..4cb52593 100644 Binary files a/Get-DbaDbPartitionFunction.html and b/Get-DbaDbPartitionFunction.html differ diff --git a/Get-DbaDbPartitionScheme.html b/Get-DbaDbPartitionScheme.html index c9647c18..5cfdf5b3 100644 Binary files a/Get-DbaDbPartitionScheme.html and b/Get-DbaDbPartitionScheme.html differ diff --git a/Get-DbaDbPhysicalFile.html b/Get-DbaDbPhysicalFile.html new file mode 100644 index 00000000..ca895bb9 --- /dev/null +++ b/Get-DbaDbPhysicalFile.html @@ -0,0 +1,553 @@ + + + + + + + dbatools docs | Get-DbaDbPhysicalFile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-DbaDbPhysicalFile

+ + + + + + + + + + + + + + + + + +
AuthorSimone Bizzotto
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Gets raw information about physical files linked to databases

+

Description

+

Fastest way to fetch just the paths of the physical files for every database on the instance, also for offline databases. +Incidentally, it also fetches the paths for MMO and FS filegroups. +This is partly already in Get-DbaDbFile, but this internal needs to stay lean and fast, as it's heavily used in top-level functions

+

Syntax

+
Get-DbaDbPhysicalFile
+    [-SqlInstance] <DbaInstanceParameter>
+    [[-SqlCredential] <PSCredential>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Get-DbaDbPhysicalFile -SqlInstance server1\instance2

+

Required Parameters

+
-SqlInstance
+

SMO object representing the SQL Server to connect to.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-SqlCredential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Get-DbaDbPhysicalFile on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-DbaDbPhysicalFile.

+ +
+
+
+
+ + + diff --git a/Get-DbaDbQueryStoreOption.html b/Get-DbaDbQueryStoreOption.html index 1f380ebb..bab59af3 100644 Binary files a/Get-DbaDbQueryStoreOption.html and b/Get-DbaDbQueryStoreOption.html differ diff --git a/Get-DbaDbRecoveryModel.html b/Get-DbaDbRecoveryModel.html index 0b29ac56..9d1570bb 100644 Binary files a/Get-DbaDbRecoveryModel.html and b/Get-DbaDbRecoveryModel.html differ diff --git a/Get-DbaDbRestoreHistory.html b/Get-DbaDbRestoreHistory.html index 09e8146a..e334e459 100644 Binary files a/Get-DbaDbRestoreHistory.html and b/Get-DbaDbRestoreHistory.html differ diff --git a/Get-DbaDbRole.html b/Get-DbaDbRole.html index 8fa61365..7751dc9c 100644 Binary files a/Get-DbaDbRole.html and b/Get-DbaDbRole.html differ diff --git a/Get-DbaDbRoleMember.html b/Get-DbaDbRoleMember.html index e7f7f13b..13c7dd18 100644 Binary files a/Get-DbaDbRoleMember.html and b/Get-DbaDbRoleMember.html differ diff --git a/Get-DbaDbSchema.html b/Get-DbaDbSchema.html index 707fe4ff..e1df07cd 100644 Binary files a/Get-DbaDbSchema.html and b/Get-DbaDbSchema.html differ diff --git a/Get-DbaDbSequence.html b/Get-DbaDbSequence.html index efa189e7..c64ce245 100644 Binary files a/Get-DbaDbSequence.html and b/Get-DbaDbSequence.html differ diff --git a/Get-DbaDbServiceBrokerQueue.html b/Get-DbaDbServiceBrokerQueue.html new file mode 100644 index 00000000..06845026 --- /dev/null +++ b/Get-DbaDbServiceBrokerQueue.html @@ -0,0 +1,684 @@ + + + + + + + dbatools docs | Get-DbaDbServiceBrokerQueue + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-DbaDbServiceBrokerQueue

+ + + + + + + + + + + + + + + + + +
AuthorAnt Green (@ant_green)
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Gets database service broker queues

+

Description

+

Gets database Sservice broker queue

+

Syntax

+
Get-DbaDbServiceBrokerQueue
+    [[-SqlInstance] <DbaInstanceParameter[]>]
+    [[-SqlCredential] <PSCredential>]
+    [[-Database] <Object[]>]
+    [[-ExcludeDatabase] <Object[]>]
+    [-ExcludeSystemQueue]
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Get-DbaDbServiceBrokerQueue -SqlInstance sql2016
+
+

Gets all database service broker queues

+
Example: 2
+
PS C:\> Get-DbaDbServiceBrokerQueue -SqlInstance Server1 -Database db1
+
+

Gets the service broker queues for the db1 database

+
Example: 3
+
PS C:\> Get-DbaDbServiceBrokerQueue -SqlInstance Server1 -ExcludeDatabase db1
+
+

Gets the service broker queues for all databases except db1

+
Example: 4
+
PS C:\> Get-DbaDbServiceBrokerQueue -SqlInstance Server1 -ExcludeSystemQueue
+
+

Gets the service broker queues for all databases that are not system objects

+

Optional Parameters

+
-SqlInstance
+

The target SQL Server instance or instances

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinetrue (ByValue)
Default Value
+
-SqlCredential
+

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential). +Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported. +For MFA support, please use Connect-DbaInstance.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Database
+

To get service broker queues from specific database(s)

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ExcludeDatabase
+

The database(s) to exclude - this list is auto populated from the server

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ExcludeSystemQueue
+

This switch removes all system objects from the queue collection

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Get-DbaDbServiceBrokerQueue on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-DbaDbServiceBrokerQueue.

+ +
+
+
+
+ + + diff --git a/Get-DbaDbServiceBrokerService.html b/Get-DbaDbServiceBrokerService.html index 9ae19f7a..9f93fd2e 100644 Binary files a/Get-DbaDbServiceBrokerService.html and b/Get-DbaDbServiceBrokerService.html differ diff --git a/Get-DbaDbSharePoint.html b/Get-DbaDbSharePoint.html index d63d3185..b7b1165e 100644 Binary files a/Get-DbaDbSharePoint.html and b/Get-DbaDbSharePoint.html differ diff --git a/Get-DbaDbSnapshot.html b/Get-DbaDbSnapshot.html index 37b19542..9384d94f 100644 Binary files a/Get-DbaDbSnapshot.html and b/Get-DbaDbSnapshot.html differ diff --git a/Get-DbaDbSpace.html b/Get-DbaDbSpace.html index 0c516901..39b48bce 100644 Binary files a/Get-DbaDbSpace.html and b/Get-DbaDbSpace.html differ diff --git a/Get-DbaDbState.html b/Get-DbaDbState.html index b4372d85..05e8ea28 100644 Binary files a/Get-DbaDbState.html and b/Get-DbaDbState.html differ diff --git a/Get-DbaDbStoredProcedure.html b/Get-DbaDbStoredProcedure.html index 656727de..052863f1 100644 Binary files a/Get-DbaDbStoredProcedure.html and b/Get-DbaDbStoredProcedure.html differ diff --git a/Get-DbaDbSynonym.html b/Get-DbaDbSynonym.html index 7b0322ed..a4984a61 100644 Binary files a/Get-DbaDbSynonym.html and b/Get-DbaDbSynonym.html differ diff --git a/Get-DbaDbTable.html b/Get-DbaDbTable.html index 7e7fe21f..b65d27c2 100644 Binary files a/Get-DbaDbTable.html and b/Get-DbaDbTable.html differ diff --git a/Get-DbaDbTrigger.html b/Get-DbaDbTrigger.html index b0ac4575..cccdd71e 100644 Binary files a/Get-DbaDbTrigger.html and b/Get-DbaDbTrigger.html differ diff --git a/Get-DbaDbUdf.html b/Get-DbaDbUdf.html index fa14789c..eaf75581 100644 Binary files a/Get-DbaDbUdf.html and b/Get-DbaDbUdf.html differ diff --git a/Get-DbaDbUser.html b/Get-DbaDbUser.html index 5807dac9..ae4092c3 100644 Binary files a/Get-DbaDbUser.html and b/Get-DbaDbUser.html differ diff --git a/Get-DbaDbUserDefinedTableType.html b/Get-DbaDbUserDefinedTableType.html index 4ff5bf50..a5f75962 100644 Binary files a/Get-DbaDbUserDefinedTableType.html and b/Get-DbaDbUserDefinedTableType.html differ diff --git a/Get-DbaDbView.html b/Get-DbaDbView.html index 051dda60..cfd7dc2e 100644 Binary files a/Get-DbaDbView.html and b/Get-DbaDbView.html differ diff --git a/Get-DbaDbVirtualLogFile.html b/Get-DbaDbVirtualLogFile.html index 90e67c23..630fdb76 100644 Binary files a/Get-DbaDbVirtualLogFile.html and b/Get-DbaDbVirtualLogFile.html differ diff --git a/Get-DbaDbccHelp.html b/Get-DbaDbccHelp.html index 76f652f7..791039ec 100644 Binary files a/Get-DbaDbccHelp.html and b/Get-DbaDbccHelp.html differ diff --git a/Get-DbaDbccMemoryStatus.html b/Get-DbaDbccMemoryStatus.html index b71c498d..f5143de4 100644 Binary files a/Get-DbaDbccMemoryStatus.html and b/Get-DbaDbccMemoryStatus.html differ diff --git a/Get-DbaDbccProcCache.html b/Get-DbaDbccProcCache.html index 986d9800..0861d47b 100644 Binary files a/Get-DbaDbccProcCache.html and b/Get-DbaDbccProcCache.html differ diff --git a/Get-DbaDbccSessionBuffer.html b/Get-DbaDbccSessionBuffer.html index e0afe24c..6a56103e 100644 Binary files a/Get-DbaDbccSessionBuffer.html and b/Get-DbaDbccSessionBuffer.html differ diff --git a/Get-DbaDbccStatistic.html b/Get-DbaDbccStatistic.html index f6d83a5e..a9bcc5ed 100644 Binary files a/Get-DbaDbccStatistic.html and b/Get-DbaDbccStatistic.html differ diff --git a/Get-DbaDbccUserOption.html b/Get-DbaDbccUserOption.html index 4011f7d6..a84d3c6d 100644 Binary files a/Get-DbaDbccUserOption.html and b/Get-DbaDbccUserOption.html differ diff --git a/Get-DbaDefaultPath.html b/Get-DbaDefaultPath.html index c3c21c7f..a907c529 100644 Binary files a/Get-DbaDefaultPath.html and b/Get-DbaDefaultPath.html differ diff --git a/Get-DbaDependency.html b/Get-DbaDependency.html index 30909643..d0268522 100644 Binary files a/Get-DbaDependency.html and b/Get-DbaDependency.html differ diff --git a/Get-DbaDeprecatedFeature.html b/Get-DbaDeprecatedFeature.html index bc47a7dc..fb46564f 100644 Binary files a/Get-DbaDeprecatedFeature.html and b/Get-DbaDeprecatedFeature.html differ diff --git a/Get-DbaDiskSpace.html b/Get-DbaDiskSpace.html index 350ccbb6..4f5ff0ca 100644 Binary files a/Get-DbaDiskSpace.html and b/Get-DbaDiskSpace.html differ diff --git a/Get-DbaDump.html b/Get-DbaDump.html index 8256a6b3..5c2006a1 100644 Binary files a/Get-DbaDump.html and b/Get-DbaDump.html differ diff --git a/Get-DbaEndpoint.html b/Get-DbaEndpoint.html index e1cf3d78..a44ef1ed 100644 Binary files a/Get-DbaEndpoint.html and b/Get-DbaEndpoint.html differ diff --git a/Get-DbaErrorLog.html b/Get-DbaErrorLog.html index cdbc4f66..8bdf8d0c 100644 Binary files a/Get-DbaErrorLog.html and b/Get-DbaErrorLog.html differ diff --git a/Get-DbaErrorLogConfig.html b/Get-DbaErrorLogConfig.html index 798458c1..e33540f7 100644 Binary files a/Get-DbaErrorLogConfig.html and b/Get-DbaErrorLogConfig.html differ diff --git a/Get-DbaEstimatedCompletionTime.html b/Get-DbaEstimatedCompletionTime.html index f9a0f7cb..bc37077c 100644 Binary files a/Get-DbaEstimatedCompletionTime.html and b/Get-DbaEstimatedCompletionTime.html differ diff --git a/Get-DbaExecutionPlan.html b/Get-DbaExecutionPlan.html index 109396a3..eccd7c83 100644 Binary files a/Get-DbaExecutionPlan.html and b/Get-DbaExecutionPlan.html differ diff --git a/Get-DbaExtendedProperty.html b/Get-DbaExtendedProperty.html index 4ab8869e..c51fd3a9 100644 Binary files a/Get-DbaExtendedProperty.html and b/Get-DbaExtendedProperty.html differ diff --git a/Get-DbaExtendedProtection.html b/Get-DbaExtendedProtection.html index 64d28809..8cc7d752 100644 Binary files a/Get-DbaExtendedProtection.html and b/Get-DbaExtendedProtection.html differ diff --git a/Get-DbaExternalProcess.html b/Get-DbaExternalProcess.html index e042ba34..19a4749f 100644 Binary files a/Get-DbaExternalProcess.html and b/Get-DbaExternalProcess.html differ diff --git a/Get-DbaFeature.html b/Get-DbaFeature.html index 531e35b6..28d338af 100644 Binary files a/Get-DbaFeature.html and b/Get-DbaFeature.html differ diff --git a/Get-DbaFile.html b/Get-DbaFile.html index 662f4166..4c7ef8a6 100644 Binary files a/Get-DbaFile.html and b/Get-DbaFile.html differ diff --git a/Get-DbaFileStreamFolder.html b/Get-DbaFileStreamFolder.html new file mode 100644 index 00000000..1b5eb5f1 --- /dev/null +++ b/Get-DbaFileStreamFolder.html @@ -0,0 +1,614 @@ + + + + + + + dbatools docs | Get-DbaFileStreamFolder + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-DbaFileStreamFolder

+ + + + + + + + + + + + + + + + + +
AuthorStuart Moore (@napalmgram stuart-moore.com )
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Returns basic information about Filestream folders from a Sql Instance

+

Description

+

Given a SQL Instance, and an optional list of databases returns the FileStream containing folders on that Instance. Without the Database parameter, all dbs with FileStream are returned

+

Syntax

+
Get-DbaFileStreamFolder
+    [[-SqlInstance] <DbaInstanceParameter>]
+    [[-SqlCredential] <PSCredential>]
+    [[-Database] <String[]>]
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Get-DbaFileStreamFolder -SqlInstance server1\instance2
+Returns all FileStream folders from server1\instance2

+
Example: 2
+

PS > Get-DbaFileStreamFolder -SqlInstance server1\instance2 -Database Archive
+Returns any FileStream folders from the Archive database on server1\instance2

+

Optional Parameters

+
-SqlInstance
+

The Sql Server instance to be queries

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-SqlCredential
+

A Sql Credential to connect to $SqlInstance

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Database
+

Database to be tested, multiple databases may be specified as a comma seperated list.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Get-DbaFileStreamFolder on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-DbaFileStreamFolder.

+ +
+
+
+
+ + + diff --git a/Get-DbaFilestream.html b/Get-DbaFilestream.html index c5083dc8..3e023bae 100644 Binary files a/Get-DbaFilestream.html and b/Get-DbaFilestream.html differ diff --git a/Get-DbaFirewallRule.html b/Get-DbaFirewallRule.html index 0806cc00..1fd0045d 100644 Binary files a/Get-DbaFirewallRule.html and b/Get-DbaFirewallRule.html differ diff --git a/Get-DbaForceNetworkEncryption.html b/Get-DbaForceNetworkEncryption.html index d51ecafe..57137476 100644 Binary files a/Get-DbaForceNetworkEncryption.html and b/Get-DbaForceNetworkEncryption.html differ diff --git a/Get-DbaHelp.html b/Get-DbaHelp.html new file mode 100644 index 00000000..4ecc2bfe --- /dev/null +++ b/Get-DbaHelp.html @@ -0,0 +1,565 @@ + + + + + + + dbatools docs | Get-DbaHelp + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-DbaHelp

+ + + + + + + + + + + + + + + + + +
AuthorSimone Bizzotto (@niphlod)
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Massages inline help data to a more useful format

+

Description

+

Takes the inline help and outputs a more usable object

+

Syntax

+
Get-DbaHelp
+    [-Name] <String>
+    [[-OutputAs] <String>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Get-DbaHelp Get-DbaDatabase
+Parses the inline help from Get-DbaDatabase and outputs the massaged object

+
Example: 2
+

PS > Get-DbaHelp Get-DbaDatabase -OutputAs "PSObject"
+Parses the inline help from Get-DbaDatabase and outputs the massaged object

+
Example: 3
+
PS C:\> Get-DbaHelp Get-DbaDatabase -OutputAs "MDString" | Out-File Get-DbaDatabase.md
+PS C:\> & code Get-DbaDatabase.md
+
+

Parses the inline help from Get-DbaDatabase as MarkDown, saves the file and opens it
+via VSCode

+

Required Parameters

+
-Name
+

The function/command to extract help from

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-OutputAs
+

Output format (raw PSObject or MDString)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValuePSObject
Accepted ValuesPSObject,MDString
+

 

+

Want to see the source code for this command? Check out Get-DbaHelp on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-DbaHelp.

+ +
+
+
+
+ + + diff --git a/Get-DbaHelpIndex.html b/Get-DbaHelpIndex.html index f8ee572e..7e72ceba 100644 Binary files a/Get-DbaHelpIndex.html and b/Get-DbaHelpIndex.html differ diff --git a/Get-DbaHideInstance.html b/Get-DbaHideInstance.html index 10235eb6..ff482552 100644 Binary files a/Get-DbaHideInstance.html and b/Get-DbaHideInstance.html differ diff --git a/Get-DbaInstalledPatch.html b/Get-DbaInstalledPatch.html index 5a477ae4..07d7cdb3 100644 Binary files a/Get-DbaInstalledPatch.html and b/Get-DbaInstalledPatch.html differ diff --git a/Get-DbaInstanceAudit.html b/Get-DbaInstanceAudit.html index df84c007..df874ed0 100644 Binary files a/Get-DbaInstanceAudit.html and b/Get-DbaInstanceAudit.html differ diff --git a/Get-DbaInstanceAuditSpecification.html b/Get-DbaInstanceAuditSpecification.html index 6802afe5..c2da8e99 100644 Binary files a/Get-DbaInstanceAuditSpecification.html and b/Get-DbaInstanceAuditSpecification.html differ diff --git a/Get-DbaInstanceInstallDate.html b/Get-DbaInstanceInstallDate.html index b51a7114..a7d5d0f6 100644 Binary files a/Get-DbaInstanceInstallDate.html and b/Get-DbaInstanceInstallDate.html differ diff --git a/Get-DbaInstanceProperty.html b/Get-DbaInstanceProperty.html index 2b58e097..e90adbb6 100644 Binary files a/Get-DbaInstanceProperty.html and b/Get-DbaInstanceProperty.html differ diff --git a/Get-DbaInstanceProtocol.html b/Get-DbaInstanceProtocol.html index 5151fb9c..39f5f2cd 100644 Binary files a/Get-DbaInstanceProtocol.html and b/Get-DbaInstanceProtocol.html differ diff --git a/Get-DbaInstanceTrigger.html b/Get-DbaInstanceTrigger.html index 12813523..4c3222be 100644 Binary files a/Get-DbaInstanceTrigger.html and b/Get-DbaInstanceTrigger.html differ diff --git a/Get-DbaInstanceUserOption.html b/Get-DbaInstanceUserOption.html index 9042a0b1..32f7275b 100644 Binary files a/Get-DbaInstanceUserOption.html and b/Get-DbaInstanceUserOption.html differ diff --git a/Get-DbaIoLatency.html b/Get-DbaIoLatency.html index 439ee470..73608dd5 100644 Binary files a/Get-DbaIoLatency.html and b/Get-DbaIoLatency.html differ diff --git a/Get-DbaKbUpdate.html b/Get-DbaKbUpdate.html index 2a036e56..c16c09ea 100644 Binary files a/Get-DbaKbUpdate.html and b/Get-DbaKbUpdate.html differ diff --git a/Get-DbaLastBackup.html b/Get-DbaLastBackup.html index cabb4ab6..e2d88971 100644 Binary files a/Get-DbaLastBackup.html and b/Get-DbaLastBackup.html differ diff --git a/Get-DbaLastGoodCheckDb.html b/Get-DbaLastGoodCheckDb.html index 1d5ec047..8c88f9b1 100644 Binary files a/Get-DbaLastGoodCheckDb.html and b/Get-DbaLastGoodCheckDb.html differ diff --git a/Get-DbaLatchStatistic.html b/Get-DbaLatchStatistic.html index 767ba8cc..663a054e 100644 Binary files a/Get-DbaLatchStatistic.html and b/Get-DbaLatchStatistic.html differ diff --git a/Get-DbaLinkedServer.html b/Get-DbaLinkedServer.html index 8b2cf32f..f5c1a95e 100644 Binary files a/Get-DbaLinkedServer.html and b/Get-DbaLinkedServer.html differ diff --git a/Get-DbaLinkedServerLogin.html b/Get-DbaLinkedServerLogin.html index 5137706d..f58827df 100644 Binary files a/Get-DbaLinkedServerLogin.html and b/Get-DbaLinkedServerLogin.html differ diff --git a/Get-DbaLocaleSetting.html b/Get-DbaLocaleSetting.html index e870c685..499fad64 100644 Binary files a/Get-DbaLocaleSetting.html and b/Get-DbaLocaleSetting.html differ diff --git a/Get-DbaLogin.html b/Get-DbaLogin.html index 4d2b542c..0bb31f6e 100644 Binary files a/Get-DbaLogin.html and b/Get-DbaLogin.html differ diff --git a/Get-DbaMaintenanceSolutionLog.html b/Get-DbaMaintenanceSolutionLog.html index 1468ffa0..481cc1e3 100644 Binary files a/Get-DbaMaintenanceSolutionLog.html and b/Get-DbaMaintenanceSolutionLog.html differ diff --git a/Get-DbaManagementObject.html b/Get-DbaManagementObject.html index c215a479..27625fd7 100644 Binary files a/Get-DbaManagementObject.html and b/Get-DbaManagementObject.html differ diff --git a/Get-DbaMaxMemory.html b/Get-DbaMaxMemory.html index 0487f0f4..dc0ef595 100644 Binary files a/Get-DbaMaxMemory.html and b/Get-DbaMaxMemory.html differ diff --git a/Get-DbaMemoryCondition.html b/Get-DbaMemoryCondition.html index 51931eb8..65ef7981 100644 Binary files a/Get-DbaMemoryCondition.html and b/Get-DbaMemoryCondition.html differ diff --git a/Get-DbaMemoryUsage.html b/Get-DbaMemoryUsage.html index f7c8c579..25a109bc 100644 Binary files a/Get-DbaMemoryUsage.html and b/Get-DbaMemoryUsage.html differ diff --git a/Get-DbaMessageLevelModifier.html b/Get-DbaMessageLevelModifier.html new file mode 100644 index 00000000..34c9ba4a --- /dev/null +++ b/Get-DbaMessageLevelModifier.html @@ -0,0 +1,525 @@ + + + + + + + dbatools docs | Get-DbaMessageLevelModifier + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-DbaMessageLevelModifier

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Returns all registered message level modifiers with similar name.

+

Description

+

Returns all registered message level modifiers with similar name.

+

Message level modifiers are created using New-DbaMessageLevelModifier and allow dynamically modifying the actual message level written by commands.

+

Syntax

+
Get-DbaMessageLevelModifier
+    [[-Name] <String>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Get-DbaMessageLevelModifier
+
+

Returns all message level filters

+
Example: 2
+
PS C:\> Get-DbaMessageLevelModifier -Name "mymodule.*"
+
+

Returns all message level filters that start with "mymodule."

+

Optional Parameters

+
-Name
+

Default: "*" +A name filter - only commands that are similar to the filter will be returned.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value*
+

 

+

Want to see the source code for this command? Check out Get-DbaMessageLevelModifier on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-DbaMessageLevelModifier.

+ +
+
+
+
+ + + diff --git a/Get-DbaModule.html b/Get-DbaModule.html index 144bff76..ab780ec0 100644 Binary files a/Get-DbaModule.html and b/Get-DbaModule.html differ diff --git a/Get-DbaMsdtc.html b/Get-DbaMsdtc.html index 41a27b10..c1311cee 100644 Binary files a/Get-DbaMsdtc.html and b/Get-DbaMsdtc.html differ diff --git a/Get-DbaNetworkActivity.html b/Get-DbaNetworkActivity.html index f988d4b7..d009f189 100644 Binary files a/Get-DbaNetworkActivity.html and b/Get-DbaNetworkActivity.html differ diff --git a/Get-DbaNetworkCertificate.html b/Get-DbaNetworkCertificate.html index 905d9e7b..02d41aff 100644 Binary files a/Get-DbaNetworkCertificate.html and b/Get-DbaNetworkCertificate.html differ diff --git a/Get-DbaNetworkConfiguration.html b/Get-DbaNetworkConfiguration.html index 25137cef..63cde380 100644 Binary files a/Get-DbaNetworkConfiguration.html and b/Get-DbaNetworkConfiguration.html differ diff --git a/Get-DbaOleDbProvider.html b/Get-DbaOleDbProvider.html index 10e29071..6c03ef19 100644 Binary files a/Get-DbaOleDbProvider.html and b/Get-DbaOleDbProvider.html differ diff --git a/Get-DbaOpenTransaction.html b/Get-DbaOpenTransaction.html index 77619e15..34983bdf 100644 Binary files a/Get-DbaOpenTransaction.html and b/Get-DbaOpenTransaction.html differ diff --git a/Get-DbaOperatingSystem.html b/Get-DbaOperatingSystem.html index 595b681d..b2236698 100644 Binary files a/Get-DbaOperatingSystem.html and b/Get-DbaOperatingSystem.html differ diff --git a/Get-DbaPageFileSetting.html b/Get-DbaPageFileSetting.html index 2bc0eec5..78522b1f 100644 Binary files a/Get-DbaPageFileSetting.html and b/Get-DbaPageFileSetting.html differ diff --git a/Get-DbaPathSep.html b/Get-DbaPathSep.html new file mode 100644 index 00000000..d3cbded6 --- /dev/null +++ b/Get-DbaPathSep.html @@ -0,0 +1,514 @@ + + + + + + + dbatools docs | Get-DbaPathSep + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-DbaPathSep

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Get-DbaPathSep [-Server ] []

+

Description

+

Syntax

+
Get-DbaPathSepsyntaxItem----------{@{name=
+
+Get-DbaPathSep; CommonParameters=True; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-Server
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Get-DbaPathSep on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-DbaPathSep.

+ + + + + + + + diff --git a/Get-DbaPbmStore.html b/Get-DbaPbmStore.html index f86aa878..d298bcb3 100644 Binary files a/Get-DbaPbmStore.html and b/Get-DbaPbmStore.html differ diff --git a/Get-DbaPermission.html b/Get-DbaPermission.html index 20e18ead..cd2e95eb 100644 Binary files a/Get-DbaPermission.html and b/Get-DbaPermission.html differ diff --git a/Get-DbaPfAvailableCounter.html b/Get-DbaPfAvailableCounter.html index 7d3d7baa..57c8cd40 100644 Binary files a/Get-DbaPfAvailableCounter.html and b/Get-DbaPfAvailableCounter.html differ diff --git a/Get-DbaPfDataCollector.html b/Get-DbaPfDataCollector.html index 55157f3c..7e8105ac 100644 Binary files a/Get-DbaPfDataCollector.html and b/Get-DbaPfDataCollector.html differ diff --git a/Get-DbaPfDataCollectorCounter.html b/Get-DbaPfDataCollectorCounter.html index 68c52f8d..349a1fde 100644 Binary files a/Get-DbaPfDataCollectorCounter.html and b/Get-DbaPfDataCollectorCounter.html differ diff --git a/Get-DbaPfDataCollectorCounterSample.html b/Get-DbaPfDataCollectorCounterSample.html index 786833c8..2861d243 100644 Binary files a/Get-DbaPfDataCollectorCounterSample.html and b/Get-DbaPfDataCollectorCounterSample.html differ diff --git a/Get-DbaPfDataCollectorSet.html b/Get-DbaPfDataCollectorSet.html index fd913d24..6deb83cb 100644 Binary files a/Get-DbaPfDataCollectorSet.html and b/Get-DbaPfDataCollectorSet.html differ diff --git a/Get-DbaPfDataCollectorSetTemplate.html b/Get-DbaPfDataCollectorSetTemplate.html index 66f6795e..07e593fb 100644 Binary files a/Get-DbaPfDataCollectorSetTemplate.html and b/Get-DbaPfDataCollectorSetTemplate.html differ diff --git a/Get-DbaPlanCache.html b/Get-DbaPlanCache.html index 136ffda1..3989e111 100644 Binary files a/Get-DbaPlanCache.html and b/Get-DbaPlanCache.html differ diff --git a/Get-DbaPowerPlan.html b/Get-DbaPowerPlan.html index c6f611b6..984fc2b3 100644 Binary files a/Get-DbaPowerPlan.html and b/Get-DbaPowerPlan.html differ diff --git a/Get-DbaPrivilege.html b/Get-DbaPrivilege.html index 0cc35f26..865a2f05 100644 Binary files a/Get-DbaPrivilege.html and b/Get-DbaPrivilege.html differ diff --git a/Get-DbaProcess.html b/Get-DbaProcess.html index 953683f3..6e11c91f 100644 Binary files a/Get-DbaProcess.html and b/Get-DbaProcess.html differ diff --git a/Get-DbaProductKey.html b/Get-DbaProductKey.html index 00a3023f..48d64b77 100644 Binary files a/Get-DbaProductKey.html and b/Get-DbaProductKey.html differ diff --git a/Get-DbaQueryExecutionTime.html b/Get-DbaQueryExecutionTime.html index a6cd5c9e..73bd7860 100644 Binary files a/Get-DbaQueryExecutionTime.html and b/Get-DbaQueryExecutionTime.html differ diff --git a/Get-DbaRandomizedDataset.html b/Get-DbaRandomizedDataset.html index 91ed034a..06da02f5 100644 Binary files a/Get-DbaRandomizedDataset.html and b/Get-DbaRandomizedDataset.html differ diff --git a/Get-DbaRandomizedDatasetTemplate.html b/Get-DbaRandomizedDatasetTemplate.html index 682fa3f1..7bfa828f 100644 Binary files a/Get-DbaRandomizedDatasetTemplate.html and b/Get-DbaRandomizedDatasetTemplate.html differ diff --git a/Get-DbaRandomizedType.html b/Get-DbaRandomizedType.html index 921a3c73..d14d30ce 100644 Binary files a/Get-DbaRandomizedType.html and b/Get-DbaRandomizedType.html differ diff --git a/Get-DbaRandomizedValue.html b/Get-DbaRandomizedValue.html index 0bc687b5..76882289 100644 Binary files a/Get-DbaRandomizedValue.html and b/Get-DbaRandomizedValue.html differ diff --git a/Get-DbaRegServer.html b/Get-DbaRegServer.html index e84e45cb..5ece3445 100644 Binary files a/Get-DbaRegServer.html and b/Get-DbaRegServer.html differ diff --git a/Get-DbaRegServerGroup.html b/Get-DbaRegServerGroup.html index 4332387b..c20f80f1 100644 Binary files a/Get-DbaRegServerGroup.html and b/Get-DbaRegServerGroup.html differ diff --git a/Get-DbaRegServerStore.html b/Get-DbaRegServerStore.html index d40a74f8..adcb0279 100644 Binary files a/Get-DbaRegServerStore.html and b/Get-DbaRegServerStore.html differ diff --git a/Get-DbaRegistryRoot.html b/Get-DbaRegistryRoot.html index 1e53b740..d27ee455 100644 Binary files a/Get-DbaRegistryRoot.html and b/Get-DbaRegistryRoot.html differ diff --git a/Get-DbaRepDistributor.html b/Get-DbaRepDistributor.html index 4a7081a0..e7eb6780 100644 Binary files a/Get-DbaRepDistributor.html and b/Get-DbaRepDistributor.html differ diff --git a/Get-DbaRepPublication.html b/Get-DbaRepPublication.html index dcd769e6..d489b58b 100644 Binary files a/Get-DbaRepPublication.html and b/Get-DbaRepPublication.html differ diff --git a/Get-DbaRepServer.html b/Get-DbaRepServer.html index dd5434ab..09cc72d4 100644 Binary files a/Get-DbaRepServer.html and b/Get-DbaRepServer.html differ diff --git a/Get-DbaReportingService.html b/Get-DbaReportingService.html new file mode 100644 index 00000000..6d634471 --- /dev/null +++ b/Get-DbaReportingService.html @@ -0,0 +1,665 @@ + + + + + + + dbatools docs | Get-DbaReportingService + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-DbaReportingService

+ + + + + + + + + + + + + + + + + +
AuthorKirill Kravtsov ( @nvarscar )
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Gets the SQL Server Reporting Services on a computer.

+

Description

+

Gets the SQL Server Reporting Services on one or more computers.

+

Requires Local Admin rights on destination computer(s).

+

Syntax

+
Get-DbaReportingService
+    [[-ComputerName] <DbaInstanceParameter[]>]
+    [-InstanceName <String[]>]
+    [-Credential <PSCredential>]
+    [-ServiceName <String[]>]
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Get-DbaReportingService -ComputerName sqlserver2014a
+
+

Gets the Reporting Services on computer sqlserver2014a.

+
Example: 2
+
PS C:\> $cred = Get-Credential WindowsUser
+PS C:\> Get-DbaReportingService -ComputerName sql1,sql2 -Credential $cred  | Out-GridView
+
+

Gets the Reporting Services on computers sql1 and sql2 via the user WindowsUser, and shows them in a grid view.

+
Example: 3
+
PS C:\> Get-DbaReportingService -ComputerName sql1,sql2 -InstanceName MSSQLSERVER
+
+

Gets the Reporting Services related to the default instance MSSQLSERVER on computers sql1 and sql2.

+
Example: 4
+
PS C:\> $MyServers =  Get-Content .\servers.txt
+PS C:\> Get-DbaReportingService -ComputerName $MyServers -ServiceName MSSQLSERVER,SQLSERVERAGENT
+
+

Gets the Reporting Services with ServiceName MSSQLSERVER or SQLSERVERAGENT for all the servers that are stored in the file. Every line in the file can only contain one hostname for a server.

+
Example: 5
+
PS C:\> $services = Get-DbaReportingService -ComputerName sql1
+PS C:\> $services.ChangeStartMode('Manual')
+
+

Gets the Reporting Services on computer sql1 and changes their startup mode to 'Manual'.

+
Example: 6
+
PS C:\> (Get-DbaReportingService -ComputerName sql1).Restart($true)
+
+

Calls a Restart method for each Reporting service on computer sql1.

+

Optional Parameters

+
-ComputerName
+

The target SQL Server instance or instances.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliascn,host,Server
RequiredFalse
Pipelinetrue (ByValue)
Default Value$env:COMPUTERNAME
+
-InstanceName
+

Only returns services that belong to the specific instances.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
AliasInstance
RequiredFalse
Pipelinefalse
Default Value
+
-Credential
+

Credential object used to connect to the computer as a different user.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ServiceName
+

Can be used to specify service names explicitly, without looking for service types/instances.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Get-DbaReportingService on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-DbaReportingService.

+ +
+
+
+
+ + + diff --git a/Get-DbaResourceGovernor.html b/Get-DbaResourceGovernor.html index 8afe0791..aed2c5ff 100644 Binary files a/Get-DbaResourceGovernor.html and b/Get-DbaResourceGovernor.html differ diff --git a/Get-DbaRgClassifierFunction.html b/Get-DbaRgClassifierFunction.html index fccfa0b9..a39e37bb 100644 Binary files a/Get-DbaRgClassifierFunction.html and b/Get-DbaRgClassifierFunction.html differ diff --git a/Get-DbaRgResourcePool.html b/Get-DbaRgResourcePool.html index ba14d5e7..8d7398f1 100644 Binary files a/Get-DbaRgResourcePool.html and b/Get-DbaRgResourcePool.html differ diff --git a/Get-DbaRgWorkloadGroup.html b/Get-DbaRgWorkloadGroup.html index a8e32989..d1fe7306 100644 Binary files a/Get-DbaRgWorkloadGroup.html and b/Get-DbaRgWorkloadGroup.html differ diff --git a/Get-DbaRunningJob.html b/Get-DbaRunningJob.html index c6888451..9e1d2711 100644 Binary files a/Get-DbaRunningJob.html and b/Get-DbaRunningJob.html differ diff --git a/Get-DbaRunspace.html b/Get-DbaRunspace.html new file mode 100644 index 00000000..646135c7 --- /dev/null +++ b/Get-DbaRunspace.html @@ -0,0 +1,524 @@ + + + + + + + dbatools docs | Get-DbaRunspace + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-DbaRunspace

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Returns registered runspaces.

+

Description

+

Returns a list of runspaces that have been registered with dbatools

+

Syntax

+
Get-DbaRunspace
+    [[-Name] <String>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Get-DbaRunspace
+
+

Returns all registered runspaces

+
Example: 2
+
PS C:\> Get-DbaRunspace -Name 'mymodule.maintenance'
+
+

Returns the runspace registered under the name 'mymodule.maintenance'

+

Optional Parameters

+
-Name
+

Default: "*" +Only registered runspaces of similar names are returned.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value*
+

 

+

Want to see the source code for this command? Check out Get-DbaRunspace on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-DbaRunspace.

+ +
+
+
+
+ + + diff --git a/Get-DbaSchemaChangeHistory.html b/Get-DbaSchemaChangeHistory.html index 1e6557f2..b2ea1ed4 100644 Binary files a/Get-DbaSchemaChangeHistory.html and b/Get-DbaSchemaChangeHistory.html differ diff --git a/Get-DbaServerRole.html b/Get-DbaServerRole.html index fe20d820..eb5c8c07 100644 Binary files a/Get-DbaServerRole.html and b/Get-DbaServerRole.html differ diff --git a/Get-DbaServerRoleMember.html b/Get-DbaServerRoleMember.html index d8f412e3..0e65f3c2 100644 Binary files a/Get-DbaServerRoleMember.html and b/Get-DbaServerRoleMember.html differ diff --git a/Get-DbaService.html b/Get-DbaService.html index 560625b1..5bd2f734 100644 Binary files a/Get-DbaService.html and b/Get-DbaService.html differ diff --git a/Get-DbaServiceErrorMessage.html b/Get-DbaServiceErrorMessage.html new file mode 100644 index 00000000..c9f33773 --- /dev/null +++ b/Get-DbaServiceErrorMessage.html @@ -0,0 +1,514 @@ + + + + + + + dbatools docs | Get-DbaServiceErrorMessage + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-DbaServiceErrorMessage

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal function. Returns the list of error code messages for Windows service management.

+

Description

+

Syntax

+
Get-DbaServiceErrorMessage
+    [[-ErrorNumber] <Int32>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-ErrorNumber
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinetrue (ByValue)
Default Value0
+

 

+

Want to see the source code for this command? Check out Get-DbaServiceErrorMessage on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-DbaServiceErrorMessage.

+ +
+
+
+
+ + + diff --git a/Get-DbaSpConfigure.html b/Get-DbaSpConfigure.html index 29ea6622..9ac60572 100644 Binary files a/Get-DbaSpConfigure.html and b/Get-DbaSpConfigure.html differ diff --git a/Get-DbaSpinLockStatistic.html b/Get-DbaSpinLockStatistic.html index ca22d373..dba9b5a2 100644 Binary files a/Get-DbaSpinLockStatistic.html and b/Get-DbaSpinLockStatistic.html differ diff --git a/Get-DbaSpn.html b/Get-DbaSpn.html index 322be21d..508c7a19 100644 Binary files a/Get-DbaSpn.html and b/Get-DbaSpn.html differ diff --git a/Get-DbaSsisExecutionHistory.html b/Get-DbaSsisExecutionHistory.html index e156e1d2..6f2a7347 100644 Binary files a/Get-DbaSsisExecutionHistory.html and b/Get-DbaSsisExecutionHistory.html differ diff --git a/Get-DbaStartupParameter.html b/Get-DbaStartupParameter.html index 1f98bec1..5540a727 100644 Binary files a/Get-DbaStartupParameter.html and b/Get-DbaStartupParameter.html differ diff --git a/Get-DbaStartupProcedure.html b/Get-DbaStartupProcedure.html index b483ced1..3d43cfd5 100644 Binary files a/Get-DbaStartupProcedure.html and b/Get-DbaStartupProcedure.html differ diff --git a/Get-DbaSuspectPage.html b/Get-DbaSuspectPage.html index 9d50687e..33ee3193 100644 Binary files a/Get-DbaSuspectPage.html and b/Get-DbaSuspectPage.html differ diff --git a/Get-DbaTcpPort.html b/Get-DbaTcpPort.html index 684691e7..51da6046 100644 Binary files a/Get-DbaTcpPort.html and b/Get-DbaTcpPort.html differ diff --git a/Get-DbaTempdbUsage.html b/Get-DbaTempdbUsage.html index 71ff9c95..3266c2f2 100644 Binary files a/Get-DbaTempdbUsage.html and b/Get-DbaTempdbUsage.html differ diff --git a/Get-DbaTopResourceUsage.html b/Get-DbaTopResourceUsage.html index 0f59cfb8..b61c8be7 100644 Binary files a/Get-DbaTopResourceUsage.html and b/Get-DbaTopResourceUsage.html differ diff --git a/Get-DbaTrace.html b/Get-DbaTrace.html index 5887a7f5..f639a36d 100644 Binary files a/Get-DbaTrace.html and b/Get-DbaTrace.html differ diff --git a/Get-DbaTraceFlag.html b/Get-DbaTraceFlag.html index 63d8d5df..47f3b411 100644 Binary files a/Get-DbaTraceFlag.html and b/Get-DbaTraceFlag.html differ diff --git a/Get-DbaUptime.html b/Get-DbaUptime.html index b56dd8c8..ccecd8e5 100644 Binary files a/Get-DbaUptime.html and b/Get-DbaUptime.html differ diff --git a/Get-DbaUserPermission.html b/Get-DbaUserPermission.html index e7701948..be6e91b6 100644 Binary files a/Get-DbaUserPermission.html and b/Get-DbaUserPermission.html differ diff --git a/Get-DbaWaitResource.html b/Get-DbaWaitResource.html index d1f5326d..87ac0843 100644 Binary files a/Get-DbaWaitResource.html and b/Get-DbaWaitResource.html differ diff --git a/Get-DbaWaitStatistic.html b/Get-DbaWaitStatistic.html index 83b021ea..5868d5a9 100644 Binary files a/Get-DbaWaitStatistic.html and b/Get-DbaWaitStatistic.html differ diff --git a/Get-DbaWaitingTask.html b/Get-DbaWaitingTask.html index 68edfd33..becf2dfa 100644 Binary files a/Get-DbaWaitingTask.html and b/Get-DbaWaitingTask.html differ diff --git a/Get-DbaWindowsLog.html b/Get-DbaWindowsLog.html index 136f1403..0850e578 100644 Binary files a/Get-DbaWindowsLog.html and b/Get-DbaWindowsLog.html differ diff --git a/Get-DbaWsfcAvailableDisk.html b/Get-DbaWsfcAvailableDisk.html index b8e3529b..d3149de7 100644 Binary files a/Get-DbaWsfcAvailableDisk.html and b/Get-DbaWsfcAvailableDisk.html differ diff --git a/Get-DbaWsfcCluster.html b/Get-DbaWsfcCluster.html index 9be2c513..6da46b74 100644 Binary files a/Get-DbaWsfcCluster.html and b/Get-DbaWsfcCluster.html differ diff --git a/Get-DbaWsfcDisk.html b/Get-DbaWsfcDisk.html index bc64ddda..6ba87ecc 100644 Binary files a/Get-DbaWsfcDisk.html and b/Get-DbaWsfcDisk.html differ diff --git a/Get-DbaWsfcNetwork.html b/Get-DbaWsfcNetwork.html index 5e88fce9..a2615150 100644 Binary files a/Get-DbaWsfcNetwork.html and b/Get-DbaWsfcNetwork.html differ diff --git a/Get-DbaWsfcNetworkInterface.html b/Get-DbaWsfcNetworkInterface.html index fa1a3a08..a2cf87ab 100644 Binary files a/Get-DbaWsfcNetworkInterface.html and b/Get-DbaWsfcNetworkInterface.html differ diff --git a/Get-DbaWsfcNode.html b/Get-DbaWsfcNode.html index b98fd4fb..a0602e52 100644 Binary files a/Get-DbaWsfcNode.html and b/Get-DbaWsfcNode.html differ diff --git a/Get-DbaWsfcResource.html b/Get-DbaWsfcResource.html index 6c7bd07d..8a576eea 100644 Binary files a/Get-DbaWsfcResource.html and b/Get-DbaWsfcResource.html differ diff --git a/Get-DbaWsfcResourceType.html b/Get-DbaWsfcResourceType.html index 412ac857..e0741a80 100644 Binary files a/Get-DbaWsfcResourceType.html and b/Get-DbaWsfcResourceType.html differ diff --git a/Get-DbaWsfcRole.html b/Get-DbaWsfcRole.html index c7681777..3d6a149e 100644 Binary files a/Get-DbaWsfcRole.html and b/Get-DbaWsfcRole.html differ diff --git a/Get-DbaWsfcSharedVolume.html b/Get-DbaWsfcSharedVolume.html index 302810c8..e5a6c714 100644 Binary files a/Get-DbaWsfcSharedVolume.html and b/Get-DbaWsfcSharedVolume.html differ diff --git a/Get-DbaXEObject.html b/Get-DbaXEObject.html index 8892df33..2203b934 100644 Binary files a/Get-DbaXEObject.html and b/Get-DbaXEObject.html differ diff --git a/Get-DbaXESession.html b/Get-DbaXESession.html index bc77fe37..0387ed08 100644 Binary files a/Get-DbaXESession.html and b/Get-DbaXESession.html differ diff --git a/Get-DbaXESessionTarget.html b/Get-DbaXESessionTarget.html index 9d0bba22..ae7da28a 100644 Binary files a/Get-DbaXESessionTarget.html and b/Get-DbaXESessionTarget.html differ diff --git a/Get-DbaXESessionTargetFile.html b/Get-DbaXESessionTargetFile.html index f8adaf65..2e4d1230 100644 Binary files a/Get-DbaXESessionTargetFile.html and b/Get-DbaXESessionTargetFile.html differ diff --git a/Get-DbaXESessionTemplate.html b/Get-DbaXESessionTemplate.html index 4ed0a330..4601f5f4 100644 Binary files a/Get-DbaXESessionTemplate.html and b/Get-DbaXESessionTemplate.html differ diff --git a/Get-DbaXESmartTarget.html b/Get-DbaXESmartTarget.html index a794b9ca..23efa29a 100644 Binary files a/Get-DbaXESmartTarget.html and b/Get-DbaXESmartTarget.html differ diff --git a/Get-DbaXEStore.html b/Get-DbaXEStore.html index edddbf27..f579ac22 100644 Binary files a/Get-DbaXEStore.html and b/Get-DbaXEStore.html differ diff --git a/Get-DbatoolsChangeLog.html b/Get-DbatoolsChangeLog.html index 7d0c9d22..dce11277 100644 Binary files a/Get-DbatoolsChangeLog.html and b/Get-DbatoolsChangeLog.html differ diff --git a/Get-DbatoolsConfig.html b/Get-DbatoolsConfig.html index 958b5f5e..6573de64 100644 Binary files a/Get-DbatoolsConfig.html and b/Get-DbatoolsConfig.html differ diff --git a/Get-DbatoolsConfigValue.html b/Get-DbatoolsConfigValue.html index 5cadcd6d..d7d8509e 100644 Binary files a/Get-DbatoolsConfigValue.html and b/Get-DbatoolsConfigValue.html differ diff --git a/Get-DbatoolsError.html b/Get-DbatoolsError.html index d45b36be..0b7f15c1 100644 Binary files a/Get-DbatoolsError.html and b/Get-DbatoolsError.html differ diff --git a/Get-DbatoolsLog.html b/Get-DbatoolsLog.html index 90237dba..48c91567 100644 Binary files a/Get-DbatoolsLog.html and b/Get-DbatoolsLog.html differ diff --git a/Get-DbatoolsPath.html b/Get-DbatoolsPath.html index c12f009c..18ab9bed 100644 Binary files a/Get-DbatoolsPath.html and b/Get-DbatoolsPath.html differ diff --git a/Get-DecryptedObject.html b/Get-DecryptedObject.html new file mode 100644 index 00000000..41614003 --- /dev/null +++ b/Get-DecryptedObject.html @@ -0,0 +1,580 @@ + + + + + + + dbatools docs | Get-DecryptedObject + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-DecryptedObject

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal function.

+

This function is heavily based on Antti Rantasaari's script at http://goo.gl/wpqSib +Antti Rantasaari 2014, NetSPI +License: BSD 3-Clause http://opensource.org/licenses/BSD-3-Clause

+

Description

+

Syntax

+
Get-DecryptedObject
+    [-SqlInstance] <Server>
+    [-Type] <String>
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-SqlInstance
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-Type
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
Accepted ValuesLinkedServer,Credential
+

Optional Parameters

+
-EnableException
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Get-DecryptedObject on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-DecryptedObject.

+ +
+
+
+
+ + + diff --git a/Get-DirectoryRestoreFile.html b/Get-DirectoryRestoreFile.html new file mode 100644 index 00000000..61ecd0eb --- /dev/null +++ b/Get-DirectoryRestoreFile.html @@ -0,0 +1,574 @@ + + + + + + + dbatools docs | Get-DirectoryRestoreFile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-DirectoryRestoreFile

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal Function to get SQL Server backfiles from a specified folder

+

Description

+

Takes path, checks for validity. Scans for usual backup file

+

Syntax

+
Get-DirectoryRestoreFile
+    [-Path] <String>
+    [-Recurse]
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-Path
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinetrue (ByValue)
Default Value
+

Optional Parameters

+
-Recurse
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-EnableException
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Get-DirectoryRestoreFile on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-DirectoryRestoreFile.

+ +
+
+
+
+ + + diff --git a/Get-ErrorMessage.html b/Get-ErrorMessage.html new file mode 100644 index 00000000..c16da7a0 --- /dev/null +++ b/Get-ErrorMessage.html @@ -0,0 +1,514 @@ + + + + + + + dbatools docs | Get-ErrorMessage + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-ErrorMessage

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Get-ErrorMessage -Record []

+

Description

+

Syntax

+
Get-ErrorMessagesyntaxItem----------{@{name=
+
+Get-ErrorMessage; CommonParameters=True; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-Record
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinetrue (ByValue)
Default Value
+

 

+

Want to see the source code for this command? Check out Get-ErrorMessage on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-ErrorMessage.

+ +
+
+
+
+ + + diff --git a/Get-ExportFilePath.html b/Get-ExportFilePath.html new file mode 100644 index 00000000..b6520c18 --- /dev/null +++ b/Get-ExportFilePath.html @@ -0,0 +1,654 @@ + + + + + + + dbatools docs | Get-ExportFilePath + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-ExportFilePath

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Get-ExportFilePath [-Path ] [-FilePath ] [-Type ] [-ServerName ] [-DatabaseName ] -Unique

+

Description

+

Syntax

+
Get-ExportFilePathsyntaxItem----------{@{name=
+
+Get-ExportFilePath; CommonParameters=False; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-DatabaseName
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-FilePath
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Path
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ServerName
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Type
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Unique
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Get-ExportFilePath on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-ExportFilePath.

+ + + + + + + + diff --git a/Get-InternalService.html b/Get-InternalService.html new file mode 100644 index 00000000..31e458b1 --- /dev/null +++ b/Get-InternalService.html @@ -0,0 +1,673 @@ + + + + + + + dbatools docs | Get-InternalService + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-InternalService

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Uses WMI/CIM to scan for the existance of a specific windows services.

+

Description

+

Uses WMI/CIM to scan for the existance of a specific windows services.

+

Use Get-InternalService if you are interested in scanning for sql server services exclusively.

+

Syntax

+
Get-InternalService
+    [[-Name] <String[]>]
+    [[-DisplayName] <String[]>]
+    [[-ComputerName] <DbaInstanceParameter[]>]
+    [[-Credential] <PSCredential>]
+    [[-DoNotUse] {None | CimRM | CimDCOM | Wmi | PowerShellRemoting}]
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Get-InternalService -Name LanmanServer
+Returns information on the LanmanServer service from localhost.

+
Example: 2
+

PS > Get-ADComputer -Filter * | Get-InternalService -Name Browser
+First retrieves all computer accounts from active directory, then scans all of those computers for the browser service.
+Note: THis may take seriously long time, you may also want to filter out computers that are offline before scanning for services.

+
Example: 3
+

PS > Get-InternalService -ComputerName "server1","server2","server3" -Name Lanman%
+Scans the servers server1, server2 and server3 for all services whose name starts with 'lanman'

+

Optional Parameters

+
-Name
+

The name of the service to search for.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-DisplayName
+

The display-name of the service to search for.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ComputerName
+

The computer to target. Uses localhost by default.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinetrue (ByValue)
Default Value$env:COMPUTERNAME
+
-Credential
+

The credentials to use when connecting to the computer.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-DoNotUse
+

Connection Protocols that should not be used when retrieving the information.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Get-InternalService on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-InternalService.

+ +
+
+
+
+ + + diff --git a/Get-JobList.html b/Get-JobList.html new file mode 100644 index 00000000..32fb5487 --- /dev/null +++ b/Get-JobList.html @@ -0,0 +1,687 @@ + + + + + + + dbatools docs | Get-JobList + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-JobList

+ + + + + + + + + + + + + + + + + +
AuthorShawn Melton (@wsmelton)
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Helper function to get SQL Agent jobs.

+

Description

+

Helper function to get all SQL Agent jobs or provide filter

+

Syntax

+
Get-JobList
+    [[-SqlInstance] <DbaInstanceParameter>]
+    [[-SqlCredential] <PSCredential>]
+    [[-JobFilter] <String[]>]
+    [[-StepFilter] <String[]>]
+    [-Not]
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Get-JobList -SqlInstance sql2016
+Returns the full JobServer.Jobs object found on sql2016

+
Example: 2
+

PS > Get-JobList -SqlInstance sql2016 -JobFilter 'job'
+Returns the Job object for each job name found to have "job" in the name on sql2016

+
Example: 3
+

PS > Get-JobList -SqlInstance sql2016 -JobFilter 'job' -Not
+Returns any Job object that does not have "job" in the name on sql2016

+
Example: 4
+

PS > Get-JobList -SqlInstance YourServer -JobFilter 'JobName'
+Returns the Job object where the job name is 'JobName' on sql2016

+
Example: 5
+

PS > Get-JobList -SqlInstance YourServer -JobFilter 'JobName' -Not
+Returns any Job object where the job name is not 'JobName' on sql2016

+
Example: 6
+

PS > Get-JobList -SqlInstance YourServer -JobFilter job_3_upload, job_3_download
+Returns the Job object for where job is job_3_upload or job_3_download on sql2016

+
Example: 7
+

PS > Get-JobList -SqlInstance YourServer -JobFilter job_3_upload, job_3_download -Not
+Returns any Job object where job is not job_3_upload or job_3_download on sql2016

+

Optional Parameters

+
-SqlInstance
+

SQL Server instance

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinetrue (ByValue)
Default Value
+
-SqlCredential
+

Credential to use if SqlInstance did not include it.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-JobFilter
+

Object of jobs to filter on, also supports wildcard patterns

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-StepFilter
+

Object of job steps to filter on, also supports wildcard patterns

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Not
+

Reverse results where object returned excludes filtered content.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Get-JobList on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-JobList.

+ +
+
+
+
+ + + diff --git a/Get-Language.html b/Get-Language.html new file mode 100644 index 00000000..ca2b865f --- /dev/null +++ b/Get-Language.html @@ -0,0 +1,518 @@ + + + + + + + dbatools docs | Get-Language + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-Language

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Converts Microsoft's language ID to human readable format

+

Description

+

Converts Microsoft's language ID to human readable format

+

Syntax

+
Get-Language
+    [[-id] <Int32>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Get-Language 1033
+Returns a pscustomobject with id, alias and name

+

Optional Parameters

+
-id
+

The language ID

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value0
+

 

+

Want to see the source code for this command? Check out Get-Language on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-Language.

+ +
+
+
+
+ + + diff --git a/Get-ObjectNameParts.html b/Get-ObjectNameParts.html new file mode 100644 index 00000000..3763403c --- /dev/null +++ b/Get-ObjectNameParts.html @@ -0,0 +1,527 @@ + + + + + + + dbatools docs | Get-ObjectNameParts + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-ObjectNameParts

+ + + + + + + + + + + + + + + + + +
AuthorPatrick Flynn (@sqllensman)
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Parse a one, two, or three part object name into seperate paths

+

Description

+

Takes a one, two or three part object name and splits them into Database, Schema and Name

+

Syntax

+
Get-ObjectNameParts
+    [[-ObjectName] <String>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Get-ObjectNameParts -ObjectName 'table'
+Parses a three-part name into its constitute parts.

+
Example: 2
+

PS > Get-ObjectNameParts -ObjectName '[Bad. Name]]].[Schema.With.Dots]]].[Another .Silly]] Name..]'
+Parses a three-part name into its constitute parts. Uses square brackets to enclose special characters.

+

Optional Parameters

+
-ObjectName
+

The object name to parse. You can specify a one, two, or three part object name. +If the object has special characters they must be wrapped in square brackets [ ]. +If the name contains character ']' this must be escaped by duplicating the character

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Get-ObjectNameParts on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-ObjectNameParts.

+ +
+
+
+
+ + + diff --git a/Get-OfflineSqlFileStructure.html b/Get-OfflineSqlFileStructure.html new file mode 100644 index 00000000..9da416d5 --- /dev/null +++ b/Get-OfflineSqlFileStructure.html @@ -0,0 +1,631 @@ + + + + + + + dbatools docs | Get-OfflineSqlFileStructure + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-OfflineSqlFileStructure

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal function. Returns dictionary object that contains file structures for SQL databases.

+

Description

+

Syntax

+
Get-OfflineSqlFileStructure
+    [-SqlInstance] <Object>
+    [-DbName] <String>
+    [-filelist] <Object>
+    [[-ReuseSourceFolderStructure] <Boolean>]
+    [-SqlCredential <PSCredential>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-SqlInstance
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-DbName
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-filelist
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-ReuseSourceFolderStructure
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-SqlCredential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Get-OfflineSqlFileStructure on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-OfflineSqlFileStructure.

+ +
+
+
+
+ + + diff --git a/Get-PasswordHash.html b/Get-PasswordHash.html new file mode 100644 index 00000000..16406313 --- /dev/null +++ b/Get-PasswordHash.html @@ -0,0 +1,583 @@ + + + + + + + dbatools docs | Get-PasswordHash + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-PasswordHash

+ + + + + + + + + + + + + + + + + +
AuthorKirill Kravtsov (@nvarscar)
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Generates a password hash for SQL Server login

+

Description

+

Generates a hash string based on the plaintext or securestring password and a SQL Server version. Salt is optional

+

Syntax

+
Get-PasswordHash
+    [[-Password] <Object>]
+    [[-SqlMajorVersion] <Object>]
+    [[-byteSalt] <Byte[]>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Get-PasswordHash $securePassword 11
+Generates password hash for SQL 2012

+
Example: 2
+

PS > Get-PasswordHash $securePassword 9 $byte
+Generates password hash for SQL 2005 using custom salt from the $byte variable

+

Optional Parameters

+
-Password
+

Either plain text or Securestring password

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-SqlMajorVersion
+

Major version of the SQL Server. Defines the hash algorithm.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-byteSalt
+

Optional. Inserts custom salt into the hash instead of randomly generating new salt

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Get-PasswordHash on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-PasswordHash.

+ +
+
+
+
+ + + diff --git a/Get-RandomPassword.html b/Get-RandomPassword.html new file mode 100644 index 00000000..ed3ac1e8 --- /dev/null +++ b/Get-RandomPassword.html @@ -0,0 +1,542 @@ + + + + + + + dbatools docs | Get-RandomPassword + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-RandomPassword

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Get-RandomPassword [-Length ] -AsPlainText

+

Description

+

Syntax

+
Get-RandomPasswordsyntaxItem----------{@{name=
+
+Get-RandomPassword; CommonParameters=False; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-AsPlainText
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Length
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Get-RandomPassword on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-RandomPassword.

+ + + + + + + + diff --git a/Get-RegServerGroupReverseParse.html b/Get-RegServerGroupReverseParse.html new file mode 100644 index 00000000..a6d0ca67 --- /dev/null +++ b/Get-RegServerGroupReverseParse.html @@ -0,0 +1,514 @@ + + + + + + + dbatools docs | Get-RegServerGroupReverseParse + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-RegServerGroupReverseParse

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Get-RegServerGroupReverseParse [-object ]

+

Description

+

Syntax

+
Get-RegServerGroupReverseParsesyntaxItem----------{@{name=
+
+Get-RegServerGroupReverseParse; CommonParameters=False; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-object
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Get-RegServerGroupReverseParse on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-RegServerGroupReverseParse.

+ + + + + + + + diff --git a/Get-RegServerParent.html b/Get-RegServerParent.html new file mode 100644 index 00000000..00311fab --- /dev/null +++ b/Get-RegServerParent.html @@ -0,0 +1,514 @@ + + + + + + + dbatools docs | Get-RegServerParent + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-RegServerParent

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Get-RegServerParent [-InputObject ] []

+

Description

+

Syntax

+
Get-RegServerParentsyntaxItem----------{@{name=
+
+Get-RegServerParent; CommonParameters=True; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-InputObject
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Get-RegServerParent on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-RegServerParent.

+ + + + + + + + diff --git a/Get-ResourceState.html b/Get-ResourceState.html new file mode 100644 index 00000000..153173a6 --- /dev/null +++ b/Get-ResourceState.html @@ -0,0 +1,514 @@ + + + + + + + dbatools docs | Get-ResourceState + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-ResourceState

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Get-ResourceState [-state ]

+

Description

+

Syntax

+
Get-ResourceStatesyntaxItem----------{@{name=
+
+Get-ResourceState; CommonParameters=False; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-state
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Get-ResourceState on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-ResourceState.

+ + + + + + + + diff --git a/Get-RestoreContinuableDatabase.html b/Get-RestoreContinuableDatabase.html new file mode 100644 index 00000000..37e1cb5b --- /dev/null +++ b/Get-RestoreContinuableDatabase.html @@ -0,0 +1,576 @@ + + + + + + + dbatools docs | Get-RestoreContinuableDatabase + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-RestoreContinuableDatabase

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Gets a list of databases from a SQL instance that are in a state for further restores

+

Description

+

Takes a SQL instance and checks for databases with a redo_start_lsn value, and returns the database name and that value +-gt SQl 2005 it comes from master.sys.master_files +-eq SQL 2000 DBCC DBINFO

+

Syntax

+
Get-RestoreContinuableDatabase
+    [-SqlInstance] <Object>
+    [[-SqlCredential] <PSCredential>]
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-SqlInstance
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinetrue (ByValue)
Default Value
+

Optional Parameters

+
-SqlCredential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-EnableException
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Get-RestoreContinuableDatabase on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-RestoreContinuableDatabase.

+ +
+
+
+
+ + + diff --git a/Get-SQLInstanceComponent.html b/Get-SQLInstanceComponent.html new file mode 100644 index 00000000..5c9c03ef --- /dev/null +++ b/Get-SQLInstanceComponent.html @@ -0,0 +1,626 @@ + + + + + + + dbatools docs | Get-SQLInstanceComponent + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-SQLInstanceComponent

+ + + + + + + + + + + + + + + + + +
AuthorKirill Kravtsov (@nvarscar) https://nvarscar.wordpress.com/
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Retrieves SQL server information from a local or remote servers.

+

Description

+

Retrieves SQL server information from a local or remote servers. Pulls all instances from a SQL server and +detects if in a cluster or not.

+

Syntax

+
Get-SQLInstanceComponent
+    [[-ComputerName] <DbaInstanceParameter[]>]
+    [[-Component] <String[]>]
+    [[-Credential] <PSCredential>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Get-SQLInstanceComponent -ComputerName SQL01 -Component SSDS
+ComputerName : BDT005-BT-SQL
+InstanceType : Database Engine
+InstanceName : MSSQLSERVER
+InstanceID : MSSQL11.MSSQLSERVER
+Edition : Enterprise Edition
+Version : 11.1.3000.0
+Caption : SQL Server 2012
+IsCluster : False
+IsClusterNode : False
+ClusterName :
+ClusterNodes :
+FullName : BDT005-BT-SQL

+
+

Retrieves the SQL instance information from SQL01 for component type SSDS (Database Engine).

+
Example: 2
+

PS > Get-SQLInstanceComponent -ComputerName SQL01
+ComputerName : BDT005-BT-SQL
+InstanceType : Analysis Services
+InstanceName : MSSQLSERVER
+InstanceID : MSAS11.MSSQLSERVER
+Edition : Enterprise Edition
+Version : 11.1.3000.0
+Caption : SQL Server 2012
+IsCluster : False
+IsClusterNode : False
+ClusterName :
+ClusterNodes :
+FullName : BDT005-BT-SQL
+ComputerName : BDT005-BT-SQL
+InstanceType : Reporting Services
+InstanceName : MSSQLSERVER
+InstanceID : MSRS11.MSSQLSERVER
+Edition : Enterprise Edition
+Version : 11.1.3000.0
+Caption : SQL Server 2012
+IsCluster : False
+IsClusterNode : False
+ClusterName :
+ClusterNodes :
+FullName : BDT005-BT-SQL

+
+

Retrieves the SQL instance information from SQL01 for all component types (SSAS, SSDS, SSRS).

+

Optional Parameters

+
-ComputerName
+

Local or remote systems to query for SQL information.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
AliasComputer,DNSHostName,IPAddress
RequiredFalse
Pipelinetrue (ByValue, ByPropertyName)
Default Value$Env:COMPUTERNAME
+
-Component
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value@('SSDS', 'SSAS', 'SSRS')
Accepted ValuesSSDS,SSAS,SSRS
+
-Credential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Get-SQLInstanceComponent on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-SQLInstanceComponent.

+ +
+
+
+
+ + + diff --git a/Get-SaLoginName.html b/Get-SaLoginName.html new file mode 100644 index 00000000..fe9a9583 --- /dev/null +++ b/Get-SaLoginName.html @@ -0,0 +1,547 @@ + + + + + + + dbatools docs | Get-SaLoginName + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-SaLoginName

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Gets the login matching the standard "sa" user

+

Description

+

Gets the login matching the standard "sa" user, useful in case of renames

+

Syntax

+
Get-SaLoginName
+    [-SqlInstance] <Object>
+    [[-SqlCredential] <PSCredential>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Get-SaLoginName -SqlInstance base\sql2016

+

Required Parameters

+
-SqlInstance
+

The SQL Server instance.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-SqlCredential
+

Allows you to login to servers using SQL Logins instead of Windows Authentication (AKA Integrated or Trusted).

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Get-SaLoginName on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-SaLoginName.

+ +
+
+
+
+ + + diff --git a/Get-SqlCmdVars.html b/Get-SqlCmdVars.html new file mode 100644 index 00000000..23943f03 --- /dev/null +++ b/Get-SqlCmdVars.html @@ -0,0 +1,587 @@ + + + + + + + dbatools docs | Get-SqlCmdVars + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-SqlCmdVars

+ + + + + + + + + + + + + + + + + +
AuthorRichie lee (@bzzzt_io)
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Retrieves the values of PowerShell parameters and updates values of SqlmdVars listed in the publish.xml.

+

Description

+

Attempt to resolve SQLCmd variables via matching powershell variables explicitly defined in the current context. +To try and avoid 'bad' default values getting deployed, block a deployment if we have SqlCmd variables that aren't defined in current context. +Function has one reference and is executed when the "getSqlCmdVars" switch is included.

+

Syntax

+
Get-SqlCmdVars
+    [-SqlCommandVariableValues] <Object>
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Imagine content of MyDbProject.publish.xml is as follows -

+
+


+
+True
+MyDbProject
+MyDbProject.sql
+Data Source=.;Integrated Security=True;Persist Security Info=False;Pooling=False;MultipleActiveResultSets=False;Connect
+Timeout=60;Encrypt=False;TrustServerCertificate=True
+True
+False
+1
+
+
+
+OldValue
+
+
+
+We will need one PowerShell parameter named $DeployTag to update the value
+The following scenario will fail as no $deployTag -
+"
+$publishXml = "C:\MyDbProject\bin\Debug\MyDbProject.publish.xml"
+$dacProfile = [Microsoft.SqlServer.Dac.DacProfile]::Load($publishXml)
+Get-SqlCmdVars $dacProfile.DeployOptions.SqlCommandVariableValues -EnableException
+"
+This scenario will pass.
+"
+$deployTag = "NewValue"
+$publishXml = "C:\MyDbProject\bin\Debug\MyDbProject.publish.xml"
+$dacProfile = [Microsoft.SqlServer.Dac.DacProfile]::Load($publishXml)
+Get-SqlCmdVars $dacProfile.DeployOptions.SqlCommandVariableValues -EnableException
+"

+

Required Parameters

+
-SqlCommandVariableValues
+

Mandatory. The SqlCommandVariableValues from the DeployOptions property in the Microsoft.SqlServer.Dac.DacProfile

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Get-SqlCmdVars on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-SqlCmdVars.

+ +
+
+
+
+ + + diff --git a/Get-SqlDefaultPaths.html b/Get-SqlDefaultPaths.html new file mode 100644 index 00000000..80aef37f --- /dev/null +++ b/Get-SqlDefaultPaths.html @@ -0,0 +1,573 @@ + + + + + + + dbatools docs | Get-SqlDefaultPaths + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-SqlDefaultPaths

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal function. Returns the default data and log paths for SQL Server. Needed because SMO's server.defaultpath is sometimes null.

+

Description

+

Syntax

+
Get-SqlDefaultPaths
+    [-SqlInstance] <Object>
+    [-filetype] <String>
+    [[-SqlCredential] <PSCredential>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-SqlInstance
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-filetype
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-SqlCredential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Get-SqlDefaultPaths on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-SqlDefaultPaths.

+ +
+
+
+
+ + + diff --git a/Get-SqlDefaultSpConfigure.html b/Get-SqlDefaultSpConfigure.html new file mode 100644 index 00000000..bb3c52ee --- /dev/null +++ b/Get-SqlDefaultSpConfigure.html @@ -0,0 +1,517 @@ + + + + + + + dbatools docs | Get-SqlDefaultSpConfigure + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-SqlDefaultSpConfigure

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal function. Returns the default sp_configure options for a given version of SQL Server.

+

Description

+

Syntax

+
Get-SqlDefaultSpConfigure
+    [-SqlVersion] <Object>
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Get-SqlDefaultSpConfigure -SqlVersion 11
+Returns a list of sp_configure (sys.configurations) items for SQL 2012.

+

Required Parameters

+
-SqlVersion
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
AliasVersion
RequiredTrue
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Get-SqlDefaultSpConfigure on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-SqlDefaultSpConfigure.

+ +
+
+
+
+ + + diff --git a/Get-SqlFileStructure.html b/Get-SqlFileStructure.html new file mode 100644 index 00000000..42dff775 --- /dev/null +++ b/Get-SqlFileStructure.html @@ -0,0 +1,632 @@ + + + + + + + dbatools docs | Get-SqlFileStructure + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-SqlFileStructure

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal function. Returns custom object that contains file structures on destination paths (\SqlInstance\m$\mssql\etc\etc\file.mdf) for +source and destination servers.

+

Description

+

Syntax

+
Get-SqlFileStructure
+    [-source] <Object>
+    [-destination] <Object>
+    [-ReuseSourceFolderStructure <Boolean>]
+    [-SourceSqlCredential <PSCredential>]
+    [-DestinationSqlCredential <PSCredential>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-source
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-destination
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-ReuseSourceFolderStructure
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-SourceSqlCredential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-DestinationSqlCredential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Get-SqlFileStructure on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-SqlFileStructure.

+ +
+
+
+
+ + + diff --git a/Get-SqlInstanceUpdate.html b/Get-SqlInstanceUpdate.html new file mode 100644 index 00000000..6cbcd4d9 --- /dev/null +++ b/Get-SqlInstanceUpdate.html @@ -0,0 +1,777 @@ + + + + + + + dbatools docs | Get-SqlInstanceUpdate + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-SqlInstanceUpdate

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Get-SqlInstanceUpdate -ComputerName -Type [-Credential ] [-Component <Object[]>] [-InstanceName ] [-EnableException ] [-Continue ] []

+

Get-SqlInstanceUpdate -ComputerName [-Credential ] [-Component <Object[]>] [-ServicePack ] [-CumulativeUpdate ] [-InstanceName ] [-EnableException ] [-Continue ] []

+

Get-SqlInstanceUpdate -ComputerName -KB [-Credential ] [-Component <Object[]>] [-InstanceName ] [-EnableException ] [-Continue ] []

+

Description

+

Syntax

+
Get-SqlInstanceUpdatesyntaxItem----------{@{name=
+
+Get-SqlInstanceUpdate; CommonParameters=True; parameter=System.Object[]}, @{name=
+
+Get-SqlInstanceUpdate; CommonParameters=True; parameter=System.Object[]}, @{name=
+
+Get-SqlInstanceUpdate; CommonParameters=True; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-ComputerName
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-KB
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-Type
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
Accepted ValuesServicePack,CumulativeUpdate
+

Optional Parameters

+
-Component
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Continue
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Credential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-CumulativeUpdate
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-EnableException
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-InstanceName
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ServicePack
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Get-SqlInstanceUpdate on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-SqlInstanceUpdate.

+ +
+
+
+
+ + + diff --git a/Get-SqlSaLogin.html b/Get-SqlSaLogin.html new file mode 100644 index 00000000..1fa4fcde --- /dev/null +++ b/Get-SqlSaLogin.html @@ -0,0 +1,544 @@ + + + + + + + dbatools docs | Get-SqlSaLogin + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-SqlSaLogin

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal function. Gets the name of the sa login in case someone changed it.

+

Description

+

Syntax

+
Get-SqlSaLogin
+    [-SqlInstance] <Object>
+    [[-SqlCredential] <PSCredential>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-SqlInstance
+

The SQL Server instance.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-SqlCredential
+

Allows you to login to servers using SQL Logins instead of Windows Authentication (AKA Integrated or Trusted).

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Get-SqlSaLogin on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-SqlSaLogin.

+ +
+
+
+
+ + + diff --git a/Get-WmiHadr.html b/Get-WmiHadr.html new file mode 100644 index 00000000..2683e346 --- /dev/null +++ b/Get-WmiHadr.html @@ -0,0 +1,571 @@ + + + + + + + dbatools docs | Get-WmiHadr + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-WmiHadr

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Get-WmiHadr -SqlInstance <DbaInstanceParameter[]> [-Credential ] -EnableException []

+

Description

+

Syntax

+
Get-WmiHadrsyntaxItem----------{@{name=
+
+Get-WmiHadr; CommonParameters=True; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-SqlInstance
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinetrue (ByValue)
Default Value
+

Optional Parameters

+
-Credential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-EnableException
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Get-WmiHadr on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-WmiHadr.

+ +
+
+
+
+ + + diff --git a/Get-XPlatVariable.html b/Get-XPlatVariable.html new file mode 100644 index 00000000..ee07b313 --- /dev/null +++ b/Get-XPlatVariable.html @@ -0,0 +1,485 @@ + + + + + + + dbatools docs | Get-XPlatVariable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-XPlatVariable

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Get-XPlatVariable

+

Description

+

Syntax

+
Get-XPlatVariablesyntaxItem----------{@{name=
+
+Get-XPlatVariable; CommonParameters=False; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

 

+

Want to see the source code for this command? Check out Get-XPlatVariable on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-XPlatVariable.

+ +
+
+
+
+ + + diff --git a/Get-XpDirTreeRestoreFile.html b/Get-XpDirTreeRestoreFile.html new file mode 100644 index 00000000..f195276f --- /dev/null +++ b/Get-XpDirTreeRestoreFile.html @@ -0,0 +1,638 @@ + + + + + + + dbatools docs | Get-XpDirTreeRestoreFile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Get-XpDirTreeRestoreFile

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal Function to get SQL Server backfiles from a specified folder using xp_dirtree

+

Description

+

Takes path, checks for validity. Scans for usual backup file

+

Syntax

+
Get-XpDirTreeRestoreFile
+    [-Path] <String>
+    [-SqlInstance] <DbaInstanceParameter>
+    [[-SqlCredential] <PSCredential>]
+    [-EnableException]
+    [-NoRecurse]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Get-XpDirTreeRestoreFile -Path '\\foo\bar\' -SqlInstance $SqlInstance
+
+

Tests whether the instance $SqlInstance has access to the path \foo\bar<br>

+

Required Parameters

+
-Path
+

The path to retrieve the restore for.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinetrue (ByValue)
Default Value
+
-SqlInstance
+

The SQL Server that you're connecting to.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-SqlCredential
+

Credential object used to connect to the SQL Server as a different user

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-NoRecurse
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Get-XpDirTreeRestoreFile on GitHub. +
+Want to see the Bill Of Health for this command? Check out Get-XpDirTreeRestoreFile.

+ +
+
+
+
+ + + diff --git a/Grant-DbaAgPermission.html b/Grant-DbaAgPermission.html index e68027d6..e8c2302e 100644 Binary files a/Grant-DbaAgPermission.html and b/Grant-DbaAgPermission.html differ diff --git a/Hide-ConnectionString.html b/Hide-ConnectionString.html new file mode 100644 index 00000000..5f53f978 --- /dev/null +++ b/Hide-ConnectionString.html @@ -0,0 +1,514 @@ + + + + + + + dbatools docs | Hide-ConnectionString + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Hide-ConnectionString

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Hide-ConnectionString [-ConnectionString ]

+

Description

+

Syntax

+
Hide-ConnectionStringsyntaxItem----------{@{name=
+
+Hide-ConnectionString; CommonParameters=False; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-ConnectionString
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Hide-ConnectionString on GitHub. +
+Want to see the Bill Of Health for this command? Check out Hide-ConnectionString.

+ +
+
+
+
+ + + diff --git a/Import-DbaCmdlet.html b/Import-DbaCmdlet.html new file mode 100644 index 00000000..abf7167b --- /dev/null +++ b/Import-DbaCmdlet.html @@ -0,0 +1,613 @@ + + + + + + + dbatools docs | Import-DbaCmdlet + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Import-DbaCmdlet

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Loads a cmdlet into the current context.

+

Description

+

Loads a cmdlet into the current context. +This can be used to register a cmdlet during module import, making it easy to have hybrid modules publishing both cmdlets and functions. +Can also be used to register cmdlets written in PowerShell classes.

+

Syntax

+
Import-DbaCmdlet
+    [-Name] <String>
+    [-Type] <Type>
+    [[-HelpFile] <String>]
+    [[-Module] <PSModuleInfo>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Import-DbaCmdlet -Name Get-Something -Type ([GetSomethingCommand])
+
+

Imports the Get-Something cmdlet into the current context.

+
Example: 2
+
PS C:\> Import-DbaCmdlet -Name Get-Something -Type ([GetSomethingCommand]) -Module (Get-Module PSReadline)
+
+

Imports the Get-Something cmdlet into the PSReadline module.

+

Required Parameters

+
-Name
+

The name of the cmdlet to register.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-Type
+

The type of the class implementing the cmdlet.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-HelpFile
+

Path to the help XML containing the help for the cmdlet.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Module
+

Module to inject the cmdlet into.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Import-DbaCmdlet on GitHub. +
+Want to see the Bill Of Health for this command? Check out Import-DbaCmdlet.

+ +
+
+
+
+ + + diff --git a/Import-DbaCsv.html b/Import-DbaCsv.html index 3981d600..87959ff7 100644 Binary files a/Import-DbaCsv.html and b/Import-DbaCsv.html differ diff --git a/Import-DbaPfDataCollectorSetTemplate.html b/Import-DbaPfDataCollectorSetTemplate.html index 06c3db8a..418013ea 100644 Binary files a/Import-DbaPfDataCollectorSetTemplate.html and b/Import-DbaPfDataCollectorSetTemplate.html differ diff --git a/Import-DbaRegServer.html b/Import-DbaRegServer.html index 766ed12f..e6ebcfae 100644 Binary files a/Import-DbaRegServer.html and b/Import-DbaRegServer.html differ diff --git a/Import-DbaSpConfigure.html b/Import-DbaSpConfigure.html index 786f6ace..e461fb85 100644 Binary files a/Import-DbaSpConfigure.html and b/Import-DbaSpConfigure.html differ diff --git a/Import-DbaXESessionTemplate.html b/Import-DbaXESessionTemplate.html index 288a79ca..0d9a8b80 100644 Binary files a/Import-DbaXESessionTemplate.html and b/Import-DbaXESessionTemplate.html differ diff --git a/Import-DbatoolsConfig.html b/Import-DbatoolsConfig.html index 5a19c027..47738556 100644 Binary files a/Import-DbatoolsConfig.html and b/Import-DbatoolsConfig.html differ diff --git a/Import-ModuleFile.html b/Import-ModuleFile.html new file mode 100644 index 00000000..777bf94e --- /dev/null +++ b/Import-ModuleFile.html @@ -0,0 +1,520 @@ + + + + + + + dbatools docs | Import-ModuleFile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Import-ModuleFile

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Helps import dbatools files according to configuration

+

Description

+

Helps import dbatools files according to configuration +Always dotsource this function!

+

Syntax

+
Import-ModuleFile
+    [[-Path] <Object>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Import-ModuleFile -Path $function.FullName
+
+

Imports the file stored at '$function.FullName'

+

Optional Parameters

+
-Path
+

The full path to the file to import

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Import-ModuleFile on GitHub. +
+Want to see the Bill Of Health for this command? Check out Import-ModuleFile.

+ +
+
+
+
+ + + diff --git a/Initialize-CredSSP.html b/Initialize-CredSSP.html new file mode 100644 index 00000000..df78977e --- /dev/null +++ b/Initialize-CredSSP.html @@ -0,0 +1,589 @@ + + + + + + + dbatools docs | Initialize-CredSSP + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Initialize-CredSSP

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Configure local and remote computers to use Credssp protocol

+

Description

+

Enables both local and remote machine to participate in a Credssp session. +Local computer will be told to trust the Delegate (remote) computer. +Remote computer will be configured to act as a server and accept client connections from local computer.

+

This function can be disabled by setting the value of configuration item "commands.initialize-credssp.bypass" to $true. +Configuration of CredSSP can and will be done by this command only from an elevated PowerShell session.

+

Syntax

+
Initialize-CredSSP
+    [-ComputerName] <String>
+    [-Credential <PSCredential>]
+    [-EnableException <Boolean>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Initialize-CredSSP MyRemoteComputer
+
+

Configure CredSSP protocol to connect to remote computer MyRemoteComputer

+
Example: 2
+
PS C:\> $cred = Get-Credential
+PS C:\> Initialize-CredSSP -ComputerName PC2 -Credential $cred
+
+

Configure CredSSP protocol to connect to remote computer with custom credentials

+

Required Parameters

+
-ComputerName
+

Remote computer name

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-Credential
+

PSCredential object used for authentication

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Initialize-CredSSP on GitHub. +
+Want to see the Bill Of Health for this command? Check out Initialize-CredSSP.

+ +
+
+
+
+ + + diff --git a/Install-DbaDarlingData.html b/Install-DbaDarlingData.html index e5014fa4..766db196 100644 Binary files a/Install-DbaDarlingData.html and b/Install-DbaDarlingData.html differ diff --git a/Install-DbaFirstResponderKit.html b/Install-DbaFirstResponderKit.html index a8ff15e9..bb00ce34 100644 Binary files a/Install-DbaFirstResponderKit.html and b/Install-DbaFirstResponderKit.html differ diff --git a/Install-DbaInstance.html b/Install-DbaInstance.html index 6e1a4f01..546fd279 100644 Binary files a/Install-DbaInstance.html and b/Install-DbaInstance.html differ diff --git a/Install-DbaMaintenanceSolution.html b/Install-DbaMaintenanceSolution.html index ba6b22c7..b28103b0 100644 Binary files a/Install-DbaMaintenanceSolution.html and b/Install-DbaMaintenanceSolution.html differ diff --git a/Install-DbaMultiTool.html b/Install-DbaMultiTool.html index 0341eba7..32f45d3b 100644 Binary files a/Install-DbaMultiTool.html and b/Install-DbaMultiTool.html differ diff --git a/Install-DbaSqlWatch.html b/Install-DbaSqlWatch.html index ddf644f0..5301bd9b 100644 Binary files a/Install-DbaSqlWatch.html and b/Install-DbaSqlWatch.html differ diff --git a/Install-DbaWhoIsActive.html b/Install-DbaWhoIsActive.html index 96abd00d..792abb1f 100644 Binary files a/Install-DbaWhoIsActive.html and b/Install-DbaWhoIsActive.html differ diff --git a/Install-DbatoolsWatchUpdate.html b/Install-DbatoolsWatchUpdate.html index 4da91f47..16da2cc7 100644 Binary files a/Install-DbatoolsWatchUpdate.html and b/Install-DbatoolsWatchUpdate.html differ diff --git a/Invoke-Alter.html b/Invoke-Alter.html new file mode 100644 index 00000000..18277c2e --- /dev/null +++ b/Invoke-Alter.html @@ -0,0 +1,570 @@ + + + + + + + dbatools docs | Invoke-Alter + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Invoke-Alter

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Invoke-Alter [-Object ] -WhatIf -Confirm []

+

Description

+

Syntax

+
Invoke-AltersyntaxItem----------{@{name=
+
+Invoke-Alter; CommonParameters=True; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-Confirm
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliascf
RequiredFalse
Pipelinefalse
Default Value
+
-Object
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-WhatIf
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliaswi
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Invoke-Alter on GitHub. +
+Want to see the Bill Of Health for this command? Check out Invoke-Alter.

+ + + + + + + + diff --git a/Invoke-Command2.html b/Invoke-Command2.html new file mode 100644 index 00000000..a0cd0bc4 --- /dev/null +++ b/Invoke-Command2.html @@ -0,0 +1,791 @@ + + + + + + + dbatools docs | Invoke-Command2 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Invoke-Command2

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Wrapper function that calls Invoke-Command and gracefully handles credentials.

+

Description

+

Wrapper function that calls Invoke-Command and gracefully handles credentials.

+

Syntax

+
Invoke-Command2
+    [[-ComputerName] <DbaInstanceParameter>]
+    [[-Credential] <Object>]
+    [[-ScriptBlock] <ScriptBlock>]
+    [[-ArgumentList] <Object[]>]
+    [[-InputObject] <Object[]>]
+    [[-Authentication] <String>]
+    [[-ConfigurationName] <String>]
+    [-UseSSL]
+    [-Raw]
+    [[-RequiredPSVersion] <Version>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Invoke-Command2 -ComputerName sql2014 -Credential $Credential -ScriptBlock { dir }
+
+

Executes the scriptblock '' on the computer sql2014 using the credentials stored in $Credential.
+If $Credential is null, no harm done.

+

Optional Parameters

+
-ComputerName
+

Default: $env:COMPUTERNAME +The computer to invoke the scriptblock on.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value$env:COMPUTERNAME
+
-Credential
+

The credentials to use. +Can accept $null on older PowerShell versions, since it expects type object, not PSCredential

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ScriptBlock
+

The code to run on the targeted system

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ArgumentList
+

Any arguments to pass to the scriptblock being run

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-InputObject
+

Object that could be used in the ScriptBlock as $Input. +NOTE: +The object will be de-serialized once passed through the remote pipeline. +Some objects (like hashtables) do not support de-serialization.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinetrue (ByValue)
Default Value
+
-Authentication
+

Choose an authentication to use for the connection

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueDefault
Accepted ValuesDefault,Basic,Negotiate,NegotiateWithImplicitCredential,Credssp,Digest,Kerberos
+
-ConfigurationName
+

Name of the remote PSSessionConfiguration to use. +Should be registered already using Register-PSSessionConfiguration or internal Register-RemoteSessionConfiguration.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-UseSSL
+

Enables SSL

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value(Get-DbatoolsConfigValue -FullName 'PSRemoting.PsSession.UseSSL' -Fallback $false)
+
-Raw
+

Passes through the raw return data, rather than prettifying stuff.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-RequiredPSVersion
+

Verifies that remote Powershell version is meeting specified requirements.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Invoke-Command2 on GitHub. +
+Want to see the Bill Of Health for this command? Check out Invoke-Command2.

+ +
+
+
+
+ + + diff --git a/Invoke-CommandWithFallback.html b/Invoke-CommandWithFallback.html new file mode 100644 index 00000000..ec72e22d --- /dev/null +++ b/Invoke-CommandWithFallback.html @@ -0,0 +1,714 @@ + + + + + + + dbatools docs | Invoke-CommandWithFallback + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Invoke-CommandWithFallback

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Invoke-CommandWithFallback [-ComputerName ] [-Credential ] [-ScriptBlock ] [-ArgumentList <Object[]>] [-InputObject <Object[]>] [-Authentication ] [-RequiredPSVersion ] -Raw []

+

Description

+

Syntax

+
Invoke-CommandWithFallbacksyntaxItem----------{@{name=
+
+Invoke-CommandWithFallback; CommonParameters=True; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-ArgumentList
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Authentication
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
Accepted ValuesDefault,Basic,Negotiate,NegotiateWithImplicitCredential,Credssp,Digest,Kerberos
+
-ComputerName
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Credential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-InputObject
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinetrue (ByValue)
Default Value
+
-Raw
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-RequiredPSVersion
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ScriptBlock
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Invoke-CommandWithFallback on GitHub. +
+Want to see the Bill Of Health for this command? Check out Invoke-CommandWithFallback.

+ + + + + + + + diff --git a/Invoke-Create.html b/Invoke-Create.html new file mode 100644 index 00000000..c5be8e2f --- /dev/null +++ b/Invoke-Create.html @@ -0,0 +1,570 @@ + + + + + + + dbatools docs | Invoke-Create + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Invoke-Create

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Invoke-Create [-Object ] -WhatIf -Confirm []

+

Description

+

Syntax

+
Invoke-CreatesyntaxItem----------{@{name=
+
+Invoke-Create; CommonParameters=True; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-Confirm
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliascf
RequiredFalse
Pipelinefalse
Default Value
+
-Object
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-WhatIf
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliaswi
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Invoke-Create on GitHub. +
+Want to see the Bill Of Health for this command? Check out Invoke-Create.

+ + + + + + + + diff --git a/Invoke-DbMirrorValidation.html b/Invoke-DbMirrorValidation.html new file mode 100644 index 00000000..17a5abf2 --- /dev/null +++ b/Invoke-DbMirrorValidation.html @@ -0,0 +1,798 @@ + + + + + + + dbatools docs | Invoke-DbMirrorValidation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Invoke-DbMirrorValidation

+ + + + + + + + + + + + + + + + + +
AuthorChrissy LeMaire (@cl), netnerds.net
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Validates if a mirror is ready

+

Description

+

Validates if a mirror is ready

+

Thanks to https://github.com/mmessano/PowerShell/blob/master/SQL-ConfigureDatabaseMirroring.ps1

+

Syntax

+
Invoke-DbMirrorValidation
+    [[-Primary] <DbaInstanceParameter>]
+    [[-PrimarySqlCredential] <PSCredential>]
+    [-Mirror] <DbaInstanceParameter[]>
+    [[-MirrorSqlCredential] <PSCredential>]
+    [[-Witness] <DbaInstanceParameter>]
+    [[-WitnessSqlCredential] <PSCredential>]
+    [[-Database] <String[]>]
+    [[-SharedPath] <String>]
+    [[-InputObject] <Database[]>]
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> $params = @{
+
+
    Primary = 'sql2017a'<br>
+    Mirror = 'sql2017b'<br>
+    MirrorSqlCredential = 'sqladmin'<br>
+    Witness = 'sql2019'<br>
+    Database = 'onthewall'<br>
+    SharedPath = '\\nas\sql\share'<br>
+}<br>
+
+
PS C:\> Invoke-DbMirrorValidation @params
+
+

Do things

+

Required Parameters

+
-Mirror
+

SQL Server name or SMO object representing the mirror SQL Server.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-Primary
+

SQL Server name or SMO object representing the primary SQL Server.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-PrimarySqlCredential
+

Login to the primary instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-MirrorSqlCredential
+

Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Witness
+

SQL Server name or SMO object representing the witness SQL Server.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-WitnessSqlCredential
+

Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Database
+

The database or databases to mirror

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-SharedPath
+

The network share where the backups will be

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-InputObject
+

Enables piping from Get-DbaDatabase

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinetrue (ByValue)
Default Value
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Invoke-DbMirrorValidation on GitHub. +
+Want to see the Bill Of Health for this command? Check out Invoke-DbMirrorValidation.

+ +
+
+
+
+ + + diff --git a/Invoke-DbaAdvancedInstall.html b/Invoke-DbaAdvancedInstall.html index e72bf11e..acace0b7 100644 Binary files a/Invoke-DbaAdvancedInstall.html and b/Invoke-DbaAdvancedInstall.html differ diff --git a/Invoke-DbaAdvancedRestore.html b/Invoke-DbaAdvancedRestore.html index 48c375ab..a38dfe84 100644 Binary files a/Invoke-DbaAdvancedRestore.html and b/Invoke-DbaAdvancedRestore.html differ diff --git a/Invoke-DbaAdvancedUpdate.html b/Invoke-DbaAdvancedUpdate.html index 7d7b60b4..b1881454 100644 Binary files a/Invoke-DbaAdvancedUpdate.html and b/Invoke-DbaAdvancedUpdate.html differ diff --git a/Invoke-DbaAgFailover.html b/Invoke-DbaAgFailover.html index e2ff47e9..06c8d655 100644 Binary files a/Invoke-DbaAgFailover.html and b/Invoke-DbaAgFailover.html differ diff --git a/Invoke-DbaAsync.html b/Invoke-DbaAsync.html new file mode 100644 index 00000000..4d57a89a --- /dev/null +++ b/Invoke-DbaAsync.html @@ -0,0 +1,784 @@ + + + + + + + dbatools docs | Invoke-DbaAsync + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Invoke-DbaAsync

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Runs a T-SQL script.

+

Description

+

Runs a T-SQL script. It's a stripped down version of https://github.com/dataplat/Invoke-SqlCmd2 and adapted to use dbatools' facilities. +If you're looking for a public usable function, see Invoke-DbaQuery

+

Syntax

+
Invoke-DbaAsync
+    [-SQLConnection <ServerConnection>] -Query <String>
+    [-As <String>]
+    [-SqlParameter <PSObject[]>]
+    [-CommandType {Text | StoredProcedure | TableDirect}]
+    [-AppendServerInstance]
+    [-QueryTimeout <Int32>]
+    [-MessagesToOutput]
+    [-NoExec]
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-Query
+

Specifies one or more queries to be run. The queries can be Transact-SQL, XQuery statements, or sqlcmd commands. Multiple queries in a single batch may be separated by a semicolon. +Do not specify the sqlcmd GO separator (or, use the ParseGo parameter). Escape any double quotation marks included in the string. +Consider using bracketed identifiers such as [MyTable] instead of quoted identifiers such as "MyTable".

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-SQLConnection
+

Specifies an existing SQLConnection object to use in connecting to SQL Server.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
AliasConnection,Conn
RequiredFalse
Pipelinefalse
Default Value
+
-As
+

Specifies output type. Valid options for this parameter are 'DataSet', 'DataTable', 'DataRow', 'PSObject', 'PSObjectArray', and 'SingleValue' +PSObject and PSObjectArray output introduces overhead but adds flexibility for working with results: http://powershell.org/wp/forums/topic/dealing-with-dbnull/

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueDataRow
Accepted ValuesDataSet,DataTable,DataRow,PSObject,PSObjectArray,SingleValue
+
-SqlParameter
+

Specifies a hashtable of parameters or output from New-DbaSqlParameter for parameterized SQL queries. http://blog.codinghorror.com/give-me-parameterized-sql-or-give-me-death/

+ + + + + + + + + + + + + + + + + + + + + + + + + +
AliasSqlParameters
RequiredFalse
Pipelinefalse
Default Value
+
-CommandType
+

Specifies the type of command represented by the query string. Default is Text

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueText
+
-AppendServerInstance
+

If this switch is enabled, the SQL Server instance will be appended to PSObject and DataRow output.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-QueryTimeout
+

Specifies the number of seconds before the queries time out.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value0
+
-MessagesToOutput
+

Use this switch to have on the output stream messages too (e.g. PRINT statements). Output will hold the resultset too. See examples for detail

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-NoExec
+

Use this switch to prepend SET NOEXEC ON and append SET NOEXEC OFF to each statement

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-EnableException
+

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Invoke-DbaAsync on GitHub. +
+Want to see the Bill Of Health for this command? Check out Invoke-DbaAsync.

+ +
+
+
+
+ + + diff --git a/Invoke-DbaBalanceDataFiles.html b/Invoke-DbaBalanceDataFiles.html index d4bc944a..49d076fc 100644 Binary files a/Invoke-DbaBalanceDataFiles.html and b/Invoke-DbaBalanceDataFiles.html differ diff --git a/Invoke-DbaCycleErrorLog.html b/Invoke-DbaCycleErrorLog.html index 9733c1c9..c5ebdce5 100644 Binary files a/Invoke-DbaCycleErrorLog.html and b/Invoke-DbaCycleErrorLog.html differ diff --git a/Invoke-DbaDbClone.html b/Invoke-DbaDbClone.html index e4a08979..64dc1697 100644 Binary files a/Invoke-DbaDbClone.html and b/Invoke-DbaDbClone.html differ diff --git a/Invoke-DbaDbCorruption.html b/Invoke-DbaDbCorruption.html new file mode 100644 index 00000000..8b1a4a8b --- /dev/null +++ b/Invoke-DbaDbCorruption.html @@ -0,0 +1,707 @@ + + + + + + + dbatools docs | Invoke-DbaDbCorruption + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Invoke-DbaDbCorruption

+ + + + + + + + + + + + + + + + + +
AuthorConstantine Kokkinos (@mobileck https://constantinekokkinos.com)
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Utilizes the DBCC WRITEPAGE functionality to corrupt a specific database table for testing. In no uncertain terms, this is a non-production command. +This will absolutely break your databases and that is its only purpose. +Using DBCC WritePage will definitely void any support options for your database.

+

Description

+

This command can be used to verify your tests for corruption are successful, and to demo various scenarios for corrupting page data. +This command will take an instance and database (and optionally a table) and set the database to single user mode, corrupt either the specified table or the first table it finds, and returns it to multi-user.

+

Syntax

+
Invoke-DbaDbCorruption
+    [-SqlInstance] <DbaInstanceParameter>
+    [[-SqlCredential] <PSCredential>]
+    [-Database] <String>
+    [[-Table] <String>]
+    [-EnableException]
+    [-WhatIf]
+    [-Confirm]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Invoke-DbaDbCorruption -SqlInstance sql2016 -Database containeddb
+Prompts for confirmation then selects the first table in database containeddb and corrupts it (by putting database into single user mode, writing to garbage to its first non-iam page, and returning
+it to multi-user.)

+
Example: 2
+

PS > Invoke-DbaDbCorruption -SqlInstance sql2016 -Database containeddb -Table Customers -Confirm:$false
+Does not prompt and immediately corrupts table customers in database containeddb on the sql2016 instance (by putting database into single user mode, writing to garbage to its first non-iam page, and
+returning it to multi-user.)

+

Required Parameters

+
-SqlInstance
+

The SQL Server instance holding the databases to be removed.You must have sysadmin access and Server version must be SQL Server version 2000 or higher.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinetrue (ByValue)
Default Value
+
-Database
+

The single database you would like to corrupt, this command does not support multiple databases (on purpose.)

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-SqlCredential
+

Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Table
+

The specific table you want corrupted, if you do not choose one, the first user table (alphabetically) will be chosen for corruption.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-WhatIf
+

If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliaswi
RequiredFalse
Pipelinefalse
Default Value
+
-Confirm
+

If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliascf
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Invoke-DbaDbCorruption on GitHub. +
+Want to see the Bill Of Health for this command? Check out Invoke-DbaDbCorruption.

+ +
+
+
+
+ + + diff --git a/Invoke-DbaDbDataGenerator.html b/Invoke-DbaDbDataGenerator.html index f6b3ca83..c821508c 100644 Binary files a/Invoke-DbaDbDataGenerator.html and b/Invoke-DbaDbDataGenerator.html differ diff --git a/Invoke-DbaDbDataMasking.html b/Invoke-DbaDbDataMasking.html index a4f8f3a5..7fac948d 100644 Binary files a/Invoke-DbaDbDataMasking.html and b/Invoke-DbaDbDataMasking.html differ diff --git a/Invoke-DbaDbDbccCheckConstraint.html b/Invoke-DbaDbDbccCheckConstraint.html index e8133d3e..168a3cbd 100644 Binary files a/Invoke-DbaDbDbccCheckConstraint.html and b/Invoke-DbaDbDbccCheckConstraint.html differ diff --git a/Invoke-DbaDbDbccCleanTable.html b/Invoke-DbaDbDbccCleanTable.html index ede1d5e2..2d296bd6 100644 Binary files a/Invoke-DbaDbDbccCleanTable.html and b/Invoke-DbaDbDbccCleanTable.html differ diff --git a/Invoke-DbaDbDbccUpdateUsage.html b/Invoke-DbaDbDbccUpdateUsage.html index 0235fd81..037a3cc2 100644 Binary files a/Invoke-DbaDbDbccUpdateUsage.html and b/Invoke-DbaDbDbccUpdateUsage.html differ diff --git a/Invoke-DbaDbDecryptObject.html b/Invoke-DbaDbDecryptObject.html index add4a432..2b9123f2 100644 Binary files a/Invoke-DbaDbDecryptObject.html and b/Invoke-DbaDbDecryptObject.html differ diff --git a/Invoke-DbaDbLogShipRecovery.html b/Invoke-DbaDbLogShipRecovery.html index 9f3887d5..51f553ef 100644 Binary files a/Invoke-DbaDbLogShipRecovery.html and b/Invoke-DbaDbLogShipRecovery.html differ diff --git a/Invoke-DbaDbLogShipping.html b/Invoke-DbaDbLogShipping.html index 527f1065..dca17b18 100644 Binary files a/Invoke-DbaDbLogShipping.html and b/Invoke-DbaDbLogShipping.html differ diff --git a/Invoke-DbaDbMirrorFailover.html b/Invoke-DbaDbMirrorFailover.html index f9e419b6..4772fdcd 100644 Binary files a/Invoke-DbaDbMirrorFailover.html and b/Invoke-DbaDbMirrorFailover.html differ diff --git a/Invoke-DbaDbMirroring.html b/Invoke-DbaDbMirroring.html index aaec9864..dbed2346 100644 Binary files a/Invoke-DbaDbMirroring.html and b/Invoke-DbaDbMirroring.html differ diff --git a/Invoke-DbaDbPiiScan.html b/Invoke-DbaDbPiiScan.html index 62f59b5b..d6f6aeca 100644 Binary files a/Invoke-DbaDbPiiScan.html and b/Invoke-DbaDbPiiScan.html differ diff --git a/Invoke-DbaDbShrink.html b/Invoke-DbaDbShrink.html index 912fc6e8..44caf8c8 100644 Binary files a/Invoke-DbaDbShrink.html and b/Invoke-DbaDbShrink.html differ diff --git a/Invoke-DbaDbTransfer.html b/Invoke-DbaDbTransfer.html index 86e9fa37..f2b79b0c 100644 Binary files a/Invoke-DbaDbTransfer.html and b/Invoke-DbaDbTransfer.html differ diff --git a/Invoke-DbaDbUpgrade.html b/Invoke-DbaDbUpgrade.html index 5b230fcb..a208a9ca 100644 Binary files a/Invoke-DbaDbUpgrade.html and b/Invoke-DbaDbUpgrade.html differ diff --git a/Invoke-DbaDbccDropCleanBuffer.html b/Invoke-DbaDbccDropCleanBuffer.html index 55e9e323..cfee124f 100644 Binary files a/Invoke-DbaDbccDropCleanBuffer.html and b/Invoke-DbaDbccDropCleanBuffer.html differ diff --git a/Invoke-DbaDbccFreeCache.html b/Invoke-DbaDbccFreeCache.html index b1ad9040..2682159c 100644 Binary files a/Invoke-DbaDbccFreeCache.html and b/Invoke-DbaDbccFreeCache.html differ diff --git a/Invoke-DbaDiagnosticQuery.html b/Invoke-DbaDiagnosticQuery.html index cb5173e1..0edfb4a5 100644 Binary files a/Invoke-DbaDiagnosticQuery.html and b/Invoke-DbaDiagnosticQuery.html differ diff --git a/Invoke-DbaDiagnosticQueryScriptParser.html b/Invoke-DbaDiagnosticQueryScriptParser.html new file mode 100644 index 00000000..869a316d --- /dev/null +++ b/Invoke-DbaDiagnosticQueryScriptParser.html @@ -0,0 +1,599 @@ + + + + + + + dbatools docs | Invoke-DbaDiagnosticQueryScriptParser + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Invoke-DbaDiagnosticQueryScriptParser

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Invoke-DbaDiagnosticQueryScriptParser -filename -ExcludeQueryTextColumn -ExcludePlanColumn -NoColumnParsing []

+

Description

+

Syntax

+
Invoke-DbaDiagnosticQueryScriptParsersyntaxItem----------{@{name=
+
+Invoke-DbaDiagnosticQueryScriptParser; CommonParameters=True; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-filename
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-ExcludePlanColumn
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ExcludeQueryTextColumn
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-NoColumnParsing
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Invoke-DbaDiagnosticQueryScriptParser on GitHub. +
+Want to see the Bill Of Health for this command? Check out Invoke-DbaDiagnosticQueryScriptParser.

+ +
+
+
+
+ + + diff --git a/Invoke-DbaPfRelog.html b/Invoke-DbaPfRelog.html index 211e9ad8..18613c92 100644 Binary files a/Invoke-DbaPfRelog.html and b/Invoke-DbaPfRelog.html differ diff --git a/Invoke-DbaQuery.html b/Invoke-DbaQuery.html index d54d550f..639b6c24 100644 Binary files a/Invoke-DbaQuery.html and b/Invoke-DbaQuery.html differ diff --git a/Invoke-DbaWhoIsActive.html b/Invoke-DbaWhoIsActive.html index a00b6031..83775ba3 100644 Binary files a/Invoke-DbaWhoIsActive.html and b/Invoke-DbaWhoIsActive.html differ diff --git a/Invoke-DbaXEReplay.html b/Invoke-DbaXEReplay.html index 3e1e223d..5cec7169 100644 Binary files a/Invoke-DbaXEReplay.html and b/Invoke-DbaXEReplay.html differ diff --git a/Invoke-DbatoolsFormatter.html b/Invoke-DbatoolsFormatter.html index 49f2bf15..f7286957 100644 Binary files a/Invoke-DbatoolsFormatter.html and b/Invoke-DbatoolsFormatter.html differ diff --git a/Invoke-DbatoolsRenameHelper.html b/Invoke-DbatoolsRenameHelper.html index 7c5a1379..ea536368 100644 Binary files a/Invoke-DbatoolsRenameHelper.html and b/Invoke-DbatoolsRenameHelper.html differ diff --git a/Invoke-ManagedComputerCommand.html b/Invoke-ManagedComputerCommand.html new file mode 100644 index 00000000..4573798a --- /dev/null +++ b/Invoke-ManagedComputerCommand.html @@ -0,0 +1,636 @@ + + + + + + + dbatools docs | Invoke-ManagedComputerCommand + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Invoke-ManagedComputerCommand

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Runs wmi commands against a target system.

+

Description

+

Runs wmi commands against a target system. +Either directly or over PowerShell remoting.

+

Syntax

+
Invoke-ManagedComputerCommand
+    [-ComputerName] <DbaInstanceParameter>
+    [[-Credential] <PSCredential>]
+    [-ScriptBlock] <ScriptBlock>
+    [[-ArgumentList] <Object[]>]
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-ComputerName
+

The target to run against. Must be resolvable.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
AliasServer
RequiredTrue
Pipelinefalse
Default Value
+
-ScriptBlock
+

The scriptblock to execute. +Use $wmi to access the smo wmi object. +Must not include a param block!

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-Credential
+

Credentials to use when using PowerShell remoting.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ArgumentList
+

The arguments to pass to your scriptblock. +Access them within the scriptblock using the automatic variable $args

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-EnableException
+

Left in for legacy reasons. This command will throw no matter what

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Invoke-ManagedComputerCommand on GitHub. +
+Want to see the Bill Of Health for this command? Check out Invoke-ManagedComputerCommand.

+ +
+
+
+
+ + + diff --git a/Invoke-Parallel.html b/Invoke-Parallel.html new file mode 100644 index 00000000..727a00ef --- /dev/null +++ b/Invoke-Parallel.html @@ -0,0 +1,1092 @@ + + + + + + + dbatools docs | Invoke-Parallel + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Invoke-Parallel

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Function to control parallel processing using runspaces

+

Description

+

Function to control parallel processing using runspaces

+
Note that each runspace will not have access to variables and commands loaded in your session or in other runspaces by default.
+This behaviour can be changed with parameters.
+
+

Syntax

+
Invoke-Parallel
+    [-ScriptBlock <ScriptBlock>] -InputObject <PSObject>
+    [-ObjectName <String>]
+    [-Activity <String>]
+    [-Status <String>]
+    [-Parameter <PSObject>]
+    [-ImportVariables]
+    [-ImportModules]
+    [-ImportFunctions]
+    [-Throttle <Int32>]
+    [-SleepTimer <Int32>]
+    [-RunspaceTimeout <Int32>]
+    [-NoCloseOnTimeout]
+    [-MaxQueue <Int32>]
+    [-AppendLog]
+    [-LogFile <String>]
+    [-Quiet]
+    [<CommonParameters>]
+
+Invoke-Parallel
+    [-ScriptFile <Object>] -InputObject <PSObject>
+    [-ObjectName <String>]
+    [-Activity <String>]
+    [-Status <String>]
+    [-Parameter <PSObject>]
+    [-ImportVariables]
+    [-ImportModules]
+    [-ImportFunctions]
+    [-Throttle <Int32>]
+    [-SleepTimer <Int32>]
+    [-RunspaceTimeout <Int32>]
+    [-NoCloseOnTimeout]
+    [-MaxQueue <Int32>]
+    [-AppendLog]
+    [-LogFile <String>]
+    [-Quiet]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Each example uses Test-ForPacs.ps1 which includes the following code:
+param($computer)
+if(test-connection $computer -count 1 -quiet -BufferSize 16){
+$object = [pscustomobject] @{
+Computer=$computer;
+Available=1;
+Kodak=$(
+if((test-path "\\(computer\c\)\users\public\desktop\Kodak Direct View Pacs.url") -or (test-path "\\(computer\c\)\documents and settings\all users\desktop\Kodak Direct View Pacs.url")
+){"1"}else{"0"}
+)
+}
+}
+else{
+$object = [pscustomobject] @{
+Computer=$computer;
+Available=0;
+Kodak="NA"
+}
+}
+$object

+
Example: 2
+

PS > Invoke-Parallel -scriptfile C:\public\Test-ForPacs.ps1 -inputobject $(get-content C:\pcs.txt) -runspaceTimeout 10 -throttle 10
+Pulls list of PCs from C:\pcs.txt,
+Runs Test-ForPacs against each
+If any query takes longer than 10 seconds, it is disposed
+Only run 10 threads at a time

+
Example: 3
+

PS > Invoke-Parallel -scriptfile C:\public\Test-ForPacs.ps1 -inputobject c-is-ts-91, c-is-ts-95
+Runs against c-is-ts-91, c-is-ts-95 (-computername)
+Runs Test-ForPacs against each

+
Example: 4
+

PS > $stuff = [pscustomobject] @{
+ContentFile = "windows\system32\drivers\etc\hosts"
+Logfile = "C:\temp\log.txt"
+}
+$computers | Invoke-Parallel -parameter $stuff {
+\(contentFile = join-path "\\$_\c\)" $parameter.contentfile
+Get-Content $contentFile |
+set-content $parameter.logfile
+}
+This example uses the parameter argument. This parameter is a single object. To pass multiple items into the script block, we create a custom object (using a PowerShell v3 language) with properties
+we want to pass in.
+Inside the script block, $parameter is used to reference this parameter object. This example sets a content file, gets content from that file, and sets it to a predefined log file.

+
Example: 5
+

PS > $test = 5
+1..2 | Invoke-Parallel -ImportVariables {$_ * $test}
+Add variables from the current session to the session state. Without -ImportVariables $Test would not be accessible

+
Example: 6
+

PS > $test = 5
+1..2 | Invoke-Parallel {$_ * $Using:test}
+Reference a variable from the current session with the $Using: syntax. Requires PowerShell 3 or later. Note that -ImportVariables parameter is no longer necessary.

+

Required Parameters

+
-InputObject
+

Run script against these specified objects.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
AliasCN,__Server,IPAddress,Server,ComputerName
RequiredTrue
Pipelinetrue (ByValue)
Default Value
+

Optional Parameters

+
-ScriptBlock
+

Scriptblock to run against all computers. +You may use $Using: language in PowerShell 3 and later. +The parameter block is added for you, allowing behaviour similar to foreach-object: +Refer to the input object as $_. +Refer to the parameter parameter as $parameter

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ScriptFile
+

File to run against all input objects. Must include parameter to take in the input object, or use $args. Optionally, include parameter to take in parameter. Example: C:\script.ps1

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ObjectName
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Valueinput objects
+
-Activity
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueRunning Query
+
-Status
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueStarting threads
+
-Parameter
+

This object is passed to every script block. You can use it to pass information to the script block; for example, the path to a logging folder +Reference this object as $parameter if using the scriptblock parameterset.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ImportVariables
+

If specified, get user session variables and add them to the initial session state

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-ImportModules
+

If specified, get loaded modules and pssnapins, add them to the initial session state

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-ImportFunctions
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-Throttle
+

Maximum number of threads to run at a single time.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value20
+
-SleepTimer
+

Milliseconds to sleep after checking for completed runspaces and in a few other spots. I would not recommend dropping below 200 or increasing above 500

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value200
+
-RunspaceTimeout
+

Maximum time in seconds a single thread can run. If execution of your code takes longer than this, it is disposed. Default: 0 (seconds) +WARNING: Using this parameter requires that maxQueue be set to throttle (it will be by default) for accurate timing. Details here: +http://gallery.technet.microsoft.com/Run-Parallel-Parallel-377fd430

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value0
+
-NoCloseOnTimeout
+

Do not dispose of timed out tasks or attempt to close the runspace if threads have timed out. This will prevent the script from hanging in certain situations where threads become non-responsive, at +the expense of leaking memory within the PowerShell host.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-MaxQueue
+

Maximum number of powershell instances to add to runspace pool. If this is higher than $throttle, $timeout will be inaccurate +If this is equal or less than throttle, there will be a performance impact +The default value is $throttle times 3, if $runspaceTimeout is not specified +The default value is $throttle, if $runspaceTimeout is specified

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value0
+
-AppendLog
+

Append to existing log

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-LogFile
+

Path to a file where we can log results, including run time for each thread, whether it completes, completes with errors, or times out.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Quiet
+

Disable progress bar

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Invoke-Parallel on GitHub. +
+Want to see the Bill Of Health for this command? Check out Invoke-Parallel.

+ +
+
+
+
+ + + diff --git a/Invoke-Program.html b/Invoke-Program.html new file mode 100644 index 00000000..8c0abd99 --- /dev/null +++ b/Invoke-Program.html @@ -0,0 +1,833 @@ + + + + + + + dbatools docs | Invoke-Program + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Invoke-Program

+ + + + + + + + + + + + + + + + + +
AuthorKirill Kravtsov (@nvarscar) https://nvarscar.wordpress.com/
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Invokes a remote execution of a file using specific credentials.

+

Description

+

Based on https://github.com/adbertram/PSSqlUpdater +Invokes a remote execution of a file passing credentials over the network to avoid a double-hop issue +and gain privileges necessary to execute any kind of executables.

+

First it tries to initialize a CredSSP connection by configuring both Client and Server to run CredSSP connections.

+

If CredSSP connection fails, it falls back to a less secure PSSessionConfiguration workaround, which registers +a temporary session configuration on a target machine (PS3.0+) and re-creates current PSSession to use remote +configuration by default.

+

Syntax

+
Invoke-Program
+    [-Path] <String>
+    [[-ComputerName] <DbaInstanceParameter>]
+    [[-Credential] <PSCredential>]
+    [[-ArgumentList] <String[]>]
+    [[-Authentication] <String>]
+    [[-ExpandStrings] <Boolean>]
+    [[-WorkingDirectory] <String>]
+    [[-SuccessReturnCode] <UInt32[]>]
+    [-Raw]
+    [-Fallback]
+    [[-EnableException] <Boolean>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Invoke-Program -ComputerName ServerA -Credentials $cred -Path "C:\temp\setup.exe" -ArgumentList '/quiet' -WorkingDirectory 'C:'
+
+

Starts "setup.exe /quiet" on ServerA under provided credentials. C:\ will be set as a working directory.

+
Example: 2
+
PS C:\> Invoke-Program -ComputerName ServerA -Credentials $cred -Authentication Credssp -Path "C:\temp\setup.exe" -Fallback
+
+

Starts "setup.exe" on ServerA under provided credentials. Will use CredSSP as a fisrt attempted protocol and then fallback to the PSSessionConfiguration workaround.

+

Required Parameters

+
-Path
+

Path to the executable

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-ComputerName
+

Remote computer name

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value$env:COMPUTERNAME
+
-Credential
+

Credential object that will be used for authentication

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ArgumentList
+

List of arguments to pass to the executable

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Authentication
+

Choose authentication mechanism to use

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueDefault
Accepted ValuesDefault,Basic,Negotiate,NegotiateWithImplicitCredential,Credssp,Digest,Kerberos
+
-ExpandStrings
+

The strings in ArgumentList and WorkingDirectory will be evaluated remotely on a target machine.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-WorkingDirectory
+

Working directory for the process

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-SuccessReturnCode
+

Return codes that will be acknowledged as successful execution. Defaults to 0 (success), 3010 (restart required)

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value@(0, 3010)
+
-Raw
+

Return plain stdout without any additional information

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-Fallback
+

When credentials are specified, it is possible that the chosen protocol would fail to connect with them. +Fallback will use PSSessionConfiguration to create a session configuration on a remote machine that uses +provided set of credentials by default. +Not a default option since it transfers credentials over a potentially unsecure network.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value$EnableException
+

 

+

Want to see the source code for this command? Check out Invoke-Program on GitHub. +
+Want to see the Bill Of Health for this command? Check out Invoke-Program.

+ +
+
+
+
+ + + diff --git a/Invoke-SmoCheck.html b/Invoke-SmoCheck.html new file mode 100644 index 00000000..351045ec --- /dev/null +++ b/Invoke-SmoCheck.html @@ -0,0 +1,514 @@ + + + + + + + dbatools docs | Invoke-SmoCheck + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Invoke-SmoCheck

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Checks for PowerShell SMO version vs SQL Server's SMO version.

+

Description

+

Syntax

+
Invoke-SmoCheck
+    [-SqlInstance] <Object>
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-SqlInstance
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Invoke-SmoCheck on GitHub. +
+Want to see the Bill Of Health for this command? Check out Invoke-SmoCheck.

+ +
+
+
+
+ + + diff --git a/Invoke-SteppablePipeline.html b/Invoke-SteppablePipeline.html new file mode 100644 index 00000000..eee63cb4 --- /dev/null +++ b/Invoke-SteppablePipeline.html @@ -0,0 +1,550 @@ + + + + + + + dbatools docs | Invoke-SteppablePipeline + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Invoke-SteppablePipeline

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Allows using steppable pipelines on the pipeline.

+

Description

+

Allows using steppable pipelines on the pipeline.

+

Syntax

+
Invoke-SteppablePipeline
+    [[-InputObject] <Object>]
+    [-Pipeline] <Object>
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Get-ChildItem | Invoke-SteppablePipeline -Pipeline $steppablePipeline
+
+

Processes the object returned by Get-ChildItem in the pipeline defined

+

Required Parameters

+
-Pipeline
+

The pipeline to execute

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-InputObject
+

The object(s) to process +Should only receive input from the pipeline!

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinetrue (ByValue)
Default Value
+

 

+

Want to see the source code for this command? Check out Invoke-SteppablePipeline on GitHub. +
+Want to see the Bill Of Health for this command? Check out Invoke-SteppablePipeline.

+ +
+
+
+
+ + + diff --git a/Invoke-TagCommand.html b/Invoke-TagCommand.html new file mode 100644 index 00000000..15fb313a --- /dev/null +++ b/Invoke-TagCommand.html @@ -0,0 +1,561 @@ + + + + + + + dbatools docs | Invoke-TagCommand + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Invoke-TagCommand

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

An internal command, feel free to ignore.

+

Description

+

Syntax

+
Invoke-TagCommand
+    [[-Tag] <String>]
+    [[-Keyword] <String>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Tag-Command -Tag Restore -Keyword Restore
+Tag-Command -Tag Backup -Keyword Backup
+Tag-Command -Tag Orphan -Keyword Orphan
+Tag-Command -Tag DisasterRecovery -Keyword Attach
+Tag-Command -Tag DisasterRecovery -Keyword Detach
+Tag-Command -Tag Snapshot -Keyword Snapshot
+Tag-Command -Tag Memory -Keyword Memory
+Tag-Command -Tag DisasterRecovery -Keyword Restore
+Tag-Command -Tag DisasterRecovery -Keyword Backup
+Tag-Command -Tag Storage -Keyword disk
+Tag-Command -Tag Storage -Keyword storage
+Tag-Command -Tag Migration -Keyword "Copy-"
+Tag-Command -Tag SPN -Keyword Kerberos
+Tag-Command -Tag SPN -Keyword SPN
+Tag-Command -Tag CIM -Keyword CimSession
+Tag-Command -Tag SQLWMI -Keyword Invoke-ManagedComputerCommand
+Tag-Command -Tag WSMan -Keyword Invoke-Command

+

Optional Parameters

+
-Tag
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Keyword
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Invoke-TagCommand on GitHub. +
+Want to see the Bill Of Health for this command? Check out Invoke-TagCommand.

+ +
+
+
+
+ + + diff --git a/Invoke-TlsRestMethod.html b/Invoke-TlsRestMethod.html new file mode 100644 index 00000000..6fe61895 --- /dev/null +++ b/Invoke-TlsRestMethod.html @@ -0,0 +1,485 @@ + + + + + + + dbatools docs | Invoke-TlsRestMethod + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Invoke-TlsRestMethod

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Invoke-TlsRestMethod

+

Description

+

Syntax

+
Invoke-TlsRestMethodsyntaxItem----------{@{name=
+
+Invoke-TlsRestMethod; CommonParameters=False; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

 

+

Want to see the source code for this command? Check out Invoke-TlsRestMethod on GitHub. +
+Want to see the Bill Of Health for this command? Check out Invoke-TlsRestMethod.

+ +
+
+
+
+ + + diff --git a/Invoke-TlsWebRequest.html b/Invoke-TlsWebRequest.html new file mode 100644 index 00000000..07fb574b --- /dev/null +++ b/Invoke-TlsWebRequest.html @@ -0,0 +1,485 @@ + + + + + + + dbatools docs | Invoke-TlsWebRequest + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Invoke-TlsWebRequest

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Invoke-TlsWebRequest

+

Description

+

Syntax

+
Invoke-TlsWebRequestsyntaxItem----------{@{name=
+
+Invoke-TlsWebRequest; CommonParameters=False; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

 

+

Want to see the source code for this command? Check out Invoke-TlsWebRequest on GitHub. +
+Want to see the Bill Of Health for this command? Check out Invoke-TlsWebRequest.

+ +
+
+
+
+ + + diff --git a/Join-AdminUnc.html b/Join-AdminUnc.html new file mode 100644 index 00000000..cdf44f90 --- /dev/null +++ b/Join-AdminUnc.html @@ -0,0 +1,543 @@ + + + + + + + dbatools docs | Join-AdminUnc + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Join-AdminUnc

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal function. Parses a path to make it an admin UNC.

+

Description

+

Syntax

+
Join-AdminUnc
+    [-servername] <String>
+    [-filepath] <String>
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-servername
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-filepath
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Join-AdminUnc on GitHub. +
+Want to see the Bill Of Health for this command? Check out Join-AdminUnc.

+ +
+
+
+
+ + + diff --git a/Join-DbaAvailabilityGroup.html b/Join-DbaAvailabilityGroup.html index 334d7372..13ce40d5 100644 Binary files a/Join-DbaAvailabilityGroup.html and b/Join-DbaAvailabilityGroup.html differ diff --git a/Join-DbaPath.html b/Join-DbaPath.html index 3f0da0ed..052623b6 100644 Binary files a/Join-DbaPath.html and b/Join-DbaPath.html differ diff --git a/Join-SomePath.html b/Join-SomePath.html new file mode 100644 index 00000000..3556403e --- /dev/null +++ b/Join-SomePath.html @@ -0,0 +1,542 @@ + + + + + + + dbatools docs | Join-SomePath + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Join-SomePath

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Join-SomePath [-Path ] [-ChildPath ] []

+

Description

+

Syntax

+
Join-SomePathsyntaxItem----------{@{name=
+
+Join-SomePath; CommonParameters=True; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-ChildPath
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Path
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Join-SomePath on GitHub. +
+Want to see the Bill Of Health for this command? Check out Join-SomePath.

+ +
+
+
+
+ + + diff --git a/Measure-DbaBackupThroughput.html b/Measure-DbaBackupThroughput.html index 5e243c9a..b0ca7601 100644 Binary files a/Measure-DbaBackupThroughput.html and b/Measure-DbaBackupThroughput.html differ diff --git a/Measure-DbaDbVirtualLogFile.html b/Measure-DbaDbVirtualLogFile.html index 5289611a..2ccf1e96 100644 Binary files a/Measure-DbaDbVirtualLogFile.html and b/Measure-DbaDbVirtualLogFile.html differ diff --git a/Measure-DbaDiskSpaceRequirement.html b/Measure-DbaDiskSpaceRequirement.html index db7109c2..4c7e1c9b 100644 Binary files a/Measure-DbaDiskSpaceRequirement.html and b/Measure-DbaDiskSpaceRequirement.html differ diff --git a/Measure-DbatoolsImport.html b/Measure-DbatoolsImport.html index 126c35b0..fc4aaf51 100644 Binary files a/Measure-DbatoolsImport.html and b/Measure-DbatoolsImport.html differ diff --git a/Mount-DbaDatabase.html b/Mount-DbaDatabase.html index cc10dbed..46dc36a2 100644 Binary files a/Mount-DbaDatabase.html and b/Mount-DbaDatabase.html differ diff --git a/Move-DbaDbFile.html b/Move-DbaDbFile.html index 480986d4..81ba1993 100644 Binary files a/Move-DbaDbFile.html and b/Move-DbaDbFile.html differ diff --git a/Move-DbaRegServer.html b/Move-DbaRegServer.html index 45ba989d..8b45e804 100644 Binary files a/Move-DbaRegServer.html and b/Move-DbaRegServer.html differ diff --git a/Move-DbaRegServerGroup.html b/Move-DbaRegServerGroup.html index 27d85568..7b48f035 100644 Binary files a/Move-DbaRegServerGroup.html and b/Move-DbaRegServerGroup.html differ diff --git a/New-DbaAgentAlertCategory.html b/New-DbaAgentAlertCategory.html index 7981092d..dc85b859 100644 Binary files a/New-DbaAgentAlertCategory.html and b/New-DbaAgentAlertCategory.html differ diff --git a/New-DbaAgentJob.html b/New-DbaAgentJob.html index 871c901a..604eb924 100644 Binary files a/New-DbaAgentJob.html and b/New-DbaAgentJob.html differ diff --git a/New-DbaAgentJobCategory.html b/New-DbaAgentJobCategory.html index 8b81f02a..003189a2 100644 Binary files a/New-DbaAgentJobCategory.html and b/New-DbaAgentJobCategory.html differ diff --git a/New-DbaAgentJobStep.html b/New-DbaAgentJobStep.html index b8d9f9e9..e2d751d4 100644 Binary files a/New-DbaAgentJobStep.html and b/New-DbaAgentJobStep.html differ diff --git a/New-DbaAgentOperator.html b/New-DbaAgentOperator.html index 84e8cfb8..246b1d32 100644 Binary files a/New-DbaAgentOperator.html and b/New-DbaAgentOperator.html differ diff --git a/New-DbaAgentProxy.html b/New-DbaAgentProxy.html index 18077ee1..25e4ad07 100644 Binary files a/New-DbaAgentProxy.html and b/New-DbaAgentProxy.html differ diff --git a/New-DbaAgentSchedule.html b/New-DbaAgentSchedule.html index 8865c7c8..13c66ed1 100644 Binary files a/New-DbaAgentSchedule.html and b/New-DbaAgentSchedule.html differ diff --git a/New-DbaAvailabilityGroup.html b/New-DbaAvailabilityGroup.html index 9266f4e7..945f9354 100644 Binary files a/New-DbaAvailabilityGroup.html and b/New-DbaAvailabilityGroup.html differ diff --git a/New-DbaAzAccessToken.html b/New-DbaAzAccessToken.html index 9229aaac..f9dec72d 100644 Binary files a/New-DbaAzAccessToken.html and b/New-DbaAzAccessToken.html differ diff --git a/New-DbaClientAlias.html b/New-DbaClientAlias.html index 8e39ad02..4b00f75b 100644 Binary files a/New-DbaClientAlias.html and b/New-DbaClientAlias.html differ diff --git a/New-DbaCmConnection.html b/New-DbaCmConnection.html index 77dda1a3..ea81dfcf 100644 Binary files a/New-DbaCmConnection.html and b/New-DbaCmConnection.html differ diff --git a/New-DbaComputerCertificate.html b/New-DbaComputerCertificate.html index ea1f79cc..e9dc98e7 100644 Binary files a/New-DbaComputerCertificate.html and b/New-DbaComputerCertificate.html differ diff --git a/New-DbaComputerCertificateSigningRequest.html b/New-DbaComputerCertificateSigningRequest.html index 73c9f7fa..27068c9e 100644 Binary files a/New-DbaComputerCertificateSigningRequest.html and b/New-DbaComputerCertificateSigningRequest.html differ diff --git a/New-DbaConnectionString.html b/New-DbaConnectionString.html index 9a3eead1..7a054c03 100644 Binary files a/New-DbaConnectionString.html and b/New-DbaConnectionString.html differ diff --git a/New-DbaConnectionStringBuilder.html b/New-DbaConnectionStringBuilder.html index f420f7ca..8c6144b7 100644 Binary files a/New-DbaConnectionStringBuilder.html and b/New-DbaConnectionStringBuilder.html differ diff --git a/New-DbaCredential.html b/New-DbaCredential.html index 6c48e420..9101969a 100644 Binary files a/New-DbaCredential.html and b/New-DbaCredential.html differ diff --git a/New-DbaCustomError.html b/New-DbaCustomError.html index 5de8f8df..65d6864c 100644 Binary files a/New-DbaCustomError.html and b/New-DbaCustomError.html differ diff --git a/New-DbaDacOption.html b/New-DbaDacOption.html index 9d23074a..0dceff85 100644 Binary files a/New-DbaDacOption.html and b/New-DbaDacOption.html differ diff --git a/New-DbaDacProfile.html b/New-DbaDacProfile.html index 65e178af..9a3ac299 100644 Binary files a/New-DbaDacProfile.html and b/New-DbaDacProfile.html differ diff --git a/New-DbaDatabase.html b/New-DbaDatabase.html index d7a55aec..0acd8923 100644 Binary files a/New-DbaDatabase.html and b/New-DbaDatabase.html differ diff --git a/New-DbaDbAsymmetricKey.html b/New-DbaDbAsymmetricKey.html index d92d4610..edb2b864 100644 Binary files a/New-DbaDbAsymmetricKey.html and b/New-DbaDbAsymmetricKey.html differ diff --git a/New-DbaDbCertificate.html b/New-DbaDbCertificate.html index da93a2bc..c9257f02 100644 Binary files a/New-DbaDbCertificate.html and b/New-DbaDbCertificate.html differ diff --git a/New-DbaDbDataGeneratorConfig.html b/New-DbaDbDataGeneratorConfig.html index 0d3b84a9..25cdf941 100644 Binary files a/New-DbaDbDataGeneratorConfig.html and b/New-DbaDbDataGeneratorConfig.html differ diff --git a/New-DbaDbEncryptionKey.html b/New-DbaDbEncryptionKey.html index 5a68a8c8..18987057 100644 Binary files a/New-DbaDbEncryptionKey.html and b/New-DbaDbEncryptionKey.html differ diff --git a/New-DbaDbFileGroup.html b/New-DbaDbFileGroup.html index a8ca03ac..ab27b746 100644 Binary files a/New-DbaDbFileGroup.html and b/New-DbaDbFileGroup.html differ diff --git a/New-DbaDbMailAccount.html b/New-DbaDbMailAccount.html index 5c1fe695..efd42498 100644 Binary files a/New-DbaDbMailAccount.html and b/New-DbaDbMailAccount.html differ diff --git a/New-DbaDbMailProfile.html b/New-DbaDbMailProfile.html index a3c6496e..d1aa8211 100644 Binary files a/New-DbaDbMailProfile.html and b/New-DbaDbMailProfile.html differ diff --git a/New-DbaDbMaskingConfig.html b/New-DbaDbMaskingConfig.html index a0baa6bf..2c344c6c 100644 Binary files a/New-DbaDbMaskingConfig.html and b/New-DbaDbMaskingConfig.html differ diff --git a/New-DbaDbMasterKey.html b/New-DbaDbMasterKey.html index b888979d..75783fae 100644 Binary files a/New-DbaDbMasterKey.html and b/New-DbaDbMasterKey.html differ diff --git a/New-DbaDbRole.html b/New-DbaDbRole.html index cc9d2e54..3375aeca 100644 Binary files a/New-DbaDbRole.html and b/New-DbaDbRole.html differ diff --git a/New-DbaDbSchema.html b/New-DbaDbSchema.html index a2cca561..24baaa64 100644 Binary files a/New-DbaDbSchema.html and b/New-DbaDbSchema.html differ diff --git a/New-DbaDbSequence.html b/New-DbaDbSequence.html index f1e26cce..32f5cdc3 100644 Binary files a/New-DbaDbSequence.html and b/New-DbaDbSequence.html differ diff --git a/New-DbaDbSnapshot.html b/New-DbaDbSnapshot.html index 28277ce6..db82393a 100644 Binary files a/New-DbaDbSnapshot.html and b/New-DbaDbSnapshot.html differ diff --git a/New-DbaDbSynonym.html b/New-DbaDbSynonym.html index ded7bf2d..e604ed12 100644 Binary files a/New-DbaDbSynonym.html and b/New-DbaDbSynonym.html differ diff --git a/New-DbaDbTable.html b/New-DbaDbTable.html index fe317e3b..b00da7f7 100644 Binary files a/New-DbaDbTable.html and b/New-DbaDbTable.html differ diff --git a/New-DbaDbTransfer.html b/New-DbaDbTransfer.html index b31e27f9..d453aede 100644 Binary files a/New-DbaDbTransfer.html and b/New-DbaDbTransfer.html differ diff --git a/New-DbaDbUser.html b/New-DbaDbUser.html index 76bc5480..cd8de693 100644 Binary files a/New-DbaDbUser.html and b/New-DbaDbUser.html differ diff --git a/New-DbaDiagnosticAdsNotebook.html b/New-DbaDiagnosticAdsNotebook.html index b4ae0d1b..6e858d77 100644 Binary files a/New-DbaDiagnosticAdsNotebook.html and b/New-DbaDiagnosticAdsNotebook.html differ diff --git a/New-DbaDirectory.html b/New-DbaDirectory.html index 4f159869..73f5daae 100644 Binary files a/New-DbaDirectory.html and b/New-DbaDirectory.html differ diff --git a/New-DbaEndpoint.html b/New-DbaEndpoint.html index 8cdce788..d2c38d1c 100644 Binary files a/New-DbaEndpoint.html and b/New-DbaEndpoint.html differ diff --git a/New-DbaFirewallRule.html b/New-DbaFirewallRule.html index abfcbb69..69a0cc80 100644 Binary files a/New-DbaFirewallRule.html and b/New-DbaFirewallRule.html differ diff --git a/New-DbaLinkedServer.html b/New-DbaLinkedServer.html new file mode 100644 index 00000000..03fc132b --- /dev/null +++ b/New-DbaLinkedServer.html @@ -0,0 +1,980 @@ + + + + + + + dbatools docs | New-DbaLinkedServer + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

New-DbaLinkedServer

+ + + + + + + + + + + + + + + + + +
AuthorAdam Lancaster https://github.com/lancasteradam
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Creates a new linked server.

+

Description

+

Creates a new linked server. See the Microsoft documentation for sp_addlinkedserver for more details on the parameters.

+

Syntax

+
New-DbaLinkedServer
+    [[-SqlInstance] <DbaInstanceParameter[]>]
+    [[-SqlCredential] <PSCredential>]
+    [[-LinkedServer] <String>]
+    [[-ServerProduct] <String>]
+    [[-Provider] <String>]
+    [[-DataSource] <String>]
+    [[-Location] <String>]
+    [[-ProviderString] <String>]
+    [[-Catalog] <String>]
+    [[-SecurityContext] <String>]
+    [[-SecurityContextRemoteUser] <String>]
+    [[-SecurityContextRemoteUserPassword] <SecureString>]
+    [[-InputObject] <Server[]>]
+    [-EnableException]
+    [-WhatIf]
+    [-Confirm]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> New-DbaLinkedServer -SqlInstance sql01 -LinkedServer linkedServer1 -ServerProduct mssql -Provider sqlncli -DataSource sql02
+
+

Creates a new linked server named linkedServer1 on the sql01 instance. The link is via the SQL Native Client and is connected to the sql02 instance.

+
Example: 2
+
PS C:\> Connect-DbaInstance -SqlInstance sql01 | New-DbaLinkedServer -LinkedServer linkedServer1 -ServerProduct mssql -Provider sqlncli -DataSource sql02
+
+

Creates a new linked server named linkedServer1 on the sql01 instance. The link is via the SQL Native Client and is connected to the sql02 instance. The sql01 instance is passed in via pipeline.

+
Example: 3
+
PS C:\> New-DbaLinkedServer -SqlInstance sql01 -LinkedServer linkedServer1 -ServerProduct mssql -Provider sqlncli -DataSource sql02 -SecurityContext CurrentSecurityContext
+
+

Creates a new linked server named linkedServer1 on the sql01 instance. The link is via the SQL Native Client and is connected to the sql02 instance. Connections with logins that are not explicitly
+mapped to the remote server will use the current login's security context.

+

Optional Parameters

+
-SqlInstance
+

The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function +to be executed against multiple SQL Server instances.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-SqlCredential
+

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential). +Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported. +For MFA support, please use Connect-DbaInstance.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-LinkedServer
+

The name of the linked server.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ServerProduct
+

The product name of the data source.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Provider
+

The unique ID of the provider.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-DataSource
+

The name of the data source.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Location
+

The location of the database.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ProviderString
+

The provider connection string.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Catalog
+

The catalog or default database.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-SecurityContext
+

Specifies the security context option found on the SSMS Security tab of the linked server. This is a separate configuration from the mapping of a local login to a remote login. It specifies the +connection behavior for a login that is not explicitly mapped. 'NoConnection' means that a connection will not be made. 'WithoutSecurityContext' means the connection will be made without using a +security context. 'CurrentSecurityContext' means the connection will be made using the login's current security context. 'SpecifiedSecurityContext' means the specified username and password will be +used. The default value is 'WithoutSecurityContext'. For more details see the Microsoft documentation for sp_addlinkedsrvlogin and also review the SSMS Security tab of the linked server.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueWithoutSecurityContext
Accepted ValuesNoConnection,WithoutSecurityContext,CurrentSecurityContext,SpecifiedSecurityContext
+
-SecurityContextRemoteUser
+

Specifies the remote login name. This param is used when SecurityContext is set to SpecifiedSecurityContext. To map a local login to a remote login use New-DbaLinkedServerLogin.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-SecurityContextRemoteUserPassword
+

Specifies the remote login password. This param is used when SecurityContext is set to SpecifiedSecurityContext. To map a local login to a remote login use New-DbaLinkedServerLogin. NOTE: passwords +are sent to the SQL Server instance in plain text. Check with your security administrator before using this parameter.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-InputObject
+

Allows piping from Connect-DbaInstance.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinetrue (ByValue)
Default Value
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-WhatIf
+

Shows what would happen if the command were to run. No actions are actually performed.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliaswi
RequiredFalse
Pipelinefalse
Default Value
+
-Confirm
+

Prompts you for confirmation before executing any changing operations within the command.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliascf
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out New-DbaLinkedServer on GitHub. +
+Want to see the Bill Of Health for this command? Check out New-DbaLinkedServer.

+ +
+
+
+
+ + + diff --git a/New-DbaLinkedServerLogin.html b/New-DbaLinkedServerLogin.html index 5e9377dd..19b76196 100644 Binary files a/New-DbaLinkedServerLogin.html and b/New-DbaLinkedServerLogin.html differ diff --git a/New-DbaLogShippingPrimaryDatabase.html b/New-DbaLogShippingPrimaryDatabase.html new file mode 100644 index 00000000..41f3afff --- /dev/null +++ b/New-DbaLogShippingPrimaryDatabase.html @@ -0,0 +1,1061 @@ + + + + + + + dbatools docs | New-DbaLogShippingPrimaryDatabase + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

New-DbaLogShippingPrimaryDatabase

+ + + + + + + + + + + + + + + + + +
AuthorSander Stad (@sqlstad, sqlstad.nl)
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

New-DbaLogShippingPrimaryDatabase add the primary database to log shipping

+

Description

+

New-DbaLogShippingPrimaryDatabase will add the primary database to log shipping. +This is executed on the primary server.

+

Syntax

+
New-DbaLogShippingPrimaryDatabase
+    [-SqlInstance] <Object>
+    [[-SqlCredential] <PSCredential>]
+    [-Database] <Object>
+    [-BackupDirectory] <String>
+    [-BackupJob] <String>
+    [-BackupRetention] <Int32>
+    [-BackupShare] <String>
+    [[-BackupThreshold] <Int32>]
+    [-CompressBackup]
+    [[-ThresholdAlert] <Int32>]
+    [[-HistoryRetention] <Int32>]
+    [[-MonitorServer] <String>]
+    [[-MonitorServerSecurityMode] <Object>]
+    [[-MonitorCredential] <PSCredential>]
+    [-ThresholdAlertEnabled]
+    [-EnableException]
+    [-Force]
+    [-WhatIf]
+    [-Confirm]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > New-DbaLogShippingPrimaryDatabase -SqlInstance sql1 -Database DB1 -BackupDirectory D:\data\logshipping -BackupJob LSBackup_DB1 -BackupRetention 4320 -BackupShare "\sql1\logshipping"
+-BackupThreshold 60 -CompressBackup -HistoryRetention 14420 -MonitorServer sql1 -ThresholdAlertEnabled

+

Required Parameters

+
-SqlInstance
+

SQL Server instance. You must have sysadmin access and server version must be SQL Server version 2000 or greater.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-Database
+

Database to set up log shipping for.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-BackupDirectory
+

Is the path to the backup folder on the primary server.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-BackupJob
+

Is the name of the SQL Server Agent job on the primary server that copies the backup into the backup folder.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-BackupRetention
+

Is the length of time, in minutes, to retain the log backup file in the backup directory on the primary server.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value0
+
-BackupShare
+

Is the network path to the backup directory on the primary server.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-SqlCredential
+

Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-BackupThreshold
+

Is the length of time, in minutes, after the last backup before a threshold_alert error is raised. +The default is 60.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value60
+
-CompressBackup
+

Enables the use of backup compression

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-ThresholdAlert
+

Is the length of time, in minutes, when the alert is to be raised when the backup threshold is exceeded. +The default is 14,420.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value14420
+
-HistoryRetention
+

Is the length of time in minutes in which the history will be retained. +The default is 14420.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value14420
+
-MonitorServer
+

Is the name of the monitor server. +The default is the name of the primary server.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-MonitorServerSecurityMode
+

The security mode used to connect to the monitor server. Allowed values are 0, "sqlserver", 1, "windows" +The default is 1 or Windows.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value1
Accepted Values0,sqlserver,1,windows
+
-MonitorCredential
+

Allows you to login to enter a secure credential. +This is only needed in combination with MonitorServerSecurityMode having either a 0 or 'sqlserver' value. +To use: $scred = Get-Credential, then pass $scred object to the -MonitorCredential parameter.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ThresholdAlertEnabled
+

Specifies whether an alert will be raised when backup threshold is exceeded. +The default is 0.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-Force
+

The force parameter will ignore some errors in the parameters and assume defaults. +It will also remove the any present schedules with the same name for the specific job.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-WhatIf
+

Shows what would happen if the command were to run. No actions are actually performed.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliaswi
RequiredFalse
Pipelinefalse
Default Value
+
-Confirm
+

Prompts you for confirmation before executing any changing operations within the command.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliascf
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out New-DbaLogShippingPrimaryDatabase on GitHub. +
+Want to see the Bill Of Health for this command? Check out New-DbaLogShippingPrimaryDatabase.

+ +
+
+
+
+ + + diff --git a/New-DbaLogShippingPrimarySecondary.html b/New-DbaLogShippingPrimarySecondary.html new file mode 100644 index 00000000..d2e4535f --- /dev/null +++ b/New-DbaLogShippingPrimarySecondary.html @@ -0,0 +1,758 @@ + + + + + + + dbatools docs | New-DbaLogShippingPrimarySecondary + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

New-DbaLogShippingPrimarySecondary

+ + + + + + + + + + + + + + + + + +
AuthorSander Stad (@sqlstad, sqlstad.nl)
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

New-DbaLogShippingPrimarySecondary adds an entry for a secondary database.

+

Description

+

New-DbaLogShippingPrimarySecondary adds an entry for a secondary database. +This is executed on the primary server.

+

Syntax

+
New-DbaLogShippingPrimarySecondary
+    [-SqlInstance] <DbaInstanceParameter>
+    [[-SqlCredential] <PSCredential>]
+    [-PrimaryDatabase] <Object>
+    [-SecondaryDatabase] <Object>
+    [-SecondaryServer] <DbaInstanceParameter>
+    [[-SecondarySqlCredential] <PSCredential>]
+    [-EnableException]
+    [-WhatIf]
+    [-Confirm]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > New-DbaLogShippingPrimarySecondary -SqlInstance sql1 -PrimaryDatabase DB1 -SecondaryServer sql2 -SecondaryDatabase DB1_DR

+

Required Parameters

+
-SqlInstance
+

SQL Server instance. You must have sysadmin access and server version must be SQL Server version 2000 or greater.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-PrimaryDatabase
+

Is the name of the database on the primary server.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-SecondaryDatabase
+

Is the name of the secondary database.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-SecondaryServer
+

Is the name of the secondary server.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-SqlCredential
+

Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-SecondarySqlCredential
+

Allows you to login to servers using SQL Logins as opposed to Windows Auth/Integrated/Trusted. To use: +$scred = Get-Credential, then pass $scred object to the -SecondarySqlCredential parameter.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-WhatIf
+

Shows what would happen if the command were to run. No actions are actually performed.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliaswi
RequiredFalse
Pipelinefalse
Default Value
+
-Confirm
+

Prompts you for confirmation before executing any changing operations within the command.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliascf
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out New-DbaLogShippingPrimarySecondary on GitHub. +
+Want to see the Bill Of Health for this command? Check out New-DbaLogShippingPrimarySecondary.

+ +
+
+
+
+ + + diff --git a/New-DbaLogShippingSecondaryDatabase.html b/New-DbaLogShippingSecondaryDatabase.html new file mode 100644 index 00000000..1a8690c8 --- /dev/null +++ b/New-DbaLogShippingSecondaryDatabase.html @@ -0,0 +1,1215 @@ + + + + + + + dbatools docs | New-DbaLogShippingSecondaryDatabase + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

New-DbaLogShippingSecondaryDatabase

+ + + + + + + + + + + + + + + + + +
AuthorSander Stad (@sqlstad, sqlstad.nl)
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

New-DbaLogShippingSecondaryDatabase sets up a secondary databases for log shipping.

+

Description

+

New-DbaLogShippingSecondaryDatabase sets up a secondary databases for log shipping. +This is executed on the secondary server.

+

Syntax

+
New-DbaLogShippingSecondaryDatabase
+    [-SqlInstance] <DbaInstanceParameter>
+    [[-SqlCredential] <PSCredential>]
+    [[-BufferCount] <Int32>]
+    [[-BlockSize] <Int32>]
+    [-DisconnectUsers]
+    [[-HistoryRetention] <Int32>]
+    [[-MaxTransferSize] <Int32>]
+    [-PrimaryServer] <DbaInstanceParameter>
+    [[-PrimarySqlCredential] <PSCredential>]
+    [-PrimaryDatabase] <Object>
+    [[-RestoreAll] <Int32>]
+    [[-RestoreDelay] <Int32>]
+    [[-RestoreMode] <Object>]
+    [-RestoreThreshold] <Int32>
+    [-SecondaryDatabase] <Object>
+    [[-ThresholdAlert] <Int32>]
+    [-ThresholdAlertEnabled]
+    [[-MonitorServer] <String>]
+    [[-MonitorServerSecurityMode] <Object>]
+    [[-MonitorCredential] <PSCredential>]
+    [-EnableException]
+    [-Force]
+    [-WhatIf]
+    [-Confirm]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > New-DbaLogShippingSecondaryDatabase -SqlInstance sql2 -SecondaryDatabase DB1_DR -PrimaryServer sql1 -PrimaryDatabase DB1 -RestoreDelay 0 -RestoreMode standby -DisconnectUsers -RestoreThreshold
+45 -ThresholdAlertEnabled -HistoryRetention 14420

+

Required Parameters

+
-SqlInstance
+

SQL Server instance. You must have sysadmin access and server version must be SQL Server version 2000 or greater.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-PrimaryServer
+

The name of the primary instance of the Microsoft SQL Server Database Engine in the log shipping configuration.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-PrimaryDatabase
+

Is the name of the database on the primary server.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-RestoreThreshold
+

The number of minutes allowed to elapse between restore operations before an alert is generated.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value0
+
-SecondaryDatabase
+

Is the name of the secondary database.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-SqlCredential
+

Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-BufferCount
+

The total number of buffers used by the backup or restore operation. +The default is -1.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value-1
+
-BlockSize
+

The size, in bytes, that is used as the block size for the backup device. +The default is -1.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value-1
+
-DisconnectUsers
+

If set to 1, users are disconnected from the secondary database when a restore operation is performed. +Te default is 0.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-HistoryRetention
+

Is the length of time in minutes in which the history is retained. +The default is 14420.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value14420
+
-MaxTransferSize
+

The size, in bytes, of the maximum input or output request which is issued by SQL Server to the backup device.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value0
+
-PrimarySqlCredential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-RestoreAll
+

If set to 1, the secondary server restores all available transaction log backups when the restore job runs. +The default is 1.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value1
+
-RestoreDelay
+

The amount of time, in minutes, that the secondary server waits before restoring a given backup file. +The default is 0.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value0
+
-RestoreMode
+

The restore mode for the secondary database. The default is 0. +0 = Restore log with NORECOVERY. +1 = Restore log with STANDBY.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value0
Accepted Values0,NoRecovery,1,Standby
+
-ThresholdAlert
+

Is the alert to be raised when the backup threshold is exceeded. +The default is 14420.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value14420
+
-ThresholdAlertEnabled
+

Specifies whether an alert is raised when backup_threshold is exceeded.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-MonitorServer
+

Is the name of the monitor server. +The default is the name of the primary server.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-MonitorServerSecurityMode
+

The security mode used to connect to the monitor server. Allowed values are 0, "sqlserver", 1, "windows" +The default is 1 or Windows.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value1
Accepted Values0,sqlserver,1,windows
+
-MonitorCredential
+

Allows you to login to enter a secure credential. +This is only needed in combination with MonitorServerSecurityMode having either a 0 or 'sqlserver' value. +To use: $scred = Get-Credential, then pass $scred object to the -MonitorCredential parameter.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-Force
+

The force parameter will ignore some errors in the parameters and assume defaults. +It will also remove the any present schedules with the same name for the specific job.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-WhatIf
+

Shows what would happen if the command were to run. No actions are actually performed.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliaswi
RequiredFalse
Pipelinefalse
Default Value
+
-Confirm
+

Prompts you for confirmation before executing any changing operations within the command.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliascf
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out New-DbaLogShippingSecondaryDatabase on GitHub. +
+Want to see the Bill Of Health for this command? Check out New-DbaLogShippingSecondaryDatabase.

+ +
+
+
+
+ + + diff --git a/New-DbaLogShippingSecondaryPrimary.html b/New-DbaLogShippingSecondaryPrimary.html new file mode 100644 index 00000000..b9d9a7d3 --- /dev/null +++ b/New-DbaLogShippingSecondaryPrimary.html @@ -0,0 +1,998 @@ + + + + + + + dbatools docs | New-DbaLogShippingSecondaryPrimary + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

New-DbaLogShippingSecondaryPrimary

+ + + + + + + + + + + + + + + + + +
AuthorSander Stad (@sqlstad, sqlstad.nl)
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

New-DbaLogShippingPrimarySecondary sets up the primary information for the primary database.

+

Description

+

New-DbaLogShippingPrimarySecondary sets up the primary information, adds local and remote monitor links, +and creates copy and restore jobs for the specified primary database. +This is executed on the secondary server.

+

Syntax

+
New-DbaLogShippingSecondaryPrimary
+    [-SqlInstance] <Object>
+    [[-SqlCredential] <PSCredential>]
+    [-BackupSourceDirectory] <String>
+    [[-BackupDestinationDirectory] <String>]
+    [-CopyJob] <String>
+    [[-FileRetentionPeriod] <Int32>]
+    [[-MonitorServer] <String>]
+    [[-MonitorCredential] <PSCredential>]
+    [-MonitorServerSecurityMode] <Object>
+    [[-PrimaryServer] <Object>]
+    [[-PrimarySqlCredential] <PSCredential>]
+    [[-PrimaryDatabase] <Object>]
+    [-RestoreJob] <String>
+    [-EnableException]
+    [-Force]
+    [-WhatIf]
+    [-Confirm]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > New-DbaLogShippingSecondaryPrimary -SqlInstance sql2 -BackupSourceDirectory "\sql1\logshipping\DB1" -BackupDestinationDirectory D:\Data\logshippingdestination\DB1_DR -CopyJob LSCopy_sql2_DB1_DR
+-FileRetentionPeriod 4320 -MonitorServer sql2 -MonitorServerSecurityMode 'Windows' -PrimaryServer sql1 -PrimaryDatabase DB1 -RestoreJob LSRestore_sql2_DB1_DR

+

Required Parameters

+
-SqlInstance
+

SQL Server instance. You must have sysadmin access and server version must be SQL Server version 2000 or greater.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-BackupSourceDirectory
+

The directory where transaction log backup files from the primary server are stored.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-CopyJob
+

The name to use for the SQL Server Agent job being created to copy transaction log backups to the secondary server.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-MonitorServerSecurityMode
+

The security mode used to connect to the monitor server. Allowed values are 0, "sqlserver", 1, "windows" +The default is 1 or Windows.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value1
Accepted Values0,sqlserver,1,windows
+
-RestoreJob
+

Is the name of the SQL Server Agent job on the secondary server that restores the backups to the secondary database.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-SqlCredential
+

Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-BackupDestinationDirectory
+

The directory on the secondary server where backup files are copied to.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-FileRetentionPeriod
+

The length of time, in minutes, that a backup file is retained on the secondary server in the path specified by the BackupDestinationDirectory parameter before being deleted. +The default is 14420.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value14420
+
-MonitorServer
+

Is the name of the monitor server. The default is the secondary server.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-MonitorCredential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-PrimaryServer
+

The name of the primary instance of the Microsoft SQL Server Database Engine in the log shipping configuration.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-PrimarySqlCredential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-PrimaryDatabase
+

Is the name of the database on the primary server.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-Force
+

The force parameter will ignore some errors in the parameters and assume defaults. +It will also remove the any present schedules with the same name for the specific job.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-WhatIf
+

Shows what would happen if the command were to run. No actions are actually performed.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliaswi
RequiredFalse
Pipelinefalse
Default Value
+
-Confirm
+

Prompts you for confirmation before executing any changing operations within the command.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliascf
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out New-DbaLogShippingSecondaryPrimary on GitHub. +
+Want to see the Bill Of Health for this command? Check out New-DbaLogShippingSecondaryPrimary.

+ +
+
+
+
+ + + diff --git a/New-DbaLogin.html b/New-DbaLogin.html index 552d6f18..ab82ff8d 100644 Binary files a/New-DbaLogin.html and b/New-DbaLogin.html differ diff --git a/New-DbaMessageLevelModifier.html b/New-DbaMessageLevelModifier.html new file mode 100644 index 00000000..36406281 --- /dev/null +++ b/New-DbaMessageLevelModifier.html @@ -0,0 +1,771 @@ + + + + + + + dbatools docs | New-DbaMessageLevelModifier + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

New-DbaMessageLevelModifier

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Allows modifying message levels by powerful filters.

+

Description

+

Allows modifying message levels by powerful filters.

+

This is designed to allow a developer to have more control over what is written how during the development process. +It also allows a debug user to fine tune what he is shown.

+

This functionality is NOT designed for default implementation within a module. +Instead, set healthy message levels for your own messages and leave others to tend to their own levels.

+

Note: +Adding too many level modifiers may impact performance, use with discretion.

+

Syntax

+
New-DbaMessageLevelModifier
+    [-Name] <String>
+    [-Modifier] <Int32>
+    [[-IncludeFunctionName] <String>]
+    [[-ExcludeFunctionName] <String>]
+    [[-IncludeModuleName] <String>]
+    [[-ExcludeModuleName] <String>]
+    [[-IncludeTags] <String[]>]
+    [[-ExcludeTags] <String[]>]
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> New-DbaMessageLevelModifier -Name 'MyModule-Include' -Modifier -9 -IncludeModuleName MyModule
+PS C:\> New-DbaMessageLevelModifier -Name 'MyModule-Exclude' -Modifier 9 -ExcludeModuleName MyModule
+
+

These settings will cause all messages from the module 'MyModule' to be highly prioritized and almost certainly written to host.
+It will also make it highly unlikely, that messages from other modules will even be considered for anything but the lowest level.
+This is useful when prioritizing your own module during development.

+

Required Parameters

+
-Name
+

The name of the level modifier. +Can be arbitrary, but must be unique. Not case sensitive.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-Modifier
+

The level modifier to apply.

+
    +
  • Use a negative value to make a message more relevant
    • +
  • Use a positive value to make a message less relevant +While not limited to this range, the original levels range from 1 through 9:
    • +
  • 1-3 : Written to host and debug by default
    • +
  • 4-6 : Written to verbose and debug by default
    • +
  • 7-9 : Internas, written only to debug
    • +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value0
+

Optional Parameters

+
-IncludeFunctionName
+

Only messages from functions with one of these exact names will be considered.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ExcludeFunctionName
+

Messages from functions with one of these exact names will be ignored.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-IncludeModuleName
+

Only messages from modules with one of these exact names will be considered.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ExcludeModuleName
+

Messages from module with one of these exact names will be ignored.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-IncludeTags
+

Only messages that contain one of these tags will be considered.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ExcludeTags
+

Messages that contain one of these tags will be ignored.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-EnableException
+

This parameters disables user-friendly warnings and enables the throwing of exceptions. +This is less user friendly, but allows catching exceptions in calling scripts.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out New-DbaMessageLevelModifier on GitHub. +
+Want to see the Bill Of Health for this command? Check out New-DbaMessageLevelModifier.

+ +
+
+
+
+ + + diff --git a/New-DbaRgResourcePool.html b/New-DbaRgResourcePool.html index aa59c5a3..05da776d 100644 Binary files a/New-DbaRgResourcePool.html and b/New-DbaRgResourcePool.html differ diff --git a/New-DbaRgWorkloadGroup.html b/New-DbaRgWorkloadGroup.html index afcb529f..8a561901 100644 Binary files a/New-DbaRgWorkloadGroup.html and b/New-DbaRgWorkloadGroup.html differ diff --git a/New-DbaScriptingOption.html b/New-DbaScriptingOption.html index d3241aa6..b29954fd 100644 Binary files a/New-DbaScriptingOption.html and b/New-DbaScriptingOption.html differ diff --git a/New-DbaServerRole.html b/New-DbaServerRole.html index 9d219fd7..20a83e07 100644 Binary files a/New-DbaServerRole.html and b/New-DbaServerRole.html differ diff --git a/New-DbaServiceMasterKey.html b/New-DbaServiceMasterKey.html index b5658e77..22263a50 100644 Binary files a/New-DbaServiceMasterKey.html and b/New-DbaServiceMasterKey.html differ diff --git a/New-DbaSqlParameter.html b/New-DbaSqlParameter.html index 893c37c1..6b740e78 100644 Binary files a/New-DbaSqlParameter.html and b/New-DbaSqlParameter.html differ diff --git a/New-DbaXESession.html b/New-DbaXESession.html index 406749f9..e24bee8f 100644 Binary files a/New-DbaXESession.html and b/New-DbaXESession.html differ diff --git a/New-DbaXESmartCsvWriter.html b/New-DbaXESmartCsvWriter.html index ec70eb05..3fb9980c 100644 Binary files a/New-DbaXESmartCsvWriter.html and b/New-DbaXESmartCsvWriter.html differ diff --git a/New-DbaXESmartEmail.html b/New-DbaXESmartEmail.html index dbc99fa6..3fe40dd7 100644 Binary files a/New-DbaXESmartEmail.html and b/New-DbaXESmartEmail.html differ diff --git a/New-DbaXESmartQueryExec.html b/New-DbaXESmartQueryExec.html index b6482fbb..5de39311 100644 Binary files a/New-DbaXESmartQueryExec.html and b/New-DbaXESmartQueryExec.html differ diff --git a/New-DbaXESmartReplay.html b/New-DbaXESmartReplay.html index 0696cc5a..77dfa8a5 100644 Binary files a/New-DbaXESmartReplay.html and b/New-DbaXESmartReplay.html differ diff --git a/New-DbaXESmartTableWriter.html b/New-DbaXESmartTableWriter.html index 5b22c0e2..46964735 100644 Binary files a/New-DbaXESmartTableWriter.html and b/New-DbaXESmartTableWriter.html differ diff --git a/New-DbatoolsSupportPackage.html b/New-DbatoolsSupportPackage.html index d264dddc..89a2d6cf 100644 Binary files a/New-DbatoolsSupportPackage.html and b/New-DbatoolsSupportPackage.html differ diff --git a/New-SqlConnection.html b/New-SqlConnection.html new file mode 100644 index 00000000..9a22197c --- /dev/null +++ b/New-SqlConnection.html @@ -0,0 +1,542 @@ + + + + + + + dbatools docs | New-SqlConnection + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

New-SqlConnection

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

New-SqlConnection [-SqlInstance ] [-SqlCredential ]

+

Description

+

Syntax

+
New-SqlConnectionsyntaxItem----------{@{name=
+
+New-SqlConnection; CommonParameters=False; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-SqlCredential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-SqlInstance
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out New-SqlConnection on GitHub. +
+Want to see the Bill Of Health for this command? Check out New-SqlConnection.

+ +
+
+
+
+ + + diff --git a/Publish-DbaDacPackage.html b/Publish-DbaDacPackage.html index eb239e1b..ae81556e 100644 Binary files a/Publish-DbaDacPackage.html and b/Publish-DbaDacPackage.html differ diff --git a/Read-DbaAuditFile.html b/Read-DbaAuditFile.html index f5767505..97fcaea2 100644 Binary files a/Read-DbaAuditFile.html and b/Read-DbaAuditFile.html differ diff --git a/Read-DbaBackupHeader.html b/Read-DbaBackupHeader.html index 2aa4383c..90d931ff 100644 Binary files a/Read-DbaBackupHeader.html and b/Read-DbaBackupHeader.html differ diff --git a/Read-DbaTraceFile.html b/Read-DbaTraceFile.html index a945db44..fcd33a42 100644 Binary files a/Read-DbaTraceFile.html and b/Read-DbaTraceFile.html differ diff --git a/Read-DbaTransactionLog.html b/Read-DbaTransactionLog.html index 7ad02839..758153ea 100644 Binary files a/Read-DbaTransactionLog.html and b/Read-DbaTransactionLog.html differ diff --git a/Read-DbaXEFile.html b/Read-DbaXEFile.html index acf0d2e6..09f0bbf1 100644 Binary files a/Read-DbaXEFile.html and b/Read-DbaXEFile.html differ diff --git a/Read-DbatoolsConfigFile.html b/Read-DbatoolsConfigFile.html new file mode 100644 index 00000000..f68794c3 --- /dev/null +++ b/Read-DbatoolsConfigFile.html @@ -0,0 +1,580 @@ + + + + + + + dbatools docs | Read-DbatoolsConfigFile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Read-DbatoolsConfigFile

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Reads a configuration file and parses it.

+

Description

+

Reads a configuration file and parses it.

+

Syntax

+
Read-DbatoolsConfigFile -Path <String>
+    [<CommonParameters>]
+
+Read-DbatoolsConfigFile -Weblink <String>
+    [<CommonParameters>]
+
+Read-DbatoolsConfigFile -RawJson <String>
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Read-DbatoolsConfigFile -Path config.json
+
+

Reads the config.json file and returns interpreted configuration objects.

+

Required Parameters

+
-Path
+

The path to the file to parse.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+ +

The link to a website to download straight as raw json.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-RawJson
+

Raw json data to interpret.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Read-DbatoolsConfigFile on GitHub. +
+Want to see the Bill Of Health for this command? Check out Read-DbatoolsConfigFile.

+ +
+
+
+
+ + + diff --git a/Read-DbatoolsConfigPersisted.html b/Read-DbatoolsConfigPersisted.html new file mode 100644 index 00000000..de5c91ed --- /dev/null +++ b/Read-DbatoolsConfigPersisted.html @@ -0,0 +1,637 @@ + + + + + + + dbatools docs | Read-DbatoolsConfigPersisted + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Read-DbatoolsConfigPersisted

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Reads configurations from persisted file / registry.

+

Description

+

Reads configurations from persisted file / registry.

+

Syntax

+
Read-DbatoolsConfigPersisted
+    [[-Scope] {UserDefault | UserMandatory | SystemDefault | SystemMandatory | FileUserLocal | FileUserShared | FileSystem}]
+    [[-Module] <String>]
+    [[-ModuleVersion] <Int32>]
+    [[-Hashtable] <Hashtable>]
+    [-Default]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Read-DbatoolsConfigPersisted -Scope 127
+Read all persisted default configuration items in the default mandated order.

+

Optional Parameters

+
-Scope
+

Where to read from.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Module
+

Load module specific data. +Use this to load on-demand configuration only when the module is imported. +Useful when using the config system as cache.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ModuleVersion
+

The configuration version of the module-settings to load.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value1
+
-Hashtable
+

Rather than returning results, insert them into this hashtable.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Default
+

When inserting into a hashtable, existing values are overwritten by default. +Enabling this setting will cause it to only insert values if the key does not exist yet.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Read-DbatoolsConfigPersisted on GitHub. +
+Want to see the Bill Of Health for this command? Check out Read-DbatoolsConfigPersisted.

+ +
+
+
+
+ + + diff --git a/Register-DbaMaintenanceTask.html b/Register-DbaMaintenanceTask.html new file mode 100644 index 00000000..600f1a6b --- /dev/null +++ b/Register-DbaMaintenanceTask.html @@ -0,0 +1,704 @@ + + + + + + + dbatools docs | Register-DbaMaintenanceTask + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Register-DbaMaintenanceTask

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Allows scheduling maintenance tasks, that are perfomed in the background.

+

Description

+

Allows scheduling maintenance tasks, that are perfomed in the background.

+

All scriptblocks scheduled like this will be performed on a separate runspace and have access to all internal dbatools commands. +None of the scriptblocks will affect the main session (so you cannot manipulate variables, etc.)

+

Syntax

+
Register-DbaMaintenanceTask -Name <String> -ScriptBlock <ScriptBlock> -Once
+    [-Delay <TimeSpan>]
+    [-Priority {Trivial | Low | Medium | High | Critical}]
+    [-EnableException]
+    [<CommonParameters>]
+
+Register-DbaMaintenanceTask -Name <String> -ScriptBlock <ScriptBlock> -Interval <TimeSpan>
+    [-Delay <TimeSpan>]
+    [-Priority {Trivial | Low | Medium | High | Critical}]
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Register-DbaMaintenanceTask -Name 'value1' -ScriptBlock $ScriptBlock -Once
+
+

Required Parameters

+
-Name
+

The name of the task. +Must be unique, otherwise it will update the existing task.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-ScriptBlock
+

The task/scriptblock that should be performed as part of the maintenance. +It will have all of dbatools including internal commands available.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-Once
+

Whether the interval should be performed only once.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default ValueFalse
+
-Interval
+

The interval at which the task should be repeated.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-Delay
+

How far after the initial registration should the maintenance script wait before processing this. +This can be used to delay background stuff that should not content with items that would be good to have as part of the module import. +Some library specific items can be moved to maintenance if their processing would take too much time on original import, even if it is desirable to have them available as soon as possible.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Priority
+

How important is this task? +If multiple tasks are due at the same maintenance cycle, the more critical one will be processed first.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueMedium
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Register-DbaMaintenanceTask on GitHub. +
+Want to see the Bill Of Health for this command? Check out Register-DbaMaintenanceTask.

+ +
+
+
+
+ + + diff --git a/Register-DbaMessageEvent.html b/Register-DbaMessageEvent.html new file mode 100644 index 00000000..7b01336d --- /dev/null +++ b/Register-DbaMessageEvent.html @@ -0,0 +1,771 @@ + + + + + + + dbatools docs | Register-DbaMessageEvent + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Register-DbaMessageEvent

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Registers an event to when a message is written.

+

Description

+

Registers an event to when a message is written. +These events will fire whenever the written message fulfills the specified filter criteria.

+

This allows integrating direct alerts and reactions to messages as they occur.

+

Warnings:

+
    +
  • Adding many subscriptions can impact overall performance, even without triggering.
    • +
  • Events are executed synchronously. executing complex operations may introduce a significant delay to the command execution.
    • +
+

It is recommended to push processing that involves outside resources to a separate runspace, then use the event to pass the object as trigger. +The TaskEngine component may prove to be just what is needed to accomplish this.

+

Syntax

+
Register-DbaMessageEvent -Name <String> -ScriptBlock <ScriptBlock>
+    [-MessageFilter <String>]
+    [-ModuleNameFilter <String>]
+    [-FunctionNameFilter <String>]
+    [-TargetFilter <Object>]
+    [-LevelFilter {Critical | Important | Output | Significant | VeryVerbose | Verbose | SomewhatVerbose | System | Debug | InternalComment | Warning}]
+    [-TagFilter <String[]>]
+    [-RunspaceFilter <Guid>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Register-DbaMessageEvent -Name 'Mymodule.OffloadTrigger' -ScriptBlock $ScriptBlock -Tag 'engine' -Module 'MyModule' -Level Warning
+
+

Registers an event subscription ...

+
    +
  • Under the name 'Mymodule.OffloadTrigger' ...
    • +
  • To execute $ScriptBlock ...
    • +
  • Whenever a message is written with the tag 'engine' by the module 'MyModule' at the level 'Warning'
    • +
+

Required Parameters

+
-Name
+

The name of the subscription. +Each subscription must have a name, subscriptions of equal name will overwrite each other. +This is in order to avoid having runspace uses explode the number of subscriptions on each invocation.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-ScriptBlock
+

The scriptblock to execute. +It will receive the message entry (as returned by Get-DbatoolsLog) as its sole argument.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-MessageFilter
+

Filter by message content. Understands wildcards, but not regex.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ModuleNameFilter
+

Filter by Name of the module, from which the message comes. Understands wildcards, but not regex.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-FunctionNameFilter
+

Filter by Name of the function, from which the message comes. Understands wildcards, but not regex.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-TargetFilter
+

Filter by target object. Performs equality comparison on an object level.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-LevelFilter
+

Include only messages of the specified levels.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-TagFilter
+

Only include messages with any of the specified tags.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-RunspaceFilter
+

Only include messages which were written by the specified runspace. +You can find out the current runspace ID by running this: +[System.Management.Automation.Runspaces.Runspace]::DefaultRunspace.InstanceId +You can retrieve the primary runspace - the Guid used by the runspace the user sees - by running this: +[Sqlcollaborative.Dbatools.Utility.UtilityHost]::PrimaryRunspace

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Register-DbaMessageEvent on GitHub. +
+Want to see the Bill Of Health for this command? Check out Register-DbaMessageEvent.

+ +
+
+
+
+ + + diff --git a/Register-DbaMessageTransform.html b/Register-DbaMessageTransform.html new file mode 100644 index 00000000..396307f7 --- /dev/null +++ b/Register-DbaMessageTransform.html @@ -0,0 +1,734 @@ + + + + + + + dbatools docs | Register-DbaMessageTransform + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Register-DbaMessageTransform

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Registers a scriptblock that can transform message content.

+

Description

+

Registers a scriptblock that can transform message content. +This can be used to convert some kinds of input. Specifically:

+

Target: +When specifying a target, this target may require some conversion. +For example, an object containing a live connection may need to have a static copy stored instead, +as otherwise its export on a different runspace may cause access violations.

+

Exceptions: +Some exceptions may need transforming. +For example some APIs might wrap the actual exception into a common wrapper. +In this scenario you may want the actual exception in order to provide more specific information.

+

In all instances, the scriptblock will be called, receiving only the relevant object as its sole input.

+

Note: This transformation is performed synchronously on the active runspace. Complex scriptblocks may delay execution times when a matching object is passed.

+

Syntax

+
Register-DbaMessageTransform -TargetType <String> -ScriptBlock <ScriptBlock>
+    [<CommonParameters>]
+
+Register-DbaMessageTransform -ExceptionType <String> -ScriptBlock <ScriptBlock>
+    [<CommonParameters>]
+
+Register-DbaMessageTransform -ScriptBlock <ScriptBlock> -TargetTypeFilter <String>
+    [-FunctionNameFilter <Object>]
+    [-ModuleNameFilter <Object>]
+    [<CommonParameters>]
+
+Register-DbaMessageTransform -ScriptBlock <ScriptBlock> -ExceptionTypeFilter <String>
+    [-FunctionNameFilter <Object>]
+    [-ModuleNameFilter <Object>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Register-DbaMessageTransform -TargetType 'mymodule.category.classname' -ScriptBlock $ScriptBlock
+
+

Whenever a target object of type 'mymodule.category.classname' is specified, invoke $ScriptBlock (with the object as sole argument) and store the result as target instead.

+
Example: 2
+
PS C:\> Register-DbaMessageTransform -ExceptionType 'mymodule.category.exceptionname' -ScriptBlock $ScriptBlock
+
+

Whenever an exception or error record of type 'mymodule.category.classname' is specified, invoke $ScriptBlock (with the object as sole argument) and store the result as exception instead.
+If the full error record is specified, only the updated exception will be inserted

+
Example: 3
+
PS C:\> Register-DbaMessageTransform -TargetTypeFilter 'mymodule.category.*' -ScriptBlock $ScriptBlock
+
+

Adds a transform for all target objects that are of a type whose full name starts with 'mymodule.category.'
+All target objects matching that typename will be run through the specified scriptblock, which in return generates the new target object.

+

Required Parameters

+
-TargetType
+

The full typename of the target object to apply the scriptblock to. +All objects of that typename will be processed through that scriptblock.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-ExceptionType
+

The full typename of the exception object to apply the scriptblock to. +All objects of that typename will be processed through that scriptblock. +Note: In case of error records, the type of the Exception Property is inspected. The error record as a whole will not be touched, except for having its exception exchanged.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-ScriptBlock
+

The scriptblock that performs the transformation.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-TargetTypeFilter
+

A filter for the typename of the target object to transform. +Supports wildcards, but not regex. +WARNING: Adding too many filter-type transforms may impact overall performance, try to avoid using them!

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-ExceptionTypeFilter
+

A filter for the typename of the exception object to transform. +Supports wildcards, but not regex. +WARNING: Adding too many filter-type transforms may impact overall performance, try to avoid using them!

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-FunctionNameFilter
+

Default: "*" +Allows filtering by function name, in order to consider whether the function is affected. +Supports wildcards, but not regex. +WARNING: Adding too many filter-type transforms may impact overall performance, try to avoid using them!

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value*
+
-ModuleNameFilter
+

Default: "*" +Allows filtering by module name, in order to consider whether the function is affected. +Supports wildcards, but not regex. +WARNING: Adding too many filter-type transforms may impact overall performance, try to avoid using them!

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value*
+

 

+

Want to see the source code for this command? Check out Register-DbaMessageTransform on GitHub. +
+Want to see the Bill Of Health for this command? Check out Register-DbaMessageTransform.

+ +
+
+
+
+ + + diff --git a/Register-DbaRunspace.html b/Register-DbaRunspace.html new file mode 100644 index 00000000..7895b31e --- /dev/null +++ b/Register-DbaRunspace.html @@ -0,0 +1,594 @@ + + + + + + + dbatools docs | Register-DbaRunspace + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Register-DbaRunspace

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Registers a scriptblock to run in the background.

+

Description

+

This function registers a scriptblock to run in separate runspace. +This is different from most runspace solutions, in that it is designed for permanent background tasks that need to be done. +It guarantees a single copy of the task to run within the powershell process, even when running the same module in many runspaces in parallel.

+

Updating: +If this function is called multiple times, targeting the same name, it will update the scriptblock.

+
    +
  • If that scriptblock is the same as the previous scriptblock, nothing changes
    • +
  • If that scriptblock is different from the previous ones, it will be registered, but will not be executed right away! +Only after stopping and starting the runspace will it operate under the new scriptblock.
    • +
+

Syntax

+
Register-DbaRunspace -ScriptBlock <ScriptBlock> -Name <String>
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Register-DbaRunspace -ScriptBlock $scriptBlock -Name 'mymodule.maintenance'
+
+

Registers the script defined in $scriptBlock under the name 'mymodule.maintenance'
+It does not start the runspace yet. If it already exists, it will overwrite the scriptblock without affecting the running script.

+
Example: 2
+
PS C:\> Register-DbaRunspace -ScriptBlock $scriptBlock -Name 'mymodule.maintenance'
+PS C:\> Start-DbaRunspace -Name 'mymodule.maintenance'
+
+

Registers the script defined in $scriptBlock under the name 'mymodule.maintenance'
+Then it starts the runspace, running the registered $scriptBlock

+

Required Parameters

+
-ScriptBlock
+

The scriptblock to run in a dedicated runspace

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-Name
+

The name to register the scriptblock under.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Register-DbaRunspace on GitHub. +
+Want to see the Bill Of Health for this command? Check out Register-DbaRunspace.

+ +
+
+
+
+ + + diff --git a/Register-DbaTeppArgumentCompleter.html b/Register-DbaTeppArgumentCompleter.html new file mode 100644 index 00000000..ef8f18f5 --- /dev/null +++ b/Register-DbaTeppArgumentCompleter.html @@ -0,0 +1,610 @@ + + + + + + + dbatools docs | Register-DbaTeppArgumentCompleter + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Register-DbaTeppArgumentCompleter

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Registers a parameter for a prestored Tepp.

+

Description

+

Registers a parameter for a prestored Tepp. +This function allows easily registering a function's parameter for Tepp in the function-file, rather than in a centralized location.

+

Syntax

+
Register-DbaTeppArgumentCompleter
+    [[-Command] <String[]>]
+    [[-Parameter] <String[]>]
+    [[-Name] <String>]
+    [-All]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Register-DbaTeppArgumentCompleter -Command Get-DbaDbBackupHistory -Parameter Database
+Registers the "Database" parameter of the Get-DbaDbBackupHistory to receive Database-Tepp

+

Optional Parameters

+
-Command
+

Name of the command whose parameter should receive Tepp. +Supports multiple commands at the same time in order to optimize performance.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Parameter
+

Name of the parameter that should be Tepp'ed.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Name
+

Name of the Tepp Completioner to use. +Defaults to the parameter name. +Best practice requires a Completioner to be named the same as the completed parameter, in which case this parameter needs not be specified. +However sometimes that may not be universally possible, which is when this parameter comes in.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-All
+

Whether this TEPP applies to all commands in dbatools that have the specified parameter.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Register-DbaTeppArgumentCompleter on GitHub. +
+Want to see the Bill Of Health for this command? Check out Register-DbaTeppArgumentCompleter.

+ +
+
+
+
+ + + diff --git a/Register-DbaTeppInstanceCacheBuilder.html b/Register-DbaTeppInstanceCacheBuilder.html new file mode 100644 index 00000000..f3683a63 --- /dev/null +++ b/Register-DbaTeppInstanceCacheBuilder.html @@ -0,0 +1,560 @@ + + + + + + + dbatools docs | Register-DbaTeppInstanceCacheBuilder + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Register-DbaTeppInstanceCacheBuilder

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Registers a scriptblock used to build the TEPP cache from an instance connection.

+

Description

+

Registers a scriptblock used to build the TEPP cache from an instance connection. +Used only on import of the module.

+

Syntax

+
Register-DbaTeppInstanceCacheBuilder
+    [-ScriptBlock] <ScriptBlock>
+    [-Slow]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Register-DbaTeppInstanceCacheBuilder -ScriptBlock $ScriptBlock
+Registers the scriptblock stored in the aptly named variable $ScriptBlock as a fest cache building scriptblock.
+Note: The scriptblock must execute swiftly! (less than 25ms)

+
Example: 2
+

PS > Register-DbaTeppInstanceCacheBuilder -ScriptBlock $ScriptBlock -Slow
+Registers the scriptblock stored in the aptly named variable $ScriptBlock as a slow cache building scriptblock.
+This is suitable for cache building scriptblocks that take a while to execute.

+

Required Parameters

+
-ScriptBlock
+

The ScriptBlock used to build the cache. +The ScriptBlock may assume the following two variables to exist:

+
    +
  • $FullSmoName (A string containing the full SMO name as presented by the DbaInstanceParameter class-interpreted input)
    • +
  • $server (An SMO connection object)
    • +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-Slow
+

This switch implies a gathering process that takes too much time to be performed synchronously. +Basically, when retrieving the information takes more than 25ms on an average server (on top of establishing the original connection), this switch should be set.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Register-DbaTeppInstanceCacheBuilder on GitHub. +
+Want to see the Bill Of Health for this command? Check out Register-DbaTeppInstanceCacheBuilder.

+ +
+
+
+
+ + + diff --git a/Register-DbaTeppScriptblock.html b/Register-DbaTeppScriptblock.html new file mode 100644 index 00000000..7edda702 --- /dev/null +++ b/Register-DbaTeppScriptblock.html @@ -0,0 +1,547 @@ + + + + + + + dbatools docs | Register-DbaTeppScriptblock + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Register-DbaTeppScriptblock

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Registers a scriptblock under name, to later be available for TabExpansion.

+

Description

+

Registers a scriptblock under name, to later be available for TabExpansion.

+

Syntax

+
Register-DbaTeppScriptblock
+    [[-ScriptBlock] <ScriptBlock>]
+    [[-Name] <String>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Register-DbaTeppScriptblock -ScriptBlock $scriptBlock -Name MyFirstTeppScriptBlock
+Stores the scriptblock stored in $scriptBlock under the name "MyFirstTeppScriptBlock"

+

Optional Parameters

+
-ScriptBlock
+

The scriptblock to register.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Name
+

The name under which the scriptblock should be registered.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Register-DbaTeppScriptblock on GitHub. +
+Want to see the Bill Of Health for this command? Check out Register-DbaTeppScriptblock.

+ +
+
+
+
+ + + diff --git a/Register-DbatoolsConfig.html b/Register-DbatoolsConfig.html index 64ab1ace..72d36809 100644 Binary files a/Register-DbatoolsConfig.html and b/Register-DbatoolsConfig.html differ diff --git a/Register-DbatoolsConfigValidation.html b/Register-DbatoolsConfigValidation.html new file mode 100644 index 00000000..09853e9d --- /dev/null +++ b/Register-DbatoolsConfigValidation.html @@ -0,0 +1,557 @@ + + + + + + + dbatools docs | Register-DbatoolsConfigValidation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Register-DbatoolsConfigValidation

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Registers a validation scriptblock for use with the configuration system.

+

Description

+

Registers a validation scriptblock for use with the configuration system.

+

The scriptblock must be designed according to a few guidelines:

+
    +
  • It must not throw exceptions
    • +
  • It must accept a single parameter (the value to be tested)
    • +
  • It must return an object with three properties: 'Message', 'Value' and 'Success'. +The Success property should be boolean and indicate whether the value is valid. +The Value property contains the validated input. The scriptblock may legally convert the input (For example from string to int in case of integer validation) +The message contains a string that will be passed along to an exception in case the input is NOT valid.
    • +
+

Syntax

+
Register-DbatoolsConfigValidation
+    [-Name] <String>
+    [-ScriptBlock] <ScriptBlock>
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Register-DbatoolsConfigValidation -Name IntPositive -ScriptBlock $scriptBlock
+
+

Registers the scriptblock stored in $scriptBlock as validation with the name IntPositive

+

Required Parameters

+
-Name
+

The name under which to register the validation scriptblock

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-ScriptBlock
+

The scriptblock to register

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Register-DbatoolsConfigValidation on GitHub. +
+Want to see the Bill Of Health for this command? Check out Register-DbatoolsConfigValidation.

+ +
+
+
+
+ + + diff --git a/Register-RemoteSessionConfiguration.html b/Register-RemoteSessionConfiguration.html new file mode 100644 index 00000000..6ac33ed8 --- /dev/null +++ b/Register-RemoteSessionConfiguration.html @@ -0,0 +1,662 @@ + + + + + + + dbatools docs | Register-RemoteSessionConfiguration + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Register-RemoteSessionConfiguration

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Registers a PSSessionConfiguration on a remote machine

+

Description

+

Registers a session with a custom credentials on a remote machine through WinRM. +Designed to overcome the double-hop issue and as an alternative to CredSSP protocol.

+

Syntax

+
Register-RemoteSessionConfiguration
+    [-ComputerName] <Object>
+    [[-Name] <String>]
+    [-Credential] <PSCredential>
+    [[-RunAsCredential] <PSCredential>]
+    [-WhatIf]
+    [-Confirm]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-ComputerName
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-Credential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-Name
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Valuedbatools_remotesession
+
-RunAsCredential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value$Credential
+
-WhatIf
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliaswi
RequiredFalse
Pipelinefalse
Default Value
+
-Confirm
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliascf
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Register-RemoteSessionConfiguration on GitHub. +
+Want to see the Bill Of Health for this command? Check out Register-RemoteSessionConfiguration.

+ +
+
+
+
+ + + diff --git a/Remove-DbaAgDatabase.html b/Remove-DbaAgDatabase.html index 51ac78a2..52ebf581 100644 Binary files a/Remove-DbaAgDatabase.html and b/Remove-DbaAgDatabase.html differ diff --git a/Remove-DbaAgListener.html b/Remove-DbaAgListener.html index e8b00589..45e10aa0 100644 Binary files a/Remove-DbaAgListener.html and b/Remove-DbaAgListener.html differ diff --git a/Remove-DbaAgReplica.html b/Remove-DbaAgReplica.html index 069eef0b..2e560126 100644 Binary files a/Remove-DbaAgReplica.html and b/Remove-DbaAgReplica.html differ diff --git a/Remove-DbaAgentAlert.html b/Remove-DbaAgentAlert.html index f7efda51..d9a9df11 100644 Binary files a/Remove-DbaAgentAlert.html and b/Remove-DbaAgentAlert.html differ diff --git a/Remove-DbaAgentAlertCategory.html b/Remove-DbaAgentAlertCategory.html index 74d643bb..88efbef5 100644 Binary files a/Remove-DbaAgentAlertCategory.html and b/Remove-DbaAgentAlertCategory.html differ diff --git a/Remove-DbaAgentJob.html b/Remove-DbaAgentJob.html index 4d7a6ea0..aca91d22 100644 Binary files a/Remove-DbaAgentJob.html and b/Remove-DbaAgentJob.html differ diff --git a/Remove-DbaAgentJobCategory.html b/Remove-DbaAgentJobCategory.html index 2c892035..796e10bf 100644 Binary files a/Remove-DbaAgentJobCategory.html and b/Remove-DbaAgentJobCategory.html differ diff --git a/Remove-DbaAgentJobStep.html b/Remove-DbaAgentJobStep.html index 27564723..136d9bab 100644 Binary files a/Remove-DbaAgentJobStep.html and b/Remove-DbaAgentJobStep.html differ diff --git a/Remove-DbaAgentOperator.html b/Remove-DbaAgentOperator.html index c19ff921..29803456 100644 Binary files a/Remove-DbaAgentOperator.html and b/Remove-DbaAgentOperator.html differ diff --git a/Remove-DbaAgentProxy.html b/Remove-DbaAgentProxy.html index c41538de..9faa5c46 100644 Binary files a/Remove-DbaAgentProxy.html and b/Remove-DbaAgentProxy.html differ diff --git a/Remove-DbaAgentSchedule.html b/Remove-DbaAgentSchedule.html index 9b54e2de..aa27db7d 100644 Binary files a/Remove-DbaAgentSchedule.html and b/Remove-DbaAgentSchedule.html differ diff --git a/Remove-DbaAvailabilityGroup.html b/Remove-DbaAvailabilityGroup.html index bc385da8..87080124 100644 Binary files a/Remove-DbaAvailabilityGroup.html and b/Remove-DbaAvailabilityGroup.html differ diff --git a/Remove-DbaBackup.html b/Remove-DbaBackup.html index a31a00dc..f1d9315b 100644 Binary files a/Remove-DbaBackup.html and b/Remove-DbaBackup.html differ diff --git a/Remove-DbaClientAlias.html b/Remove-DbaClientAlias.html index e1b07c50..0e2b1075 100644 Binary files a/Remove-DbaClientAlias.html and b/Remove-DbaClientAlias.html differ diff --git a/Remove-DbaCmConnection.html b/Remove-DbaCmConnection.html index 4d73664c..9df096a6 100644 Binary files a/Remove-DbaCmConnection.html and b/Remove-DbaCmConnection.html differ diff --git a/Remove-DbaComputerCertificate.html b/Remove-DbaComputerCertificate.html index a4fa8f02..1cd71845 100644 Binary files a/Remove-DbaComputerCertificate.html and b/Remove-DbaComputerCertificate.html differ diff --git a/Remove-DbaCredential.html b/Remove-DbaCredential.html index 4274ea3e..c04daa9c 100644 Binary files a/Remove-DbaCredential.html and b/Remove-DbaCredential.html differ diff --git a/Remove-DbaCustomError.html b/Remove-DbaCustomError.html index b9714f8c..08a312bd 100644 Binary files a/Remove-DbaCustomError.html and b/Remove-DbaCustomError.html differ diff --git a/Remove-DbaDatabase.html b/Remove-DbaDatabase.html index 1b68abbb..d2b1f1c9 100644 Binary files a/Remove-DbaDatabase.html and b/Remove-DbaDatabase.html differ diff --git a/Remove-DbaDatabaseSafely.html b/Remove-DbaDatabaseSafely.html index 80697870..0b70bd90 100644 Binary files a/Remove-DbaDatabaseSafely.html and b/Remove-DbaDatabaseSafely.html differ diff --git a/Remove-DbaDbAsymmetricKey.html b/Remove-DbaDbAsymmetricKey.html index ce7e8f4e..5e9bd087 100644 Binary files a/Remove-DbaDbAsymmetricKey.html and b/Remove-DbaDbAsymmetricKey.html differ diff --git a/Remove-DbaDbBackupRestoreHistory.html b/Remove-DbaDbBackupRestoreHistory.html index 0cb8ed1d..778926ab 100644 Binary files a/Remove-DbaDbBackupRestoreHistory.html and b/Remove-DbaDbBackupRestoreHistory.html differ diff --git a/Remove-DbaDbCertificate.html b/Remove-DbaDbCertificate.html index 080ab3c3..3e6637a4 100644 Binary files a/Remove-DbaDbCertificate.html and b/Remove-DbaDbCertificate.html differ diff --git a/Remove-DbaDbCheckConstraint.html b/Remove-DbaDbCheckConstraint.html index 25cc54be..f0d281e4 100644 Binary files a/Remove-DbaDbCheckConstraint.html and b/Remove-DbaDbCheckConstraint.html differ diff --git a/Remove-DbaDbData.html b/Remove-DbaDbData.html index 208ce6d8..769c2f8a 100644 Binary files a/Remove-DbaDbData.html and b/Remove-DbaDbData.html differ diff --git a/Remove-DbaDbEncryptionKey.html b/Remove-DbaDbEncryptionKey.html index 77aceab9..a105ac5e 100644 Binary files a/Remove-DbaDbEncryptionKey.html and b/Remove-DbaDbEncryptionKey.html differ diff --git a/Remove-DbaDbFileGroup.html b/Remove-DbaDbFileGroup.html index d8dbcd63..f658880b 100644 Binary files a/Remove-DbaDbFileGroup.html and b/Remove-DbaDbFileGroup.html differ diff --git a/Remove-DbaDbLogShipping.html b/Remove-DbaDbLogShipping.html index bc51e646..05aeb384 100644 Binary files a/Remove-DbaDbLogShipping.html and b/Remove-DbaDbLogShipping.html differ diff --git a/Remove-DbaDbMailAccount.html b/Remove-DbaDbMailAccount.html index a3b9484c..0b6c3e9d 100644 Binary files a/Remove-DbaDbMailAccount.html and b/Remove-DbaDbMailAccount.html differ diff --git a/Remove-DbaDbMailProfile.html b/Remove-DbaDbMailProfile.html index 78e5ceb6..8d666f4b 100644 Binary files a/Remove-DbaDbMailProfile.html and b/Remove-DbaDbMailProfile.html differ diff --git a/Remove-DbaDbMasterKey.html b/Remove-DbaDbMasterKey.html index d9fcb226..f10a52e4 100644 Binary files a/Remove-DbaDbMasterKey.html and b/Remove-DbaDbMasterKey.html differ diff --git a/Remove-DbaDbMirror.html b/Remove-DbaDbMirror.html index 30c53bb2..95588104 100644 Binary files a/Remove-DbaDbMirror.html and b/Remove-DbaDbMirror.html differ diff --git a/Remove-DbaDbMirrorMonitor.html b/Remove-DbaDbMirrorMonitor.html index 540cd0ce..899751c6 100644 Binary files a/Remove-DbaDbMirrorMonitor.html and b/Remove-DbaDbMirrorMonitor.html differ diff --git a/Remove-DbaDbOrphanUser.html b/Remove-DbaDbOrphanUser.html index 80ed48b5..8bd3d04d 100644 Binary files a/Remove-DbaDbOrphanUser.html and b/Remove-DbaDbOrphanUser.html differ diff --git a/Remove-DbaDbPartitionFunction.html b/Remove-DbaDbPartitionFunction.html index c896be37..a042d6a2 100644 Binary files a/Remove-DbaDbPartitionFunction.html and b/Remove-DbaDbPartitionFunction.html differ diff --git a/Remove-DbaDbPartitionScheme.html b/Remove-DbaDbPartitionScheme.html index b6010923..8294966a 100644 Binary files a/Remove-DbaDbPartitionScheme.html and b/Remove-DbaDbPartitionScheme.html differ diff --git a/Remove-DbaDbRole.html b/Remove-DbaDbRole.html index cb634994..fd4c73cb 100644 Binary files a/Remove-DbaDbRole.html and b/Remove-DbaDbRole.html differ diff --git a/Remove-DbaDbRoleMember.html b/Remove-DbaDbRoleMember.html index 8c9bb198..0e5f6cd5 100644 Binary files a/Remove-DbaDbRoleMember.html and b/Remove-DbaDbRoleMember.html differ diff --git a/Remove-DbaDbSchema.html b/Remove-DbaDbSchema.html index ce515418..b966ef11 100644 Binary files a/Remove-DbaDbSchema.html and b/Remove-DbaDbSchema.html differ diff --git a/Remove-DbaDbSequence.html b/Remove-DbaDbSequence.html index a8982482..dc26a39c 100644 Binary files a/Remove-DbaDbSequence.html and b/Remove-DbaDbSequence.html differ diff --git a/Remove-DbaDbSnapshot.html b/Remove-DbaDbSnapshot.html index be292894..0a446da9 100644 Binary files a/Remove-DbaDbSnapshot.html and b/Remove-DbaDbSnapshot.html differ diff --git a/Remove-DbaDbSynonym.html b/Remove-DbaDbSynonym.html index 09f9b845..1ae6798c 100644 Binary files a/Remove-DbaDbSynonym.html and b/Remove-DbaDbSynonym.html differ diff --git a/Remove-DbaDbTable.html b/Remove-DbaDbTable.html index 597d9e1e..b93ec95e 100644 Binary files a/Remove-DbaDbTable.html and b/Remove-DbaDbTable.html differ diff --git a/Remove-DbaDbTableData.html b/Remove-DbaDbTableData.html index 12bb6452..fabe54eb 100644 Binary files a/Remove-DbaDbTableData.html and b/Remove-DbaDbTableData.html differ diff --git a/Remove-DbaDbUdf.html b/Remove-DbaDbUdf.html index 08b5f52a..f97e83a3 100644 Binary files a/Remove-DbaDbUdf.html and b/Remove-DbaDbUdf.html differ diff --git a/Remove-DbaDbUser.html b/Remove-DbaDbUser.html index 1333e704..2e3b0e59 100644 Binary files a/Remove-DbaDbUser.html and b/Remove-DbaDbUser.html differ diff --git a/Remove-DbaDbView.html b/Remove-DbaDbView.html index a125e083..ff8bdca6 100644 Binary files a/Remove-DbaDbView.html and b/Remove-DbaDbView.html differ diff --git a/Remove-DbaEndpoint.html b/Remove-DbaEndpoint.html index ca96d25a..babd8d7f 100644 Binary files a/Remove-DbaEndpoint.html and b/Remove-DbaEndpoint.html differ diff --git a/Remove-DbaExtendedProperty.html b/Remove-DbaExtendedProperty.html index f99aa5b7..df4144c8 100644 Binary files a/Remove-DbaExtendedProperty.html and b/Remove-DbaExtendedProperty.html differ diff --git a/Remove-DbaFirewallRule.html b/Remove-DbaFirewallRule.html index 369533b7..e32c3eb0 100644 Binary files a/Remove-DbaFirewallRule.html and b/Remove-DbaFirewallRule.html differ diff --git a/Remove-DbaLinkedServer.html b/Remove-DbaLinkedServer.html index 9e62d88b..60b6c2c7 100644 Binary files a/Remove-DbaLinkedServer.html and b/Remove-DbaLinkedServer.html differ diff --git a/Remove-DbaLinkedServerLogin.html b/Remove-DbaLinkedServerLogin.html index 296a40fd..3c4f8a32 100644 Binary files a/Remove-DbaLinkedServerLogin.html and b/Remove-DbaLinkedServerLogin.html differ diff --git a/Remove-DbaLogin.html b/Remove-DbaLogin.html index 518efdb0..4402ce50 100644 Binary files a/Remove-DbaLogin.html and b/Remove-DbaLogin.html differ diff --git a/Remove-DbaMessageLevelModifier.html b/Remove-DbaMessageLevelModifier.html new file mode 100644 index 00000000..74270e8b --- /dev/null +++ b/Remove-DbaMessageLevelModifier.html @@ -0,0 +1,584 @@ + + + + + + + dbatools docs | Remove-DbaMessageLevelModifier + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Remove-DbaMessageLevelModifier

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Removes a message level modifier.

+

Description

+

Removes a message level modifier.

+

Message Level Modifiers can be created by using New-DbaMessageLevelModifier. +They are used to emphasize or deemphasize messages, in order to help with debugging.

+

Syntax

+
Remove-DbaMessageLevelModifier
+    [[-Name] <String[]>]
+    [[-Modifier] <MessageLevelModifier[]>]
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Get-DbaMessageLevelModifier | Remove-DbaMessageLevelModifier
+
+

Removes all message level modifiers, restoring everything to their default levels.

+
Example: 2
+
PS C:\> Remove-DbaMessageLevelModifier -Name "mymodule.foo"
+
+

Removes the message level modifier named "mymodule.foo"

+

Optional Parameters

+
-Name
+

Name of the message level modifier to remove.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinetrue (ByValue)
Default Value
+
-Modifier
+

The actual modifier to remove, as returned by Get-DbaMessageLevelModifier.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinetrue (ByValue)
Default Value
+
-EnableException
+

This parameters disables user-friendly warnings and enables the throwing of exceptions. +This is less user friendly, but allows catching exceptions in calling scripts.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Remove-DbaMessageLevelModifier on GitHub. +
+Want to see the Bill Of Health for this command? Check out Remove-DbaMessageLevelModifier.

+ +
+
+
+
+ + + diff --git a/Remove-DbaNetworkCertificate.html b/Remove-DbaNetworkCertificate.html index d18d0278..c271acb0 100644 Binary files a/Remove-DbaNetworkCertificate.html and b/Remove-DbaNetworkCertificate.html differ diff --git a/Remove-DbaPfDataCollectorCounter.html b/Remove-DbaPfDataCollectorCounter.html index 7ed45cea..4ea67cf1 100644 Binary files a/Remove-DbaPfDataCollectorCounter.html and b/Remove-DbaPfDataCollectorCounter.html differ diff --git a/Remove-DbaPfDataCollectorSet.html b/Remove-DbaPfDataCollectorSet.html index c55334fa..ea4636b4 100644 Binary files a/Remove-DbaPfDataCollectorSet.html and b/Remove-DbaPfDataCollectorSet.html differ diff --git a/Remove-DbaRegServer.html b/Remove-DbaRegServer.html index f78f0f49..db863d90 100644 Binary files a/Remove-DbaRegServer.html and b/Remove-DbaRegServer.html differ diff --git a/Remove-DbaRegServerGroup.html b/Remove-DbaRegServerGroup.html index fd88950a..8e2561f1 100644 Binary files a/Remove-DbaRegServerGroup.html and b/Remove-DbaRegServerGroup.html differ diff --git a/Remove-DbaRgResourcePool.html b/Remove-DbaRgResourcePool.html index 983bde05..1fea3cc3 100644 Binary files a/Remove-DbaRgResourcePool.html and b/Remove-DbaRgResourcePool.html differ diff --git a/Remove-DbaRgWorkloadGroup.html b/Remove-DbaRgWorkloadGroup.html index 88322b08..c3dad913 100644 Binary files a/Remove-DbaRgWorkloadGroup.html and b/Remove-DbaRgWorkloadGroup.html differ diff --git a/Remove-DbaServerRole.html b/Remove-DbaServerRole.html index 6157f6aa..6021846f 100644 Binary files a/Remove-DbaServerRole.html and b/Remove-DbaServerRole.html differ diff --git a/Remove-DbaServerRoleMember.html b/Remove-DbaServerRoleMember.html index e24d48f7..624b1191 100644 Binary files a/Remove-DbaServerRoleMember.html and b/Remove-DbaServerRoleMember.html differ diff --git a/Remove-DbaSpn.html b/Remove-DbaSpn.html index f220a7a3..71c5e619 100644 Binary files a/Remove-DbaSpn.html and b/Remove-DbaSpn.html differ diff --git a/Remove-DbaTrace.html b/Remove-DbaTrace.html index 2b1b46da..80314dc9 100644 Binary files a/Remove-DbaTrace.html and b/Remove-DbaTrace.html differ diff --git a/Remove-DbaXESession.html b/Remove-DbaXESession.html index 5a7e3b43..6d484fab 100644 Binary files a/Remove-DbaXESession.html and b/Remove-DbaXESession.html differ diff --git a/Remove-DbaXESmartTarget.html b/Remove-DbaXESmartTarget.html index 71d478e3..7f1bcad2 100644 Binary files a/Remove-DbaXESmartTarget.html and b/Remove-DbaXESmartTarget.html differ diff --git a/Remove-InvalidFileNameChars.html b/Remove-InvalidFileNameChars.html new file mode 100644 index 00000000..8cc0ef01 --- /dev/null +++ b/Remove-InvalidFileNameChars.html @@ -0,0 +1,514 @@ + + + + + + + dbatools docs | Remove-InvalidFileNameChars + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Remove-InvalidFileNameChars

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Remove-InvalidFileNameChars -Name []

+

Description

+

Syntax

+
Remove-InvalidFileNameCharssyntaxItem----------{@{name=
+
+Remove-InvalidFileNameChars; CommonParameters=True; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-Name
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinetrue (ByValue, ByPropertyName)
Default Value
+

 

+

Want to see the source code for this command? Check out Remove-InvalidFileNameChars on GitHub. +
+Want to see the Bill Of Health for this command? Check out Remove-InvalidFileNameChars.

+ +
+
+
+
+ + + diff --git a/Remove-TeppCacheItem.html b/Remove-TeppCacheItem.html new file mode 100644 index 00000000..3dbc00bd --- /dev/null +++ b/Remove-TeppCacheItem.html @@ -0,0 +1,576 @@ + + + + + + + dbatools docs | Remove-TeppCacheItem + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Remove-TeppCacheItem

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal function to remove an item from the TEPP cache.

+

Description

+

Internal function to remove an item from the TEPP cache.

+

Syntax

+
Remove-TeppCacheItem
+    [-SqlInstance] <DbaInstanceParameter>
+    [-Type] <String>
+    [-Name] <String>
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Remove-TeppCacheItem -SqlInstance $server -Type database -Name AdventureWorks
+Removes the entry for the database AdventureWorks from the TEPP cache.

+

Required Parameters

+
-SqlInstance
+

The SQL Server instance.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-Type
+

The type of object. Must be part of "[Sqlcollaborative.Dbatools.TabExpansion.TabExpansionHost]::Cache.Keys".

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-Name
+

The name of the object that should be removed from the cache.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Remove-TeppCacheItem on GitHub. +
+Want to see the Bill Of Health for this command? Check out Remove-TeppCacheItem.

+ +
+
+
+
+ + + diff --git a/Rename-DbaDatabase.html b/Rename-DbaDatabase.html index 0b6be6a2..34ea6cac 100644 Binary files a/Rename-DbaDatabase.html and b/Rename-DbaDatabase.html differ diff --git a/Rename-DbaLogin.html b/Rename-DbaLogin.html index 7899a47a..edfafac8 100644 Binary files a/Rename-DbaLogin.html and b/Rename-DbaLogin.html differ diff --git a/Repair-DbaDbMirror.html b/Repair-DbaDbMirror.html index 1a8ffc61..16719f02 100644 Binary files a/Repair-DbaDbMirror.html and b/Repair-DbaDbMirror.html differ diff --git a/Repair-DbaDbOrphanUser.html b/Repair-DbaDbOrphanUser.html index 154cf7fa..8f8e48ee 100644 Binary files a/Repair-DbaDbOrphanUser.html and b/Repair-DbaDbOrphanUser.html differ diff --git a/Repair-DbaInstanceName.html b/Repair-DbaInstanceName.html index dda0122f..f6e424b5 100644 Binary files a/Repair-DbaInstanceName.html and b/Repair-DbaInstanceName.html differ diff --git a/Reset-DbaAdmin.html b/Reset-DbaAdmin.html index bd7aeed4..14bf88c5 100644 Binary files a/Reset-DbaAdmin.html and b/Reset-DbaAdmin.html differ diff --git a/Reset-DbatoolsConfig.html b/Reset-DbatoolsConfig.html index 37e5d094..32c1cd8b 100644 Binary files a/Reset-DbatoolsConfig.html and b/Reset-DbatoolsConfig.html differ diff --git a/Resolve-DbaComputerName.html b/Resolve-DbaComputerName.html new file mode 100644 index 00000000..eb980e45 --- /dev/null +++ b/Resolve-DbaComputerName.html @@ -0,0 +1,581 @@ + + + + + + + dbatools docs | Resolve-DbaComputerName + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Resolve-DbaComputerName

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Resolves the computer based on the ComputerName of the input DbaInstanceParameter.

+

Description

+

Resolves the computer based on the ComputerName of the input DbaInstanceParameter. +Designed to get the FullComputerName needed for Invoke-Command2. +Default is to return the FullComputerName, but can also return other properties returned by Resolve-DbaNetworkName. +But if ComputerName is the local host, always returns the property ComputerName.

+

Syntax

+
Resolve-DbaComputerName
+    [-ComputerName] <DbaInstanceParameter>
+    [[-Credential] <PSCredential>]
+    [[-Property] <String>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-ComputerName
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-Credential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Property
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFullComputerName
Accepted ValuesComputerName,IPAddress,DNSHostname,DNSDomain,Domain,DNSHostEntry,FQDN,FullComputerName
+

 

+

Want to see the source code for this command? Check out Resolve-DbaComputerName on GitHub. +
+Want to see the Bill Of Health for this command? Check out Resolve-DbaComputerName.

+ +
+
+
+
+ + + diff --git a/Resolve-DbaNetworkName.html b/Resolve-DbaNetworkName.html index 2accef8c..a9addef7 100644 Binary files a/Resolve-DbaNetworkName.html and b/Resolve-DbaNetworkName.html differ diff --git a/Resolve-DbaPath.html b/Resolve-DbaPath.html index 12d0c563..92a4faab 100644 Binary files a/Resolve-DbaPath.html and b/Resolve-DbaPath.html differ diff --git a/Resolve-IpAddress.html b/Resolve-IpAddress.html new file mode 100644 index 00000000..617b56d5 --- /dev/null +++ b/Resolve-IpAddress.html @@ -0,0 +1,514 @@ + + + + + + + dbatools docs | Resolve-IpAddress + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Resolve-IpAddress

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Resolve-IpAddress -Server []

+

Description

+

Syntax

+
Resolve-IpAddresssyntaxItem----------{@{name=
+
+Resolve-IpAddress; CommonParameters=True; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-Server
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
AliasServerInstance,SqlInstance,ComputerName,SqlServer
RequiredTrue
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Resolve-IpAddress on GitHub. +
+Want to see the Bill Of Health for this command? Check out Resolve-IpAddress.

+ + + + + + + + diff --git a/Resolve-SqlIpAddress.html b/Resolve-SqlIpAddress.html new file mode 100644 index 00000000..f1ad9a9c --- /dev/null +++ b/Resolve-SqlIpAddress.html @@ -0,0 +1,543 @@ + + + + + + + dbatools docs | Resolve-SqlIpAddress + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Resolve-SqlIpAddress

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Resolve-SqlIpAddress -SqlInstance [-SqlCredential ] []

+

Description

+

Syntax

+
Resolve-SqlIpAddresssyntaxItem----------{@{name=
+
+Resolve-SqlIpAddress; CommonParameters=True; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-SqlInstance
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-SqlCredential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Resolve-SqlIpAddress on GitHub. +
+Want to see the Bill Of Health for this command? Check out Resolve-SqlIpAddress.

+ + + + + + + + diff --git a/Restart-DbaService.html b/Restart-DbaService.html index 8ee60b05..372d9295 100644 Binary files a/Restart-DbaService.html and b/Restart-DbaService.html differ diff --git a/Restart-WinRMService.html b/Restart-WinRMService.html new file mode 100644 index 00000000..e3428f74 --- /dev/null +++ b/Restart-WinRMService.html @@ -0,0 +1,632 @@ + + + + + + + dbatools docs | Restart-WinRMService + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Restart-WinRMService

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Restarts WinRM service on a remote machine and waits for it to get back up

+

Description

+

Restarts WinRM service on a remote machine and waits for it to get back up by attempting to establish a WinRM session.

+

Syntax

+
Restart-WinRMService
+    [-ComputerName] <Object>
+    [[-Credential] <PSCredential>]
+    [[-Timeout] <Int32>]
+    [-WhatIf]
+    [-Confirm]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-ComputerName
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-Credential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Timeout
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value30
+
-WhatIf
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliaswi
RequiredFalse
Pipelinefalse
Default Value
+
-Confirm
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliascf
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Restart-WinRMService on GitHub. +
+Want to see the Bill Of Health for this command? Check out Restart-WinRMService.

+ +
+
+
+
+ + + diff --git a/Restore-DbaDatabase.html b/Restore-DbaDatabase.html index 5f3212f4..c38764f5 100644 Binary files a/Restore-DbaDatabase.html and b/Restore-DbaDatabase.html differ diff --git a/Restore-DbaDbCertificate.html b/Restore-DbaDbCertificate.html index 6b8841b3..cfb35b4b 100644 Binary files a/Restore-DbaDbCertificate.html and b/Restore-DbaDbCertificate.html differ diff --git a/Restore-DbaDbSnapshot.html b/Restore-DbaDbSnapshot.html index a20b3af4..42642521 100644 Binary files a/Restore-DbaDbSnapshot.html and b/Restore-DbaDbSnapshot.html differ diff --git a/Resume-DbaAgDbDataMovement.html b/Resume-DbaAgDbDataMovement.html index 3edf6139..b5e5f4fb 100644 Binary files a/Resume-DbaAgDbDataMovement.html and b/Resume-DbaAgDbDataMovement.html differ diff --git a/Revoke-DbaAgPermission.html b/Revoke-DbaAgPermission.html index 2fd8d743..820f8742 100644 Binary files a/Revoke-DbaAgPermission.html and b/Revoke-DbaAgPermission.html differ diff --git a/Save-DbaCommunitySoftware.html b/Save-DbaCommunitySoftware.html index 58618b80..c9b7b5ba 100644 Binary files a/Save-DbaCommunitySoftware.html and b/Save-DbaCommunitySoftware.html differ diff --git a/Save-DbaDiagnosticQueryScript.html b/Save-DbaDiagnosticQueryScript.html index 467a69b3..6cc14ee7 100644 Binary files a/Save-DbaDiagnosticQueryScript.html and b/Save-DbaDiagnosticQueryScript.html differ diff --git a/Save-DbaKbUpdate.html b/Save-DbaKbUpdate.html index 5ddf8869..cb605827 100644 Binary files a/Save-DbaKbUpdate.html and b/Save-DbaKbUpdate.html differ diff --git a/Select-DbaBackupInformation.html b/Select-DbaBackupInformation.html index 5670a665..2a958a6f 100644 Binary files a/Select-DbaBackupInformation.html and b/Select-DbaBackupInformation.html differ diff --git a/Select-DbaDbSequenceNextValue.html b/Select-DbaDbSequenceNextValue.html index 5f48e10f..fd9608c8 100644 Binary files a/Select-DbaDbSequenceNextValue.html and b/Select-DbaDbSequenceNextValue.html differ diff --git a/Select-DbaObject.html b/Select-DbaObject.html index 8cc9c03d..966545ba 100644 Binary files a/Select-DbaObject.html and b/Select-DbaObject.html differ diff --git a/Select-DefaultView.html b/Select-DefaultView.html new file mode 100644 index 00000000..6634adf3 --- /dev/null +++ b/Select-DefaultView.html @@ -0,0 +1,598 @@ + + + + + + + dbatools docs | Select-DefaultView + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Select-DefaultView

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Select-DefaultView [-InputObject ] [-Property <string[]>] [-ExcludeProperty <string[]>] [-TypeName ] []

+

Description

+

Syntax

+
Select-DefaultViewsyntaxItem----------{@{name=
+
+Select-DefaultView; CommonParameters=True; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-ExcludeProperty
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-InputObject
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinetrue (ByValue)
Default Value
+
-Property
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
AliasProperties
RequiredFalse
Pipelinefalse
Default Value
+
-TypeName
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Select-DefaultView on GitHub. +
+Want to see the Bill Of Health for this command? Check out Select-DefaultView.

+ +
+
+
+
+ + + diff --git a/Send-File.html b/Send-File.html new file mode 100644 index 00000000..12cf6ec4 --- /dev/null +++ b/Send-File.html @@ -0,0 +1,583 @@ + + + + + + + dbatools docs | Send-File + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Send-File

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

This function sends a file (or folder of files recursively) to a destination WinRm session. This function was originally +built by Lee Holmes (http://poshcode.org/2216) but has been modified to recursively send folders of files as well +as to support UNC paths.

+

Author: Adam Bertram +From: https://gallery.technet.microsoft.com/scriptcenter/Send-Files-or-Folders-over-273971bf

+

Description

+

Syntax

+
Send-File
+    [-Path] <String[]>
+    [-Destination] <String>
+    [-Session] <PSSession>
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > $session = New-PSSession -ComputerName MYSERVER
+Send-File -Path C:\test.txt -Destination C:\ -Session $session
+This example will copy the file C:\test.txt to be C:\test.txt on the computer MYSERVER

+

Required Parameters

+
-Path
+

The local or UNC folder path that you'd like to copy to the session. This also support multiple paths in a comma-delimited format. +If this is a UNC path, it will be copied locally to accomodate copying. If it's a folder, it will recursively copy +all files and folders to the destination.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-Destination
+

The local path on the remote computer where you'd like to copy the folder or file. If the folder does not exist on the remote +computer it will be created.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-Session
+

The remote session. Create with New-PSSession.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Send-File on GitHub. +
+Want to see the Bill Of Health for this command? Check out Send-File.

+ +
+
+
+
+ + + diff --git a/Set-DbaAgListener.html b/Set-DbaAgListener.html index 5e17ff70..3fc94ff2 100644 Binary files a/Set-DbaAgListener.html and b/Set-DbaAgListener.html differ diff --git a/Set-DbaAgReplica.html b/Set-DbaAgReplica.html index cbb3ff81..b688ab2a 100644 Binary files a/Set-DbaAgReplica.html and b/Set-DbaAgReplica.html differ diff --git a/Set-DbaAgentAlert.html b/Set-DbaAgentAlert.html index c3393a71..3396ea14 100644 Binary files a/Set-DbaAgentAlert.html and b/Set-DbaAgentAlert.html differ diff --git a/Set-DbaAgentJob.html b/Set-DbaAgentJob.html index b55ca884..7eec7b0d 100644 Binary files a/Set-DbaAgentJob.html and b/Set-DbaAgentJob.html differ diff --git a/Set-DbaAgentJobCategory.html b/Set-DbaAgentJobCategory.html index 27c798ff..9baf05ab 100644 Binary files a/Set-DbaAgentJobCategory.html and b/Set-DbaAgentJobCategory.html differ diff --git a/Set-DbaAgentJobOutputFile.html b/Set-DbaAgentJobOutputFile.html index d543884b..62e3543e 100644 Binary files a/Set-DbaAgentJobOutputFile.html and b/Set-DbaAgentJobOutputFile.html differ diff --git a/Set-DbaAgentJobOwner.html b/Set-DbaAgentJobOwner.html index 15ff9b5c..a12dae86 100644 Binary files a/Set-DbaAgentJobOwner.html and b/Set-DbaAgentJobOwner.html differ diff --git a/Set-DbaAgentJobStep.html b/Set-DbaAgentJobStep.html index 9b864aa3..ea49001c 100644 Binary files a/Set-DbaAgentJobStep.html and b/Set-DbaAgentJobStep.html differ diff --git a/Set-DbaAgentOperator.html b/Set-DbaAgentOperator.html index b62bce0f..2edc52c6 100644 Binary files a/Set-DbaAgentOperator.html and b/Set-DbaAgentOperator.html differ diff --git a/Set-DbaAgentSchedule.html b/Set-DbaAgentSchedule.html index 4f09f3f4..cb8a5f85 100644 Binary files a/Set-DbaAgentSchedule.html and b/Set-DbaAgentSchedule.html differ diff --git a/Set-DbaAgentServer.html b/Set-DbaAgentServer.html index a86a8cdc..c7df26c6 100644 Binary files a/Set-DbaAgentServer.html and b/Set-DbaAgentServer.html differ diff --git a/Set-DbaAvailabilityGroup.html b/Set-DbaAvailabilityGroup.html index 377f5ae5..90bc0439 100644 Binary files a/Set-DbaAvailabilityGroup.html and b/Set-DbaAvailabilityGroup.html differ diff --git a/Set-DbaCmConnection.html b/Set-DbaCmConnection.html index 15c14bd7..92b49543 100644 Binary files a/Set-DbaCmConnection.html and b/Set-DbaCmConnection.html differ diff --git a/Set-DbaDbCompatibility.html b/Set-DbaDbCompatibility.html index 74edc7d3..a5ce1e21 100644 Binary files a/Set-DbaDbCompatibility.html and b/Set-DbaDbCompatibility.html differ diff --git a/Set-DbaDbCompression.html b/Set-DbaDbCompression.html index 262647d7..597c6e94 100644 Binary files a/Set-DbaDbCompression.html and b/Set-DbaDbCompression.html differ diff --git a/Set-DbaDbFileGroup.html b/Set-DbaDbFileGroup.html index fa41c2b8..6bc4ba95 100644 Binary files a/Set-DbaDbFileGroup.html and b/Set-DbaDbFileGroup.html differ diff --git a/Set-DbaDbFileGrowth.html b/Set-DbaDbFileGrowth.html index c9aea110..feac4b46 100644 Binary files a/Set-DbaDbFileGrowth.html and b/Set-DbaDbFileGrowth.html differ diff --git a/Set-DbaDbIdentity.html b/Set-DbaDbIdentity.html index 45f9d04a..fe376727 100644 Binary files a/Set-DbaDbIdentity.html and b/Set-DbaDbIdentity.html differ diff --git a/Set-DbaDbMirror.html b/Set-DbaDbMirror.html index 6ec9179c..47975a76 100644 Binary files a/Set-DbaDbMirror.html and b/Set-DbaDbMirror.html differ diff --git a/Set-DbaDbOwner.html b/Set-DbaDbOwner.html index c97e8b4e..c7818616 100644 Binary files a/Set-DbaDbOwner.html and b/Set-DbaDbOwner.html differ diff --git a/Set-DbaDbQueryStoreOption.html b/Set-DbaDbQueryStoreOption.html index 00624f1b..e6d286ed 100644 Binary files a/Set-DbaDbQueryStoreOption.html and b/Set-DbaDbQueryStoreOption.html differ diff --git a/Set-DbaDbRecoveryModel.html b/Set-DbaDbRecoveryModel.html index d6468ea4..68c3bb8f 100644 Binary files a/Set-DbaDbRecoveryModel.html and b/Set-DbaDbRecoveryModel.html differ diff --git a/Set-DbaDbSchema.html b/Set-DbaDbSchema.html index b36cc5de..504c7052 100644 Binary files a/Set-DbaDbSchema.html and b/Set-DbaDbSchema.html differ diff --git a/Set-DbaDbSequence.html b/Set-DbaDbSequence.html index a091f799..e0fd53d7 100644 Binary files a/Set-DbaDbSequence.html and b/Set-DbaDbSequence.html differ diff --git a/Set-DbaDbState.html b/Set-DbaDbState.html index b4e41c36..e3b2c9ea 100644 Binary files a/Set-DbaDbState.html and b/Set-DbaDbState.html differ diff --git a/Set-DbaDefaultPath.html b/Set-DbaDefaultPath.html index 814c1b5c..eb4d9ae4 100644 Binary files a/Set-DbaDefaultPath.html and b/Set-DbaDefaultPath.html differ diff --git a/Set-DbaEndpoint.html b/Set-DbaEndpoint.html index 204d2edd..b71d600c 100644 Binary files a/Set-DbaEndpoint.html and b/Set-DbaEndpoint.html differ diff --git a/Set-DbaErrorLogConfig.html b/Set-DbaErrorLogConfig.html index 0debbad9..e00ef492 100644 Binary files a/Set-DbaErrorLogConfig.html and b/Set-DbaErrorLogConfig.html differ diff --git a/Set-DbaExtendedProperty.html b/Set-DbaExtendedProperty.html index e5bc52e6..2023202a 100644 Binary files a/Set-DbaExtendedProperty.html and b/Set-DbaExtendedProperty.html differ diff --git a/Set-DbaExtendedProtection.html b/Set-DbaExtendedProtection.html index 7727e383..3c618571 100644 Binary files a/Set-DbaExtendedProtection.html and b/Set-DbaExtendedProtection.html differ diff --git a/Set-DbaLogin.html b/Set-DbaLogin.html index ba383ce1..750d2356 100644 Binary files a/Set-DbaLogin.html and b/Set-DbaLogin.html differ diff --git a/Set-DbaMaxDop.html b/Set-DbaMaxDop.html index f1e210c7..b1bb7bed 100644 Binary files a/Set-DbaMaxDop.html and b/Set-DbaMaxDop.html differ diff --git a/Set-DbaMaxMemory.html b/Set-DbaMaxMemory.html index 6b04ba65..7e0b6c1b 100644 Binary files a/Set-DbaMaxMemory.html and b/Set-DbaMaxMemory.html differ diff --git a/Set-DbaNetworkCertificate.html b/Set-DbaNetworkCertificate.html index 02143a74..7fa780bd 100644 Binary files a/Set-DbaNetworkCertificate.html and b/Set-DbaNetworkCertificate.html differ diff --git a/Set-DbaNetworkConfiguration.html b/Set-DbaNetworkConfiguration.html index 3d98f945..763a9b22 100644 Binary files a/Set-DbaNetworkConfiguration.html and b/Set-DbaNetworkConfiguration.html differ diff --git a/Set-DbaPowerPlan.html b/Set-DbaPowerPlan.html index 2183c6cb..8d26eda5 100644 Binary files a/Set-DbaPowerPlan.html and b/Set-DbaPowerPlan.html differ diff --git a/Set-DbaPrivilege.html b/Set-DbaPrivilege.html index 6ae8a602..7b41c16b 100644 Binary files a/Set-DbaPrivilege.html and b/Set-DbaPrivilege.html differ diff --git a/Set-DbaResourceGovernor.html b/Set-DbaResourceGovernor.html index 7205ac7b..23c94d03 100644 Binary files a/Set-DbaResourceGovernor.html and b/Set-DbaResourceGovernor.html differ diff --git a/Set-DbaRgResourcePool.html b/Set-DbaRgResourcePool.html index 913540a7..d569384f 100644 Binary files a/Set-DbaRgResourcePool.html and b/Set-DbaRgResourcePool.html differ diff --git a/Set-DbaRgWorkloadGroup.html b/Set-DbaRgWorkloadGroup.html index 5d1efaa1..da8a3428 100644 Binary files a/Set-DbaRgWorkloadGroup.html and b/Set-DbaRgWorkloadGroup.html differ diff --git a/Set-DbaSpConfigure.html b/Set-DbaSpConfigure.html index f631aebe..c27ecee4 100644 Binary files a/Set-DbaSpConfigure.html and b/Set-DbaSpConfigure.html differ diff --git a/Set-DbaSpn.html b/Set-DbaSpn.html index 1932554d..b825cc59 100644 Binary files a/Set-DbaSpn.html and b/Set-DbaSpn.html differ diff --git a/Set-DbaStartupParameter.html b/Set-DbaStartupParameter.html index 2f05ecc6..bd6c018a 100644 Binary files a/Set-DbaStartupParameter.html and b/Set-DbaStartupParameter.html differ diff --git a/Set-DbaTcpPort.html b/Set-DbaTcpPort.html index 3d41c303..82e04d8e 100644 Binary files a/Set-DbaTcpPort.html and b/Set-DbaTcpPort.html differ diff --git a/Set-DbaTempDbConfig.html b/Set-DbaTempDbConfig.html index 286b5f00..15c3eec2 100644 Binary files a/Set-DbaTempDbConfig.html and b/Set-DbaTempDbConfig.html differ diff --git a/Set-DbatoolsConfig.html b/Set-DbatoolsConfig.html index 7802d4a5..8faf1256 100644 Binary files a/Set-DbatoolsConfig.html and b/Set-DbatoolsConfig.html differ diff --git a/Set-DbatoolsPath.html b/Set-DbatoolsPath.html index e1f08892..057560b0 100644 Binary files a/Set-DbatoolsPath.html and b/Set-DbatoolsPath.html differ diff --git a/Set-FileSystemSetting.html b/Set-FileSystemSetting.html new file mode 100644 index 00000000..89618fb6 --- /dev/null +++ b/Set-FileSystemSetting.html @@ -0,0 +1,598 @@ + + + + + + + dbatools docs | Set-FileSystemSetting + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Set-FileSystemSetting

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Set-FileSystemSetting [-Instance ] [-Credential ] [-ShareName ] [-FilestreamLevel ] []

+

Description

+

Syntax

+
Set-FileSystemSettingsyntaxItem----------{@{name=
+
+Set-FileSystemSetting; CommonParameters=True; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-Credential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-FilestreamLevel
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Instance
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ShareName
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Set-FileSystemSetting on GitHub. +
+Want to see the Bill Of Health for this command? Check out Set-FileSystemSetting.

+ +
+
+
+
+ + + diff --git a/Set-ServiceStartMode.html b/Set-ServiceStartMode.html new file mode 100644 index 00000000..ccf025a2 --- /dev/null +++ b/Set-ServiceStartMode.html @@ -0,0 +1,614 @@ + + + + + + + dbatools docs | Set-ServiceStartMode + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Set-ServiceStartMode

+ + + + + + + + + + + + + + + + + +
AuthorKirill Kravtsov ( @nvarscar )
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal function. Implements the method that changes startup mode of the SQL Server service.

+

Description

+

Accepts objects from Get-DbaService and performs a corresponding action.

+

Syntax

+
Set-ServiceStartMode
+    [[-Mode] <String>]
+    [-InputObject] <Object[]>
+    [-WhatIf]
+    [-Confirm]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Get-DbaService -ComputerName sql1 | Set-ServiceStartMode -Mode 'Manual'
+Sets all SQL services on sql1 to Manual startup.

+
Example: 2
+

PS > $services = Get-DbaService -ComputerName sql1
+Set-ServiceStartMode -InputObject $services -Mode 'Automatic'
+Sets all SQL services on sql1 to Automatic startup.

+

Required Parameters

+
-InputObject
+

A collection of services from Get-DbaService.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinetrue (ByValue)
Default Value
+

Optional Parameters

+
-Mode
+

Startup mode of the service: Automatic, Manual or Disabled.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-WhatIf
+

Shows what would happen if the cmdlet runs. The cmdlet is not run.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliaswi
RequiredFalse
Pipelinefalse
Default Value
+
-Confirm
+

Prompts you for confirmation before running the cmdlet.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliascf
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Set-ServiceStartMode on GitHub. +
+Want to see the Bill Of Health for this command? Check out Set-ServiceStartMode.

+ +
+
+
+
+ + + diff --git a/Show-DbaDbList.html b/Show-DbaDbList.html index 128a77cd..23672b34 100644 Binary files a/Show-DbaDbList.html and b/Show-DbaDbList.html differ diff --git a/Show-DbaInstanceFileSystem.html b/Show-DbaInstanceFileSystem.html index ae145449..757edc89 100644 Binary files a/Show-DbaInstanceFileSystem.html and b/Show-DbaInstanceFileSystem.html differ diff --git a/Show-Notification.html b/Show-Notification.html new file mode 100644 index 00000000..592ca252 --- /dev/null +++ b/Show-Notification.html @@ -0,0 +1,570 @@ + + + + + + + dbatools docs | Show-Notification + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Show-Notification

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Show-Notification [-GalleryVersion ] [-Title ] [-Text ]

+

Description

+

Syntax

+
Show-NotificationsyntaxItem----------{@{name=
+
+Show-Notification; CommonParameters=False; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-GalleryVersion
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Text
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Title
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Show-Notification on GitHub. +
+Want to see the Bill Of Health for this command? Check out Show-Notification.

+ + + + + + + + diff --git a/Start-DbaAgentJob.html b/Start-DbaAgentJob.html index e53c86bd..ddefd5c9 100644 Binary files a/Start-DbaAgentJob.html and b/Start-DbaAgentJob.html differ diff --git a/Start-DbaDbEncryption.html b/Start-DbaDbEncryption.html index 3976cf50..32cfa1c2 100644 Binary files a/Start-DbaDbEncryption.html and b/Start-DbaDbEncryption.html differ diff --git a/Start-DbaEndpoint.html b/Start-DbaEndpoint.html index e852b34a..4ef5b252 100644 Binary files a/Start-DbaEndpoint.html and b/Start-DbaEndpoint.html differ diff --git a/Start-DbaMigration.html b/Start-DbaMigration.html index 754f3f08..a8951215 100644 Binary files a/Start-DbaMigration.html and b/Start-DbaMigration.html differ diff --git a/Start-DbaPfDataCollectorSet.html b/Start-DbaPfDataCollectorSet.html index 46582523..a6ac0f6f 100644 Binary files a/Start-DbaPfDataCollectorSet.html and b/Start-DbaPfDataCollectorSet.html differ diff --git a/Start-DbaRunspace.html b/Start-DbaRunspace.html new file mode 100644 index 00000000..1885667e --- /dev/null +++ b/Start-DbaRunspace.html @@ -0,0 +1,580 @@ + + + + + + + dbatools docs | Start-DbaRunspace + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Start-DbaRunspace

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Starts a managed runspace

+

Description

+

Starts a runspace that was registered to dbatools +Simply registering does not automatically start a given runspace. Only by executing this function will it take effect.

+

Syntax

+
Start-DbaRunspace
+    [[-Name] <String[]>]
+    [[-Runspace] <RunspaceContainer[]>]
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Start-DbaRunspace -Name 'mymodule.maintenance'
+
+

Starts the runspace registered under the name 'mymodule.maintenance'

+

Optional Parameters

+
-Name
+

The name of the registered runspace to launch

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinetrue (ByValue)
Default Value
+
-Runspace
+

The runspace to launch. Returned by Get-DbaRunspace

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinetrue (ByValue)
Default Value
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Start-DbaRunspace on GitHub. +
+Want to see the Bill Of Health for this command? Check out Start-DbaRunspace.

+ +
+
+
+
+ + + diff --git a/Start-DbaService.html b/Start-DbaService.html index e0421c82..416a4d30 100644 Binary files a/Start-DbaService.html and b/Start-DbaService.html differ diff --git a/Start-DbaTrace.html b/Start-DbaTrace.html index 7cc4112d..9774f67f 100644 Binary files a/Start-DbaTrace.html and b/Start-DbaTrace.html differ diff --git a/Start-DbaXESession.html b/Start-DbaXESession.html index 093a0ac0..a95ae02c 100644 Binary files a/Start-DbaXESession.html and b/Start-DbaXESession.html differ diff --git a/Start-DbaXESmartTarget.html b/Start-DbaXESmartTarget.html index 121a0fef..e772ae9c 100644 Binary files a/Start-DbaXESmartTarget.html and b/Start-DbaXESmartTarget.html differ diff --git a/Start-DbccCheck.html b/Start-DbccCheck.html new file mode 100644 index 00000000..7be754ba --- /dev/null +++ b/Start-DbccCheck.html @@ -0,0 +1,654 @@ + + + + + + + dbatools docs | Start-DbccCheck + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Start-DbccCheck

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Start-DbccCheck [-server ] [-DbName ] [-MaxDop ] -table -WhatIf -Confirm []

+

Description

+

Syntax

+
Start-DbccChecksyntaxItem----------{@{name=
+
+Start-DbccCheck; CommonParameters=True; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-Confirm
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliascf
RequiredFalse
Pipelinefalse
Default Value
+
-DbName
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-MaxDop
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-WhatIf
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliaswi
RequiredFalse
Pipelinefalse
Default Value
+
-server
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-table
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Start-DbccCheck on GitHub. +
+Want to see the Bill Of Health for this command? Check out Start-DbccCheck.

+ + + + + + + + diff --git a/Stop-DbaAgentJob.html b/Stop-DbaAgentJob.html index 30062fd8..dd66d8c4 100644 Binary files a/Stop-DbaAgentJob.html and b/Stop-DbaAgentJob.html differ diff --git a/Stop-DbaDbEncryption.html b/Stop-DbaDbEncryption.html index ebff13a9..93564829 100644 Binary files a/Stop-DbaDbEncryption.html and b/Stop-DbaDbEncryption.html differ diff --git a/Stop-DbaEndpoint.html b/Stop-DbaEndpoint.html index cdcef1dd..9791e89a 100644 Binary files a/Stop-DbaEndpoint.html and b/Stop-DbaEndpoint.html differ diff --git a/Stop-DbaExternalProcess.html b/Stop-DbaExternalProcess.html index 3f95dda0..70b2d8ba 100644 Binary files a/Stop-DbaExternalProcess.html and b/Stop-DbaExternalProcess.html differ diff --git a/Stop-DbaPfDataCollectorSet.html b/Stop-DbaPfDataCollectorSet.html index c15a548c..0bd8c3fd 100644 Binary files a/Stop-DbaPfDataCollectorSet.html and b/Stop-DbaPfDataCollectorSet.html differ diff --git a/Stop-DbaProcess.html b/Stop-DbaProcess.html index e2f381f8..9945f239 100644 Binary files a/Stop-DbaProcess.html and b/Stop-DbaProcess.html differ diff --git a/Stop-DbaRunspace.html b/Stop-DbaRunspace.html new file mode 100644 index 00000000..a8ad6890 --- /dev/null +++ b/Stop-DbaRunspace.html @@ -0,0 +1,586 @@ + + + + + + + dbatools docs | Stop-DbaRunspace + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Stop-DbaRunspace

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Stops a managed runspace

+

Description

+

Stops a runspace that was registered to dbatools. +Will not cause errors if the runspace is already halted.

+

Runspaces may not automatically terminate immediately when calling this function. +Depending on the implementation of the scriptblock, this may in fact take a little time. +If the scriptblock hasn't finished and terminated the runspace in a seemingly time, it will be killed by the system. +This timeout is by default 30 seconds, but can be altered by using the Configuration System. +For example, this line will increase the timeout to 60 seconds: +Set-DbatoolsConfig Runspace.StopTimeout 60

+

Syntax

+
Stop-DbaRunspace
+    [[-Name] <String[]>]
+    [[-Runspace] <RunspaceContainer[]>]
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Stop-DbaRunspace -Name 'mymodule.maintenance'
+
+

Stops the runspace registered under the name 'mymodule.maintenance'

+

Optional Parameters

+
-Name
+

The name of the registered runspace to stop

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinetrue (ByValue)
Default Value
+
-Runspace
+

The runspace to stop. Returned by Get-DbaRunspace

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinetrue (ByValue)
Default Value
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Stop-DbaRunspace on GitHub. +
+Want to see the Bill Of Health for this command? Check out Stop-DbaRunspace.

+ +
+
+
+
+ + + diff --git a/Stop-DbaService.html b/Stop-DbaService.html index 1bd0878b..f642bc41 100644 Binary files a/Stop-DbaService.html and b/Stop-DbaService.html differ diff --git a/Stop-DbaTrace.html b/Stop-DbaTrace.html index f43cb6f3..4ccbaf4a 100644 Binary files a/Stop-DbaTrace.html and b/Stop-DbaTrace.html differ diff --git a/Stop-DbaXESession.html b/Stop-DbaXESession.html index edd9cfcc..41afa989 100644 Binary files a/Stop-DbaXESession.html and b/Stop-DbaXESession.html differ diff --git a/Stop-DbaXESmartTarget.html b/Stop-DbaXESmartTarget.html index d00ff46d..d4df5606 100644 Binary files a/Stop-DbaXESmartTarget.html and b/Stop-DbaXESmartTarget.html differ diff --git a/Stop-Function.html b/Stop-Function.html new file mode 100644 index 00000000..4397bc89 --- /dev/null +++ b/Stop-Function.html @@ -0,0 +1,948 @@ + + + + + + + dbatools docs | Stop-Function + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Stop-Function

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Function that interrupts a function.

+

Description

+

Function that interrupts a function.

+

This function is a utility function used by other functions to reduce error catching overhead. +It is designed to allow gracefully terminating a function with a warning by default and also allow opt-in into terminating errors. +It also allows simple integration into loops.

+

Note: +When calling this function with the intent to terminate the calling function in non-EnableException mode too, you need to add a return below the call.

+

Syntax

+
Stop-Function -Message <String>
+    [-EnableException <Boolean>]
+    [-Category {NotSpecified | OpenError | CloseError | DeviceError | DeadlockDetected | InvalidArgument | InvalidData | InvalidOperation | InvalidResult | InvalidType | MetadataError | NotImplemented | NotInstalled | ObjectNotFound | OperationStopped | OperationTimeout | SyntaxError | ParserError | PermissionDenied | ResourceBusy | ResourceExists | ResourceUnavailable | ReadError | WriteError | FromStdErr | SecurityError | ProtocolError | ConnectionError | AuthenticationError | LimitsExceeded | QuotaExceeded | NotEnabled}]
+    [-Tag <String[]>]
+    [-FunctionName <String>]
+    [-File <String>]
+    [-Line <Int32>]
+    [-Target <Object>]
+    [-Exception <Exception>]
+    [-OverrideExceptionMessage]
+    [-Continue]
+    [-SilentlyContinue]
+    [-ContinueLabel <String>]
+    [<CommonParameters>]
+
+Stop-Function -Message <String>
+    [-EnableException <Boolean>]
+    [-Category {NotSpecified | OpenError | CloseError | DeviceError | DeadlockDetected | InvalidArgument | InvalidData | InvalidOperation | InvalidResult | InvalidType | MetadataError | NotImplemented | NotInstalled | ObjectNotFound | OperationStopped | OperationTimeout | SyntaxError | ParserError | PermissionDenied | ResourceBusy | ResourceExists | ResourceUnavailable | ReadError | WriteError | FromStdErr | SecurityError | ProtocolError | ConnectionError | AuthenticationError | LimitsExceeded | QuotaExceeded | NotEnabled}]
+    [-ErrorRecord <ErrorRecord[]>]
+    [-Tag <String[]>]
+    [-FunctionName <String>]
+    [-File <String>]
+    [-Line <Int32>]
+    [-Target <Object>]
+    [-Exception <Exception>]
+    [-OverrideExceptionMessage]
+    [-Continue]
+    [-SilentlyContinue]
+    [-ContinueLabel <String>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Stop-Function -Message "Foo failed bar." -EnableException $EnableException -ErrorRecord $_
+return
+Depending on whether $EnableException is true or false it will:

+
    +
  • Throw a bloody terminating error. Game over.
    • +
  • Write a nice warning about how Foo failed bar, then terminate the function. The return on the next line will then end the calling function.
    • +
+
Example: 2
+

PS > Stop-Function -Message "Foo failed bar." -EnableException $EnableException -Category InvalidOperation -Target $foo -Continue
+Depending on whether $silent is true or false it will:

+
    +
  • Throw a bloody terminating error. Game over.
    • +
  • Write a nice warning about how Foo failed bar, then call continue to process the next item in the loop.
    +In both cases, the error record added to $error will have the content of $foo added, the better to figure out what went wrong.
    • +
+

Required Parameters

+
-Message
+

A message to pass along, explaining just what the error was.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value$EnableException
+
-Category
+

What category does this termination belong to? +Mandatory so long as no inner exception is passed.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueNotSpecified
+
-ErrorRecord
+

An option to include an inner exception in the error record (and in the exception thrown, if one is thrown). +Use this, whenever you call Stop-Function in a catch block. +Note: +Pass the full error record, not just the exception.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
AliasInnerErrorRecord
RequiredFalse
Pipelinefalse
Default Value
+
-Tag
+

Tags to add to the message written. +This allows filtering and grouping by category of message, targeting specific messages.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-FunctionName
+

The name of the function to crash. +This parameter is very optional, since it automatically selects the name of the calling function. +The function name is used as part of the errorid. +That in turn allows easily figuring out, which exception belonged to which function when checking out the $error variable.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value((Get-PSCallStack)[0].Command)
+
-File
+

The file in which Stop-Function was called. +Will be automatically set, but can be overridden when necessary.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Line
+

The line on which Stop-Function was called. +Will be automatically set, but can be overridden when necessary.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value0
+
-Target
+

The object that was processed when the error was thrown. +For example, if you were trying to process a Database Server object when the processing failed, add the object here. +This object will be in the error record (which will be written, even in non-EnableException mode, just won't show it). +If you specify such an object, it becomes simple to actually figure out, just where things failed at.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Exception
+

Allows specifying an inner exception as input object. This will be passed on to the logging and used for messages. +When specifying both ErrorRecord AND Exception, Exception wins, but ErrorRecord is still used for record metadata.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-OverrideExceptionMessage
+

Disables automatic appending of exception messages. +Use in cases where you already have a speaking message interpretation and do not need the original message.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-Continue
+

This will cause the function to call continue while not running silently. +Useful when mass-processing items where an error shouldn't break the loop.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-SilentlyContinue
+

This will cause the function to call continue while running silently. +Useful when mass-processing items where an error shouldn't break the loop.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-ContinueLabel
+

When specifying a label in combination with "-Continue" or "-SilentlyContinue", this function will call continue with this specified label. +Helpful when trying to continue on an upper level named loop.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Stop-Function on GitHub. +
+Want to see the Bill Of Health for this command? Check out Stop-Function.

+ +
+
+
+
+ + + diff --git a/Suspend-DbaAgDbDataMovement.html b/Suspend-DbaAgDbDataMovement.html index 781e9c69..a184a5d3 100644 Binary files a/Suspend-DbaAgDbDataMovement.html and b/Suspend-DbaAgDbDataMovement.html differ diff --git a/Sync-DbaAvailabilityGroup.html b/Sync-DbaAvailabilityGroup.html index 71011c76..6b6c35c9 100644 Binary files a/Sync-DbaAvailabilityGroup.html and b/Sync-DbaAvailabilityGroup.html differ diff --git a/Sync-DbaLoginPermission.html b/Sync-DbaLoginPermission.html index 49303905..c3e788b8 100644 Binary files a/Sync-DbaLoginPermission.html and b/Sync-DbaLoginPermission.html differ diff --git a/Test-Bound.html b/Test-Bound.html new file mode 100644 index 00000000..c2c334c8 --- /dev/null +++ b/Test-Bound.html @@ -0,0 +1,679 @@ + + + + + + + dbatools docs | Test-Bound + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Test-Bound

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Helper function that tests if a parameter was bound.

+

Description

+

Helper function that tests if one or more parameters was bound.

+

Syntax

+
Test-Bound
+    [[-ParameterName] <String[]>]
+    [-Not]
+    [-And]
+    [[-Min] <Int32>]
+    [[-Max] <Int32>]
+    [[-BoundParameters] <Object>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > if (Test-Bound "Day")
+{
+}
+Snippet as part of a function. Will check whether the parameter "Day" was bound. If yes, whatever logic is in the conditional will be executed.

+
Example: 2
+

PS > Test-Bound -Not 'Login', 'Spid', 'ExcludeSpid', 'Host', 'Program', 'Database'
+Returns whether none of the parameters above were specified.

+
Example: 3
+

PS > Test-Bound -And 'Login', 'Spid', 'ExcludeSpid', 'Host', 'Program', 'Database'
+Returns whether any of the specified parameters was not bound.

+
Example: 4
+

PS > Test-Bound -ParameterName 'MinimumBuild', 'MaxBehind', 'Latest' -Max 1
+Tests for mutually exclusive but necessary parameters.

+
Example: 5
+

PS > Test-Bound -ParameterName 'Database', 'AllDatabases', 'ExcludeDatabase' -Min 0 -Max 1
+Tests for mutually exclusive but optional parameters.
+Do not be tempted to use [CmdletBinding()] here, this will subtly change the way this function's parameters are bound, and break it.

+

Optional Parameters

+
-ParameterName
+

The name(s) of the parameter that is tested for being bound. +By default, the check is true when AT LEAST one was bound.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Not
+

Reverses the result. Returns true if NOT bound and false if bound.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
AliasReverse
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-And
+

All specified parameters must be present, rather than at least one of them.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-Min
+

At least the specified number of parameters out of the specified parameters must be present. Default is 1.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value1
+
-Max
+

A maximum of the specified number of parameters out of the specified parameters may be present. Default is the length of ParameterName.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value$ParameterName.Length
+
-BoundParameters
+

The hashtable of bound parameters. Is automatically inherited from the calling function via default value. Needs not be bound explicitly.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value$($ExecutionContext.SessionState.PSVariable.Get('psboundparameters').Value)
+

 

+

Want to see the source code for this command? Check out Test-Bound on GitHub. +
+Want to see the Bill Of Health for this command? Check out Test-Bound.

+ +
+
+
+
+ + + diff --git a/Test-ComputerTarget.html b/Test-ComputerTarget.html new file mode 100644 index 00000000..abb13113 --- /dev/null +++ b/Test-ComputerTarget.html @@ -0,0 +1,534 @@ + + + + + + + dbatools docs | Test-ComputerTarget + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Test-ComputerTarget

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Validates whether the input string can be legally used to target a computer.

+

Description

+

Validates whether the input string can be legally used to target a computer. +It will consider:

+
    +
  • Names (NETBIOS/dns)
    • +
  • IPv4 Addresses
    • +
  • IPv6 Addresses +It will resolve idn names into default ascii names according to the official rules, before rendering judgement.
    • +
+

Syntax

+
Test-ComputerTarget
+    [-ComputerName] <String[]>
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Test-ComputerTarget -ComputerName 'server1'
+
+

Will test whether 'server1' is a legal computername (hint: it is)

+
Example: 2
+
PS C:\> "foo", "bar", "foo bar" | Test-ComputerTarget
+
+

Will test, whether the names passed to it are legal targets.

+
    +
  • The first two will pass, the last one will fail
    • +
  • Note that it will only return boolean values, so the order needs to be remembered (due to this, using it by pipeline on more than one object is not really recommended).
    • +
+

Required Parameters

+
-ComputerName
+

The name to verify

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinetrue (ByValue)
Default Value
+

 

+

Want to see the source code for this command? Check out Test-ComputerTarget on GitHub. +
+Want to see the Bill Of Health for this command? Check out Test-ComputerTarget.

+ +
+
+
+
+ + + diff --git a/Test-DbaAgentJobOwner.html b/Test-DbaAgentJobOwner.html index d336c63c..e7b0b02c 100644 Binary files a/Test-DbaAgentJobOwner.html and b/Test-DbaAgentJobOwner.html differ diff --git a/Test-DbaAvailabilityGroup.html b/Test-DbaAvailabilityGroup.html index b60bdee8..25b92b5d 100644 Binary files a/Test-DbaAvailabilityGroup.html and b/Test-DbaAvailabilityGroup.html differ diff --git a/Test-DbaBackupEncrypted.html b/Test-DbaBackupEncrypted.html index 5edfaf99..192b74b9 100644 Binary files a/Test-DbaBackupEncrypted.html and b/Test-DbaBackupEncrypted.html differ diff --git a/Test-DbaBackupInformation.html b/Test-DbaBackupInformation.html index 4d792eaf..bbf45bb8 100644 Binary files a/Test-DbaBackupInformation.html and b/Test-DbaBackupInformation.html differ diff --git a/Test-DbaBuild.html b/Test-DbaBuild.html index 877c5195..fde8aaa7 100644 Binary files a/Test-DbaBuild.html and b/Test-DbaBuild.html differ diff --git a/Test-DbaCmConnection.html b/Test-DbaCmConnection.html index 54099c69..5299d9d3 100644 Binary files a/Test-DbaCmConnection.html and b/Test-DbaCmConnection.html differ diff --git a/Test-DbaComputerCertificateExpiration.html b/Test-DbaComputerCertificateExpiration.html index 1be60c28..8557506b 100644 Binary files a/Test-DbaComputerCertificateExpiration.html and b/Test-DbaComputerCertificateExpiration.html differ diff --git a/Test-DbaConnection.html b/Test-DbaConnection.html index 806bbfe6..0db22156 100644 Binary files a/Test-DbaConnection.html and b/Test-DbaConnection.html differ diff --git a/Test-DbaConnectionAuthScheme.html b/Test-DbaConnectionAuthScheme.html index 5c0fb7da..3ba00856 100644 Binary files a/Test-DbaConnectionAuthScheme.html and b/Test-DbaConnectionAuthScheme.html differ diff --git a/Test-DbaDbCollation.html b/Test-DbaDbCollation.html index 31cdb3d2..f09389c1 100644 Binary files a/Test-DbaDbCollation.html and b/Test-DbaDbCollation.html differ diff --git a/Test-DbaDbCompatibility.html b/Test-DbaDbCompatibility.html index 796170b3..8e4231b2 100644 Binary files a/Test-DbaDbCompatibility.html and b/Test-DbaDbCompatibility.html differ diff --git a/Test-DbaDbCompression.html b/Test-DbaDbCompression.html index c44d8365..1b085fe2 100644 Binary files a/Test-DbaDbCompression.html and b/Test-DbaDbCompression.html differ diff --git a/Test-DbaDbDataGeneratorConfig.html b/Test-DbaDbDataGeneratorConfig.html index 9a103085..495dde9d 100644 Binary files a/Test-DbaDbDataGeneratorConfig.html and b/Test-DbaDbDataGeneratorConfig.html differ diff --git a/Test-DbaDbDataMaskingConfig.html b/Test-DbaDbDataMaskingConfig.html index 1af23837..b94bb5d3 100644 Binary files a/Test-DbaDbDataMaskingConfig.html and b/Test-DbaDbDataMaskingConfig.html differ diff --git a/Test-DbaDbLogShipStatus.html b/Test-DbaDbLogShipStatus.html index 5e67cae5..c29d68db 100644 Binary files a/Test-DbaDbLogShipStatus.html and b/Test-DbaDbLogShipStatus.html differ diff --git a/Test-DbaDbOwner.html b/Test-DbaDbOwner.html index 1bc6e18d..044507b2 100644 Binary files a/Test-DbaDbOwner.html and b/Test-DbaDbOwner.html differ diff --git a/Test-DbaDbQueryStore.html b/Test-DbaDbQueryStore.html index 364ccbdf..9fdbe4de 100644 Binary files a/Test-DbaDbQueryStore.html and b/Test-DbaDbQueryStore.html differ diff --git a/Test-DbaDbRecoveryModel.html b/Test-DbaDbRecoveryModel.html index 8d27720f..93bf868c 100644 Binary files a/Test-DbaDbRecoveryModel.html and b/Test-DbaDbRecoveryModel.html differ diff --git a/Test-DbaDeprecatedFeature.html b/Test-DbaDeprecatedFeature.html index d2a1ff93..e0567c05 100644 Binary files a/Test-DbaDeprecatedFeature.html and b/Test-DbaDeprecatedFeature.html differ diff --git a/Test-DbaDeprecation.html b/Test-DbaDeprecation.html new file mode 100644 index 00000000..ca71e876 --- /dev/null +++ b/Test-DbaDeprecation.html @@ -0,0 +1,716 @@ + + + + + + + dbatools docs | Test-DbaDeprecation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Test-DbaDeprecation

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Tests whether a function or one of its parameters was called by a bad name.

+

Description

+

Tests whether a function or one of its parameters was called by a bad name. +This allows giving deprecation warnings - once per session - whenever a user uses something we are planning on removing.

+

For example, when renaming a function, we give a grace period by adding an Alias for that function with its old name. +However, we do not want to carry along this alias forever, so we give warning ahead of time using this function. +When reaching the specified version, we then can safely remove the alias.

+

Furthermore, this function is used for testing, whether such a removal was properly done.

+

Syntax

+
Test-DbaDeprecation -DeprecatedOn <Version>
+    [-FunctionName <String>]
+    [-Call <Object>] -Parameter <String>
+    [-CustomMessage <String>]
+    [-EnableException <Boolean>]
+    [<CommonParameters>]
+
+Test-DbaDeprecation -DeprecatedOn <Version>
+    [-FunctionName <String>]
+    [-Call <Object>] -Alias <String>
+    [-CustomMessage <String>]
+    [-EnableException <Boolean>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Test-DbaDeprecation -DeprecatedOn "1.0.0.0" -Parameter 'Details'
+
+

Will - once per session - complain if the parameter 'Details' is used.
+Will cause tests to fail, if it's still in the code after release 1.0.0.0.

+
Example: 2
+
PS C:\> Test-DbaDeprecation -DeprecatedOn "1.0.0.0" -Alias Copy-SqlDatabase
+
+

Will - once per session - complain if the alias 'Copy-SqlDatabase' is used.
+Will cause tests to fail, if it's still in the code after release 1.0.0.0.

+

Required Parameters

+
-DeprecatedOn
+

The version this parameter or alias will be removed in. +Generally, deprecated parameters and aliases should only be removed on major releases.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-Parameter
+

The parameter that has become deprecated. +On renamed parameters, keep a parameter-alias. This function will notice, when the alias is used.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-Alias
+

The alias of the command that will be deprecated.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-FunctionName
+

Automatically filled with the calling function. +The name of the function that contains either a deprecated alias or parameter.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value(Get-PSCallStack)[0].Command
+
-Call
+

The InvocationInfo of the calling function. +Automatically filled.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value(Get-PSCallStack)[0].InvocationInfo
+
-CustomMessage
+

This function will generate a default message. However, this may not always be appropriate. +Use CustomMessage to tailor a response to the necessity of the moment.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value$EnableException
+

 

+

Want to see the source code for this command? Check out Test-DbaDeprecation on GitHub. +
+Want to see the Bill Of Health for this command? Check out Test-DbaDeprecation.

+ +
+
+
+
+ + + diff --git a/Test-DbaDiskAlignment.html b/Test-DbaDiskAlignment.html index 854c0d6d..982558db 100644 Binary files a/Test-DbaDiskAlignment.html and b/Test-DbaDiskAlignment.html differ diff --git a/Test-DbaDiskAllocation.html b/Test-DbaDiskAllocation.html index 1b393c16..50689034 100644 Binary files a/Test-DbaDiskAllocation.html and b/Test-DbaDiskAllocation.html differ diff --git a/Test-DbaDiskSpeed.html b/Test-DbaDiskSpeed.html index c1031c23..156d0c5f 100644 Binary files a/Test-DbaDiskSpeed.html and b/Test-DbaDiskSpeed.html differ diff --git a/Test-DbaEndpoint.html b/Test-DbaEndpoint.html index 73a81cb7..126df254 100644 Binary files a/Test-DbaEndpoint.html and b/Test-DbaEndpoint.html differ diff --git a/Test-DbaIdentityUsage.html b/Test-DbaIdentityUsage.html index 9a37885f..29da290d 100644 Binary files a/Test-DbaIdentityUsage.html and b/Test-DbaIdentityUsage.html differ diff --git a/Test-DbaInstanceName.html b/Test-DbaInstanceName.html index 1689b4fd..7dfc2303 100644 Binary files a/Test-DbaInstanceName.html and b/Test-DbaInstanceName.html differ diff --git a/Test-DbaLastBackup.html b/Test-DbaLastBackup.html index 046d1602..19dda04d 100644 Binary files a/Test-DbaLastBackup.html and b/Test-DbaLastBackup.html differ diff --git a/Test-DbaLinkedServerConnection.html b/Test-DbaLinkedServerConnection.html index cf3a3c9a..011379ed 100644 Binary files a/Test-DbaLinkedServerConnection.html and b/Test-DbaLinkedServerConnection.html differ diff --git a/Test-DbaLoginPassword.html b/Test-DbaLoginPassword.html index afda1587..fac984dc 100644 Binary files a/Test-DbaLoginPassword.html and b/Test-DbaLoginPassword.html differ diff --git a/Test-DbaLsnChain.html b/Test-DbaLsnChain.html new file mode 100644 index 00000000..79a21524 --- /dev/null +++ b/Test-DbaLsnChain.html @@ -0,0 +1,585 @@ + + + + + + + dbatools docs | Test-DbaLsnChain + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Test-DbaLsnChain

+ + + + + + + + + + + + + + + + + +
AuthorStuart Moore (@napalmgram), stuart-moore.com
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Checks that a filtered array from Get-FilteredRestore contains a restorabel chain of LSNs

+

Description

+

Finds the anchoring Full backup (or multiple if it's a striped set). +Then filters to ensure that all the backups are from that anchor point (LastLSN) and that they're all on the same RecoveryForkID +Then checks that we have either enough Diffs and T-log backups to get to where we want to go. And checks that there is no break between +LastLSN and FirstLSN in sequential files

+

Syntax

+
Test-DbaLsnChain
+    [-FilteredRestoreFiles] <Object[]>
+    [-Continue]
+    [-EnableException]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Test-DbaLsnChain -FilteredRestoreFiles $FilteredFiles
+Checks that the Restore chain in $FilteredFiles is complete and can be fully restored

+

Required Parameters

+
-FilteredRestoreFiles
+

This is just an object consisting of the output from Read-DbaBackupHeader. Normally this will have been filtered down to a restorable chain +before arriving here. (ie; only 1 anchoring Full backup)

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinetrue (ByValue)
Default Value
+

Optional Parameters

+
-Continue
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-EnableException
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Test-DbaLsnChain on GitHub. +
+Want to see the Bill Of Health for this command? Check out Test-DbaLsnChain.

+ +
+
+
+
+ + + diff --git a/Test-DbaManagementObject.html b/Test-DbaManagementObject.html index bb6ed6b6..63563b2d 100644 Binary files a/Test-DbaManagementObject.html and b/Test-DbaManagementObject.html differ diff --git a/Test-DbaMaxDop.html b/Test-DbaMaxDop.html index ba252063..51972220 100644 Binary files a/Test-DbaMaxDop.html and b/Test-DbaMaxDop.html differ diff --git a/Test-DbaMaxMemory.html b/Test-DbaMaxMemory.html index 22aa325e..0b5b3225 100644 Binary files a/Test-DbaMaxMemory.html and b/Test-DbaMaxMemory.html differ diff --git a/Test-DbaMigrationConstraint.html b/Test-DbaMigrationConstraint.html index 2f6b8373..7053aacf 100644 Binary files a/Test-DbaMigrationConstraint.html and b/Test-DbaMigrationConstraint.html differ diff --git a/Test-DbaNetworkLatency.html b/Test-DbaNetworkLatency.html index d7d07b0b..578bea3b 100644 Binary files a/Test-DbaNetworkLatency.html and b/Test-DbaNetworkLatency.html differ diff --git a/Test-DbaOptimizeForAdHoc.html b/Test-DbaOptimizeForAdHoc.html index af49e622..4b812459 100644 Binary files a/Test-DbaOptimizeForAdHoc.html and b/Test-DbaOptimizeForAdHoc.html differ diff --git a/Test-DbaPath.html b/Test-DbaPath.html index 1b392213..29606d92 100644 Binary files a/Test-DbaPath.html and b/Test-DbaPath.html differ diff --git a/Test-DbaPowerPlan.html b/Test-DbaPowerPlan.html index 7c7129b0..41289a6a 100644 Binary files a/Test-DbaPowerPlan.html and b/Test-DbaPowerPlan.html differ diff --git a/Test-DbaRepLatency.html b/Test-DbaRepLatency.html index f4a7f1d4..538ea8d7 100644 Binary files a/Test-DbaRepLatency.html and b/Test-DbaRepLatency.html differ diff --git a/Test-DbaRestoreVersion.html b/Test-DbaRestoreVersion.html new file mode 100644 index 00000000..891bdf7c --- /dev/null +++ b/Test-DbaRestoreVersion.html @@ -0,0 +1,614 @@ + + + + + + + dbatools docs | Test-DbaRestoreVersion + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Test-DbaRestoreVersion

+ + + + + + + + + + + + + + + + + +
AuthorStuart Moore (@napalmgram), stuart-moore.com
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Checks that the restore files are from a version of SQL Server that can be restored on the target version

+

Description

+

Finds the anchoring Full backup (or multiple if it's a striped set). +Then filters to ensure that all the backups are from that anchor point (LastLSN) and that they're all on the same RecoveryForkID +Then checks that we have either enough Diffs and T-log backups to get to where we want to go. And checks that there is no break between +LastLSN and FirstLSN in sequential files

+

Syntax

+
Test-DbaRestoreVersion
+    [-SqlInstance] <Object>
+    [-FilteredRestoreFiles] <Object[]>
+    [[-SqlCredential] <PSCredential>]
+    [-SystemDatabaseRestore]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > Test-DbaRestoreVersion -FilteredRestoreFiles $FilteredFiles -SqlInstance server1\instance1
+Checks that the Restore chain in $FilteredFiles is compatible with the SQL Server version of server1\instance1

+

Required Parameters

+
-SqlInstance
+

Sql Server Instance against which the restore is going to be performed

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-FilteredRestoreFiles
+

This is just an object consisting of the output from Read-DbaBackupHeader. Normally this will have been filtered down to a restorable chain +before arriving here. (ie; only 1 anchoring Full backup)

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-SqlCredential
+

Credential for connecting to SqlInstance

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-SystemDatabaseRestore
+

Switch when restoring system databases

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Test-DbaRestoreVersion on GitHub. +
+Want to see the Bill Of Health for this command? Check out Test-DbaRestoreVersion.

+ +
+
+
+
+ + + diff --git a/Test-DbaSpn.html b/Test-DbaSpn.html index afdf9837..0998e658 100644 Binary files a/Test-DbaSpn.html and b/Test-DbaSpn.html differ diff --git a/Test-DbaTempDbConfig.html b/Test-DbaTempDbConfig.html index a1aad491..363f99ea 100644 Binary files a/Test-DbaTempDbConfig.html and b/Test-DbaTempDbConfig.html differ diff --git a/Test-DbaWindowsLogin.html b/Test-DbaWindowsLogin.html index 4416378f..d0350591 100644 Binary files a/Test-DbaWindowsLogin.html and b/Test-DbaWindowsLogin.html differ diff --git a/Test-ElevationRequirement.html b/Test-ElevationRequirement.html new file mode 100644 index 00000000..310eff15 --- /dev/null +++ b/Test-ElevationRequirement.html @@ -0,0 +1,684 @@ + + + + + + + dbatools docs | Test-ElevationRequirement + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Test-ElevationRequirement

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Command that tests, whether the process runs elevated and has to run as such.

+

Description

+

Command that tests, whether the process runs elevated and has to run as such. +Some commands require to be run elevated, when executed against localhost, but not when run against a remote computer. +This command handles that test and manages the reaction to it.

+

Syntax

+
Test-ElevationRequirement
+    [-ComputerName <DbaInstanceParameter>]
+    [-Continue]
+    [-ContinueLabel <String>]
+    [-SilentlyContinue]
+    [-EnableException <Boolean>]
+    [<CommonParameters>]
+
+Test-ElevationRequirement
+    [-ComputerName <DbaInstanceParameter>]
+    [-NoStop]
+    [-EnableException <Boolean>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > $null = Test-ElevationRequirement -ComputerName $instance -Continue
+This will test whether the currently processed instance is localhost and the process is running elevated.
+If it should have elevation but is not running with elevation:

+
    +
  • In silent mode it will terminate with an exception
    • +
  • In default mode, it will continue with the next instance
    • +
+
Example: 2
+

PS > if (-not ( Test-ElevationRequirement -ComputerName $instance -NoStop)) {
+# Do whatever
+}
+This will test whether the currently processed instance is localhost and the process is running elevated.
+If it isn't running elevated but should be, the overall condition will be met and the if-block is executed.

+

Optional Parameters

+
-ComputerName
+

The computer that is being targeted by the calling command. +This must be a localhost variety, for it to be able to fail.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Continue
+

When using the native capability to terminate on fail, this will call continue in non-EnableException mode.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-ContinueLabel
+

When using the native capability to terminate on fail, and using a continue mode, the continue will continue with this label.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-SilentlyContinue
+

When using the native capability to terminate on fail, this will call continue in EnableException mode.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-NoStop
+

Does not call stop-function when the test fails, rather only returns $false instead

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value$EnableException
+

 

+

Want to see the source code for this command? Check out Test-ElevationRequirement on GitHub. +
+Want to see the Bill Of Health for this command? Check out Test-ElevationRequirement.

+ +
+
+
+
+ + + diff --git a/Test-ExportDirectory.html b/Test-ExportDirectory.html new file mode 100644 index 00000000..9d4b0e79 --- /dev/null +++ b/Test-ExportDirectory.html @@ -0,0 +1,514 @@ + + + + + + + dbatools docs | Test-ExportDirectory + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Test-ExportDirectory

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Test-ExportDirectory [-Path ]

+

Description

+

Syntax

+
Test-ExportDirectorysyntaxItem----------{@{name=
+
+Test-ExportDirectory; CommonParameters=False; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-Path
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Test-ExportDirectory on GitHub. +
+Want to see the Bill Of Health for this command? Check out Test-ExportDirectory.

+ + + + + + + + diff --git a/Test-FunctionInterrupt.html b/Test-FunctionInterrupt.html new file mode 100644 index 00000000..60c9f1ad --- /dev/null +++ b/Test-FunctionInterrupt.html @@ -0,0 +1,494 @@ + + + + + + + dbatools docs | Test-FunctionInterrupt + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Test-FunctionInterrupt

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal tool, used to gracefully interrupt a function.

+

Description

+

This helper function is designed to work in tandem with Stop-Function. +When gracefully terminating a function, there is a major issue: +"Return" will only stop the current one of the three blocks (Begin, Process, End). +All other statements have side effects or produce lots of red text.

+

So, Stop-Function writes a variable into the parent scope, that signals the function should cease. +This function then checks for that very variable and returns true if it is set.

+

This avoids having to handle odd variables in the parent function and causes the least impact on contributors.

+

Syntax

+
Test-FunctionInterrupt
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > if (Test-FunctionInterrupt)
+The calling function will stop if this function returns true.

+

 

+

Want to see the source code for this command? Check out Test-FunctionInterrupt on GitHub. +
+Want to see the Bill Of Health for this command? Check out Test-FunctionInterrupt.

+ +
+
+
+
+ + + diff --git a/Test-HostOSLinux.html b/Test-HostOSLinux.html new file mode 100644 index 00000000..48c2457d --- /dev/null +++ b/Test-HostOSLinux.html @@ -0,0 +1,542 @@ + + + + + + + dbatools docs | Test-HostOSLinux + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Test-HostOSLinux

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Test-HostOSLinux [-SqlInstance ] [-SqlCredential ]

+

Description

+

Syntax

+
Test-HostOSLinuxsyntaxItem----------{@{name=
+
+Test-HostOSLinux; CommonParameters=False; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-SqlCredential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-SqlInstance
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Test-HostOSLinux on GitHub. +
+Want to see the Bill Of Health for this command? Check out Test-HostOSLinux.

+ + + + + + + + diff --git a/Test-PSRemoting.html b/Test-PSRemoting.html new file mode 100644 index 00000000..ca78265a --- /dev/null +++ b/Test-PSRemoting.html @@ -0,0 +1,571 @@ + + + + + + + dbatools docs | Test-PSRemoting + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Test-PSRemoting

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Test-PSRemoting -ComputerName [-Credential ] -EnableException []

+

Description

+

Syntax

+
Test-PSRemotingsyntaxItem----------{@{name=
+
+Test-PSRemoting; CommonParameters=True; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-ComputerName
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinetrue (ByValue)
Default Value
+

Optional Parameters

+
-Credential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-EnableException
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Test-PSRemoting on GitHub. +
+Want to see the Bill Of Health for this command? Check out Test-PSRemoting.

+ + + + + + + + diff --git a/Test-PendingReboot.html b/Test-PendingReboot.html new file mode 100644 index 00000000..ba93a30d --- /dev/null +++ b/Test-PendingReboot.html @@ -0,0 +1,577 @@ + + + + + + + dbatools docs | Test-PendingReboot + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Test-PendingReboot

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Based on https://github.com/adbertram/PSSqlUpdater +This function tests various registry values to see if the local computer is pending a reboot

+

Description

+

Syntax

+
Test-PendingReboot
+    [-ComputerName] <DbaInstanceParameter>
+    [[-Credential] <PSCredential>]
+    [-NoPendingRename]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS>Test-PendingReboot
+This example checks various registry values to see if the local computer is pending a reboot.

+

Required Parameters

+
-ComputerName
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-Credential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-NoPendingRename
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Test-PendingReboot on GitHub. +
+Want to see the Bill Of Health for this command? Check out Test-PendingReboot.

+ +
+
+
+
+ + + diff --git a/Test-PsVersion.html b/Test-PsVersion.html new file mode 100644 index 00000000..4aadf168 --- /dev/null +++ b/Test-PsVersion.html @@ -0,0 +1,591 @@ + + + + + + + dbatools docs | Test-PsVersion + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Test-PsVersion

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal tool, used to detect the version of PowerShell

+

Description

+

We still support PS3 and as future continues we will have to maintain code base for PS3 and code base for newer versions of PowerShell. This is just easier function to use for validating version of PS with if/else statements

+

Syntax

+
Test-PsVersion
+    [[-Is] <Single>]
+    [[-Minimum] <Single>]
+    [[-Maximum] <Single>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> if (Test-PsVersion -Is 3) {
+>> #do something
+>> }
+
+

The calling function will only execute code if PS version is 3.0.

+
Example: 2
+
PS C:\> if (Test-PsVersion -Minimum 4) {
+>> #do something
+>> }
+
+

The calling function will only execute code if PS version is 4.0 or higher.

+
Example: 3
+
PS C:\> if (Test-PsVersion -Minimum 3 -Maximum 5.1) {
+>> #do something
+>> }
+
+

The calling function will only execute code if PS version is found to be between 3.0 and 5 (could include 5.0 or 5.1).

+

Optional Parameters

+
-Is
+

Use to only allow specific version of PowerShell

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value0
+
-Minimum
+

Use to allow for minimum version

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value0
+
-Maximum
+

Use to allow for maximum version

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value0
+

 

+

Want to see the source code for this command? Check out Test-PsVersion on GitHub. +
+Want to see the Bill Of Health for this command? Check out Test-PsVersion.

+ +
+
+
+
+ + + diff --git a/Test-ShouldProcess.html b/Test-ShouldProcess.html new file mode 100644 index 00000000..77c9795f --- /dev/null +++ b/Test-ShouldProcess.html @@ -0,0 +1,573 @@ + + + + + + + dbatools docs | Test-ShouldProcess + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Test-ShouldProcess

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal function. To use instead of $PSCmdlet.ShouldProcess($x, "Message") as +Test-ShouldProcess -Context $PSCmdlet -Target $x -Action "Message"

+

Description

+

Syntax

+
Test-ShouldProcess
+    [[-Context] <Object>]
+    [[-Target] <String>]
+    [[-Action] <String>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-Context
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Target
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Action
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Test-ShouldProcess on GitHub. +
+Want to see the Bill Of Health for this command? Check out Test-ShouldProcess.

+ +
+
+
+
+ + + diff --git a/Test-SqlAgent.html b/Test-SqlAgent.html new file mode 100644 index 00000000..e87758a4 --- /dev/null +++ b/Test-SqlAgent.html @@ -0,0 +1,544 @@ + + + + + + + dbatools docs | Test-SqlAgent + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Test-SqlAgent

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal function. Checks to see if SQL Server Agent is running on a server.

+

Description

+

Syntax

+
Test-SqlAgent
+    [-SqlInstance] <Object>
+    [[-SqlCredential] <PSCredential>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-SqlInstance
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-SqlCredential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Test-SqlAgent on GitHub. +
+Want to see the Bill Of Health for this command? Check out Test-SqlAgent.

+ +
+
+
+
+ + + diff --git a/Test-SqlLoginAccess.html b/Test-SqlLoginAccess.html new file mode 100644 index 00000000..ca12a1e0 --- /dev/null +++ b/Test-SqlLoginAccess.html @@ -0,0 +1,573 @@ + + + + + + + dbatools docs | Test-SqlLoginAccess + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Test-SqlLoginAccess

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal function. Ensures login has access on SQL Server.

+

Description

+

Syntax

+
Test-SqlLoginAccess
+    [-SqlInstance] <Object>
+    [[-SqlCredential] <PSCredential>]
+    [[-Login] <String>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-SqlInstance
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-SqlCredential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Login
+

[switch]$Detailed - can return if its a login or just has access

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Test-SqlLoginAccess on GitHub. +
+Want to see the Bill Of Health for this command? Check out Test-SqlLoginAccess.

+ +
+
+
+
+ + + diff --git a/Test-SqlQueryComplete.html b/Test-SqlQueryComplete.html new file mode 100644 index 00000000..2f6780ad --- /dev/null +++ b/Test-SqlQueryComplete.html @@ -0,0 +1,570 @@ + + + + + + + dbatools docs | Test-SqlQueryComplete + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Test-SqlQueryComplete

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Test-SqlQueryComplete [-server ] [-sql ] -checkpid

+

Description

+

Syntax

+
Test-SqlQueryCompletesyntaxItem----------{@{name=
+
+Test-SqlQueryComplete; CommonParameters=False; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-checkpid
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-server
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
AliasSqlInstance,SqlServer
RequiredFalse
Pipelinefalse
Default Value
+
-sql
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Test-SqlQueryComplete on GitHub. +
+Want to see the Bill Of Health for this command? Check out Test-SqlQueryComplete.

+ + + + + + + + diff --git a/Test-SqlSa.html b/Test-SqlSa.html new file mode 100644 index 00000000..680a523a --- /dev/null +++ b/Test-SqlSa.html @@ -0,0 +1,544 @@ + + + + + + + dbatools docs | Test-SqlSa + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Test-SqlSa

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal function. Ensures sysadmin account access on SQL Server.

+

Description

+

Syntax

+
Test-SqlSa
+    [-SqlInstance] <Object>
+    [[-SqlCredential] <PSCredential>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-SqlInstance
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-SqlCredential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Test-SqlSa on GitHub. +
+Want to see the Bill Of Health for this command? Check out Test-SqlSa.

+ +
+
+
+
+ + + diff --git a/Test-Windows.html b/Test-Windows.html new file mode 100644 index 00000000..13ce04ff --- /dev/null +++ b/Test-Windows.html @@ -0,0 +1,518 @@ + + + + + + + dbatools docs | Test-Windows + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Test-Windows

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal tool, used to detect non-Windows platforms

+

Description

+

Some things don't work with Windows, this is an easy way to detect

+

Syntax

+
Test-Windows
+    [-NoWarn]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > if (-not (Test-Windows))
+The calling function will stop if this function returns true.

+

Optional Parameters

+
-NoWarn
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Test-Windows on GitHub. +
+Want to see the Bill Of Health for this command? Check out Test-Windows.

+ +
+
+
+
+ + + diff --git a/Uninstall-DbaSqlWatch.html b/Uninstall-DbaSqlWatch.html index 17cbbbe2..6c351f58 100644 Binary files a/Uninstall-DbaSqlWatch.html and b/Uninstall-DbaSqlWatch.html differ diff --git a/Uninstall-DbatoolsWatchUpdate.html b/Uninstall-DbatoolsWatchUpdate.html index 1f8261a7..bceb5153 100644 Binary files a/Uninstall-DbatoolsWatchUpdate.html and b/Uninstall-DbatoolsWatchUpdate.html differ diff --git a/Unregister-DbatoolsConfig.html b/Unregister-DbatoolsConfig.html index 302caa50..5a7a035c 100644 Binary files a/Unregister-DbatoolsConfig.html and b/Unregister-DbatoolsConfig.html differ diff --git a/Unregister-RemoteSessionConfiguration.html b/Unregister-RemoteSessionConfiguration.html new file mode 100644 index 00000000..ed95cc47 --- /dev/null +++ b/Unregister-RemoteSessionConfiguration.html @@ -0,0 +1,632 @@ + + + + + + + dbatools docs | Unregister-RemoteSessionConfiguration + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Unregister-RemoteSessionConfiguration

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Unregisters a PSSessionConfiguration on a remote machine

+

Description

+

Unregisters a session previously created with Register-RemoteSessionConfiguration through WinRM.

+

Syntax

+
Unregister-RemoteSessionConfiguration
+    [-ComputerName] <Object>
+    [-Name] <String>
+    [[-Credential] <PSCredential>]
+    [-WhatIf]
+    [-Confirm]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-ComputerName
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-Name
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-Credential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-WhatIf
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliaswi
RequiredFalse
Pipelinefalse
Default Value
+
-Confirm
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliascf
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Unregister-RemoteSessionConfiguration on GitHub. +
+Want to see the Bill Of Health for this command? Check out Unregister-RemoteSessionConfiguration.

+ +
+
+
+
+ + + diff --git a/Update-DbaBuildReference.html b/Update-DbaBuildReference.html index 9e05a5ae..8eda11bf 100644 Binary files a/Update-DbaBuildReference.html and b/Update-DbaBuildReference.html differ diff --git a/Update-DbaInstance.html b/Update-DbaInstance.html index adfe819a..02428b1c 100644 Binary files a/Update-DbaInstance.html and b/Update-DbaInstance.html differ diff --git a/Update-DbaMaintenanceSolution.html b/Update-DbaMaintenanceSolution.html index 01d0e3bf..70a8c19f 100644 Binary files a/Update-DbaMaintenanceSolution.html and b/Update-DbaMaintenanceSolution.html differ diff --git a/Update-DbaServiceAccount.html b/Update-DbaServiceAccount.html index fae93db3..a6600b4e 100644 Binary files a/Update-DbaServiceAccount.html and b/Update-DbaServiceAccount.html differ diff --git a/Update-Dbatools.html b/Update-Dbatools.html index 3b002aa0..8191d1fa 100644 Binary files a/Update-Dbatools.html and b/Update-Dbatools.html differ diff --git a/Update-ServiceStatus.html b/Update-ServiceStatus.html new file mode 100644 index 00000000..6a017e55 --- /dev/null +++ b/Update-ServiceStatus.html @@ -0,0 +1,706 @@ + + + + + + + dbatools docs | Update-ServiceStatus + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Update-ServiceStatus

+ + + + + + + + + + + + + + + + + +
AuthorKirill Kravtsov ( @nvarscar )
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal function. Sends start/stop request to a SQL Server service and wait for the result.

+

Description

+

Accepts objects from Get-DbaService and performs a corresponding action.

+

Syntax

+
Update-ServiceStatus
+    [-InputObject] <Object[]>
+    [-Action] <String[]>
+    [[-Timeout] <Int32>]
+    [[-Credential] <PSCredential>]
+    [[-EnableException] <Boolean>]
+    [-WhatIf]
+    [-Confirm]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

PS > $InputObject = Get-DbaService -ComputerName sql1
+Update-ServiceStatus -InputObject $InputObject -Action 'stop' -Timeout 30
+Update-ServiceStatus -InputObject $InputObject -Action 'start' -Timeout 30
+Restarts SQL services on sql1

+
Example: 2
+

PS > $InputObject = Get-DbaService -ComputerName sql1
+$credential = Get-Credential
+Update-ServiceStatus -InputObject $InputObject -Action 'stop' -Timeout 0 -Credential $credential
+Stops SQL services on sql1 and waits indefinitely for them to stop. Uses $credential to authorize on the server.

+

Required Parameters

+
-InputObject
+

A collection of services from Get-DbaService

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinetrue (ByValue)
Default Value
+
-Action
+

Start or stop.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-Timeout
+

How long to wait for the start/stop request completion before moving on.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value60
+
-Credential
+

Credential object used to connect to the computer as a different user.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-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.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-WhatIf
+

Shows what would happen if the cmdlet runs. The cmdlet is not run.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliaswi
RequiredFalse
Pipelinefalse
Default Value
+
-Confirm
+

Prompts you for confirmation before running the cmdlet.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliascf
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Update-ServiceStatus on GitHub. +
+Want to see the Bill Of Health for this command? Check out Update-ServiceStatus.

+ +
+
+
+
+ + + diff --git a/Update-SqlDbOwner.html b/Update-SqlDbOwner.html new file mode 100644 index 00000000..691c7f16 --- /dev/null +++ b/Update-SqlDbOwner.html @@ -0,0 +1,718 @@ + + + + + + + dbatools docs | Update-SqlDbOwner + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Update-SqlDbOwner

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal function. Updates specified database dbowner.

+

Description

+

Syntax

+
Update-SqlDbOwner
+    [-Source] <Object>
+    [-Destination] <Object>
+    [[-DbName] <String>]
+    [[-SourceSqlCredential] <PSCredential>]
+    [[-DestinationSqlCredential] <PSCredential>]
+    [-EnableException]
+    [-WhatIf]
+    [-Confirm]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-Source
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-Destination
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-DbName
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-SourceSqlCredential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-DestinationSqlCredential
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-EnableException
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-WhatIf
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliaswi
RequiredFalse
Pipelinefalse
Default Value
+
-Confirm
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliascf
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Update-SqlDbOwner on GitHub. +
+Want to see the Bill Of Health for this command? Check out Update-SqlDbOwner.

+ +
+
+
+
+ + + diff --git a/Update-SqlDbReadOnly.html b/Update-SqlDbReadOnly.html new file mode 100644 index 00000000..50d17746 --- /dev/null +++ b/Update-SqlDbReadOnly.html @@ -0,0 +1,631 @@ + + + + + + + dbatools docs | Update-SqlDbReadOnly + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Update-SqlDbReadOnly

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal function. Updates specified database to read-only or read-write. Necessary because SMO doesn't appear to support NO_WAIT.

+

Description

+

Syntax

+
Update-SqlDbReadOnly
+    [-SqlInstance] <Object>
+    [-DbName] <String>
+    [-readonly] <Boolean>
+    [-WhatIf]
+    [-Confirm]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-SqlInstance
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-DbName
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-readonly
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default ValueFalse
+

Optional Parameters

+
-WhatIf
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliaswi
RequiredFalse
Pipelinefalse
Default Value
+
-Confirm
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliascf
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Update-SqlDbReadOnly on GitHub. +
+Want to see the Bill Of Health for this command? Check out Update-SqlDbReadOnly.

+ +
+
+
+
+ + + diff --git a/Update-SqlPermission.html b/Update-SqlPermission.html new file mode 100644 index 00000000..e67c608b --- /dev/null +++ b/Update-SqlPermission.html @@ -0,0 +1,718 @@ + + + + + + + dbatools docs | Update-SqlPermission + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Update-SqlPermission

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Internal function. Updates permission sets, roles, database mappings on server and databases

+

Description

+

Syntax

+
Update-SqlPermission
+    [-SourceServer] <Object>
+    [-SourceLogin] <Object>
+    [-DestServer] <Object>
+    [-DestLogin] <Object>
+    [-ObjectLevel]
+    [-EnableException]
+    [-WhatIf]
+    [-Confirm]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+

Required Parameters

+
-SourceServer
+

Source Server

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-SourceLogin
+

Source login

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-DestServer
+

Destination Server

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+
-DestLogin
+

Destination Login

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredTrue
Pipelinefalse
Default Value
+

Optional Parameters

+
-ObjectLevel
+

Use Export-DbaUser to update object-level permissions as well

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-EnableException
+

Use this switch to disable any kind of verbose messages

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+
-WhatIf
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliaswi
RequiredFalse
Pipelinefalse
Default Value
+
-Confirm
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Aliascf
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Update-SqlPermission on GitHub. +
+Want to see the Bill Of Health for this command? Check out Update-SqlPermission.

+ +
+
+
+
+ + + diff --git a/Watch-DbaDbLogin.html b/Watch-DbaDbLogin.html index 2c79ccea..1285e0d0 100644 Binary files a/Watch-DbaDbLogin.html and b/Watch-DbaDbLogin.html differ diff --git a/Watch-DbaXESession.html b/Watch-DbaXESession.html index 16a7c106..7f9b3b68 100644 Binary files a/Watch-DbaXESession.html and b/Watch-DbaXESession.html differ diff --git a/Watch-DbatoolsUpdate.html b/Watch-DbatoolsUpdate.html index a1dabca6..bef04b90 100644 Binary files a/Watch-DbatoolsUpdate.html and b/Watch-DbatoolsUpdate.html differ diff --git a/Write-DbaDbTableData.html b/Write-DbaDbTableData.html index c703406b..a17feee4 100644 Binary files a/Write-DbaDbTableData.html and b/Write-DbaDbTableData.html differ diff --git a/Write-DbatoolsConfigFile.html b/Write-DbatoolsConfigFile.html new file mode 100644 index 00000000..2b930e13 --- /dev/null +++ b/Write-DbatoolsConfigFile.html @@ -0,0 +1,581 @@ + + + + + + + dbatools docs | Write-DbatoolsConfigFile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Write-DbatoolsConfigFile

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Handles config export to file.

+

Description

+

Handles config export to file.

+

Syntax

+
Write-DbatoolsConfigFile
+    [[-Config] <Config[]>]
+    [[-Path] <String>]
+    [-Replace]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Write-DbatoolsConfigFile -Config $items -Path .\file.json
+
+

Exports all settings stored in $items to .\file.json.
+If the file already exists, the new settings will be merged into the existing file.

+

Optional Parameters

+
-Config
+

The configuration items to export.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Path
+

The path to export to. +Needs to point to the specific file to export to. +Will create the folder structure if needed.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Replace
+

Completely replaces previous file contents. +By default, it will integrate settings into one coherent configuration file.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default ValueFalse
+

 

+

Want to see the source code for this command? Check out Write-DbatoolsConfigFile on GitHub. +
+Want to see the Bill Of Health for this command? Check out Write-DbatoolsConfigFile.

+ +
+
+
+
+ + + diff --git a/Write-HostColor.html b/Write-HostColor.html new file mode 100644 index 00000000..d132e08b --- /dev/null +++ b/Write-HostColor.html @@ -0,0 +1,571 @@ + + + + + + + dbatools docs | Write-HostColor + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Write-HostColor

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Function that recognizes html-style tags to insert color into printed text.

+

Description

+

Function that recognizes html-style tags to insert color into printed text.

+

Color tags should be designed to look like this: +<c="">Text +For example this would be a valid string: +"This message should <c="red">partially be painted in red."

+

This allows specifying color within strings and avoids having to piece together colored text in multiple calls to Write-Host. +Only colors that are part of the ConsoleColor enumeration can be used. Bad colors will be ignored in favor of the default color.

+

Syntax

+
Write-HostColor
+    [[-String] <String[]>]
+    [[-DefaultColor] {Black | DarkBlue | DarkGreen | DarkCyan | DarkRed | DarkMagenta | DarkYellow | Gray | DarkGray | Blue | Green | Cyan | Red | Magenta | Yellow | White}]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+

Write-HostColor -String 'This is going to be <c="red">bloody red text! And this is <c="green">green stuff for extra color'
+Will print the specified line in multiple colors

+
Example: 2
+

$string1 = 'This is going to be <c="red">bloody red text! And this is <c="green">green stuff for extra color'
+$string2 = '<c="red">bloody red text! And this is <c="green">green stuff for extra color'
+$string3 = 'This is going to be <c="red">bloody red text! And this is <c="green">green stuff'
+$string1, $string2, $string3 | Write-HostColor -DefaultColor "Magenta"
+Will print all three lines, respecting the color-codes, but use the color "Magenta" as default color.

+
Example: 3
+

PS > $stringLong = @"
+Dear <c="red">Sirs<c="green"> and <c="blue">Madams,
+it has come to our attention that you are not sufficiently <c="darkblue">awesome!
+Kindly improve your <c="yellow">AP (<c="magenta">awesome-ness points) by at least 50% to maintain you membership in Awesome Inc!
+You have <c="green">27 3/4 days time to meet this deadline. <c="darkyellow">After this we will unfortunately be forced to rend you assunder and sacrifice your remains to the devil.
+Best regards,
+<c="red">Luzifer
+"@
+Write-HostColor -String $stringLong
+Will print a long multiline text in its entirety while still respecting the colorcodes

+

Optional Parameters

+
-String
+

The message to write to host.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinetrue (ByValue)
Default Value
+
-DefaultColor
+

Default: (Get-DbatoolsConfigValue -Name "message.infocolor") +The color to write stuff to host in when no (or bad) color-code was specified.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value(Get-DbatoolsConfigValue -Name "message.infocolor")
+

 

+

Want to see the source code for this command? Check out Write-HostColor on GitHub. +
+Want to see the Bill Of Health for this command? Check out Write-HostColor.

+ +
+
+
+
+ + + diff --git a/Write-ImportTime.html b/Write-ImportTime.html new file mode 100644 index 00000000..9424cd2a --- /dev/null +++ b/Write-ImportTime.html @@ -0,0 +1,548 @@ + + + + + + + dbatools docs | Write-ImportTime + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Write-ImportTime

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Writes an entry to the import module time debug list

+

Description

+

Writes an entry to the import module time debug list

+

Syntax

+
Write-ImportTime
+    [[-Text] <String>]
+    [[-Timestamp] <Object>]
+    [<CommonParameters>]
+
+
+

 

+

Examples

+

 

+
Example: 1
+
PS C:\> Write-ImportTime -Text "Starting SMO Import"
+
+

Adds the message "Starting SMO Import" to the debug list

+

Optional Parameters

+
-Text
+

The message to write

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-Timestamp
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value([DateTime]::now)
+

 

+

Want to see the source code for this command? Check out Write-ImportTime on GitHub. +
+Want to see the Bill Of Health for this command? Check out Write-ImportTime.

+ +
+
+
+
+ + + diff --git a/Write-Message.html b/Write-Message.html index 99d6eb97..84b6b82c 100644 Binary files a/Write-Message.html and b/Write-Message.html differ diff --git a/Write-ProgressHelper.html b/Write-ProgressHelper.html new file mode 100644 index 00000000..2022c666 --- /dev/null +++ b/Write-ProgressHelper.html @@ -0,0 +1,626 @@ + + + + + + + dbatools docs | Write-ProgressHelper + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+

+ commands + +

+

+
+
+
+ + +
+
Clear
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ^ +
+
+

Write-ProgressHelper

+ + + + + + + + + + + + + +
AvailabilityWindows, Linux, macOS
+

 

+

Synopsis

+

Write-ProgressHelper [-StepNumber ] [-Activity ] [-Message ] [-TotalSteps ] -ExcludePercent

+

Description

+

Syntax

+
Write-ProgressHelpersyntaxItem----------{@{name=
+
+Write-ProgressHelper; CommonParameters=False; parameter=System.Object[]}}
+
+
+

 

+

Examples

+

 

+

Optional Parameters

+
-Activity
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-ExcludePercent
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
AliasNoProgress
RequiredFalse
Pipelinefalse
Default Value
+
-Message
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-StepNumber
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+
-TotalSteps
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Alias
RequiredFalse
Pipelinefalse
Default Value
+

 

+

Want to see the source code for this command? Check out Write-ProgressHelper on GitHub. +
+Want to see the Bill Of Health for this command? Check out Write-ProgressHelper.

+ +
+
+
+
+ + + diff --git a/assets/dbatools-index.json b/assets/dbatools-index.json index 70bb1a70..f9802f98 100644 Binary files a/assets/dbatools-index.json and b/assets/dbatools-index.json differ diff --git a/sitemap.xml b/sitemap.xml index 9965e18d..3a5e3c26 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1,2683 +1,3251 @@  + + https://docs.dbatools.io/Add-ConnectionHashValue + 2022-07-14T11:07:58Z + https://docs.dbatools.io/Add-DbaAgDatabase - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Add-DbaAgListener - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Add-DbaAgReplica - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Add-DbaComputerCertificate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Add-DbaDbMirrorMonitor - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Add-DbaDbRoleMember - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Add-DbaExtendedProperty - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Add-DbaPfDataCollectorCounter - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Add-DbaRegServer - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Add-DbaRegServerGroup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Add-DbaServerRoleMember - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Add-TeppCacheItem + 2022-07-14T11:07:58Z https://docs.dbatools.io/Backup-DbaComputerCertificate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Backup-DbaDatabase - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Backup-DbaDbCertificate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Backup-DbaDbMasterKey - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Backup-DbaServiceMasterKey - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Clear-DbaConnectionPool - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Clear-DbaLatchStatistics - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Clear-DbaPlanCache - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Clear-DbaWaitStatistics - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Compare-DbaCollationSensitiveObject + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Connect-AsServer + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Connect-ConnstringInstance + 2022-07-14T11:07:58Z https://docs.dbatools.io/Connect-DbaInstance - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Connect-ReplicationDB + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Convert-ByteToHexString + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Convert-ConnectionString + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Convert-DbaIndexToTable + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Convert-DbaLSN + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Convert-DbaMaskingValue + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Convert-DbaMessageException + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Convert-DbaMessageLevel + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Convert-DbaMessageTarget + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Convert-DbaTimelineStatusColor + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Convert-DbVersionToSqlVersion + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Convert-HexStringToByte + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/ConvertFrom-SecurePass + 2022-07-14T11:07:58Z https://docs.dbatools.io/ConvertTo-DbaDataTable - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/ConvertTo-DbaTimeline - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/ConvertTo-DbaXESession - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/ConvertTo-JsDate + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaAgentAlert - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaAgentJob - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaAgentJobCategory - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaAgentOperator - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaAgentProxy - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaAgentSchedule - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaAgentServer - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaBackupDevice - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaCredential - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaCustomError - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaDatabase - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaDataCollector - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaDbAssembly - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaDbCertificate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaDbMail - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaDbQueryStoreOption - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaDbTableData - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaDbViewData - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaEndpoint - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaInstanceAudit - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaInstanceAuditSpecification - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaInstanceTrigger - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaLinkedServer - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaLogin - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaPolicyManagement - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaRegServer - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaResourceGovernor - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaSpConfigure - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaStartupProcedure - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaSysDbUserObject - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaXESession - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Copy-DbaXESessionTemplate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Disable-DbaAgHadr - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Disable-DbaDbEncryption - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Disable-DbaFilestream - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Disable-DbaForceNetworkEncryption - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Disable-DbaHideInstance - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Disable-DbaStartupProcedure - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Disable-DbaTraceFlag - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Disconnect-DbaInstance - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Disconnect-Regserver + 2022-07-14T11:07:58Z https://docs.dbatools.io/Dismount-DbaDatabase - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Enable-DbaAgHadr - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Enable-DbaDbEncryption - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Enable-DbaFilestream - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Enable-DbaForceNetworkEncryption - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Enable-DbaHideInstance - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Enable-DbaStartupProcedure - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Enable-DbaTraceFlag - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Expand-DbaDbLogFile - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Export-DbaCredential - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Export-DbaDacPackage - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Export-DbaDbRole - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Export-DbaDbTableData - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Export-DbaDiagnosticQuery - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Export-DbaExecutionPlan - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Export-DbaInstance - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Export-DbaLinkedServer - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Export-DbaLogin - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Export-DbaPfDataCollectorSetTemplate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Export-DbaRegServer - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Export-DbaRepServerSetting - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Export-DbaScript - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Export-DbaServerRole - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Export-DbaSpConfigure - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Export-DbaSysDbUserObject - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Export-DbatoolsConfig - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Export-DbaUser - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Export-DbaXECsv - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Export-DbaXESession - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Export-DbaXESessionTemplate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Find-DbaAgentJob - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Find-DbaBackup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Find-DbaCommand - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Find-DbaDatabase - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Find-DbaDbDisabledIndex - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Find-DbaDbDuplicateIndex - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Find-DbaDbGrowthEvent - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Find-DbaDbUnusedIndex - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Find-DbaInstance - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Find-DbaLoginInGroup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Find-DbaOrphanedFile - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Find-DbaSimilarTable - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Find-DbaStoredProcedure - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Find-DbaTrigger - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Find-DbaUserObject - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Find-DbaView - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Find-SqlInstanceSetup + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Find-SqlInstanceUpdate + 2022-07-14T11:07:58Z https://docs.dbatools.io/Format-DbaBackupInformation - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-AdjustedTotalRowsCopied + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-ADSConnection + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-BackupAncientHistory + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-BulkRowsCopiedCount + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-CodePage + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-ConnectionParent + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-DbaADObject + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaAgBackupHistory - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaAgDatabase - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaAgentAlert - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaAgentAlertCategory - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaAgentJob - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaAgentJobCategory - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaAgentJobHistory - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaAgentJobOutputFile - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaAgentJobStep - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaAgentLog - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaAgentOperator - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaAgentProxy - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaAgentSchedule - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaAgentServer - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaAgHadr - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaAgListener - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaAgReplica - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaAvailabilityGroup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaAvailableCollation - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaBackupDevice - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaBackupInformation - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaBuild - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaClientAlias - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaClientProtocol - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaCmConnection - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaCmObject - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaComputerCertificate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaComputerSystem - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaConnectedInstance - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaConnection - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaCpuRingBuffer - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaCpuUsage - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaCredential - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaCustomError - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDatabase - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbAssembly - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbAsymmetricKey - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbBackupHistory - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbccHelp - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbccMemoryStatus - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbccProcCache - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbccSessionBuffer - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbccStatistic - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbccUserOption - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbCertificate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbCheckConstraint - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbCompatibility - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbCompression - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbDbccOpenTran - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbDetachedFileInfo - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbEncryption - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbEncryptionKey - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbExtentDiff - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbFeatureUsage - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbFile - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbFileGroup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbFileGrowth - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbFileMapping - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbForeignKey - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbIdentity - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbLogShipError - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbLogSpace - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbMail - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbMailAccount - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbMailConfig - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbMailHistory - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbMailLog - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbMailProfile - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbMailServer - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbMasterKey - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbMemoryUsage - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbMirror - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbMirrorMonitor - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbObjectTrigger - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbOrphanUser - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbPageInfo - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbPartitionFunction - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbPartitionScheme - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-DbaDbPhysicalFile + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbQueryStoreOption - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbRecoveryModel - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbRestoreHistory - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbRole - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbRoleMember - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbSchema - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbSequence - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-DbaDbServiceBrokerQueue + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbServiceBrokerService - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbSharePoint - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbSnapshot - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbSpace - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbState - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbStoredProcedure - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbSynonym - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbTable - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbTrigger - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbUdf - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbUser - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbUserDefinedTableType - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbView - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDbVirtualLogFile - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDefaultPath - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDependency - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDeprecatedFeature - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDiskSpace - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaDump - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaEndpoint - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaErrorLog - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaErrorLogConfig - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaEstimatedCompletionTime - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaExecutionPlan - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaExtendedProperty - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaExtendedProtection - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaExternalProcess - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaFeature - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaFile - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaFilestream - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-DbaFileStreamFolder + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaFirewallRule - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaForceNetworkEncryption - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-DbaHelp + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaHelpIndex - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaHideInstance - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaInstalledPatch - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaInstanceAudit - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaInstanceAuditSpecification - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaInstanceInstallDate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaInstanceProperty - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaInstanceProtocol - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaInstanceTrigger - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaInstanceUserOption - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaIoLatency - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaKbUpdate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaLastBackup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaLastGoodCheckDb - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaLatchStatistic - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaLinkedServer - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaLinkedServerLogin - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaLocaleSetting - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaLogin - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaMaintenanceSolutionLog - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaManagementObject - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaMaxMemory - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaMemoryCondition - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaMemoryUsage - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-DbaMessageLevelModifier + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaModule - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaMsdtc - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaNetworkActivity - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaNetworkCertificate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaNetworkConfiguration - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaOleDbProvider - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaOpenTransaction - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaOperatingSystem - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaPageFileSetting - 2022-07-14T10:46:19Z - - - https://docs.dbatools.io/Get-DbaPbmCategory - 2022-07-14T10:46:19Z - - - https://docs.dbatools.io/Get-DbaPbmCategorySubscription - 2022-07-14T10:46:19Z - - - https://docs.dbatools.io/Get-DbaPbmCondition - 2022-07-14T10:46:19Z - - - https://docs.dbatools.io/Get-DbaPbmObjectSet - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z - https://docs.dbatools.io/Get-DbaPbmPolicy - 2022-07-14T10:46:19Z + https://docs.dbatools.io/Get-DbaPathSep + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaPbmStore - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaPermission - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaPfAvailableCounter - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaPfDataCollector - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaPfDataCollectorCounter - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaPfDataCollectorCounterSample - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaPfDataCollectorSet - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaPfDataCollectorSetTemplate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaPlanCache - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaPowerPlan - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaPrivilege - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaProcess - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaProductKey - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaQueryExecutionTime - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaRandomizedDataset - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaRandomizedDatasetTemplate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaRandomizedType - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaRandomizedValue - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaRegistryRoot - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaRegServer - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaRegServerGroup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaRegServerStore - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaRepDistributor - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-DbaReportingService + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaRepPublication - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaRepServer - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaResourceGovernor - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaRgClassifierFunction - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaRgResourcePool - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaRgWorkloadGroup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaRunningJob - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-DbaRunspace + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaSchemaChangeHistory - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaServerRole - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaServerRoleMember - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaService - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-DbaServiceErrorMessage + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaSpConfigure - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaSpinLockStatistic - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaSpn - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaSsisExecutionHistory - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaStartupParameter - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaStartupProcedure - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaSuspectPage - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaTcpPort - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaTempdbUsage - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbatoolsChangeLog - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbatoolsConfig - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbatoolsConfigValue - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbatoolsError - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbatoolsLog - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbatoolsPath - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaTopResourceUsage - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaTrace - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaTraceFlag - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaUptime - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaUserPermission - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaWaitingTask - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaWaitResource - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaWaitStatistic - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaWindowsLog - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaWsfcAvailableDisk - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaWsfcCluster - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaWsfcDisk - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaWsfcNetwork - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaWsfcNetworkInterface - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaWsfcNode - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaWsfcResource - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaWsfcResourceType - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaWsfcRole - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaWsfcSharedVolume - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaXEObject - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaXESession - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaXESessionTarget - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaXESessionTargetFile - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaXESessionTemplate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaXESmartTarget - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Get-DbaXEStore - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-DecryptedObject + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-DirectoryRestoreFile + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-ErrorMessage + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-ExportFilePath + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-InternalService + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-JobList + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-Language + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-ObjectNameParts + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-OfflineSqlFileStructure + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-PasswordHash + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-RandomPassword + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-RegServerGroupReverseParse + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-RegServerParent + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-ResourceState + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-RestoreContinuableDatabase + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-SaLoginName + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-SqlCmdVars + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-SqlDefaultPaths + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-SqlDefaultSpConfigure + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-SqlFileStructure + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-SQLInstanceComponent + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-SqlInstanceUpdate + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-SqlSaLogin + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-WmiHadr + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-XpDirTreeRestoreFile + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Get-XPlatVariable + 2022-07-14T11:07:58Z https://docs.dbatools.io/Grant-DbaAgPermission - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Hide-ConnectionString + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Import-DbaCmdlet + 2022-07-14T11:07:58Z https://docs.dbatools.io/Import-DbaCsv - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Import-DbaPfDataCollectorSetTemplate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Import-DbaRegServer - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Import-DbaSpConfigure - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Import-DbatoolsConfig - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Import-DbaXESessionTemplate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Import-ModuleFile + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Initialize-CredSSP + 2022-07-14T11:07:58Z https://docs.dbatools.io/Install-DbaDarlingData - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Install-DbaFirstResponderKit - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Install-DbaInstance - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Install-DbaMaintenanceSolution - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Install-DbaMultiTool - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Install-DbaSqlWatch - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Install-DbatoolsWatchUpdate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Install-DbaWhoIsActive - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Invoke-Alter + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Invoke-Command2 + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Invoke-CommandWithFallback + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Invoke-Create + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaAdvancedInstall - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaAdvancedRestore - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaAdvancedUpdate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaAgFailover - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Invoke-DbaAsync + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaBalanceDataFiles - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaCycleErrorLog - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaDbccDropCleanBuffer - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaDbccFreeCache - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaDbClone - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Invoke-DbaDbCorruption + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaDbDataGenerator - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaDbDataMasking - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaDbDbccCheckConstraint - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaDbDbccCleanTable - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaDbDbccUpdateUsage - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaDbDecryptObject - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaDbLogShipping - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaDbLogShipRecovery - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaDbMirrorFailover - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaDbMirroring - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaDbPiiScan - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaDbShrink - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaDbTransfer - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaDbUpgrade - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaDiagnosticQuery - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Invoke-DbaDiagnosticQueryScriptParser + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaPfRelog - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaQuery - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbatoolsFormatter - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbatoolsRenameHelper - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaWhoIsActive - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Invoke-DbaXEReplay - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Invoke-DbMirrorValidation + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Invoke-ManagedComputerCommand + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Invoke-Parallel + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Invoke-Program + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Invoke-SmoCheck + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Invoke-SteppablePipeline + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Invoke-TagCommand + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Invoke-TlsRestMethod + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Invoke-TlsWebRequest + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Join-AdminUnc + 2022-07-14T11:07:58Z https://docs.dbatools.io/Join-DbaAvailabilityGroup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Join-DbaPath - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Join-SomePath + 2022-07-14T11:07:58Z https://docs.dbatools.io/Measure-DbaBackupThroughput - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Measure-DbaDbVirtualLogFile - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Measure-DbaDiskSpaceRequirement - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Measure-DbatoolsImport - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Mount-DbaDatabase - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Move-DbaDbFile - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Move-DbaRegServer - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Move-DbaRegServerGroup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaAgentAlertCategory - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaAgentJob - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaAgentJobCategory - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaAgentJobStep - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaAgentOperator - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaAgentProxy - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaAgentSchedule - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaAvailabilityGroup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaAzAccessToken - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaClientAlias - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaCmConnection - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaComputerCertificate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaComputerCertificateSigningRequest - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaConnectionString - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaConnectionStringBuilder - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaCredential - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaCustomError - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaDacOption - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaDacProfile - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaDatabase - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaDbAsymmetricKey - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaDbCertificate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaDbDataGeneratorConfig - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaDbEncryptionKey - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaDbFileGroup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaDbMailAccount - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaDbMailProfile - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaDbMaskingConfig - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaDbMasterKey - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaDbRole - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaDbSchema - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaDbSequence - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaDbSnapshot - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaDbSynonym - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaDbTable - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaDbTransfer - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaDbUser - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaDiagnosticAdsNotebook - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaDirectory - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaEndpoint - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaFirewallRule - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/New-DbaLinkedServer + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaLinkedServerLogin - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaLogin - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/New-DbaLogShippingPrimaryDatabase + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/New-DbaLogShippingPrimarySecondary + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/New-DbaLogShippingSecondaryDatabase + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/New-DbaLogShippingSecondaryPrimary + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/New-DbaMessageLevelModifier + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaRgResourcePool - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaRgWorkloadGroup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaScriptingOption - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaServerRole - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaServiceMasterKey - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaSqlParameter - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbatoolsSupportPackage - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaXESession - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaXESmartCsvWriter - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaXESmartEmail - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaXESmartQueryExec - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaXESmartReplay - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/New-DbaXESmartTableWriter - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/New-SqlConnection + 2022-07-14T11:07:58Z https://docs.dbatools.io/Publish-DbaDacPackage - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Read-DbaAuditFile - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Read-DbaBackupHeader - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Read-DbatoolsConfigFile + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Read-DbatoolsConfigPersisted + 2022-07-14T11:07:58Z https://docs.dbatools.io/Read-DbaTraceFile - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Read-DbaTransactionLog - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Read-DbaXEFile - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Register-DbaMaintenanceTask + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Register-DbaMessageEvent + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Register-DbaMessageTransform + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Register-DbaRunspace + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Register-DbaTeppArgumentCompleter + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Register-DbaTeppInstanceCacheBuilder + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Register-DbaTeppScriptblock + 2022-07-14T11:07:58Z https://docs.dbatools.io/Register-DbatoolsConfig - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Register-DbatoolsConfigValidation + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Register-RemoteSessionConfiguration + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaAgDatabase - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaAgentAlert - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaAgentAlertCategory - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaAgentJob - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaAgentJobCategory - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaAgentJobStep - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaAgentOperator - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaAgentProxy - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaAgentSchedule - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaAgListener - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaAgReplica - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaAvailabilityGroup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaBackup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaClientAlias - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaCmConnection - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaComputerCertificate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaCredential - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaCustomError - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDatabase - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDatabaseSafely - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbAsymmetricKey - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbBackupRestoreHistory - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbCertificate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbCheckConstraint - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbData - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbEncryptionKey - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbFileGroup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbLogShipping - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbMailAccount - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbMailProfile - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbMasterKey - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbMirror - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbMirrorMonitor - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbOrphanUser - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbPartitionFunction - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbPartitionScheme - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbRole - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbRoleMember - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbSchema - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbSequence - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbSnapshot - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbSynonym - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbTable - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbTableData - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbUdf - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbUser - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaDbView - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaEndpoint - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaExtendedProperty - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaFirewallRule - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaLinkedServer - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaLinkedServerLogin - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaLogin - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Remove-DbaMessageLevelModifier + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaNetworkCertificate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaPfDataCollectorCounter - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaPfDataCollectorSet - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaRegServer - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaRegServerGroup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaRgResourcePool - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaRgWorkloadGroup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaServerRole - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaServerRoleMember - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaSpn - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaTrace - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaXESession - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Remove-DbaXESmartTarget - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Remove-InvalidFileNameChars + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Remove-TeppCacheItem + 2022-07-14T11:07:58Z https://docs.dbatools.io/Rename-DbaDatabase - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Rename-DbaLogin - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Repair-DbaDbMirror - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Repair-DbaDbOrphanUser - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Repair-DbaInstanceName - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Reset-DbaAdmin - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Reset-DbatoolsConfig - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Resolve-DbaComputerName + 2022-07-14T11:07:58Z https://docs.dbatools.io/Resolve-DbaNetworkName - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Resolve-DbaPath - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Resolve-IpAddress + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Resolve-SqlIpAddress + 2022-07-14T11:07:58Z https://docs.dbatools.io/Restart-DbaService - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Restart-WinRMService + 2022-07-14T11:07:58Z https://docs.dbatools.io/Restore-DbaDatabase - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Restore-DbaDbCertificate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Restore-DbaDbSnapshot - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Resume-DbaAgDbDataMovement - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Revoke-DbaAgPermission - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Save-DbaCommunitySoftware - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Save-DbaDiagnosticQueryScript - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Save-DbaKbUpdate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Select-DbaBackupInformation - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Select-DbaDbSequenceNextValue - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Select-DbaObject - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Select-DefaultView + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Send-File + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaAgentAlert - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaAgentJob - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaAgentJobCategory - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaAgentJobOutputFile - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaAgentJobOwner - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaAgentJobStep - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaAgentOperator - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaAgentSchedule - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaAgentServer - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaAgListener - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaAgReplica - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaAvailabilityGroup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaCmConnection - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaDbCompatibility - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaDbCompression - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaDbFileGroup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaDbFileGrowth - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaDbIdentity - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaDbMirror - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaDbOwner - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaDbQueryStoreOption - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaDbRecoveryModel - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaDbSchema - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaDbSequence - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaDbState - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaDefaultPath - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaEndpoint - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaErrorLogConfig - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaExtendedProperty - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaExtendedProtection - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaLogin - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaMaxDop - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaMaxMemory - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaNetworkCertificate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaNetworkConfiguration - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaPowerPlan - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaPrivilege - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaResourceGovernor - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaRgResourcePool - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaRgWorkloadGroup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaSpConfigure - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaSpn - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaStartupParameter - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaTcpPort - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbaTempDbConfig - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbatoolsConfig - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Set-DbatoolsPath - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Set-FileSystemSetting + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Set-ServiceStartMode + 2022-07-14T11:07:58Z https://docs.dbatools.io/Show-DbaDbList - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Show-DbaInstanceFileSystem - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Show-Notification + 2022-07-14T11:07:58Z https://docs.dbatools.io/Start-DbaAgentJob - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Start-DbaDbEncryption - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Start-DbaEndpoint - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Start-DbaMigration - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Start-DbaPfDataCollectorSet - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Start-DbaRunspace + 2022-07-14T11:07:58Z https://docs.dbatools.io/Start-DbaService - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Start-DbaTrace - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Start-DbaXESession - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Start-DbaXESmartTarget - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Start-DbccCheck + 2022-07-14T11:07:58Z https://docs.dbatools.io/Stop-DbaAgentJob - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Stop-DbaDbEncryption - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Stop-DbaEndpoint - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Stop-DbaExternalProcess - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Stop-DbaPfDataCollectorSet - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Stop-DbaProcess - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Stop-DbaRunspace + 2022-07-14T11:07:58Z https://docs.dbatools.io/Stop-DbaService - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Stop-DbaTrace - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Stop-DbaXESession - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Stop-DbaXESmartTarget - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Stop-Function + 2022-07-14T11:07:58Z https://docs.dbatools.io/Suspend-DbaAgDbDataMovement - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Sync-DbaAvailabilityGroup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Sync-DbaLoginPermission - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Test-Bound + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Test-ComputerTarget + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaAgentJobOwner - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaAvailabilityGroup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaBackupEncrypted - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaBackupInformation - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaBuild - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaCmConnection - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaComputerCertificateExpiration - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaConnection - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaConnectionAuthScheme - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaDbCollation - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaDbCompatibility - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaDbCompression - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaDbDataGeneratorConfig - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaDbDataMaskingConfig - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaDbLogShipStatus - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaDbOwner - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaDbQueryStore - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaDbRecoveryModel - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaDeprecatedFeature - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Test-DbaDeprecation + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaDiskAlignment - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaDiskAllocation - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaDiskSpeed - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaEndpoint - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaIdentityUsage - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaInstanceName - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaLastBackup - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaLinkedServerConnection - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaLoginPassword - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Test-DbaLsnChain + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaManagementObject - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaMaxDop - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaMaxMemory - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaMigrationConstraint - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaNetworkLatency - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaOptimizeForAdHoc - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaPath - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaPowerPlan - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaRepLatency - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Test-DbaRestoreVersion + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaSpn - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaTempDbConfig - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Test-DbaWindowsLogin - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Test-ElevationRequirement + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Test-ExportDirectory + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Test-FunctionInterrupt + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Test-HostOSLinux + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Test-PendingReboot + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Test-PSRemoting + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Test-PsVersion + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Test-ShouldProcess + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Test-SqlAgent + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Test-SqlLoginAccess + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Test-SqlQueryComplete + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Test-SqlSa + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Test-Windows + 2022-07-14T11:07:58Z https://docs.dbatools.io/Uninstall-DbaSqlWatch - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Uninstall-DbatoolsWatchUpdate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Unregister-DbatoolsConfig - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Unregister-RemoteSessionConfiguration + 2022-07-14T11:07:58Z https://docs.dbatools.io/Update-DbaBuildReference - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Update-DbaInstance - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Update-DbaMaintenanceSolution - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Update-DbaServiceAccount - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Update-Dbatools - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Update-ServiceStatus + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Update-SqlDbOwner + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Update-SqlDbReadOnly + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Update-SqlPermission + 2022-07-14T11:07:58Z https://docs.dbatools.io/Watch-DbaDbLogin - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Watch-DbatoolsUpdate - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Watch-DbaXESession - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z https://docs.dbatools.io/Write-DbaDbTableData - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Write-DbatoolsConfigFile + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Write-HostColor + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Write-ImportTime + 2022-07-14T11:07:58Z https://docs.dbatools.io/Write-Message - 2022-07-14T10:46:19Z + 2022-07-14T11:07:58Z + + + https://docs.dbatools.io/Write-ProgressHelper + 2022-07-14T11:07:58Z \ No newline at end of file