fortios_vpn_kmip_server – KMIP server entry configuration in Fortinet’s FortiOS and FortiGate.
New in version 2.0.0.
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn feature and kmip_server category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v7.4.0 -> 7.4.3
Parameters
- 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
- vpn_kmip_server - KMIP server entry configuration. type: dict more...
- interface - Specify outgoing interface to reach server. Source system.interface.name. type: str more...
- interface_select_method - Specify how to select outgoing interface to reach server. type: str choices: auto, sdwan, specify more...
- name - KMIP server entry name. type: str required: true more...
- password - Password to use for connectivity to the KMIP server. type: str more...
- server_identity_check - Enable/disable KMIP server identity check (verify server FQDN/IP address against the server certificate). type: str choices: enable, disable more...
- server_list - KMIP server list. type: list member_path: server_list:id more...
- cert - Client certificate to use for connectivity to the KMIP server. Source vpn.certificate.local.name. type: str more...
- id - ID see Notes. type: int required: true more...
- port - KMIP server port. type: int more...
- server - KMIP server FQDN or IP address. type: str more...
- status - Enable/disable KMIP server. type: str choices: enable, disable more...
- source_ip - FortiGate IP address to be used for communication with the KMIP server. type: str more...
- ssl_min_proto_version - Minimum supported protocol version for SSL/TLS connections . type: str choices: default, SSLv3, TLSv1, TLSv1-1, TLSv1-2, TLSv1-3 more...
- username - User name to use for connectivity to the KMIP server. type: str more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: KMIP server entry configuration.
fortinet.fortios.fortios_vpn_kmip_server:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_kmip_server:
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
name: "default_name_5"
password: "<your_own_value>"
server_identity_check: "enable"
server_list:
-
cert: "<your_own_value> (source vpn.certificate.local.name)"
id: "10"
port: "5696"
server: "192.168.100.40"
status: "enable"
source_ip: "84.230.14.43"
ssl_min_proto_version: "default"
username: "<your_own_value>"
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:
- 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
Status
This module is not guaranteed to have a backwards compatible interface.