Utiliser des variables

Les propriétés des firewalls indiquées dans la liste des firewalls ou dans les paramètres de chaque firewall (menu Supervision > Firewalls) constituent des variables qui peuvent être utilisées dans les scripts.

Vous pouvez utiliser encore plus de variables à l'aide d'un fichier CSV. Reportez-vous à la section Utiliser un fichier CSV.

Les variables sont sensibles à la casse.

Insérez les variables entourées du signe % dans les commandes CLI de votre script.

Ces variables prennent une valeur différente suivant le firewall sur lequel le script est exécuté :

  • FW_ADDRESS : champ Adresse IP du firewall connectée au serveur SMC,
  • FW_DESCRIPTION : champ Description du firewall,
  • FW_LOCATION : champ Lieu du firewall,
  • FW_MODEL : modèle du firewall,
  • FW_NAME : nom du firewall,
  • FW_SERIAL : numéro de série du firewall,
  • FW_VERSION : numéro de la version du firewall,
  • FW_ARCHITECTURE : architecture du processeur du firewall,
  • FW_SIZE : gamme du firewall,
  • FW_VM : firewall virtuel,
  • FW_UPD_SUFFIX : variable utilisée pour la mise à jour de firewall SNS, prenant la valeur SNS-%FW_ARCHITECTURE%-%FW_SIZE%.maj (par exemple SNS-amd64-M.maj). Pour plus d'informations, reportez-vous à la section Mettre à jour les firewalls en utilisant les scripts CLI SNS .
  • HA_PEER_SERIAL: numéro de série du firewall passif (sans Haute Disponibilité, la valeur sera vide),
  • HA_PEER_FIRMWARE: numéro de la version du firewall passif (sans Haute Disponibilité, la valeur sera vide),
  • CUSTOM_X : champs personnalisés

Les variables %CUSTOM_X% sont des variables personnalisables à votre convenance. Double-cliquez sur un firewall dans la liste du menu Supervision > Firewalls et ouvrez l'onglet Variables personnalisées. Pour plus d'informations, reportez-vous à la section Créer des variables personnalisées.

Ces variables ont la même valeur pour tous les firewalls et font référence à la date et heure du serveur :

  • NOW : date complète au format local (exemple : "%NOW%" => "20151222-104727"),
  • NOW_AS_DATE : date au format local (exemple : "%NOW_AS_DATE%" => "20151222"),
  • NOW_AS_TIME : heure au format local (exemple : "%NOW_AS_TIME%" => "104727").

Afin de réaliser des opérations sur un grand nombre de firewalls ou bien de réaliser une opération complexe sur un firewall, nous recommandons l'utilisation d'un fichier CSV.

Le fichier CSV n'est utilisable que depuis l'interface de ligne de commande. Les variables associées aux firewalls sont alors lues depuis ce fichier et le script est dupliqué autant de fois qu'il y a de lignes dans le fichier CSV pour un firewall donné.

Un exemple de fichier CSV "example-sns-cli-script.csv" est disponible sur le serveur, dans le dossier /opt/stormshield/examples/csv/.

Pour savoir comment utiliser le fichier CSV depuis l'interface de ligne de commande, reportez-vous à la section Exemple d'utilisation de script en ligne de commande avec un fichier CSV.