Exchange Server Mailbox Management (OnPremise)
Home > Administration > IT Operations Management > ITOM Package Library > Exchange Server Mailbox Management (OnPremise) | Index |
IntroductionProvides operations for On-Premise Exchange server mailbox management. This package is supported for use on Exchange Server version 2016 and above. |
|
Target Environment Requirements
Script Execution Machine Requirements
- If the script execution policy on the machine executing these operations is set to Restricted, then this will need to be updated to something less restrictive. If this is the case, you can use the Set Execution Policy operation within this package to update the Execution Policy on the target device before peforming any of the 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 User Mailbox
Returns the specified mailbox's properties
Input Parameters
Identity
MANDATORY - Unique Identity of mailbox to be returned
Output Parameters
Name
Alias
EmailAddress
DistinguishedName
outcome
MANDATORY The outcome of the operation (OK/FAIL)errors
Any errors returned by the operation
Create New Mailbox
Creates a New Exchange Mailbox and AD user account
Input Parameters
UserPrincipalName
MANDATORY - Provide the AD User principal nameMailboxName
MANDATORY - Provide the mailbox nameFirstName
-Surname
-DisplayName
-Password
MANDATORY -ResetPassword
-OrganisationalUnit
-
Output Parameters
Name
Alias
EmailAddress
outcome
MANDATORY The outcome of the operation (OK/FAIL)errors
Any errors returned by the operation
Remove Mailbox
Remove the specified mailbox
Input Parameters
Identity
MANDATORY - Mailbox IdentityPermanent
- Permanently remove mailbox
Output Parameters
outcome
MANDATORY The outcome of the operation (OK/FAIL)errors
Any errors returned by the operation
Enable Mailbox
Creates a new mailbox for an existing AD account
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