fortinet.fortimanager.fmgr_user_tacacs (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 (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 TACACS+ server entries.
      fortinet.fortimanager.fmgr_user_tacacs:
        # 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_tacacs:
          authen_type: <value in [auto, ascii, pap, ...]>
          authorization: <value in [disable, enable]>
          dynamic_mapping:
            -
              _scope:
                -
                  name: <string>
                  vdom: <string>
              authen_type: <value in [auto, ascii, pap, ...]>
              authorization: <value in [disable, enable]>
              key: <list or string>
              port: <integer>
              secondary_key: <list or string>
              secondary_server: <string>
              server: <string>
              source_ip: <string>
              tertiary_key: <list or string>
              tertiary_server: <string>
              interface: <string>
              interface_select_method: <value in [auto, sdwan, specify]>
          key: <list or string>
          name: <string>
          port: <integer>
          secondary_key: <list or string>
          secondary_server: <string>
          server: <string>
          source_ip: <string>
          tertiary_key: <list or string>
          tertiary_server: <string>
          interface: <string>
          interface_select_method: <value in [auto, sdwan, specify]>

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_tacacs:
    description: The top level parameters set.
    required: false
    suboptions:
      authen-type:
        choices:
        - auto
        - ascii
        - pap
        - chap
        - mschap
        description: Deprecated, please rename it to authen_type. Allowed authentication
          protocols/methods.
        type: str
      authorization:
        choices:
        - disable
        - enable
        description: Enable/disable TACACS+ authorization.
        type: str
      dynamic_mapping:
        description: Dynamic_Mapping.
        elements: dict
        suboptions:
          _scope:
            description: _Scope.
            elements: dict
            suboptions:
              name:
                description: Name.
                type: str
              vdom:
                description: Vdom.
                type: str
            type: list
          authen-type:
            choices:
            - auto
            - ascii
            - pap
            - chap
            - mschap
            description: Deprecated, please rename it to authen_type. Allowed authentication
              protocols/methods.
            type: str
          authorization:
            choices:
            - disable
            - enable
            description: Enable/disable TACACS+ authorization.
            type: str
          interface:
            description: Specify outgoing interface to reach server.
            type: str
          interface-select-method:
            choices:
            - auto
            - sdwan
            - specify
            description: Deprecated, please rename it to interface_select_method. Specify
              how to select outgoing interface to reach server.
            type: str
          key:
            description: (list) Key to access the primary server.
            type: raw
          port:
            description: Port number of the TACACS+ server.
            type: int
          secondary-key:
            description: (list) Deprecated, please rename it to secondary_key. Key to
              access the secondary server.
            type: raw
          secondary-server:
            description: Deprecated, please rename it to secondary_server. Secondary TACACS+
              server CN domain name or IP address.
            type: str
          server:
            description: Primary TACACS+ server CN domain name or IP address.
            type: str
          source-ip:
            description: Deprecated, please rename it to source_ip. Source IP for communications
              to TACACS+ server.
            type: str
          tertiary-key:
            description: (list) Deprecated, please rename it to tertiary_key. Key to access
              the tertiary server.
            type: raw
          tertiary-server:
            description: Deprecated, please rename it to tertiary_server. Tertiary TACACS+
              server CN domain name or IP address.
            type: str
        type: list
      interface:
        description: Specify outgoing interface to reach server.
        type: str
      interface-select-method:
        choices:
        - auto
        - sdwan
        - specify
        description: Deprecated, please rename it to interface_select_method. Specify
          how to select outgoing interface to reach server.
        type: str
      key:
        description: (list) Key to access the primary server.
        type: raw
      name:
        description: TACACS+ server entry name.
        required: true
        type: str
      port:
        description: Port number of the TACACS+ server.
        type: int
      secondary-key:
        description: (list) Deprecated, please rename it to secondary_key. Key to access
          the secondary server.
        type: raw
      secondary-server:
        description: Deprecated, please rename it to secondary_server. Secondary TACACS+
          server CN domain name or IP address.
        type: str
      server:
        description: Primary TACACS+ server CN domain name or IP address.
        type: str
      source-ip:
        description: Deprecated, please rename it to source_ip. Source IP for communications
          to TACACS+ server.
        type: str
      tertiary-key:
        description: (list) Deprecated, please rename it to tertiary_key. Key to access
          the tertiary server.
        type: raw
      tertiary-server:
        description: Deprecated, please rename it to tertiary_server. Tertiary TACACS+
          server CN domain name or IP address.
        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