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

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
profil_administrateur_systèmedictionnaire le jeu de paramètres de premier niveau
adom-lockchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Verrouillage ADOMnone - Pas de permission.read - permission de lecture.read-write - permission de lecture-écriture.
adom-policy-packageschaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Paquets de politique ADOM.none - Pas d'autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
adom-switchchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Domaine de l'administrateur.none - Aucune autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
app-filterchaîne de caractères
    Choix :

  • désactiver
  • activer
App filter.disable - Paramètre de désactivation.enable - Paramètre d'activation.
affectationchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Affectation permission.none - Pas de permission.read - Lecture permission.read-write - Lecture-écriture permission.
change-passwordchaîne de caractères
    Choix :

  • désactiver
  • activer
Activer/désactiver l'utilisateur restreint pour changer son propre mot de passe.disable - Désactiver le paramètre.enable - Activer le paramètre.
config-retrievechaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Configuration retrieve.none - Aucune permission.read - Lecture permission.read-write - Lecture-écriture permission.
config-revertchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Rétablir la configuration à partir de l'historique des révisionsnone - Aucune permission.read - permission de lecture.read-write - permission de lecture-écriture.
contrôle de cohérencechaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Contrôle de cohérence.none - Aucune autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
masque de donnéeschaîne de caractères
    Choix :

  • désactiver
  • activer
Activer/désactiver le masquage des données.disable - Désactiver le masquage des données.enable - Activer le masquage des données.
datamask-custom-fieldsliste / elements=chaîne pas de description
catégorie de champliste / elements=chaîne
    Choix :

  • journal
  • fortiview
  • alerte
  • ueba
  • tout
pas de description
nom du champchaîne de caractères Nom du champ.
état du champchaîne de caractères
    Choix :

  • désactiver
  • activer
Champ status.disable - Champ désactivé.enable - Champ activé.
field-typechaîne de caractères
    Choix :

  • chaîne de caractères
  • ip
  • mac
  • email
  • inconnu
Type de champ.string - Chaîne.ip - IP.mac - Adresse MAC.email - Adresse email.unknown - Inconnu.
datamask-custom-prioritychaîne de caractères
    Choix :

  • désactiver
  • activer
Donner la priorité aux champs personnalisés.disable - Désactiver la priorité de recherche des champs personnalisés.enable - Activer la priorité de recherche des champs personnalisés.
datamask-fieldsliste / elements=chaîne
    Choix :

  • utilisateur
  • srcip
  • srcname
  • srcmac
  • dstip
  • dstname
  • email
  • message
  • domaine
pas de description
datamask-keychaîne de caractères pas de description
deploy-managementchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Installer sur les périphériques.none - Aucune autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
descriptionchaîne de caractères Description.
périphérique-apchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Gérer l'AP.none - Aucune autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
device-configchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Gérer les configurations des périphériques.none - Aucune autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
device-forticlientchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Gérer le FortiClient.none - Aucune autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
périphérique-fortiswitchchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Gérer le FortiSwitch.none - Aucune autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
device-managerchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Gestionnaire de périphériques.none - Aucune autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
device-opchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Ajout/suppression/modification de périphériques.none - Aucune autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
device-policy-package-lockchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Device/Policy Package lockingnone - Pas de permission.read - Permission de lecture.read-write - Permission de lecture-écriture.
profil de périphériquechaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Profil du dispositif permission.none - Pas de permission.read - Permission de lecture.read-write - Permission de lecture-écriture.
dispositif-révision-suppressionchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Supprimer la révision du dispositif.none - Aucune permission.read - Permission de lecture.read-write - Permission de lecture-écriture.
device-wan-link-load-balancechaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Gérer l'équilibrage de charge des liaisons WAN.none - Aucune permission.read - Permission de lecture.read-write - Permission de lecture-écriture.
gestion des événementschaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Gestion des événements.none - Aucune autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
fgd-center-advancedchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
FortiGuard Center Advanced.none - Aucune autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
fgd-center-fmw-mgmtchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Gestion du firmware du centre FortiGuard.none - Aucune autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
fgd-center-licensingchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
FortiGuard Center Licensing.none - Aucune autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
fgd_centerchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Centre FortiGuard.none - Aucune autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
global-policy-packageschaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Paquets de politique globale.none - Pas d'autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
import-policy-packageschaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Importer un paquet de politiques.none - Aucune autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
intf-mappingchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Interface Mappingnone - Aucune permission.read - Lecture permission.read-write - Lecture-écriture permission.
ips-filterchaîne de caractères
    Choix :

  • désactiver
  • activer
Filtre IPS.disable - Paramètre de désactivation.enable - Paramètre d'activation.
log-viewerchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Log viewer.none - Aucune autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
objets de la politiquechaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Objets de politique permission.none - Aucune permission.read - Lecture permission.read-write - Lecture-écriture permission.
profileidchaîne de caractères ID du profil.
read-passwdchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Afficher le mot de passe en clair.none - Aucune autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
realtime-monitorchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Moniteur en temps réel.none - Aucune autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
report-viewerchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Visionneuse de rapports.none - Aucune autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
scopechaîne de caractères
    Choix :

  • global
  • adom
Scope.global - Scope global.adom - Scope ADOM.
set-install-targetschaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Modifier les cibles d'installation.none - Aucune autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
system-settingchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Paramètres du système.none - Pas de permission.read - Permission de lecture.read-write - Permission de lecture-écriture.
term-accesschaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Accès au terminal.none - Aucune autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
typechaîne de caractères
    Choix :

  • système
  • restreint
profil type.system - System admin.restricted - Restricted admin.
vpn-managerchaîne de caractères
    Choix :

  • aucun
  • lire
  • lecture-écriture
Gestionnaire VPN.none - Aucune autorisation.read - Autorisation de lecture.read-write - Autorisation de lecture-écriture.
web-filterchaîne de caractères
    Choix :

  • désactiver
  • activer
Filtre Web.disable - Paramètre de désactivation.enable - Paramètre d'activation.
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 pour 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 profile.
     fmgr_system_admin_profile: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_profile:adom-lock: [none, read, read-write]>adom-policy-packages: [none, read, read-write]>adom-switch: [none, read, read-write]>app-filter: [disable, enable]>assignment: [none, read, read-write]>change-password: [disable, enable]>config-retrieve: [none, read, read-write]>config-revert: [none, read, read-write]>consistency-check: [none, read, read-write]>datamask: [disable, enable]>datamask-custom-fields:-field-category:- log
                   - fortiview
                   - alert
                   - ueba
                   - all
                 field-name: >field-status: [disable, enable]>field-type: [string, ip, mac,...]>datamask-custom-priority: [disable, enable]>datamask-fields:- user
             - srcip
             - srcname
             - srcmac
             - dstip
             - dstname
             - email
             - message
             - domain
           datamask-key: >deploy-management: [none, read, read-write]>description: >device-ap: [none, read, read-write]>device-config: [none, read, read-write]>device-forticlient: [none, read, read-write]>device-fortiswitch: [none, read, read-write]>device-manager: [none, read, read-write]>device-op: [none, read, read-write]>device-policy-package-lock: [none, read, read-write]>device-profile: [none, read, read-write]>device-revision-deletion: [none, read, read-write]>device-wan-link-load-balance: [none, read, read-write]>event-management: [none, read, read-write]>fgd-center-advanced: [none, read, read-write]>fgd-center-fmw-mgmt: [none, read, read-write]>fgd-center-licensing: [none, read, read-write]>fgd_center: [none, read, read-write]>global-policy-packages: [none, read, read-write]>import-policy-packages: [none, read, read-write]>intf-mapping: [none, read, read-write]>ips-filter: [disable, enable]>log-viewer: [none, read, read-write]>policy-objects: [none, read, read-write]>profileid: >read-passwd: [none, read, read-write]>realtime-monitor: [none, read, read-write]>report-viewer: [none, read, read-write]>scope: [global, adom]>set-install-targets: [none, read, read-write]>system-setting: [none, read, read-write]>term-access: [none, read, read-write]>type: [system, restricted]>vpn-manager: [none, read, read-write]>web-filter: [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
response_codenombre 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)