Get Transport Rule operation


The Get Transport Rule process views transport rules that are configured on a computer that has the Microsoft Exchange Server 2007 Hub Transport server role or the Edge Transport server role installed.

Note

The Get Transport Rule operation supports Microsoft Exchange versions 2007, 2010, 2013, 2016, and 2019. 

The adapter request parameters may differ according to the Microsoft Exchange Server version.

For the list of all supported parameters, refer to the Get-TransportRule cmdlet in the Microsoft Exchange documentation specific to your version.

The following figure shows a sample adapter request for the Get Transport Rule operation on Microsoft Exchange version 2019:

<microsoft-exchange-request>
   <command>
     <command-name>Get-TransportRule</command-name>
     <format-option />
     <verbose-logging />
     <parameters>
       <parameter>
         <name>Identity</name>
         <value>Transpor*</value>
       </parameter>
     </parameters>
   </command>
</microsoft-exchange-request>

The following figure shows the response for the adapter request:

<microsoft-exchange-response>
 <metadata>
   <status>success</status>
 </metadata>
 <targets-output>
   <target-output host="clm-pun-020413.bmc.com">
     <metadata>
       <os-id>Windows Server 2008</os-id>
       <os-version>6.3.9600</os-version>
       <status>success</status>
     </metadata>
     <commands-output>
       <command-output>
         <metadata>
           <command>Get-TransportRule -Identity:Transpor*</command>
           <line-count>8</line-count>
           <execution-milliseconds>22823</execution-milliseconds>
           <exit-code>0</exit-code>
           <status>success</status>
         </metadata>
         <output>
           <line index="1">Attempting to connect to remote host...</line>
           <line index="2">Initialising rctrlx server component...</line>
           <line index="3">Executing remote application: cmd /c "echo . | powershell -PSConsoleFile "C:\Program Files\Microsoft\Exchange Server\V15\Bin\exshell.psc1" -NonInteractive -Command Get-TransportRule -Identity:Transpor* "</line>
           <line index="4">Stdout:</line>
           <line index="5">Name                     State    Mode        Priority Comments                </line>
           <line index="6">----                     -----    ----        -------- --------                </line>
           <line index="7">TransportRule1           Enabled  Enforce     0        ...                     </line>
           <line index="8">Remote application exited with code: 0</line>
         </output>
       </command-output>
     </commands-output>
   </target-output>
 </targets-output>
</microsoft-exchange-response>

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*