Partager via

Prise en charge PowerShell pour les clusters de passerelles de données locales

  • Article

Les scripts PowerShell sont disponibles dans la galerie PowerShell. Les scripts décrits dans cet article concernent PowerShell version 5. Lorsque vous utilisez PowerShell version 7, reportez-vous à Cmdlets PowerShell pour la gestion de la passerelle de données locale. Vous pouvez utiliser les scripts PowerShell pour exécuter les opérations suivantes :

  • Récupérer la liste des clusters de passerelles disponibles pour un utilisateur.
  • Récupérer la liste des instances de passerelle inscrites dans un cluster, ainsi que leur état en ligne ou hors connexion.
  • Modifier l’état Activé/désactivé d’une instance de passerelle dans un cluster, ainsi que d’autres propriétés de passerelle.
  • Supprimer une passerelle.

Exécuter les commandes PowerShell

Pour installer ces cmdlets, exécutez la commande suivante dans une session PowerShell avec élévation de privilèges :

Install-Module -Name OnPremisesDataGatewayHAMgmt

Vous trouverez la liste complète des cmdlets à l’aide de la commande suivante :

Get-Command -Module OnPremisesDataGateway*

Des exemples et des descriptions sont inclus dans les cmdlets et vous pouvez y accéder à l’aide de la commande suivante :

get-help <cmdlet-name>

Vous pouvez maintenant utiliser les commandes du tableau suivant pour gérer vos clusters de passerelles.

Commande Description Paramètres
Login-OnPremisesDataGateway Utilisez cette commande pour vous connecter afin de gérer vos clusters de passerelles de données locales. Vous devez exécuter cette commande et vous connecter avant pour que les autres commandes de haute disponibilité puissent fonctionner correctement. Remarque : le jeton d’authentification Microsoft Entra ID acquis dans le cadre d’un appel de login est valide pendant seulement 1 heure, après quoi il expire. Vous pouvez réexécuter la commande login pour obtenir un nouveau jeton. Nom d’utilisateur et mot de passe Microsoft Entra ID (fournis dans le cadre de l’exécution de la commande, et non pas lors de l’appel initial).
Get-OnPremisesDataGatewayClusters Récupère la liste des clusters de passerelles pour l’utilisateur connecté. Si vous le souhaitez, vous pouvez passer des paramètres de mise en forme de cette commande pour une meilleure lisibilité, par exemple Format-Table -AutoSize -Wrap.
Get-OnPremisesDataClusterGateways Récupère la liste des passerelles dans le cluster spécifié, ainsi que des informations supplémentaires pour chaque passerelle (état en ligne/hors connexion, nom de l’ordinateur, etc.). -ClusterObjectID xyz (où xyz est remplacé par une valeur réelle d’ID d’objet de cluster, qui peut être récupérée à l’aide de la commande Get-OnPremisesDataGatewayClusters).
Set-OnPremisesDataGateway Utilisez cette commande pour définir les valeurs des propriétés d’une passerelle donnée dans un cluster, y compris la possibilité d’activer ou de désactiver une instance de passerelle spécifique. -ClusterObjectID xyz (où xyz est remplacé par une valeur réelle d’ID d’objet de cluster, qui peut être récupérée à l’aide de la commande Get-OnPremisesDataGatewayClusters). -GatewayObjectID abc (où abc est remplacé par une valeur réelle d’ID d’objet de passerelle, qui peut être récupérée à l’aide de la commande Get-OnPremisesDataClusterGateways, en fonction d’ID d’objet de cluster).
Get-OnPremisesDataGatewayStatus Utilisez cette commande pour récupérer l’état d’une instance de passerelle donnée au sein d’un cluster. -ClusterObjectID xyz (où xyz est remplacé par une valeur réelle d’ID d’objet de cluster, qui peut être récupérée à l’aide de la commande Get-OnPremisesDataGatewayClusters). -GatewayObjectID abc (où abc est remplacé par une valeur réelle d’ID d’objet de passerelle, qui peut être récupérée à l’aide de la commande Get-OnPremisesDataClusterGateways, en fonction d’ID d’objet de cluster).
Remove-OnPremisesDataGateway Utilisez cette commande pour supprimer une instance de passerelle d’un cluster. Remarque : la passerelle principale du cluster ne peut pas être supprimée tant que toutes les autres passerelles du cluster n’ont pas été supprimées. -ClusterObjectID xyz (où xyz est remplacé par une valeur réelle d’ID d’objet de cluster, qui peut être récupérée à l’aide de la commande Get-OnPremisesDataGatewayClusters). -GatewayObjectID abc (où abc est remplacé par une valeur réelle d’ID d’objet de passerelle, qui peut être récupérée à l’aide de la commande Get-OnPremisesDataClusterGateways, en fonction d’ID d’objet de cluster).

Étapes suivantes