commands (v 2.1.28)

Add-DbaAgDatabaseAdd-DbaAgListenerAdd-DbaAgReplicaAdd-DbaComputerCertificateAdd-DbaDbMirrorMonitorAdd-DbaDbRoleMemberAdd-DbaExtendedPropertyAdd-DbaPfDataCollectorCounterAdd-DbaRegServerAdd-DbaRegServerGroupAdd-DbaReplArticleAdd-DbaServerRoleMemberBackup-DbaComputerCertificateBackup-DbaDatabaseBackup-DbaDbCertificateBackup-DbaDbMasterKeyBackup-DbaServiceMasterKeyClear-DbaConnectionPoolClear-DbaLatchStatisticsClear-DbaPlanCacheClear-DbaWaitStatisticsConnect-DbaInstanceConvertTo-DbaDataTableConvertTo-DbaTimelineConvertTo-DbaXESessionCopy-DbaAgentAlertCopy-DbaAgentJobCopy-DbaAgentJobCategoryCopy-DbaAgentOperatorCopy-DbaAgentProxyCopy-DbaAgentScheduleCopy-DbaAgentServerCopy-DbaBackupDeviceCopy-DbaCredentialCopy-DbaCustomErrorCopy-DbaDatabaseCopy-DbaDataCollectorCopy-DbaDbAssemblyCopy-DbaDbCertificateCopy-DbaDbMailCopy-DbaDbQueryStoreOptionCopy-DbaDbTableDataCopy-DbaDbViewDataCopy-DbaEndpointCopy-DbaInstanceAuditCopy-DbaInstanceAuditSpecificationCopy-DbaInstanceTriggerCopy-DbaLinkedServerCopy-DbaLoginCopy-DbaPolicyManagementCopy-DbaRegServerCopy-DbaResourceGovernorCopy-DbaSpConfigureCopy-DbaSsisCatalogCopy-DbaStartupProcedureCopy-DbaSystemDbUserObjectCopy-DbaXESessionCopy-DbaXESessionTemplateDisable-DbaAgHadrDisable-DbaDbEncryptionDisable-DbaFilestreamDisable-DbaForceNetworkEncryptionDisable-DbaHideInstanceDisable-DbaReplDistributorDisable-DbaReplPublishingDisable-DbaStartupProcedureDisable-DbaTraceFlagDisconnect-DbaInstanceDismount-DbaDatabaseEnable-DbaAgHadrEnable-DbaDbEncryptionEnable-DbaFilestreamEnable-DbaForceNetworkEncryptionEnable-DbaHideInstanceEnable-DbaReplDistributorEnable-DbaReplPublishingEnable-DbaStartupProcedureEnable-DbaTraceFlagExpand-DbaDbLogFileExport-DbaBinaryFileExport-DbaCredentialExport-DbaDacPackageExport-DbaDbRoleExport-DbaDbTableDataExport-DbaDiagnosticQueryExport-DbaExecutionPlanExport-DbaInstanceExport-DbaLinkedServerExport-DbaLoginExport-DbaPfDataCollectorSetTemplateExport-DbaRegServerExport-DbaReplServerSettingExport-DbaScriptExport-DbaServerRoleExport-DbaSpConfigureExport-DbaSysDbUserObjectExport-DbatoolsConfigExport-DbaUserExport-DbaXECsvExport-DbaXESessionExport-DbaXESessionTemplateFind-DbaAgentJobFind-DbaBackupFind-DbaCommandFind-DbaDatabaseFind-DbaDbDisabledIndexFind-DbaDbDuplicateIndexFind-DbaDbGrowthEventFind-DbaDbUnusedIndexFind-DbaInstanceFind-DbaLoginInGroupFind-DbaOrphanedFileFind-DbaSimilarTableFind-DbaStoredProcedureFind-DbaTriggerFind-DbaUserObjectFind-DbaViewFormat-DbaBackupInformationGet-DbaAgBackupHistoryGet-DbaAgDatabaseGet-DbaAgentAlertGet-DbaAgentAlertCategoryGet-DbaAgentJobGet-DbaAgentJobCategoryGet-DbaAgentJobHistoryGet-DbaAgentJobOutputFileGet-DbaAgentJobStepGet-DbaAgentLogGet-DbaAgentOperatorGet-DbaAgentProxyGet-DbaAgentScheduleGet-DbaAgentServerGet-DbaAgHadrGet-DbaAgListenerGet-DbaAgReplicaGet-DbaAvailabilityGroupGet-DbaAvailableCollationGet-DbaBackupDeviceGet-DbaBackupInformationGet-DbaBinaryFileTableGet-DbaBuildGet-DbaClientAliasGet-DbaClientProtocolGet-DbaCmConnectionGet-DbaCmObjectGet-DbaComputerCertificateGet-DbaComputerSystemGet-DbaConnectedInstanceGet-DbaConnectionGet-DbaCpuRingBufferGet-DbaCpuUsageGet-DbaCredentialGet-DbaCustomErrorGet-DbaDatabaseGet-DbaDbAssemblyGet-DbaDbAsymmetricKeyGet-DbaDbBackupHistoryGet-DbaDbccHelpGet-DbaDbccMemoryStatusGet-DbaDbccProcCacheGet-DbaDbccSessionBufferGet-DbaDbccStatisticGet-DbaDbccUserOptionGet-DbaDbCertificateGet-DbaDbCheckConstraintGet-DbaDbCompatibilityGet-DbaDbCompressionGet-DbaDbDbccOpenTranGet-DbaDbDetachedFileInfoGet-DbaDbEncryptionGet-DbaDbEncryptionKeyGet-DbaDbExtentDiffGet-DbaDbFeatureUsageGet-DbaDbFileGet-DbaDbFileGroupGet-DbaDbFileGrowthGet-DbaDbFileMappingGet-DbaDbForeignKeyGet-DbaDbIdentityGet-DbaDbLogShipErrorGet-DbaDbLogSpaceGet-DbaDbMailGet-DbaDbMailAccountGet-DbaDbMailConfigGet-DbaDbMailHistoryGet-DbaDbMailLogGet-DbaDbMailProfileGet-DbaDbMailServerGet-DbaDbMasterKeyGet-DbaDbMemoryUsageGet-DbaDbMirrorGet-DbaDbMirrorMonitorGet-DbaDbObjectTriggerGet-DbaDbOrphanUserGet-DbaDbPageInfoGet-DbaDbPartitionFunctionGet-DbaDbPartitionSchemeGet-DbaDbQueryStoreOptionGet-DbaDbRecoveryModelGet-DbaDbRestoreHistoryGet-DbaDbRoleGet-DbaDbRoleMemberGet-DbaDbSchemaGet-DbaDbSequenceGet-DbaDbServiceBrokerQueueGet-DbaDbServiceBrokerServiceGet-DbaDbSharePointGet-DbaDbSnapshotGet-DbaDbSpaceGet-DbaDbStateGet-DbaDbStoredProcedureGet-DbaDbSynonymGet-DbaDbTableGet-DbaDbTriggerGet-DbaDbUdfGet-DbaDbUserGet-DbaDbUserDefinedTableTypeGet-DbaDbViewGet-DbaDbVirtualLogFileGet-DbaDefaultPathGet-DbaDependencyGet-DbaDeprecatedFeatureGet-DbaDiskSpaceGet-DbaDumpGet-DbaEndpointGet-DbaErrorLogGet-DbaErrorLogConfigGet-DbaEstimatedCompletionTimeGet-DbaExecutionPlanGet-DbaExtendedPropertyGet-DbaExtendedProtectionGet-DbaExternalProcessGet-DbaFeatureGet-DbaFileGet-DbaFilestreamGet-DbaFirewallRuleGet-DbaForceNetworkEncryptionGet-DbaHelpIndexGet-DbaHideInstanceGet-DbaInstalledPatchGet-DbaInstanceAuditGet-DbaInstanceAuditSpecificationGet-DbaInstanceInstallDateGet-DbaInstancePropertyGet-DbaInstanceProtocolGet-DbaInstanceTriggerGet-DbaInstanceUserOptionGet-DbaIoLatencyGet-DbaKbUpdateGet-DbaLastBackupGet-DbaLastGoodCheckDbGet-DbaLatchStatisticGet-DbaLinkedServerGet-DbaLinkedServerLoginGet-DbaLocaleSettingGet-DbaLoginGet-DbaMaintenanceSolutionLogGet-DbaManagementObjectGet-DbaMaxMemoryGet-DbaMemoryConditionGet-DbaMemoryUsageGet-DbaModuleGet-DbaMsdtcGet-DbaNetworkActivityGet-DbaNetworkCertificateGet-DbaNetworkConfigurationGet-DbaOleDbProviderGet-DbaOpenTransactionGet-DbaOperatingSystemGet-DbaPageFileSettingGet-DbaPbmCategoryGet-DbaPbmCategorySubscriptionGet-DbaPbmConditionGet-DbaPbmObjectSetGet-DbaPbmPolicyGet-DbaPbmStoreGet-DbaPermissionGet-DbaPfAvailableCounterGet-DbaPfDataCollectorGet-DbaPfDataCollectorCounterGet-DbaPfDataCollectorCounterSampleGet-DbaPfDataCollectorSetGet-DbaPfDataCollectorSetTemplateGet-DbaPlanCacheGet-DbaPowerPlanGet-DbaPrivilegeGet-DbaProcessGet-DbaProductKeyGet-DbaQueryExecutionTimeGet-DbaRandomizedDatasetGet-DbaRandomizedDatasetTemplateGet-DbaRandomizedTypeGet-DbaRandomizedValueGet-DbaRegistryRootGet-DbaRegServerGet-DbaRegServerGroupGet-DbaRegServerStoreGet-DbaReplArticleGet-DbaReplArticleColumnGet-DbaReplDistributorGet-DbaReplPublicationGet-DbaReplPublisherGet-DbaReplServerGet-DbaReplSubscriptionGet-DbaResourceGovernorGet-DbaRgClassifierFunctionGet-DbaRgResourcePoolGet-DbaRgWorkloadGroupGet-DbaRunningJobGet-DbaSchemaChangeHistoryGet-DbaServerRoleGet-DbaServerRoleMemberGet-DbaServiceGet-DbaSpConfigureGet-DbaSpinLockStatisticGet-DbaSpnGet-DbaSsisEnvironmentVariableGet-DbaSsisExecutionHistoryGet-DbaStartupParameterGet-DbaStartupProcedureGet-DbaSuspectPageGet-DbaTcpPortGet-DbaTempdbUsageGet-DbatoolsChangeLogGet-DbatoolsConfigGet-DbatoolsConfigValueGet-DbatoolsErrorGet-DbatoolsLogGet-DbatoolsPathGet-DbaTopResourceUsageGet-DbaTraceGet-DbaTraceFlagGet-DbaUptimeGet-DbaUserPermissionGet-DbaWaitingTaskGet-DbaWaitResourceGet-DbaWaitStatisticGet-DbaWindowsLogGet-DbaWsfcAvailableDiskGet-DbaWsfcClusterGet-DbaWsfcDiskGet-DbaWsfcNetworkGet-DbaWsfcNetworkInterfaceGet-DbaWsfcNodeGet-DbaWsfcResourceGet-DbaWsfcResourceGroupGet-DbaWsfcResourceTypeGet-DbaWsfcRoleGet-DbaWsfcSharedVolumeGet-DbaXEObjectGet-DbaXESessionGet-DbaXESessionTargetGet-DbaXESessionTargetFileGet-DbaXESessionTemplateGet-DbaXESmartTargetGet-DbaXEStoreGrant-DbaAgPermissionImport-CommandImport-DbaBinaryFileImport-DbaCsvImport-DbaPfDataCollectorSetTemplateImport-DbaRegServerImport-DbaSpConfigureImport-DbatoolsConfigImport-DbaXESessionTemplateInstall-DbaAgentAdminAlertInstall-DbaDarlingDataInstall-DbaFirstResponderKitInstall-DbaInstanceInstall-DbaMaintenanceSolutionInstall-DbaMultiToolInstall-DbaSqlWatchInstall-DbaWhoIsActiveInvoke-DbaAdvancedInstallInvoke-DbaAdvancedRestoreInvoke-DbaAdvancedUpdateInvoke-DbaAgFailoverInvoke-DbaBalanceDataFilesInvoke-DbaCycleErrorLogInvoke-DbaDbccDropCleanBufferInvoke-DbaDbccFreeCacheInvoke-DbaDbCloneInvoke-DbaDbDataGeneratorInvoke-DbaDbDataMaskingInvoke-DbaDbDbccCheckConstraintInvoke-DbaDbDbccCleanTableInvoke-DbaDbDbccUpdateUsageInvoke-DbaDbDecryptObjectInvoke-DbaDbLogShippingInvoke-DbaDbLogShipRecoveryInvoke-DbaDbMirrorFailoverInvoke-DbaDbMirroringInvoke-DbaDbPiiScanInvoke-DbaDbShrinkInvoke-DbaDbTransferInvoke-DbaDbUpgradeInvoke-DbaDiagnosticQueryInvoke-DbaPfRelogInvoke-DbaQueryInvoke-DbatoolsFormatterInvoke-DbatoolsRenameHelperInvoke-DbaWhoIsActiveInvoke-DbaXEReplayJoin-DbaAvailabilityGroupJoin-DbaPathMeasure-DbaBackupThroughputMeasure-DbaDbVirtualLogFileMeasure-DbaDiskSpaceRequirementMeasure-DbatoolsImportMount-DbaDatabaseMove-DbaDbFileMove-DbaRegServerMove-DbaRegServerGroupNew-DbaAgentAlertNew-DbaAgentAlertCategoryNew-DbaAgentJobNew-DbaAgentJobCategoryNew-DbaAgentJobStepNew-DbaAgentOperatorNew-DbaAgentProxyNew-DbaAgentScheduleNew-DbaAvailabilityGroupNew-DbaAzAccessTokenNew-DbaClientAliasNew-DbaCmConnectionNew-DbaComputerCertificateNew-DbaComputerCertificateSigningRequestNew-DbaConnectionStringNew-DbaConnectionStringBuilderNew-DbaCredentialNew-DbaCustomErrorNew-DbaDacOptionNew-DbaDacProfileNew-DbaDatabaseNew-DbaDbAsymmetricKeyNew-DbaDbCertificateNew-DbaDbDataGeneratorConfigNew-DbaDbEncryptionKeyNew-DbaDbFileGroupNew-DbaDbMailAccountNew-DbaDbMailProfileNew-DbaDbMaskingConfigNew-DbaDbMasterKeyNew-DbaDbRoleNew-DbaDbSchemaNew-DbaDbSequenceNew-DbaDbSnapshotNew-DbaDbSynonymNew-DbaDbTableNew-DbaDbTransferNew-DbaDbUserNew-DbaDiagnosticAdsNotebookNew-DbaDirectoryNew-DbaEndpointNew-DbaFirewallRuleNew-DbaLinkedServerNew-DbaLinkedServerLoginNew-DbaLoginNew-DbaReplCreationScriptOptionsNew-DbaReplPublicationNew-DbaReplSubscriptionNew-DbaRgResourcePoolNew-DbaRgWorkloadGroupNew-DbaScriptingOptionNew-DbaServerRoleNew-DbaServiceMasterKeyNew-DbaSqlParameterNew-DbaSsisCatalogNew-DbatoolsSupportPackageNew-DbaXESessionNew-DbaXESmartCsvWriterNew-DbaXESmartEmailNew-DbaXESmartQueryExecNew-DbaXESmartReplayNew-DbaXESmartTableWriterPublish-DbaDacPackageRead-DbaAuditFileRead-DbaBackupHeaderRead-DbaTraceFileRead-DbaTransactionLogRead-DbaXEFileRead-XEventRegister-DbatoolsConfigRemove-DbaAgDatabaseRemove-DbaAgentAlertRemove-DbaAgentAlertCategoryRemove-DbaAgentJobRemove-DbaAgentJobCategoryRemove-DbaAgentJobStepRemove-DbaAgentOperatorRemove-DbaAgentProxyRemove-DbaAgentScheduleRemove-DbaAgListenerRemove-DbaAgReplicaRemove-DbaAvailabilityGroupRemove-DbaBackupRemove-DbaClientAliasRemove-DbaCmConnectionRemove-DbaComputerCertificateRemove-DbaCredentialRemove-DbaCustomErrorRemove-DbaDatabaseRemove-DbaDatabaseSafelyRemove-DbaDbAsymmetricKeyRemove-DbaDbBackupRestoreHistoryRemove-DbaDbCertificateRemove-DbaDbCheckConstraintRemove-DbaDbDataRemove-DbaDbEncryptionKeyRemove-DbaDbFileGroupRemove-DbaDbLogShippingRemove-DbaDbMailAccountRemove-DbaDbMailProfileRemove-DbaDbMasterKeyRemove-DbaDbMirrorRemove-DbaDbMirrorMonitorRemove-DbaDbOrphanUserRemove-DbaDbPartitionFunctionRemove-DbaDbPartitionSchemeRemove-DbaDbRoleRemove-DbaDbRoleMemberRemove-DbaDbSchemaRemove-DbaDbSequenceRemove-DbaDbSnapshotRemove-DbaDbSynonymRemove-DbaDbTableRemove-DbaDbTableDataRemove-DbaDbUdfRemove-DbaDbUserRemove-DbaDbViewRemove-DbaEndpointRemove-DbaExtendedPropertyRemove-DbaFirewallRuleRemove-DbaLinkedServerRemove-DbaLinkedServerLoginRemove-DbaLoginRemove-DbaNetworkCertificateRemove-DbaPfDataCollectorCounterRemove-DbaPfDataCollectorSetRemove-DbaRegServerRemove-DbaRegServerGroupRemove-DbaReplArticleRemove-DbaReplPublicationRemove-DbaReplSubscriptionRemove-DbaRgResourcePoolRemove-DbaRgWorkloadGroupRemove-DbaServerRoleRemove-DbaServerRoleMemberRemove-DbaSpnRemove-DbaTraceRemove-DbaXESessionRemove-DbaXESmartTargetRename-DbaDatabaseRename-DbaLoginRepair-DbaDbMirrorRepair-DbaDbOrphanUserRepair-DbaInstanceNameReset-DbaAdminReset-DbatoolsConfigResolve-DbaNetworkNameResolve-DbaPathRestart-DbaServiceRestore-DbaDatabaseRestore-DbaDbCertificateRestore-DbaDbSnapshotResume-DbaAgDbDataMovementRevoke-DbaAgPermissionSave-DbaCommunitySoftwareSave-DbaDiagnosticQueryScriptSave-DbaKbUpdateSelect-DbaBackupInformationSelect-DbaDbSequenceNextValueSelect-DbaObjectSet-DbaAgentAlertSet-DbaAgentJobSet-DbaAgentJobCategorySet-DbaAgentJobOutputFileSet-DbaAgentJobOwnerSet-DbaAgentJobStepSet-DbaAgentOperatorSet-DbaAgentScheduleSet-DbaAgentServerSet-DbaAgListenerSet-DbaAgReplicaSet-DbaAvailabilityGroupSet-DbaCmConnectionSet-DbaDbCompatibilitySet-DbaDbCompressionSet-DbaDbFileGroupSet-DbaDbFileGrowthSet-DbaDbIdentitySet-DbaDbMirrorSet-DbaDbOwnerSet-DbaDbQueryStoreOptionSet-DbaDbRecoveryModelSet-DbaDbSchemaSet-DbaDbSequenceSet-DbaDbStateSet-DbaDefaultPathSet-DbaEndpointSet-DbaErrorLogConfigSet-DbaExtendedPropertySet-DbaExtendedProtectionSet-DbaLoginSet-DbaMaxDopSet-DbaMaxMemorySet-DbaNetworkCertificateSet-DbaNetworkConfigurationSet-DbaPowerPlanSet-DbaPrivilegeSet-DbaResourceGovernorSet-DbaRgResourcePoolSet-DbaRgWorkloadGroupSet-DbaSpConfigureSet-DbaSpnSet-DbaStartupParameterSet-DbaTcpPortSet-DbaTempDbConfigSet-DbatoolsConfigSet-DbatoolsInsecureConnectionSet-DbatoolsPathShow-DbaDbListShow-DbaInstanceFileSystemStart-DbaAgentJobStart-DbaDbEncryptionStart-DbaEndpointStart-DbaMigrationStart-DbaPfDataCollectorSetStart-DbaServiceStart-DbaTraceStart-DbaXESessionStart-DbaXESmartTargetStop-DbaAgentJobStop-DbaDbEncryptionStop-DbaEndpointStop-DbaExternalProcessStop-DbaPfDataCollectorSetStop-DbaProcessStop-DbaServiceStop-DbaTraceStop-DbaXESessionStop-DbaXESmartTargetSuspend-DbaAgDbDataMovementSync-DbaAvailabilityGroupSync-DbaLoginPermissionTest-DbaAgentJobOwnerTest-DbaAgSpnTest-DbaAvailabilityGroupTest-DbaBackupEncryptedTest-DbaBackupInformationTest-DbaBuildTest-DbaCmConnectionTest-DbaComputerCertificateExpirationTest-DbaConnectionTest-DbaConnectionAuthSchemeTest-DbaDbCollationTest-DbaDbCompatibilityTest-DbaDbCompressionTest-DbaDbDataGeneratorConfigTest-DbaDbDataMaskingConfigTest-DbaDbLogShipStatusTest-DbaDbOwnerTest-DbaDbQueryStoreTest-DbaDbRecoveryModelTest-DbaDeprecatedFeatureTest-DbaDiskAlignmentTest-DbaDiskAllocationTest-DbaDiskSpeedTest-DbaEndpointTest-DbaIdentityUsageTest-DbaInstanceNameTest-DbaLastBackupTest-DbaLinkedServerConnectionTest-DbaLoginPasswordTest-DbaManagementObjectTest-DbaMaxDopTest-DbaMaxMemoryTest-DbaMigrationConstraintTest-DbaNetworkLatencyTest-DbaOptimizeForAdHocTest-DbaPathTest-DbaPowerPlanTest-DbaReplLatencyTest-DbaSpnTest-DbaTempDbConfigTest-DbaWindowsLoginUninstall-DbaSqlWatchUnregister-DbatoolsConfigUpdate-DbaBuildReferenceUpdate-DbaInstanceUpdate-DbaMaintenanceSolutionUpdate-DbaServiceAccountUpdate-DbatoolsWatch-DbaDbLoginWatch-DbaXESessionWrite-DbaDbTableData
^

Get-DbaClientProtocol

Author Klaas Vandenberghe (@PowerDBAKlaas)
Availability Windows, Linux, macOS

 

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

Synopsis

Gets the SQL Server related client protocols on a computer.

Description

Gets the SQL Server related client protocols on one or more computers.

Requires Local Admin rights on destination computer(s).
The client protocols can be enabled and disabled when retrieved via WSMan.

Syntax

Get-DbaClientProtocol
    [[-ComputerName] <DbaInstanceParameter[]>]
    [[-Credential] <PSCredential>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-DbaClientProtocol -ComputerName sqlserver2014a

Gets the SQL Server related client protocols on computer sqlserver2014a.

Example: 2
PS C:\> 'sql1','sql2','sql3' | Get-DbaClientProtocol

Gets the SQL Server related client protocols on computers sql1, sql2 and sql3.

Example: 3
PS C:\> Get-DbaClientProtocol -ComputerName sql1,sql2 | Out-GridView

Gets the SQL Server related client protocols on computers sql1 and sql2, and shows them in a grid view.

Example: 4
PS C:\> (Get-DbaClientProtocol -ComputerName sql2 | Where-Object { $_.DisplayName -eq 'Named Pipes' }).Disable()

Disables the VIA ClientNetworkProtocol on computer sql2.
If successful, return code 0 is shown.

Optional Parameters

-ComputerName

The target SQL Server instance or instances.

Alias cn,host,Server
Required False
Pipeline true (ByValue)
Default Value $env:COMPUTERNAME
-Credential

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

Alias
Required False
Pipeline false
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
Required False
Pipeline false
Default Value False