Commands › Exchange Online

Install-TransportAgent

Exchange Online ExchangeOnlineManagement Install-*

Register transport agents on Exchange servers.

Quick start script

# Install-TransportAgent — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Run and inspect
Install-TransportAgent -Name <String> -AssemblyPath <String> -TransportAgentFactory <String> | Format-List

# 3. Export for evidence / drift tracking
Install-TransportAgent | Export-Clixml .\TransportAgent-$(Get-Date -Format yyyyMMdd).xml

Syntax

Install-TransportAgent [-Name] <String> -AssemblyPath <String> -TransportAgentFactory <String>
 [-Confirm]
 [-DomainController <Fqdn>]
 [-TransportService <TransportService>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (7)

ParameterTypeRequiredWhat it controls
-Name String yes The Name parameter specifies the display name of the transport agent to be installed. The length of the name can't exceed 64 characters.
-AssemblyPath String yes The AssemblyPath parameter specifies the location of the transport agent Microsoft.NET assembly. Universal Naming Convention (UNC) file paths can't be used.
-TransportAgentFactory String yes The TransportAgentFactory parameter specifies the Microsoft.NET class type of the transport agent factory. The developer of the transport agent being installed provides the transport agent factory and related...
-Confirm SwitchParameter The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding.
-DomainController Fqdn 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...
-TransportService TransportService The TransportService parameter specifies the transport service that you want to view or modify. Valid values for this parameter are:
-WhatIf SwitchParameter The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.