Exchange Server Mailbox Management (OnPremise)

Home > Administration > IT Operations Management > ITOM Package Library > Exchange Server Mailbox Management (OnPremise)

Index

     

Introduction This package provides operations for On-Premise Exchange server mailbox management, supported for use on Exchange Server version 2016 and above.

Related Articles IT Operations Management Business Process Designer KeySafe

Target Environment Requirements

Script Execution Machine Requirements

• This package utilises Exchange Server PowerShell CmdLets provided by the Exchange Management Shell, which requires installation on the target device. See the Install Exchange Management Tools document for more information
• If the script execution policy on the machine executing these operations is restricted, this will need to be updated to something less restrictive. If this is the case, you can use the Set Execution Policy operation within the Windows Management package to update the Execution Policy on the target device before performing any other operations.

KeySafe Configuration

When creating SIS jobs for operations contained within this package, they need to be run on the target machine as a user who has the correct privileges on the target.

To configure your Target Machine account authentication in KeySafe:

• In the Admin console, navigate to: System > Security > KeySafe;
• Click on + then select Username + Password;
• Give the KeySafe Key a Title (this is the name/identifier for the target machine account as you will see it when creating an IT Automation Job, or adding an IT Automation node to a Business Process or Runbook);
• Optionally add a description;
• Populate the Username field with the domain/local account username for the account being used on the target machine;
• Populate the Password field with the password for the above account;
• Select Create Key to save.

Once you have created your KeySafe Key, you can then use it when creating IT Automation Jobs from this package. See screenshots to the right for examples.

Package Operations

The Exchange Server Mailbox Management (OnPremise) package contains the following operations, than can be used to create ITOM Jobs directly, or included in your Business Processes and/or IT Operations Management Rubooks.

Get Mailbox Details

Returns the specified mailbox's properties

Input Parameters

• Identity MANDATORY - Specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox.

Output Parameters

• Name
• Type
• Alias
• EmailAddress
• DistinguishedName
• Database
• ForwardingAddress
• ForwardingSMTPAddress
• DeliverToMailboxAndForward
• outcome MANDATORY The outcome of the operation (OK/FAIL)
• errors Any errors returned by the operation

Create New Mailbox

Enables the creation of a user mailbox and linked Active Directory user account at the same time.

Input Parameters

• UserPrincipalName MANDATORY - Specifies the logon name for the user account. The UPN uses an email address format: username@domain. Typically, the domain value is the domain where the user account resides.
• MailboxName MANDATORY - The unique name of the mailbox.
• FirstName - Specifies the user's first name.
• Lastname - Specifies the user's last name.
• DisplayName - Specifies the display name of the mailbox. The display name is visible in the Exchange admin center, in address lists, and in Outlook.
• Password MANDATORY - Specifies the password for the mailbox (the user account that's associated with the mailbox).
• ResetPassword - Specify if the user is required to change their password the next time they log on to their mailbox.
• OrganisationalUnit - Specifies the location in Active Directory where the new mailbox is created.
• Database - Specifies the mailbox database that contains the mailbox. You can use any value that uniquely identifies the database.

Output Parameters

• Name
• Alias
• EmailAddress
• outcome MANDATORY The outcome of the operation (OK/FAIL)
• errors Any errors returned by the operation

Remove Mailbox

Enables the Deletion of a mailbox and the associated Active Directory user account.

Input Parameters

• Identity MANDATORY - Identifies the mailbox that you want to remove. You can use any value that uniquely identifies the mailbox.
• Permanent - specifies whether to permanently delete the mailbox from the mailbox database.

Output Parameters

• outcome MANDATORY The outcome of the operation (OK/FAIL)
• errors Any errors returned by the operation

Enable Mailbox

Creates a mailbox for an existing user who doesn't already have an associated mailbox.

Input Parameters

• Identity MANDATORY - AD Account Identity

Output Parameters

• Name
• Alias
• EmailAddress
• DistinguishedName
• outcome MANDATORY The outcome of the operation (OK/FAIL)
• errors Any errors returned by the operation