Set-IoFreeRun
SYNOPSIS
Sets the IO FreeRun state of the target.
SYNTAX
NetIdPortList (Default)
Set-IoFreeRun [-Timeout <Int32>] [-Quiet] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
NetIdPort
Set-IoFreeRun [-NetId <AmsNetId>] [-Timeout <Int32>] [-Quiet] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
AddressStr
Set-IoFreeRun [-Address] <String> [-Timeout <Int32>] [-Quiet] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
Session
Set-IoFreeRun -Session <ISession> [-Timeout <Int32>] [-Quiet] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
Sets the IO FreeRun state of a TwinCAT target.
The target must be in Config mode, otherwise an error will be produced.
EXAMPLES
EXAMPLE 1
PS> Set-IOFreeRun -NetId 5.62.192.46.1.1
Setting the target system with NetID 5.62.192.46.1.1 to IO FreeRun mode.
PARAMETERS
-NetId
The address where to set the TwinCAT FreeRun state.
Type: AmsNetId
Parameter Sets: NetIdPort
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Address
The address(es) where to set the TwinCAT FreeRun state.
This can be the RouteName, NetId, the HostName or the IPAddress.
Wildcards are permitted.
Type: String
Parameter Sets: AddressStr
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-Session
The Session to use for the Cmdlet
Type: ISession
Parameter Sets: Session
Aliases: InputObject
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Timeout
The communication ADS timeout in milliseconds.
A value of 0 disables the timeout.
A value \<= 0 sets the Default (5000 ms).
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: -1
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
-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.