lix_fortinet.fortios.fortios_system_external_resource (102.2.120) — module

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120

Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

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

Requirements

• ansible>=2.9

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure external resource.
    fortios_system_external_resource:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_external_resource:
        category: "0"
        comments: "<your_own_value>"
        interface: "<your_own_value> (source system.interface.name)"
        interface_select_method: "auto"
        name: "default_name_7"
        password: "<your_own_value>"
        refresh_rate: "5"
        resource: "<your_own_value>"
        server_identity_check: "none"
        source_ip: "84.230.14.43"
        status: "enable"
        type: "category"
        update_method: "feed"
        user_agent: "<your_own_value>"
        username: "<your_own_value>"
        uuid: "<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

system_external_resource:
    default: null
    description:
    - Configure external resource.
    suboptions:
      category:
        description:
        - User resource category.
        type: int
      comments:
        description:
        - Comment.
        type: str
      interface:
        description:
        - Specify outgoing interface to reach server. Source system.interface.name.
        type: str
      interface_select_method:
        choices:
        - auto
        - sdwan
        - specify
        description:
        - Specify how to select outgoing interface to reach server.
        type: str
      name:
        description:
        - External resource name.
        required: true
        type: str
      password:
        description:
        - HTTP basic authentication password.
        type: str
      refresh_rate:
        description:
        - Time interval to refresh external resource (1 - 43200 min).
        type: int
      resource:
        description:
        - URI of external resource.
        type: str
      server_identity_check:
        choices:
        - none
        - basic
        - full
        description:
        - Certificate verification option.
        type: str
      source_ip:
        description:
        - Source IPv4 address used to communicate with server.
        type: str
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable user resource.
        type: str
      type:
        choices:
        - category
        - address
        - domain
        - malware
        description:
        - User resource type.
        type: str
      update_method:
        choices:
        - feed
        - push
        description:
        - External resource update method.
        type: str
      user_agent:
        description:
        - HTTP User-Agent header .
        type: str
      username:
        description:
        - HTTP basic authentication user name.
        type: str
      uuid:
        description:
        - Universally Unique Identifier (UUID; automatically assigned but can be manually
          reset).
        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