Remove-MqttRoute
SYNOPSIS
Remove a MQQT Route.
SYNTAX
Address (Default)
Remove-MqttRoute [-Address] <String> [[-Port] <Int32>] [-Destination <String>] [-Quiet] [-Force]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
RouteInfo
Remove-MqttRoute -InputObject <MqttConfig[]> [-Destination <String>] [-Quiet] [-Force]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Removes a MQQT Route of the specified system.
EXAMPLES
EXAMPLE 1
PS> Remove-MqttRoute -address 1.2.3.4 -port 42 -Destination CX_1234
Removes the MQTT route on the destination System 'CX_1234' to MQTT Broker with Address '1.2.3.4' and Port '42'.
PARAMETERS
-Address
The IPAddress or HostName of the Mqtt broker system to remove.
Type: String
Parameter Sets: Address
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Port
The TCP/IP port specification.
Type: Int32
Parameter Sets: Address
Aliases:
Required: False
Position: 1
Default value: -1
Accept pipeline input: False
Accept wildcard characters: False
-InputObject
The Mqtt routes to remove.
Type: MqttConfig[]
Parameter Sets: RouteInfo
Aliases: MqttRoute
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Destination
The destination address, where to Remove the specified Mqtt route.
This can be the NetId, the HostName or the IPAddress
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Quiet
The Quiet parameter suppresses the 'ShouldProcess' messsage and the Cmdlet will be processed without further user confirmation.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: Silent
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Force
Forces the command (no confirmation, Resets the FailFastHandler)
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
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.