Share via

Get-SCSPFSetting

  • Reference
Module:
spfadmin

Gets a setting for a database connection or for a portal endpoint.

Syntax

Get-SCSPFSetting
   [-SettingType <String>]
   [<CommonParameters>]
Get-SCSPFSetting
   -ID <Guid[]>
   [<CommonParameters>]
Get-SCSPFSetting
   -Name <String[]>
   [<CommonParameters>]
Get-SCSPFSetting
   -Server <Server>
   [-SettingType <String>]
   [<CommonParameters>]
Get-SCSPFSetting
   -ServerName <String>
   [-SettingType <String>]
   [<CommonParameters>]

Description

The Get-SCSPFSetting cmdlet gets the setting for a database connection or for a portal endpoint connection.

Examples

Example 1: Get a setting

PS C:\>$Setting = Get-SCSPFSetting -ID f3b39608-ac58-40b7-853c-241e343b256a

This command gets an existing setting by its ID.

Parameters

-ID

Specifies the GUID for the setting.

Type:System.Guid[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies a name for the setting.

Type:System.String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Server

Specifies a server object associated with the setting.

Type:Microsoft.SystemCenter.Foundation.SPFData.Types.Server
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ServerName

Specifies the name of the sever associated with the setting.

Type:System.String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SettingType

Specifies either DatabaseConnectionString or EndPointConnectionString.

Type:System.String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.SystemCenter.Foundation.SPFData.Types.Server

Outputs

System.Object