Set-ActiveSyncOrganizationSettings

 

Applies to: Exchange Online, Exchange Server 2016

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

Use the Set-ActiveSyncOrganizationSettings cmdlet to set the Microsoft Exchange ActiveSync settings for the organization.

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

Set-ActiveSyncOrganizationSettings [-Identity <ActiveSyncOrganizationSettingsIdParameter>] <COMMON PARAMETERS>

Set-ActiveSyncOrganizationSettings -Identity <ActiveSyncOrganizationSettingsIdParameter> <COMMON PARAMETERS>

Set-ActiveSyncOrganizationSettings -Identity <ActiveSyncOrganizationSettingsIdParameter> <COMMON PARAMETERS>

Set-ActiveSyncOrganizationSettings -Identity <ActiveSyncOrganizationSettingsIdParameter> <COMMON PARAMETERS>

Set-ActiveSyncOrganizationSettings -Identity <ActiveSyncOrganizationSettingsIdParameter> <COMMON PARAMETERS>

COMMON PARAMETERS: [-AdminMailRecipients <MultiValuedProperty>] [-AllowAccessForUnSupportedPlatform <$true | $false>] [-Confirm [<SwitchParameter>]] [-DefaultAccessLevel <Allow | Block | Quarantine>] [-DomainController <Fqdn>] [-OtaNotificationMailInsert <String>] [-UserMailInsert <String>] [-WhatIf [<SwitchParameter>]]

This example sets the default access level to quarantine and sets two administrative email addresses.

Set-ActiveSyncOrganizationSettings -DefaultAccessLevel Quarantine -AdminMailRecipients will@contoso.com,roger@contoso.com

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 "Exchange ActiveSync settings" entry in the Clients and mobile devices permissions topic.

 

Parameter Required Type Description

AdminMailRecipients

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AdminMailRecipients parameter specifies the email addresses of the administrators for reporting purposes.

To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>"....

To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}.

AllowAccessForUnSupportedPlatform

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

DefaultAccessLevel

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.DeviceAccessLevel

The DefaultAccessLevel parameter specifies the access level for new devices. Valid values are Allow,Block or Quarantine. The default value is Allow.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

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

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.ActiveSyncOrganizationSettingsIdParameter

The Identity parameter specifies the ActiveSync organization settings object that you want to modify. The default name of this object is Mobile Mailbox Settings.

OtaNotificationMailInsert

Optional

System.String

The OtaNotificationMailInsert parameter specifies the text to include in an email message that's sent to users who need to update their older devices to use the new Exchange ActiveSync features in Microsoft Exchange.

The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks (").

UserMailInsert

Optional

System.String

The UserMailInsert parameter specifies an informational footer that's added to the email message sent to users when their mobile device isn't synchronized because the device is quarantined.

The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks (").

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this 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.

 
Show: