Try SpotterConfigure user groups in Fortinet's FortiOS and FortiGate.
| "added in version" 2.9 of ansible.builtin"
Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)
preview | supported by community
pipInstall with pip install ansible==2.9.27
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and group category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
tasks:
- name: Configure user groups.
fortios_user_group:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
state: "present"
user_group:
auth_concurrent_override: "enable"
auth_concurrent_value: "4"
authtimeout: "5"
company: "optional"
email: "disable"
expire: "8"
expire_type: "immediately"
group_type: "firewall"
guest:
-
comment: "Comment."
company: "<your_own_value>"
email: "<your_own_value>"
expiration: "<your_own_value>"
mobile_phone: "<your_own_value>"
name: "default_name_17"
password: "<your_own_value>"
sponsor: "<your_own_value>"
user_id: "<your_own_value>"
http_digest_realm: "<your_own_value>"
id: "22"
match:
-
group_name: "<your_own_value>"
id: "25"
server_name: "<your_own_value> (source user.radius.name user.ldap.name user.tacacs+.name)"
max_accounts: "27"
member:
-
name: "default_name_29 (source user.peer.name user.local.name user.radius.name user.tacacs+.name user.ldap.name user.adgrp.name user.pop3.name)"
mobile_phone: "disable"
multiple_guest_add: "disable"
name: "default_name_32"
password: "auto-generate"
sms_custom_server: "<your_own_value> (source system.sms-server.name)"
sms_server: "fortiguard"
sponsor: "optional"
sso_attribute_value: "<your_own_value>"
user_id: "email"
user_name: "disable"
host:
description:
- FortiOS or FortiGate IP address.
required: false
type: str
vdom:
default: root
description:
- Virtual domain, among those defined previously. A vdom is a virtual instance of
the FortiGate that can be configured and used as a different unit.
type: str
https:
default: true
description:
- Indicates if the requests towards FortiGate must use HTTPS protocol.
type: bool
state:
choices:
- present
- absent
description:
- Indicates whether to create or remove the object.
required: true
type: str
password:
default: ''
description:
- FortiOS or FortiGate password.
type: str
username:
description:
- FortiOS or FortiGate username.
required: false
type: str
ssl_verify:
default: true
description:
- Ensures FortiGate certificate must be verified by a proper CA.
type: bool
user_group:
default: null
description:
- Configure user groups.
suboptions:
auth_concurrent_override:
choices:
- enable
- disable
description:
- Enable/disable overriding the global number of concurrent authentication sessions
for this user group.
type: str
auth_concurrent_value:
description:
- Maximum number of concurrent authenticated connections per user (0 - 100).
type: int
authtimeout:
description:
- Authentication timeout in minutes for this user group. 0 to use the global user
setting auth-timeout.
type: int
company:
choices:
- optional
- mandatory
- disabled
description:
- Set the action for the company guest user field.
type: str
email:
choices:
- disable
- enable
description:
- Enable/disable the guest user email address field.
type: str
expire:
description:
- Time in seconds before guest user accounts expire. (1 - 31536000 sec)
type: int
expire_type:
choices:
- immediately
- first-successful-login
description:
- Determine when the expiration countdown begins.
type: str
group_type:
choices:
- firewall
- fsso-service
- rsso
- guest
description:
- Set the group to be for firewall authentication, FSSO, RSSO, or guest users.
type: str
guest:
description:
- Guest User.
suboptions:
comment:
description:
- Comment.
type: str
company:
description:
- Set the action for the company guest user field.
type: str
email:
description:
- Email.
type: str
expiration:
description:
- Expire time.
type: str
mobile_phone:
description:
- Mobile phone.
type: str
name:
description:
- Guest name.
type: str
password:
description:
- Guest password.
type: str
sponsor:
description:
- Set the action for the sponsor guest user field.
type: str
user_id:
description:
- Guest ID.
type: str
type: list
http_digest_realm:
description:
- Realm attribute for MD5-digest authentication.
type: str
id:
description:
- Group ID.
type: int
match:
description:
- Group matches.
suboptions:
group_name:
description:
- Name of matching group on remote authentication server.
type: str
id:
description:
- ID.
required: true
type: int
server_name:
description:
- Name of remote auth server. Source user.radius.name user.ldap.name user.tacacs+.name.
type: str
type: list
max_accounts:
description:
- Maximum number of guest accounts that can be created for this group (0 means
unlimited).
type: int
member:
description:
- Names of users, peers, LDAP servers, or RADIUS servers to add to the user group.
suboptions:
name:
description:
- Group member name. Source user.peer.name user.local.name user.radius.name
user.tacacs+.name user.ldap.name user.adgrp.name user .pop3.name.
required: true
type: str
type: list
mobile_phone:
choices:
- disable
- enable
description:
- Enable/disable the guest user mobile phone number field.
type: str
multiple_guest_add:
choices:
- disable
- enable
description:
- Enable/disable addition of multiple guests.
type: str
name:
description:
- Group name.
required: true
type: str
password:
choices:
- auto-generate
- specify
- disable
description:
- Guest user password type.
type: str
sms_custom_server:
description:
- SMS server. Source system.sms-server.name.
type: str
sms_server:
choices:
- fortiguard
- custom
description:
- Send SMS through FortiGuard or other external server.
type: str
sponsor:
choices:
- optional
- mandatory
- disabled
description:
- Set the action for the sponsor guest user field.
type: str
sso_attribute_value:
description:
- Name of the RADIUS user group that this local user group represents.
type: str
user_id:
choices:
- email
- auto-generate
- specify
description:
- Guest user ID type.
type: str
user_name:
choices:
- disable
- enable
description:
- Enable/disable the guest user name entry.
type: str
type: dict
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str