Uninstall-MtPack

Synopsis

Removes a Maester Pack from maester-packs.lock.json and the Maester config.

Syntax

Uninstall-MtPack [-Id] <String[]> [-PackLock <String>] [-ProgressAction <ActionPreference>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

Description

The pack and the modules only it needed are removed from the lock file, and its entry from the Packs list of maester-config.json, so Invoke-Maester no longer runs it. A pack that another installed pack requires is not removed. The files stay in the local pack store, which other projects may share.

A pack that ships with Maester cannot be uninstalled; turn it off in the config instead, with Packs: [{ “Id”: “maester.zero-trust-assessment”, “Enabled”: false }].

Examples

Example 1

Uninstall-MtPack contoso.google-workspace

Removes the pack from the project.

Parameters

-Id

The packs to remove.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-PackLock

The lock file to change. By default the one beside the Maester config found from the current folder, else the user’s.

Type: String
Parameter Sets: (All)
Aliases:

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

-WhatIf

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

-Confirm

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

-ProgressAction

Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by Write-Progress.

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
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

Related links

https://maester.dev/docs/commands/Uninstall-MtPack