Skip to content

Latest commit

 

History

History
417 lines (373 loc) · 18.4 KB

fortios_user_exchange.rst

File metadata and controls

417 lines (373 loc) · 18.4 KB
Raw
source:fortios_user_exchange.py
orphan:

fortios_user_exchange -- Configure MS Exchange server entries in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

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

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_user_exchange v6.2.0 -> latest

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - 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 default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • user_exchange - Configure MS Exchange server entries. type: dict more...
    Supported Version Ranges
    user_exchange v6.2.0 -> latest
    • auth_level - Authentication security level used for the RPC protocol layer. type: str choices: connect, call, packet, integrity, privacy more...
      Supported Version Ranges
      auth_level v6.2.0 -> latest
      [connect] v6.0.0 -> latest
      [call] v6.0.0 -> latest
      [packet] v6.0.0 -> latest
      [integrity] v6.0.0 -> latest
      [privacy] v6.0.0 -> latest
    • auth_type - Authentication security type used for the RPC protocol layer. type: str choices: spnego, ntlm, kerberos more...
      Supported Version Ranges
      auth_type v6.2.0 -> latest
      [spnego] v6.0.0 -> latest
      [ntlm] v6.0.0 -> latest
      [kerberos] v6.0.0 -> latest
    • auto_discover_kdc - Enable/disable automatic discovery of KDC IP addresses. type: str choices: enable, disable more...
      Supported Version Ranges
      auto_discover_kdc v6.4.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • connect_protocol - Connection protocol used to connect to MS Exchange service. type: str choices: rpc-over-tcp, rpc-over-http, rpc-over-https more...
      Supported Version Ranges
      connect_protocol v6.2.0 -> latest
      [rpc-over-tcp] v6.0.0 -> latest
      [rpc-over-http] v6.0.0 -> latest
      [rpc-over-https] v6.0.0 -> latest
    • domain_name - MS Exchange server fully qualified domain name. type: str more...
      Supported Version Ranges
      domain_name v6.2.0 -> latest
    • http_auth_type - Authentication security type used for the HTTP transport. type: str choices: basic, ntlm more...
      Supported Version Ranges
      http_auth_type v6.2.0 -> latest
      [basic] v6.0.0 -> latest
      [ntlm] v6.0.0 -> latest
    • ip - Server IPv4 address. type: str more...
      Supported Version Ranges
      ip v6.2.0 -> latest
    • kdc_ip - KDC IPv4 addresses for Kerberos authentication. type: list member_path: kdc_ip:ipv4 more...
      Supported Version Ranges
      kdc_ip v6.2.0 -> latest
      • ipv4 - KDC IPv4 addresses for Kerberos authentication. type: str required: true more...
        Supported Version Ranges
        ipv4 v6.2.0 -> latest
    • name - MS Exchange server entry name. type: str required: true more...
      Supported Version Ranges
      name v6.2.0 -> latest
    • password - Password for the specified username. type: str more...
      Supported Version Ranges
      password v6.2.0 -> latest
    • server_name - MS Exchange server hostname. type: str more...
      Supported Version Ranges
      server_name v6.2.0 -> latest
    • ssl_min_proto_version - Minimum SSL/TLS protocol version for HTTPS transport . type: str choices: default, SSLv3, TLSv1, TLSv1-1, TLSv1-2, TLSv1-3 more...
      Supported Version Ranges
      ssl_min_proto_version v6.2.0 -> latest
      [default] v6.0.0 -> latest
      [SSLv3] v6.0.0 -> latest
      [TLSv1] v6.0.0 -> latest
      [TLSv1-1] v6.0.0 -> latest
      [TLSv1-2] v6.0.0 -> latest
      [TLSv1-3] v7.4.1 -> latest
    • username - User name used to sign in to the server. Must have proper permissions for service. type: str more...
      Supported Version Ranges
      username v6.2.0 -> latest

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure MS Exchange server entries.
  fortinet.fortios.fortios_user_exchange:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_exchange:
          auth_level: "connect"
          auth_type: "spnego"
          auto_discover_kdc: "enable"
          connect_protocol: "rpc-over-tcp"
          domain_name: "<your_own_value>"
          http_auth_type: "basic"
          ip: "<your_own_value>"
          kdc_ip:
              -
                  ipv4: "<your_own_value>"
          name: "default_name_12"
          password: "<your_own_value>"
          server_name: "<your_own_value>"
          ssl_min_proto_version: "default"
          username: "<your_own_value>"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

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

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.