Annexe : utiliser le script de configuration des ports réservés au fonctionnement du système

Cette annexe explique comment utiliser le script de configuration des ports réservés au fonctionnement du système (AddRangeReservedSystemPorts.ps1).

Vous pouvez utiliser ce script :

  • Juste après l'installation de l'Agent TS, idéalement avant de redémarrer le serveur,
  • Plus tard pour ajuster les paramètres de l'Agent TS, par exemple en cas d'installation de nouvelles applications ou de problèmes de connexion.

Principe de fonctionnement du script

Ce script, fourni par Stormshield, analyse les ports susceptibles d'entrer en conflit avec l'Agent TS et les ajoute au paramètre ReservedSystemPorts de l'Agent TS pour les réserver au fonctionnement du système. Ainsi, ces ports ne pourront pas être attribués à un utilisateur.

Le script analyse les ports de plusieurs manières :

  • En analysant l'état du réseau de la machine (comme un netstat amélioré),
  • En analysant les événements de l'Agent TS dans l'Observateur d'événements afin d'y repérer d'éventuels conflits de port (ID de l'événement 32781). Cette analyse s'effectue par défaut sur un mois (le nombre de jours exact varie d'un mois à un autre).

Prérequis pour utiliser le script

  • Pouvoir exécuter Windows PowerShell en tant qu'administrateur.

  • Pouvoir lancer des scripts locaux sur la machine.

    Vous pouvez modifier cette politique d'exécution avec les commandes :

    Set-ExecutionPolicy unrestricted
    Set-ExecutionPolicy remotesigned

Télécharger le script

  1. Dans votre espace MyStormshield, rendez-vous dans Téléchargements > Téléchargements.
  2. Dans les catégories, sélectionnez Stormshield Network Security > TS Agent.
  3. Cliquez sur le script AddRangeReservedSystemPorts.ps1 pour le télécharger.
  4. Copiez le script sur chaque serveur RDS ou Citrix où un Agent TS est installé.

Utiliser le script

  1. Dans Windows PowerShell, exécutez la commande :

    .\AddRangeReservedSystemPorts.ps1

  2. Prenez connaissance du résultat du script :

    • Les ports affichés sont susceptibles d'entrer en conflit avec l'Agent TS,

    • Les ports Pre-configured sont issus de la configuration par défaut de l'Agent TS.

  3. Indiquez avec "yes" ou "no" si vous souhaitez que le script modifie le paramètre ReservedSystemPorts de l'Agent TS dans la base de registre en y ajoutant les ports trouvés.

  4. Indiquez avec "yes" ou "no" si vous souhaitez redémarrer immédiatement le serveur. Les nouveaux ports réservés au fonctionnement du système ne seront pris en compte qu'après le redémarrage du serveur. Si vous ne redémarrez pas immédiatement le serveur, pensez à le programmer afin de prendre en compte les modifications.

Options possibles

Vous pouvez utiliser le script avec des options :

.\AddRangeReservedSystemPorts.ps1 -Options

Option Description
-PauseAtExit

Force le script à attendre que l'utilisateur appuie sur une touche du clavier avant de se terminer, et cela dans tous les cas.

 

Cette option est utile pour voir le résultat du script lorsqu'il est appelé par un autre script ou un programme.

-Force

Modifie le paramètre ReservedSystemPorts de l'Agent TS dans la base de registre sans demander de confirmation.

-HistoryDepth <days>

Détermine une période d'analyse en jours des événements de l'Agent TS dans l'Observateur d'événements. Par défaut, l'analyse s'effectue sur un mois (le nombre de jours exact varie d'un mois à un autre).

 

Cette option n'est pas compatible avec l'option -FullLog.

-FullLog

Analyse l'historique complet disponible des événements de l'Agent TS dans l'Observateur d'événements.

 

Cette option n'est pas compatible avec l'option -HistoryDepth.

-AutoRestart

Redémarre automatiquement le serveur sans demander de confirmation, à condition que le script se soit exécuté correctement.

 

Cette option est utile pour prendre en compte immédiatement les nouveaux ports réservés au fonctionnement du système.

Cette option n'est pas compatible avec l'option -NoRestart .

-NoRestart

Détermine que le serveur ne doit pas être redémarré, ce qui évite l'affichage de la demande de confirmation de redémarrage lors de l'exécution du script.

 

Cette option n'est pas compatible avec l'option -AutoRestart.

-Verbose Affiche des messages supplémentaires lors de l'exécution du script. Cette option est utile lors d'une assistance technique, par exemple avec le support Stormshield.
-DryRun

Affiche uniquement le résultat de l'analyse du script. Aucune action n'est initiée avec cette option. Cette option est souvent utilisée avec l'option -Verbose.

 

Cette option est utile pour exécuter le script sans être administrateur.