Get a Dynamics 365 Runbook

Get-D365Runbook [[-Path] <String>] [[-Name] <String>] [-Latest] [<CommonParameters>]

Get the full path and filename of a Dynamics 365 Runbook

Get-D365Runbook

This will list all runbooks that are available in the default location.

Get-D365Runbook -Latest

This will get the latest runbook file from the default InstallationRecords directory on the machine.

Get-D365Runbook -Latest | Invoke-D365RunbookAnalyzer

This will find the latest runbook file and have it analyzed by the Invoke-D365RunbookAnalyzer cmdlet to output any error details.

Get-D365Runbook -Latest | Invoke-D365RunbookAnalyzer | Out-File "C:\Temp\d365fo.tools\runbook-analyze-results.xml"

This will find the latest runbook file and have it analyzed by the Invoke-D365RunbookAnalyzer cmdlet to output any error details. The output will be saved into the "C:\Temp\d365fo.tools\runbook-analyze-results.xml" file.

Get-D365Runbook | Backup-D365Runbook

This will save a copy of all runbooks from the default location and save them to "c:\temp\d365fo.tools\runbookbackups"

notepad.exe (Get-D365Runbook -Latest).File

This will find the latest runbook file and open it with notepad.

Path to the folder containing the runbook files

The default path is "InstallationRecord" which is normally located on the "C:\DynamicsAX\InstallationRecords"

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: (Join-Path $Script:InstallationRecordsDir "Runbooks")
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

Name of the runbook file that you are looking for

The parameter accepts wildcards. E.g. -Name hotfix-20181024

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: *
Accept pipeline input: False
Accept wildcard characters: False

Instruct the cmdlet to only get the latest runbook file, based on the last written attribute

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Tags: Runbook, Servicing, Hotfix, DeployablePackage, Deployable Package, InstallationRecordsDirectory, Installation Records Directory

Author: Mötz Jensen (@Splaxi)