UcmPsTools Documentation
  • Welcome! - UcmPsTools
  • Using UcmPsTools
    • QuickStart
    • About UcmPSTools
    • Using UcmPsTools in your Automation
    • Cmdlet Reference
      • Accounts and Voice Apps
        • New-UcmOffice365User -todo
        • New-UcmTeamsResourceAccount - todo
      • Auditing and Planning
        • Measure-UcmOnPremNumberRange
      • Call Management
        • New-UcmCsFixedNumberDiversion
      • Connections and Modules
      • Licences and Service Plans
      • Reporting and Logging
        • Complete-UcmReport
        • Export-UcmCSVReport
        • Export-UcmHTMLReport
        • Initialize-UcmReport
        • New-UcmReportItem
        • New-UcmReportStep
        • Search-UcmCsOnPremNumberRange
        • Write-UcmLog
    • Example Scripts
  • UcmPsTools In Depth
    • More about UcmPsTools
    • Security In UcmPsTools
    • UcmPsTools Cmdlet Status Reporting
  • Contributing to UcmPsTools
    • New Function Rules
    • Pull Process
Powered by GitBook
On this page
  • Installing from the PowerShell Gallery
  • Installing from Release
  • Developing UcmPsTools
  1. Using UcmPsTools

QuickStart

PreviousWelcome! - UcmPsToolsNextAbout UcmPSTools

Last updated 2 years ago

If you're looking to use the tools. Grab the latest version from the . Everything is digitally signed and ready to go. That's it. All the Cmdlets are available as soon as the module is installed.

Installing from the PowerShell Gallery

You can use PowerShell's built-in Install-Module feature to automatically download the latest stable version of UcmPsTools into your PowerShell directory

Install-Module UcmPsTools

Installing from Release

Can't access the PowerShell Gallery? No problem, you can download the latest build from the Releases page on GitHub, transfer it to your target machine and place it into your PowerShell modules folder. (C:\WINDOWS\system32\WindowsPowerShell\v1.0\Modules or C:\Program Files\WindowsPowerShell\Modules by default).

Developing UcmPsTools

Wanna try the bleeding edge and not have the beta code sitting in your modules folder? Maybe develop your own fork? Just clone the dev branch from GitHub and run Test-ImportFunctions.ps1

#Clone the repo
git home https://github.com/Atreidae/UcmPsTools.git c:\UcMadScientist\UcmPsTools

#Dot source the test script to load all cmdlets in the 'public' folder
. c:\UcMadScientist\UcmPsTools\Test-ImportFunctions.ps1

#To include cmdlets in the 'private' folder, add the -Private switch
. c:\UcMadScientist\UcmPsTools\Test-ImportFunctions.ps1 -Private

The code from GitHub Repo is not signed, so you will need to use Set-ExecutionPolicy -Bypass in any environment using the raw code.

Note: Each as Cmdlet is its own *.ps1 file and not a module, you will need to manually dot source Test-ImportFunctions.ps1 for each PowerShell session

PowerShell Gallery