Remove-SCSPFSetting

Article
10/29/2013

Applies To: System Center 2012 R2 Orchestrator

Remove-SCSPFSetting

Removes a setting.

Syntax

Parameter Set: FromSettingParameterSetName
Remove-SCSPFSetting -SpfSetting <SpfSetting[]> [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Remove-SCSPFSetting cmdlet removes a connection string for either a database connection or for a portal endpoint connection.

Parameters

-SpfSetting<SpfSetting[]>

Specifies one or more settings to remove.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before executing the command.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

1: Remove a setting

This command obtains a setting by its name and then sends it to the next command in the pipeline to be removed.

PS C:\> $OldSetting = Get-SCSPFSetting -Name 'mysetting' | Remove-SCSPFSetting

Remove-SCSPFSetting