fmgr_certificate_template¶
New in version 2.10.
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.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
6.2.1 |
6.2.3 |
6.2.5 |
6.4.0 |
6.4.2 |
6.4.5 |
7.0.0 |
7.2.0 |
|
| certificate_template | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- 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
- 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
- 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
- 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
- adom - The parameter in requested url type: str required: true
- certificate_template - no description type: dict
- city - City. type: str more...
- country - Country. type: str more...
- digest-type - Digest-Type. type: str choices: [sha1, sha256] default: sha1 more...
- email - Email. type: str more...
- id-type - Id-Type. type: str choices: [host-ip, domain-name, email] default: host-ip more...
- key-size - Key-Size. type: str choices: [512, 1024, 1536, 2048, 4096] default: 2048 more...
- key-type - Key-Type. type: str choices: [rsa, ec] default: rsa more...
- name - Name. type: str more...
- organization - Organization. type: str more...
- organization-unit - Organization-Unit. type: str more...
- scep-password - Scep-Password. type: str more...
- scep-server - Scep-Server. type: str more...
- state - State. type: str more...
- subject-name - Subject-Name. type: str more...
- type - Type. type: str choices: [external, local] default: external more...
- curve-name - Curve-Name. type: str choices: [secp256r1, secp384r1, secp521r1] default: secp256r1 more...
- scep-ca-identifier - No description for the parameter type: str more...
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¶
- name: gathering fortimanager facts
hosts: fortimanager00
gather_facts: no
connection: httpapi
collections:
- fortinet.fortimanager
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: retrieve all the scripts
fmgr_fact:
facts:
selector: 'certificate_template'
params:
adom: 'ansible'
template: 'your_value'
- hosts: fortimanager00
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: no description
fmgr_certificate_template:
adom: ansible
state: present
certificate_template:
#digest-type: sha1
id-type: host-ip
key-size: 512
key-type: rsa
name: 'ansible-test'
scep-password: 'fortinet1'
type: external
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:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict