Add-AdfsProxy
Add-AdfsProxy
Configures this computer as a federation server proxy.
Syntax
Parameter Set: Default
Add-AdfsProxy [-FederationServiceName] <String> -FederationServiceTrustCredential <PSCredential> [-ForwardProxy <String> ] [ <CommonParameters>]
Detailed Description
The Add-Adfsproxy cmdlet configures this computer as a federation server proxy.
Parameters
-FederationServiceName<String>
Specifies the name of the federation service for which this computer will proxy requests.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-FederationServiceTrustCredential<PSCredential>
Specifies the credentials of the Active Directory identity that is authorized to register new federation server proxies. By default, this is the account under which the federation service runs or an account that is a member of the administrators group on the federation server.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ForwardProxy<String>
Specifies the DNS name and port of an HTTP proxy that this federation server proxy will use to obtain access to the federation service. For example, the syntax to use to specify a forward proxy with a host name of "proxy01" that is located within the corp.contoso.com domain and that can be reached using the HTTP port of 8080 would be "proxy-01.corp.contoso.com:8080".
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
- none
Outputs
The output type is the type of the objects that the cmdlet emits.
- Result object
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
Adds a federation service proxy to an existing AD FS installation with federation service name fs.corp.contoso.com. Credentials entered as FederationServiceTrustCredential can be the AD FS service account or another account that has administrative permissions on the federation server(s) on which the federation service is installed.
C:\PS>$fsCredential = Get-Credential
C:\PS>Add-AdfsProxy -FederationServiceName fs.corp.contoso.com -FederationServiceTrustCredential $fscredential