Note

Ce plugin fait partie de la collection fortinet.fortimanager (version 2.0.1).

Pour l'installer, utilisez : ansible-galaxy collection install fortinet.fortimanager.

Pour l'utiliser dans un playbook, spécifiez : fortinet.fortimanager.fmgr_system_log_settings.

Nouveau dans la version 2.10 : de fortinet.fortimanager

  • Synopsis
  • Paramètres
  • Notes
  • Exemples
  • Valeurs de retour

Synopsis

  • Ce module est capable de configurer un périphérique FortiManager.
  • Les exemples comprennent tous les paramètres et valeurs qui doivent être ajustés aux sources de données avant l'utilisation.

Paramètres

Paramètre Choix/par défaut Commentaires
bypass_validationbooléen
    Choix :

  • pas de
  • oui
uniquement mis à True lorsque le schéma du module diffère avec la structure de l'API FortiManager, le module continue à s'exécuter sans valider les paramètres.
rc_failedliste / elements=string la liste des codes rc avec lesquels les conditions d'échec seront remplacées.
rc_succèsliste / elements=string la liste des codes rc avec lesquels les conditions de réussite seront remplacées.
étatchaîne de caractères / obligatoire
    Choix :

  • présent
  • absent
la directive pour créer, mettre à jour ou supprimer un objet
paramètres du journal du systèmedictionnaire le jeu de paramètres de niveau supérieur
browse-max-logfilesnombre entier Par défaut :
10000
Nombre maximal de fichiers journaux pour chaque tentative d'exploration des journaux pour chaque Adom.
dns-resolve-dstipchaîne de caractères
    Choix :

  • désactiver
  • activer
Activer/désactiver la résolution de l'IP de destination par DNS.disable - Désactiver la résolution de l'IP de destination par DNS.enable - Activer la résolution de l'IP de destination par DNS.
download-max-logsnombre entier Par défaut :
500000
Nombre maximal de journaux pour chaque tentative de téléchargement de journaux.
FAC-champ personnalisé1chaîne de caractères Nom du champ de journal personnalisé à indexer.
FAZ-champ personnalisé1chaîne de caractères Nom du champ de journal personnalisé à indexer.
FCH-champ personnalisé1chaîne de caractères Nom du champ de journal personnalisé à indexer.
FCT-champ personnalisé1chaîne de caractères Nom du champ de journal personnalisé à indexer.
Champ personnalisé FDD1chaîne de caractères Nom du champ de journal personnalisé à indexer.
Champ personnalisé FGT1chaîne de caractères Nom du champ de journal personnalisé à indexer.
FMG-champ personnalisé1chaîne de caractères Nom du champ de journal personnalisé à indexer.
FML-champ personnalisé1chaîne de caractères Nom du champ de journal personnalisé à indexer.
FPX-champ personnalisé1chaîne de caractères Nom du champ de journal personnalisé à indexer.
Champ personnalisé FSA1chaîne de caractères Nom du champ de journal personnalisé à indexer.
FWB-champ personnalisé1chaîne de caractères Nom du champ de journal personnalisé à indexer.
ha-auto-migratechaîne de caractères
    Choix :

  • désactiver
  • activer
Activation/désactivation de la fusion automatique des journaux des membres HA vers le cluster HA.disable - Désactive la fusion automatique des journaux des membres HA vers le cluster HA.enable - Active la fusion automatique des journaux des membres HA vers le cluster HA.
import-max-logfilesnombre entier Par défaut :
10000
Nombre maximal de fichiers journaux pour chaque tentative d'importation de journaux.
nom de l'archive du fichier journalchaîne de caractères
    Choix :

  • de base
  • étendu
Format du nom du fichier journal pour l'archivage, tel que la sauvegarde, le téléchargement ou le chargement.basic - Format de base pour le nom du fichier journal d'archive, par exemple FGT20C0000000001.tlog.1417797247.log.extended - Format étendu pour le nom du fichier journal d'archive, par exemple FGT20C0000000001.2014-12-05-08:34:58.tlog.1417797247.log.
rolling-analyzerdictionnaire pas de description
joursliste / elements=chaîne
    Choix :

  • soleil
  • lun
  • tue
  • mercredi
  • thu
  • vendredi
  • sam
pas de description
del-fileschaîne de caractères
    Choix :

  • désactiver
  • activer
Activer/désactiver la suppression du fichier journal après le téléchargement.disable - Désactiver la suppression du fichier journal.enable - Activer la suppression du fichier journal.
répertoirechaîne de caractères Répertoire du serveur de téléchargement, pour un serveur Unix, utiliser absolu.
taille du fichierentier Par défaut :
200
Roller les fichiers journaux lorsqu'ils atteignent cette taille (Mo).
gzip-formatchaîne de caractères
    Choix :

  • désactiver
  • activer
Activer/désactiver la compression des fichiers journaux téléchargés.disable - Désactiver la compression.enable - Activer la compression.
heurenombre entier Par défaut :
0
Horaire de roulement des fichiers journaux (heure).
ipchaîne de caractères Par défaut :
"0.0.0.0"
Adresse IP du serveur de téléchargement.
ip2chaîne de caractères Par défaut :
"0.0.0.0"
Adresse IP2 du serveur de téléchargement.
ip3chaîne de caractères Par défaut :
"0.0.0.0"
Adresse IP3 du serveur de téléchargement.
log-formatchaîne de caractères
    Choix :

  • natif
  • texte
  • csv
Format des fichiers journaux téléchargés.native - Format natif (texte ou compact).text - Format texte (convertir si nécessaire).csv - Format CSV (valeurs séparées par des virgules).
minnombre entier Par défaut :
0
Horaire de roulement des fichiers journaux (minutes).
mot de passechaîne de caractères pas de description
mot de passe2chaîne de caractères pas de description
mot de passe3chaîne de caractères pas de description
type de serveurchaîne de caractères
    Choix :

  • ftp
  • sftp
  • scp
Type de serveur de téléchargement.ftp - Téléchargement via FTP.sftp - Téléchargement via SFTP.scp - Téléchargement via SCP.
Téléchargerchaîne de caractères
    Choix :

  • désactiver
  • activer
Activer/désactiver le téléchargement des fichiers journaux.disable - Désactiver le téléchargement des fichiers journaux.enable - Activer le téléchargement des fichiers journaux.
upload-hournombre entier Par défaut :
0
Horaire de téléchargement des fichiers journaux (heure).
upload-modechaîne de caractères
    Choix :

  • sauvegarde
  • miroir
Mode de téléchargement avec plusieurs serveurs.Backup - Les serveurs sont tentés et utilisés les uns après les autres en cas d'échec de la connexion.Mirror - Tous les serveurs configurés sont tentés et utilisés.
upload-triggerchaîne de caractères
    Choix :

  • on-roll
  • on-schedule
Événement déclenchant le téléchargement des fichiers journaux.on-roll - Télécharger les fichiers journaux après qu'ils aient été roulés.on-schedule - Télécharger les fichiers journaux quotidiennement.
nom d'utilisateurchaîne de caractères Nom d'utilisateur de connexion au serveur de téléchargement.
nom d'utilisateur2chaîne de caractères Nom d'utilisateur de connexion au serveur de téléchargement2.
nom d'utilisateur3chaîne de caractères Nom d'utilisateur de connexion au serveur de téléchargement3.
quandchaîne de caractères
    Choix :

  • aucun
  • quotidien
  • hebdomadaire
Faire rouler les fichiers journaux périodiquement.none - Ne pas faire rouler les fichiers journaux périodiquement.daily - Faire rouler les fichiers journaux quotidiennement.weekly - Faire rouler les fichiers journaux certains jours de la semaine.
rolling-localdictionnaire pas de description
joursliste / elements=chaîne
    Choix :

  • soleil
  • lun
  • tue
  • mercredi
  • thu
  • vendredi
  • sam
pas de description
del-fileschaîne de caractères
    Choix :

  • désactiver
  • activer
Activer/désactiver la suppression du fichier journal après le téléchargement.disable - Désactiver la suppression du fichier journal.enable - Activer la suppression du fichier journal.
répertoirechaîne de caractères Répertoire du serveur de téléchargement, pour un serveur Unix, utiliser absolu.
taille du fichierentier Par défaut :
200
Roller les fichiers journaux lorsqu'ils atteignent cette taille (Mo).
gzip-formatchaîne de caractères
    Choix :

  • désactiver
  • activer
Activer/désactiver la compression des fichiers journaux téléchargés.disable - Désactiver la compression.enable - Activer la compression.
heurenombre entier Par défaut :
0
Horaire de roulement des fichiers journaux (heure).
ipchaîne de caractères Par défaut :
"0.0.0.0"
Adresse IP du serveur de téléchargement.
ip2chaîne de caractères Par défaut :
"0.0.0.0"
Adresse IP2 du serveur de téléchargement.
ip3chaîne de caractères Par défaut :
"0.0.0.0"
Adresse IP3 du serveur de téléchargement.
log-formatchaîne de caractères
    Choix :

  • natif
  • texte
  • csv
Format des fichiers journaux téléchargés.native - Format natif (texte ou compact).text - Format texte (convertir si nécessaire).csv - Format CSV (valeurs séparées par des virgules).
minnombre entier Par défaut :
0
Horaire de roulement des fichiers journaux (minutes).
mot de passechaîne de caractères pas de description
mot de passe2chaîne de caractères pas de description
mot de passe3chaîne de caractères pas de description
type de serveurchaîne de caractères
    Choix :

  • ftp
  • sftp
  • scp
Type de serveur de téléchargement.ftp - Téléchargement via FTP.sftp - Téléchargement via SFTP.scp - Téléchargement via SCP.
Téléchargerchaîne de caractères
    Choix :

  • désactiver
  • activer
Activer/désactiver le téléchargement des fichiers journaux.disable - Désactiver le téléchargement des fichiers journaux.enable - Activer le téléchargement des fichiers journaux.
upload-hournombre entier Par défaut :
0
Horaire de téléchargement des fichiers journaux (heure).
upload-modechaîne de caractères
    Choix :

  • sauvegarde
  • miroir
Mode de téléchargement avec plusieurs serveurs.backup - Les serveurs sont tentés et utilisés l'un après l'autre en cas d'échec de la connexion.mirror - Tous les serveurs configurés sont tentés et utilisés.
upload-triggerchaîne de caractères
    Choix :

  • on-roll
  • on-schedule
Événement déclenchant le téléchargement des fichiers journaux.on-roll - Télécharger les fichiers journaux après qu'ils aient été roulés.on-schedule - Télécharger les fichiers journaux quotidiennement.
nom d'utilisateurchaîne de caractères Nom d'utilisateur de connexion au serveur de téléchargement.
nom d'utilisateur2chaîne de caractères Nom d'utilisateur de connexion au serveur de téléchargement2.
nom d'utilisateur3chaîne de caractères Nom d'utilisateur de connexion au serveur de téléchargement3.
quandchaîne de caractères
    Choix :

  • aucun
  • quotidien
  • hebdomadaire
Faire rouler les fichiers journaux périodiquement.none - Ne pas faire rouler les fichiers journaux périodiquement.daily - Faire rouler les fichiers journaux quotidiennement.weekly - Faire rouler les fichiers journaux certains jours de la semaine.
rouler-régulierdictionnaire pas de description
joursliste / elements=chaîne
    Choix :

  • soleil
  • lun
  • tue
  • mercredi
  • thu
  • vendredi
  • sam
pas de description
del-fileschaîne de caractères
    Choix :

  • désactiver
  • activer
Activer/désactiver la suppression du fichier journal après le téléchargement.disable - Désactiver la suppression du fichier journal.enable - Activer la suppression du fichier journal.
répertoirechaîne de caractères Répertoire du serveur de téléchargement, pour un serveur Unix, utiliser absolu.
taille du fichierentier Par défaut :
200
Roller les fichiers journaux lorsqu'ils atteignent cette taille (Mo).
gzip-formatchaîne de caractères
    Choix :

  • désactiver
  • activer
Activer/désactiver la compression des fichiers journaux téléchargés.disable - Désactiver la compression.enable - Activer la compression.
heurenombre entier Par défaut :
0
Horaire de roulement des fichiers journaux (heure).
ipchaîne de caractères Par défaut :
"0.0.0.0"
Adresse IP du serveur de téléchargement.
ip2chaîne de caractères Par défaut :
"0.0.0.0"
Adresse IP2 du serveur de téléchargement.
ip3chaîne de caractères Par défaut :
"0.0.0.0"
Adresse IP3 du serveur de téléchargement.
log-formatchaîne de caractères
    Choix :

  • natif
  • texte
  • csv
Format des fichiers journaux téléchargés.native - Format natif (texte ou compact).text - Format texte (convertir si nécessaire).csv - Format CSV (valeurs séparées par des virgules).
minnombre entier Par défaut :
0
Horaire de roulement des fichiers journaux (minutes).
mot de passechaîne de caractères pas de description
mot de passe2chaîne de caractères pas de description
mot de passe3chaîne de caractères pas de description
type de serveurchaîne de caractères
    Choix :

  • ftp
  • sftp
  • scp
Type de serveur de téléchargement.ftp - Téléchargement via FTP.sftp - Téléchargement via SFTP.scp - Téléchargement via SCP.
Téléchargerchaîne de caractères
    Choix :

  • désactiver
  • activer
Activer/désactiver le téléchargement des fichiers journaux.disable - Désactiver le téléchargement des fichiers journaux.enable - Activer le téléchargement des fichiers journaux.
upload-hournombre entier Par défaut :
0
Horaire de téléchargement des fichiers journaux (heure).
upload-modechaîne de caractères
    Choix :

  • sauvegarde
  • miroir
Mode de téléchargement avec plusieurs serveurs.Backup - Les serveurs sont tentés et utilisés les uns après les autres en cas d'échec de la connexion.Mirror - Tous les serveurs configurés sont tentés et utilisés.
upload-triggerchaîne de caractères
    Choix :

  • on-roll
  • on-schedule
Événement déclenchant le téléchargement des fichiers journaux.on-roll - Télécharger les fichiers journaux après qu'ils aient été roulés.on-schedule - Télécharger les fichiers journaux quotidiennement.
nom d'utilisateurchaîne de caractères Nom d'utilisateur de connexion au serveur de téléchargement.
nom d'utilisateur2chaîne de caractères Nom d'utilisateur de connexion au serveur de téléchargement2.
nom d'utilisateur3chaîne de caractères Nom d'utilisateur de connexion au serveur de téléchargement3.
quandchaîne de caractères
    Choix :

  • aucun
  • quotidien
  • hebdomadaire
Faire rouler les fichiers journaux périodiquement.none - Ne pas faire rouler les fichiers journaux périodiquement.daily - Faire rouler les fichiers journaux quotidiennement.weekly - Faire rouler les fichiers journaux certains jours de la semaine.
sync-search-timeoutnombre entier Par défaut :
60
Nombre maximal de secondes pour l'exécution d'une session de recherche de journaux en mode synchrone.
espace de travail_blocage_adomchaîne de caractères l'adom à verrouiller pour FortiManager fonctionnant en mode espace de travail, la valeur peut être globale et d'autres y compris root.
workspace_locking_timeoutentier Par défaut :
300
le temps maximum en secondes pour attendre qu'un autre utilisateur libère le verrouillage de l'espace de travail.

Notes

Note

  • L'exécution en mode de verrouillage de l'espace de travail est prise en charge dans ce module FortiManager, les paramètres de haut niveau workspace_locking_adom et workspace_locking_timeout aident à faire le travail.
  • Pour créer ou mettre à jour un objet, utilisez la directive state present.
  • Pour supprimer un objet, utilisez la directive state absent.
  • Normalement, l'exécution d'un module peut échouer lorsqu'un rc non nul est renvoyé. vous pouvez également modifier les conditions d'échec ou de réussite avec les paramètres rc_failed et rc_succeeded.

Exemples

-hosts: fortimanager-inventory
  collections:- fortinet.fortimanager
  connection: httpapi
  vars:ansible_httpapi_use_ssl:Trueansible_httpapi_validate_certs:Falseansible_httpapi_port:443tasks:-name: Log settings.
     fmgr_system_log_settings:bypass_validation:Falseworkspace_locking_adom: [global, custom adom including root]>workspace_locking_timeout:300rc_succeeded:[0,-2,-3,...]rc_failed:[-2,-3,...]system_log_settings:FAC-custom-field1: >FAZ-custom-field1: >FCH-custom-field1: >FCT-custom-field1: >FDD-custom-field1: >FGT-custom-field1: >FMG-custom-field1: >FML-custom-field1: >FPX-custom-field1: >FSA-custom-field1: >FWB-custom-field1: >browse-max-logfiles: >dns-resolve-dstip: [disable, enable]>download-max-logs: >ha-auto-migrate: [disable, enable]>import-max-logfiles: >log-file-archive-name: [basic, extended]>rolling-analyzer:days:- sun
                - mon
                - tue
                - wed
                - thu
                - fri
                - sat
              del-files: [disable, enable]>directory: >file-size: >gzip-format: [disable, enable]>hour: >ip: >ip2: >ip3: >log-format: [native, text, csv]>min: >password: >password2: >password3: >server-type: [ftp, sftp, scp]>upload: [disable, enable]>upload-hour: >upload-mode: [backup, mirror]>upload-trigger: [on-roll, on-schedule]>username: >username2: >username3: >when: [none, daily, weekly]>rolling-local:days:- sun
                - mon
                - tue
                - wed
                - thu
                - fri
                - sat
              del-files: [disable, enable]>directory: >file-size: >gzip-format: [disable, enable]>hour: >ip: >ip2: >ip3: >log-format: [native, text, csv]>min: >password: >password2: >password3: >server-type: [ftp, sftp, scp]>upload: [disable, enable]>upload-hour: >upload-mode: [backup, mirror]>upload-trigger: [on-roll, on-schedule]>username: >username2: >username3: >when: [none, daily, weekly]>rolling-regular:days:- sun
                - mon
                - tue
                - wed
                - thu
                - fri
                - sat
              del-files: [disable, enable]>directory: >file-size: >gzip-format: [disable, enable]>hour: >ip: >ip2: >ip3: >log-format: [native, text, csv]>min: >password: >password2: >password3: >server-type: [ftp, sftp, scp]>upload: [disable, enable]>upload-hour: >upload-mode: [backup, mirror]>upload-trigger: [on-roll, on-schedule]>username: >username2: >username3: >when: [none, daily, weekly]>sync-search-timeout: >

Valeurs de retour

Les valeurs de retour courantes sont documentées ici, les champs suivants sont uniques à ce module :

Clé Retourné Description
request_urlchaîne de caractères toujours L'url complète demandée
Exemple :/sys/login/user
response_codenombre entier toujours Le statut de la demande api
response_messagechaîne de caractères toujours Le message descriptif de la réponse api.
Exemple : OK.

Auteurs

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)