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

Configure custom Internet Services 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 internet_service_custom 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 custom Internet Services.
    fortios_firewall_internet_service_custom:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      firewall_internet_service_custom:
        state: "present"
        comment: "Comment."
        disable-entry:
         -
            id:  "5"
            ip-range:
             -
                end-ip: "<your_own_value>"
                id:  "8"
                start-ip: "<your_own_value>"
            port: "10"
            protocol: "11"
        entry:
         -
            dst:
             -
                name: "default_name_14 (source firewall.address.name firewall.addrgrp.name)"
            id:  "15"
            port-range:
             -
                end-port: "17"
                id:  "18"
                start-port: "19"
            protocol: "20"
        master-service-id: "21 (source firewall.internet-service.id)"
        name: "default_name_22"

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: false
    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_internet_service_custom:
    default: null
    description:
    - Configure custom Internet Services.
    suboptions:
      comment:
        description:
        - Comment.
      disable-entry:
        description:
        - Disable entries in the Internet Service database.
        suboptions:
          id:
            description:
            - Disable entry ID.
            required: true
          ip-range:
            description:
            - IP ranges in the disable entry.
            suboptions:
              end-ip:
                description:
                - End IP address.
              id:
                description:
                - Disable entry range ID.
                required: true
              start-ip:
                description:
                - Start IP address.
          port:
            description:
            - Integer value for the TCP/IP port (0 - 65535).
          protocol:
            description:
            - Integer value for the protocol type as defined by IANA (0 - 255).
      entry:
        description:
        - Entries added to the Internet Service database and custom database.
        suboptions:
          dst:
            description:
            - Destination address or address group name.
            suboptions:
              name:
                description:
                - Select the destination address or address group object from available
                  options. Source firewall.address.name firewall .addrgrp.name.
                required: true
          id:
            description:
            - Entry ID(1-255).
            required: true
          port-range:
            description:
            - Port ranges in the custom entry.
            suboptions:
              end-port:
                description:
                - Integer value for ending TCP/UDP/SCTP destination port in range (1 to
                  65535).
              id:
                description:
                - Custom entry port range ID.
                required: true
              start-port:
                description:
                - Integer value for starting TCP/UDP/SCTP destination port in range (1
                  to 65535).
          protocol:
            description:
            - Integer value for the protocol type as defined by IANA (0 - 255).
      master-service-id:
        description:
        - Internet Service ID in the Internet Service database. Source firewall.internet-service.id.
      name:
        description:
        - Internet Service name.
        required: true
      state:
        choices:
        - present
        - absent
        description:
        - Indicates whether to create or remove the object

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