|
|
| (24 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]] > Endpoint Configuration Manager|[[: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|microsoft_logo.png|300px]]
| |
| − | {{IntroAndLinks|The Endpoint Configuration Manager package for Hornbill's IT Operations Management (ITOM) contains operations to manage Microsoft Endpoint Configuration Manager Devices, Scripts, Packages and Discoveries.
| |
| − | |
| |
| − | <!-- 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]] |
| − | | + | [[Category:HDOC]] |
| − | ===Script Execution Machine Requirements===
| |
| − | | |
| − | * PowerShell v5.0 or above;
| |
| − | * The ConfigurationManager PowerShell module needs to installed on the machine that will be executing the operations;
| |
| − | * 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. See the [https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy?view=powershell-5.1 PowerShell Documentation] for more information.
| |
| − | | |
| − | ==KeySafe Configuration==
| |
| − | [[File:Itomtarget_keysafe.png|300px|right|link=https://wiki.hornbill.com/images/d/d2/Itomtarget_keysafe.png]]
| |
| − | | |
| − | 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==
| |
| − | [[File:ecm_job.png|300px|right|link=https://wiki.hornbill.com/images/1/10/Ecm_job.png]]
| |
| − | | |
| − | The Endpoint Configuration Manager 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">
| |
| − | ===Device - Add To Collection===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation adds a Device to a Collection. See the [https://docs.microsoft.com/en-us/powershell/module/configurationmanager/add-cmdevicecollectiondirectmembershiprule?view=sccm-ps Add-CMDeviceCollectionDirectMembershipRule cmdlet documentation] for more information.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>SiteID</code> '''(MANDATORY)''' - The ID of the target Config Manager Site;
| |
| − | * <code>DeviceName</code> '''(MANDATORY)''' - The name of the Device;
| |
| − | * <code>CollectionName</code> '''(MANDATORY)''' - The name of the Collection.
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>errors</code> - Any errors returned by the operation;
| |
| − | * <code>outcome</code> - Outcome of the operation. Can be OK or FAIL;
| |
| − | * <code>warnings</code> - Any warnings returned by the operation.
| |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Device - Approve===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation approves a Configuration Manager Device. See the [https://docs.microsoft.com/en-us/powershell/module/configurationmanager/approve-cmdevice?view=sccm-ps Approve-CMDevice cmdlet documentation] for more information.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>SiteID</code> '''(MANDATORY)''' - The ID of the target Config Manager Site;
| |
| − | * <code>DeviceName</code> '''(MANDATORY)''' - The name of the Device.
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>errors</code> - Any errors returned by the operation;
| |
| − | * <code>outcome</code> - Outcome of the operation. Can be OK or FAIL;
| |
| − | * <code>warnings</code> - Any warnings returned by the operation.
| |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Device - Block===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation blocks a Configuration Manager Device. See the [https://docs.microsoft.com/en-us/powershell/module/configurationmanager/block-cmdevice?view=sccm-ps Block-CMDevice cmdlet documentation] for more information.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>SiteID</code> '''(MANDATORY)''' - The ID of the target Config Manager Site;
| |
| − | * <code>DeviceName</code> '''(MANDATORY)''' - The name of the Device.
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>errors</code> - Any errors returned by the operation;
| |
| − | * <code>outcome</code> - Outcome of the operation. Can be OK or FAIL;
| |
| − | * <code>warnings</code> - Any warnings returned by the operation.
| |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Device - Get Details===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation returns information about a Configuration Manager Device. See the [https://docs.microsoft.com/en-us/powershell/module/configurationmanager/get-cmdevice?view=sccm-ps Get-CMDevice cmdlet documentation] for more information.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>SiteID</code> '''(MANDATORY)''' - The ID of the target Config Manager Site;
| |
| − | * <code>DeviceName</code> '''(MANDATORY)''' - The name of the Device.
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>errors</code> - Any errors returned by the operation;
| |
| − | * <code>outcome</code> - Outcome of the operation. Can be OK or FAIL;
| |
| − | * <code>warnings</code> - Any warnings returned by the operation;
| |
| − | * <code>adSiteName</code> - The AC Site Name where the Device resides;
| |
| − | * <code>clientState</code> - The Client State;
| |
| − | * <code>coManaged</code> - Co-Managed?;
| |
| − | * <code>deviceOS</code> - The Device OS;
| |
| − | * <code>domain</code> - The Domain the Device belongs to;
| |
| − | * <code>epDeploymentState</code> - The EP Deployment State;
| |
| − | * <code>isAssigned</code> - Is Assigned?;
| |
| − | * <code>isClient</code> - Is Client?;
| |
| − | * <code>isDecommissioned</code> - Is Decommissioned?;
| |
| − | * <code>isDirect</code> - Is Direct?;
| |
| − | * <code>name</code> - The Device Name;
| |
| − | * <code>resourceId</code> - The Resource ID;
| |
| − | * <code>resourceType</code> - The Resource Type.
| |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Device - Remove===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation removes a Configuration Manager Device. See the [https://docs.microsoft.com/en-us/powershell/module/configurationmanager/remove-cmdevice?view=sccm-ps Remove-CMDevice cmdlet documentation] for more information.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>SiteID</code> '''(MANDATORY)''' - The ID of the target Config Manager Site;
| |
| − | * <code>DeviceName</code> '''(MANDATORY)''' - The name of the Device.
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>errors</code> - Any errors returned by the operation;
| |
| − | * <code>outcome</code> - Outcome of the operation. Can be OK or FAIL;
| |
| − | * <code>warnings</code> - Any warnings returned by the operation.
| |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Device - Remove From Collection===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation removes a Configuration Manager Device from a Collection. See the [https://docs.microsoft.com/en-us/powershell/module/configurationmanager/remove-cmdevicecollectiondirectmembershiprule?view=sccm-ps Remove-CMDeviceCollectionDirectMembershipRule cmdlet documentation] for more information.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>SiteID</code> '''(MANDATORY)''' - The ID of the target Config Manager Site;
| |
| − | * <code>DeviceName</code> '''(MANDATORY)''' - The name of the Device;
| |
| − | * <code>CollectionName</code> '''(MANDATORY)''' - The name of the Collection to remove the Device from.
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>errors</code> - Any errors returned by the operation;
| |
| − | * <code>outcome</code> - Outcome of the operation. Can be OK or FAIL;
| |
| − | * <code>warnings</code> - Any warnings returned by the operation.
| |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Device - Unblock===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation unblocks a Configuration Manager Device. See the [https://docs.microsoft.com/en-us/powershell/module/configurationmanager/unblock-cmdevice?view=sccm-ps Unblock-CMDevice cmdlet documentation] for more information.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>SiteID</code> '''(MANDATORY)''' - The ID of the target Config Manager Site;
| |
| − | * <code>DeviceName</code> '''(MANDATORY)''' - The name of the Device.
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>errors</code> - Any errors returned by the operation;
| |
| − | * <code>outcome</code> - Outcome of the operation. Can be OK or FAIL;
| |
| − | * <code>warnings</code> - Any warnings returned by the operation.
| |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Invoke Discovery - System===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation invokes a System Discovery in a Configuration Manager Site. See the [https://docs.microsoft.com/en-us/powershell/module/configurationmanager/invoke-cmsystemdiscovery?view=sccm-ps Invoke-CMSystemDiscovery cmdlet documentation] for more information.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>SiteID</code> '''(MANDATORY)''' - The ID of the target Config Manager Site.
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>errors</code> - Any errors returned by the operation;
| |
| − | * <code>outcome</code> - Outcome of the operation. Can be OK or FAIL;
| |
| − | * <code>warnings</code> - Any warnings returned by the operation.
| |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Invoke Discovery - User===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation invokes a User Discovery in a Configuration Manager Site. See the [https://docs.microsoft.com/en-us/powershell/module/configurationmanager/invoke-cmuserdiscovery?view=sccm-ps Invoke-CMUserDiscovery cmdlet documentation] for more information.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>SiteID</code> '''(MANDATORY)''' - The ID of the target Config Manager Site.
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>errors</code> - Any errors returned by the operation;
| |
| − | * <code>outcome</code> - Outcome of the operation. Can be OK or FAIL;
| |
| − | * <code>warnings</code> - Any warnings returned by the operation.
| |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Invoke Discovery - User===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation invokes a User Discovery in a Configuration Manager Site. See the [https://docs.microsoft.com/en-us/powershell/module/configurationmanager/invoke-cmuserdiscovery?view=sccm-ps Invoke-CMUserDiscovery cmdlet documentation] for more information.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>SiteID</code> '''(MANDATORY)''' - The ID of the target Config Manager Site.
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>errors</code> - Any errors returned by the operation;
| |
| − | * <code>outcome</code> - Outcome of the operation. Can be OK or FAIL;
| |
| − | * <code>warnings</code> - Any warnings returned by the operation.
| |
| − | </div></div>
| |
| − | | |
| − | | |
| − | [[Category:ITOM]] | |
