fortinet.fortios.fortios_user_local (2.3.6) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

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

Requirements

• ansible>=2.15

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Configure local users.
  fortinet.fortios.fortios_user_local:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_local:
          auth_concurrent_override: "enable"
          auth_concurrent_value: "0"
          authtimeout: "0"
          email_to: "<your_own_value>"
          fortitoken: "<your_own_value> (source user.fortitoken.serial-number)"
          id: "8"
          ldap_server: "<your_own_value> (source user.ldap.name)"
          name: "default_name_10"
          passwd: "<your_own_value>"
          passwd_policy: "<your_own_value> (source user.password-policy.name)"
          passwd_time: "<your_own_value>"
          ppk_identity: "<your_own_value>"
          ppk_secret: "<your_own_value>"
          qkd_profile: "<your_own_value> (source vpn.qkd.name)"
          radius_server: "<your_own_value> (source user.radius.name)"
          sms_custom_server: "<your_own_value> (source system.sms-server.name)"
          sms_phone: "<your_own_value>"
          sms_server: "fortiguard"
          status: "enable"
          tacacs_plus_server: "<your_own_value> (source user.tacacs+.name)"
          two_factor: "disable"
          two_factor_authentication: "fortitoken"
          two_factor_notification: "email"
          type: "password"
          username_case_sensitivity: "disable"
          username_sensitivity: "disable"
          workstation: "<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

user_local:
    default: null
    description:
    - Configure local users.
    suboptions:
      auth_concurrent_override:
        choices:
        - enable
        - disable
        description:
        - Enable/disable overriding the policy-auth-concurrent under config system global.
        type: str
      auth_concurrent_value:
        description:
        - Maximum number of concurrent logins permitted from the same user.
        type: int
      authtimeout:
        description:
        - Time in minutes before the authentication timeout for a user is reached.
        type: int
      email_to:
        description:
        - Two-factor recipient"s email address.
        type: str
      fortitoken:
        description:
        - Two-factor recipient"s FortiToken serial number. Source user.fortitoken.serial-number.
        type: str
      id:
        description:
        - User ID.
        type: int
      ldap_server:
        description:
        - Name of LDAP server with which the user must authenticate. Source user.ldap.name.
        type: str
      name:
        description:
        - Local user name.
        required: true
        type: str
      passwd:
        description:
        - User"s password.
        type: str
      passwd_policy:
        description:
        - Password policy to apply to this user, as defined in config user password-policy.
          Source user.password-policy.name.
        type: str
      passwd_time:
        description:
        - Time of the last password update.
        type: str
      ppk_identity:
        description:
        - IKEv2 Postquantum Preshared Key Identity.
        type: str
      ppk_secret:
        description:
        - IKEv2 Postquantum Preshared Key (ASCII string or hexadecimal encoded with a
          leading 0x).
        type: str
      qkd_profile:
        description:
        - Quantum Key Distribution (QKD) profile. Source vpn.qkd.name.
        type: str
      radius_server:
        description:
        - Name of RADIUS server with which the user must authenticate. Source user.radius.name.
        type: str
      sms_custom_server:
        description:
        - Two-factor recipient"s SMS server. Source system.sms-server.name.
        type: str
      sms_phone:
        description:
        - Two-factor recipient"s mobile phone number.
        type: str
      sms_server:
        choices:
        - fortiguard
        - custom
        description:
        - Send SMS through FortiGuard or other external server.
        type: str
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable allowing the local user to authenticate with the FortiGate unit.
        type: str
      tacacs_plus_server:
        description:
        - Name of TACACS+ server with which the user must authenticate. Source user.tacacs+.name.
        type: str
      two_factor:
        choices:
        - disable
        - fortitoken
        - fortitoken-cloud
        - email
        - sms
        description:
        - Enable/disable two-factor authentication.
        type: str
      two_factor_authentication:
        choices:
        - fortitoken
        - email
        - sms
        description:
        - Authentication method by FortiToken Cloud.
        type: str
      two_factor_notification:
        choices:
        - email
        - sms
        description:
        - Notification method for user activation by FortiToken Cloud.
        type: str
      type:
        choices:
        - password
        - radius
        - tacacs+
        - ldap
        description:
        - Authentication method.
        type: str
      username_case_sensitivity:
        choices:
        - disable
        - enable
        description:
        - Enable/disable case sensitivity when performing username matching (uppercase
          and lowercase letters are treated either as distinct or equivalent).
        type: str
      username_sensitivity:
        choices:
        - disable
        - enable
        description:
        - Enable/disable case and accent sensitivity when performing username matching
          (accents are stripped and case is ignored when disabled).
        type: str
      workstation:
        description:
        - Name of the remote user workstation, if you want to limit the user to authenticate
          only from a particular workstation.
        type: str
    type: dict

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

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