Export (0) Print
Expand All

Set-OrganizationRelationship

 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-03-14

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 Set-OrganizationRelationship cmdlet to modify a relationship with an external Exchange organization for the purposes of accessing calendar free/busy information or moving mailboxes between on-premises Exchange servers and the Exchange Online service as part of a hybrid deployment.

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

Set-OrganizationRelationship -Identity <OrganizationRelationshipIdParameter> [-ArchiveAccessEnabled <$true | $false>] [-Confirm [<SwitchParameter>]] [-DeliveryReportEnabled <$true | $false>] [-DomainController <Fqdn>] [-DomainNames <MultiValuedProperty>] [-Enabled <$true | $false>] [-Force <SwitchParameter>] [-FreeBusyAccessEnabled <$true | $false>] [-FreeBusyAccessLevel <None | AvailabilityOnly | LimitedDetails>] [-FreeBusyAccessScope <GroupIdParameter>] [-MailboxMoveEnabled <$true | $false>] [-MailTipsAccessEnabled <$true | $false>] [-MailTipsAccessLevel <None | Limited | All>] [-MailTipsAccessScope <GroupIdParameter>] [-Name <String>] [-OrganizationContact <SmtpAddress>] [-PhotosEnabled <$true | $false>] [-TargetApplicationUri <Uri>] [-TargetAutodiscoverEpr <Uri>] [-TargetOwaURL <Uri>] [-TargetSharingEpr <Uri>] [-WhatIf [<SwitchParameter>]]

This example modifies the free/busy access level to LimitedDetails, which includes time, subject, and location.

Set-OrganizationRelationship -Identity "Fourth Coffee" -FreeBusyAccessLevel LimitedDetails

This example disables the organization relationship with Contoso

Set-OrganizationRelationship -Identity "Contoso" -Enabled $false

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 "Organization relationships" entry in the Recipients Permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.OrganizationRelationshipIdParameter

The Identity parameter specifies the organization relationship to be modified. You can use the following values:

  • Canonical name

  • GUID

  • Name

ArchiveAccessEnabled

Optional

System.Boolean

The ArchiveAccessEnabled parameter specifies whether the organization relationship has been configured to provide remote archive access. Valid input for the ArchiveAccessEnabled parameter is $true or $false. The default value is $false. When the ArchiveAccessEnabled parameter is set to $true, the external organization specified in the organization relationship provides remote access to mailbox archives.

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.

DeliveryReportEnabled

Optional

System.Boolean

The DeliveryReportEnabled parameter specifies whether Delivery Report data should be shared over this organization relationship.

The accepted values are $true or $false. The default value is $false.

If set to $true, this means the following two things:

  • The organization has agreed to share all Delivery Report data with the organization specified in the organization relationship.

  • This organization relationship should be used to retrieve Delivery Report information from the organization referenced in the organization relationship.

For message tracking to work in a cross-premises, Exchange scenario, the DeliveryReportEnabled parameter must be set to $true on both sides of the organization relationship. If one, or both, of the members of the organization relationship specifies the DeliveryReportEnabled parameter as $false, tracking between the organizations won't work in either direction.

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.

DomainNames

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The DomainNames parameter specifies the SMTP domains of the external organization. If adding multiple domain names, separate each entry with a comma, for example, "contoso.com","northamerica.contoso.com".

Enabled

Optional

System.Boolean

The Enabled parameter specifies whether to enable the organization relationship. This parameter can be used to completely stop the sharing for a particular relationship. The valid input values are $true or $false. The default value is $true.

Force

Optional

System.Management.Automation.SwitchParameter

The Force switch specifies whether to suppress the warning or confirmation messages that appear during specific configuration changes.

FreeBusyAccessEnabled

Optional

System.Boolean

The FreeBusyAccessEnabled parameter specifies whether this organization relationship should be used for retrieving free/busy information from the external organization.

The accepted values are $true or $false.

The default value is $false.

FreeBusyAccessLevel

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.FreeBusyAccessLevel

The FreeBusyAccessLevel parameter specifies the maximum amount of detail returned to the requesting organization.

You can use the following values:

  • None   No free/busy access

  • AvailabilityOnly   Free/busy access with time only

  • LimitedDetails   Free/busy access with time, subject, and location

FreeBusyAccessScope

Optional

Microsoft.Exchange.Configuration.Tasks.GroupIdParameter

The FreeBusyAccessScope parameter specifies a security distribution group in the internal organization that contains users that can have their free/busy information accessed by an external organization. You can use the following values:

  • Canonical name

  • Display name

  • Distinguished name (DN)

  • GUID

  • Name

MailboxMoveEnabled

Optional

System.Boolean

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

The MailboxMoveEnabled parameter specifies that the organization relationship is used to provide the credential information for moving mailboxes to the external organization. If this parameter isn't set, the move requests require an administrator to provide a remote credential for the remote organization. The accepted values are $true or $false. The default value is $false.

MailTipsAccessEnabled

Optional

System.Boolean

The MailTipsAccessEnabled parameter specifies whether MailTips data for users in this organization are returned over this organization relationship. The accepted values are $true or $false. The default value is $false.

MailTipsAccessLevel

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.MailTipsAccessLevel

The MailTipsAccessLevel parameter specifies the level of MailTips data externally shared over this organization relationship. This parameter can have the following values:

  • All   All MailTips are returned, but the recipients in the remote organization are considered external. For the Auto Reply MailTip, the external Auto Reply message is returned.

  • Limited   Only those MailTips that could prevent a non-delivery report (NDR) or an Auto Reply are returned. Custom MailTips, the Large Audience MailTip, and Moderated Recipient MailTips won't be returned.

  • None   No MailTips are returned to the remote organization.

The default value is None.

MailTipsAccessScope

Optional

Microsoft.Exchange.Configuration.Tasks.GroupIdParameter

The MailTipsAccessScope parameter specifies a Security Distribution group in the organization that contains users for whom recipient-specific MailTips are returned over this organization relationship. The recipient-specific MailTips are:

  • Auto Reply

  • Mailbox Full

  • Custom

If a group is specified, these MailTips are returned only for those recipients that are members of the specified group. If a group isn't specified, recipient-specific MailTips are returned for all recipients in the organization. By default, no group is specified.

This restriction only applies to mailboxes, mail users, and mail contacts. It doesn't apply to distribution groups.

Name

Optional

System.String

The Name parameter specifies the meaningful name of the organization relationship. Use this parameter to change the name of the organization relationship.

OrganizationContact

Optional

Microsoft.Exchange.Data.SmtpAddress

The OrganizationContact parameter specifies the email address that can be used to contact the external organization, for example, administrator@fourthcoffee.com.

PhotosEnabled

Optional

System.Boolean

The PhotosEnabled parameter specifies whether photo data for users in this organization are returned over this organization relationship. The accepted values are $true or $false. The default value is $false.

TargetApplicationUri

Optional

System.Uri

The TargetApplicationUri parameter specifies the target Uniform Resource Identifier (URI) of the external organization. The TargetApplicationUri parameter is specified by Exchange when requesting a delegated token to retrieve free and busy information, for example, mail.contoso.com.

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 Client Access server endpoint for external requests.

TargetOwaURL

Optional

System.Uri

The TargetOwaURL parameter specifies the Microsoft Office Outlook Web App URL of the external organization defined in the organization relationship. It is used for Outlook Web App redirection in a cross-premise Exchange scenario. Configuring this attribute enables users in the organization to use their current Outlook Web App URL to access Outlook Web App in the external organization.

TargetSharingEpr

Optional

System.Uri

The TargetSharingEpr parameter specifies the URL of the target Exchange Web Services for the external organization. If the TargetSharingEpr parameter is used, Exchange always uses this URL to reach the external Client Access server and doesn't use the TargetAutoDiscoverEpr parameter information to locate the Client Access server.

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