Nota

Este complemento es parte del colección fortinet.fortimanager (versión 2.0.1).

Para instalarlo use: ansible-galaxy collection install fortinet.fortimanager.

Para usarlo en un libro de jugadas, especifique: fortinet.fortimanager.fmgr_system_backup_allsettings.

Nuevo en la versión 2.10: de fortinet.fortimanager

  • Sinopsis
  • Parámetros
  • Notas
  • Ejemplos de
  • Valores devueltos

Sinopsis

  • Este módulo puede configurar un dispositivo FortiManager.
  • Los ejemplos incluyen todos los parámetros y valores que deben ajustarse a las fuentes de datos antes de su uso.

Parámetros

Parámetro Opciones / Valores predeterminados Comentarios
bypass_validationbooleano
    Opciones:

  • no ←
  • sí
 solo se establece en True cuando el esquema del módulo difiere con la estructura de la API de FortiManager, el módulo continúa ejecutándose sin validar los parámetros
rc_failedlista / elementos =string la lista de códigos rc con la que se anularán las condiciones para fallar
rc_succeededlista / elementos =string la lista de códigos rc con la que se anularán las condiciones para tener éxito
estadostring / requerido
    Opciones:

  • regalo
  • ausente
 la directiva para crear, actualizar o eliminar un objeto
system_backup_allsettingsdiccionario el conjunto de parámetros de nivel superior
certstring Certificado SSH para autenticación.
crptpasswdstring Sin descripción
directoriostring Directorio en el que se almacenará el archivo en el servidor de respaldo.
passwdstring Sin descripción
protocolostring
    Opciones:

  • sftp ←
  • ftp
  • scp
 Protocolo utilizado para backup.sftp – SFTP.ftp – FTP.scp – SCP.
servidorstring Nombre / IP del servidor de respaldo.
estadostring
    Opciones:

  • desactivar ←
  • habilitar
 Habilitar / deshabilitar la copia de seguridad programada. Deshabilitar: deshabilitar la configuración. Habilitar: habilitar la configuración.
tiempostring Es hora de hacer copias de seguridad.
usuariostring Usuario de inicio de sesión del servidor de respaldo.
días_de_semanalista / elementos =string
    Opciones:

  • lunes
  • martes
  • miércoles
  • jueves
  • viernes
  • sábado
  • domingo
 Sin descripción
workpace_locking_adomstring el adom para bloquear para FortiManager que se ejecuta en modo de espacio de trabajo, el valor puede ser global y otros, incluido el root
workpace_locking_timeoutentero Defecto:
300		 el tiempo máximo en segundos para esperar a que otro usuario libere el bloqueo del espacio de trabajo

Notas

Nota

  • La ejecución en modo de bloqueo del espacio de trabajo es compatible con este módulo de FortiManager, los parámetros de nivel superior workspace_locking_adom y workspace_locking_timeout ayudan a hacer el trabajo.
  • Para crear o actualizar un objeto, use la directiva state present.
  • Para eliminar un objeto, use la directiva de ausencia de estado.
  • Normalmente, la ejecución de un módulo puede fallar cuando se devuelve un rc distinto de cero. también puede anular las condiciones para fallar o tener éxito con los parámetros rc_failed y rc_succeeded

Ejemplos de

-hosts: fortimanager-inventory
  collections:- fortinet.fortimanager
  connection: httpapi
  vars:ansible_httpapi_use_ssl:Trueansible_httpapi_validate_certs:Falseansible_httpapi_port:443tasks:-name: Scheduled backup settings.
     fmgr_system_backup_allsettings:bypass_validation:Falseworkspace_locking_adom: [global, custom adom including root]>workspace_locking_timeout:300rc_succeeded:[0,-2,-3,...]rc_failed:[-2,-3,...]system_backup_allsettings:cert: >crptpasswd: >directory: >passwd: >protocol: [sftp, ftp, scp]>server: >status: [disable, enable]>time: >user: >week_days:- monday
             - tuesday
             - wednesday
             - thursday
             - friday
             - saturday
             - sunday

Valores devueltos

Los valores de retorno comunes están documentados aquí, los siguientes son los campos exclusivos de este módulo:

Llave Devuelto Descripción
request_urlstring siempre La URL completa solicitada
Muestra:/ sys / login / usuario
código de respuestaentero siempre El estado de la solicitud de API
mensaje_respuestastring siempre El mensaje descriptivo de la respuesta de la API
Muestra:está bien.

Autores

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