Liste des variables d'environnement

Les variables d'environnement permettent de contrôler le comportement de l'agent au moment de l'exécution.

Les variables d'environnement peuvent être générées dans l'agent à l'aide de la page Variables d'environnement. Sur les systèmes Windows, ces variables sont définies dans le fichier KXXENV de l'agent. Sur les systèmes UNIX et Linux, elles peuvent être définies dans le fichier $CANDLEHOME/config/XX.ini de l'agent. XX correspond au code produit à deux lettres. L'agent doit être redémarré pour que les nouveaux paramètres soient appliqués.

Remarque : Les variables d'environnement ne sont pas définies correctement sur un système distant exécutant un interpréteur de commandes C. Si vous devez utiliser des variables d'environnement, utilisez un interpréteur de commandes différent.

Tableau 1. Variables d'environnement. Tableau répertoriant les variables d'environnement, leurs valeurs par défaut, les plages de valeurs valides et les descriptions de chaque variable.
Variable d'environnement	Valeur par défaut	Valeurs admises	Description
`CDP_ATTRIBUTE_GROUP_INTERVALLE_ACTUALISATION`	Non applicable	Tout entier non négatif	Fréquence, en secondes, à laquelle un groupe d'attributs particulier indiqué est mis à jour en arrière-plan. Cette variable fonctionne de la même manière que `CDP_DP_REFRESH_INTERVAL`, à ceci près qu'elle ne vise que le groupe d'attributs indiqué. Le nom de groupe d'attributs dans le nom de variable doit être en majuscules, même si le nom de groupe d'attributs réel ne l'est pas.
`CDP_DP_CACHE_TTL`	`55`	Tout entier supérieur ou égal à 1.	Nombre de secondes pendant lequel les données collectées pour un groupe d'attributs sont mises en cache. Pendant cette durée, lorsque plusieurs demandes sont effectuées pour les mêmes données, elles reçoivent une copie en cache de ces données. Cette valeur s'applique à tous les groupes d'attribut de l'agent.
`CDP_GROUPE_ATTRIBUTS_CACHE_TTL`	Valeur de `CDP_DP_CACHE_TTL`	Tout entier supérieur ou égal à 1.	Nombre de secondes pendant lesquelles les données collectées pour le groupe d'attributs spécifié sont mises en cache. Pendant cette durée, lorsque plusieurs demandes sont effectuées pour les mêmes données, elles reçoivent une copie en cache de ces données. Cette valeur se substitue à `CDP_DP_CACHE_TTL` pour le groupe spécifié. Le nom de groupe d'attributs dans le nom de variable doit être en majuscules, même si le nom de groupe d'attributs réel ne l'est pas.
`CDP_DP_IMPATIENT_COLLECTOR_TIMEOUT`	`5` si des sous-noeuds sont définis ; dans le cas contraire, elle n'est pas définie.	Tout entier positif	Délai d'attente (en secondes) d'une collecte de données avant expiration et renvoi des données mises en cache, même si les données mises en cache sont périmées. (Les données mises en cache sont périmées si elles sont plus anciennes que`CDP_DP_CACHE_TTL` secondes). Si cette variable n'est pas définie, l'agent attend la fin de la collecte de données. Il arrive parfois que Tivoli Enterprise Portal ignore le délai d'attente. Si aucun pool d'unités d'exécution n'est configuré, cette variable est ignorée et la collecte de données est exécutée de façon synchrone.
`CDP_DP_REFRESH_INTERVAL`	`60` si des sous-noeuds sont définis ; dans le cas contraire, elle n'est pas définie.	Tout entier non négatif	Fréquence, en secondes, à laquelle les groupes d'attributs sont mis à jour en arrière-plan. Si cette variable n'est pas définie ou qu'elle a pour valeur 0, les mises à jour en arrière-plan sont désactivées. Si un pool d'unités d'exécution est configuré (voir la variable `CDP_DP_THREAD_POOL_SIZE`), les groupes d'attributs peuvent être régénérés en parallèle. S'il n'y a aucun pool d'unités d'exécution, les mises à jour se font en série, ce qui peut prendre un temps considérable. Cela équivaut logiquement à une taille de pool d'unités d'exécution de 1.
`CDP_DP_THREAD_POOL_SIZE`	`15` si des sous-noeuds sont définis ; dans le cas contraire, elle n'est pas définie.	Tout entier non négatif	Nombre d'unités d'exécution créées pour exécuter des collectes de données en arrière-plan à une fréquence définie par `CDP_DP_REFRESH_INTERVAL`. Si cette variable n'est pas définie ou qu'elle a pour valeur 0, cela signifie qu'il n'y a aucun pool d'unités d'exécution. Si `CDP_DP_THREAD_POOL_SIZE` est définie sur une valeur supérieure à 1 et que `CDP_DP_REFRESH_INTERVAL` est définie sur 0, la valeur de `CDP_DP_THREAD_POOL_SIZE` est ignorée et la collecte de données est lancée à la demande. Le groupe d'attributs Statut du pool d'unités d'exécution présente le mode de fonctionnement. Il vous permet d'ajuster la taille du pool d'unités d'exécution et la fréquence de régénération pour améliorer les résultats. Par défaut, la requête de ce groupe d'attributs ne s'affiche pas dans l'arborescence de navigation de l'agent. Vous risquez de ne pas vous souvenir d'inclure la requête dans un espace de travail personnalisé pour l'agent. Cependant, vous pouvez aisément la visualiser en affectant la requête Statut du pool d'unités d'exécution à une vue d'espace de travail au niveau de l'agent.
`CDP_JDBC_MAX_ROWS`	`1000`	Tout entier positif	Nombre maximal de lignes de données que le fournisseur de données JDBC renvoie. Un ensemble de résultats contenant un nombre supérieur à ce nombre de lignes n'est traité que jusqu'à cette valeur maximale. Des requêtes peuvent être développées pour empêcher qu'une quantité excessive de données soit renvoyée à IBM® Tivoli Monitoring.
`CDP_NT_EVENT_LOG_GET_ALL_ENTRIES_FIRST_TIME`	`NO`	YES, NO	Si cette variable est définie sur YES, l'agent envoie un événement pour chaque enregistrement dans le journal des événements Windows. Si elle est définie sur NO, seuls les nouveaux événements du journal Windows sont envoyés.
`CDP_NT_EVENT_LOG_CACHE_TIMEOUT`	`3600`	Tout entier supérieur ou égal à 300.	Nombre de secondes pendant lequel les événements du journal des événements Windows sont mis en cache par l'agent. Tous les événements mis en cache sont renvoyés lorsqu'une requête est effectuée sur le groupe d'attributs Journal des événements. Remarque : Cette variable n'est plus utilisée. Utilisez la variable `CDP_PURE_EVENT_CACHE_SIZE`.
`CDP_PURE_EVENT_CACHE_SIZE`	`100`	Tout entier positif supérieur ou égal à 1.	Nombre maximal d'événements à mettre en cache lorsqu'une source de données de fichier journal est configurée pour traiter de nouveaux enregistrements, pour le groupe d'attributs Journal des événements Windows. Et aussi pour les moniteurs et les notifications JMX. Chaque nouvel enregistrement du journal provoque l'envoi d'un événement. Cette variable d'environnement définit le nombre d'événements placés dans la mémoire cache par l'agent. Les valeurs mises en cache sont renvoyées lorsqu'une requête est effectuée sur le groupe d'attributs.
`CDP_DP_ACTION_TIMEOUT`	`20` secondes	Tout entier positif supérieur ou égal à 1.	Délai d'attente en secondes avant que l'agent n'ait effectué le traitement de la commande Action.
`CDP_DP_SCRIPT_TIMEOUT`	`30` secondes	Tout entier positif supérieur ou égal à 10.	Délai d'attente en secondes, avant que le programme lancé par un groupe d'attributs basé sur des scripts soit terminé.
`CDP_DP_PING_TIMEOUT`	`30` secondes	Tout entier positif supérieur ou égal à 10.	Délai d'attente en secondes, avant que le programme lancé par un code de retour de commande soit terminé. Remarque : Cette variable ne concerne pas le fournisseur de données de Ping ICMP.
`CDP_SNMP_MAX_RETRIES`	`2`	Tout entier positif	Nombre de nouvelles tentatives d'envoi de la demande SNMP. Le nombre total de demandes envoyées à l'agent SNMP correspond à cette valeur plus un, si aucune réponse n'est reçue.
`CDP_SNMP_RESPONSE_TIMEOUT`	`2` secondes	Tout entier positif	Délai d'expiration, en secondes, de chaque demande SNMP. Chaque ligne d'un groupe d'attributs correspond à une demande distincte. Cette valeur de délai d'expiration correspond au délai d'attente, en secondes, d'une réponse avant une nouvelle tentative. Le délai d'expiration total pour une ligne de données unique est (`CDP_SNMP_MAX_RETRIES` + 1) * `CDP_SNMP_RESPONSE_TIMEOUT`. Le délai d'expiration total par défaut est (2+1) * 2 = 6 secondes.
`CDP_DP_HOSTNAME`	Nom de la première interface réseau installée	Une adresse IP ou un nom d'hôte	Définit le nom d'hôte préféré (interface réseau) sur un système comportant plusieurs interfaces. Utilisez cette variable d'environnement si l'agent connecte ses ports d'écoute à une adresse d'interface réseau autre que celle par défaut. Utilisé par le fournisseur de données SNMP. Pour les sources de données personnalisées et de socket, cette variable s'applique si la variable `CDP_DP_ALLOW_REMOTE` est également définie.
`CDP_SNMP_ALLOW_DECREASING_OIDS`	`NO`	YES, NO	Si cette variable a pour valeur YES, les fournisseurs de données SNMP ne vérifient pas si les ID objet renvoyés sont en cours d'augmentation. Affectez la valeur YES avec prudence car il se peut que l'agent surveillé ait des problèmes que cette vérification peut généralement intercepter.
`KUMP_DP_COPY_MODE_SAMPLE_INTERVAL`	`60`	Délai d'attente (secondes)	Pour un fournisseur de données de fichier journal, indique le délai d'attente avant la relecture du contenu d'un fichier lorsque l'agent est défini sur Traiter tous les enregistrements lorsque le fichier est échantillonné. La durée est exprimée en secondes.
`KUMP_MAXPROCESS`	`100%`	5-100%	Pour un fournisseur de données de fichier journal, spécifie l'utilisation maximale du processeur pour traiter le fichier de données. Les valeurs sont comprises entre 5 et 100%. La valeur par défaut est de 100%.
`KUMP_DP_SAMPLE_FACTOR`	`5`	Tout entier non négatif	Pour un fournisseur de données de fichier journal, définit le facteur d'échantillonnage lorsque l'option Traiter tous les enregistrements lorsque le fichier est échantillonné est sélectionnée. Ce temps d'attente garantit que les modèles qui couvrent plusieurs enregistrements sont totalement écrits avant consignation des balayages du modèle.
`KUMP_DP_EVENT`	`5`	Tout entier non négatif	Pour un fournisseur de données de fichier journal, définit la fréquence d'échantillonnage des données d'événement, en secondes.
`KUMP_DP_FILE_EXIST_WAIT`	`YES`	YES, NO	Pour un fournisseur de données de fichier journal, indique que l'unité d'exécution de surveillance de fichier continue de s'exécuter si elle détecte que le fichier surveillé est absent ou vide. L'unité d'exécution attend que le fichier existe, re-vérifie toutes les quelques secondes, puis démarre ou redémarre la surveillance une fois que le fichier est disponible.
`KUMP_DP_FILE_SWITCH_CHECK_INTERVAL`	`600`	Tout entier non négatif	Indique la fréquence, en secondes, à laquelle le fournisseur de données de fichier journal recherche un fichier de surveillance différent sur lequel basculer lors de l'utilisation de la prise en charge de nom de fichier dynamique.
`KUMP_DP_FILE_ROW_PAUSE_INCREMENT`	Aucun	Tout entier non négatif	Pour un fournisseur de données de fichier journal, indique le nombre d'enregistrements de fichier lus avant que l'unité d'exécution de surveillance de fichier s'interrompe. La pause permet le traitement des mises à jour précédentes. Utilisez cette variable d'environnement uniquement si le fichier surveillé reçoit des rafales volumineuses de nouveaux enregistrements et que certaines mises à jour d'enregistrement risquent d'être perdues.
`CDP_COLLECTION_TIMEOUT`	`60` secondes	Tout entier positif	Délai en secondes durant lequel l'agent attend une réponse d'un collecteur de données qui a été lancé dans un autre processus. Les collecteurs de données JMX, JDBC, HTTP et SOAP en sont des exemples.
`CDP_SSH_TEMP_DIRECTORY`	`.` (point)	Toute chaîne de chemin valide sur le système distant	Pour un fournisseur de données de script compatible SSH, spécifie un emplacement sur le système distant. Les fichiers script qui sont fournis avec l'agent doivent être téléchargés à cet emplacement. Le terme d'emplacement relatif désigne un emplacement par rapport au répertoire de base de l'utilisateur. La valeur par défaut de `.` (point) indique le répertoire de base de l'utilisateur.
`CDP_SSH_DEL_COMMAND`	`rm -Rf`	Toute chaîne de commande de suppression valide sur le système distant	Pour un fournisseur de données de script compatible SSH, spécifie la commande appelée pour supprimer les fichiers scripts téléchargés, fournis avec l'agent.
`CDP_SNMP_SEND_DELAY_ FACTOR`	`0` millisecondes	Tout entier positif	L'envoi SNMP initial est retardé de 0 au nombre de millisecondes indiqué. Cette variable n'est activée que si le pool d'unités d'exécution est activé aussi. Le délai ne s'applique pas à tous les envois, mais seulement au premier envoi effectué par un groupe d'attributs. Cette variable est utile lorsque le périphérique surveillé a des difficultés à répondre lorsqu'il reçoit plusieurs demandes à la fois.
`CDP_ICMP_PING_REFRESH_INTERVAL`	`60` secondes	Tout entier supérieur ou égal à 1.	Intervalle auquel sont "pingués" les systèmes répertoriés dans un fichier listant les unités. Si les pings consomment trop de temps, il y a toujours un délai d'au moins `CDP_PING_MIN_INTERVAL_DELAY` secondes avant que la commande ne soit réémise. Les données ne sont pas actualisées plus fréquemment que ne l'indique ce paramètre. Elles peuvent l'être moins fréquemment, selon le nombre d'entrées contenues dans le fichier liste de périphériques et la durée nécessaire à la réception des réponses.
`CDP_ICMP_PING_MIN_INTERVAL_DELAY`	`30` secondes	Tout entier supérieur ou égal à 1 et inférieur à la fréquence de régénération des pings `CDP`	Après émission d'une commande PING sur les périphériques d'un fichier liste, le prochain intervalle de régénération des pings ne doit pas débuter avant que ce délai, exprimé en secondes, ne soit écoulé.
`CDP_ICMP_PING_BURST`	`10`	Tout entier supérieur ou égal à 0.	Nombre de commandes Ping qui seront envoyées avant l'interruption de l'agent spécifiée par la variable `CDP_ICMP_PING_BURST_DELAY`. La valeur zéro désactive cette fonction.
`CDP_ICMP_PING_BURST_DELAY`	`10`	Tout entier supérieur ou égal à 0.	Délai d'attente en millisecondes après envoi du nombre de commandes Ping défini par la variable `CDP_ICMP_PING_BURST`. La valeur zéro désactive cette fonction.
`CDP_ICMP_PING_TIMEOUT`	`2000` millisecondes	Tout entier supérieur ou égal à 1.	Délai d'attente, en millisecondes, d'une réponse à une commande Ping. Ce paramètre s'applique à chaque tentative de commande PING effectuée. Trois tentatives de commande PING sont effectuées pour chaque hôte. Si aucune réponse n'est reçue suite aux 3 tentatives, la durée totale d'attente d'une réponse est `CDP_ICMP_PING_TIMEOUT` multiplié par 3. Par défaut, cette valeur est de 6000 millisecondes. Si vous modifiez la valeur de `CDP_ICMP_PING_TIMEOUT`, l'énumération `TIMEOUT` par défaut de l'attribut Temps de réponse actuel ne s'applique plus. Vous devez définir l'énumération `TIMEOUT` sur la nouvelle valeur de `CDP_ICMP_PING_TIMEOUT` multipliée par 3.
`CDP_JDBC_CONNECTIONLESS`	`false`	true, false	Si la valeur est true, les connexions JDBC sont fermées après chaque tentative de collecte de données, c'est-à-dire que tous les groupes d'attributs tentent de créer leur propre connexion chaque fois que des données sont collectées. Les connexions ne sont pas réutilisées si cette variable est activée. Si la valeur est false, une connexion est établie avec la base de données et cette connexion est partagée par les groupes d'attributs.
`CDP_SSH_EXCLUDED_ ENVIRONMENT_VARIABLES`	Aucun	Liste séparée par des virgules de noms de variables d'environnement	Pour un fournisseur de données de script compatible SSH, spécifie l'ensemble de variables d'environnement local qui ne doivent pas être définies dans l'environnement du système distant.
`CDP_DP_EVENT_LOG_MAX_BACKLOG_TIME`	`0` secondes	0, 1 ou tout entier supérieur à 1	Si cette valeur est définie sur 0 et que la variable `CDP_DP_EVENT_LOG_MAX_BACKLOG_EVENTS` n'a pas été définie sur 1 ou sur tout entier supérieur à 1, le programme ne traite pas les événements générés pendant que l'agent est arrêté. 0 est la valeur par défaut. Si cette valeur est définie sur 1 et que la variable `CDP_DP_EVENT_LOG_MAX_BACKLOG_EVENTS` n'a pas été définie sur un entier supérieur à 1, le programme traite tous les événements générés pendant que l'agent est arrêté. Si cette valeur est supérieure à 1 et que la variable `CDP_DP_EVENT_LOG_MAX_BACKLOG_EVENTS` n'a pas été définie sur un entier supérieur à 1, le programme traite les événements générés pendant ce délai en secondes par rapport à l'heure actuelle de l'ordinateur. Par exemple, si la valeur est définie sur 300, l'agent traite tous les événements générés à moins de 300 secondes de l'heure actuelle de l'ordinateur. Lorsqu'une valeur supérieure à 1 est entrée pour les variables `CDP_DP_EVENT_LOG_MAX_BACKLOG _TIME` et `CDP_DP_EVENT_LOG_MAX _BACKLOG_EVENTS`, l'intervalle de temps des événements ou le nombre d'événements est traité. La variable choisie dépend de celle qui correspond en premier.
`CDP_DP_EVENT_LOG_ journal_événements_Windows_MAX_BACKLOG_TIME`	`0` seconde (ne traitez pas d'événements omis pendant que l'agent est arrêté)	0, 1 ou tout entier supérieur à 1	Si la valeur est
`CDP_DP_EVENT_LOG_ MAX_BACKLOG_EVENTS`	`0` événements	0, 1 ou tout entier supérieur à 1	Si elle est définie sur 0 et que la variable `CDP_DP_EVENT_LOG_MAX_BACKLOG _TIME` n'est pas définie sur 1 ou un entier supérieur, le programme ne traite pas les événements générés lorsque l'agent est arrêté. 0 est la valeur par défaut. Si elle est définie sur 1 et que la variable `CDP_DP_EVENT_LOG_MAX_BACKLOG _TIME` n'est pas définie sur un entier supérieur à 1, le programme traite tous les événements générés lorsque l'agent est arrêté. Si elle est supérieure à 1 et que la variable `CDP_DP_EVENT_LOG_MAX_BACKLOG _TIME` n'est pas supérieure à 1, le programme traite au plus les événements générés lorsque l'agent est arrêté. Par exemple, si la valeur est définie sur 200, au démarrage de l'agent, le programme traite les 200 événements générés directement avant le démarrage. Lorsqu'une valeur supérieure à 1 est entrée pour les variables `CDP_DP_EVENT_LOG_MAX_BACKLOG _EVENTS` et `CDP_DP_EVENT_LOG_MAX_BACKLOG _BACKLOG_TIME`, l'intervalle de temps des événements ou le nombre d'événements est traité. La variable choisie dépend de celle qui correspond en premier.
`CDP_DP_EVENT_LOG_ journal_événements_Windows_MAX_BACKLOG_EVENTS`	`0` événement (ne traitez pas d'événement omis pendant que l'agent est arrêté)	0 ou tout entier supérieur ou égal à 1	Si la valeur est
`CDP_HTTP_READ_TIMEOUT`	`10`	Tout entier positif	Temps en secondes d'attente d'une réponse à une requête HTTP.
`CDP_JAT_THREAD_POOL_SIZE`	`15`	Tout entier positif	Nombre d'unités d'exécution utilisées par les fournisseurs Java™ pour la gestion des demandes de collecte de données. Les fournisseurs de données JMX, JDBC, HTTP et SOAP sont ceux qui peuvent bénéficier de ce pool d'unités d'exécution.
`CDP_HTML_OBJECTS_THREAD_ POOL_SIZE`	`10`	Tout entier positif	Nombre d'unités d'exécution utilisées pour le téléchargement d'objets de page trouvés dans les URL surveillées par le fournisseur de données HTTP.
`CDP_HTTP_SOAP_MAX_ROWS`	`500`	Tout entier positif	Nombre maximal de lignes renvoyées par le fournisseur de données HTTP SOAP.
`CDP_DP_ALLOW_REMOTE`	`NO`	`YES, NO`	Si cette variable est paramétrée sur Yes, l'agent autorise les connexions socket distantes. Si elle est paramétrée sur Non, l'agent n'autorise que les connexions socket à partir du système hôte local. Il s'agit de la valeur par défaut.
`CDP_DP_INITIAL_COLLECTION_ DELAY`	varie	Tout entier positif	Nombre de secondes, après le démarrage de l'agent, avant que le pool d'unités d'exécution ne commence ses collectes de données planifiées.