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
  • Description
  • Parameters
  • Example
  • Inputs
  • Outputs
  1. Using UcmPsTools
  2. Cmdlet Reference
  3. Reporting and Logging

New-UcmReportStep

PreviousNew-UcmReportItemNextSearch-UcmCsOnPremNumberRange

Last updated 2 years ago

For a full overview, check

Description

Adds a new ReportStep to the current ReportItem

Parameters

-StepName: This is the name of the Step, translating to the title of the column for each of the rows of the first row, for example, "Enable User" -StepResult: This is the value of the action performed. This is a freeform field, but should it contain "OK" "Warn" or "Error", HTML reports will automatically have their cells coloured Green, Yellow and Red respectively.

Example

New-UCMReportItem -LineTitle "Username" -LineMessage "AppleJack@ucmadscientist.com"
    New-UcmReportStep -Stepname "Enable User" -StepResult "OK: Created User"
    New-UcmReportStep -Stepname "Assign Licence" -StepResult "OK: Assigned Licence"
    New-UcmReportStep -Stepname "Assign Policy" -StepResult "OK: Policy Assigned"

New-UCMReportItem -LineTitle "Username" -LineMessage "Discord@ucmadscientist.com"
    ...
    ...

Inputs

This function accepts no inputs

Outputs

This cmdlet does not output anything to the pipeline

About UCM Reporting Cmdlets