external help file: SitecoreInstallFramework-help.xml
online version:
schema: 2.0.0
---
Creates a parameters file for a Web Deploy Package
Export-WebDeployParameters [-Package] <String> [[-OutPath] <String>] [[-Format] <String>] [-Required]
[[-MsDeployPath] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Given a Web Deploy package, this function extracts the package to a temporary location before searching for a parameters.xml file.
If found, it creates a matching xml file that can be directly passed to Web Deploy or it creates a matching json file to use in configurations.
By default, all parameters and their default values are added to the file. This can be restricted to the required fields by passing the -Required
flag.
PS C:\> Export-WebDeployParameters -Package c:\webdeploy.zip -OutPath .
This will output a webdeploy-parameters
The file will contain all fields with their default values. You can then add this to a configuration.
PS C:\> Export-WebDeployParameters -Package c:\webdeploy.zip -OutPath . -Format xml -Required
This will output a webdeploy-parameters
The file will contain only the required parameters. This can be passed directly to web deploy using the -SetParamFile
argument
The format to output the exported parameters.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: json, xml
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The path to msdeploy.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The location to place the completed file.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The package to be searched.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
If set, only the required parameters are added to the output.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
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 (http://go.microsoft.com/fwlink/?LinkID=113216).