fortinet.fortimanager.fmgr_user_tacacs – Configure TACACS+ server entries.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_user_tacacs.

New in version 2.10: of fortinet.fortimanager

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

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.

Parameters

Parameter				Choices/Defaults	Comments
adom string / required					the parameter (adom) in requested url
bypass_validation boolean				Choices: no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log boolean				Choices: no ← yes	Enable/Disable logging for task
proposed_method string				Choices: update set add	The overridden method for the underlying Json RPC request
rc_failed list / elements=string					the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string					the rc codes list with which the conditions to succeed will be overriden
state string / required				Choices: present absent	the directive to create, update or delete an object
user_tacacs dictionary					the top level parameters set
	authen-type string			Choices: auto ascii pap chap mschap	Allowed authentication protocols/methods.
	authorization string			Choices: disable enable	Enable/disable TACACS+ authorization.
	dynamic_mapping list / elements=string				no description
		_scope list / elements=string			no description
			name string		no description
			vdom string		no description
		authen-type string		Choices: auto ascii pap chap mschap	no description
		authorization string		Choices: disable enable	no description
		interface string			no description
		interface-select-method string		Choices: auto sdwan specify	no description
		key string			no description
		port integer			no description
		secondary-key string			no description
		secondary-server string			no description
		server string			no description
		source-ip string			no description
		tertiary-key string			no description
		tertiary-server string			no description
	interface string				Specify outgoing interface to reach server.
	interface-select-method string			Choices: auto sdwan specify	Specify how to select outgoing interface to reach server.
	key string				no description
	name string				TACACS+ server entry name.
	port integer				Port number of the TACACS+ server.
	secondary-key string				no description
	secondary-server string				Secondary TACACS+ server CN domain name or IP address.
	server string				Primary TACACS+ server CN domain name or IP address.
	source-ip string				source IP for communications to TACACS+ server.
	tertiary-key string				no description
	tertiary-server string				Tertiary TACACS+ server CN domain name or IP address.
workspace_locking_adom string					the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout integer				Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state present directive.
To delete an object, use state absent directive.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure TACACS+ server entries.
     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: <value in [present, absent]>
        user_tacacs:
           authen-type: <value in [auto, ascii, pap, ...]>
           authorization: <value in [disable, enable]>
           dynamic_mapping:
             -
                 _scope:
                   -
                       name: <value of string>
                       vdom: <value of string>
                 authen-type: <value in [auto, ascii, pap, ...]>
                 authorization: <value in [disable, enable]>
                 key: <value of string>
                 port: <value of integer>
                 secondary-key: <value of string>
                 secondary-server: <value of string>
                 server: <value of string>
                 source-ip: <value of string>
                 tertiary-key: <value of string>
                 tertiary-server: <value of string>
                 interface: <value of string>
                 interface-select-method: <value in [auto, sdwan, specify]>
           key: <value of string>
           name: <value of string>
           port: <value of integer>
           secondary-key: <value of string>
           secondary-server: <value of string>
           server: <value of string>
           source-ip: <value of string>
           tertiary-key: <value of string>
           tertiary-server: <value of string>
           interface: <value of string>
           interface-select-method: <value in [auto, sdwan, specify]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_user_tacacs_module.html