Ce tutoriel a été validé par nos experts afin que vous ayez la garantie de l'exactitude de notre post.
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_dvm_cmd_import_devlist
.
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 |
|
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. | |||
dvm_cmd_import_devlistdictionnaire | le jeu de paramètres de premier niveau | ||||
adomchaîne de caractères | Nom ou ID de l'ADOM sur lequel la commande doit être exécutée. | ||||
flagsliste / elements=chaîne |
|
pas de description | |||
import-adom-membresliste / elements=chaîne | pas de description | ||||
adomchaîne de caractères | ADOM cible auquel associer le VDOM du périphérique. | ||||
devchaîne de caractères | pas de description | ||||
vdomchaîne de caractères | pas de description | ||||
import-adomsliste / elements=string | pas de description | ||||
descchaîne de caractères | pas de description | ||||
drapeauxliste / elements=chaîne |
|
pas de description | |||
log_db_retention_hoursnombre entier | Par défaut : 1440 |
pas de description | |||
log_disk_quotanombre entier | pas de description | ||||
log_disk_quota_alert_thresnombre entier | Par défaut : 90 |
pas de description | |||
log_disk_quota_split_rationombre entier | Par défaut : 70 |
pas de description | |||
journal_fichier_rétention_heuresnombre entier | Par défaut : 8760 |
pas de description | |||
champs métadictionnaire | pas de description | ||||
mig_mrnombre entier | Par défaut : 2 |
pas de description | |||
mig_os_verchaîne de caractères |
|
pas de description | |||
modechaîne de caractères |
|
ems - (Valeur qui n'est plus utilisée à partir de 4.3)provider - Base de données globale. | |||
mrnombre entier | Par défaut : 2 |
pas de description | |||
nomchaîne de caractères | pas de description | ||||
os_verchaîne de caractères |
|
pas de description | |||
restreint_prdsliste / elements=string |
|
pas de description | |||
étatnombre entier | Par défaut : 1 |
pas de description | |||
uuidchaîne de caractères | pas de description | ||||
import-devicesliste / elements=chaîne | pas de description | ||||
adm_passchaîne de caractères | pas de description | ||||
adm_usrchaîne de caractères | pas de description | ||||
app_verchaîne de caractères | pas de description | ||||
av_verchaîne de caractères | pas de description | ||||
bêtanombre entier | pas de description | ||||
branch_ptnombre entier | pas de description | ||||
construirenombre entier | pas de description | ||||
somme de contrôlechaîne de caractères | pas de description | ||||
conf_statuschaîne de caractères |
|
pas de description | |||
conn_modechaîne de caractères |
|
pas de description | |||
conn_statuschaîne de caractères |
|
pas de description | |||
db_statuschaîne de caractères |
|
pas de description | |||
descchaîne de caractères | pas de description | ||||
dev_statuschaîne de caractères |
|
pas de description | |||
fap_cntnombre entier | pas de description | ||||
faz.full_actnombre entier | pas de description | ||||
faz.permnombre entier | pas de description | ||||
faz.quotanombre entier | pas de description | ||||
faz.utilisénombre entier | pas de description | ||||
fex_cntnombre entier | pas de description | ||||
drapeauxliste / elements=chaîne |
|
pas de description | |||
foslic_cpunombre entier | Nombre de vCPU du compteur de VM. | ||||
foslic_dr_sitechaîne de caractères |
|
État du site DR VM Meter. | |||
foslic_inst_timenombre entier | Heure du premier déploiement de VM Meter (en horodatage UNIX). | ||||
foslic_dernière_synchronombre entier | Heure de la dernière synchronisation du compteur VM (en timestamp UNIX). | ||||
foslic_ramnombre entier | Taille de la mémoire vive du périphérique VM Meter (en Mo). | ||||
foslic_typechaîne de caractères |
|
Type de licence VM Meter. | |||
foslic_utmliste / elements=string |
|
pas de description | |||
fsw_cntnombre entier | pas de description | ||||
ha_group_idnombre entier | pas de description | ||||
ha_group_namechaîne de caractères | pas de description | ||||
ha_modechaîne de caractères |
|
enabled - Valeur réservée aux dispositifs HA non-FOS. | |||
ha_slaveliste / elements=string | pas de description | ||||
idxnombre entier | pas de description | ||||
nomchaîne de caractères | pas de description | ||||
prionombre entier | pas de description | ||||
rôlechaîne de caractères |
|
pas de description | |||
snchaîne de caractères | pas de description | ||||
statutnombre entier | pas de description | ||||
hdisk_sizenombre entier | pas de description | ||||
nom d'hôtechaîne de caractères | pas de description | ||||
hw_rev_majornombre entier | pas de description | ||||
hw_rev_minornombre entier | pas de description | ||||
ipchaîne de caractères | pas de description | ||||
ips_extnombre entier | pas de description | ||||
ips_verchaîne de caractères | pas de description | ||||
last_checkednombre entier | pas de description | ||||
last_resyncnombre entier | pas de description | ||||
latitudechaîne de caractères | pas de description | ||||
lic_flagsnombre entier | pas de description | ||||
lic_regionchaîne de caractères | pas de description | ||||
location_fromchaîne de caractères | pas de description | ||||
logdisk_sizenombre entier | pas de description | ||||
longitudechaîne de caractères | pas de description | ||||
maxvdomnombre entier | Par défaut : 10 |
pas de description | |||
champs métadictionnaire | pas de description | ||||
mgmt_idnombre entier | pas de description | ||||
mgmt_ifchaîne de caractères | pas de description | ||||
mgmt_modechaîne de caractères |
|
pas de description | |||
mgt_vdomchaîne de caractères | pas de description | ||||
mrnombre entier | Par défaut : -1 |
pas de description | |||
nomchaîne de caractères | Nom unique pour le dispositif. | ||||
os_typechaîne de caractères |
|
pas de description | |||
os_verchaîne de caractères |
|
pas de description | |||
patchnombre entier | pas de description | ||||
plate-forme_strchaîne de caractères | pas de description | ||||
pskchaîne de caractères | pas de description | ||||
snchaîne de caractères | Valeur unique pour chaque appareil. | ||||
vdomliste / elements=string | pas de description | ||||
commentaireschaîne de caractères | pas de description | ||||
nomchaîne de caractères | pas de description | ||||
opmodechaîne de caractères |
|
pas de description | |||
rtm_prof_idnombre entier | pas de description | ||||
étatchaîne de caractères | pas de description | ||||
versionnombre entier | pas de description | ||||
vm_cpunombre entier | pas de description | ||||
vm_cpu_limitnombre entier | pas de description | ||||
vm_lic_expirenombre entier | pas de description | ||||
vm_memnombre entier | pas de description | ||||
vm_mem_limitnombre entier | pas de description | ||||
vm_statusnombre entier | pas de description | ||||
import-group-membersliste / elements=chaîne | pas de description | ||||
adomchaîne de caractères | ADOM où se trouve le groupe de périphériques. La valeur par défaut est "root" si elle n'est pas spécifiée. | ||||
devchaîne de caractères | pas de description | ||||
grpchaîne de caractères | Groupe de périphériques cible auquel associer le VDOM du périphérique. | ||||
vdomchaîne de caractères | pas de description | ||||
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. | ||||
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: Import a list of ADOMs and devices. fmgr_dvm_cmd_import_devlist:bypass_validation:Falseworkspace_locking_adom:[global, custom adom including root]>workspace_locking_timeout:300rc_succeeded:[0,-2,-3,...]rc_failed:[-2,-3,...]dvm_cmd_import_devlist:adom: >flags:- none - create_task - nonblocking - log_dev import-adom-members:-adom: >dev: >vdom: >import-adoms:-desc: >flags:- migration - db_export - no_vpn_console - backup - other_devices - central_sdwan - is_autosync - per_device_wtp - policy_check_on_install - install_on_policy_check_fail - auto_push_cfg log_db_retention_hours: >log_disk_quota: >log_disk_quota_alert_thres: >log_disk_quota_split_ratio: >log_file_retention_hours: >meta fields: >mig_mr: >mig_os_ver: [unknown,0.0,1.0,...]>mode: [ems, gms, provider]>mr: >name: >os_ver: [unknown,0.0,1.0,...]>restricted_prds:- fos - foc - fml - fch - fwb - log - fct - faz - fsa - fsw - fmg - fdd - fac - fpx state: >uuid: >import-devices:-adm_pass: >adm_usr: >app_ver: >av_ver: >beta: >branch_pt: >build: >checksum: >conf_status: [unknown, insync, outofsync]>conn_mode: [active, passive]>conn_status: [UNKNOWN, up, down]>db_status: [unknown, nomod, mod]>desc: >dev_status: [none, unknown, checkedin,...]>fap_cnt: >faz.full_act: >faz.perm: >faz.quota: >faz.used: >fex_cnt: >flags:- has_hdd - vdom_enabled - discover - reload - interim_build - offline_mode - is_model - fips_mode - linked_to_model - ip-conflict - faz-autosync foslic_cpu: >foslic_dr_site: [disable, enable]>foslic_inst_time: >foslic_last_sync: >foslic_ram: >foslic_type: [temporary, trial, regular,...]>foslic_utm:- fw - av - ips - app - url - utm - fwb fsw_cnt: >ha_group_id: >ha_group_name: >ha_mode: [standalone, AP, AA,...]>ha_slave:-idx: >name: >prio: >role: [slave, master]>sn: >status: >hdisk_size: >hostname: >hw_rev_major: >hw_rev_minor: >ip: >ips_ext: >ips_ver: >last_checked: >last_resync: >latitude: >lic_flags: >lic_region: >location_from: >logdisk_size: >longitude: >maxvdom: >meta fields: >mgmt_id: >mgmt_if: >mgmt_mode: [unreg, fmg, faz,...]>mgt_vdom: >mr: >name: >os_type: [unknown, fos, fsw,...]>os_ver: [unknown,0.0,1.0,...]>patch: >platform_str: >psk: >sn: >vdom:-comments: >name: >opmode: [nat, transparent]>rtm_prof_id: >status: >version: >vm_cpu: >vm_cpu_limit: >vm_lic_expire: >vm_mem: >vm_mem_limit: >vm_status: >import-group-members:-adom: >dev: >grp: >vdom: >
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 api. Exemple : OK. |
Auteurs
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)