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

Show Internet Service application 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 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: Show Internet Service application.
    fortios_firewall_internet_service:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      firewall_internet_service:
        state: "present"
        database: "isdb"
        direction: "src"
        entry:
         -
            id:  "6"
            ip-number: "7"
            ip-range-number: "8"
            port: "9"
            protocol: "10"
        icon-id: "11"
        id:  "12"
        name: "default_name_13"
        offset: "14"
        reputation: "15"
        sld-id: "16"

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:
    default: null
    description:
    - Show Internet Service application.
    suboptions:
      database:
        choices:
        - isdb
        - irdb
        description:
        - Database name this Internet Service belongs to.
      direction:
        choices:
        - src
        - dst
        - both
        description:
        - How this service may be used in a firewall policy (source, destination or both).
      entry:
        description:
        - Entries in the Internet Service database.
        suboptions:
          id:
            description:
            - Entry ID.
            required: true
          ip-number:
            description:
            - Total number of IP addresses.
          ip-range-number:
            description:
            - Total number of IP ranges.
          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).
      icon-id:
        description:
        - Icon ID of Internet Service.
      id:
        description:
        - Internet Service ID.
        required: true
      name:
        description:
        - Internet Service name.
      offset:
        description:
        - Offset of Internet Service ID.
      reputation:
        description:
        - Reputation level of the Internet Service.
      sld-id:
        description:
        - Second Level Domain.
      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