Export (0) Print
Expand All

Add-AvailabilityAddressSpace

 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-09-18

This cmdlet is available in on-premises Exchange Server 2013 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Add-AvailabilityAddressSpace cmdlet to define the access method and associated credentials used to exchange free/busy data across forests.

NoteNote:
The maximum number off Availability address spaces returned by Active Directory to Exchange is 100. Microsoft recommends using 100 or fewer address spaces in order for Availability lookups to work properly.

For information about the parameter sets in the Syntax section below, see Syntax.

Add-AvailabilityAddressSpace -AccessMethod <PerUserFB | OrgWideFB | PublicFolder | InternalProxy | OrgWideFBBasic> -ForestName <String> [-Confirm [<SwitchParameter>]] [-Credentials <PSCredential>] [-DomainController <Fqdn>] [-Organization <OrganizationIdParameter>] [-ProxyUrl <Uri>] [-TargetAutodiscoverEpr <Uri>] [-UseServiceAccount <$true | $false>] [-WhatIf [<SwitchParameter>]]

This example is useful with an untrusted cross-forest Availability service, or if detailed cross-forest free/busy service isn't desired. Enter a user name and password when you're prompted by the command. For an untrusted cross-forest configuration, make sure that the user doesn't have a mailbox.

Add-AvailabilityAddressSpace -ForestName <example.contoso.com> -AccessMethod OrgWideFB -Credentials <ExampleCredential>

This example is useful with a trusted cross-forest Availability service. The contoso.com forest trusts the current forest, and the specified account connects to the contoso.com forest. The specified account must be an existing account in the contoso.com forest.

Add-AvailabilityAddressSpace -ForestName <example.contoso.com> -AccessMethod PerUserFB -Credentials <ExampleCredential>

This example is useful with a trusted cross-forest Availability service. The contoso.com forest trusts the current forest and uses the service account (typically the local system account or the computer account) to connect to the contoso.com forest. Because the service is trusted, there is no issue with authorization when the current forest tries to retrieve free/busy information from contoso.com.

Add-AvailabilityAddressSpace -ForestName <example.contoso.com> -AccessMethod PerUserFB -UseServiceAccount $true

This example is useful for interoperability between Exchange 2013 and versions of Exchange earlier than Exchange 2007, for example Exchange 2003.

Add-AvailabilityAddressSpace -ForestName <example.contoso.com> -AccessMethod PublicFolder 

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Availability service address space settings" entry in the Clients and mobile devices permissions topic.

 

Parameter Required Type Description

AccessMethod

Required

Microsoft.Exchange.Data.Directory.SystemConfiguration.AvailabilityAccessMethod

The AccessMethod parameter specifies the availability access method and can have the following values:

  • PerUserFB   This value causes the command to access the free/busy data in the defined per-user free/busy proxy account or group, or in the All Exchange Servers group. The PerUserFB value requires trust between the two forests. You must use either the UseServiceAccount parameter or Credentials parameter.

  • OrgWideFB   This value causes the command to access the free/busy data in the per-user free/busy proxy account or group in the target forest. You must use either the UseServiceAccount parameter or Credentials parameter.

  • OrgWideFBBasic   This value is reserved for internal Microsoft use.

  • InternalProxy   This value is used to proxy a request to the Client Access server in the site with the latest version of Exchange.

  • PublicFolder   This value causes the command to access free/busy data on servers running Microsoft Exchange Server 2003. The Exchange Inter-Organization Replication tool must be running between the two forests.

ForestName

Required

System.String

The ForestName parameter specifies the SMTP domain name of the target forest for users whose free/busy data must be retrieved. If your users are distributed among multiple SMTP domains in the target forest, run the Add-AvailabilityAddressSpace command once for each SMTP domain.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch 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 switch.

Credentials

Optional

System.Management.Automation.PSCredential

The Credentials parameter specifies the credentials for an account that has permission to access the Availability services in the target forest.

This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see Get-Credential.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2013.

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

ProxyUrl

Optional

System.Uri

This parameter is available only in on-premises Exchange 2013.

The ProxyUrl parameter specifies whether to direct a Microsoft Exchange Server 2007 Client Access server to proxy its free/busy requests through an Exchange Server 2013 Client Access server when requesting federated free/busy data for a user in another organization.

Before you can configure this setting, you must create the proper trust relationships and sharing relationships. For more information, see New-FederationTrust.

TargetAutodiscoverEpr

Optional

System.Uri

The TargetAutodiscoverEpr parameter specifies the Autodiscover URL of Exchange Web Services for the external organization, for example, https://contoso.com/autodiscover/autodiscover.svc/wssecurity. Exchange uses Autodiscover to automatically detect the correct server endpoint for external requests.

UseServiceAccount

Optional

System.Boolean

This parameter is available only in on-premises Exchange 2013.

The UseServiceAccount parameter, when assigned a value of $true, uses the local Availability service account for authorization.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, 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 switch.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft