:source: fmgd_user_radius.py
:orphan:
.. _fmgd_user_radius:
fmgd_user_radius -- Configure RADIUS server entries.
++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 1.1.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v7.x.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible-core>=2.16.0
FortiManager Version Compatibility
----------------------------------
.. raw:: html
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
Parameters
----------
.. raw:: html
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- device - The parameter in requested url type: str required: true
- vdom - The parameter in requested url type: str required: true
- user_radius - Configure RADIUS server entries. type: dict
- accounting_server (Alias name: accounting-server) Accounting server. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- id Id (0 - 4294967295). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- interface Specify outgoing interface to reach server. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- interface_select_method (Alias name: interface-select-method) Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- port Radius accounting port number. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- secret Secret key. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- server Server cn domain name or ip address. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- source_ip (Alias name: source-ip) Support meta variable type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- status Status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- vrf_select (Alias name: vrf-select) Vrf id used for connection to server. type: int
more...
Supported Version Ranges: v7.6.4 -> latest
- acct_all_servers (Alias name: acct-all-servers) Enable/disable sending of accounting messages to all configured servers (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- acct_interim_interval (Alias name: acct-interim-interval) Time in seconds between each accounting interim update message. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- all_usergroup (Alias name: all-usergroup) Enable/disable automatically including this radius server in all user groups. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- auth_type (Alias name: auth-type) Authentication methods/protocols permitted for this radius server. type: str choices: [pap, chap, ms_chap, ms_chap_v2, auto]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- class Class attribute name(s). type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- delimiter Configure delimiter to be used for separating profile group names in the sso attribute (default = plus character +). type: str choices: [plus, comma]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dynamic_mapping Dynamic mapping. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- _scope Scope. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- name Name. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- vdom Vdom. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- account_key_cert_field (Alias name: account-key-cert-field) Define subject identity field in certificate for user access right checking. type: str choices: [othername, rfc822name, dnsname, cn]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- account_key_processing (Alias name: account-key-processing) Account key processing operation. type: str choices: [same, strip]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- accounting_server (Alias name: accounting-server) Accounting server. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- id Id (0 - 4294967295). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- interface Specify outgoing interface to reach server. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- interface_select_method (Alias name: interface-select-method) Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- port Radius accounting port number. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- secret Secret key. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- server Server cn domain name or ip address. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- source_ip (Alias name: source-ip) Support meta variable type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- status Status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- vrf_select (Alias name: vrf-select) Vrf id used for connection to server. type: int
more...
Supported Version Ranges: v7.6.4 -> latest
- acct_all_servers (Alias name: acct-all-servers) Enable/disable sending of accounting messages to all configured servers (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- acct_interim_interval (Alias name: acct-interim-interval) Time in seconds between each accounting interim update message. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- all_usergroup (Alias name: all-usergroup) Enable/disable automatically including this radius server in all user groups. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- auth_type (Alias name: auth-type) Authentication methods/protocols permitted for this radius server. type: str choices: [pap, chap, ms_chap, ms_chap_v2, auto]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ca_cert (Alias name: ca-cert) Ca of server to trust under tls. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- call_station_id_type (Alias name: call-station-id-type) Calling & called station identifier type configuration (default = legacy), this option is not available for 802. type: str choices: [legacy, IP, MAC]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- class Class attribute name(s). type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- client_cert (Alias name: client-cert) Client certificate to use under tls. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- delimiter Configure delimiter to be used for separating profile group names in the sso attribute (default = plus character +). type: str choices: [plus, comma]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dp_carrier_endpoint_attribute (Alias name: dp-carrier-endpoint-attribute) Dp carrier endpoint attribute. type: str choices: [User-Name, User-Password, CHAP-Password, NAS-IP-Address, NAS-Port, Service-Type, Framed-Protocol, Framed-IP-Address, Framed-IP-Netmask, Framed-Routing, Filter-Id, Framed-MTU, Framed-Compression, Login-IP-Host, Login-Service, Login-TCP-Port, Reply-Message, Callback-Number, Callback-Id, Framed-Route, Framed-IPX-Network, State, Class, Vendor-Specific, Session-Timeout, Idle-Timeout, Termination-Action, Called-Station-Id, Calling-Station-Id, NAS-Identifier, Proxy-State, Login-LAT-Service, Login-LAT-Node, Login-LAT-Group, Framed-AppleTalk-Link, Framed-AppleTalk-Network, Framed-AppleTalk-Zone, Acct-Status-Type, Acct-Delay-Time, Acct-Input-Octets, Acct-Output-Octets, Acct-Session-Id, Acct-Authentic, Acct-Session-Time, Acct-Input-Packets, Acct-Output-Packets, Acct-Terminate-Cause, Acct-Multi-Session-Id, Acct-Link-Count, CHAP-Challenge, NAS-Port-Type, Port-Limit, Login-LAT-Port]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dp_carrier_endpoint_block_attribute (Alias name: dp-carrier-endpoint-block-attribute) Dp carrier endpoint block attribute. type: str choices: [User-Name, User-Password, CHAP-Password, NAS-IP-Address, NAS-Port, Service-Type, Framed-Protocol, Framed-IP-Address, Framed-IP-Netmask, Framed-Routing, Filter-Id, Framed-MTU, Framed-Compression, Login-IP-Host, Login-Service, Login-TCP-Port, Reply-Message, Callback-Number, Callback-Id, Framed-Route, Framed-IPX-Network, State, Class, Vendor-Specific, Session-Timeout, Idle-Timeout, Termination-Action, Called-Station-Id, Calling-Station-Id, NAS-Identifier, Proxy-State, Login-LAT-Service, Login-LAT-Node, Login-LAT-Group, Framed-AppleTalk-Link, Framed-AppleTalk-Network, Framed-AppleTalk-Zone, Acct-Status-Type, Acct-Delay-Time, Acct-Input-Octets, Acct-Output-Octets, Acct-Session-Id, Acct-Authentic, Acct-Session-Time, Acct-Input-Packets, Acct-Output-Packets, Acct-Terminate-Cause, Acct-Multi-Session-Id, Acct-Link-Count, CHAP-Challenge, NAS-Port-Type, Port-Limit, Login-LAT-Port]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dp_context_timeout (Alias name: dp-context-timeout) Dp context timeout. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dp_flush_ip_session (Alias name: dp-flush-ip-session) Dp flush ip session. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dp_hold_time (Alias name: dp-hold-time) Dp hold time. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dp_http_header (Alias name: dp-http-header) Dp http header. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dp_http_header_fallback (Alias name: dp-http-header-fallback) Dp http header fallback. type: str choices: [ip-header-address, default-profile]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dp_http_header_status (Alias name: dp-http-header-status) Dp http header status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dp_http_header_suppress (Alias name: dp-http-header-suppress) Dp http header suppress. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dp_log_dyn_flags (Alias name: dp-log-dyn_flags) Dp log dyn flags. type: list choices: [none, protocol-error, profile-missing, context-missing, accounting-stop-missed, accounting-event, radiusd-other, endpoint-block]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dp_log_period (Alias name: dp-log-period) Dp log period. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dp_mem_percent (Alias name: dp-mem-percent) Dp mem percent. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dp_profile_attribute (Alias name: dp-profile-attribute) Dp profile attribute. type: str choices: [User-Name, User-Password, CHAP-Password, NAS-IP-Address, NAS-Port, Service-Type, Framed-Protocol, Framed-IP-Address, Framed-IP-Netmask, Framed-Routing, Filter-Id, Framed-MTU, Framed-Compression, Login-IP-Host, Login-Service, Login-TCP-Port, Reply-Message, Callback-Number, Callback-Id, Framed-Route, Framed-IPX-Network, State, Class, Vendor-Specific, Session-Timeout, Idle-Timeout, Termination-Action, Called-Station-Id, Calling-Station-Id, NAS-Identifier, Proxy-State, Login-LAT-Service, Login-LAT-Node, Login-LAT-Group, Framed-AppleTalk-Link, Framed-AppleTalk-Network, Framed-AppleTalk-Zone, Acct-Status-Type, Acct-Delay-Time, Acct-Input-Octets, Acct-Output-Octets, Acct-Session-Id, Acct-Authentic, Acct-Session-Time, Acct-Input-Packets, Acct-Output-Packets, Acct-Terminate-Cause, Acct-Multi-Session-Id, Acct-Link-Count, CHAP-Challenge, NAS-Port-Type, Port-Limit, Login-LAT-Port]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dp_profile_attribute_key (Alias name: dp-profile-attribute-key) Dp profile attribute key. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dp_radius_response (Alias name: dp-radius-response) Dp radius response. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dp_radius_server_port (Alias name: dp-radius-server-port) Dp radius server port. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dp_secret (Alias name: dp-secret) Dp secret. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dp_validate_request_secret (Alias name: dp-validate-request-secret) Dp validate request secret. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dynamic_profile (Alias name: dynamic-profile) Dynamic profile. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- endpoint_translation (Alias name: endpoint-translation) Endpoint translation. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ep_carrier_endpoint_convert_hex (Alias name: ep-carrier-endpoint-convert-hex) Ep carrier endpoint convert hex. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ep_carrier_endpoint_header (Alias name: ep-carrier-endpoint-header) Ep carrier endpoint header. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ep_carrier_endpoint_header_suppress (Alias name: ep-carrier-endpoint-header-suppress) Ep carrier endpoint header suppress. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ep_carrier_endpoint_prefix (Alias name: ep-carrier-endpoint-prefix) Ep carrier endpoint prefix. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ep_carrier_endpoint_prefix_range_max (Alias name: ep-carrier-endpoint-prefix-range-max) Ep carrier endpoint prefix range max. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ep_carrier_endpoint_prefix_range_min (Alias name: ep-carrier-endpoint-prefix-range-min) Ep carrier endpoint prefix range min. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ep_carrier_endpoint_prefix_string (Alias name: ep-carrier-endpoint-prefix-string) Ep carrier endpoint prefix string. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ep_carrier_endpoint_source (Alias name: ep-carrier-endpoint-source) Ep carrier endpoint source. type: str choices: [http-header, cookie]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ep_ip_header (Alias name: ep-ip-header) Ep ip header. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ep_ip_header_suppress (Alias name: ep-ip-header-suppress) Ep ip header suppress. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ep_missing_header_fallback (Alias name: ep-missing-header-fallback) Ep missing header fallback. type: str choices: [session-ip, policy-profile]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ep_profile_query_type (Alias name: ep-profile-query-type) Ep profile query type. type: str choices: [session-ip, extract-ip, extract-carrier-endpoint]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- group_override_attr_type (Alias name: group-override-attr-type) Radius attribute type to override user group information. type: str choices: [filter-Id, class]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- h3c_compatibility (Alias name: h3c-compatibility) Enable/disable compatibility with the h3c, a mechanism that performs security checking for authentication. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- interface Specify outgoing interface to reach server. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- interface_select_method (Alias name: interface-select-method) Specify how to select outgoing interface to reach server. type: str choices: [auto, specify, sdwan]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- mac_case (Alias name: mac-case) Mac authentication case (default = lowercase). type: str choices: [uppercase, lowercase]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- mac_password_delimiter (Alias name: mac-password-delimiter) Mac authentication password delimiter (default = hyphen). type: str choices: [hyphen, single-hyphen, colon, none]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- mac_username_delimiter (Alias name: mac-username-delimiter) Mac authentication username delimiter (default = hyphen). type: str choices: [hyphen, single-hyphen, colon, none]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- nas_id (Alias name: nas-id) Custom nas identifier. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- nas_id_type (Alias name: nas-id-type) Nas identifier type configuration (default = legacy). type: str choices: [legacy, custom, hostname]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- nas_ip (Alias name: nas-ip) Ip address used to communicate with the radius server and used as nas-ip-address and called-station-id attributes. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- password_encoding (Alias name: password-encoding) Password encoding. type: str choices: [ISO-8859-1, auto]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- password_renewal (Alias name: password-renewal) Enable/disable password renewal. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- radius_coa (Alias name: radius-coa) Enable to allow a mechanism to change the attributes of an authentication, authorization, and accounting session after it is authenticated. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- radius_port (Alias name: radius-port) Radius service port number. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- require_message_authenticator (Alias name: require-message-authenticator) Require message authenticator in authentication response. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso Enable/disable radius based single sign on feature. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso_context_timeout (Alias name: rsso-context-timeout) Time in seconds before the logged out user is removed from the user context list of logged on users. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso_endpoint_attribute (Alias name: rsso-endpoint-attribute) Radius attributes used to extract the user end point identifier from the radius start record. type: str choices: [User-Name, NAS-IP-Address, Framed-IP-Address, Framed-IP-Netmask, Filter-Id, Login-IP-Host, Reply-Message, Callback-Number, Callback-Id, Framed-Route, Framed-IPX-Network, Class, Called-Station-Id, Calling-Station-Id, NAS-Identifier, Proxy-State, Login-LAT-Service, Login-LAT-Node, Login-LAT-Group, Framed-AppleTalk-Zone, Acct-Session-Id, Acct-Multi-Session-Id]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso_endpoint_block_attribute (Alias name: rsso-endpoint-block-attribute) Radius attributes used to block a user. type: str choices: [User-Name, NAS-IP-Address, Framed-IP-Address, Framed-IP-Netmask, Filter-Id, Login-IP-Host, Reply-Message, Callback-Number, Callback-Id, Framed-Route, Framed-IPX-Network, Class, Called-Station-Id, Calling-Station-Id, NAS-Identifier, Proxy-State, Login-LAT-Service, Login-LAT-Node, Login-LAT-Group, Framed-AppleTalk-Zone, Acct-Session-Id, Acct-Multi-Session-Id]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso_ep_one_ip_only (Alias name: rsso-ep-one-ip-only) Enable/disable the replacement of old ip addresses with new ones for the same endpoint on radius accounting start messages. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso_flush_ip_session (Alias name: rsso-flush-ip-session) Enable/disable flushing user ip sessions on radius accounting stop messages. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso_log_flags (Alias name: rsso-log-flags) Events to log. type: list choices: [none, protocol-error, profile-missing, accounting-stop-missed, accounting-event, radiusd-other, endpoint-block]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso_log_period (Alias name: rsso-log-period) Time interval in seconds that group event log messages will be generated for dynamic profile events. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso_radius_response (Alias name: rsso-radius-response) Enable/disable sending radius response packets after receiving start and stop records. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso_radius_server_port (Alias name: rsso-radius-server-port) Udp port to listen on for radius start and stop records. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso_secret (Alias name: rsso-secret) Radius secret used by the radius accounting server. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso_validate_request_secret (Alias name: rsso-validate-request-secret) Enable/disable validating the radius request shared secret in the start or end record. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- secondary_secret (Alias name: secondary-secret) Secret key to access the secondary server. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- secondary_server (Alias name: secondary-server) Secondary radius cn domain name or ip address. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- secret Pre-shared secret key used to access the primary radius server. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- server Primary radius server cn domain name or ip address. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- server_identity_check (Alias name: server-identity-check) Enable/disable radius server identity check (verify server domain name/ip address against the server certificate). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- source_ip (Alias name: source-ip) Support meta variable type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- sso_attribute (Alias name: sso-attribute) Radius attribute that contains the profile group name to be extracted from the radius start record. type: str choices: [User-Name, NAS-IP-Address, Framed-IP-Address, Framed-IP-Netmask, Filter-Id, Login-IP-Host, Reply-Message, Callback-Number, Callback-Id, Framed-Route, Framed-IPX-Network, Class, Called-Station-Id, Calling-Station-Id, NAS-Identifier, Proxy-State, Login-LAT-Service, Login-LAT-Node, Login-LAT-Group, Framed-AppleTalk-Zone, Acct-Session-Id, Acct-Multi-Session-Id]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- sso_attribute_key (Alias name: sso-attribute-key) Key prefix for sso group value in the sso attribute. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- sso_attribute_value_override (Alias name: sso-attribute-value-override) Enable/disable override old attribute value with new value for the same endpoint. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- status_ttl (Alias name: status-ttl) Time for which server reachability is cached so that when a server is unreachable, it will not be retried for at least this period of time (0 = cache disabled, default = 300). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- switch_controller_acct_fast_framedip_detect (Alias name: switch-controller-acct-fast-framedip-detect) Switch controller accounting message framed-ip detection from dhcp snooping (seconds, default=2). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- switch_controller_nas_ip_dynamic (Alias name: switch-controller-nas-ip-dynamic) Enable/disable switch-controller nas-ip dynamic to dynamically set nas-ip. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- switch_controller_service_type (Alias name: switch-controller-service-type) Radius service type. type: list choices: [login, framed, callback-login, callback-framed, outbound, administrative, nas-prompt, authenticate-only, callback-nas-prompt, call-check, callback-administrative]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- tertiary_secret (Alias name: tertiary-secret) Secret key to access the tertiary server. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- tertiary_server (Alias name: tertiary-server) Tertiary radius cn domain name or ip address. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- timeout Time in seconds to retry connecting server. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- tls_min_proto_version (Alias name: tls-min-proto-version) Minimum supported protocol version for tls connections (default is to follow system global setting). type: str choices: [default, TLSv1, TLSv1-1, TLSv1-2, SSLv3, TLSv1-3]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- transport_protocol (Alias name: transport-protocol) Transport protocol to be used (default = udp). type: str choices: [udp, tcp, tls]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- use_group_for_profile (Alias name: use-group-for-profile) Use group for profile. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- use_management_vdom (Alias name: use-management-vdom) Enable/disable using management vdom to send requests. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- username_case_sensitive (Alias name: username-case-sensitive) Enable/disable case sensitive user names. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- source_ip_interface (Alias name: source-ip-interface) Source interface for communication with the radius server. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- vrf_select (Alias name: vrf-select) Vrf id used for connection to server. type: int
more...
Supported Version Ranges: v7.6.4 -> latest
- group_override_attr_type (Alias name: group-override-attr-type) Radius attribute type to override user group information. type: str choices: [filter-Id, class]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- h3c_compatibility (Alias name: h3c-compatibility) Enable/disable compatibility with the h3c, a mechanism that performs security checking for authentication. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- interface Specify outgoing interface to reach server. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- interface_select_method (Alias name: interface-select-method) Specify how to select outgoing interface to reach server. type: str choices: [auto, specify, sdwan]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- mac_case (Alias name: mac-case) Mac authentication case (default = lowercase). type: str choices: [uppercase, lowercase]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- mac_password_delimiter (Alias name: mac-password-delimiter) Mac authentication password delimiter (default = hyphen). type: str choices: [hyphen, single-hyphen, colon, none]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- mac_username_delimiter (Alias name: mac-username-delimiter) Mac authentication username delimiter (default = hyphen). type: str choices: [hyphen, single-hyphen, colon, none]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- name Radius server entry name. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- nas_id (Alias name: nas-id) Custom nas identifier. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- nas_id_type (Alias name: nas-id-type) Nas identifier type configuration (default = legacy). type: str choices: [legacy, custom, hostname]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- nas_ip (Alias name: nas-ip) Ip address used to communicate with the radius server and used as nas-ip-address and called-station-id attributes. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- password_encoding (Alias name: password-encoding) Password encoding. type: str choices: [ISO-8859-1, auto]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- password_renewal (Alias name: password-renewal) Enable/disable password renewal. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- radius_coa (Alias name: radius-coa) Enable to allow a mechanism to change the attributes of an authentication, authorization, and accounting session after it is authenticated. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- radius_port (Alias name: radius-port) Radius service port number. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- require_message_authenticator (Alias name: require-message-authenticator) Require message authenticator in authentication response. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso Enable/disable radius based single sign on feature. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso_context_timeout (Alias name: rsso-context-timeout) Time in seconds before the logged out user is removed from the user context list of logged on users. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso_endpoint_attribute (Alias name: rsso-endpoint-attribute) Radius attributes used to extract the user end point identifier from the radius start record. type: str choices: [User-Name, NAS-IP-Address, Framed-IP-Address, Framed-IP-Netmask, Filter-Id, Login-IP-Host, Reply-Message, Callback-Number, Callback-Id, Framed-Route, Framed-IPX-Network, Class, Called-Station-Id, Calling-Station-Id, NAS-Identifier, Proxy-State, Login-LAT-Service, Login-LAT-Node, Login-LAT-Group, Framed-AppleTalk-Zone, Acct-Session-Id, Acct-Multi-Session-Id]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso_endpoint_block_attribute (Alias name: rsso-endpoint-block-attribute) Radius attributes used to block a user. type: str choices: [User-Name, NAS-IP-Address, Framed-IP-Address, Framed-IP-Netmask, Filter-Id, Login-IP-Host, Reply-Message, Callback-Number, Callback-Id, Framed-Route, Framed-IPX-Network, Class, Called-Station-Id, Calling-Station-Id, NAS-Identifier, Proxy-State, Login-LAT-Service, Login-LAT-Node, Login-LAT-Group, Framed-AppleTalk-Zone, Acct-Session-Id, Acct-Multi-Session-Id]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso_ep_one_ip_only (Alias name: rsso-ep-one-ip-only) Enable/disable the replacement of old ip addresses with new ones for the same endpoint on radius accounting start messages. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso_flush_ip_session (Alias name: rsso-flush-ip-session) Enable/disable flushing user ip sessions on radius accounting stop messages. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso_log_flags (Alias name: rsso-log-flags) Events to log. type: list choices: [none, protocol-error, profile-missing, accounting-stop-missed, accounting-event, radiusd-other, endpoint-block]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso_log_period (Alias name: rsso-log-period) Time interval in seconds that group event log messages will be generated for dynamic profile events. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso_radius_response (Alias name: rsso-radius-response) Enable/disable sending radius response packets after receiving start and stop records. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso_radius_server_port (Alias name: rsso-radius-server-port) Udp port to listen on for radius start and stop records. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso_secret (Alias name: rsso-secret) Radius secret used by the radius accounting server. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rsso_validate_request_secret (Alias name: rsso-validate-request-secret) Enable/disable validating the radius request shared secret in the start or end record. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- secondary_secret (Alias name: secondary-secret) Secret key to access the secondary server. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- secondary_server (Alias name: secondary-server) Secondary radius cn domain name or ip address. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- secret Pre-shared secret key used to access the primary radius server. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- server Primary radius server cn domain name or ip address. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- source_ip (Alias name: source-ip) Support meta variable type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- sso_attribute (Alias name: sso-attribute) Radius attribute that contains the profile group name to be extracted from the radius start record. type: str choices: [User-Name, NAS-IP-Address, Framed-IP-Address, Framed-IP-Netmask, Filter-Id, Login-IP-Host, Reply-Message, Callback-Number, Callback-Id, Framed-Route, Framed-IPX-Network, Class, Called-Station-Id, Calling-Station-Id, NAS-Identifier, Proxy-State, Login-LAT-Service, Login-LAT-Node, Login-LAT-Group, Framed-AppleTalk-Zone, Acct-Session-Id, Acct-Multi-Session-Id]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- sso_attribute_key (Alias name: sso-attribute-key) Key prefix for sso group value in the sso attribute. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- sso_attribute_value_override (Alias name: sso-attribute-value-override) Enable/disable override old attribute value with new value for the same endpoint. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- switch_controller_acct_fast_framedip_detect (Alias name: switch-controller-acct-fast-framedip-detect) Switch controller accounting message framed-ip detection from dhcp snooping (seconds, default=2). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- switch_controller_service_type (Alias name: switch-controller-service-type) Radius service type. type: list choices: [login, framed, callback-login, callback-framed, outbound, administrative, nas-prompt, authenticate-only, callback-nas-prompt, call-check, callback-administrative]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- tertiary_secret (Alias name: tertiary-secret) Secret key to access the tertiary server. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- tertiary_server (Alias name: tertiary-server) Tertiary radius cn domain name or ip address. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- timeout Time in seconds to retry connecting server. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- use_management_vdom (Alias name: use-management-vdom) Enable/disable using management vdom to send requests. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- username_case_sensitive (Alias name: username-case-sensitive) Enable/disable case sensitive user names. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- tls_min_proto_version (Alias name: tls-min-proto-version) Minimum supported protocol version for tls connections (default is to follow system global setting). type: str choices: [default, TLSv1, TLSv1-1, TLSv1-2, SSLv3, TLSv1-3]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- status_ttl (Alias name: status-ttl) Time for which server reachability is cached so that when a server is unreachable, it will not be retried for at least this period of time (0 = cache disabled, default = 300). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- account_key_cert_field (Alias name: account-key-cert-field) Define subject identity field in certificate for user access right checking. type: str choices: [othername, rfc822name, dnsname, cn]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- switch_controller_nas_ip_dynamic (Alias name: switch-controller-nas-ip-dynamic) Enable/disable switch-controller nas-ip dynamic to dynamically set nas-ip. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- account_key_processing (Alias name: account-key-processing) Account key processing operation. type: str choices: [same, strip]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- server_identity_check (Alias name: server-identity-check) Enable/disable radius server identity check (verify server domain name/ip address against the server certificate). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- transport_protocol (Alias name: transport-protocol) Transport protocol to be used (default = udp). type: str choices: [udp, tcp, tls]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- client_cert (Alias name: client-cert) Client certificate to use under tls. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ca_cert (Alias name: ca-cert) Ca of server to trust under tls. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- call_station_id_type (Alias name: call-station-id-type) Calling & called station identifier type configuration (default = legacy), this option is not available for 802. type: str choices: [legacy, IP, MAC]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- source_ip_interface (Alias name: source-ip-interface) Source interface for communication with the radius server. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- vrf_select (Alias name: vrf-select) Vrf id used for connection to server. type: int
more...
Supported Version Ranges: v7.6.4 -> latest
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
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure RADIUS server entries.
fortinet.fmgdevice.fmgd_user_radius:
# bypass_validation: false
# workspace_locking_adom:
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device:
vdom:
state: present #
user_radius:
name: "your value" # Required variable, string
# accounting_server:
# - id:
# interface:
# interface_select_method:
# port:
# secret:
# server:
# source_ip:
# status:
# vrf_select:
# acct_all_servers:
# acct_interim_interval:
# all_usergroup:
# auth_type:
# class:
# delimiter:
# dynamic_mapping:
# - _scope:
# - name:
# vdom:
# account_key_cert_field:
# account_key_processing:
# accounting_server:
# - id:
# interface:
# interface_select_method:
# port:
# secret:
# server:
# source_ip:
# status:
# vrf_select:
# acct_all_servers:
# acct_interim_interval:
# all_usergroup:
# auth_type:
# ca_cert:
# call_station_id_type:
# class:
# client_cert:
# delimiter:
# dp_carrier_endpoint_attribute:
# dp_carrier_endpoint_block_attribute:
# dp_context_timeout:
# dp_flush_ip_session:
# dp_hold_time:
# dp_http_header:
# dp_http_header_fallback:
# dp_http_header_status:
# dp_http_header_suppress:
# dp_log_dyn_flags:
# - "none"
# - "protocol-error"
# - "profile-missing"
# - "context-missing"
# - "accounting-stop-missed"
# - "accounting-event"
# - "radiusd-other"
# - "endpoint-block"
# dp_log_period:
# dp_mem_percent:
# dp_profile_attribute:
# dp_profile_attribute_key:
# dp_radius_response:
# dp_radius_server_port:
# dp_secret:
# dp_validate_request_secret:
# dynamic_profile:
# endpoint_translation:
# ep_carrier_endpoint_convert_hex:
# ep_carrier_endpoint_header:
# ep_carrier_endpoint_header_suppress:
# ep_carrier_endpoint_prefix:
# ep_carrier_endpoint_prefix_range_max:
# ep_carrier_endpoint_prefix_range_min:
# ep_carrier_endpoint_prefix_string:
# ep_carrier_endpoint_source:
# ep_ip_header:
# ep_ip_header_suppress:
# ep_missing_header_fallback:
# ep_profile_query_type:
# group_override_attr_type:
# h3c_compatibility:
# interface:
# interface_select_method:
# mac_case:
# mac_password_delimiter:
# mac_username_delimiter:
# nas_id:
# nas_id_type:
# nas_ip:
# password_encoding:
# password_renewal:
# radius_coa:
# radius_port:
# require_message_authenticator:
# rsso:
# rsso_context_timeout:
# rsso_endpoint_attribute:
# rsso_endpoint_block_attribute:
# rsso_ep_one_ip_only:
# rsso_flush_ip_session:
# rsso_log_flags:
# - "none"
# - "protocol-error"
# - "profile-missing"
# - "accounting-stop-missed"
# - "accounting-event"
# - "radiusd-other"
# - "endpoint-block"
# rsso_log_period:
# rsso_radius_response:
# rsso_radius_server_port:
# rsso_secret:
# rsso_validate_request_secret:
# secondary_secret:
# secondary_server:
# secret:
# server:
# server_identity_check:
# source_ip:
# sso_attribute:
# sso_attribute_key:
# sso_attribute_value_override:
# status_ttl:
# switch_controller_acct_fast_framedip_detect:
# switch_controller_nas_ip_dynamic:
# switch_controller_service_type:
# - "login"
# - "framed"
# - "callback-login"
# - "callback-framed"
# - "outbound"
# - "administrative"
# - "nas-prompt"
# - "authenticate-only"
# - "callback-nas-prompt"
# - "call-check"
# - "callback-administrative"
# tertiary_secret:
# tertiary_server:
# timeout:
# tls_min_proto_version:
# transport_protocol:
# use_group_for_profile:
# use_management_vdom:
# username_case_sensitive:
# source_ip_interface:
# vrf_select:
# group_override_attr_type:
# h3c_compatibility:
# interface:
# interface_select_method:
# mac_case:
# mac_password_delimiter:
# mac_username_delimiter:
# nas_id:
# nas_id_type:
# nas_ip:
# password_encoding:
# password_renewal:
# radius_coa:
# radius_port:
# require_message_authenticator:
# rsso:
# rsso_context_timeout:
# rsso_endpoint_attribute:
# rsso_endpoint_block_attribute:
# rsso_ep_one_ip_only:
# rsso_flush_ip_session:
# rsso_log_flags:
# - "none"
# - "protocol-error"
# - "profile-missing"
# - "accounting-stop-missed"
# - "accounting-event"
# - "radiusd-other"
# - "endpoint-block"
# rsso_log_period:
# rsso_radius_response:
# rsso_radius_server_port:
# rsso_secret:
# rsso_validate_request_secret:
# secondary_secret:
# secondary_server:
# secret:
# server:
# source_ip:
# sso_attribute:
# sso_attribute_key:
# sso_attribute_value_override:
# switch_controller_acct_fast_framedip_detect:
# switch_controller_service_type:
# - "login"
# - "framed"
# - "callback-login"
# - "callback-framed"
# - "outbound"
# - "administrative"
# - "nas-prompt"
# - "authenticate-only"
# - "callback-nas-prompt"
# - "call-check"
# - "callback-administrative"
# tertiary_secret:
# tertiary_server:
# timeout:
# use_management_vdom:
# username_case_sensitive:
# tls_min_proto_version:
# status_ttl:
# account_key_cert_field:
# switch_controller_nas_ip_dynamic:
# account_key_processing:
# server_identity_check:
# transport_protocol:
# client_cert:
# ca_cert:
# call_station_id_type:
# source_ip_interface:
# vrf_select:
Return Values
-------------
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
.. raw:: html
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)