fmgr_icap_profile – Configure ICAP profiles.¶
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.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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
- icap_profile - Configure ICAP profiles. type: dict
- methods - No description for the parameter type: array choices: [delete, get, head, options, post, put, trace, other]
- name - ICAP profile name. type: str
- replacemsg-group - Replacement message group. type: str
- request - Enable/disable whether an HTTP request is passed to an ICAP server. type: str choices: [disable, enable]
- request-failure - Action to take if the ICAP server cannot be contacted when processing an HTTP request. type: str choices: [error, bypass]
- request-path - Path component of the ICAP URI that identifies the HTTP request processing service. type: str
- request-server - ICAP server to use for an HTTP request. type: str
- response - Enable/disable whether an HTTP response is passed to an ICAP server. type: str choices: [disable, enable]
- response-failure - Action to take if the ICAP server cannot be contacted when processing an HTTP response. type: str choices: [error, bypass]
- response-path - Path component of the ICAP URI that identifies the HTTP response processing service. type: str
- response-server - ICAP server to use for an HTTP response. type: str
- streaming-content-bypass - Enable/disable bypassing of ICAP server for streaming content. type: str choices: [disable, enable]
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¶
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure ICAP profiles.
fmgr_icap_profile:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
icap_profile:
methods:
- delete
- get
- head
- options
- post
- put
- trace
- other
name: <value of string>
replacemsg-group: <value of string>
request: <value in [disable, enable]>
request-failure: <value in [error, bypass]>
request-path: <value of string>
request-server: <value of string>
response: <value in [disable, enable]>
response-failure: <value in [error, bypass]>
response-path: <value of string>
response-server: <value of string>
streaming-content-bypass: <value in [disable, enable]>
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