lix_fortinet.fortios.fortios_user_exchange (102.2.120) — module

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

| "added in version" 2.0.0 of lix_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 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 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

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 MS Exchange server entries.
    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>"

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

user_exchange:
    default: null
    description:
    - Configure MS Exchange server entries.
    suboptions:
      auth_level:
        choices:
        - connect
        - call
        - packet
        - integrity
        - privacy
        description:
        - Authentication security level used for the RPC protocol layer.
        type: str
      auth_type:
        choices:
        - spnego
        - ntlm
        - kerberos
        description:
        - Authentication security type used for the RPC protocol layer.
        type: str
      auto_discover_kdc:
        choices:
        - enable
        - disable
        description:
        - Enable/disable automatic discovery of KDC IP addresses.
        type: str
      connect_protocol:
        choices:
        - rpc-over-tcp
        - rpc-over-http
        - rpc-over-https
        description:
        - Connection protocol used to connect to MS Exchange service.
        type: str
      domain_name:
        description:
        - MS Exchange server fully qualified domain name.
        type: str
      http_auth_type:
        choices:
        - basic
        - ntlm
        description:
        - Authentication security type used for the HTTP transport.
        type: str
      ip:
        description:
        - Server IPv4 address.
        type: str
      kdc_ip:
        description:
        - KDC IPv4 addresses for Kerberos authentication.
        elements: dict
        suboptions:
          ipv4:
            description:
            - KDC IPv4 addresses for Kerberos authentication.
            type: str
        type: list
      name:
        description:
        - MS Exchange server entry name.
        required: true
        type: str
      password:
        description:
        - Password for the specified username.
        type: str
      server_name:
        description:
        - MS Exchange server hostname.
        type: str
      ssl_min_proto_version:
        choices:
        - default
        - SSLv3
        - TLSv1
        - TLSv1-1
        - TLSv1-2
        description:
        - Minimum SSL/TLS protocol version for HTTPS transport .
        type: str
      username:
        description:
        - User name used to sign in to the server. Must have proper permissions for service.
        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