Share via

Get-SCSPFSetting

Module:
spfadmin Module

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

Syntax

Empty (Default) 

Get-SCSPFSetting
    [-SettingType <String>]
    [<CommonParameters>]

FromSettingIdParameterSetName 

Get-SCSPFSetting
    -ID <Guid[]>
    [<CommonParameters>]

FromSettingNameParameterSetName 

Get-SCSPFSetting
    -Name <String[]>
    [<CommonParameters>]

FromSettingServerSettingTypeParameterSetName 

Get-SCSPFSetting
    -Server <Server>
    [-SettingType <String>]
    [<CommonParameters>]

FromSettingServerNameSettingTypeParameterSetName 

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.

Parameter properties

Type:

System.Guid[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

FromSettingIdParameterSetName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies a name for the setting.

Parameter properties

Type:

System.String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

FromSettingNameParameterSetName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Server

Specifies a server object associated with the setting.

Parameter properties

Type:Microsoft.SystemCenter.Foundation.SPFData.Types.Server
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

FromSettingServerSettingTypeParameterSetName
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-ServerName

Specifies the name of the sever associated with the setting.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

FromSettingServerNameSettingTypeParameterSetName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SettingType

Specifies either DatabaseConnectionString or EndPointConnectionString.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Empty
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
FromSettingServerSettingTypeParameterSetName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
FromSettingServerNameSettingTypeParameterSetName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.SystemCenter.Foundation.SPFData.Types.Server

Outputs

System.Object