Skip to content

Unregister‑ShpTool

Raimund edited this page Jun 12, 2026 · 1 revision

SYNOPSIS

Removes one or all user-defined tools registered for Invoke-Shp.

SYNTAX

ByName (Default)

Unregister-ShpTool -Name <String> [-WhatIf] [-Confirm]
 [<CommonParameters>]

All

Unregister-ShpTool [-All] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Deletes a tool previously added with Register-ShpTool from the module-scoped registry, so Invoke-Shp stops offering it to the model. Pass -Name to remove a single tool, or -All to clear every registered tool. Affects only the current PowerShell session.

EXAMPLES

EXAMPLE 1

Unregister-ShpTool -Name Get-Process

Removes the Get-Process tool from the session registry.

EXAMPLE 2

Unregister-ShpTool -All

Clears every user-defined tool registered in the session.

PARAMETERS

-All

Remove every registered tool instead of a single named one.

Type: SwitchParameter
Parameter Sets: All
Aliases:

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

-Name

The name of the tool to remove. Mandatory in the default parameter set. Accepts pipeline input.

Type: String
Parameter Sets: ByName
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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

-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

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

None.

NOTES

RELATED LINKS

Register-ShpTool

Get-ShpTool

Clone this wiki locally