Invoke D365SDPInstall

---

external help file: d365fo.tools-help.xml Module Name: d365fo.tools online version: schema: 2.0.0

Invoke-D365SDPInstall

SYNOPSIS

Invoke the AxUpdateInstaller.exe file from Software Deployable Package (SDP)

SYNTAX

QuickInstall (Default)

Invoke-D365SDPInstall [-Path] <String> [[-MetaDataDir] <String>] [-QuickInstallAll] [[-Step] <Int32>]
 [[-RunbookId] <String>] [-LogPath <String>] [-ShowOriginalProgress] [-OutputCommandOnly] [<CommonParameters>]

DevInstall

Invoke-D365SDPInstall [-Path] <String> [[-MetaDataDir] <String>] [-DevInstall] [[-Step] <Int32>]
 [[-RunbookId] <String>] [-LogPath <String>] [-ShowOriginalProgress] [-OutputCommandOnly] [<CommonParameters>]

Manual

Invoke-D365SDPInstall [-Path] <String> [[-MetaDataDir] <String>] [-Command] <String> [[-Step] <Int32>]
 [[-RunbookId] <String>] [-LogPath <String>] [-ShowOriginalProgress] [-OutputCommandOnly] [<CommonParameters>]

DESCRIPTION

A cmdlet that wraps some of the cumbersome work into a streamlined process. The process are detailed in the Microsoft documentation here: https://docs.microsoft.com/en-us/dynamics365/unified-operations/dev-itpro/deployment/install-deployable-package

EXAMPLES

EXAMPLE 1

Invoke-D365SDPInstall -Path "c:\temp\package.zip" -QuickInstallAll

This will install the package contained in the c:\temp\package.zip file using a runbook in memory while executing.

EXAMPLE 2

Invoke-D365SDPInstall -Path "c:\temp\" -DevInstall

This will install the extracted package in c:\temp\ using a runbook in memory while executing.

This command is to be used on Microsoft Hosted Tier1 development environment, where you don't have access to the administrator user account on the vm.

EXAMPLE 3

Invoke-D365SDPInstall -Path "c:\temp\" -Command SetTopology

PS C:\> Invoke-D365SDPInstall -Path "c:\temp" -Command Generate -RunbookId 'MyRunbook' PS C:\> Invoke-D365SDPInstall -Path "c:\temp" -Command Import -RunbookId 'MyRunbook' PS C:\> Invoke-D365SDPInstall -Path "c:\temp" -Command Execute -RunbookId 'MyRunbook'

Manual operations that first create Topology XML from current environment, then generate runbook with id 'MyRunbook', then import it and finally execute it.

EXAMPLE 4

Invoke-D365SDPInstall -Path "c:\temp\" -Command RunAll

Create Topology XML from current environment. Using default runbook id 'Runbook' and run all the operations from generate, to import to execute.

EXAMPLE 5

Invoke-D365SDPInstall -Path "c:\temp\" -Command RerunStep -Step 18 -RunbookId 'MyRunbook'

Rerun runbook with id 'MyRunbook' from step 18.

EXAMPLE 6

Invoke-D365SDPInstall -Path "c:\temp\" -Command SetStepComplete -Step 24 -RunbookId 'MyRunbook'

Mark step 24 complete in runbook with id 'MyRunbook' and continue the runbook from the next step.

PARAMETERS

-Path

Path to the update package that you want to install into the environment

The cmdlet supports a path to a zip-file or directory with the unpacked contents.

Type: String
Parameter Sets: (All)
Aliases: File, Hotfix

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

-MetaDataDir

The path to the meta data directory for the environment

Default path is the same as the aos service PackagesLocalDirectory

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: "$Script:MetaDataDir"
Accept pipeline input: False
Accept wildcard characters: False

-QuickInstallAll

Use this switch to let the runbook reside in memory. You will not get a runbook on disc which you can examine for steps

Type: SwitchParameter
Parameter Sets: QuickInstall
Aliases:

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

-DevInstall

Use this when running on developer box without administrator privileges (Run As Administrator)

Type: SwitchParameter
Parameter Sets: DevInstall
Aliases:

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

-Command

The command you want the cmdlet to execute when it runs the AXUpdateInstaller.exe

Valid options are: SetTopology Generate Import Execute RunAll ReRunStep SetStepComplete Export VersionCheck

The default value is "SetTopology"

Type: String
Parameter Sets: Manual
Aliases:

Required: True
Position: 4
Default value: SetTopology
Accept pipeline input: False
Accept wildcard characters: False

-Step

The step number that you want to work against

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-RunbookId

The runbook id of the runbook that you want to work against

Default value is "Runbook"

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: Runbook
Accept pipeline input: False
Accept wildcard characters: False

-LogPath

The path where the log file(s) will be saved

When running without the ShowOriginalProgress parameter, the log files will be the standard output and the error output from the underlying tool executed

Type: String
Parameter Sets: (All)
Aliases: LogDir

Required: False
Position: Named
Default value: $(Join-Path -Path $Script:DefaultTempPath -ChildPath "Logs\SdpInstall")
Accept pipeline input: False
Accept wildcard characters: False

-ShowOriginalProgress

Instruct the cmdlet to show the standard output in the console

Default is $false which will silence the standard output

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-OutputCommandOnly

Instruct the cmdlet to only output the command that you would have to execute by hand

Will include full path to the executable and the needed parameters based on your selection

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

CommonParameters

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

INPUTS

OUTPUTS

NOTES

Author: Tommy Skaue (@skaue) Author: Mötz Jensen (@Splaxi)

Inspired by blogpost http://dev.goshoom.net/en/2016/11/installing-deployable-packages-with-powershell/

RELATED LINKS