fortinet.fortimanager.fmgr_user_local (2.4.0) — module

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

Scanned by Steampunk Spotter

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

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure local users.
      fortinet.fortimanager.fmgr_user_local:
        bypass_validation: false
        adom: ansible
        state: present
        user_local:
          id: 1
          name: ansible-test-local
          passwd: fortinet
          status: disable

Scanned by Steampunk Spotter

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

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the local users
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_local"
          params:
            adom: "ansible"
            local: "your_value"

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

user_local:
    description: The top level parameters set.
    required: false
    suboptions:
      auth-concurrent-override:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to auth_concurrent_override. Enable/disable
          overriding the policy-auth-concurrent under confi...
        type: str
      auth-concurrent-value:
        description: Deprecated, please rename it to auth_concurrent_value. 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: Deprecated, please rename it to email_to. Two-factor recipients email
          address.
        type: str
      fortitoken:
        description: Two-factor recipients FortiToken serial number.
        type: str
      history0:
        description: (list) No description.
        type: raw
      history1:
        description: (list) No description.
        type: raw
      id:
        description: User ID.
        type: int
      ldap-server:
        description: Deprecated, please rename it to ldap_server. Name of LDAP server
          with which the user must authenticate.
        type: str
      name:
        description: User name.
        required: true
        type: str
      passwd:
        description: (list) Users password.
        type: raw
      passwd-policy:
        description: Deprecated, please rename it to passwd_policy. Password policy to
          apply to this user, as defined in config user password-p...
        type: str
      ppk-identity:
        description: Deprecated, please rename it to ppk_identity. IKEv2 Postquantum Preshared
          Key Identity.
        type: str
      ppk-secret:
        description: (list) Deprecated, please rename it to ppk_secret. IKEv2 Postquantum
          Preshared Key
        type: raw
      qkd-profile:
        description: Deprecated, please rename it to qkd_profile. Quantum Key Distribution
        type: str
      radius-server:
        description: Deprecated, please rename it to radius_server. Name of RADIUS server
          with which the user must authenticate.
        type: str
      sms-custom-server:
        description: Deprecated, please rename it to sms_custom_server. Two-factor recipients
          SMS server.
        type: str
      sms-phone:
        description: Deprecated, please rename it to sms_phone. Two-factor recipients
          mobile phone number.
        type: str
      sms-server:
        choices:
        - fortiguard
        - custom
        description: Deprecated, please rename it to sms_server. Send SMS through FortiGuard
          or other external server.
        type: str
      status:
        choices:
        - disable
        - enable
        description: Enable/disable allowing the local user to authenticate with the FortiGate
          unit.
        type: str
      tacacs+-server:
        description: Deprecated, please rename it to tacacs__server. Name of TACACS+ server
          with which the user must authenticate.
        type: str
      two-factor:
        choices:
        - disable
        - fortitoken
        - email
        - sms
        - fortitoken-cloud
        description: Deprecated, please rename it to two_factor. Enable/disable two-factor
          authentication.
        type: str
      two-factor-authentication:
        choices:
        - fortitoken
        - email
        - sms
        description: Deprecated, please rename it to two_factor_authentication. Authentication
          method by FortiToken Cloud.
        type: str
      two-factor-notification:
        choices:
        - email
        - sms
        description: Deprecated, please rename it to two_factor_notification. Notification
          method for user activation by FortiToken Cloud.
        type: str
      type:
        choices:
        - password
        - radius
        - tacacs+
        - ldap
        description: Authentication method.
        type: str
      username-case-insensitivity:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to username_case_insensitivity. Enable/disable
          case sensitivity when performing username matching
        type: str
      username-case-sensitivity:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to username_case_sensitivity. Enable/disable
          case sensitivity when performing username matching
        type: str
      username-sensitivity:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to username_sensitivity. Enable/disable
          case and accent sensitivity when performing username ...
        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

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

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