fortinet.fortimanager.fmgr_user_exchange (2.4.0) — module

Configure MS Exchange server entries.

| "added in version" 2.1.0 of fortinet.fortimanager"

Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0


Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

Description

This module is able to configure a FortiManager device.

Examples include all parameters and values which need to be adjusted to data sources before usage.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure MS Exchange server entries.
      fortinet.fortimanager.fmgr_user_exchange:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        user_exchange:
          addr_type: <value in [ipv4, ipv6]>
          auth_level: <value in [low, medium, normal, ...]>
          auth_type: <value in [spnego, ntlm, kerberos]>
          connect_protocol: <value in [rpc-over-tcp, rpc-over-http, rpc-over-https]>
          domain_name: <string>
          http_auth_type: <value in [ntlm, basic]>
          ip: <string>
          ip6: <string>
          kdc_ip: <list or string>
          name: <string>
          password: <list or string>
          server_name: <string>
          ssl_min_proto_version: <value in [default, TLSv1-1, TLSv1-2, ...]>
          username: <string>
          auto_discover_kdc: <value in [disable, enable]>

Inputs

    
adom:
    description: The parameter (adom) in requested url.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    type: list

user_exchange:
    description: The top level parameters set.
    required: false
    suboptions:
      addr-type:
        choices:
        - ipv4
        - ipv6
        description: Deprecated, please rename it to addr_type. Indicate whether the server
          IP-address is IPv4 or IPv6.
        type: str
      auth-level:
        choices:
        - low
        - medium
        - normal
        - high
        - connect
        - call
        - packet
        - integrity
        - privacy
        description: Deprecated, please rename it to auth_level. Authentication security
          level used for the RPC protocol layer.
        type: str
      auth-type:
        choices:
        - spnego
        - ntlm
        - kerberos
        description: Deprecated, please rename it to auth_type. Authentication security
          type used for the RPC protocol layer.
        type: str
      auto-discover-kdc:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to auto_discover_kdc. Enable/disable
          automatic discovery of KDC IP addresses.
        type: str
      connect-protocol:
        choices:
        - rpc-over-tcp
        - rpc-over-http
        - rpc-over-https
        description: Deprecated, please rename it to connect_protocol. Connection protocol
          used to connect to MS Exchange service.
        type: str
      domain-name:
        description: Deprecated, please rename it to domain_name. MS Exchange server fully
          qualified domain name.
        type: str
      http-auth-type:
        choices:
        - ntlm
        - basic
        description: Deprecated, please rename it to http_auth_type. Authentication security
          type used for the HTTP transport.
        type: str
      ip:
        description: Server IPv4 address.
        type: str
      ip6:
        description: Server IPv6 address.
        type: str
      kdc-ip:
        description: (list) Deprecated, please rename it to kdc_ip. KDC IPv4 addresses
          for Kerberos authentication.
        type: raw
      name:
        description: MS Exchange server entry name.
        required: true
        type: str
      password:
        description: (list) Password for the specified username.
        type: raw
      server-name:
        description: Deprecated, please rename it to server_name. MS Exchange server hostname.
        type: str
      ssl-min-proto-version:
        choices:
        - default
        - TLSv1-1
        - TLSv1-2
        - SSLv3
        - TLSv1
        - TLSv1-3
        description: Deprecated, please rename it to ssl_min_proto_version. Minimum SSL/TLS
          protocol version for HTTPS transport
        type: str
      username:
        description: User name used to sign in to the server.
        type: str
    type: dict

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    type: bool

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    type: int

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list