Try SpotterConfigure RADIUS server entries.
| "added in version" 2.0.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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 RADIUS server entries.
fortinet.fortimanager.fmgr_user_radius:
bypass_validation: false
adom: ansible
state: present
user_radius:
name: ansible-test-radius
server: ansible
timeout: 200
- 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 RADIUS server entries
fortinet.fortimanager.fmgr_fact:
facts:
selector: "user_radius"
params:
adom: "ansible"
radius: "your_value"
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_radius:
description: The top level parameters set.
required: false
suboptions:
account-key-cert-field:
choices:
- othername
- rfc822name
- dnsname
description: Deprecated, please rename it to account_key_cert_field. Define subject
identity field in certificate for user access right...
type: str
account-key-processing:
choices:
- same
- strip
description: Deprecated, please rename it to account_key_processing. Account key
processing operation.
type: str
accounting-server:
description: Deprecated, please rename it to accounting_server. Accounting-Server.
elements: dict
suboptions:
id:
description: ID
type: int
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
port:
description: RADIUS accounting port number.
type: int
secret:
description: (list) Secret key.
type: raw
server:
description: No description
type: str
source-ip:
description: Deprecated, please rename it to source_ip. Source IP address
for communications to the RADIUS server.
type: str
status:
choices:
- disable
- enable
description: Status.
type: str
type: list
acct-all-servers:
choices:
- disable
- enable
description: Deprecated, please rename it to acct_all_servers. Enable/disable
sending of accounting messages to all configured servers
type: str
acct-interim-interval:
description: Deprecated, please rename it to acct_interim_interval. Time in seconds
between each accounting interim update message.
type: int
all-usergroup:
choices:
- disable
- enable
description: Deprecated, please rename it to all_usergroup. Enable/disable automatically
including this RADIUS server in all user groups.
type: str
auth-type:
choices:
- pap
- chap
- ms_chap
- ms_chap_v2
- auto
description: Deprecated, please rename it to auth_type. Authentication methods/protocols
permitted for this RADIUS server.
type: str
ca-cert:
description: Deprecated, please rename it to ca_cert. CA of server to trust under
TLS.
type: str
call-station-id-type:
choices:
- legacy
- IP
- MAC
description: Deprecated, please rename it to call_station_id_type. Calling & Called
station identifier type configuration
type: str
class:
description: (list) Class attribute name
type: raw
client-cert:
description: Deprecated, please rename it to client_cert. Client certificate to
use under TLS.
type: str
delimiter:
choices:
- plus
- comma
description: Configure delimiter to be used for separating profile group names
in the SSO attribute
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
account-key-cert-field:
choices:
- othername
- rfc822name
- dnsname
description: Deprecated, please rename it to account_key_cert_field. Define
subject identity field in certificate for user acce...
type: str
account-key-processing:
choices:
- same
- strip
description: Deprecated, please rename it to account_key_processing. Account
key processing operation.
type: str
accounting-server:
description: Deprecated, please rename it to accounting_server. Accounting-Server.
elements: dict
suboptions:
id:
description: ID
type: int
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...
type: str
port:
description: RADIUS accounting port number.
type: int
secret:
description: (list) Secret key.
type: raw
server:
description: No description
type: str
source-ip:
description: Deprecated, please rename it to source_ip. Source IP address
for communications to the RADIUS server.
type: str
status:
choices:
- disable
- enable
description: Status.
type: str
type: list
acct-all-servers:
choices:
- disable
- enable
description: Deprecated, please rename it to acct_all_servers. Enable/disable
sending of accounting messages to all configured ...
type: str
acct-interim-interval:
description: Deprecated, please rename it to acct_interim_interval. Time in
seconds between each accounting interim update message.
type: int
all-usergroup:
choices:
- disable
- enable
description: Deprecated, please rename it to all_usergroup. Enable/disable
automatically including this RADIUS server in all us...
type: str
auth-type:
choices:
- pap
- chap
- ms_chap
- ms_chap_v2
- auto
description: Deprecated, please rename it to auth_type. Authentication methods/protocols
permitted for this RADIUS server.
type: str
ca-cert:
description: Deprecated, please rename it to ca_cert. CA of server to trust
under TLS.
type: str
call-station-id-type:
choices:
- legacy
- IP
- MAC
description: Deprecated, please rename it to call_station_id_type. Calling
& Called station identifier type configuration
type: str
class:
description: (list) Class attribute name
type: raw
client-cert:
description: Deprecated, please rename it to client_cert. Client certificate
to use under TLS.
type: str
delimiter:
choices:
- plus
- comma
description: Configure delimiter to be used for separating profile group names
in the SSO attribute
type: str
dp-carrier-endpoint-attribute:
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
description: Deprecated, please rename it to dp_carrier_endpoint_attribute.
Dp-Carrier-Endpoint-Attribute.
type: str
dp-carrier-endpoint-block-attribute:
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
description: Deprecated, please rename it to dp_carrier_endpoint_block_attribute.
Dp-Carrier-Endpoint-Block-Attribute.
type: str
dp-context-timeout:
description: Deprecated, please rename it to dp_context_timeout. Dp-Context-Timeout.
type: int
dp-flush-ip-session:
choices:
- disable
- enable
description: Deprecated, please rename it to dp_flush_ip_session. Dp-Flush-Ip-Session.
type: str
dp-hold-time:
description: Deprecated, please rename it to dp_hold_time. Dp-Hold-Time.
type: int
dp-http-header:
description: Deprecated, please rename it to dp_http_header. Dp-Http-Header.
type: str
dp-http-header-fallback:
choices:
- ip-header-address
- default-profile
description: Deprecated, please rename it to dp_http_header_fallback. Dp-Http-Header-Fallback.
type: str
dp-http-header-status:
choices:
- disable
- enable
description: Deprecated, please rename it to dp_http_header_status. Dp-Http-Header-Status.
type: str
dp-http-header-suppress:
choices:
- disable
- enable
description: Deprecated, please rename it to dp_http_header_suppress. Dp-Http-Header-Suppress.
type: str
dp-log-dyn_flags:
choices:
- none
- protocol-error
- profile-missing
- context-missing
- accounting-stop-missed
- accounting-event
- radiusd-other
- endpoint-block
description: Deprecated, please rename it to dp_log_dyn_flags. Dp-Log-Dyn_Flags.
elements: str
type: list
dp-log-period:
description: Deprecated, please rename it to dp_log_period. Dp-Log-Period.
type: int
dp-mem-percent:
description: Deprecated, please rename it to dp_mem_percent. Dp-Mem-Percent.
type: int
dp-profile-attribute:
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
description: Deprecated, please rename it to dp_profile_attribute. Dp-Profile-Attribute.
type: str
dp-profile-attribute-key:
description: Deprecated, please rename it to dp_profile_attribute_key. Dp-Profile-Attribute-Key.
type: str
dp-radius-response:
choices:
- disable
- enable
description: Deprecated, please rename it to dp_radius_response. Dp-Radius-Response.
type: str
dp-radius-server-port:
description: Deprecated, please rename it to dp_radius_server_port. Dp-Radius-Server-Port.
type: int
dp-secret:
description: (list) Deprecated, please rename it to dp_secret. Dp-Secret.
type: raw
dp-validate-request-secret:
choices:
- disable
- enable
description: Deprecated, please rename it to dp_validate_request_secret. Dp-Validate-Request-Secret.
type: str
dynamic-profile:
choices:
- disable
- enable
description: Deprecated, please rename it to dynamic_profile. Dynamic-Profile.
type: str
endpoint-translation:
choices:
- disable
- enable
description: Deprecated, please rename it to endpoint_translation. Endpoint-Translation.
type: str
ep-carrier-endpoint-convert-hex:
choices:
- disable
- enable
description: Deprecated, please rename it to ep_carrier_endpoint_convert_hex.
Ep-Carrier-Endpoint-Convert-Hex.
type: str
ep-carrier-endpoint-header:
description: Deprecated, please rename it to ep_carrier_endpoint_header. Ep-Carrier-Endpoint-Header.
type: str
ep-carrier-endpoint-header-suppress:
choices:
- disable
- enable
description: Deprecated, please rename it to ep_carrier_endpoint_header_suppress.
Ep-Carrier-Endpoint-Header-Suppress.
type: str
ep-carrier-endpoint-prefix:
choices:
- disable
- enable
description: Deprecated, please rename it to ep_carrier_endpoint_prefix. Ep-Carrier-Endpoint-Prefix.
type: str
ep-carrier-endpoint-prefix-range-max:
description: Deprecated, please rename it to ep_carrier_endpoint_prefix_range_max.
Ep-Carrier-Endpoint-Prefix-Range-Max.
type: int
ep-carrier-endpoint-prefix-range-min:
description: Deprecated, please rename it to ep_carrier_endpoint_prefix_range_min.
Ep-Carrier-Endpoint-Prefix-Range-Min.
type: int
ep-carrier-endpoint-prefix-string:
description: Deprecated, please rename it to ep_carrier_endpoint_prefix_string.
Ep-Carrier-Endpoint-Prefix-String.
type: str
ep-carrier-endpoint-source:
choices:
- http-header
- cookie
description: Deprecated, please rename it to ep_carrier_endpoint_source. Ep-Carrier-Endpoint-Source.
type: str
ep-ip-header:
description: Deprecated, please rename it to ep_ip_header. Ep-Ip-Header.
type: str
ep-ip-header-suppress:
choices:
- disable
- enable
description: Deprecated, please rename it to ep_ip_header_suppress. Ep-Ip-Header-Suppress.
type: str
ep-missing-header-fallback:
choices:
- session-ip
- policy-profile
description: Deprecated, please rename it to ep_missing_header_fallback. Ep-Missing-Header-Fallback.
type: str
ep-profile-query-type:
choices:
- session-ip
- extract-ip
- extract-carrier-endpoint
description: Deprecated, please rename it to ep_profile_query_type. Ep-Profile-Query-Type.
type: str
group-override-attr-type:
choices:
- filter-Id
- class
description: Deprecated, please rename it to group_override_attr_type. Group-Override-Attr-Type.
type: str
h3c-compatibility:
choices:
- disable
- enable
description: Deprecated, please rename it to h3c_compatibility. Enable/disable
compatibility with the H3C, a mechanism that per...
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
mac-case:
choices:
- uppercase
- lowercase
description: Deprecated, please rename it to mac_case. MAC authentication
case
type: str
mac-password-delimiter:
choices:
- hyphen
- single-hyphen
- colon
- none
description: Deprecated, please rename it to mac_password_delimiter. MAC authentication
password delimiter
type: str
mac-username-delimiter:
choices:
- hyphen
- single-hyphen
- colon
- none
description: Deprecated, please rename it to mac_username_delimiter. MAC authentication
username delimiter
type: str
nas-id:
description: Deprecated, please rename it to nas_id. Custom NAS identifier.
type: str
nas-id-type:
choices:
- legacy
- custom
- hostname
description: Deprecated, please rename it to nas_id_type. NAS identifier type
configuration
type: str
nas-ip:
description: Deprecated, please rename it to nas_ip. IP address used to communicate
with the RADIUS server and used as NAS-IP-A...
type: str
password-encoding:
choices:
- ISO-8859-1
- auto
description: Deprecated, please rename it to password_encoding. Password encoding.
type: str
password-renewal:
choices:
- disable
- enable
description: Deprecated, please rename it to password_renewal. Enable/disable
password renewal.
type: str
radius-coa:
choices:
- disable
- enable
description: Deprecated, please rename it to radius_coa. Enable to allow a
mechanism to change the attributes of an authenticat...
type: str
radius-port:
description: Deprecated, please rename it to radius_port. RADIUS service port
number.
type: int
rsso:
choices:
- disable
- enable
description: Enable/disable RADIUS based single sign on feature.
type: str
rsso-context-timeout:
description: Deprecated, please rename it to rsso_context_timeout. Time in
seconds before the logged out user is removed from t...
type: int
rsso-endpoint-attribute:
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
- 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
description: Deprecated, please rename it to rsso_endpoint_attribute. RADIUS
attributes used to extract the user end point iden...
type: str
rsso-endpoint-block-attribute:
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
- 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
description: Deprecated, please rename it to rsso_endpoint_block_attribute.
RADIUS attributes used to block a user.
type: str
rsso-ep-one-ip-only:
choices:
- disable
- enable
description: Deprecated, please rename it to rsso_ep_one_ip_only. Enable/disable
the replacement of old IP addresses with new o...
type: str
rsso-flush-ip-session:
choices:
- disable
- enable
description: Deprecated, please rename it to rsso_flush_ip_session. Enable/disable
flushing user IP sessions on RADIUS accounti...
type: str
rsso-log-flags:
choices:
- none
- protocol-error
- profile-missing
- context-missing
- accounting-stop-missed
- accounting-event
- radiusd-other
- endpoint-block
description: Deprecated, please rename it to rsso_log_flags. Events to log.
elements: str
type: list
rsso-log-period:
description: Deprecated, please rename it to rsso_log_period. Time interval
in seconds that group event log messages will be ge...
type: int
rsso-radius-response:
choices:
- disable
- enable
description: Deprecated, please rename it to rsso_radius_response. Enable/disable
sending RADIUS response packets after receivi...
type: str
rsso-radius-server-port:
description: Deprecated, please rename it to rsso_radius_server_port. UDP
port to listen on for RADIUS Start and Stop records.
type: int
rsso-secret:
description: (list) Deprecated, please rename it to rsso_secret. RADIUS secret
used by the RADIUS accounting server.
type: raw
rsso-validate-request-secret:
choices:
- disable
- enable
description: Deprecated, please rename it to rsso_validate_request_secret.
Enable/disable validating the RADIUS request shared ...
type: str
secondary-secret:
description: (list) Deprecated, please rename it to secondary_secret. Secret
key to access the secondary server.
type: raw
secondary-server:
description: Deprecated, please rename it to secondary_server. No description
type: str
secret:
description: (list) Pre-shared secret key used to access the primary RADIUS
server.
type: raw
server:
description: Primary RADIUS server CN domain name or IP address.
type: str
server-identity-check:
choices:
- disable
- enable
description: Deprecated, please rename it to server_identity_check. Enable/disable
RADIUS server identity check
type: str
source-ip:
description: Deprecated, please rename it to source_ip. Source IP address
for communications to the RADIUS server.
type: str
sso-attribute:
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
- 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
description: Deprecated, please rename it to sso_attribute. RADIUS attribute
that contains the profile group name to be extract...
type: str
sso-attribute-key:
description: Deprecated, please rename it to sso_attribute_key. Key prefix
for SSO group value in the SSO attribute.
type: str
sso-attribute-value-override:
choices:
- disable
- enable
description: Deprecated, please rename it to sso_attribute_value_override.
Enable/disable override old attribute value with new...
type: str
status-ttl:
description: Deprecated, please rename it to status_ttl. Time for which server
reachability is cached so that when a server is ...
type: int
switch-controller-acct-fast-framedip-detect:
description: Deprecated, please rename it to switch_controller_acct_fast_framedip_detect.
Switch-Controller-Acct-Fast-Framedip-...
type: int
switch-controller-nas-ip-dynamic:
choices:
- disable
- enable
description: Deprecated, please rename it to switch_controller_nas_ip_dynamic.
Enable/Disable switch-controller nas-ip dynamic ...
type: str
switch-controller-service-type:
choices:
- login
- framed
- callback-login
- callback-framed
- outbound
- administrative
- nas-prompt
- authenticate-only
- callback-nas-prompt
- call-check
- callback-administrative
description: Deprecated, please rename it to switch_controller_service_type.
Switch-Controller-Service-Type.
elements: str
type: list
tertiary-secret:
description: (list) Deprecated, please rename it to tertiary_secret. Secret
key to access the tertiary server.
type: raw
tertiary-server:
description: Deprecated, please rename it to tertiary_server. No description
type: str
timeout:
description: Time in seconds between re-sending authentication requests.
type: int
tls-min-proto-version:
choices:
- default
- TLSv1
- TLSv1-1
- TLSv1-2
- SSLv3
- TLSv1-3
description: Deprecated, please rename it to tls_min_proto_version. Minimum
supported protocol version for TLS connections
type: str
transport-protocol:
choices:
- udp
- tcp
- tls
description: Deprecated, please rename it to transport_protocol. Transport
protocol to be used
type: str
use-group-for-profile:
choices:
- disable
- enable
description: Deprecated, please rename it to use_group_for_profile. Use-Group-For-Profile.
type: str
use-management-vdom:
choices:
- disable
- enable
description: Deprecated, please rename it to use_management_vdom. Enable/disable
using management VDOM to send requests.
type: str
username-case-sensitive:
choices:
- disable
- enable
description: Deprecated, please rename it to username_case_sensitive. Enable/disable
case sensitive user names.
type: str
type: list
group-override-attr-type:
choices:
- filter-Id
- class
description: Deprecated, please rename it to group_override_attr_type. RADIUS
attribute type to override user group information.
type: str
h3c-compatibility:
choices:
- disable
- enable
description: Deprecated, please rename it to h3c_compatibility. Enable/disable
compatibility with the H3C, a mechanism that performs se...
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
mac-case:
choices:
- uppercase
- lowercase
description: Deprecated, please rename it to mac_case. MAC authentication case
type: str
mac-password-delimiter:
choices:
- hyphen
- single-hyphen
- colon
- none
description: Deprecated, please rename it to mac_password_delimiter. MAC authentication
password delimiter
type: str
mac-username-delimiter:
choices:
- hyphen
- single-hyphen
- colon
- none
description: Deprecated, please rename it to mac_username_delimiter. MAC authentication
username delimiter
type: str
name:
description: RADIUS server entry name.
required: true
type: str
nas-id:
description: Deprecated, please rename it to nas_id. Custom NAS identifier.
type: str
nas-id-type:
choices:
- legacy
- custom
- hostname
description: Deprecated, please rename it to nas_id_type. NAS identifier type
configuration
type: str
nas-ip:
description: Deprecated, please rename it to nas_ip. IP address used to communicate
with the RADIUS server and used as NAS-IP-Address a...
type: str
password-encoding:
choices:
- ISO-8859-1
- auto
description: Deprecated, please rename it to password_encoding. Password encoding.
type: str
password-renewal:
choices:
- disable
- enable
description: Deprecated, please rename it to password_renewal. Enable/disable
password renewal.
type: str
radius-coa:
choices:
- disable
- enable
description: Deprecated, please rename it to radius_coa. Enable to allow a mechanism
to change the attributes of an authentication, aut...
type: str
radius-port:
description: Deprecated, please rename it to radius_port. RADIUS service port
number.
type: int
rsso:
choices:
- disable
- enable
description: Enable/disable RADIUS based single sign on feature.
type: str
rsso-context-timeout:
description: Deprecated, please rename it to rsso_context_timeout. Time in seconds
before the logged out user is removed from the user ...
type: int
rsso-endpoint-attribute:
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
- 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
description: Deprecated, please rename it to rsso_endpoint_attribute. RADIUS attributes
used to extract the user end point identifer fr...
type: str
rsso-endpoint-block-attribute:
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
- 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
description: Deprecated, please rename it to rsso_endpoint_block_attribute. RADIUS
attributes used to block a user.
type: str
rsso-ep-one-ip-only:
choices:
- disable
- enable
description: Deprecated, please rename it to rsso_ep_one_ip_only. Enable/disable
the replacement of old IP addresses with new ones for ...
type: str
rsso-flush-ip-session:
choices:
- disable
- enable
description: Deprecated, please rename it to rsso_flush_ip_session. Enable/disable
flushing user IP sessions on RADIUS accounting Stop ...
type: str
rsso-log-flags:
choices:
- none
- protocol-error
- profile-missing
- context-missing
- accounting-stop-missed
- accounting-event
- radiusd-other
- endpoint-block
description: Deprecated, please rename it to rsso_log_flags. Events to log.
elements: str
type: list
rsso-log-period:
description: Deprecated, please rename it to rsso_log_period. Time interval in
seconds that group event log messages will be generated ...
type: int
rsso-radius-response:
choices:
- disable
- enable
description: Deprecated, please rename it to rsso_radius_response. Enable/disable
sending RADIUS response packets after receiving Start...
type: str
rsso-radius-server-port:
description: Deprecated, please rename it to rsso_radius_server_port. UDP port
to listen on for RADIUS Start and Stop records.
type: int
rsso-secret:
description: (list) Deprecated, please rename it to rsso_secret. RADIUS secret
used by the RADIUS accounting server.
type: raw
rsso-validate-request-secret:
choices:
- disable
- enable
description: Deprecated, please rename it to rsso_validate_request_secret. Enable/disable
validating the RADIUS request shared secret i...
type: str
secondary-secret:
description: (list) Deprecated, please rename it to secondary_secret. Secret key
to access the secondary server.
type: raw
secondary-server:
description: Deprecated, please rename it to secondary_server. No description
type: str
secret:
description: (list) Pre-shared secret key used to access the primary RADIUS server.
type: raw
server:
description: Primary RADIUS server CN domain name or IP address.
type: str
server-identity-check:
choices:
- disable
- enable
description: Deprecated, please rename it to server_identity_check. Enable/disable
RADIUS server identity check
type: str
source-ip:
description: Deprecated, please rename it to source_ip. Source IP address for
communications to the RADIUS server.
type: str
sso-attribute:
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
- 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
description: Deprecated, please rename it to sso_attribute. RADIUS attribute that
contains the profile group name to be extracted from ...
type: str
sso-attribute-key:
description: Deprecated, please rename it to sso_attribute_key. Key prefix for
SSO group value in the SSO attribute.
type: str
sso-attribute-value-override:
choices:
- disable
- enable
description: Deprecated, please rename it to sso_attribute_value_override. Enable/disable
override old attribute value with new value f...
type: str
status-ttl:
description: Deprecated, please rename it to status_ttl. Time for which server
reachability is cached so that when a server is unreacha...
type: int
switch-controller-acct-fast-framedip-detect:
description: Deprecated, please rename it to switch_controller_acct_fast_framedip_detect.
Switch controller accounting message Framed-I...
type: int
switch-controller-nas-ip-dynamic:
choices:
- disable
- enable
description: Deprecated, please rename it to switch_controller_nas_ip_dynamic.
Enable/Disable switch-controller nas-ip dynamic to dynam...
type: str
switch-controller-service-type:
choices:
- login
- framed
- callback-login
- callback-framed
- outbound
- administrative
- nas-prompt
- authenticate-only
- callback-nas-prompt
- call-check
- callback-administrative
description: Deprecated, please rename it to switch_controller_service_type. RADIUS
service type.
elements: str
type: list
tertiary-secret:
description: (list) Deprecated, please rename it to tertiary_secret. Secret key
to access the tertiary server.
type: raw
tertiary-server:
description: Deprecated, please rename it to tertiary_server. No description
type: str
timeout:
description: Time in seconds between re-sending authentication requests.
type: int
tls-min-proto-version:
choices:
- default
- TLSv1
- TLSv1-1
- TLSv1-2
- SSLv3
- TLSv1-3
description: Deprecated, please rename it to tls_min_proto_version. Minimum supported
protocol version for TLS connections
type: str
transport-protocol:
choices:
- udp
- tcp
- tls
description: Deprecated, please rename it to transport_protocol. Transport protocol
to be used
type: str
use-management-vdom:
choices:
- disable
- enable
description: Deprecated, please rename it to use_management_vdom. Enable/disable
using management VDOM to send requests.
type: str
username-case-sensitive:
choices:
- disable
- enable
description: Deprecated, please rename it to username_case_sensitive. Enable/disable
case sensitive user names.
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
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