Clear-MtConnectionState

Synopsis

Forgets the connection of a Maester Pack connector.

Syntax

Clear-MtConnectionState [[-Service] <String>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Description

A pack connector calls this from its Disconnect function (Maester Packs design, section 6.1). Disconnect-Maester also clears the state of every pack service it disconnects. Inside a pack it clears the pack’s own service; outside a pack, -Service is required.

Examples

Example 1

Clear-MtConnectionState

Inside a pack connector’s Disconnect function: forgets its connection.

Parameters

-Service

The connector’s service name, such as CNT.GoogleWorkspace. Needed only when the pack has more than one connector, or outside a pack.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
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/Clear-MtConnectionState