Invoke PowerShell

Invoke PowerShell activity that executes a PowerShell command or script with specified input parameters.

UiPath.Core.Activities.InvokePowerShell

Description

The Invoke PowerShell activity executes a PowerShell command or script with specified input parameters.

Remarque :

Antivirus policies that restrict PowerShell access may prevent the use of PowerShell-related activities. For example, you cannot use Invoke Workflow File and Invoke PowerShell when rule ID 6151 is enabled in McAfee Endpoint Security.

Compatibilité du Projet

Windows - Héritage | Windows

Configuration

• Texte de commande (Command Text) : la commande PowerShell à exécuter. Cette valeur peut être le nom d'une cmdlet ou le texte d'un script PowerShell.

Panneau propriétés

Commun

• Continue On Error : indique si l'automatisation doit se poursuivre, même lorsque l'activité génère une erreur. Ce champ ne prend en charge que des valeurs booléennes (True, False). La valeur par défaut est False. Par conséquent, si le champ est vide et qu'une erreur est générée, l'exécution du projet s'arrête. Si la valeur est définie sur True, l'exécution du projet se poursuit indépendamment de toute erreur.
  Remarque :

  Si cette activité est incluse dans Tenter de capturer (Try Catch) et que la valeur de la propriété Poursuite sur erreur (ContinueOnError) est True, aucune erreur n'est détectée lors de l'exécution du projet.

• NomAffichage (DisplayName) - Nom affiché de l'activité.

Entrée

• Paramètres (Parameters) : le dictionnaire des paramètres de la commande PowerShell. Une commande (cmdlet) ou un script spécifique peut être utilisé.
  • Commande spécifique : lorsque vous invoquez une commande spécifique, le nom du paramètre doit correspondre au nom du paramètre de la commande.

Par exemple, si vous utilisez Get-Command -Module CimCmdlets comme entrée, la valeur d'entrée doit être Get-Command et le paramètre doit être nommé Module avec la valeur définie sur "CimCmdlets".

• Script : au début du script, vous devez préciser le type du paramètre. En option, vous pouvez également rendre un paramètre obligatoire pour qu'un script soit toujours appelé avec le paramètre défini par l'appelant.

Par exemple, le script suivant prend deux paramètres, l'un de type string, et l'autre de type int :

Param(
  [Parameter(Mandatory=$true)]
  [string]$Name,
  [int]$Age
)

Ces paramètres peuvent ensuite être référencés dans le script en ajoutant $ devant le nom du paramètre.

• Input - A collection of PSObjects that are passed to the writer of the pipeline used to execute the command. Can be the output of another Invoke PowerShell activity. You can reference piped input in a script by using $input.
  Remarque :

  Cette variable est créée implicitement par PowerShell. La définition de variables ou de paramètres nommés input peut générer des erreurs ou des conflits. Il est recommandé que le terme input soit réservé pour les pipelines.

Options

• EstScript (IsScript) : permet d'indiquer si le texte de la commande est un script ou une commande directe. Les Pipelines, Variables et Paramètres peuvent être utilisés avec une seule commande ou script.
• Mode d'exécution (Execution mode) : sélectionnez une version de PowerShell dans laquelle exécuter la commande ou le script fourni. Ceci n'est disponible que pour les projets Windows, les projets Windows-Legacy ciblent la version Windows PowerShell 5.1 (32 bits). Les options suivantes sont disponibles :
  • PowerShell 7.2.15 (64 bits) : utilise le shell PowerShell Core basé sur .NET6. Dans cette version, PowerShell est hébergé dans le runtime.NET 6. Toutes les données utilisées sont directement accessibles par l'activité et peuvent être importées dans le workflow.
  • PowerShell 5.1 (64 bits) : utilise l'exécutable Windows PowerShell 64 bits. Dans cette version, PowerShell est fourni avec Windows et est situé par défaut dans C:\Windows\System32\WindowsPowerShell\v1.0\. Dans ce mode d'exécution, PowerShell est distant localement sur la machine à l'aide du shell préinstallé. La mise à distance introduit le besoin de sérialiser et de désérialiser les informations entre les différents runtimes .NET, et de ce fait, les objets qui ne peuvent pas être reconstruits sont encapsulés dans un PSObject ou PSCustomObject.
  • PowerShell 5.1 (32 bits) : utilise l'exécutable Windows PowerShell 32 bits. Dans cette version, PowerShell est fourni avec Windows et est situé par défaut dans C:\Windows\SysWOW64\WindowsPowerShell\v1.0\). Dans ce mode d'exécution, PowerShell est distant localement sur la machine à l'aide du shell préinstallé. La mise à distance introduit le besoin de sérialiser et de désérialiser les informations entre les différents runtimes .NET, et de ce fait, les objets qui ne peuvent pas être reconstruits sont encapsulés dans un PSObject ou PSCustomObject. PSObject et PSCustomObjects contiennent des informations sur la structure globale de l'objet d'origine et peuvent être utilisés pour reconstruire les objets manuellement.
• PowerShellVariables - A dictionary of named objects that represent variables used within the current session of the Invoke PowerShell activity. A PowerShell command or script can retrieve information from In and In/Out variables and can set Out variables. To reference variables in your script, use the variable identifier character $ to denote that the text after is a variable name. Example: $firstVariable.
  Remarque :

  Les noms de variables ne sont pas sensibles à la casse.

• Type actuel : définit le type des objets renvoyés dans la sortie.

Divers

• Privé (Private) - Si cette option est sélectionnée, les valeurs des variables et des arguments ne sont plus enregistrées au niveau Détaillé (Verbose).

Sortie

• Output - A collection of objects of the type set in Current type, returned by the execution of the command. Can be used to pipe several Invoke PowerShell activities.