Get-IODevice
SYNOPSIS
Gets actually loaded IO Devices of the target system.
SYNTAX
NetIdPortList (Default)
Get-IODevice [-Id <Int32>] [-Timeout <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
NetIdPort
Get-IODevice [-NetId <AmsNetId>] [-Id <Int32>] [-Timeout <Int32>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
AddressStr
Get-IODevice [-Address] <String> [-Id <Int32>] [-Timeout <Int32>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Session
Get-IODevice -Session <ISession> [-Id <Int32>] [-Timeout <Int32>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION
This command lists the actually loaded IO Devices of the target system.
The list can be filted by specific Device IDs.
EXAMPLES
EXAMPLE 1
PS> Get-IODevice -NetId 5.62.192.46.1.1
ID DeviceName DeviceType DeviceNetId BoxesCount
-- ---------- ---------- ----------- ----------
1 Device 1 (EtherCAT) EtherCAT_DirectModeV210 172.16.1.3.2.1 4
Getting the IO Devices from NetID 5.62.192.46.1.1
EXAMPLE 2
PS> (Get-IODevice -Address CX_01234 -Id 1).Boxes
ID Name BoxType Port Comment
-- ---- ------- ---- -------
1 Box 1 (IFC2422) EtherCAT_EXXXXX 1001
2 Box 2 (IFC2421m) EtherCAT_EXXXXX 1002
3 Box 3 (IFC2421m1) EtherCAT_EXXXXX 1003
4 Box 4 (IFC2421m2) EtherCAT_EXXXXX 1004
Getting the Boxes of Device with Id 1 from the target system with Name/Address CX_01234
PARAMETERS
-NetId
The address where to get the device.
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 Devices.
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, must be connected to port 300, R0_IO
Type: ISession
Parameter Sets: Session
Aliases: InputObject
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Id
Specifies the DeviceId to scan by the Cmdlet.
If not specified, all Devices will be scanned.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
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).
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: -1
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
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.