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_admin_user.

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 dispositif 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 défini à 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
utilisateur_administrateur_systèmedictionnaire le jeu de paramètres de premier niveau
adomliste / elements=string pas de description
adom-namechaîne de caractères Noms de domaines d'administration.
adom-excludeliste / elements=string pas de description
adom-namechaîne de caractères Noms de domaines d'administration.
app-filterliste / elements=chaîne pas de description
app-filter-namechaîne de caractères Nom du filtre d'application.
avatarchaîne de caractères Fichier image pour l'avatar (maximum 4K encodé en base64).
cachaîne de caractères CA du certificat de l'utilisateur de l'ICP (nom de la CA en local).
change-passwordchaîne de caractères
    Choix :

  • désactiver
  • activer
Activer/désactiver l'utilisateur restreint pour changer le mot de passe personnel.disable - Désactiver le paramètre.enable - Activer le paramètre.
tableau de bordliste / elements=chaîne pas de description
colonnenombre entier Par défaut :
0
ID de la colonne Widgets.
diskio-content-typechaîne de caractères
    Choix :

  • util
  • iops
  • blks
Type de graphique des widgets de Disk I/O Monitor.util - utilisation de la bande passante.iops - nombre de demandes d'E/S.blks - quantité de données des demandes d'E/S.
diskio-periodchaîne de caractères
    Choix :

  • 1 heure
  • 8 heures
  • 24 heures
Période de données des widgets Disk I/O Monitor.1hour - 1 heure.8hour - 8 heures.24hour - 24 heures.
log-rate-periodchaîne de caractères
    Choix :

  • 2min
  • 1 heure
  • 6 heures
Période de réception des données des widgets de surveillance du journal.2min - 2 minutes.1hour - 1 heure.6hours - 6 heures.
log-rate-topnchaîne de caractères
    Choix :

  • 1
  • 2
  • 3
  • 4
  • 5
Journal de réception des widgets de surveillance nombre d'éléments supérieurs à afficher.1 - Top 1.2 - Top 2.3 - Top 3.4 - Top 4.5 - Top 5.
log-rate-typechaîne de caractères
    Choix :

  • journal
  • dispositif
Options de ventilation des statistiques des widgets du moniteur de réception des journaux.log - Afficher les taux de journalisation pour chaque type de journal.device - Afficher les taux de journalisation pour chaque périphérique.
moduleidnombre entier Par défaut :
0
ID du widget.
nomchaîne de caractères Nom du widget.
num-entriesnombre entier Par défaut :
10
Nombre d'entrées.
intervalle de rafraîchissementnombre entier Par défaut :
300
Intervalle de rafraîchissement des widgets.
res-cpu-displaychaîne de caractères
    Choix :

  • moyenne
  • chaque
Widgets Type d'affichage du CPU.average - Utilisation moyenne du CPU.each - Chaque utilisation du CPU.
res-periodchaîne de caractères
    Choix :

  • 10min
  • heure
  • jour
Période de données des widgets.10min - Les 10 dernières minutes.hour - La dernière heure.day - Le dernier jour.
res-view-typechaîne de caractères
    Choix :

  • temps réel
  • historique
Widgets data view type.real-time - Vue en temps réel.history - Vue historique.
étatchaîne de caractères
    Choix :

  • fermer
  • ouvrir
Widgets ouverts/fermés état.close - Widget fermé.open - Widget ouvert.
tabidnombre entier Par défaut :
0
ID de l'onglet où le widget est affiché.
période de tempschaîne de caractères
    Choix :

  • 1 heure
  • 8h
  • 24 heures
Période de données des widgets Log Database Monitor.1hour - 1 heure.8hour - 8 heures.24hour - 24 heures.
widget-typechaîne de caractères
    Choix :

  • top-lograte
  • sysres
  • sysinfo
  • licinfo
  • jsconsole
  • sysop
  • alerte
  • statistiques
  • rpteng
  • raid
  • logrecv
  • devsummary
  • logdb-perf
  • logdb-lag
  • disk-io
  • log-rcvd-fwd
Type de widget.top-lograte - Moniteur de réception de journaux.sysres - Ressources système.sysinfo - Informations système.licinfo - Informations sur la licence.jsconsole - Console CLI.sysop - Fonctionnement de l'unité.alert - Console de messages d'alerte.statistics - Statistiques. rpteng - Report Engine.raid - Disk Monitor.logrecv - Logs/Data Received.devsummary - Device Summary.logdb-perf - Log Database Performance Monitor.logdb-lag - Log Database Lag Time.disk-io - Disk I/O.log-rcvd-fwd - Log receive and forwarding Monitor.
dashboard-tabsliste / elements=chaîne pas de description
nomchaîne de caractères Nom de l'onglet.
tabidentier Par défaut :
0
ID de l'onglet.
descriptionchaîne de caractères Description.
dev-groupchaîne de caractères groupe de périphériques.
adresse électroniquechaîne de caractères Adresse électronique.
ext-auth-accprofile-overridechaîne de caractères
    Choix :

  • désactiver
  • activer
Autoriser l'utilisation du profil d'accès fourni par le serveur d'authentification distant.Disable - Désactiver le remplacement du profil d'accès.enable - Activer le remplacement du profil d'accès.
ext-auth-adom-overridechaîne de caractères
    Choix :

  • désactiver
  • activer
Autoriser l'utilisation de l'ADOM fourni par le serveur d'authentification distant.disable - Désactiver le remplacement de l'ADOM.enable - Activer le remplacement de l'ADOM.
ext-auth-group-matchchaîne de caractères Seuls les administrateurs appartenant à ce groupe peuvent se connecter.
prénomchaîne de caractères Prénom.
force-password-changechaîne de caractères
    Choix :

  • désactiver
  • activer
Activer/désactiver le changement de mot de passe forcé à la prochaine connexion.disable - Désactiver le paramètre.enable - Activer le paramètre.
groupechaîne de caractères Nom du groupe.
cachénombre entier Par défaut :
0
Administrateur caché.
ips-filterliste / elements=string pas de description
ips-filter-namechaîne de caractères Nom du filtre IPS.
ipv6_trusthost1chaîne de caractères Par défaut :
"::/0"
Hôte de confiance de l'utilisateur Admin IPv6, par défaut ::/0 pour tous.
ipv6_trusthost10chaîne de caractères Par défaut :
"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128"
Admin user trusted host IPv6, par défaut ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 pour none.
ipv6_trusthost2chaîne de caractères Par défaut :
"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128"
Admin user trusted host IPv6, par défaut ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 pour none.
ipv6_trusthost3chaîne de caractères Par défaut :
"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128"
Admin user trusted host IPv6, par défaut ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 pour none.
ipv6_trusthost4chaîne de caractères Par défaut :
"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128"
Admin user trusted host IPv6, par défaut ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 pour none.
ipv6_trusthost5chaîne de caractères Par défaut :
"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128"
Admin user trusted host IPv6, par défaut ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 pour none.
ipv6_trusthost6chaîne de caractères Par défaut :
"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128"
Admin user trusted host IPv6, par défaut ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 pour none.
ipv6_trusthost7chaîne de caractères Par défaut :
"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128"
Admin user trusted host IPv6, par défaut ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 pour none.
ipv6_trusthost8chaîne de caractères Par défaut :
"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128"
Admin user trusted host IPv6, par défaut ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 pour none.
ipv6_trusthost9chaîne de caractères Par défaut :
"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128"
Admin user trusted host IPv6, par défaut ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 pour none.
nom de famillechaîne de caractères Nom de famille.
ldap-serverchaîne de caractères Nom du serveur LDAP.
méta-donnéesliste / elements=chaîne pas de description
longueur du champnombre entier Par défaut :
0
Longueur du champ.
nom du champchaîne de caractères Nom du champ.
valeur du champchaîne de caractères Valeur du champ.
importancechaîne de caractères
    Choix :

  • optionnel
  • obligatoire
Importance.facultatif - Ce champ est facultatif.obligatoire - Ce champ est obligatoire.
statutchaîne de caractères
    Choix :

  • désactivé
  • activé
Status.disabled - Ce champ est désactivé.enabled - Ce champ est activé.
numéro de mobilechaîne de caractères Numéro de mobile.
numéro de téléavertisseurchaîne de caractères Numéro de téléavertisseur.
mot de passechaîne de caractères pas de description
expiration du mot de passechaîne de caractères pas de description
numéro de téléphonechaîne de caractères Numéro de téléphone.
paquet de politiquesliste / elements=chaîne pas de description
nom de paquetage de politiquechaîne de caractères Noms des paquets de politique.
profileidchaîne de caractères Par défaut :
"Utilisateur_restrictif"
ID du profil.
radius_serverchaîne de caractères Nom du serveur RADIUS.
restrict-accesschaîne de caractères
    Choix :

  • désactiver
  • activer
Activer/désactiver l'accès restreint au VDOM de développement.disable - Désactiver le paramètre.enable - Activer le paramètre.
restrict-dev-vdomliste / elements=chaîne pas de description
dev-vdomchaîne de caractères VDOM du dispositif ou du périphérique.
rpc-permitchaîne de caractères
    Choix :

  • lecture-écriture
  • aucun
  • lire
set none/read/read-write rpc-permission.read-write - permission de lecture-écriture.none - aucune permission.read - permission de lecture seule.
ssh-public-key1chaîne de caractères pas de description
ssh-public-key2chaîne de caractères pas de description
ssh-public-key3chaîne de caractères pas de description
sujetchaîne de caractères Contraintes relatives au nom du certificat de l'utilisateur de l'ICP.
tacacs-plus-serverchaîne de caractères Nom du serveur TACACS+.
trusthost1chaîne de caractères Par défaut :
"0.0.0.0 0.0.0.0"
IP de l'hôte de confiance de l'utilisateur Admin, par défaut 0.0.0.0 0.0.0 pour tous.
trusthost10chaîne de caractères Par défaut :
"255.255.255.255 255.255.255.255"
IP de l'hôte de confiance de l'utilisateur Admin, par défaut 255.255.255.255.255.255 pour aucun.
trusthost2chaîne de caractères Par défaut :
"255.255.255.255 255.255.255.255"
IP de l'hôte de confiance de l'utilisateur Admin, par défaut 255.255.255.255.255.255 pour aucun.
trusthost3chaîne de caractères Par défaut :
"255.255.255.255 255.255.255.255"
IP de l'hôte de confiance de l'utilisateur Admin, par défaut 255.255.255.255.255.255 pour aucun.
trusthost4chaîne de caractères Par défaut :
"255.255.255.255 255.255.255.255"
IP de l'hôte de confiance de l'utilisateur Admin, par défaut 255.255.255.255.255.255 pour aucun.
trusthost5chaîne de caractères Par défaut :
"255.255.255.255 255.255.255.255"
IP de l'hôte de confiance de l'utilisateur Admin, par défaut 255.255.255.255.255.255 pour aucun.
trusthost6chaîne de caractères Par défaut :
"255.255.255.255 255.255.255.255"
IP de l'hôte de confiance de l'utilisateur Admin, par défaut 255.255.255.255.255.255 pour aucun.
trusthost7chaîne de caractères Par défaut :
"255.255.255.255 255.255.255.255"
IP de l'hôte de confiance de l'utilisateur Admin, par défaut 255.255.255.255.255.255 pour aucun.
trusthost8chaîne de caractères Par défaut :
"255.255.255.255 255.255.255.255"
IP de l'hôte de confiance de l'utilisateur Admin, par défaut 255.255.255.255.255.255 pour aucun.
trusthost9chaîne de caractères Par défaut :
"255.255.255.255 255.255.255.255"
IP de l'hôte de confiance de l'utilisateur Admin, par défaut 255.255.255.255.255.255 pour aucun.
two-factor-authchaîne de caractères
    Choix :

  • désactiver
  • activer
Activer l'authentification à 2 facteurs (certificat + mot de passe).Disable - Désactiver l'authentification à 2 facteurs.enable - Activer l'authentification à 2 facteurs.
type_utilisateurchaîne de caractères
    Choix :

  • local
  • rayon
  • ldap
  • tacacs-plus
  • pki-auth
  • groupe
Type d'utilisateur.local - Utilisateur local.radius - Utilisateur RADIUS.ldap - Utilisateur LDAP.tacacs-plus - Utilisateur TACACS+.pki-auth - Utilisateur PKI.group - Utilisateur de groupe.
useridchaîne de caractères Nom de l'utilisateur.
filtre webliste / elements=chaîne pas de description
web-filter-namechaîne de caractères Nom du filtre web.
jokerchaîne de caractères
    Choix :

  • désactiver
  • activer
Activer/désactiver l'authentification distante par joker.disable - Désactiver le joker de nom d'utilisateur.enable - Activer le joker de nom d'utilisateur.
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 à 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: Admin user.
     fmgr_system_admin_user:bypass_validation:Falseworkspace_locking_adom: [global, custom adom including root]>workspace_locking_timeout:300rc_succeeded:[0,-2,-3,...]rc_failed:[-2,-3,...]state: [present, absent]>system_admin_user:adom:-adom-name: >adom-exclude:-adom-name: >app-filter:-app-filter-name: >avatar: >ca: >change-password: [disable, enable]>dashboard:-column: >diskio-content-type: [util, iops, blks]>diskio-period: [1hour, 8hour, 24hour]>log-rate-period: [2min , 1hour, 6hours]>log-rate-topn: [1,2,3,...]>log-rate-type: [log, device]>moduleid: >name: >num-entries: >refresh-interval: >res-cpu-display: [average , each]>res-period: [10min , hour, day]>res-view-type: [real-time , history]>status: [close, open]>tabid: >time-period: [1hour, 8hour, 24hour]>widget-type: [top-lograte, sysres, sysinfo,...]>dashboard-tabs:-name: >tabid: >description: >dev-group: >email-address: >ext-auth-accprofile-override: [disable, enable]>ext-auth-adom-override: [disable, enable]>ext-auth-group-match: >first-name: >force-password-change: [disable, enable]>group: >hidden: >ips-filter:-ips-filter-name: >ipv6_trusthost1: >ipv6_trusthost10: >ipv6_trusthost2: >ipv6_trusthost3: >ipv6_trusthost4: >ipv6_trusthost5: >ipv6_trusthost6: >ipv6_trusthost7: >ipv6_trusthost8: >ipv6_trusthost9: >last-name: >ldap-server: >meta-data:-fieldlength: >fieldname: >fieldvalue: >importance: [optional, required]>status: [disabled, enabled]>mobile-number: >pager-number: >password: >password-expire: >phone-number: >policy-package:-policy-package-name: >profileid: >radius_server: >restrict-access: [disable, enable]>restrict-dev-vdom:-dev-vdom: >rpc-permit: [read-write, none, read]>ssh-public-key1: >ssh-public-key2: >ssh-public-key3: >subject: >tacacs-plus-server: >trusthost1: >trusthost10: >trusthost2: >trusthost3: >trusthost4: >trusthost5: >trusthost6: >trusthost7: >trusthost8: >trusthost9: >two-factor-auth: [disable, enable]>user_type: [local, radius, ldap,...]>userid: >web-filter:-web-filter-name: >wildcard: [disable, enable]>

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
code_réponsenombre entier toujours Le statut de la demande d'api
response_messagechaîne de caractères toujours Le message descriptif de la réponse de l'api.
Exemple : OK.

Auteurs

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