Start-AdsProcess
SYNOPSIS
Start a process via ADS on the target system.
SYNTAX
NetIdPort (Default)
Start-AdsProcess [[-NetId] <AmsNetId[]>] -FilePath <String> [-ArgumentList <String[]>] [-WorkingDir <String>]
[-Timeout <Int32>] [-Force] [<CommonParameters>]
Route
Start-AdsProcess [-InputObject] <IRoute[]> -FilePath <String> [-ArgumentList <String[]>] [-WorkingDir <String>]
[-Timeout <Int32>] [-Force] [<CommonParameters>]
AddressStr
Start-AdsProcess [-Address] <String[]> -FilePath <String> [-ArgumentList <String[]>] [-WorkingDir <String>]
[-Timeout <Int32>] [-Force] [<CommonParameters>]
Session
Start-AdsProcess -Session <ISession[]> -FilePath <String> [-ArgumentList <String[]>] [-WorkingDir <String>]
[-Timeout <Int32>] [-Force] [<CommonParameters>]
SessionId
Start-AdsProcess -SessionId <Int32[]> -FilePath <String> [-ArgumentList <String[]>] [-WorkingDir <String>]
[-Timeout <Int32>] [-Force] [<CommonParameters>]
DESCRIPTION
This Cmdlet starts a processs on the Target system.
EXAMPLES
Example 1
PS> Start-AdsProcess -Address CX_1234 -path "notepad.exe"
Starts the notepad.exe on the target system.
PARAMETERS
-NetId
NetId(s) of the target system. Tab completion: Completes AmsNetId values from currently reachable routes on the local TwinCAT system. The net id.
Type: AmsNetId[]
Parameter Sets: NetIdPort
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InputObject
The route object where to get the Target information from.. Tab completion: Completes route names from currently reachable ADS systems on the local TwinCAT system. The input object.
Type: IRoute[]
Parameter Sets: Route
Aliases: Destination, Route
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Address
Target names/addresses. These can consist of RouteName, NetID, HostName or 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: Name
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-Session
The Session to use for the value read. The address.
Type: ISession[]
Parameter Sets: Session
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-SessionId
Specifies the Session (with unique ID) to use for the value read. Tab completion: Completes IDs of active TwinCAT sessions (created with New-TcSession). The Session ID.
Type: Int32[]
Parameter Sets: SessionId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilePath
Path to the executable of the target system. The Path.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ArgumentList
Specifies parameters or parameter values to use when this cmdlet starts the process. Arguments can be accepted as a single string with the arguments separated by spaces, or as an array of strings separated by commas. The cmdlet joins the array into a single string with each element of the array separated by a single space. The Path.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WorkingDir
The working directory on the target system The Path.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
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
-Force
Force reading value. This flag bypasses the FailFastInterceptor to retry communication in every case. Force flag.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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.