Edit

Share via


New-CMExchangeServer

Configures a new Exchange Server connector.

Syntax

NewOnPrem (Default)

New-CMExchangeServer
    -ServerAddress <String>
    [-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>]
    [-SiteCode <String>]
    [-UserName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewHosted

New-CMExchangeServer
    -ServerAddress <String>
    -UserName <String>
    [-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>]
    [-SiteCode <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 }}

Parameter properties

Type:AccessLevelType
Default value:None
Accepted values:Allow, Block, Quarantine
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AllowExternalDeviceManagement

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:ExchangeConnectorApplicationSetting
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DeltaSyncMins

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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DeltaSyncInterval

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisableWildcardHandling

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EmailAddress

{{ Fill EmailAddress Description }}

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:EmailAddresses

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:ExchangeConnectorEmailManagementSetting
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnableAccessRule

{{ Fill EnableAccessRule Description }}

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ExchangeClientAccessServer

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

Parameter properties

Type:

Dictionary`2[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

NewOnPrem
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ForceWildcardHandling

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FullSyncSchedule

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

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-GeneralSetting

Specifies general settings. Valid values are:

  • RequireManualSyncWhenRoaming
  • RequireStorageCardEncryption
  • UnapprovedInROMApplicationList
  • DevicePolicyRefreshInterval
  • MaxInactivityTimeDeviceLock

Parameter properties

Type:ExchangeConnectorGeneralSetting
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Hosted

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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

NewHosted
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IsHosted

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NotificationUserName

{{ Fill NotificationUserName Description }}

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OnPrem

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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

NewOnPrem
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PasswordSetting

Specifies password settings. Valid values are:

  • AlphanumericDevicePasswordRequired
  • DevicePasswordEnabled
  • DevicePasswordExpiration
  • DevicePasswordHistory
  • MaxDevicePasswordFailedAttempts
  • PasswordRecoveryEnabled
  • MinDevicePasswordComplexCharacters
  • MinDevicePasswordLength
  • AlphanumericDevicePasswordRequired
  • AllowSimpleDevicePassword

Parameter properties

Type:ExchangeConnectorPasswordSetting
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SecuritySetting

Specifies a dictionary of security settings. Valid values are:

  • AllowBluetooth
  • AllowBrowser
  • AllowCamera
  • AllowDesktopSync
  • AllowInternetSharing
  • AllowIrDA
  • AllowNonProvisionableDevices
  • AllowRemoteDesktop
  • AllowStorageCard
  • AllowTextMessaging
  • AllowWiFi

Parameter properties

Type:ExchangeConnectorSecuritySetting
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ServerAddress

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SiteCode

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UserName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

NewOnPrem
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

IResultObject