Add-AdsRoute
SYNOPSIS
Cmdlet for adding TwinCAT Routes.
SYNTAX
Routes (Default)
Add-AdsRoute [-RemotePersistance <RoutePersistanceType>] -InputObject <IRoute[]> [-Destination <String>]
[-DestinationCredential <PSCredential>] -Credential <PSCredential> [-HostName] [-Temporary] [-Unidirectional]
[-Quiet] [-Force] [-Nat <AmsNetId>] [-PassThru] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Address
Add-AdsRoute [-Name <String>] [-Address] <String[]> [-RemotePersistance <RoutePersistanceType>]
[-BroadcastTimeout <Int32>] [-Destination <String>] [-DestinationCredential <PSCredential>]
[-Credential <PSCredential>] [-HostName] [-Temporary] [-Unidirectional] [-Quiet] [-Force] [-Nat <AmsNetId>]
[-PassThru] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
AddressPSK
Add-AdsRoute [-Name <String>] [-Address] <String[]> [-BroadcastTimeout <Int32>] [-Destination <String>]
[-DestinationCredential <PSCredential>] -Credential <PSCredential> [-HostName] [-Temporary] [-PreSharedKey]
[-Unidirectional] [-Quiet] [-Force] [-Nat <AmsNetId>] [-PassThru] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
AddressPSKKey
Add-AdsRoute [-Name <String>] [-Address] <String[]> [-BroadcastTimeout <Int32>] [-Destination <String>]
[-DestinationCredential <PSCredential>] -Identity <String> -BinaryKey <Byte[]> [-HostName] [-Temporary]
[-PreSharedKey] [-Unidirectional] [-Quiet] [-Force] [-Nat <AmsNetId>] [-PassThru]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
AddressSCA
Add-AdsRoute [-Name <String>] [-Address] <String[]> [-BroadcastTimeout <Int32>] [-Destination <String>]
[-DestinationCredential <PSCredential>] [-HostName] [-Temporary] [-SharedCertAuth] [-IgnoreCN]
[-Unidirectional] [-Quiet] [-Force] [-Nat <AmsNetId>] [-PassThru] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
AddressSSC
Add-AdsRoute [-Name <String>] [-Address] <String[]> [-BroadcastTimeout <Int32>] [-Destination <String>]
[-DestinationCredential <PSCredential>] -Credential <PSCredential> [-HostName] [-Temporary] [-SelfSigned]
[-FingerPrint <String>] [-Unidirectional] [-Quiet] [-Force] [-Nat <AmsNetId>] [-PassThru]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
NetId
Add-AdsRoute [-Name <String>] [-NetId] <AmsNetId> [-IPOrHostName <String>]
[-RemotePersistance <RoutePersistanceType>] [-Destination <String>] [-DestinationCredential <PSCredential>]
[-Credential <PSCredential>] [-HostName] [-Temporary] [-Unidirectional] [-Quiet] [-Force] [-Nat <AmsNetId>]
[-PassThru] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
NetIdPSK
Add-AdsRoute [-Name <String>] [-NetId] <AmsNetId> [-IPOrHostName <String>] [-Destination <String>]
[-DestinationCredential <PSCredential>] -Credential <PSCredential> [-HostName] [-Temporary] [-PreSharedKey]
[-Unidirectional] [-Quiet] [-Force] [-Nat <AmsNetId>] [-PassThru] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
NetIdPSKKey
Add-AdsRoute [-Name <String>] [-NetId] <AmsNetId> [-IPOrHostName <String>] [-Destination <String>]
[-DestinationCredential <PSCredential>] -Identity <String> -BinaryKey <Byte[]> [-HostName] [-Temporary]
[-PreSharedKey] [-Unidirectional] [-Quiet] [-Force] [-Nat <AmsNetId>] [-PassThru]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
NetIdSCA
Add-AdsRoute [-Name <String>] [-NetId] <AmsNetId> [-IPOrHostName <String>] [-Destination <String>]
[-DestinationCredential <PSCredential>] [-HostName] [-Temporary] [-SharedCertAuth] [-IgnoreCN]
[-Unidirectional] [-Quiet] [-Force] [-Nat <AmsNetId>] [-PassThru] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
NetIdSSC
Add-AdsRoute [-Name <String>] [-NetId] <AmsNetId> [-IPOrHostName <String>] [-Destination <String>]
[-DestinationCredential <PSCredential>] -Credential <PSCredential> [-HostName] [-Temporary] [-SelfSigned]
[-FingerPrint <String>] [-Unidirectional] [-Quiet] [-Force] [-Nat <AmsNetId>] [-PassThru]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
RoutesPSK
Add-AdsRoute -InputObject <IRoute[]> [-Destination <String>] [-DestinationCredential <PSCredential>]
-Credential <PSCredential> [-HostName] [-Temporary] [-PreSharedKey] [-Unidirectional] [-Quiet] [-Force]
[-Nat <AmsNetId>] [-PassThru] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
RoutesPSKKey
Add-AdsRoute -InputObject <IRoute[]> [-Destination <String>] [-DestinationCredential <PSCredential>]
-Identity <String> -BinaryKey <Byte[]> [-HostName] [-Temporary] [-PreSharedKey] [-Unidirectional] [-Quiet]
[-Force] [-Nat <AmsNetId>] [-PassThru] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
RoutesSCA
Add-AdsRoute -InputObject <IRoute[]> [-Destination <String>] [-DestinationCredential <PSCredential>]
[-HostName] [-Temporary] [-SharedCertAuth] [-IgnoreCN] [-Unidirectional] [-Quiet] [-Force] [-Nat <AmsNetId>]
[-PassThru] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
RoutesSSC
Add-AdsRoute -InputObject <IRoute[]> [-Destination <String>] [-DestinationCredential <PSCredential>]
-Credential <PSCredential> [-HostName] [-Temporary] [-SelfSigned] [-FingerPrint <String>] [-Unidirectional]
[-Quiet] [-Force] [-Nat <AmsNetId>] [-PassThru] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Adds a Route to the destination target System (Temporary or statically).
Dependant on the used parameters, this Cmdlet uses an internal broadcast search to determine the target system Addresses (NetId, HostName or IPAddress) to establish a full defined route.
To find the specified target it is necessary that the target system is running/online and reachable from the local system.
Another use case is to establish a route on the local system for preparation before the targeting system is available.
In that case the full target address represented by the -NetID and -IPOrHostName parameter must be given, while leaving out the -Credential parameter.
EXAMPLES
EXAMPLE 1
> Get-AdsRoute -All -name "Tc3*"
Name NetId Address Sub TcVersion RTSystem
---- ----- ------- --- --------- --------
TC3TestA1-CP67x 172.17.62.105.1.1 172.17.62.105 3.1.4021 Win7
TC3Test13-C6650 172.17.60.239.1.1 172.17.62.156 2.11.2246 Win7
PS> $cred = Get-Credential -Message "Get Credentials" -UserName "UserName"
PS> Add-AdsRoute -Credential $cred -name "TC3TestA1-CP67x" -temporary -passthru
Name NetId Address Sub TcVersion RTSystem
---- ----- ------- --- --------- --------
TC3TestA1-CP67x 172.17.62.105.1.1 172.17.62.105 3.1.4021 Win7
PS> Get-AdsRoute -name "TC3TestA1-CP67x" | Test-AdsRoute
Search for Systems that start with the name "TC3*", then asks the user for Credentials and adds the Route as 'temporary' (with TC2 compatible security, clear text password).
Afterwards, the connection is checked via 'Test-AdsRoute'.
The route is specified by its name (ComputerName).
To find out the address of the route an under the hood broadcast search is necessary what means that the target system must be online available in the network.
EXAMPLE 2
> Add-AdsRoute -name Test -NetId 1.2.3.4.1.1 -IPOrHostName 1.2.3.4
Adds a Route named 'Test' to the local routes with the specified NetId and IPAddress.
Because NetId and IPOrHostName are defined AND no credentials are set, this route is added locally only.
Be aware that to get the route functional, the target system must define the backroute.
EXAMPLE 3
> Get-AdsRoute -All -name "Tc3*"
Name NetId Address Sub TcVersion RTSystem
---- ----- ------- --- --------- --------
TC3TestA1-CP67x 172.17.62.105.1.1 172.17.62.105 3.1.4021 Win7
TC3Test13-C6650 172.17.60.239.1.1 172.17.62.156 2.11.2246 Win7
PS> $cred = Get-Credential -Message "Get Credentials" -UserName "UserName"
PS> Add-AdsRoute -Credential $cred -name "TC3TestA1-CP67x" -selfSigned -passthru
Name NetId Address Sub TcVersion RTSystem
---- ----- ------- --- --------- --------
TC3TestA1-CP67x 172.17.62.105.1.1 172.17.62.105 3.1.4021 Win7
PS> Get-AdsRoute -name "TC3TestA1-CP67x" | Test-AdsRoute
Search for Systems that start with the name "TC3*", then asks the user for Credentials and adds the Route with 'SelfSigned' AdsSecure settings.
Afterwards, the connection is checked via 'Test-AdsRoute'.
The route is specified by its name (ComputerName).
To find out the address of the route an under the hood broadcast search is necessary what means that the target system must be online available in the network.
EXAMPLE 4
PS> Add-AdsRoute -Address 172.17.62.105 -sca -paththru
Name NetId Address Sub TcVersion RTSystem
---- ----- ------- --- --------- --------
TC3TestA1-CP67x 172.17.62.105.1.1 172.17.62.105 3.1.4021 Win7
Searches for the system with the specified IPAddress, and add the Route with Shared Certification Authority settings without password.
The precondition is, that valid certificates are already established on both (engineering and remote) systems, within their StaticRoutes.xml files.
The route is specified by its Address only.
Because the NetId is missing a broadcast search is necessary what means that the target system must be online available in the network.
EXAMPLE 5
PS> $cred = Get-Credential -Message "Get Credentials" -UserName "UserName"
PS> Add-AdsRoute -Credential $cred -NetId 172.17.62.105 -Nat 1.2.3.4.1.1
Name NetId Address Sub TcVersion RTSystem
--------------- ----------- ------------- --- --------- ------------
TC3TestA1-CP67x 1.2.3.4.1.1 172.17.62.105 3.1.4024 Win10 (2004)
Add a route with a local network address translation (NAT AmsNetId) to project a remote AmsNetId (RemoteNetId) locally to a different address.
EXAMPLE 6
Add-AdsRoute -name "TestRoute" -NetId 1.2.3.4.1.1 -IPOrHostName 1.2.3.4 -Temporary -RemotePersistance None
Adding a route 'TestRoute' single sided and temporary only to the local system.
The remote device doesn't need to be online.
EXAMPLE 7
PS> $route = get-adsroute CX_01234 -all
PS> $route
Name NetId TLS Address FingerPrint
---- ----- --- ------- -----------
CX_01234 172.17.60.197.1.1 X 172.17.60.197 7835dae7a079c4f296c84109b2e6d7156b66e6bcc39e386c3576d7535…
PS> $route | add-adsroute -SharedCertAuth -IgnoreCN -passthru
Name NetId TLS Address FingerPrint
---- ----- --- ------- -----------
CX_01234 172.17.60.197.1.1 X 172.17.60.197 7835dae7a079c4f296c84109b2e6d7156b66e6bcc39e386c3576d7535…
Broadcast search for a Device with Hostname CX_01234 and adding of a ADSSecure route via 'Shared Certificate Authority' (SCA) to the local system.
Both systems must contain certificates derived from the same root CA certificate.
EXAMPLE 8
PS> $cred = get-credential
UserName: MyUser
Password: ********
PS> $route = get-adsroute CX_01234 -all
PS> $route
Name NetId TLS Address FingerPrint
---- ----- --- ------- -----------
CX_01234 172.17.60.197.1.1 X 172.17.60.197 7835dae7a079c4f296c84109b2e6d7156b66e6bcc39e386c3576d7535…
PS> $route | add-adsroute -PreSharedKey -Credential $cred
Name NetId TLS Address FingerPrint
---- ----- --- ------- -----------
CX_01234 172.17.60.197.1.1 X 172.17.60.197 7835dae7a079c4f296c84109b2e6d7156b66e6bcc39e386c3576d7535…
Broadcast search for a Device with Hostname CX_01234 and adding of a ADSSecure route via 'Preshared key' (UserName, Password) to the local system.
The target system must already contain the preshared key configuration (as Psk Identity/Password) in its StaticRoutes.xml configuration file.
EXAMPLE 9
PS> $route = get-adsroute CX_01234 -all
PS> $route
Name NetId TLS Address FingerPrint
---- ----- --- ------- -----------
CX_01234 172.17.60.197.1.1 X 172.17.60.197 7835dae7a079c4f296c84109b2e6d7156b66e6bcc39e386c3576d7535…
PS> $route | add-adsroute -PreSharedKey -Identity MyUser -BinaryKey 1,2,3,4,5,6,7,8,9,0xa,0xb,0xc,0xd,0xe,0xf
Name NetId TLS Address FingerPrint
---- ----- --- ------- -----------
CX_01234 172.17.60.197.1.1 X 172.17.60.197 7835dae7a079c4f296c84109b2e6d7156b66e6bcc39e386c3576d7535…
Broadcast search for a Device with Hostname CX_01234 and adding of a ADSSecure route via 'Preshared key' (Identity, BinaryKey) to the local system.
The target system must already contain the preshared key configuration (as Psk Identity/BinaryKey) in its StaticRoutes.xml configuration file.
PARAMETERS
-Name
The name of the route(s) to add.
If the Routes address is ambiguous and more than one route will be found online for adding then the route names will be numbered to be distinct.
Without setting this parameter, the default route name will be its Computername / Hostname.
Type: String
Parameter Sets: Address, AddressPSK, AddressPSKKey, AddressSCA, AddressSSC, NetId, NetIdPSK, NetIdPSKKey, NetIdSCA, NetIdSSC
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Address
The address for the ADS route.
This can be the RouteName, NetId, the HostName or the IPAddress.
Type: String[]
Parameter Sets: Address, AddressPSK, AddressPSKKey, AddressSCA, AddressSSC
Aliases: TargetAddress
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-NetId
The AmsNetID for the ADS route to add.
If no further IPAddress or HostName is specified with the -IPOrHostName parameter, a broadcast search is triggered to find an online device.
If a single sided route should be added, specify the IPAddress or HostName Parameter in combination with -RemotePersistance:None and without -Credential.
Type: AmsNetId
Parameter Sets: NetId, NetIdPSK, NetIdPSKKey, NetIdSCA, NetIdSSC
Aliases: TargetNetId
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IPOrHostName
The HostName Address of the target route or the IPAddress.
Because the HostName or IPAddress is necessary in addition to the NetId for a functional route, the Add-AdsRoute Cmdlet tries to detect the HostName/IPAddress via a Broadcast search in the Network when it is not specified.
That means the target must be available and reachable within the network in that case.
If not the Add-AdsRoute Cmdlet will fail.
If the IP or HostName in combination with the -NetId is specified, the target availability is not necessary and Add-Route will register the Route whatever is specified as address.
Type: String
Parameter Sets: NetId, NetIdPSK, NetIdPSKKey, NetIdSCA, NetIdSSC
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RemotePersistance
The persistance type of the remmote route.
None/Server means no remote route will be created.
Other valid values are 'Static' or 'Temporary'
Possible values: None, Server, Temporary, Static
Type: RoutePersistanceType
Parameter Sets: Routes, Address, NetId
Aliases:
Accepted values: None, Server, Temporary, Static
Required: False
Position: Named
Default value: Static
Accept pipeline input: False
Accept wildcard characters: False
-BroadcastTimeout
(Broadcast) Search Timeout for searching the unregistered target in seconds (Default 0, Dynamic detection).
Type: Int32
Parameter Sets: Address, AddressPSK, AddressPSKKey, AddressSCA, AddressSSC
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-InputObject
The input Ads Routes.
Type: IRoute[]
Parameter Sets: Routes, RoutesPSK, RoutesPSKKey, RoutesSCA, RoutesSSC
Aliases: Route, TargetRoute
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Destination
The Destination Address, where the route is added.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DestinationCredential
The credentials of the destination system, where to add the route.
Local system by default.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Credential
Credentials of the route to be added to the destination system.
This parameter is only necessary, when a bidirectional route will be added.
When specifying
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.
Type: PSCredential
Parameter Sets: Routes, AddressPSK, AddressSSC, NetIdPSK, NetIdSSC, RoutesPSK, RoutesSSC
Aliases: TargetCredential
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: PSCredential
Parameter Sets: Address, NetId
Aliases: TargetCredential
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Identity
The BinaryKey can be used instead of the credential Password on SecureSettings.PreSharedKeys (PSK).
There is no function for this parameter on other security settings.
Type: String
Parameter Sets: AddressPSKKey, NetIdPSKKey, RoutesPSKKey
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BinaryKey
The BinaryKey can be used instead of the credential Password on SecureSettings.PreSharedKeys (PSK).
There is no function for this parameter on other security settings.
Type: Byte[]
Parameter Sets: AddressPSKKey, NetIdPSKKey, RoutesPSKKey
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-HostName
If set, the route will be registered as HostName
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Temporary
If set, the Route will be registered as temporary route.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-SelfSigned
Gets or sets the SelfSigned (SSC) mode for adding the route.
Type: SwitchParameter
Parameter Sets: AddressSSC, NetIdSSC, RoutesSSC
Aliases: SSC
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-FingerPrint
The Fingerprint used for adding the route.
This parameter can be used when the parameter '-SelfSigned' is set.
If specified, the found OnlineTarget will be checked against this fingerprint.
If not specified, the 'Add-AdsRoute' Cmdlet doesn't check the fingerprint, always adding the route.
Using the fingerprint means that only single routes can be added, multi-adding routes with fingerprint is not supported.
Type: String
Parameter Sets: AddressSSC, NetIdSSC, RoutesSSC
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PreSharedKey
Gets or sets the PreSharedKey (PSK) mode for adding the route.
Because a valid certificate is expected at the target, it is not necessary to enter credentials.
Type: SwitchParameter
Parameter Sets: AddressPSK, AddressPSKKey, NetIdPSK, NetIdPSKKey, RoutesPSK, RoutesPSKKey
Aliases: PSK
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-SharedCertAuth
Gets or sets the SharedCertificateAuthority (SCA) mode for adding the route.
Because a valid certificate is expected at the target, it is not necessary to enter credentials.
Type: SwitchParameter
Parameter Sets: AddressSCA, NetIdSCA, RoutesSCA
Aliases: SCA
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-IgnoreCN
Gets or sets the 'Ignore Common Name' mode for SharedCertificateAuthority (SCA) while adding the route.
The "CommonName" of the certificate must correspond to the name used when establishing the connection in the certificate.
This behavior can be deactivated by this option.
Type: SwitchParameter
Parameter Sets: AddressSCA, NetIdSCA, RoutesSCA
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Unidirectional
Gets or sets the unidirectional setting.
The Unidirectional setting registers the ADS Route as 'one-way' channel.
That means that the engineering/source system (thats where the route request is initiated) can send requests to the remote target, but not in the opposite direction.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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
-Force
Forces the command (no confirmation, Resets the FailFastHandler)
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Nat
The 'Nat' parameter sets the local representation of the routes AmsNetId.
All (local) addressing to this netId will be translated to the remote/network AmsAddress of the route.
If using the '-Nat' parameter, the 'Add-AdsRoute' Cmdlet is limited to single route additions.
Multi-adding is not supported.
This Parameter can be used with TwinCAT Versions \>= 3.1.4024.11.
Type: AmsNetId
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru
If the passthrough parameter is set, the successfully created route will be returned as object.
By default, this Cmdlet will not create any output.
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
-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.