Top-level processes for the Microsoft Exchange adapter

The top-level processes perform high-level operations and call specialized processes in the subdirectories of the v2007 and v2010 directories. The top-level processes execute the following Microsoft Exchange processes:

Create Items

The Create Items process creates and adds objects and new requests in the Microsoft Exchange Server. For example, you can use the Create Items process to create a New Storage Group, add a Distribution Group member or create a request for mailbox movement. The supported commands for each of the Microsoft Exchange Server are listed in the following table.

The following table describes the input elements for the <items> XML for the Create Items process:

Input elements for the Create Items process

Input	Description	Required
adapter name	Specifies the name of the adapter used to handle the request Default name of the adapter is MicrosoftExchangeActorAdapter.	No
command	Specifies the name of the command to execute Valid values: Commands supported only on Exchange version 2007: New-StorageGroup Add-MailboxDatabaseCopy Commands supported on Exchange versions 2007, 2010, 2013 and 2016: New-MailboxDatabase New-TransportRule New-DynamicDistributionGroup New-ReceiveConnector New-SendConnector Add-DistributionGroupMember Commands supported on Exchange versions 2010, 2013 and 2016: New-DatabaseAvailabilityGroup Add-DatabaseAvailabilityGroupServer New-MailboxExportRequest (supported on 2010 SP1 and later, 2013, 2016) New-MailboxImportRequest (supported on 2010 SP1 and later, 2013, 2016) New-MailboxMoveRequest	Yes
input parameters	Specifies the input parameters in an XML format required to run the command Specify each parameter separately in a combination of name and value pair. The following figure shows the sample input parameters that you can specify: <parameters> <parameter> <name>Server</name> <value>clm-pun-123456</value> </parameter> <parameter> <name>Name2</name> <value>database1</value> </parameter> </parameters> Note: The parameters may differ based on the Exchange Server version. Refer to the Microsoft documentation for the list of all supported parameters specific to your version.	Yes
format option	Specifies the output format of the command being executed Valid values: format-list, format-custom, format-table, and format-wide	No
verbose logging	Specifies whether to get detailed log statements for the operation in the adapter response Valid values: true, false	No

Get Items

The Get Items process retrieves objects and requests from the Microsoft Exchange Server.

The following table describes the input elements for the <items> XML for the Get Items process:

Input elements for the Get Items process

Input	Description	Required
adapter name	Specifies the name of the adapter used to handle the request Default name of the adapter is MicrosoftExchangeActorAdapter.	No
command	Specifies the name of the command to execute Valid values: Commands supported on Exchange versions 2007, 2010, 2013 and 2016: Get-MailboxDatabase Get-TransportRule Get-MailboxStatistics Get-Mailbox Get-Message Get-DistributionGroupMember Commands supported on Exchange versions 2010, 2013 and 2016: Get-MailboxDatabaseCopyStatus Get-MailboxMoveRequest Get-MailboxImportRequest (supported on 2010 SP1 and later, 2013 and 2016) Get-MailboxExportRequest (supported on 2010 SP1 and later, 2013 and 2016) Get-DatabaseAvailabilityGroup	Yes
input parameters	Specifies the input parameters in an XML format required to run the command Specify each parameter separately in a combination of name and value pair. The following figure shows the sample input parameters that you can specify: <parameters> <parameter> <name>identity</name> <value>database1</value> </parameter> </parameters> Note: The parameters may differ based on the Exchange Server version. Refer to the Microsoft documentation for the list of all supported parameters specific to your version.	Yes
format option	Specifies the output format of the command being executed Valid values: format-list, format-custom, format-table, and format-wide	No
verbose logging	Specifies whether to get detailed log statements for the operation in the adapter response Valid values: true, false	No

Perform Operations

The Perform Operations process performs miscellaneous operations like enabling and disabling objects or suspend and resume requests.

The following table describes the input elements for the <items> XML for the Perform Operations process:

Input elements for the Perform Operations Items process

Input	Description	Required
adapter name	Specifies the name of the adapter used to handle the request Default name of the adapter is MicrosoftExchangeActorAdapter.	No
command	Specifies the name of the command Valid values: Commands supported only on Exchange versions 2007: Disable-StorageGroupCopy Enable-StorageGroupCopy Enable-DatabaseCopy Move-Mailbox Commands supported on Exchange versions 2007 and 2010 RTM: Import-Mailbox Export-Mailbox Commands supported on Exchange versions 2007, 2010, 2013 and 2016: Disable-MailContact Disable-Mailbox Enable-MailContact Enable-Mailbox Mount-Database Dismount-Database Export-Message Resume-Message Resume-Queue Suspend-Message Suspend-Queue Disable-DistributionGroup Enable-DistributionGroup Disable-MailUser Enable-MailUser	Yes
input parameters	Specifies the input parameters in an XML format required to run the command Specify each parameter separately in a combination of name and value pair. The following figure shows the sample input parameters that you can specify: <parameters> <parameter> <name>identity</name> <value>allen</value> </parameter> <parameter> <name>Name2</name> <value>Value2</value> </parameter> </parameters> Note: The parameters may differ based on the Exchange Server version. Refer to the Microsoft documentation for the list of all supported parameters specific to your version.	Yes
format option	Specifies the output format of the command being executed Valid values: format-list, format-custom, format-table, and format-wide	No
verbose logging	Specifies whether to get detailed log statements for the operation in the adapter response Valid values: true, false	No

Remove Items

The Remove Items process removes objects and requests from the server.

The following table describes the input elements for the <items> XML for the Remove Items process:

Input elements for the Remove Items process

Input	Description	Required
adapter name	Specifies the name of the adapter used to handle the request Default name of the adapter is MicrosoftExchangeActorAdapter.	No
command	Specifies the name of the command to execute Valid values: Commands supported on Exchange versions 2007, 2010, 2013 and 2016: Remove-TransportRule Remove-Message	Yes
input parameters	Specifies the input parameters in an XML format required to run the command Specify each parameter separately in a combination of name and value pair. The following figure shows the sample input parameters that you can specify: <parameters> <parameter> <name>Identity</name> <value>clm-pun-123456\Submission\2787433775105</value> </parameter> <parameter> <name>Name2</name> <value>Value2</value> </parameter> </parameters> Note: The parameters may differ based on the Exchange Server version. Refer to the Microsoft documentation for the list of all supported parameters specific to your version.	Yes
format option	Specifies the output format of the command being executed Valid values: format-list, format-custom, format-table, and format-wide	No
verbose logging	Specifies whether to get detailed log statements for the operation in the adapter response Valid values: true, false	No

Set Items

The Set Items process updates objects' settings in the server.

The following table describes the input elements for the <items> XML for the Set Items process:

Input elements for the Set Items process

Input	Description	Required
adapter name	Specifies the name of the adapter used to handle the request Default name of the adapter is MicrosoftExchangeActorAdapter.	No
command	Specifies the name of the command to execute Valid values: Commands supported only on Exchange versions 2007: Set-StorageGroup Commands supported on Exchange versions 2007, 2010, 2013 and 2016: Set-Contact Set-MailContact Set-MailboxDatabase Set-Mailbox Set-DistributionGroup Set-DynamicDistributionGroup Set-Group Set-ReceiveConnector Set-SendConnector Set-MailUser	Yes
input parameters	Specifies the input parameters in an XML format required to run the command Specify each parameter separately in a combination of name and value pair. The following figure shows the sample input parameters that you can specify: <parameters> <parameter> <name>MaxReceiveSize</name> <value>100KB</value> </parameter> <parameter> <name>MaxSendSize</name> <value>1024</value> </parameter> </parameters> Note: The parameters may differ based on the Exchange Server version. Refer to the Microsoft documentation for the list of all supported parameters specific to your version.	Yes
format option	Specifies the output format of the command being executed Valid values: format-list, format-custom, format-table, and format-wide	No
verbose logging	Specifies whether to get detailed log statements for the operation in the adapter response Valid values: true, false	No