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

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 endpoint_control feature and forticlient_ems category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

• 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 FortiClient Enterprise Management Server (EMS) entries.
    fortios_endpoint_control_forticlient_ems:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      endpoint_control_forticlient_ems:
        state: "present"
        address: "<your_own_value> (source firewall.address.name)"
        admin-password: "<your_own_value>"
        admin-type: "Windows"
        admin-username: "<your_own_value>"
        https-port: "7"
        listen-port: "8"
        name: "default_name_9"
        rest-api-auth: "disable"
        serial-number: "<your_own_value>"
        upload-port: "12"

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

endpoint_control_forticlient_ems:
    default: null
    description:
    - Configure FortiClient Enterprise Management Server (EMS) entries.
    suboptions:
      address:
        description:
        - Firewall address name. Source firewall.address.name.
      admin-password:
        description:
        - FortiClient EMS admin password.
      admin-type:
        choices:
        - Windows
        - LDAP
        description:
        - FortiClient EMS admin type.
      admin-username:
        description:
        - FortiClient EMS admin username.
      https-port:
        description:
        - 'FortiClient EMS HTTPS access port number. (1 - 65535, default: 443).'
      listen-port:
        description:
        - 'FortiClient EMS telemetry listen port number. (1 - 65535, default: 8013).'
      name:
        description:
        - FortiClient Enterprise Management Server (EMS) name.
        required: true
      rest-api-auth:
        choices:
        - disable
        - userpass
        description:
        - FortiClient EMS REST API authentication.
      serial-number:
        description:
        - FortiClient EMS Serial Number.
      state:
        choices:
        - present
        - absent
        description:
        - Indicates whether to create or remove the object
      upload-port:
        description:
        - 'FortiClient EMS telemetry upload port number. (1 - 65535, default: 8014).'

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