Get Mailbox Database operation

The Get Mailbox Database process retrieves one or more mailbox database objects from a storage group, server, or an organization.

Note

The Get Mailbox Database 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-MailBoxDatabase cmdlet in the Microsoft Exchange documentation specific to your version.

Note

  • If you use the GetMailboxDatabase with no parameters, it gets information about all mailbox databases in the Exchange organization.
  • If you use the GetMailboxDatabase with the Server parameter, it gets information about all mailbox databases on the server.
  • If you use the GetMailboxDatabase with the StorageGroup parameter, it gets information about all mailbox databases in the storage group.

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

<microsoft-exchange-request>
   <command>
     <command-name>Get-MailboxDatabase</command-name>
     <format-option />
     <verbose-logging />
     <parameters>
       <parameter>
         <name>Identity</name>
         <value>database1</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-MailboxDatabase -Identity:database1</command>
           <line-count>8</line-count>
           <execution-milliseconds>22138</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-MailboxDatabase -Identity:database1 "</line>
           <line index="4">Stdout:</line>
           <line index="5">Name                           Server          Recovery        ReplicationType </line>
           <line index="6">----                           ------          --------        --------------- </line>
           <line index="7">database1                      CLM-PUN-020413  False           None            </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*