fortinet.fortios.fortios_endpoint_control_fctems (1.1.7) — module

Configure FortiClient Enterprise Management Server (EMS) entries in Fortinet's FortiOS and FortiGate.

| "added in version" 2.9 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:==1.1.7


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 1.1.7

Description

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


Requirements

Usage examples

  • 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 FortiClient Enterprise Management Server (EMS) entries.
    fortios_endpoint_control_fctems:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      endpoint_control_fctems:
        call_timeout: "3"
        certificate: "<your_own_value> (source certificate.remote.name)"
        cloud_server_type: "production"
        fortinetone_cloud_authentication: "enable"
        https_port: "7"
        name: "default_name_8"
        pull_avatars: "enable"
        pull_sysinfo: "enable"
        pull_tags: "enable"
        pull_vulnerabilities: "enable"
        server: "192.168.100.40"
        source_ip: "84.230.14.43"

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

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

endpoint_control_fctems:
    default: null
    description:
    - Configure FortiClient Enterprise Management Server (EMS) entries.
    suboptions:
      call_timeout:
        description:
        - FortiClient EMS call timeout in milliseconds (500 - 50000 milliseconds).
        type: int
      certificate:
        description:
        - FortiClient EMS certificate. Source certificate.remote.name.
        type: str
      cloud_server_type:
        choices:
        - production
        - alpha
        - beta
        description:
        - Cloud server type.
        type: str
      fortinetone_cloud_authentication:
        choices:
        - enable
        - disable
        description:
        - Enable/disable authentication of FortiClient EMS Cloud through FortiCloud account.
        type: str
      https_port:
        description:
        - FortiClient EMS HTTPS access port number. (1 - 65535).
        type: int
      name:
        description:
        - FortiClient Enterprise Management Server (EMS) name.
        required: true
        type: str
      pull_avatars:
        choices:
        - enable
        - disable
        description:
        - Enable/disable pulling avatars from EMS.
        type: str
      pull_sysinfo:
        choices:
        - enable
        - disable
        description:
        - Enable/disable pulling SysInfo from EMS.
        type: str
      pull_tags:
        choices:
        - enable
        - disable
        description:
        - Enable/disable pulling FortiClient user tags from EMS.
        type: str
      pull_vulnerabilities:
        choices:
        - enable
        - disable
        description:
        - Enable/disable pulling vulnerabilities from EMS.
        type: str
      server:
        description:
        - FortiClient EMS FQDN or IPv4 address.
        type: str
      source_ip:
        description:
        - REST API call source IP.
        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