Utiliser des modules d’intégration

  • Article

Important

Cette version de Service Management Automation (SMA) a atteint la fin du support. Nous vous recommandons de mettre à niveau vers SMA 2022.

Un module d'intégration est un package qui contient un module Windows PowerShell. Pour plus d'informations sur l'écriture d'un module Windows PowerShell, consultez la page relative à l' écriture d'un module Windows PowerShell. Un module d'intégration peut contenir tous les types de module valides spécifiés dans les modules Windows PowerShell. Cela inclut les modules de script (.psm1), les modules binaires (.dll) et les modules de manifeste (.psd1). Le package du module d'intégration est un fichier compressé qui porte le même nom que le module avec une extension .zip. Il contient un seul dossier, qui porte également le nom du module. Le module Windows PowerShell et les fichiers de prise en charge, ainsi qu'un fichier manifeste (.psd1) si le module en dispose, doivent se trouver dans ce dossier.

Si le module doit contenir un type Connection , il doit également contenir un fichier nommé <ModuleName>-Automation.json qui spécifie les propriétés du type de connexion. Il s'agit d'un fichier json au format suivant.

{
   "ConnectionFields": [
   {
      "IsEncrypted":  false,
      "IsOptional":  false,
      "Name":  "ComputerName",
      "TypeName":  "System.String"
   },
   {
      "IsEncrypted":  false,
      "IsOptional":  true,
      "Name":  "Username",
      "TypeName":  "System.String"
   },
   {
      "IsEncrypted":  true,
      "IsOptional":  false,
      "Name":  "Password",
   "TypeName":  "System.String"
   }],
   "ConnectionTypeName":  "DataProtectionManager",
   "IntegrationModuleName":  "DataProtectionManager"
}

Les étapes de création et d’utilisation des runbooks Automation diffèrent selon que vous utilisez un portail de gestion ou Windows PowerShell. Les étapes de base pour diverses opérations courantes utilisant les deux méthodes sont fournies dans les sections suivantes.

Énumérer les modules installés

Obtenir la liste des modules installés à l'aide du portail de gestion

  1. Sélectionnez l'espace de travail Automation.

  2. Si vous utilisez Azure, sélectionnez un compte Automation.

  3. En haut de la fenêtre, sélectionnez Ressources.

  4. Examinez les ressources de la liste dont le type est Module.

Obtenir la liste des modules installés à l'aide de Windows PowerShell

Les exemples de commandes suivants récupèrent tous les modules installés dans Automation.

$webServer = 'https://MyWebServer'
$port = 9090
Get-SmaModule -WebServiceEndpoint $webServer -Port $port

Importer un module

Un module est un fichier compressé avec une extension .zip qui contient un dossier, qui inclut l’un des types de fichiers suivants :

  • Un module (fichier psm1)
  • Un manifeste de module (fichier psd1)

Pour importer un module à l'aide du portail de gestion

  1. Sélectionnez l'espace de travail Automation.

  2. En bas de la fenêtre, sélectionnez Importer le module.

  3. Sélectionnez Rechercher un fichier.

  4. Sélectionnez le fichier de module, puis sélectionnez OK.

  5. Sélectionnez le bouton coche dans la boîte de dialogue.

Importer un module à l'aide de Windows PowerShell

Les exemples de commandes suivants montrent comment importer un module.

$webServer = 'https://MyWebServer'
$port = 9090
$modulePath = 'C:\Modules\MyModule.psm1'
Import-SmaModule -WebServiceEndpoint $webServer -Port $port -Path $modulePath

Énumérer les activités dans amModule

Obtenir la liste des activités d'un module dans le portail de gestion

  1. Sélectionnez l'espace de travail Automation.

  2. Si vous utilisez Azure, sélectionnez un compte Automation.

  3. En haut de la fenêtre, sélectionnez Ressources.

  4. Localisez le module et sélectionnez-le.

  5. Faites défiler la page vers le bas de l'écran Détails sur le module et examinez ses activités.

  6. Si vous le souhaitez, sélectionnez l’icône de loupe pour filtrer des activités particulières.

Obtenir la liste des activités dans un module à l'aide de Windows PowerShell

Les exemples de commandes suivants montrent comment récupérer les activités dans un module particulier.

$webServer = 'https://MyWebServer'
$port = 9090
$moduleName = 'MyModule'
$module = Get-SmaModule -WebServiceEndpoint $webServer -Port $port -Name $moduleName
$module.Activities

Obtenir la liste des activités dans tous les modules à l'aide de Windows PowerShell

Les exemples de commandes suivants montrent comment récupérer les activités dans tous les modules installés dans Automation.

$webServer = 'https://MyWebServer'
$port = 9090
$modules = Get-SmaModule -WebServiceEndpoint $webServer -Port $port
$modules | foreach {$_.Activities} | sort Name,ModuleName | ft Name,ModuleName,Description

Étapes suivantes