Display output of custom command in web interface

Question

How do I script my custom command to display the output in the web interface?

For instance, I need to see the output of the following Exchange 2010 cmdlet in the web interface.

add-pssnapin Microsoft.Exchange.Management.PowerShell.E2010
Get-MailboxDatabase | Get-MailboxDatabaseCopyStatus

Answer 1

Hello Michael,

If you want to output some information, you can add a record to the Execution Log of the operation using the $Context.LogMessage method. For more information, see ExecuteScriptContext. The execution log of the Custom Command will be displayed in Adaxes Web Interface once the Custom Command is executed.

So, to output the information that is returned by the Get-MailboxDatabaseCopyStatus cmdlet, you need to pass the collection of database copy status entries that this cmdlet returns into a foreach loop and output information on each entry as a separate log entry. Here's a sample script that you can use:

Add-PSSnapin Microsoft.Exchange.Management.PowerShell.E2010
$databaseCopyStatuses = Get-MailboxDatabase | Get-MailboxDatabaseCopyStatus
foreach ($databaseCopyStatus in $databaseCopyStatuses)
{
    $logMessage = $databaseCopyStatus.Name + " : " + $databaseCopyStatus.Status + " ; " `
                  + $databaseCopyStatus.CopyQueueLength + " ; " + $databaseCopyStatus.CopyQueueLength + " ; "`
                  + $databaseCopyStatus.ReplayQueueLength + " ; " + $databaseCopyStatus.LastInspectedLogTime`
                  + " ; " + $databaseCopyStatus.LastInspectedLogTime + " ; " + $databaseCopyStatus.ContentIndexState
    $Context.LogMessage($logMessage, "Information")
}

For more information on the properties of a database copy status entry that you can get, see the description of the DatabaseCopyStatusEntry Class on MSDN.

Comments

Thank you! This worked!

---

Is this still possible in 2019.1? I'm trying this but unable to see any output when I'm setting the LogMessage to Information. If I use Warning or Error it outputs, but this makes the end-user think there was a problem. I can see the information log output if I go into the administration console and logging, but there is no output in the web interface after the end user triggers the custom command.
Thanks!

---

Answered my own question! Found the following settings in the web interface configuration tool. Changed from default of "only if it contains errors or warnings" to "always". Hope this helps someone else!