Get-IoFreeRun
SYNOPSIS
Gets the IO FreeRun State of the specified target.
SYNTAX
NetIdPortList (Default)
Get-IoFreeRun [-Timeout <Int32>] [<CommonParameters>]
NetIdPort
Get-IoFreeRun [-NetId <AmsNetId>] [-Timeout <Int32>] [<CommonParameters>]
AddressStr
Get-IoFreeRun [-Address] <String> [-Timeout <Int32>] [<CommonParameters>]
Session
Get-IoFreeRun -Session <ISession> [-Timeout <Int32>] [<CommonParameters>]
DESCRIPTION
This command gets the IO FreeRun state of specified target when the target is in config mode. If the target system is not in config mode, a warning is produced.
EXAMPLES
Example 1
PS> Get-IoFreeRun -NetId 5.62.192.46.1.1
$true
Getting the IO FreeRun State from NetID 5.62.192.46.1.1
PARAMETERS
-NetId
The address where to get the free run state. Tab completion: Completes AmsNetId values from currently reachable routes on the local TwinCAT system. The NetId. Null is not a valid value for the NetId parameter!
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 get the free run state. This can be the RouteName, NetId, the HostName or the IPAddress. Wildcards are permitted. Tab completion: Completes route names from currently reachable ADS systems on the local TwinCAT system. The address.
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, must be connected to port 300, R0_IO The Session.
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). The ADS communication timeout in milliseconds.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: -1
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.