fortinet.fortios.fortios_vpn_ssl_web_host_check_software (2.3.6) — module

SSL-VPN host check software in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of fortinet.fortios"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_ssl_web feature and host_check_software category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: SSL-VPN host check software.
  fortinet.fortios.fortios_vpn_ssl_web_host_check_software:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      vpn_ssl_web_host_check_software:
          check_item_list:
              -
                  action: "require"
                  id: "5"
                  md5s:
                      -
                          id: "7"
                  target: "<your_own_value>"
                  type: "file"
                  version: "<your_own_value>"
          guid: "<your_own_value>"
          name: "default_name_12"
          os_type: "windows"
          type: "av"
          version: "<your_own_value>"

Inputs

    
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.
    type: str

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

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

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

vpn_ssl_web_host_check_software:
    default: null
    description:
    - SSL-VPN host check software.
    suboptions:
      check_item_list:
        description:
        - Check item list.
        elements: dict
        suboptions:
          action:
            choices:
            - require
            - deny
            description:
            - Action.
            type: str
          id:
            description:
            - ID (0 - 4294967295). see <a href='#notes'>Notes</a>.
            required: true
            type: int
          md5s:
            description:
            - MD5 checksum.
            elements: dict
            suboptions:
              id:
                description:
                - Hex string of MD5 checksum.
                required: true
                type: str
            type: list
          target:
            description:
            - Target.
            type: str
          type:
            choices:
            - file
            - registry
            - process
            description:
            - Type.
            type: str
          version:
            description:
            - Version.
            type: str
        type: list
      guid:
        description:
        - Globally unique ID.
        type: str
      name:
        description:
        - Name.
        required: true
        type: str
      os_type:
        choices:
        - windows
        - macos
        description:
        - OS type.
        type: str
      type:
        choices:
        - av
        - fw
        description:
        - Type.
        type: str
      version:
        description:
        - Version.
        type: str
    type: dict

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