ansible.builtin.fortios_firewall_profile_group (v2.8.20) — module

Configure profile groups in Fortinet's FortiOS and FortiGate.

| "added in version" 2.8 of ansible.builtin"

Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

This module is able to configure a FortiGate or FortiOS by allowing the user to configure firewall feature and profile_group category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure profile groups.
    fortios_firewall_profile_group:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      firewall_profile_group:
        state: "present"
        application-list: "<your_own_value> (source application.list.name)"
        av-profile: "<your_own_value> (source antivirus.profile.name)"
        dlp-sensor: "<your_own_value> (source dlp.sensor.name)"
        dnsfilter-profile: "<your_own_value> (source dnsfilter.profile.name)"
        icap-profile: "<your_own_value> (source icap.profile.name)"
        ips-sensor: "<your_own_value> (source ips.sensor.name)"
        name: "default_name_9"
        profile-protocol-options: "<your_own_value> (source firewall.profile-protocol-options.name)"
        spamfilter-profile: "<your_own_value> (source spamfilter.profile.name)"
        ssh-filter-profile: "<your_own_value> (source ssh-filter.profile.name)"
        ssl-ssh-profile: "<your_own_value> (source firewall.ssl-ssh-profile.name)"
        voip-profile: "<your_own_value> (source voip.profile.name)"
        waf-profile: "<your_own_value> (source waf.profile.name)"
        webfilter-profile: "<your_own_value> (source webfilter.profile.name)"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip address.
    required: true

vdom:
    default: root
    description:
    - Virtual domain, among those defined previously. A vdom is a virtual instance of
      the FortiGate that can be configured and used as a different unit.

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.

username:
    description:
    - FortiOS or FortiGate username.
    required: true

firewall_profile_group:
    default: null
    description:
    - Configure profile groups.
    suboptions:
      application-list:
        description:
        - Name of an existing Application list. Source application.list.name.
      av-profile:
        description:
        - Name of an existing Antivirus profile. Source antivirus.profile.name.
      dlp-sensor:
        description:
        - Name of an existing DLP sensor. Source dlp.sensor.name.
      dnsfilter-profile:
        description:
        - Name of an existing DNS filter profile. Source dnsfilter.profile.name.
      icap-profile:
        description:
        - Name of an existing ICAP profile. Source icap.profile.name.
      ips-sensor:
        description:
        - Name of an existing IPS sensor. Source ips.sensor.name.
      name:
        description:
        - Profile group name.
        required: true
      profile-protocol-options:
        description:
        - Name of an existing Protocol options profile. Source firewall.profile-protocol-options.name.
      spamfilter-profile:
        description:
        - Name of an existing Spam filter profile. Source spamfilter.profile.name.
      ssh-filter-profile:
        description:
        - Name of an existing SSH filter profile. Source ssh-filter.profile.name.
      ssl-ssh-profile:
        description:
        - Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name.
      state:
        choices:
        - present
        - absent
        description:
        - Indicates whether to create or remove the object
      voip-profile:
        description:
        - Name of an existing VoIP profile. Source voip.profile.name.
      waf-profile:
        description:
        - Name of an existing Web application firewall profile. Source waf.profile.name.
      webfilter-profile:
        description:
        - Name of an existing Web filter profile. Source webfilter.profile.name.

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str