Set-ADFSProxyProperties

Article
02/25/2013

Set-ADFSProxyProperties

Sets the properties of the federation server proxy.

Syntax

Set-ADFSProxyProperties [-ForwardProxyUrl <Uri>] [-HostName <string>] [-HttpPort <System.Nullable[int]>] [-HttpsPort <System.Nullable[int]>] [-LogLevel <string[]>] [-PassThru] [-ProxyTrustRenewPeriod <int>] [-Confirm] [-WhatIf] [<CommonParameters>]

ForwardProxyUrl
HostName
HttpPort
HttpsPort
LogLevel
PassThru
ProxyTrustRenewPeriod
Confirm
WhatIf

Detailed Description

The Set-ADFSProxyProperties cmdlet changes the properties of a previously configured federation server proxy.

Parameters

ForwardProxyUrl

Specifies the URL of a forward proxy to use for communication to the federation service, if any. By default, there is no forward proxy configured.

Default Value: **

Data Type: Uri

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	false	pipelineInput
Position?	named	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	true	required
Variable Length?	false	variableLength

HostName

Specifies the network addressable host name of the Federation Service.

Default Value: **

Data Type: string

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	false	pipelineInput
Position?	named	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	true	required
Variable Length?	false	variableLength

HttpPort

Specifies the HTTP port for the server. The default value is 80.

Default Value: **

Data Type: System.Nullable[int]

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	false	pipelineInput
Position?	named	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	true	required
Variable Length?	false	variableLength

HttpsPort

Specifies the HTTPS port for the server. The default value is 443.

Default Value: **

Data Type: System.Nullable[int]

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	false	pipelineInput
Position?	named	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	true	required
Variable Length?	false	variableLength

LogLevel

Specifies the level of logging detail. The list defines which types of events are logged.

Possible values are Errors, Warnings, Information, SuccessAudits, and FailureAudits.

Default Value: **

Data Type: string[]

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	true	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	false	pipelineInput
Position?	named	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	true	required
Variable Length?	true	variableLength

PassThru

Passes an object to the pipeline. By default, this cmdlet does not generate any output.

Default Value: **

Data Type: SwitchParameter

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	false	pipelineInput
Position?	named	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength

ProxyTrustRenewPeriod

Sets the interval (in minutes) that the federation server proxy uses to check with its associated federation server for updated trust tokens.

Default Value: **

Data Type: int

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	false	pipelineInput
Position?	named	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	true	required
Variable Length?	false	variableLength

Confirm

Prompts you for confirmation before executing the command.

Default Value: **

Data Type: SwitchParameter

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	true	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	false	pipelineInput
Position?	named	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength

WhatIf

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

Default Value: **

Data Type: SwitchParameter

Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	true	variableLength
Accept wildcard characters?	false	globbing
Accept Pipeline Input?	false	pipelineInput
Position?	named	position

Value Attributes

Name	Value	PSMAML Attribute
Required?	false	required
Variable Length?	false	variableLength

Input Type

None

Return Type

None

Notes

This cmdlet may be used only on a computer that is configured in Active Directory Federation Services (AD FS) 2.0 as a federation server proxy. It will not work on a federation server.

Examples

-------------------------- EXAMPLE 1 --------------------------

Command Prompt: C:\PS>

 
Set-ADFSProxyProperties -Hostname "fs.fabrikam.com"

Description

-----------

Sets the properties for the federation server proxy with the name "fs.fabrikam.com".

Set-ADFSProxyProperties