Interface en Ligne de Commande (CLI)

La CLI (Command-Line Interface ou Interface en Ligne de Commande) de Pandora FMS est utilisée en effectuant des appels en ligne de commande sur le fichier pandora_manage.

Cette méthode est particulièrement utile pour intégrer des applications tierces avec Pandora FMS via des tâches automatisées. Elle consiste fondamentalement en un appel avec les paramètres formatés pour effectuer une action telle que la création et la suppression d'un agent, d'un module ou d'un utilisateur, entre autres.

Syntaxe avec la barre oblique inversée \ comme connecteur de ligne :

pandora_manage \
    <pandora_server.conf path> \
    <option> \
    <option parameters> \
    [ optional parameters ]

• Tous les paramètres, obligatoires ou optionnels, peuvent être délimités par des guillemets simples. Cela est particulièrement utile lorsqu'un paramètre comporte un ou plusieurs espaces.
• Si un paramètre doit être omis, deux guillemets simples consécutifs peuvent être utilisés. Si le paramètre est strictement nécessaire, un message de type [ERROR] Error: sera affiché suivi de sa description. Cela est également utile pour indiquer des paramètres optionnels vides.
• Certains paramètres sont sensibles à la casse, d'autres non. Par exemple, lors de la création d'un agent, le nom du serveur PFMS doit être strictement identique, cependant, le nom du groupe principal auquel l'agent appartiendra peut être en majuscules et/ou minuscules et s'il y a une correspondance, le groupe sera assigné.
• Vous pouvez utiliser l'alias d'un agent, au lieu de son nom lui-même, au moyen du paramètre use_alias à la fin de la ligne de commande.

Aide générale :

pandora_manage --h | more

Pour obtenir de l'aide sur une option spécifique, entrez l'option sans paramètres :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_user

Les commandes sont regroupées dans les catégories suivantes :

• Agents.
• Modules
• Alertes
• Utilisateurs
• Événements
• Politiques
• NetFlow®
• Outils
• Graphiques
• Clusters
• Consoles visuelles

Paramètres obligatoires (syntaxe) :

• <nom de l'agent> Renvoie une erreur si le nom existe (voir <alias comme nom>).
• <système d'exploitation> Doit correspondre à un OS existant (insensible à la casse), sinon il sera enregistré sans aucun OS.
• <nom du groupe d'agents >
• <nom du serveur> Strictement sensible à la casse, sinon la valeur du champ sera laissée nulle sans afficher le moindre avertissement. Vous devez vérifier que l'agent a bien été assigné à un serveur.

Paramètres optionnels :

• <adresse IP ou URL>
• <description> Si vous omettez la description, Created by <server name> sera ajouté (que le serveur spécifié existe ou non).
• <intervalle> En secondes, valeur par défaut : 300 (voir point suivant).
• <alias comme nom> La valeur par défaut est 1 et avec cette valeur l'alias de l'agent sera le même que le nom de l'agent. Si vous souhaitez que le nom soit généré de manière aléatoire, vous devez utiliser 0.

Description :

Un agent sera créé avec le nom, le système d'exploitation, le groupe et le serveur spécifiés. Optionnellement, il peut lui être attribué une adresse (adresse IP ou nom), une description et un intervalle en secondes.

Exemple (voir l'appel et sa syntaxe) :

Un agent sera créé avec un nom aléatoire et l'alias My agent et avec la période recommandée de 300 secondes.

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_agent \
  'My agent' AIX Databases Central-Server \
  192.168.12.123 'Agent description' '300' 0

Paramètres obligatoires (syntaxe) :

• <agent_name>
• <field_to_modify>
• <new_value>

Paramètres optionnels :

• use_alias

Description : Un champ <field_to_modify> d'un agent existant sera mis à jour. Les champs disponibles sont les suivants :

• agent_name
• address Même si le jeton Unique IP est activé, vous ne recevrez aucun avertissement pour une adresse IP répétée (ISSUE 12992).
• description
• group_name
• interval
• os_name
• disabled (0 pour l'activer, 1 pour le désactiver, toute autre valeur utilisée aura des résultats imprévisibles, ISSUE 13096).
• parent_name Si l'agent parent est modifié et que le jeton Cascade protection modules est activé sur l'agent enfant, il devra être reconfiguré pour que l'effet cascade puisse être exécuté (ISSUE 13097). L'agent parent doit également avoir au moins un module enregistré.
• cascade_protection (0 pour le désactiver, 1 pour l'activer, toute autre valeur utilisée aura des résultats imprévisibles, ISSUE 13098).
• icon_path pour changer l'icône représentant l'agent dans les cartes GIS, les valeurs possibles sont : circle, cross, marker, square_marker, star et triangle.
• update_gis_data (0 pour le désactiver, 1 pour l'activer).
• custom_id

Exemples (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --update_agent \
  'My Agent' agent_name 'Agent 2'

Lors du changement de l'adresse IP d'un agent, gardez à l'esprit que cette commande permet de répéter les adresses IP.

pandora_manage /etc/pandora/pandora_server.conf \ 
  --update_agent \
  'My Agent' address 192.168.7.47

pandora_manage /etc/pandora/pandora_server.conf \ 
  --update_agent \
  'My Agent' description 'New note' \
  use_alias

Pour l'option disabled, vous devez utiliser uniquement 0 et 1 ; toute autre valeur produira des résultats de recherche et/ou de visualisation imprévisibles dans la Console Web.

pandora_manage /etc/pandora/pandora_server.conf \ 
  --update_agent \
    'My Agent' disabled 1 \
    use_alias

Pour l'option cascade_protection, vous devez utiliser uniquement 0 et 1 ; toute autre valeur produira des résultats de recherche et/ou de visualisation imprévisibles dans la Console Web.

pandora_manage /etc/pandora/pandora_server.conf \ 
  --update_agent \
    'My Agent' cascade_protection 1 \
    use_alias

pandora_manage /etc/pandora/pandora_server.conf \ 
  --update_agent \
    'My Agent' icon_path cross \
    use_alias

Paramètres obligatoires (syntaxe) :

• <id_agent> identifiant de l'agent.
• <type_de_champ> qui peut être 0 si c'est de type texte ou 1 si c'est une liste déroulante (combo ou combo box) composée de plusieurs options. Voir la section des réponses.
• <champ_a_changer> nom du champ personnalisé à mettre à jour.
• <nouvelle_valeur> la valeur du champ personnalisé à mettre à jour.

Description : met à jour les champs personnalisés d'un agent. Cette commande est incompatible avec les champs personnalisés de type lien et de type mot de passe (ISSUE 13532).

Les réponses dont elle est composée sont :

• ERROR :
• Si l'agent n'existe pas.
• Si le champ n'existe pas.
• Au cas où la nouvelle_valeur d'une liste déroulante ne correspondrait pas à celles préétablies.
• Si la mise à jour du champ a échoué.

• INFO :
• Mise à jour du champ X avec l'id d'agent Y.
• Mis à jour avec succès.

Exemples (voir l'appel et sa syntaxe) :

TYPE TEXTE :

pandora_manage /etc/pandora/pandora_server.conf \
 --agent_update_custom_fields \
 1 0 'Serial number' 'THX-1138'

TYPE LISTE : un champ personnalisé nommé Names doit avoir été configuré avec au moins un élément nommé John.

pandora_manage /etc/pandora/pandora_server.conf \
 --agent_update_custom_fields \
 1 1 'Names' 'John'

Paramètres obligatoires (syntaxe) :

• <nom_agent>

Paramètre optionnel :

• use_alias

Description :

L'agent sera supprimé en passant son nom ou son alias comme paramètre.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \
    --delete_agent 'pandora.internals' \
    use_alias

Paramètre obligatoire :

• <nom_du_groupe>

Description :

Désactive tous les agents d'un groupe. Les agents du groupe passés en paramètre seront désactivés lors de l'exécution de cette option.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --disable_group Firewalls

Paramètre obligatoire :

• <nom_groupe>

Description :

Les agents du groupe passé en paramètre seront activés lors de l'exécution de cette option. Si All est passé comme groupe, tous les agents de tous les groupes seront activés.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --enable_group FIREWALLS

Paramètre obligatoire :

• <nom_du_nouveau_groupe>

Paramètres optionnels :

• <nom_du_groupe_parent>
• <icone> options disponibles :

• applications
• application_osx
• application_osx_terminal
• bricks
• chart_organisation
• clock
• computer
• database
• database_gear
• docker
• drive_network
• email
• eye
• firewall
• heart
• house
• images
• lightning
• lock
• network
• plugin
• printer
• server_database
• transmit
• vmware
• without_group
• world

• <description>

Description :

Un nouveau groupe sera créé si le nom n'existe pas et, optionnellement, il peut lui être assigné un groupe “parent” ou supérieur, une icône pour l'identification graphique (le nom de l'icône, sans extension, utilisez uniquement les options listées ISSUE 9408) et une description. Le groupe parent par défaut est 'All' et l'icône par défaut est une chaîne de texte vide (sans icône, il ne l'utilisera pas).

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_group \
    'New group name' \
    Web computer 'New description.'

Paramètre obligatoire :

• <nom_du_groupe>

Description :

Supprime un groupe d'agents et ses agents. Le groupe spécial All ne peut pas être supprimé.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --delete_group 'Group name'

Paramètre obligatoire :

• <id_groupe>

Paramètres optionnels :

• <nom_du_groupe_a_modifier>
• <nom_du_groupe_parent>
• <icone> options disponibles :

• applications
• application_osx
• application_osx_terminal
• bricks
• chart_organisation
• clock
• computer
• database
• database_gear
• docker
• drive_network
• email
• eye
• firewall
• heart
• house
• images
• lightning
• lock
• network
• plugin
• printer
• server_database
• transmit
• vmware
• without_group
• world

• <description>

Description :

Un groupe est modifié au moyen de son identifiant numérique. Les paramètres qui peuvent être modifiés sont :

• Nom du groupe.
• Nom du groupe “parent” ou supérieur.
• Icône (uniquement le nom, sans l'extension de fichier, choisissez-en un dans la liste décrite).
• Description.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --update_group 2 \
    'Group name' 'Web' 'transmit' 'Description'

Paramètre obligatoire :

• <nom_de_l_arret_planifie>

Description :

Arrête un arrêt planifié. Si la déconnexion est déjà terminée, un message s'affichera. Messages de retour :

• [ERROR] Planned_downtime cannot be stopped (l'arrêt planifié ne peut pas être arrêté).
• [INFO] Planned_downtime is already stopped (l'arrêt planifié est déjà arrêté).
• [INFO] Stopping planned downtime (arrêt planifié en cours d'arrêt).

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --stop_downtime 'Downtine name'

Paramètre obligatoire :

• <nom_agent>

Paramètre optionnel :

Description : Obtenir l'état d'un agent spécifique via son nom ou son alias.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \
  --get_agent_status 'agent name' use_alias

Paramètre obligatoire :

• <nom_agent>

Paramètre optionnel :

Description : Obtenir le groupe d'un agent spécifique via son nom ou son alias. Ledit nom de groupe d'agents sera renvoyé avec l'encodage URL (Percent-encoding).

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \
  --get_agent_group 'agent name' use_alias

Paramètre obligatoire :

• <nom_agent>

Paramètre optionnel :

Description : Obtenir l'identifiant d'un agent spécifique via son nom ou son alias.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_agent_group_id 'pandora.internals'

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_agent_group_id 'pandorafms agent' use_alias

Paramètre obligatoire :

• <nom_agent>

Paramètre optionnel :

Description : Obtenir les modules (identifiants et noms, séparés par une virgule) d'un agent spécifique via son nom ou son alias.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_agent_modules 'agent name' use_alias

Paramètre obligatoire : Aucun.

Paramètres optionnels : permettent de filtrer la liste des agents dans un format sérialisé où l'ordre importe, utilisez deux guillemets simples pour omettre le(s) paramètre(s). Ils sont numérotés ici pour un meilleur contrôle et visualisation :

1. < nom_de_groupe >
2. < nom_du_systeme_d_exploitation >
3. <statut> Valeurs possibles : critical, warning, unknown, normal.
4. <nombre_maximum_de_modules> Seule une valeur numérique doit être utilisée (ISSUE 13968).
5. <mot_cle> Permet de filtrer par nom d'agent (ou alias d'agent si vous ajoutez use_agent_alias à la fin).
6. <nom_de_politique>
7. use_alias pour rechercher un agent par son alias au lieu de son nom.

Description : Obtenir tous les agents (sans paramètres) ou les agents selon un filtre.

Exemple (voir l'appel et sa syntaxe) :

• Obtenir tous les agents dans le groupe Network :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_agents 'Network' '' '' '' '' ''

• Obtenir tous les agents ayant Linux comme système d'exploitation :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_agents '' 'Linux' '' '' '' ''

• Obtenir tous les agents dont l'état est normal :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_agents '' '' 'normal' '' '' ''

• Obtenir tous les agents avec zéro module (sans aucun module) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_agents '' '' '' '0' '' ''

• Obtenir tous les agents avec zéro module dans le groupe Servers :

pandora_manage /etc/pandora/pandora_server.conf \ 
--get_agents 'Servers' '' '' '0' '' ''

• Obtenir tous les agents contenant le mot test dans leur alias :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_agents '' '' '' '' 'test' '' use_alias

• Obtenir tous les agents qui sont dans la politique de surveillance nommée Basic Linux Monitoring :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_agents '' '' '' '' '' 'Basic Linux Monitoring'

Paramètre obligatoire : <alias_agent>

Paramètre optionnel : strict

Description : Liste les identifiants et alias des agents correspondant à l'alias spécifié, insensible à la casse. L'utilisation du paramètre optionnel strict limite la recherche à une correspondance exacte de toutes les lettres.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_agents_id_name_by_alias 'name' strict

Paramètre obligatoire : <nom_agent>

Paramètre optionnel : use_alias

Description : Le fichier de configuration d'un agent sera supprimé. Lors de l'accès via la Console Web dans l'option Remote configuration, un message d'erreur sera reçu : Error: the conf file of agent is not readable..

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --delete_conf_file 'agent alias' use_alias

Paramètre obligatoire : <nom_agent>

Paramètre optionnel : use_alias

Description : Le fichier de configuration d'un agent sera nettoyé (tout le contenu du fichier sera supprimé - y compris les valeurs de connexion et les paramètres de configuration ISSUE 13663).

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --clean_conf_file 'agent alias' use_alias

Paramètres : Aucun.

Description :

1. Les fichiers de configuration mal configurés seront listés en cherchant dans les jetons principaux :

• server_ip
• server_path
• temporal
• logfile

1. Au cas où il y aurait des fichiers corrompus et qui ne peuvent pas être ouverts :

[WARN] Can't open file <path_file>.

1. Au cas où le fichier n'est pas trouvé dans le chemin d'accès :

[WARN] File not exist <path_file>.

1. Au cas où les fichiers de configuration seraient corrects (selon les jetons du premier point) :

[INFO] No bad files found

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_bad_conf_files

Paramètres obligatoires :

• <id_de_l_agent_a_migrer>
• <nom_du_noeud_source>
• <nom_du_noeud_destination>

Paramètre optionnel :

• <seulement_bdd> par défaut 0, migrera les données de la base de données et l'historique, s'il est à 1 il migrera seulement la base de données sans les données historiques.

Description : Un agent est ajouté à la file d'attente de migration pour être déplacé d'un nœud à un autre nœud.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --migration_agent_queue 1 node_1 node_2 0

Paramètre obligatoire : <id_agent_a_verifier>

Description : Il renverra vrai ou faux selon que l'agent introduit existe dans la table de migration des agents.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --migration_agent 1

Paramètres obligatoires (syntaxe) :

• <nom_de_l_arret_planifie>
• <description>
• <date_de>
• <date_a>
• <id_groupe>
• <lundi (0|1) >
• <mardi (0|1) >
• <mercredi (0|1) >
• <jeudi (0|1) >
• <vendredi (0|1) >
• <samedi (0|1) >
• <dimanche (0|1) >
• <heure_de_dans_periode HH:MM:SS>
• <heure_a_dans_periode HH:MM:SS>
• <numero_jour_de_dans_periode>
• <numero_jour_a_dans_periode>
• <type_d_arret_planifie (quiet|disable_agents|disable_agents_alerts) >
• <type_d_execution periodically > (l'option once est désactivée).
• <type_de_periodicite (weekly|monthly) >
• <id_utilisateur>

Description : Un arrêt planifié hebdomadaire ou mensuel sera créé avec les données envoyées. Le format de date doit être MM/DD/YYYY (Mois/Jour/Année) pour que cet appel fonctionne correctement.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_downtime \
  Testing Testing 05/07/2024 06/07/2024 \
  0 1 1 1 1 1 1 1 17:07:00 18:08:00 1 31 \
  quiet periodically weekly admin

Paramètres obligatoires (syntaxe) :

• <id_arret_planifie>
• <id_agent1,id_agent2,id_agent3,…,id_agentN>
• <nom_module1,nom_module2,nom_module3,…,nom_moduleN>

Description :

Des enregistrements seront ajoutés à un arrêt planifié avec les données envoyées. Écrivez la liste des identifiants d'agents et la liste des noms de modules sans laisser d'espaces entre les virgules séparant les composants des deux listes. Si un nom de module contient des espaces, placez ce nom de module entre deux guillemets simples. Si deux agents ou plus sont passés, il est supposé par défaut que des modules communs doivent être ajoutés, sinon un message d'avertissement s'affichera.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --add_item_downtime \
  1 1 Memory_Used,'CPU Load'

Paramètres obligatoires :

• <nom_a_rechercher>

Paramètres optionnels (Issue 9414) :

• <id_groupe>
• <type_d_arret_planifie> quiet, disable_agents, disable_agents_alerts.
• <type_d_execution> once, periodically.
• <type_de_periodicite> weekly, monthly.

Description :

Tous les arrêts de service planifiés correspondant aux données envoyées seront listés.

Exemple (voir l'appel et sa syntaxe) :

Pour obtenir la liste complète des arrêts planifiés :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_all_planned_downtimes ''

Pour lister un arrêt planifié très spécifique :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_all_planned_downtimes \ 
  "Stop 1" "8" "disable_agents" "periodically" "monthly"

Paramètres obligatoires :

• <nom_a_rechercher>

Paramètres optionnels (Issue 14343) :

• <id_groupe>
• <type_d_arret_planifie> quiet, disable_agents, disable_agents_alerts.
• <type_d_execution> once, periodically.
• <type_de_periodicite> weekly, monthly

Description :

Tous les éléments correspondant au nom de l'arrêt de service planifié demandé seront listés.

Exemple (voir l'appel et sa syntaxe) :

Pour obtenir tous les éléments de tous les arrêts planifiés :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_planned_downtimes_items ''

Pour obtenir les éléments des arrêts planifiés contenant le mot new en majuscules et/ou minuscules :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_planned_downtimes_items 'new'

Pour obtenir les éléments des arrêts planifiés hebdomadaires :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_planned_downtimes_items '' '' '' '' 'weekly'

Paramètres obligatoires (syntaxe) :

• <nom_arret_planifie>

Description :

Supprime un arrêt planifié au moyen de son nom correspondant. Il peut répondre avec l'un de ces messages :

• This planned downtime is deleted.
• Problems with this planned downtime.
• The scheduled downtime is still being executed.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --set_planned_downtimes_deleted \
  'Name Scheduled Downtime'

Paramètres obligatoires :

• <id_agent>
• Pour le Command Center (Métaconsole) l'identifiant du nœud, pour les nœuds n'importe quelle valeur est placée car elle est indifférente.

Paramètres optionnels :

• <valeur> Par défaut 1 pour activer l'agent, 0 pour le désactiver.

Description : Désactive un agent et aussi, s'il a une configuration à distance, le met en mode standby.

Exemple (voir l'appel et sa syntaxe) :

Pour activer un agent depuis le nœud :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --set_disabled_and_standby 2 0 1

Pour désactiver un agent depuis le nœud :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --set_disabled_and_standby 2 0 0

Pour activer un agent depuis le Command Center (Métaconsole) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --set_disabled_and_standby 2 1 1

Pour désactiver un agent depuis le Command Center (Métaconsole) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --set_disabled_and_standby 2 1 0

Paramètres obligatoires (syntaxe) :

<identifiant_numerique_agent>

Description : Synchronise les comptes de modules et d'alertes d'un agent donné. Au cas où vous voudriez synchroniser avec tous les agents, le premier paramètre doit être All.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --reset_agent_counts "All"

Paramètres obligatoires (syntaxe) :

• <identifiant_numerique_agent>
• <latitude>
• <longitude>
• <altitude>

Paramètres optionnels :

• Aucun.

Description : Met à jour les données GIS d'un agent. Cette fonctionnalité doit être activée dans la configuration générale de PFMS.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --insert_gis_data 1 2 3 4

Paramètres obligatoires (syntaxe) :

• <identifiant_numerique_agent>

Paramètres optionnels :

• Aucun.

Description : Obtient les données GIS d'un agent. Cette fonctionnalité doit être activée dans la configuration générale de PFMS.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_gis_agent 1

Paramètres obligatoires :

• <identifiant_numerique_agent>
• <identifiant_numerique_systeme_exploitation>
• <version_systeme_exploitation>

Paramètres optionnels :

• Aucun.

Description : Permet d'ajouter ou de changer le système d'exploitation (et l'obsolescence) d'un agent.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --agent_set_os 7 1 'Ubuntu 16.04'

Paramètre obligatoire : <nom_agent>

Paramètre optionnel : use_alias pour rechercher par alias d'agent.

Description : Cherche un agent dans les nœuds d'un Command Center (Métaconsole) et renvoie l'identifiant du nœud.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --locate_agent NAS use_alias

Paramètres obligatoires :

1. <nom_module>
2. <type_module>
3. <nom_agent>
4. <description>
5. <groupe_module>
6. <minimum>
7. <maximum>

Bien que les champs 4 à 7 soient obligatoires, vous pouvez omettre ces paramètres en utilisant des guillemets "". Dans le cas de l'établissement des valeurs minimale et maximale acceptées par le module, toute valeur en dehors de cette plage sera écartée.

Paramètres optionnels :

1. <post_process>
2. <intervalle>
3. <minimum_avertissement>
4. <maximum_avertissement>
5. <minimum_critique>
6. <maximum_critique>
7. <donnees_historiques>
8. <fichier_de_definition>
9. <chaine_avertissement>
10. <chaine_critique>
11. <activer_evenements_inconnus>
12. <seuil_flip-flop>
13. <chaque_flip-flop>
14. <seuil_flip-flop_normal>
15. <seuil_flip-flop_avertissement>
16. <seuil_flip-flop_critique>
17. <delai_flip-flop>
18. <inverse_avertissement>
19. <inverse_critique>
20. <instructions_critiques>
21. <instructions_avertissement>
22. <instructions_etat_inconnu>
23. use_agent_alias : Pour la recherche de l'agent, il utilise l'alias de l'agent au lieu du nom de l'agent.
24. ignore_unknown : Écarte le calcul de l'état inconnu, de sorte que le module ne passera jamais à cet état et conservera toujours le dernier état connu.
25. <nombre_d_intervalles_en_avertissement> Permet la mise à l'échelle de l'état en spécifiant le nombre maximum d'intervalles consécutifs pendant lesquels le module reste en état d'avertissement. En dépassant cette valeur, le module passera en état critique.

Description : Un module de type data sera créé dans un agent avec le nom du module, le type de module et le nom de l'agent (voir l'option use_agent_alias) où il sera créé. Optionnellement, il pourra lui être attribué une description, le groupe du module, etc.

Les valeurs par défaut sont 0 pour les minimums et maximums, donnees_historiques, et post_process ; 300 pour l'intervalle.

Exemple (voir l'appel et sa syntaxe) :

Exemple basique :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_data_module "My new module" "generic_data" \ 
  "pandora.internals" "My description" "Miscellaneous" "0" "100"

Exemple simple pour la mise à l'échelle de l'état :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_data_module data_module_test generic_data \ 
  3f9c41953a072afa229aa0a7fe3a6203a1ecf86b40b8a13d8a7d9916f0210bb1 \ 
  "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" \ 
  "" "" "" "" "" "" 2001

Exemple complexe, le fichier de définition du module contiendra quelque chose de ce style :

module_begin
module_name My module
module_type generic_data
module_exec cat /proc/meminfo  | grep MemFree | awk '{ print $2 }'
module_end

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_data_module 'My module' generic_data ' \ 
  My agent' 'Module description' 'General' 1 3 0 300 0 0 0 0 1 \ 
  /home/user/definition_file 'warning text' 'critical text'

Paramètres obligatoires :

1. <nom_module>
2. <type_module> web_data, web_proc, web_content_data, web_content_string.
3. <nom_agent>
4. <description>

Dans <type_module> les valeurs possibles sont :

Paramètres optionnels :

1. <groupe_module>
2. <minimum>
3. <maximum>
4. <post_process>
5. <intervalle>
6. <minimum_avertissement>
7. <maximum_avertissement>
8. <minimum_critique>
9. <maximum_critique>
10. <donnees_historiques>
11. <tentatives>
12. <requetes>
13. <identifiant_navigateur_agent>
14. <serveur_authentification>
15. <domaine_autorite>
16. <fichier_de_definition>
17. <url_proxy>
18. <login_autorisation_proxy_auth>
19. <mot_de_passe_autorisation_proxy_auth>
20. <chaine_avertissement>
21. <chaine_critique>
22. <activer_evenements_inconnus>
23. <seuil_flip-flop>
24. <chaque_flip-flop>
25. <seuil_flip-flop_normal>
26. <seuil_flip-flop_avertissement>
27. <seuil_flip-flop_critique>
28. <delai_flip-flop>
29. <inverse_avertissement>
30. <inverse_critique>
31. <instructions_critiques>
32. <instructions_avertissement>
33. <instructions_etat_inconnu>
34. use_agent_alias : Pour la recherche de l'agent, il utilise l'alias de l'agent au lieu du nom de l'agent.
35. ignore_unknown : Écarte le calcul de l'état inconnu, de sorte que le module ne passera jamais à cet état et conservera toujours le dernier état connu.
36. <nombre_d_intervalles_en_avertissement> Permet la mise à l'échelle de l'état en spécifiant le nombre maximum d'intervalles consécutifs pendant lesquels le module reste en état d'avertissement. En dépassant cette valeur, le module passera en état critique.

Description : Un module de type web sera créé dans un agent avec le nom du module, le type de module et le nom de l'agent (voir le paramètre use_agent_alias) où il sera créé. Optionnellement, il pourra lui être attribué une description, le groupe du module, des valeurs minimale et maximale, un fichier de définition du module, parmi d'autres paramètres. Dans le cas de l'établissement des valeurs minimale et maximale acceptées par le module, toute valeur en dehors de cette plage sera écartée.

Exemple (voir l'appel et sa syntaxe) :

Exemple basique :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_web_module "My new web_content_string" \ 
  "web_content_string" "pandora.internals" \ 
  "My description" "Miscellaneous" "0" "100"

Exemple simple pour la mise à l'échelle de l'état :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_web_module web_module_test web_data \ 
  3f9c41953a072afa229aa0a7fe3a6203a1ecf86b40b8a13d8a7d9916f0210bb1 \ 
  "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" \ 
  "" "" "" "" "" "" "" "" "" "" "" "" "" "" 2001

Exemple complexe, le fichier de définition du module contiendra quelque chose de ce style :

task_begin
get http://pandorafms.com
task_end

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_web_module 'module_name' web_data 'pandorafms' \ 
  'Module description' 'General' 0 100 0 300 0 0 0 0 1 0 1 \ 
  'Pandora FMS' auto public /home/user/file_definition \ 
  'http://proxy.url' 'proxy_login' 'proxy_password' \ 
  1 10 10 10 10 10 10 10 10 1 1 \ 
  'critical_instructions' 'warning_instructions' 'unknown_instructions'

Paramètres obligatoires :

1. <nom_module>
2. <type_module> accepte les valeurs suivantes : remote_icmp_proc, remote_icmp, remote_tcp, remote_tcp_proc, remote_tcp_string, remote_tcp_inc.
3. <nom_agent>
4. <adresse_module>
5. <port_module> uniquement pour TCP : valeur numérique entre 1 et 65535.
6. <description>
7. <groupe_module>
8. <min>
9. <max>
10. <post_process>
11. <intervalle>
12. <warning_min>
13. <warning_max>

Paramètres optionnels :

1. <critical_min>
2. <critical_max>
3. <history_data>
4. <ff_threshold>
5. <warning_str>
6. <critical_str>
7. <enable_unknown_events>
8. <each_ff>
9. <ff_threshold_normal>
10. <ff_treshold_warning>
11. <ff_threshold_critical>
12. <timeout>
13. <retries>
14. <critical_instructions>
15. <warning_instructions>
16. <unknown_instructions>
17. <warning_inverse>
18. <critical_inverse>
19. use_agent_alias pour rechercher l'agent par son alias au lieu de son nom.
20. ignore_unknown Écarte le calcul de l'état inconnu, de sorte que le module ne passera jamais à cet état et conservera toujours le dernier état connu.
21. <number_of_intervals_in_warning> Permet la mise à l'échelle de l'état en spécifiant le nombre maximum d'intervalles consécutifs pendant lesquels le module reste en état d'avertissement. En dépassant cette valeur, le module passera en état critique.

Description : Un module réseau sera créé dans un agent avec le nom du module, le type de module, le nom de l'agent où il sera créé et l'adresse du module spécifiés. Optionnellement, il pourra lui être attribué un numéro de port, une description, des valeurs minimale et maximale et d'autres valeurs optionnelles.

Les valeurs par défaut sont 0 pour les minimums et maximums, history_data et post_process, et 300 secondes pour l'intervalle.

Exemple (voir l'appel et sa syntaxe) :

Exemple basique :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_network_module \ 
  "My Network Module" "remote_icmp_proc" \ 
  "pandora.internals" "" "22" "My description" \ 
  "Enviromental" "" "" "" "" "" ""

Exemple simple pour la mise à l'échelle de l'état :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_network_module net_module_test remote_tcp \ 
  3f9c41953a072afa229aa0a7fe3a6203a1ecf86b40b8a13d8a7d9916f0210bb1 \ 
  127.0.0.1 "1" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" \ 
  "" "" "" "" "" "" "" "" "" "" "" 2001

Autre exemple :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_network_module 'My module' remote_tcp 'My agent' \ 
  192.168.12.123 8080 'Module description' 'General' \ 
  1 3 0 300 0 0 0 0 1

Paramètres obligatoires :

1. <network_component_name>
2. < network_component_group >
3. <network_component_type> Uniquement parmi les valeurs numériques suivantes (l'utilisation de toute autre valeur peut produire des résultats inattendus) :

• 6 Remote ICMP network agent, boolean data.
• 7 Remote ICMP network agent (latency).
• 8 Remote TCP network agent, numeric data.
• 9 Remote TCP network agent, boolean data.
• 10 Remote TCP network agent, alphanumeric data.
• 11 Remote TCP network agent, incremental data.
• 15 Remote SNMP network agent, numeric data.
• 16 Remote SNMP network agent, incremental data.
• 17 Remote SNMP network agent, alphanumeric data.
• 18 Remote SNMP network agent, boolean data.

Paramètres optionnels :

• <description>
• <module_interval> En secondes.
• <max_value> Toute valeur au-dessus de ce nombre est écartée.
• <min_value>
• <snmp_community>
• < id_module_group >
• <max_timeout> Champ non modifiable par la Console Web.
• <history_data> Cochez cette option si vous avez besoin de sauvegarder les valeurs à long terme dans la base de données historique. Actif : 1, inactif : 0 (l'utilisation de toute autre valeur peut produire des résultats inattendus).
• <min_warning>
• <max_warning> Doit être supérieur à <min_warning>.
• <str_warning> Utilisé si le type de composant est alphanumeric data.
• <min_critical>
• <max_critical> Doit être supérieur à <min_critical>.
• <str_critical> Utilisé si le type de composant est alphanumeric data.
• <min_ff_event>
• <post_process>
• <disabled_types_event> Format JSON.
• <each_ff>
• <min_ff_event_normal>
• <min_ff_event_warning>
• <min_ff_event_critical>

Description : Un composant réseau sera créé. Optionnellement, il pourra lui être attribué un port, une description, des valeurs minimale et maximale, une valeur de post-traitement, un intervalle en secondes, des valeurs d'avertissement minimale et maximale, des valeurs critiques minimale et maximale, et une valeur de données historiques.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
 --create_network_component "example_name" 2 7

Paramètres obligatoires :

1. <module_name>
2. <module_type> les options suivantes sont valides : remote_snmp, remote_snmp_inc, remote_snmp_proc.
3. <agent_name>
4. <module_address>
5. <module_port> valeur numérique entre 1 et 65535.
6. <version>
7. <community>
8. <oid>
9. <description>
10. <module_group>
11. <min>
12. <max>
13. <post_process>
14. <interval>

Paramètres optionnels :

1. <warning_min>
2. <warning_max>
3. <critical_min>
4. <critical_max>
5. <history_data>
6. <snmp3_priv_method>
7. <snmp3_priv_pass>
8. <snmp3_sec_level>
9. <snmp3_auth_method>
10. <snmp3_auth_user>
11. <snmp3_auth_pass>
12. <ff_threshold>
13. <warning_str>
14. <critical_str>
15. <unknown_events>
16. <each_ff>
17. <ff_threshold_normal>
18. <ff_threshold_warning>
19. <ff_threshold_critical>
20. <timeout>
21. <retries>
22. use_alias pour rechercher l'agent par son alias au lieu de son nom.
23. ignore_unknown Écarte le calcul de l'état inconnu, de sorte que le module ne passera jamais à cet état et conservera toujours le dernier état connu.
24. <critical_instructions>
25. <warning_instructions>
26. <unknown_instructions>
27. <warning_inverse>
28. <critical_inverse>
29. <number_of_intervals_in_warning> Permet la mise à l'échelle de l'état en spécifiant le nombre maximum d'intervalles consécutifs pendant lesquels le module reste en état d'avertissement. En dépassant cette valeur, le module passera en état critique.

Description : Un module de type SNMP sera créé dans un agent avec le nom du module (non nul), le type de module, le nom de l'agent où il sera créé, l'adresse du module, le port associé, la version SNMP, le nom de communauté, un OID, une description, le groupe du module, des valeurs minimale et maximale, une valeur de post-traitement, un intervalle de vérification (en secondes), ainsi que d'autres valeurs optionnelles.

Les valeurs par défaut sont 0 pour les minimums et maximums, history_data et post_process, et 300 secondes pour l'intervalle.

Exemple (voir l'appel et sa syntaxe) :

Exemple basique :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_snmp_module "My Module SNMP" "remote_snmp_inc" \ 
  "pandora.internals" "" "777" "" "" "" "My Description" \ 
  "Performance" "" "" "" ""

Exemple simple pour la mise à l'échelle de l'état :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_snmp_module snmp_module_test remote_snmp_inc \ 
  3f9c41953a072afa229aa0a7fe3a6203a1ecf86b40b8a13d8a7d9916f0210bb1 \ 
  127.0.0.1 "1" "3" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" \ 
  "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" 2001

Autre exemple :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_snmp_module 'My module' remote_snmp_inc \ 
  'My agent' 192.168.12.123 8080 1 my_comunnity my_oid \
  'Module description'

Paramètres requis :

• <module_name>
• <module_type>
• <agent_name>
• <module_address>
• <module_port> valeur numérique entre 1 et 65535.
• <plugin_name> l'un de ceux enregistrés (menu Management → Servers → Plugins).
• <user>
• <password>
• <params>
• <description>
• <module_group>

Paramètres optionnels :

• <min>
• <max>
• <post_process>
• <interval>
• <warning_min>
• <warning_max>
• <critical_min>
• <critical_max>
• <history_data>
• <ff_threshold>
• <warning_string>
• <critical_string>
• <enable_unknown_events>
• <each_ff>
• <ff_threshold_normal>
• <ff_threshold_warning>
• <ff_threshold_critical>
• <timeout>
• <critical_instructions>
• <warning_instructions>
• <unknown_instructions>
• <warning_inverse>
• <critical_inverse>
• use_agent_alias pour rechercher l'agent par son alias au lieu de son nom.
• ignore_unknown Écarte le calcul de l'état inconnu, de sorte que le module ne passera jamais à cet état et conservera toujours le dernier état connu.
• <number_of_intervals_in_warning> Permet la mise à l'échelle de l'état en spécifiant le nombre maximum d'intervalles consécutifs pendant lesquels le module reste en état d'avertissement. En dépassant cette valeur, le module passera en état critique.

Description : Un module de type plugin sera créé dans un agent avec le nom du module, le type de module, le nom de l'agent où il sera créé, l'adresse du module, le port associé, le nom de plugin correspondant, une description, le groupe du module, et des valeurs minimale et maximale, parmi d'autres valeurs optionnelles.

Les valeurs par défaut sont 0 pour les minimums et maximums, history_data, et post_process, et 300 pour l'intervalle.

Exemple (voir l'appel et sa syntaxe) :

Exemple basique :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_plugin_module \ 
  "My plugin module" "generic_data" "pandora.internals" "" "8080" \ 
  "DNS Plugin" "" "" "" "" "" "" "" "" "" "" ""

Exemple simple pour la mise à l'échelle de l'état :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_plugin_module \
  plugin_module_test generic_data \ 
  3f9c41953a072afa229aa0a7fe3a6203a1ecf86b40b8a13d8a7d9916f0210bb1 127.0.0.1 \
  "1" "DNS Plugin" "admin" "pandora" "100" "" "" "" "" "" "" "" "" "" "" "" \ 
  "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" 2001

Autre exemple :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_plugin_module \ 
  'My module' generic_data 'My agent' 192.168.12.123 8080 myplugin \ 
  myuser mypass 'param1 param2 param3' 'Module description' \ 
  'General' 1 3 0 300 0 0 0 0 1

Exemple avancé :

Si vous avez besoin de définir un timeout 30, vous devez passer explicitement chacun des paramètres optionnels avec "" pour que la position indiquée (dans ce cas le timeout) soit correcte :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_plugin_module \ 
  MyModule generic_data MyAgent 127.0.0.1 5667 \ 
  MyPlugin "" "" "" "" MyGroup "" "" "" "" "" "" \
  "" "" "" "" "" "" "" "" "" "" "" "" 30

Paramètres optionnels :

• <nom_groupe_module>

Description : Affiche les groupes de modules disponibles. Nous pouvons filtrer en ajoutant le nom du groupe ou une partie de celui-ci.

Réponse : Format CSV avec en-têtes.

• id_module_group
• group_name

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_module_group "general"

Paramètre obligatoire :

• <nom_du_groupe>

Description : Un groupe de modules sera créé avec le nom spécifié.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_module_group "My module group"

Paramètre obligatoire : <nom_serveur_1|nom_serveur_2| … |nom_serveur_n>

Paramètre optionnel : <type_retour> JSON et CSV, par défaut au format CSV.

Description : Les groupes de modules du Command Center seront synchronisés avec les nœuds spécifiés dans le premier paramètre, séparés par |.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --module_group_synch \
"server_name1|server_name2|server_name3" "json"

Paramètres :

• <nom_module>
• <type_synthetique> arithmetic ou average.
• <nom_agent>
• <opts>
• use_alias

Description : Un module synthétique sera créé dans l'agent et avec le nom de module indiqué. Le type de module peut être arithmetic (arithmétique) ou average (moyenne). Les opérateurs peuvent être : +-*/x.

Exemples (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_synthetic example_module arithmetic example_agent <opts>

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_synthetic example_module average example_agent <opts>

Paramètres possibles à utiliser dans <opts> :

• <opts> = <agent_source1>,<operande>,<module_source1> <agent_source2>,<operande>,<module_source2>
• <opts> = <agent_source1>,<operande>,<module_source1> <operande>,<valeur_fixe>

Paramètres obligatoires :

• <nom_module>
• <nom_agent>

Paramètres optionnels :

• use_alias

Description : Un module d'un agent sera supprimé en passant le nom des deux comme paramètres (ou avec l'alias de l'agent en utilisant use_alias). Au cas où ce module serait sur un agent local, il sera également supprimé du fichier de configuration. À partir de la version 771, les descendants du module supprimé sont supprimés de manière récursive.

Exemples (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --delete_module 'My module' 'My agent'

Paramètres obligatoires :

• <nom_serveur_pfms>
• <nom_agent>
• <nom_module>
• < type_module >
• <nouvelle_donnee>

Paramètres optionnels :

• <date_heure> au format YYY-MM-DD HH:mm.
• use_alias si cette option est utilisée, une date et une heure valides doivent être spécifiées.

Description : Insère une valeur dans un module.

Réponses :

• [ERROR] No module found with this type. : Le type de module diffère de celui enregistré pour le module demandé.
• [INFO] Inserting data to module : Réponse réussie.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --data_module "pandorafms" "pandorafms agent" \ 
  "CPU Load" generic_data 77 "2024-07-19 13:38" use_alias

Paramètres obligatoires :

• <nom_agent>
• <nom_module>
• <intervalle> valeur en secondes.

Paramètres optionnels :

• <separateur> entre guillemets, si nécessaire ; par défaut “|”.
• use_alias si cette option est utilisée, un séparateur doit être spécifié.

Description : Les données du module pour les X dernières secondes (intervalle demandé) seront renvoyées en utilisant le séparateur entre le timestamp et la valeur.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_module_data "pandorafms agent" "CPU Load" 7200 "," use_alias

Paramètres obligatoires :

• <identifiant_numerique_agent> si l'identifiant n'est pas enregistré, cela renverra un message d'erreur indiquant que le module demandé n'existe pas.
• <nom_module>

Description : L'identifiant numérique d'un module spécifique d'un agent sera renvoyé.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_module_id 2 "CPU Load" && echo ""

Paramètres obligatoires :

• < identifiant_numerique_module >
• <valeur_identifiant_personnalise>

Description : Insère la valeur du champ Custom ID d'un module spécifique. S'il est laissé nul “”, son contenu sera supprimé.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --set_module_custom_id 21 "My id value" && echo ""

Paramètre obligatoire :

• <identifiant_module> (voir get_module_id).

Description : La valeur du champ Custom ID (y compris les entités et sans saut de ligne) d'un module spécifique d'un agent sera renvoyée.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_module_custom_id 4

Description : Toutes les données associées à l'objet spécifié (module, agent, ou groupe d'agents) seront supprimées de l'historique des données.

Paramètre pour supprimer les données de module : -m <nom_module> <nom_agent>

Paramètre pour supprimer les données d'agent : -a <nom_agent> (optionnel use_alias)

Paramètre pour supprimer les données de groupe : -g <nom_groupe_agents>

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --delete_data -a "agent_alias" use_alias

Paramètres obligatoires :

• <nom_module>
• <nom_agent>
• <champ_a_mettre_a_jour>
• <nouvelle_valeur>

Paramètre optionnel :

• use_agent_alias

Description : Un champ donné d'un module existant sera mis à jour. Le type de module sera détecté pour permettre la mise à jour des champs spécifiques à chaque type.

Les champs possibles à modifier sont :

Communs à tout module :

• module_name
• description
• module_group
• min
• max
• post_process
• history_data (seul 1 ou 0 doit être utilisé)
• interval
• warning_min
• warning_max (doit être supérieur à warning_min)
• critical_min
• critical_max (doit être supérieur à critical_min)
• warning_str (à ne pas confondre avec warning_instructions)
• critical_str (à ne pas confondre avec critical_instructions)
• ff_threshold
• each_ff (valeur numérique entière utilisée dans les plugins)
• ff_threshold_normal
• ff_threshold_warning
• ff_threshold_critical
• critical_instructions
• warning_instructions
• unknown_instructions

Pour les modules de données : ff_timeout.

Pour les modules réseau : module_address, module_port.

Pour les modules de type SNMP :

• module_address
• module_port
• version_community
• oid
• snmp3_priv_method
• snmp3_priv_pass
• snmp3_sec_level
• snmp3_auth_method
• snmp3_auth_user
• snmp3_priv_pass

Pour les modules de type plugin :

• module_address
• module_port
• plugin_name
• user
• password.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --update_module "CPU load" "pandorafms agent" "description" "new description"

Avec le paramètre agent_name, un module peut être déplacé d'un agent à un autre agent identifié uniquement par son nom :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --update_module "last_events_24h" "pandora.internals" \ 
  "agent_name" \ 
  4be5603649674274b9b7ba841118a876c2365f70667eb0da37badd498b6a4aa8

Paramètres obligatoires :

• <nom_agent>
• <nom_module>
• <nom_etiquette>

Description : Ajoute une étiquette ou tag (menu Management → Profiles → Module tags) au module spécifié.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --add_tag_to_module "pandora.internals" "console_log_size" "Dmz"

Paramètre obligatoire :

• <nom_module>

Description : Obtient l'identifiant de l'agent, son nom, et les données actuelles (séparés par des virgules) de tous les modules avec le nom exact demandé (sans tenir compte des majuscules et/ou minuscules).

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_agents_module_current_data "cpu load"

Paramètres obligatoires :

• <nom_agent>
• <nom_composant_distant>

Paramètres optionnels :

• use_alias

Description : Crée un module dans un agent donné à partir d'un composant distant. Vous devez fournir le nom de l'agent ou son alias avec l'option use_alias.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_network_module_from_component \ 
  "pandorafms agent" "IIS PutRequestsPersec" use_alias

Paramètres obligatoires :

• <nom_agent>
• <nom_composant_local>

Paramètres optionnels :

• use_alias

Description : Crée un module dans un agent donné à partir d'un composant local. Vous devez fournir le nom de l'agent ou son alias avec l'option use_alias.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_data_module_from_local_component \ 
  "pandorafms agent" "Event 1000" use_alias

Paramètres :

• <component_name>
• <data>
• <description>
• <id_os>
• <os_version>
• <id_network_component_group>
• <type>
• <min>
• <max>
• <module_interval>
• <id_module_group>
• <history_data>
• <min_warning>
• <max_warning>
• <str_warning>
• <min_critical>
• <max_critical>
• <str_critical>
• <min_ff_event>
• <post_process>
• <unit>
• <wizard_level>
• <critical_instructions>
• <warning_instructions>
• <unknown_instructions>
• <critical_inverse>
• <warning_inverse>
• <id_category>
• <disabled_types_event>
• <tags>
• <min_ff_event_normal>
• <min_ff_event_warning>
• <min_ff_event_critical>
• <each_ff>
• <ff_timeout>

Description : Pour créer un nouveau composant local.

Exemple (voir l'appel et sa syntaxe), la variable $PARAM est ajoutée pour plus de clarté :

PARAM=''
PARAM=$PARAM'module_begin\nmodule_name name\n'
PARAM=$PARAM'module_type generic_data\n'
PARAM=$PARAM'module_exec exec\nmodule_end'
 
pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_local_component 'New local component' \ 
  $PARAM

Paramètres :

• <id_template>
• <id_agent>

Description : Ces modèles de modules sont un regroupement contenant des modules de vérification réseau. Ces modèles peuvent être appliqués directement aux agents, évitant d'avoir à ajouter les modules un par un.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --apply_module_template 1 1

Paramètres obligatoires :

• <nom_modele>
• <nom_module>
• <nom_agent>

Paramètres optionnels :

• use_alias

Description : Au moyen d'un modèle, une alerte sera créée pour un module d'un agent.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_template_module "Manual alert" "CPU Load" "pandorafms agent" use_alias

Paramètres obligatoires :

• <nom_modele>
• <nom_module>
• <nom_agent>

Paramètres optionnels :

• use_alias

Description : Une alerte sur un module d'un agent qui a été créée en utilisant un modèle d'alerte sera supprimée. Elle renverra une réponse uniquement si les trois paramètres obligatoires existent et que l'opération réussit, sinon aucun message ne sera affiché.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --delete_template_module \ 
  "Manual alert" "CPU Load" "pandorafms agent" use_alias

Si l'exécution précédente est réussie, cela affichera :

[INFO] Delete template 'Manual alert' from 
  module 'CPU Load' from agent 'pandorafms agent'

Paramètres obligatoires :

• <nom_action>
• <nom_modele>
• <nom_module>
• <nom_agent >

Paramètres optionnels :

• <nombre_minimum_d_alertes>
• <nombre_maximum_d_alertes>
• use_alias

Description : Une action sera ajoutée à une alerte en passant comme paramètres le nom de l'action et celui du modèle, module, et agent qui composent l'alerte. Optionnellement, on peut aussi lui passer les valeurs de mise à l'échelle nombre minimum d'alertes et nombre maximum d'alertes (les deux par défaut à 0).

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_template_action \ 
  "Mail to Admin" "Manual alert" "CPU Load" "pandorafms agent" 3 4 use_alias

Paramètres obligatoires :

• <nom_action>
• <nom_modele>
• <nom_module>
• <nom_agent>

Paramètres optionnels :

• use_alias

Description : Une action d'alerte sera supprimée d'un module d'agent qui utilise un modèle.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --delete_template_action "Mail to Admin" \ 
  "Manual alert" "CPU Load" "pandorafms agent" use_alias

Paramètres obligatoires : Aucun.

Paramètres optionnels : Aucun.

Description : Désactive toutes les alertes. S'il y avait déjà des alertes désactivées avant l'exécution de cette commande et qu'ensuite son homologue enable_alerts est exécutée, toutes les alertes seront à nouveau actives.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --disable_alerts

Paramètres obligatoires : Aucun.

Paramètres optionnels : Aucun.

Description : Active toutes les alertes. S'il y avait déjà des alertes actives avant l'exécution de cette commande et qu'ensuite son homologue disable_alerts est exécutée, toutes les alertes seront à nouveau inactives.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --enable_alerts

Paramètres :

• <template_name>
• <condition_type_serialized>
• <time_from>
• <time_to>
• <description>
• <group_name>
• <field_1 >
• <field_2 >
• <field_3 >
• <priority>
• <default_action>
• <days>
• <time_threshold>
• <min_alerts>
• <max_alerts>
• <alert_recovery>
• <field_2_recovery>
• <field_3_recovery>
• <condition_type_separator>

Description : Un modèle d'alerte sera créé.

Champ <condition_type_serialized> : Ce sont les options de type de modèle sérialisées avec le séparateur ; par défaut. Vous pouvez changer le séparateur avec le paramètre <condition_type_separator> pour éviter les conflits dans certaines options s'il y avait une possibilité qu'elles contiennent le caractère par défaut.

Expression régulière :

• Syntaxe : <type>;<matches_value>;<value>
• Exemple : regex;1;stopped|error (Alerte lorsque la valeur correspond à l'expression régulière 'stopped|error')

Maximum et minimum :

• Syntaxe : <type>;<matches_value>;<min_value>;<max_value>
• Exemple : max_min;0;30;50 (Alerte lorsque la valeur est en dehors de la plage 30-50)

Maximum :

• Syntaxe : <type>;<max_value>
• Exemple : max;70 (Alerte lorsque la valeur est supérieure à 70)

Minimum :

• Syntaxe : <type>;<min_value> :
• Exemple : min;30 (Alerte lorsque la valeur est inférieure à 30)

Égal à :

• Syntaxe : <type>;<value>
• Exemple : equal;0 (Alerte lorsque la valeur est égale à 0)

Différent de :

• Syntaxe : <type>;<value>
• Exemple : not_equal;100 (Alerte lorsque la valeur est différente de 100)

État avertissement :

• Syntaxe : <type>
• Exemple : warning (Alerte lorsque l'état passe à avertissement)

État critique :

• Syntaxe : <type>
• Exemple : critical (Alerte lorsque l'état passe à critique)

État inconnu :

• Syntaxe : <type>
• Exemple : unknown (Alerte lorsque l'état passe à inconnu)

État différent de normal :

• Syntaxe : <type>
• Exemple : not_normal (Alerte lorsque l'état est différent de normal -avertissement, critique, etc.-)

En état de changement :

• Syntaxe : <type>;<matches_value>
• Exemple : on_change;1 (Alerte lorsque la valeur change)

Toujours :

• Syntaxe : <type>
• Exemple : always (Alerte toujours)

Le champ <days> :

• Ce sont sept caractères binaires qui spécifient les jours de la semaine où l'alerte sera activée. p.e. : 0000011 pour activer l'alerte uniquement les samedis et dimanches.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_alert_template \
 "Template name" \
 "max_min@1@3@5" \
 "09:00 18:00" \
 "It sends an email interval 3-5, 9 AM-6 PM, Mondays. Separator forced to @" \
 "Unknown" \
 "[email protected]" \
 "subject" \
 "message" \
 "3" \
 "Mail to XXX" \
 "1000000" \
 "38600" \
 "1" \
 "2" \
 "0" \
 "@"

Paramètre obligatoire : <nom_modele>

Paramètres optionnels : Aucun.

Description : Un modèle d'alerte sera supprimé s'il existe.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --delete_alert_template "Critical condition" "" "" "" "" "" ""

Paramètres :

• <template_name>
• <field_to_update>
• <new_value>

Description : Un champ donné d'un modèle d'alerte existant sera mis à jour.

Pour <field_to_update> les champs possibles sont :

• name
• description
• type
• matches_value
• value
• min_value
• max_value
• time_threshold (0-1)
• time_from
• time_to
• monday (0-1)
• tuesday (0-1)
• wednesday (0-1)
• thursday (0-1)
• friday (0-1)
• saturday (0-1)
• sunday (0-1)
• min_alerts
• max_alerts
• recovery_notify (0-1)
• field_1
• field_2
• field_3
• recovery_field_2
• recovery_field_3
• priority (0-4)
• default_action
• group_name

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --update_alert_template "Template name" "priority" "4"

Paramètres obligatoires : Aucun.

Paramètres optionnels :

• <nom_action>
• <separateur>
• <format> csv (par défaut), json, string

Description : Renvoie toutes les actions d'alerte. Optionnellement, le résultat peut être filtré par mot-clé. Optionnellement, le séparateur de résultats peut être spécifié dans le deuxième paramètre et le format du résultat dans le troisième paramètre.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.jim --get_alert_actions '%28' ';' csv

Paramètres :

• <server_name>
• <action_name>
• <separator>
• <return_type>

Description : Renvoie toutes les actions d'alerte du Command Center (Métaconsole). Optionnellement, le résultat peut être filtré par nom de nœud ou par nom d'action. Dans le deuxième paramètre, le séparateur de résultats peut être spécifié et dans le troisième paramètre, le format de la liste renvoyée (csv, json, string).

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_alert_actions_meta  'Action 1' ';' 'json'

Paramètres :

• <command_name>
• <command>
• <id_group>
• <description>
• <internal>
• <fields_descriptions>
• <fields_values>

Description : Une commande sera créée avec le nom et les données de commande spécifiés.

Optionnellement, vous pouvez spécifier :

• Nom du groupe. Si aucun groupe n'est fourni, elle sera assignée au groupe All.
• Description de la commande.
• Interne (1-0).
• Description des champs dans le format suivant : [“description_1”,“descrip_2”,“descrip_3”,“descrip_4”,“descrip_5”].
• Valeurs des champs dans le format suivant : [“value_1”,“value_2”,“value_3”,“value_4”,“value_5”].

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_alert_command \
 'Test' 'command' 'All' 'Desc' '1' \
 '["des1","des2","des3","","des5","","","","",""]' \ 
 '["val1","val2","val3","val4","","","","","",""]'

Paramètres obligatoires : Aucun.

Paramètres optionnels :

• <nom_commande>
• <commande_elle_meme>
• <nom_groupe>
• 1 pour lister les commandes à usage interne dans PFMS, 0 pour lister les autres commandes.

Description : Permet de voir toutes les commandes d'alertes. Optionnellement, le résultat peut être filtré par mot-clé dans les champs suivants : nom de commande, code exécuté par la commande d'alerte, nom de groupe, description, ou s'il est à usage interne.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_alert_commands "log" "echo" "" "0"

Paramètres obligatoires :

• <nom_modele_alerte>
• <id_agent>
• <id_module>

Paramètres optionnels :

• use_alias si cette option est utilisée, l'alias de l'agent doit être placé au lieu de son identifiant.

Description : Valide une alerte étant donné un nom de modèle d'alerte, un ID d'agent, et un ID de module.

Exemple (voir l'appel et sa syntaxe) :

En supposant qu'une alerte est définie sur l'agent qui est installé par défaut avec PFMS.

pandora_manage /etc/pandora/pandora_server.conf \ 
  --validate_alert "Critical condition" pandora.internals 99 use_alias

Paramètres : Aucun.

Description : Toutes les alertes seront validées.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --validate_all_alerts

Paramètres obligatoires :

1. <special_day> : Date au format YYYY-MM-DD.
2. <calendar_name> : Nom du calendrier, PFMS est livré avec le calendrier Default créé par défaut. Le nom du calendrier ne peut pas contenir d'espaces ni de caractères spéciaux.
3. <same_day> : Jour de la semaine à émuler, ils doivent être spécifiés en anglais, insensible à la casse.
4. <description> : Il peut être omis en mettant des guillemets consécutifs, "" ou ''.
5. <group_name> : Nom du groupe d'agents, PFMS est livré avec le groupe All créé par défaut. Le nom du groupe ne peut pas contenir d'espaces ni de caractères spéciaux.

Description : Créer un jour spécial.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_special_day \ 
  "2026-05-05" 'Default' "sunday" 'my description' "All"

Paramètres : <jour_special>

Description : Suppression du jour spécial spécifié.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --delete_special_day "2024-05-03"

Paramètres :

• <special_day>
• <field_to_change>
• <new_value>

Description : Modifier un champ spécifique d'un jour spécial. Les champs qui peuvent être mis à jour sont : same_day, description, et group_name.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --update_special_day "2014-05-03" "same_day" "monday"

Paramètres obligatoires :

• <valeur> 1 pour activer, 0 pour désactiver.

Paramètres optionnels : Aucun.

Description : Active ou désactive le jeton Event storm protection. S'il est activé, aucun événement ni alerte ne sera généré pendant que des données (vérifications d'agents) sont encore en cours de réception. Utilisez uniquement 1 ou 0, toute autre valeur peut produire des résultats inattendus.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --set_event_storm_protection 1

Paramètres obligatoires :

• <id_utilisateur>
• <mot_de_passe>
• <est_admin>

Paramètres optionnels :

• <commentaire>

Description : Un utilisateur sera créé avec l'identifiant d'utilisateur (qui sera également son nom d'utilisateur) et le mot de passe reçu. De plus, une valeur binaire sera reçue (<est_admin> 0 faux ou 1 vrai) spécifiant si oui ou non l'utilisateur sera un superadmin. Optionnellement, un commentaire sur l'utilisateur créé peut être ajouté.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_user "user7500" "user 7500" "0" \ 
  "User created by PFMS CLI."

Paramètre obligatoire :

• <id_utilisateur>

Description : Une tentative sera faite pour supprimer un utilisateur en passant son nom comme paramètre. Vous pouvez vérifier si un utilisateur existe ou non en utilisant la commande update_user.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --delete_user user02

Paramètres obligatoires :

• <id_utilisateur>
• <champ_a_mettre_a_jour>
• <nouvelle_valeur>

Les champs disponibles pour <champ_a_mettre_a_jour> sont :

1. email : adresse email.
2. phone : numéro de téléphone.
3. is_admin : Est-il superadmin ? (0 faux, 1 vrai).
4. comments : Commentaires.
5. fullname : Nom complet de l'utilisateur.
6. password : Mot de passe de l'utilisateur, utilisez des guillemets s'il contient des espaces.
7. language langue, valeurs possibles :

• default, prend la langue sélectionnée dans la configuration générale.
• ca, catalan.
• en_GB, anglais britannique.
• es, espagnol.
• fr, français.
• ru, russe.
• ja, japonais.
• zh_CN, chinois simplifié.

Description : Met à jour le champ donné pour un utilisateur existant.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --update_user "usuario 7500" password "XYZ"

Paramètre obligatoire :

• <id_utilisateur>

Description : Un utilisateur existant sera activé. S'il est déjà actif, seul un message s'affichera.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --enable_user "user7500"

Paramètre obligatoire :

• <id_utilisateur>

Description : Un utilisateur existant sera désactivé. S'il est déjà désactivé, seul un message s'affichera.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --disable_user "user7500"

Paramètres obligatoires :

• <nom_profil>
• <liste_de_permissions> 1 pour accorder la permission au nouveau profil ou 0 pour la refuser, dans cet ordre :

1. Voir agents (AR View agents) : agent_view.
2. Éditer agents (AW Edit agents) : agent_edit.
3. Désactiver agents (AD Disable agents) : agent_disable.
4. Éditer alertes (LW Edit alerts) : alert_edit.
5. Gérer alertes (LM Manage alerts) : alert_management.
6. Gérer utilisateurs (UM Manage users) : user_management.
7. Gérer base de données (DM Manage database) : db_management.
8. Voir événements (ER View events) : event_view.
9. Éditer événements (EW Edit events) : event_edit.
10. Gérer événements (EM Manage events) : event_management.
11. Voir rapports (RR View reports) : report_view.
12. Éditer rapports (RW Edit reports) : report_edit.
13. Gérer rapports (RM Manage reports) : report_management.
14. Voir cartes réseau (MR View network maps) : map_view.
15. Éditer cartes réseau (MW Edit network maps) : map_edit.
16. Gérer cartes réseau (MM Manage network maps) : map_management.
17. Voir console visuelle (VR View visual console) : vconsole_view.
18. Éditer console visuelle (VW Edit visual console) : vconsole_edit.
19. Gérer console visuelle (VM Manage visual console) : vconsole_management.
20. Gérer Pandora PFMS (PM Pandora FMS management) : pandora_management.
21. 0.
22. 0.
23. 0.

Description : Un nouveau profil sera créé en passant le nom du profil et les permissions comme paramètres.

Exemple (voir l'appel et sa syntaxe) :

Pour créer un profil avec une seule permission PM :

pandora_manage /etc/pandora/pandora_server.conf \
 --create_profile "New Profile" \
 0 0 0 0 0 0 0 0 0 0 \
 0 0 0 0 0 0 0 0 0 1 1 1 1

Paramètres obligatoires :

• <nom_profil>
• <liste_de_permissions> 1 pour accorder la permission au nouveau profil ou 0 pour la refuser, dans cet ordre :

1. Voir agents (AR View agents) : agent_view.
2. Éditer agents (AW Edit agents) : agent_edit.
3. Désactiver agents (AD Disable agents) : agent_disable.
4. Éditer alertes (LW Edit alerts) : alert_edit.
5. Gérer alertes (LM Manage alerts) : alert_management.
6. Gérer utilisateurs (UM Manage users) : user_management.
7. Gérer base de données (DM Manage database) : db_management.
8. Voir événements (ER View events) : event_view.
9. Éditer événements (EW Edit events) : event_edit.
10. Gérer événements (EM Manage events) : event_management.
11. Voir rapports (RR View reports) : report_view.
12. Éditer rapports (RW Edit reports) : report_edit.
13. Gérer rapports (RM Manage reports) : report_management.
14. Voir cartes réseau (MR View network maps) : map_view.
15. Éditer cartes réseau (MW Edit network maps) : map_edit.
16. Gérer cartes réseau (MM Manage network maps) : map_management.
17. Voir console visuelle (VR View visual console) : vconsole_view.
18. Éditer console visuelle (VW Edit visual console) : vconsole_edit.
19. Gérer console visuelle (VM Manage visual console) : vconsole_management.
20. Gérer Pandora PFMS (PM Pandora FMS management) : pandora_management.
21. 0.
22. 0.
23. 0.

Description : Un nouveau profil sera modifié en passant le nom du profil et les permissions comme paramètres.

Exemple (voir l'appel et sa syntaxe) :

Pour que New Profile n'ait qu'une seule permission PM :

pandora_manage /etc/pandora/pandora_server.conf \
 --update_profile "New Profile" \
 0 0 0 0 0 0 0 0 0 0 \
 0 0 0 0 0 0 0 0 0 1 1 1 1

Paramètres obligatoires :

• <id_utilisateur>
• <nom_profil>
• <nom_groupe>

Description : Un profil sera ajouté à un utilisateur en passant comme paramètres l'identifiant de l'utilisateur, le nom du profil, et le nom du groupe sur lequel il aura les privilèges de ce profil. Spécifiez le groupe All si vous souhaitez que le profil soit valide dans tous les groupes.

Commande associée : add_profile_to_user.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --add_profile "User 07" "Group coordinator" "All"

Paramètres obligatoires :

• <id_utilisateur>
• <nom_etiquette>
• <nom_groupe>
• <nom_profil>

Description : Ajoute une étiquette au profil et groupe assigné à un utilisateur.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --add_tag_to_user_profile 'User 7500' 'dmz' 'Servers' 'Chief Operator'

Paramètres obligatoires :

• <id_utilisateur>
• <nom_profil>
• <nom_groupe>

Description : Un profil sera supprimé d'un utilisateur en passant comme paramètre l'identifiant de l'utilisateur, le nom du profil, et le nom du groupe sur lequel le profil a des privilèges.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --delete_profile "john doe" "Chief Operator" "Applications"

Paramètres obligatoires :

• <id_utilisateur>
• <nom_profil>

Paramètre optionnel :

• <nom_groupe>

Description : Ajoute un profil de groupe existant à un utilisateur. Si aucun groupe n'est fourni, il sera assigné au groupe All.

Commande associée : add_profile.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --add_profile_to_user 'user01' 'Chief Operator' 'Network'

Paramètres : Aucun.

Description : Le système EACL sera désactivé dans la configuration générale de PFMS.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --disable_eacl

Paramètres : Aucun.

Description : Le système EACL sera activé dans la configuration générale de PFMS.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --enable_eacl

Paramètre obligatoire :

• <id_utilisateur>

Description : La double authentification de l'utilisateur choisi sera désactivée.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --disable_double_auth 'admin'

Paramètres obligatoires :

• <nom_etiquette>
• <description_etiquette> vous pouvez utiliser des guillemets simples ou doubles pour une description nulle.

Paramètres optionnels :

• <url_etiquette> si vous utilisez une chaîne quelconque, cela ouvrira un lien dans la Console Web.
• <email_etiquette>

Description : Crée une nouvelle étiquette.

Exemples (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_tag "New tag" "My description" \ 
  "index.php?sec=custom_report&sec2=godmode/reporting/reporting_builder"

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_tag "New tag" "My description" \ 
  "https://example.com" "[email protected]"

Paramètres obligatoires (3) :

• <nom_evenement> (permet de répéter des noms existants).
• <type_evenement> Il pourra prendre l'une de ces valeurs typées :

• <nom_groupe> (sauf le groupe ALL).

Paramètres optionnels :

1. Nom de l'agent.
2. Nom du module de l'agent.
3. État de l'événement (0 nouvel événement non validé, 1 s'il est validé et 2 en cours). Pour pouvoir ajouter le reste des champs optionnels, l'une de ces valeurs devra être spécifiée.
4. Sévérité : 0 (Maintenance), 1 (Informatif), 2 (Normal), 3 (Avertissement), 4 (Critique), 5 (Mineur) et 6 (Majeur). Pour pouvoir ajouter le reste des champs optionnels, l'une de ces valeurs devra être spécifiée.
5. Nom du modèle d'alerte dans le cas où le module spécifié est associé à une alerte.
6. Nom d'utilisateur ou identifiant d'utilisateur (id_user, différent de l'utilisateur propriétaire owner_user de l'événement). Si le nom d'utilisateur ou l'identifiant d'utilisateur inclut des espace(s) ou tout autre caractère étendu, ces caractères doivent être échappés. Un espace est représenté comme   et & comme &, etc.
7. Commentaire. Si le nom de l'utilisateur ou l'identifiant de l'utilisateur faisant le commentaire inclut des espaces ou tout autre caractère étendu, ces caractères doivent être échappés. Un espace est représenté comme   et & comme &, etc. (via la Console Web le nom d'utilisateur ou l'identifiant d'utilisateur sera affiché sans échappement, c'est normal). Il est recommandé d'utiliser l'identifiant d'utilisateur car il est immuable et permettra toujours d'identifier correctement l'utilisateur.
8. Source, champ texte pour indiquer l'origine de l'événement, des mots-clés peuvent être utilisés.
9. Identifiant extraordinaire (Extra ID), utilisé dans la vue des événements pour regrouper de manière additionnelle.
10. (Version 6.0 SP5 OUM 625 ou antérieure, issue 525) Étiquettes : Le format des étiquettes doit être <etiquette> <url>. Plusieurs étiquettes peuvent être ajoutées séparées par des virgules : <etiquette> <url>,<etiquette> <url>. Il est important qu'il n'y ait pas d'espaces entre la virgule et l'étiquette suivante.
11. Données personnalisées : Les données personnalisées sont saisies sous forme de document JSON. Par exemple : {"Location": "Office", "Priority": 42}. Si le JSON est mal structuré, une exception non gérée se produira, il est recommandé d'utiliser la commande json_pp pour vérifier le JSON avant de créer l'événement.
12. Forcer la création de l'agent (0 faux, 1 vrai) : Si le paramètre du nom de l'agent fait référence à un agent qui n'existe pas, alors il sera créé (utilisez null, deux guillemets consécutifs, dans les paramètres de nom de module et de nom de modèle d'alerte). L'alias du nouvel agent sera exactement le même nom fourni.
13. Instructions en critique : Ajoute les instructions à réaliser en cas de passage à l'état critique.
14. Instructions en avertissement : Ajoute les instructions à réaliser en cas de passage à l'état d'avertissement.
15. Instructions en inconnu : Ajoute les instructions à réaliser en cas de passage à l'état inconnu.
16. Utiliser l'alias de l'agent, utilisez textuellement use_alias. Deux guillemets simples consécutifs, sans espace entre eux, doivent être spécifiés si vous utilisez le paramètre suivant ci-dessous.
17. Command Center (Métaconsole) : Identifiant du serveur.
18. Paramètre sans utilisation, omettre avec des guillemets consécutifs ('' ou "").
19. Paramètre sans utilisation, omettre avec des guillemets consécutifs ('' ou "").
20. Paramètre sans utilisation, omettre avec des guillemets consécutifs ('' ou "").
21. Identifiant d'événement personnalisé.
22. Instructions par défaut.

Description : Un événement sera créé avec les données de nom et de type de l'événement, et les noms de module, d'agent et de groupe associés.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_event \
    'Event CLI' \
    system \
    Firewalls \
    'My agent' 'My module' 0 4 Template004 \

Paramètres obligatoires :

• <nom_agent>

Paramètres optionnels :

• <nom_module>
• <date_heure_minimale>
• <date_heure_maximale>
• <utilisateur_proprietaire_evenement>
• <id_criticite> Une de ces valeurs : 0 (maintenance), 1 (informational), 2 (normal), 3 (warning), 4 (critical), 5 (minor).
• <nom_modele_alerte> (sans fonctionnalité).
• use_alias si le nom de l'agent est inconnu, vous pouvez chercher par son alias.

Description : Tous les événements seront validés en fonction d'une série de filtres. Les filtres configurables sont le nom de l'agent, le nom du module, une date et heure minimales et une date et heure maximales, le nom de l'utilisateur propriétaire de l'événement, l'identifiant de criticité, et le nom du modèle d'alerte associé.

Les paramètres peuvent être combinés de nombreuses manières, en laissant vides avec des guillemets vides "" ou '' ceux que vous ne voulez pas utiliser (y compris le nom de l'agent) et en remplissant les autres.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --validate_event 'My agent' 'My module'  '2024-06-02 22:02'

Paramètres obligatoires : <id_evenement>

Paramètres optionnels : Aucun.

Description : Permet de valider un événement en utilisant son identifiant numérique entier.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf 1234

Paramètre obligatoire :

• <id_evenement>

Paramètre optionnel :

• <separateur> par défaut |.

Description : Les informations d'un événement seront affichées à partir de son identifiant.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_event_info 341

Paramètres obligatoires :

• <id_evenement>
• <id_utilisateur>
• <commentaire>

Description : Ajoute un commentaire à un événement en spécifiant un utilisateur enregistré.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --add_event_comment "1234" "admin" "TEXT"

Paramètre obligatoire : <id_evenement>

Description : Change le statut d'un événement en “En cours” via son identifiant numérique.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --event_in_progress 123

Paramètres obligatoires :

• <id_evenement>
• <id_evenement_personnalise>

Description : Ajoute un identifiant personnalisé à un événement.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --update_event_custom_id "232" "CLI test"

Paramètres obligatoires :

• <id_evenement>
• L'un ou les deux paramètres suivants : <minutes_reponse_sla> <minutes_resolution_sla>.

Paramètre optionnel :

Si exécuté depuis le Command Center, et que les trois paramètres obligatoires ont été fournis, vous pouvez spécifier l'identifiant du Serveur PFMS hébergeant l'événement demandé, <identifiant_serveur>.

Description : Affiche à l'écran un résumé SLA d'un événement, calculé selon les paramètres fournis.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \
  --get_event_lifetime 123

Paramètres obligatoires :

• <nom_nouvelle_politique>
• <nom_groupe_agents>

Paramètre optionnel :

• <description> (erratum : l'aide en ligne de la commande indique qu'elle est obligatoire).

Description : Une politique sera créée avec le nom spécifié et appartenant au groupe spécifié.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_policy "New policy" "Workstations" "All desktop computers."

Paramètres obligatoires :

• <id_numerique_politique> Si les paramètres optionnels sont omis, la politique sera appliquée à tous les agents lui appartenant.

Paramètres optionnels :

1. <id_numerique_agent>
2. <utiliser_id_numerique> par défaut 0, pour utiliser le nom de l'agent dans le paramètre optionnel un, 1 doit être spécifié dans ce paramètre.
3. <id_serveur> Si vous travaillez dans un environnement centralisé, ce paramètre doit être spécifié, indiquant le serveur sur lequel la politique de surveillance sera exécutée et appliquée.

Description : Une politique sera appliquée de force. Dans le processus d'application d'une politique, il y a : la création des modules de la politique dans tous ses agents associés, la création des alertes de la politique dans les modules créés, et la réalisation de modifications dans le fichier de configuration des agents locaux que la politique peut avoir pour ajouter les modules créés et les collections associées à la politique.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --apply_policy 6 1 0 1

Paramètres : Aucun.

Description : Ajoute toutes les politiques à la file d'attente d'application. Le serveur est celui qui observe la file d'attente et applique les politiques de surveillance.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --apply_all_policies

Paramètres obligatoires :

• <nom_agent>
• <nom_politique>

Paramètre optionnel :

• use_alias

Description : Un agent existant sera ajouté à une politique existante en spécifiant son nom d'agent ou, si le paramètre optionnel est utilisé, son alias d'agent.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --add_agent_to_policy "pandorafms agent" "Basic Linux Monitoring" use_alias

Paramètres obligatoires :

• <nom_politique>
• <nom_collection> Si une collection inexistante est spécifiée, une exception non gérée sera obtenue.

Paramètres optionnels : Aucun.

Description : Une collection existante sera ajoutée à une politique existante.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --add_collection_to_policy "Basic Remote Checks" "Apache Enterprise Plugin"

Paramètre obligatoire : <id_collection_fichiers>

Paramètres optionnels : Aucun.

Description : Recrée les fichiers d'une collection. Vous devez avoir zip installé pour compresser les fichiers. La collection doit avoir au moins un fichier pour que le résultat soit réussi. Si une collection inexistante est spécifiée, une exception non gérée sera obtenue.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --recreate_collection 1

Paramètres :

• <policy_name>
• <component_name>

Description : Un module extrait d'un composant local existant sera ajouté à une politique existante.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \
 --create_policy_data_module_from_local_component \
 "Monitoring policy name" \
 "Local component name"

Paramètres : Aucun.

Description : Tous les modules qui n'appartiennent à aucune politique seront supprimés, à la fois de la base de données et du fichier de configuration des agents (le cas échéant).

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --delete_not_policy_modules

Paramètres obligatoires :

• <id_politique>
• <id_agent>

Description : Supprime un agent d'une politique. Il est nécessaire de spécifier l'identifiant numérique de la politique de surveillance et l'identifiant de l'agent que vous souhaitez supprimer.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --remove_agent_from_policy '11' '2'

Paramètre obligatoire : <nom_politique>

Paramètre optionnel : Aucun.

Description : Toutes les alertes d'une politique passée en paramètre seront marquées comme désactivées.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --disable_policy_alerts "Basic HP-UX Local Monitoring"

Paramètres obligatoires :

• <nom_politique>
• <nom_module>
• <type_module>

Paramètres optionnels :

• <description>
• <groupe_module>
• <min>
• <max>
• <post_process>
• <intervalle>
• <warning_min>
• <warning_max>
• <critical_min>
• <critical_max>
• <history_data>
• <data_configuration>
• <warning_str>
• <critical_str>
• <enable_unknown_events>
• <ff_threshold>
• <each_ff>
• <ff_threshold_normal>
• <ff_threshold_warning>
• <ff_threshold_critical>
• <ff_timeout>
• <critical_instructions>
• <warning_instructions>
• <unknown_instructions>
• ignore_unknown Écarte le calcul de l'état inconnu, de sorte que le module ne passera jamais à cet état et conservera toujours le dernier état connu.

Description : Un module de données sera créé dans une politique. Les valeurs par défaut sont les mêmes que pour l'option --create_data_module.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_policy_data_module 'Policy name' 'Module name' \ 
  generic_proc 'Module description' 'group module' \ 
  0 100 0 300 30 60 61 100 0 \ 
  'module_begin\nmodule_name modname\nmodule_end' \ 
  'Warning string' 'Critical string'

Paramètres obligatoires :

• <nom_politique>
• <nom_module>
• <type_module> web_data, web_proc, web_content_data, web_content_string.

Paramètres optionnels :

• <description>
• <groupe_module>
• <min>
• <max>
• <post_process>
• <intervalle>
• <warning_min>
• <warning_max>
• <critical_min>
• <critical_max>
• <history_data>
• <retries>
• <requests>
• <agent_browser_id>
• <auth_server>
• <auth_realm>
• <configuration_data>
• <proxy_url>
• <proxy_auth_login>
• <proxy_auth_password>
• <warning_str>
• <critical_str>
• <enable_unknown_events>
• <ff_threshold>
• <each_ff>
• <ff_threshold_normal>
• <ff_threshold_warning>
• <ff_threshold_critical>
• <ff_timeout>
• <warning_inverse>
• <critical_inverse>
• <critical_instructions>
• <warning_instructions>
• <unknown_instructions>
• ignore_unknown Écarte le calcul de l'état inconnu, de sorte que le module ne passera jamais à cet état et conservera toujours le dernier état connu.

Description : Un module web sera créé dans une politique. Les valeurs par défaut sont les mêmes que pour l'option --create_web_module.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_policy_web_module 'Policy name' 'Module name' \ 
  web_data 'Module description' 'General' \ 
  0 100 0 300 0 0 0 0 1 0 1 'Pandora FMS' \ 
  auto public 'module_begin\nmodule_name modname\nmodule_end' \ 
  'http://proxy.url' 'proxy_login' 'proxy_password' \ 
  1 10 10 10 10 10 10 10 10 1 1 \ 
  'critical_instructions' 'warning_instructions' 'unknown_instructions'

Paramètres obligatoires :

• <policy_name>
• <module_name>
• <module_type>

Paramètres optionnels :

• <module_port> valeur numérique entre 1 et 65535.
• <description>
• <module_group>
• <min>
• <max>
• <post_process>
• <interval>
• <warning_min>
• <warning_max>
• <critical_min>
• <critical_max>
• <history_data>
• <ff_threshold>
• <warning_str>
• <critical_str>
• <enable_unknown_events>
• <each_ff>
• <ff_threshold_normal>
• <ff_threshold_warning>
• <ff_threshold_critical>
• <critical_instructions>
• <warning_instructions>
• <unknown_instructions>
• ignore_unknown Écarte le calcul de l'état inconnu, de sorte que le module ne passera jamais à cet état et conservera toujours le dernier état connu.

Description : Un module réseau sera créé dans une politique. Les valeurs par défaut sont les mêmes que pour l'option --create_network_module.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_policy_network_module 'Policy name' \ 
  'Module name' remote_icmp_proc 22 'Module description' \ 
  'Name group' 0 100 0 300 30 60 61 100 0 0 \ 
  'Warning string' 'Critical string'

Paramètres obligatoires :

• <policy_name>
• <module_name>
• <module_type>
• <module_port>
• <version>

Paramètres optionnels :

• <community>
• <oid>
• <description>
• <module_group>
• <min>
• <max>
• <post_process>
• <interval>
• <warning_min>
• <warning_max>
• <critical_min>
• <critical_max>
• <history_data>
• <snmp3_priv_method>
• <snmp3_priv_pass>
• <snmp3_sec_level>
• <snmp3_auth_method>
• <snmp3_auth_user>
• <snmp3_priv_pass>
• <ff_threshold>
• <warning_str>
• <critical_str>
• <enable_unknown_events>
• <each_ff>
• <ff_threshold_normal>
• <ff_threshold_warning>
• <ff_threshold_critical>
• <critical_instructions>
• <warning_instructions>
• <unknown_instructions>
• ignore_unknown Écarte le calcul de l'état inconnu, de sorte que le module ne passera jamais à cet état et conservera toujours le dernier état connu.

Description : Un module SNMP sera créé dans une politique. Les valeurs par défaut sont les mêmes que pour l'option --create_snmp_module.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_policy_snmp_module 'Policy name' \ 
  'Module name' remote_snmp_inc 8080 1 \ 
  mycommunity myoid 'Module description'

Paramètres obligatoires :

• <policy_name>
• <module_name>
• <module_kind>
• <module_port> valeur numérique entre 1 et 65535.
• <plugin_name>
• <user>
• <password>
• <parameters>

Paramètres optionnels :

• <description>
• <module_group>
• <min>
• <max>
• <post_process>
• <interval>
• <warning_min>
• <warning_max>
• <critical_min>
• <critical_max>
• <history_data>
• <warning_str>
• <critical_str>
• <enable_unknown_events>
• <each_ff>
• <ff_threshold_normal>
• <ff_threshold_warning>
• <ff_threshold_critical>
• <critical_instructions>
• <warning_instructions>
• <unknown_instructions>
• ignore_unknown Écarte le calcul de l'état inconnu, de sorte que le module ne passera jamais à cet état et conservera toujours le dernier état connu.

Description : Un module de type plugin sera créé dans une politique. Les valeurs par défaut sont les mêmes que pour l'option --create_plugin_module.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_policy_plugin_module 'Policy name' \ 
  'Module name' generic_data 22 myplugin myuser \ 
  mypass 'param1 param2 param3' 'Module description' \ 
  'General' 1 3 0 300 0 0 0 0 1 'Warning string' 'Critical string'

Paramètre obligatoire : <nom_politique>

Paramètres optionnels : Aucun.

Description : Valide toutes les alertes d'une politique donnée.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --validate_policy_alerts "Basic Linux Monitoring"

Paramètre obligatoire : <nom_politique>

Paramètres optionnels : Aucun.

Description : Obtient la liste des modules (identifiant numérique et nom) d'une politique donnée.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_policy_modules "Basic Linux Monitoring"

Paramètres obligatoires : Aucun.

Paramètres optionnels :

• <nom_agent>
• use_alias pour chercher par alias d'agent.

Description :

• Sans paramètres : Obtient toutes les politiques (identifiant numérique et nom).
• Nom d'agent : Obtient les politiques d'un agent (liste le nom de l'agent, l'identifiant numérique de la politique, et le nom de la politique).

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --get_policies "pandorafms agent" use_alias

Paramètres obligatoires :

• <nom_nouveau_filtre>
• <nom_groupe_agents>
• <filtre_lui_meme>
• <agrege_par> Une des valeurs suivantes : none, dstip, dstport, proto, srcip, srcport.
• <format_de_sortie> kilobytes, kilobytespersecond, megabytes, megabytespersecond.

Paramètres optionnels : Aucun.

Description : Créer un nouveau filtre pour surveiller via NetFlow®.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_netflow_filter "New filter" "Network" \ 
  "host 192.168.50.3 OR host 192.168.50.4 or HOST 192.168.50.6" \ 
  dstport kilobytes

Paramètres obligatoires (voir étude de cas) :

• <commande_a_executer>
• <parametres_de_la_commande_a_executer>

Description : Avec cette option, il est possible d'exécuter n'importe quelle commande CLI PFMS avec des macros à partir d'un fichier CSV. Le nombre de macros correspondra au nombre de colonnes dans le fichier CSV. Chaque macro s'appellera __FIELD1__, __FIELD2__, __FIELD3__, … , __FIELDn__.

Étude de cas :

Enregistrer des utilisateurs avec la commande create_user à partir d'un fichier CSV /tmp/users_csv :

User 1,Password 1,0
User 2,Password 2,0
User 3,Password 3,0
User Admin,Password Admin,1

Instruction à exécuter (les connecteurs de ligne sont inclus à des fins pédagogiques) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --exec_from_file \
  /tmp/users_csv \
  create_user \
  __FIELD1__ \
  __FIELD2__ \
  __FIELD3__ \
  'Created by exec_from_file CLI PFMS command'

Paramètres obligatoires :

• <nom_snmp_trap> Tel qu'il sera vu dans la console des traps SNMP.
• <OID>
• <description>
• <severite> Valeur numérique, une des valeurs suivantes : 0 (Maintenance), 1 (Info) , 2 (Normal), 3 (Warning), 4 (Critical), 5 (Minor), 6 (Major).

Description : Crée une nouvelle définition de trap SNMP. Un nom doit être placé ; si un OID est répété, le trap ne sera pas créé.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_snmp_trap "Cisco_FAN_Crash" "1.3.3.3.2.12.3.3.4.1" \ 
  "Something happen with the FAN inside the CISCO device, probably a failure" "3"

Paramètres : Aucun.

Démarre le processus snmptrapd sur le serveur de traps SNMP. S'il est déjà démarré, il met fin à ce service (commande kill) et l'exécute à nouveau, en supprimant tous les traps situés dans le journal d'échange situé par défaut dans :

/var/log/pandora/pandora_snmptrapd.log

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --start_snmptrapd

Paramètre obligatoire :

• <nom_serveur_PFMS>

Paramètres optionnels : Aucun.

Description : L'option multiprocess doit être activée pour que les serveurs PFMS s'exécutent dans des processus individuels et puissent être détectés par cette commande. Une fois cette configuration effectuée, l'utilisation de cette commande sans paramètres listera les serveurs en cours d'exécution et leurs noms correspondants à tuer, un par un.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --kill dataserver

Paramètres obligatoires :

• <log_line>
• <source_id>

Paramètre optionnel :

• <source_type> : Si non indiqué, syslog sera utilisé.

Description : Analyse le journal donné et renvoie les décodeurs et les règles SIEM correspondants.

Exemple (voir l'appel et sa syntaxe), la variable $PARAM est utilisée pour plus de clarté :

PARAM="[Tue Sep 30 14:25:44.895897 2014] "
PARAM=$PARAM"[authz_core:error] [pid 31858] "
PARAM=$PARAM"[client 99.47.227.95:38870] "
PARAM=$PARAM"AH01630: client denied by server configuration: "
PARAM=$PARAM"/var/www/example.com/docroot/"
pandora_manage /etc/pandora/pandora_server.conf \ 
  --parse_siem_log \ 
  $PARAM \ 
  'httpd' 'syslog'

Une licence SIEM valide et les décodeurs et règles déjà chargés dans la base de données sont nécessaires pour que l'appel CLI fonctionne. Le résultat sera toujours ce qui serait généré au moment où il est évalué. Cet appel n'introduit pas de nouvelles entrées de journal dans la surveillance, ni ne génère d'événements SIEM.

La sortie générée sera en JSON, exemple (avec sortie formatée), la variable $PARAM est utilisée pour plus de clarté :

`{
  "decoder": [
    "apache-errorlog",
    "apache24-errorlog-ip-port",
    "apache24-errorlog-ip",
    "apache-errorlog-ip"
  ],
  "source_type": "syslog",
  "logcontent": "<$PARAM>",
  "source_id": "httpd",
  "srcport": "38870",
  "id": "AH01630",
  "type": "syslog",
  "srcip": "99.47.227.95:38870",
  "program_name": "httpd",
  "events": [
    {
      "level": 2,
      "description": "Unknown problem somewhere in the system.",
      "severity": 1,
      "mitre": [],
      "groups": [
        "syslog",
        "gpg13_4.3",
        "errors"
      ],
      "rule": 1002
    },
    {
      "description": "Apache: Attempt to access forbidden file or directory.",
      "level": 5,
      "severity": 1,
      "rule": 30305,
      "mitre": [],
      "groups": [
        "gdpr_IV_35.7.d",
        "hipaa_164.312.b",
        "nist_800_53_AC.7",
        "nist_800_53_AU.14",
        "pci_dss_10.2.4",
        "tsc_CC6.1",
        "tsc_CC6.8",
        "tsc_CC7.2",
        "tsc_CC7.3",
        "apache",
        "web",
        "nist_800_53_SA.11",
        "tsc_CC6.6",
        "tsc_CC7.1",
        "access_denied",
        "pci_dss_6.5.8"
      ]
    }
  ]
}`

Paramètres obligatoires :

• <nom_nouveau_graphique>
• <description>
• <id_utilisateur>
• <id_groupe>
• <largeur>
• <hauteur>
• <evenements>
• <type_graphique> Par défaut 0 (Aire) ou l'une des valeurs suivantes :

1. Aire empilée.
2. Ligne.
3. Ligne empilée.
4. Graphique en nuage de points.
5. Jauge.
6. Barres horizontales.
7. Barres verticales.
8. Graphique circulaire.

• <periode>
• <modules>
• <separateur_modules>

Description : Un graphique sera créé avec les éléments spécifiés. Deux modules ou plus doivent être distingués avec < separateur_modules >, qui doit toujours être spécifié, même pour un seul module.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --create_custom_graph "New graph" \ 
  "Graph created by CLI PFMS" "admin" "0" \ 
  "" "" "0" "2" "" "1;2;3" ";"

Paramètres obligatoires :

• <id_graphique_a_editer>
• <nom_graphique_a_editer>
• <description_a_editer>
• <utilisateur_a_editer>
• <id_groupe_a_editer>
• <largeur_a_editer>
• <hauteur_a_editer>
• <evenements_a_editer>
• <type_graphique_a_editer> Par défaut 0 (Aire) ou l'une des valeurs suivantes :

1. Aire empilée.
2. Ligne.
3. Ligne empilée.
4. Graphique en nuage de points.
5. Jauge.
6. Barres horizontales.
7. Barres verticales.
8. Graphique circulaire.

• <periode_a_editer>

Description : Un graphique sera édité avec les éléments spécifiés. Tous les paramètres sont obligatoires, mais certains peuvent être laissés vides en utilisant des guillemets simples. Si cela se produit, les valeurs seront celles que le graphique avait déjà avant l'édition.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --edit_custom_graph "1" "" "edit graph by CLI" \ 
  "" "" "" "" "" "" "" 3600

Paramètres obligatoires :

1. <id_graphique>
2. <id_modules> jusqu'à un maximum de 10 modules, délimités avec <separateur>
3. <separateur>

Description : Les modules spécifiés seront ajoutés au graphique sélectionné. Bien que plus de 10 modules puissent être ajoutés, seuls les 10 premiers seront affichés.

Exemples (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --add_modules_to_graph 1 '1,2,3' ','

pandora_manage /etc/pandora/pandora_server.conf \ 
  --add_modules_to_graph 1 '4;5;6;7' ';'

Paramètres obligatoires :

• <id_graphique>
• <id_modules> les identifiants numériques de module doivent être délimités avec <separateur>
• <separateur>

Description : Les modules spécifiés seront supprimés du graphique sélectionné.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --delete_modules_to_graph "1" "2,4,6" ","

Paramètres obligatoires :

• <nom_cluster>
• <type_cluster> uniquement AA ou AP.
• <description>
• <id_groupe>

Description : Un cluster sera créé avec les paramètres spécifiés et ses éléments associés.

Exemple (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --new_cluster \
 "New cluster" "AA" "My description" "2"

Paramètre obligatoire :

• <donnees_json_base64> au format JSON, puis encodé en base64 : paires de valeurs avec l'identifiant du cluster et l'identifiant de l'agent. Exemple :

[{"id":5,"id_agent":2},{"id":5,"id_agent":3}]

Description : Un agent spécifique sera ajouté au cluster spécifié. Il est absolument nécessaire que les données JSON soient encodées en base64.

Suite de l'exemple précédent (voir l'appel et sa syntaxe) :

pandora_manage /etc/pandora/pandora_server.conf \ 
  --add_cluster_agent \ 
 W3siaWQiOjUsImlkX2FnZW50IjoyfSwKeyJpZCI6NSwiaWRfYWdlbnQiOjN9XQ==