source: | fortios_user_krb_keytab.py |
---|---|
orphan: |
.. versionadded:: 2.0.0
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and krb_keytab category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
The below requirements are needed on the host that executes this module.
- ansible>=2.14
Using member operation to add an element to an existing object.
Supported Version Ranges | |
fortios_user_krb_keytab | v6.0.0 -> latest |
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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 default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- user_krb_keytab - Configure Kerberos keytab entries. type: dict
more...
Supported Version Ranges user_krb_keytab v6.0.0 -> latest
- keytab - Base64 coded keytab file containing a pre-shared key. type: str
more...
Supported Version Ranges keytab v6.0.0 -> latest
- ldap_server - LDAP server name(s). Source user.ldap.name. type: list member_path: ldap_server:name
more...
Supported Version Ranges ldap_server v6.0.0 -> latest
- name - LDAP server name. Source user.ldap.name. type: str required: true
more...
Supported Version Ranges name v6.4.4 -> latest
- name - Kerberos keytab entry name. type: str required: true
more...
Supported Version Ranges name v6.0.0 -> latest
- pac_data - Enable/disable parsing PAC data in the ticket. type: str choices: enable, disable
more...
Supported Version Ranges pac_data v6.2.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- password - Password for keytab. type: str
more...
Supported Version Ranges password v6.2.3 -> v6.2.3
- principal - Kerberos service principal. For example, HTTP/myfgt.example.com@example.com. type: str
more...
Supported Version Ranges principal v6.0.0 -> latest
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- name: Configure Kerberos keytab entries.
fortinet.fortios.fortios_user_krb_keytab:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_krb_keytab:
keytab: "<your_own_value>"
ldap_server:
-
name: "default_name_5 (source user.ldap.name)"
name: "default_name_6"
pac_data: "enable"
password: "<your_own_value>"
principal: "<your_own_value>"
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:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
- This module is not guaranteed to have a backwards compatible interface.
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can create a pull request to improve it.