Edit

Share via

New-CMExchangeServer

  • Reference
Module:
ConfigurationManager

Configures a new Exchange Server connector.

Syntax

New-CMExchangeServer
   [-AccessLevel <AccessLevelType>]
   [-ActiveDirectoryContainer <String[]>]
   [-AllowExternalDeviceManagement <Boolean>]
   [-ApplicationSetting <ExchangeConnectorApplicationSetting>]
   [-DeltaSyncMins <Int32>]
   [-EmailAddress <String[]>]
   [-EmailManagementSetting <ExchangeConnectorEmailManagementSetting>]
   [-EnableAccessRule <Boolean>]
   [-ExchangeClientAccessServer <Dictionary`2[]>]
   [-FullSyncSchedule <IResultObject>]
   [-GeneralSetting <ExchangeConnectorGeneralSetting>]
   [-IsHosted <Boolean>]
   [-MaximumInactiveDay <Int32>]
   [-NotificationUserName <String>]
   [-OnPrem]
   [-PasswordSetting <ExchangeConnectorPasswordSetting>]
   [-SecuritySetting <ExchangeConnectorSecuritySetting>]
   -ServerAddress <String>
   [-SiteCode <String>]
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-CMExchangeServer
   [-AccessLevel <AccessLevelType>]
   [-ActiveDirectoryContainer <String[]>]
   [-AllowExternalDeviceManagement <Boolean>]
   [-ApplicationSetting <ExchangeConnectorApplicationSetting>]
   [-DeltaSyncMins <Int32>]
   [-EmailAddress <String[]>]
   [-EmailManagementSetting <ExchangeConnectorEmailManagementSetting>]
   [-EnableAccessRule <Boolean>]
   [-FullSyncSchedule <IResultObject>]
   [-GeneralSetting <ExchangeConnectorGeneralSetting>]
   [-Hosted]
   [-IsHosted <Boolean>]
   [-MaximumInactiveDay <Int32>]
   [-NotificationUserName <String>]
   [-PasswordSetting <ExchangeConnectorPasswordSetting>]
   [-SecuritySetting <ExchangeConnectorSecuritySetting>]
   -ServerAddress <String>
   [-SiteCode <String>]
   -UserName <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-CMExchangeServer cmdlet configures a new Microsoft Exchange Server connector in Configuration Manager. An Exchange Server connector synchronizes and manages the device enrolled by the Exchange Server.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: Create an Exchange Server

PS XYZ:\> $schedule = New-CMSchedule -Start "03/01/2016 11:59 PM" -RecurInterval Days -RecurCount 1
PS XYZ:\> New-CMExchangeServer -ServerAddress "https://exchange.contoso.com" -DeltaSyncInterval 120 -FullSyncSchedule $schedule -IsHosted -SiteCode "ContosoSite"

These commands create an Exchange Server with the server address https://exchange.contoso.com. To do this, the first command in the example uses the New-CMSchedule cmdlet to create a schedule for doing Exchange synchronizations. This schedule object is stored in a variable $schedule.

The second command then uses New-CMExchangeServer to create the new server as part of the site ContosoSite.

Parameters

-AccessLevel

{{ Fill AccessLevel Description }}

Type:AccessLevelType
Accepted values:Allow, Block, Quarantine
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ActiveDirectoryContainer

Specifies an array of names of Active Directory containers. When this parameter is specified, the Exchange Server connector searches the Active Directory containers for the device.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AllowExternalDeviceManagement

Indicates whether an external device management program can manage the device.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ApplicationSetting

Specifies application settings. For each dictionary entry in the array, specify the setting name as the key and the configuration as the value. Valid values are: AllowUnsignedApplications, AllowUnsignedInstallationPackages, or Block a specific application.

Type:ExchangeConnectorApplicationSetting
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DeltaSyncMins

Type:Int32
Aliases:DeltaSyncInterval
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EmailAddress

{{ Fill EmailAddress Description }}

Type:String[]
Aliases:EmailAddresses
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EmailManagementSetting

Specifies email management settings. For each dictionary entry in the array, specify the setting name as the key and the configuration as the value.

Type:ExchangeConnectorEmailManagementSetting
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnableAccessRule

{{ Fill EnableAccessRule Description }}

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ExchangeClientAccessServer

Specifies an array of Exchange Client Access servers, as key-value pairs.

Type:Dictionary`2[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FullSyncSchedule

Specifies a result object that schedules the full discovery time for an Exchange Server connector.

Type:IResultObject
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GeneralSetting

Specifies general settings. Valid values are:

  • RequireManualSyncWhenRoaming
  • RequireStorageCardEncryption
  • UnapprovedInROMApplicationList
  • DevicePolicyRefreshInterval
  • MaxInactivityTimeDeviceLock
Type:ExchangeConnectorGeneralSetting
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Hosted

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IsHosted

Indicates that the Exchange Server connector configuration is for a hosted or on-premise Exchange Server.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MaximumInactiveDay

Specifies the interval between times that the Exchange Server connector runs device discovery. The cmdlet checks the last sync time of the devices that Exchange Server manages. If the most recent sync time is older than the current time - MinimumInactiveDay, then the exchange connector does not discover the devices.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-NotificationUserName

{{ Fill NotificationUserName Description }}

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OnPrem

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PasswordSetting

Specifies password settings. Valid values are:

  • AlphanumericDevicePasswordRequired
  • DevicePasswordEnabled
  • DevicePasswordExpiration
  • DevicePasswordHistory
  • MaxDevicePasswordFailedAttempts
  • PasswordRecoveryEnabled
  • MinDevicePasswordComplexCharacters
  • MinDevicePasswordLength
  • AlphanumericDevicePasswordRequired
  • AllowSimpleDevicePassword
Type:ExchangeConnectorPasswordSetting
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SecuritySetting

Specifies a dictionary of security settings. Valid values are:

  • AllowBluetooth
  • AllowBrowser
  • AllowCamera
  • AllowDesktopSync
  • AllowInternetSharing
  • AllowIrDA
  • AllowNonProvisionableDevices
  • AllowRemoteDesktop
  • AllowStorageCard
  • AllowTextMessaging
  • AllowWiFi
Type:ExchangeConnectorSecuritySetting
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServerAddress

Specifies the address of the Exchange Server for which the cmdlet configures the Exchange Server connector.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SiteCode

Specifies the site code of the Configuration Manager site where a Exchange Server connector runs.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UserName

Specifies the username that the connector uses to connect to the Exchange Server.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

IResultObject