chillancezen.fortimanager.fmgr_export_playbooks (2.1.6) — module

Export fortimanager configuration as playbooks.

| "added in version" 1.0.0 of chillancezen.fortimanager"

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

preview | supported by community

Install collection

Install with ansible-galaxy collection install chillancezen.fortimanager:==2.1.6


Add to requirements.yml

  collections:
    - name: chillancezen.fortimanager
      version: 2.1.6

Description

This module is able to configure a FortiManager device.

Examples include all parameters and values which need to be adjusted to data sources before usage.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: Export Playbooks
     fmgr_export_playbooks:
        export_playbooks:
            selector:
                - all
            path: './exported'
            params:
                all:
                  adom: root

Inputs

    
enable_log:
    default: false
    description: Enable/Disable logging for task
    required: false
    type: bool

export_playbooks:
    description: the top level parameters set
    required: false
    type: dict

workspace_locking_adom:
    description: the adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root
    required: false
    type: str

workspace_locking_timeout:
    default: 300
    description: the maximum time in seconds to wait for other user to release the workspace
      lock
    required: false
    type: int

Outputs

request_url:
  description: The full url requested
  returned: always
  sample: /sys/login/user
  type: str
response_code:
  description: The status of api request
  returned: always
  sample: 0
  type: int
response_message:
  description: The descriptive message of the api response
  returned: always
  sample: OK.
  type: str