|
|
| (23 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| − | {{bluebanner|[[Main_Page|Home]] > [[Administration]] > [[IT_Operations_Management|IT Operations Management]] > [[ITOM_Package_Library|ITOM Package Library]] > Exchange Server Mailbox Management (OnPremise) |[[:Category:ITOM|Index]]}}
| + | This document can now be found at its new location in the [https://docs.hornbill.com/itom-packages/welcome Hornbill Document Library]. |
| − | [[File:microsoft_logo.png|300px]] [[File:Microsoft_Exchange_(2019-present).svg.png|150px]]
| |
| − | {{IntroAndLinks|Provides operations for On-Premise Exchange server mailbox management. This package is supported for use on Exchange Server version 2016 and above.
| |
| − | See the {{Plainlink|https://docs.microsoft.com/en-us/exchange/plan-and-deploy/post-installation-tasks/install-management-tools?view=exchserver-2019 Install Exchange Management Tools}} for more information
| |
| − | |
| |
| − | <!-- Related Links go here -->
| |
| − | :* [[IT_Operations_Management|IT Operations Management]]
| |
| − | :* [[Business_Process_Designer|Business Process Designer]]
| |
| − | :* [[Hornbill_KeySafe|KeySafe]]
| |
| − | }}
| |
| | | | |
| − | ==Target Environment Requirements==
| + | [[file:hornbill-document-library.png|ITOM Package Reference|link=https://docs.hornbill.com/itom-packages/welcome]] |
| − | | |
| − | ===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==
| |
| − | [[File:itomtarget_keysafe.png|300px|right]] | |
| − | | |
| − | 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 '''[[Hornbill_KeySafe|KeySafe]]''':
| |
| − | | |
| − | * In the Admin console, navigate to: System > Security > KeySafe;
| |
| − | * Click on + then select <code>Username + Password</code>;
| |
| − | * 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_Process_Designer|Business Processes]] and/or IT Operations Management Rubooks.
| |
| − | | |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Get User Mailbox===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Returns the specified mailbox's properties
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>Identity</code> '''MANDATORY''' - Unique Identity of mailbox to be returned
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>Name</code>
| |
| − | * <code>Alias</code>
| |
| − | * <code>EmailAddress</code>
| |
| − | * <code>DistinguishedName</code>
| |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Create New Mailbox===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Creates a New Exchange Mailbox and AD user account
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>UserPrincipalName</code> '''MANDATORY''' - Provide the AD User principal name
| |
| − | * <code>MailboxName</code> '''MANDATORY''' - Provide the mailbox name
| |
| − | * <code>FirstName</code> -
| |
| − | * <code>Surname</code> -
| |
| − | * <code>DisplayName</code> -
| |
| − | * <code>Password</code> '''MANDATORY''' -
| |
| − | * <code>ResetPassword</code> -
| |
| − | * <code>OrganisationalUnit</code> -
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>Name</code>
| |
| − | * <code>Alias</code>
| |
| − | * <code>EmailAddress</code>
| |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Remove Mailbox===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Remove the specified mailbox
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>Identity</code> '''MANDATORY''' - Mailbox Identity
| |
| − | * <code>Permanent</code> - Permanently remove mailbox
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Enable Mailbox===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Creates a new mailbox for an existing AD account
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>Identity</code> '''MANDATORY''' - AD Account Identity
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>Name</code>
| |
| − | * <code>Alias</code>
| |
| − | * <code>EmailAddress</code>
| |
| − | * <code>DistinguishedName</code>
| |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | | |
| − | [[Category:ITOM]]
| |
