Skip to main content
SnapCenter 4.9 cmdlets

Remove-SdStorageConnectionSetting

Contributors
PDFs

Removes the storage connection, transport, and credential settings from the configuration repository for one or more storage system or virtual storage server.

Syntax

Remove-SdStorageConnectionSetting [-StorageSystem]  <String[]>  [-HostOnly]  <>  [-PassThru]  <>  [-LegacyContext]  <>  [-Session]  <String>  [-Host]  <String>  [-All]  <>  [-HostOnly]  <>  [-PassThru]  <>  [-LegacyContext]  <>  [-Session]  <String>  [-Host]  <String>  [-DefaultSetting]  <>  [-HostOnly]  <>  [-PassThru]  <>  [-LegacyContext]  <>  [-Session]  <String>  [-Host]  <String>

Detailed Description

Removes the storage connection, transport and credential settings from the configuration repository for one or more storage system or virtual storage server.Related cmdlets: Set-SdStorageConnectionSetting and Get-SdStorageConnectionSetting

Parameters

Name Description Required? Pipeline Input Default Value

StorageSystem

Specifies the name or IP address of the storage system (storage controller or virtual storage server) for which you want to retrieve connection settings.

true

true (ByPropertyName)

HostOnly

Specifies that you want to remove the storage system credentials only on the cluster node you specify. The default behavior is that HostOnly is not specified, and your storage credential settings are removed from all the nodes in a cluster.

false

true (ByPropertyName)

PassThru

Indicates the output setting objects that you removed from the configuration. These objects are written to the pipeline for further processing.

false

true (ByPropertyName)

false

LegacyContext

For internal use only.

false

false

Session

false

true (ByPropertyName)

Host

Specifies the name or IP address of the host on which you execute the operation. The default is your local machine.

false

true (ByPropertyName)

All

Indicates that you want to remove all connection settings, including the default settings, from the configuration repository.

true

true (ByPropertyName)

DefaultSetting

Indicates that you want to remove the default storage system connection settings.

true

false

Examples

Example 1: Removing named connection settings

 PS C:\> Remove-SdStorageSystemSetting -StorageSystem vmStorageServer,sqlServer -PassThru

This example syntax removes the specified vmStorageServer and sqlServer storage system connection settings.

Example 2: Removing all connection settings

 PS C:\> Remove-SdStorageConnectionSetting -All -PassThru

This example syntax removes all the connection settings, including the default connection settings.

Example 3: Removing default storage connection settings

 PS C:\> Remove-SdStorageConnectionSetting -DefaultSetting -PassThru

This example syntax removes the default storage system connection settings. You can use the default settings to attempt a connection to any system that is not explicitly configured.

Example 4: Removing pipeline storage connection settings

 PS C:\> $settings = Get-SdStorageConnectionSetting
$settings | Remove-SdStorageConnectionSetting -PassThru -confirm:$false

This example syntax retrieves the existing storage connection settings. In this case, they are "vmStorageServer" and "sharePointServer". Then the example pipes those names as the connection settings to be removed. Because the confirm value is false, there is no confirmation prompt and the PassThru switch means it outputs the objects removed.