Add-MqttRoute
SYNOPSIS
Adds an MQTT route to the destination system.
SYNTAX
Default (Default)
Add-MqttRoute [-Address] <String> [-Port] <Int32> [[-Topic] <String>] [-Destination <String>] [-Quiet] [-Force]
[-WhatIf] [-Confirm] [<CommonParameters>]
Identity
Add-MqttRoute [-Address] <String> [-Port] <Int32> [[-Topic] <String>] [-Destination <String>]
-Credential <PSCredential> [-IdentityCaseSensitive] [-Quiet] [-Force]
[-WhatIf] [-Confirm] [<CommonParameters>]
Psk
Add-MqttRoute [-Address] <String> [-Port] <Int32> [[-Topic] <String>] [-Destination <String>]
-Identity <String> -PreSharedKey <String> [-Quiet] [-Force] [-WhatIf]
[-Confirm] [<CommonParameters>]
SCA
Add-MqttRoute [-Address] <String> [-Port] <Int32> [[-Topic] <String>] [-Destination <String>] -CA <String>
-Cert <String> -Key <String> [-Quiet] [-Force] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
This Cmdlet adds an MQTT route to the destination system. To add the route, the Address of a MQTT route must be specified.
EXAMPLES
Example 1
PS> Add-MqttRoute -Address 1.2.3.4 -port 42
Adds the MQTT route to an MQTT Broker system with the IPAddress '1.2.3.4' and Port '42' on the local system.
Example 2
PS> Add-MqttRoute -Address MqttSystem -port 42 -Destination CX_1234
Adds the MQTT route on the destination System 'CX_1234' to the MQTT Broker with Address '1.2.3.4' and Port '42'.
PARAMETERS
-Address
The Address of the MQTT Broker to add. This can be the HostName or the IPAddress. IPAddress/HostName
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Port
The TCP/IP Port of the MQTT Broker to add. TCP/IP port.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Topic
The MQTT Topic string under which this MQTT Consumer sends/receives data. The topic string.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Destination
The Destination Address, where the MQTT route is added remotely. Tab completion: Completes route names from currently reachable ADS systems on the local TwinCAT system. The destination address.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Credential
Credentials of the Preshared Key Identity. IMPORTANT: Please be aware, that in the current version, tha password is transferred as clear text through the network. Use this only in safe subnetworks. The credential.
Type: PSCredential
Parameter Sets: Identity
Aliases: TargetCredential
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IdentityCaseSensitive
Key will be generated Sha256(Identity+Pwd), Identity in upper case if 'IdentityCaseSensitive' = false - UTF8 The identity case sensitive.
Type: SwitchParameter
Parameter Sets: Identity
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Identity
The identity name used to talk to the MQTT message broker (Preshared Key method). The identity.
Type: String
Parameter Sets: Psk
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PreSharedKey
The Preshared key used togehter with the identity for MQTT message broker communication. The key.
Type: String
Parameter Sets: Psk
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CA
Path to the Certificate Authority file. Certificates of MQTT broker, signed by this CA will be accepted for connection. The file must be already located on the target system. Path to the CA Root certificate
Type: String
Parameter Sets: SCA
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Cert
Path to the public key Certificate (X.509). The file must be already located on the target system. Path to the certificate file.
Type: String
Parameter Sets: SCA
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Key
Path of the private Key file of the X.509 Certifcate. The file must be already located on the target system. Path to the Key file.
Type: String
Parameter Sets: SCA
Aliases:
Required: True
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.. Value of the Quiet parameter
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) The quiet.
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
-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.