Note

Ce plugin fait partie du programme 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_wanprof_system_virtualwanlink.

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
adomchaîne de caractères / obligatoire le paramètre (adom) dans l'url demandée
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
wanprofchaîne de caractères / obligatoire le paramètre (wanprof) dans l'url demandée
wanprof_system_virtualwanlinkdictionnaire le jeu de paramètres de niveau supérieur
détection d'échecchaîne de caractères
    Choix :

  • désactiver
  • activer
Activez/désactivez la vérification de l'état de la connexion Internet du SD-WAN (détection des défaillances).
health-checkliste / elements=chaîne pas de description
_dynamic-serverchaîne de caractères pas de description
addr-modechaîne de caractères
    Choix :

  • ipv4
  • ipv6
Mode d'adressage (IPv4 ou IPv6).
failtimenombre entier Nombre d'échecs avant que le serveur soit considéré comme perdu (1 - 3600, par défaut = 5).
http-agentchaîne de caractères Chaîne de caractères dans le champ http-agent de l'en-tête HTTP.
http-getchaîne de caractères URL utilisée pour communiquer avec le serveur si le protocole si le protocole est HTTP.
http-matchchaîne de caractères Chaîne de réponse attendue du serveur si le protocole est HTTP.
intervallenombre entier Intervalle de vérification de l'état, ou le temps entre les tentatives de connexion au serveur (1 - 3600 sec, par défaut = 5).
membreschaîne de caractères Liste des numéros d'ordre des membres.
nomchaîne de caractères Nom du contrôle d'état ou du contrôle de santé.
taille du paquetnombre entier Taille des paquets d'une session de test de twamp,
mot de passechaîne de caractères pas de description
portnombre entier Numéro de port utilisé pour communiquer avec le serveur via le protocole sélectionné.
protocolechaîne de caractères
    Choix :

  • ping
  • tcp-echo
  • udp-echo
  • http
  • twamp
  • ping6
Protocole utilisé pour déterminer si le FortiGate peut communiquer avec le serveur.
délai de récupérationnombre entier Nombre de réponses réussies reçues avant que le serveur soit considéré comme récupéré (1 - 3600, par défaut = 5).
security-modechaîne de caractères
    Choix :

  • aucun
  • authentification
Mode de sécurité du contrôleur Twamp.
serveurchaîne de caractères pas de description
slaliste / elements=chaîne pas de description
idnombre entier ID SLA.
Seuil de giguenombre entier Gigue pour que le SLA prenne une décision en millisecondes. (0 - 10000000, par défaut = 5).
Seuil de latencenombre entier Latence pour que l'ANS prenne une décision en millisecondes. (0 - 10000000, par défaut = 5).
link-cost-factorliste / elements=chaîne
    Choix :

  • latence
  • gigue
  • perte de paquets
pas de description
seuil de perte de paquetsnombre entier Perte de paquets pour que le SLA prenne une décision en pourcentage. (0 - 100, par défaut = 0).
seuil-alert-jitternombre entier Seuil d'alerte pour la gigue (ms, par défaut = 0).
seuil d'alerte pour la giguenombre entier Seuil d'alerte pour la latence (ms, par défaut = 0).
threshold-alert-packetlossnombre entier Seuil d'alerte pour la perte de paquets (pourcentage, par défaut = 0).
seuil d'alerte pour la giguenombre entier Seuil d'alerte pour la gigue (ms, par défaut = 0).
seuil-alerte-latencenombre entier Seuil d'avertissement pour la latence (ms, par défaut = 0).
seuil-alerte-packetlossnombre entier Seuil d'avertissement pour la perte de paquets (pourcentage, par défaut = 0).
update-cascade-interfacechaîne de caractères
    Choix :

  • désactiver
  • activer
Activer/désactiver l'interface de mise à jour en cascade.
update-static-routechaîne de caractères
    Choix :

  • désactiver
  • activer
Active/désactive la mise à jour de la route statique.
load-balance-modechaîne de caractères
    Choix :

  • basé sur la source-ip
  • basé sur le poids
  • basé sur l'utilisation
  • basé sur la source-dest-ip
  • basé sur le volume mesuré
Algorithme ou mode à utiliser pour l'équilibrage de charge du trafic Internet vers les membres du SD-WAN.
membresliste / elements=chaîne pas de description
_dynamic-memberchaîne de caractères pas de description
commentairechaîne de caractères Commentaires.
passerellechaîne de caractères La passerelle par défaut pour cette interface. Habituellement, la passerelle par défaut du fournisseur de services Internet que cette interfa...
passerelle6chaîne de caractères Passerelle IPv6.
ingress-spillover-thresholdnombre entier Seuil de débordement d'entrée pour cette interface (0 - 16776000 kbit/s). Lorsque ce seuil de volume de trafic est atteint, n....
interfacechaîne de caractères Nom de l'interface.
prioriténombre entier Priorité de l'interface (0 - 4294967295). Utilisée pour les règles SD-WAN ou les règles de priorité.
seq-numnombre entier Numéro de séquence (1-255).
sourcechaîne de caractères Adresse IP source utilisée dans le paquet de contrôle de santé vers le serveur.
source6chaîne de caractères Adresse IPv6 source utilisée dans le paquet de contrôle de santé vers le serveur.
seuil de débordementnombre entier Seuil de débordement en sortie pour cette interface (0 - 16776000 kbit/s). Lorsque ce seuil de volume de trafic est atteint, ne...
étatchaîne de caractères
    Choix :

  • désactiver
  • activer
Activez/désactivez cette interface dans le SD-WAN.
volume-rationombre entier Rapport de volume mesuré (cette valeur / la somme de toutes les valeurs = pourcentage du volume du lien, 0 - 255).
poidsnombre entier Poids de cette interface pour l'équilibrage de charge pondéré. (0 - 255) Plus de trafic est dirigé vers les interfaces avec un poids plus élevé....
serviceliste / elements=chaîne pas de description
addr-modechaîne de caractères
    Choix :

  • ipv4
  • ipv6
Mode d'adressage (IPv4 ou IPv6).
bande passante-pondérationnombre entier Coefficient de réciprocité de la bande passante bidirectionnelle disponible dans la formule du profil personnalisé-1.
par défautchaîne de caractères
    Choix :

  • désactiver
  • activer
Activez/désactivez l'utilisation du SD-WAN comme service par défaut.
dscp-forwardchaîne de caractères
    Choix :

  • désactiver
  • activer
Activer/désactiver la balise DSCP du trafic de transfert.
dscp-forward-tagchaîne de caractères Balise DSCP pour le trafic de transfert.
dscp-reversechaîne de caractères
    Choix :

  • désactiver
  • activer
Activer/désactiver la balise DSCP du trafic inverse.
dscp-reverse-tagchaîne de caractères Balise DSCP du trafic inverse.
dstchaîne de caractères Nom de l'adresse de destination.
dst-negatechaîne de caractères
    Choix :

  • désactiver
  • activer
Activer/désactiver la négation de la correspondance de l'adresse de destination.
dst6chaîne de caractères Nom de l'adresse de destination6.
end-portentier Numéro du port de destination de fin.
passerellechaîne de caractères
    Choix :

  • désactiver
  • activer
Activez/désactivez la passerelle de service SD-WAN.
groupeschaîne de caractères Groupes d'utilisateurs.
contrôle de santéchaîne de caractères Contrôle de santé.
temps d'attentenombre entier Période d'attente en secondes lors du passage du membre de secours au membre principal (0 - 10000000, par défaut = 0).
idnombre entier ID de la règle de priorité (1 - 4000).
service internetchaîne de caractères
    Choix :

  • désactiver
  • activer
Activez/désactivez l'utilisation du service Internet pour l'équilibrage de charge basé sur les applications.
internet-service-ctrlnombre entier pas de description
internet-service-ctrl-groupchaîne de caractères Liste de groupes de services Internet basée sur le contrôle.
internet-service-customchaîne de caractères Liste de noms de services Internet personnalisés.
internet-service-custom-groupchaîne de caractères Liste de groupes de services Internet personnalisés.
internet-service-groupchaîne de caractères Liste des groupes de services Internet.
internet-service-idchaîne de caractères Liste des identifiants de services Internet.
poids de la giguenombre entier Coefficient de gigue dans la formule du profil personnalisé-1.
poids de latencenombre entier Coefficient de latence dans la formule du profil personnalisé-1.
Facteur de coût de liaisonchaîne de caractères
    Choix :

  • latence
  • gigue
  • perte de paquets
  • bande passante intérieure
  • largeur de bande sortante
  • bande passante bibandwidth
  • profil personnalisé-1
Facteur de coût des liens.
link-cost-thresholdnombre entier Pourcentage de changement de seuil des valeurs de coût de liaison qui entraînera la régénération de la route de la politique (0 - 10000000, par défaut =....
membrechaîne de caractères Numéro d'ordre du membre.
modechaîne de caractères
    Choix :

  • auto
  • manuel
  • priorité
  • sla
  • équilibrage de charge
Contrôlez comment la règle de priorité définit la priorité des interfaces dans le SD-WAN.
nomchaîne de caractères Nom de la règle de priorité.
poids de perte de paquetsnombre entier Coefficient de perte de paquets dans la formule du profil personnalisé-1.
priority-memberschaîne de caractères Liste des numéros d'ordre des membres.
protocolenombre entier Numéro de protocole.
lien de qualiténombre entier Lien de qualité.
route-tagnombre entier Carte de route IPv4 route-tag.
slaliste / elements=chaîne pas de description
contrôle de santéchaîne de caractères Contrôle de santé de la liaison WAN virtuelle.
idnombre entier ID DE L'ANS.
srcchaîne de caractères Nom de l'adresse de la source.
src-negatechaîne de caractères
    Choix :

  • désactiver
  • activer
Activer/désactiver la négation de la correspondance de l'adresse source.
src6chaîne de caractères Nom de l'adresse source6.
port de départentier Numéro du port de destination de départ.
statutchaîne de caractères
    Choix :

  • désactiver
  • activer
Activez/désactivez le service SD-WAN.
toschaîne de caractères Modèle binaire du type de service.
tos-maskchaîne de caractères Bits évalués du type de service.
utilisateurschaîne de caractères Nom de l'utilisateur.
statutchaîne de caractères
    Choix :

  • désactiver
  • activer
Activer/désactiver le SD-WAN.
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: Configure redundant internet connections using SD-WAN (formerly virtual WAN link).
     fmgr_wanprof_system_virtualwanlink:bypass_validation:Falseworkspace_locking_adom: [global, custom adom including root]>workspace_locking_timeout:300rc_succeeded:[0,-2,-3,...]rc_failed:[-2,-3,...]adom: >wanprof: >wanprof_system_virtualwanlink:fail-detect: [disable, enable]>health-check:-_dynamic-server: >addr-mode: [ipv4, ipv6]>failtime: >http-agent: >http-get: >http-match: >interval: >members: >name: >packet-size: >password: >port: >protocol: [ping, tcp-echo, udp-echo,...]>recoverytime: >security-mode: [none, authentication]>server: >sla:-id: >jitter-threshold: >latency-threshold: >link-cost-factor:- latency
                         - jitter
                         - packet-loss
                       packetloss-threshold: >threshold-alert-jitter: >threshold-alert-latency: >threshold-alert-packetloss: >threshold-warning-jitter: >threshold-warning-latency: >threshold-warning-packetloss: >update-cascade-interface: [disable, enable]>update-static-route: [disable, enable]>load-balance-mode: [source-ip-based, weight-based, usage-based,...]>members:-_dynamic-member: >comment: >gateway: >gateway6: >ingress-spillover-threshold: >interface: >priority: >seq-num: >source: >source6: >spillover-threshold: >status: [disable, enable]>volume-ratio: >weight: >service:-addr-mode: [ipv4, ipv6]>bandwidth-weight: >default: [disable, enable]>dscp-forward: [disable, enable]>dscp-forward-tag: >dscp-reverse: [disable, enable]>dscp-reverse-tag: >dst: >dst-negate: [disable, enable]>dst6: >end-port: >gateway: [disable, enable]>groups: >health-check: >hold-down-time: >id: >internet-service: [disable, enable]>internet-service-ctrl: >internet-service-ctrl-group: >internet-service-custom: >internet-service-custom-group: >internet-service-group: >internet-service-id: >jitter-weight: >latency-weight: >link-cost-factor: [latency, jitter, packet-loss,...]>link-cost-threshold: >member: >mode: [auto, manual, priority,...]>name: >packet-loss-weight: >priority-members: >protocol: >quality-link: >route-tag: >sla:-health-check: >id: >src: >src-negate: [disable, enable]>src6: >start-port: >status: [disable, enable]>tos: >tos-mask: >users: >status: [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 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)