Set-OutlookProvider
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Set-OutlookProvider cmdlet to set specific global settings by using the msExchOutlookProvider attribute on the msExchAutoDiscoverConfig object in the Active Directory directory service.
Syntax
Set-OutlookProvider -Identity <OutlookProviderIdParameter> [-CertPrincipalName <String>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Name <String>] [-Server <String>] [-TTL <Int32>] [-WhatIf [<SwitchParameter>]]
Set-OutlookProvider [-CertPrincipalName <String>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Instance <OutlookProvider>] [-Name <String>] [-Server <String>] [-TTL <Int32>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Set-OutlookProvider cmdlet creates the global settings for the AutoDiscover service. It sets the AutoDiscoverConfig object under the Global Settings object in Active Directory and sets the attributes specified in the parameters listed in the Parameters section.
To run the Set-OutlookProvider cmdlet, the account you use must be delegated the following:
- Exchange Organization Administrator role
For more information about permissions, delegating roles, and the rights that are required to administer Microsoft Exchange Server 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.OutlookProviderIdParameter |
The Identity parameter specifies the ADIDParameter value of the MAPI protocol for which you want to set global settings. |
CertPrincipalName |
Optional |
System.String |
The CertPrincipalName parameter specifies the Secure Sockets Layer (SSL) certificate principal name required for connecting to Exchange from an external location. This parameter is only used for Microsoft Outlook Anywhere clients. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm parameter causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm parameter. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory, include the DomainController parameter in the command. |
Instance |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.OutlookProvider |
The Instance parameter enables you to pass an entire object to the command to be processed. It is mainly used in scripts where an entire object must be passed to the command. |
Name |
Optional |
System.String |
Use the Name parameter to specify a common name for the Outlook Provider Configuration object. This can be a user-friendly name for identification. |
Server |
Optional |
System.String |
Use the Server parameter to specify the mail server to use for Outlook Anywhere clients. |
TTL |
Optional |
System.Int32 |
The TTL parameter specifies the duration (in hours) that the specified settings are valid. If a value is specified, the settings are rediscovered via AutoDiscover after the duration specified with this parameter. A value of 0 indicates that no rediscovery will be required. The default value is 1 hour. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf parameter. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
Exceptions
| Exceptions | Description |
|---|---|
|
Example
In this example, the Set-OutlookProvider command is used to change the duration that the auto-discovery settings are valid for the Outlook Provider msExchAutoDiscoverConfig.
Set-OutlookProvider -Identity msExchAutoDiscoverConfig -TTL 2