fmgd_system_externalresource – Configure external resource.
Added in version 1.1.0.
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 v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible-core>=2.16.0
FortiManager Version Compatibility
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- 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
- 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
- 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
- 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
- device - The parameter in requested url type: str required: true
- vdom - The parameter in requested url type: str required: true
- system_externalresource - Configure external resource. type: dict
- category User resource category. type: int more...
- comments Comment. type: str more...
- interface Support meta variable type: list more...
- interface_select_method (Alias name: interface-select-method) Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify] more...
- name External resource name. type: str more...
- password Http basic authentication password. type: list more...
- proxy Proxy. type: str more...
- proxy_password (Alias name: proxy-password) Proxy password. type: list more...
- proxy_port (Alias name: proxy-port) Proxy port. type: int more...
- proxy_username (Alias name: proxy-username) Proxy username. type: str more...
- refresh_rate (Alias name: refresh-rate) Time interval to refresh external resource (1 - 43200 min, default = 5 min). type: int more...
- resource Url of external resource. type: str more...
- server_identity_check (Alias name: server-identity-check) Certificate verification option. type: str choices: [none, basic, full] more...
- source_ip (Alias name: source-ip) Support meta variable type: str more...
- status Enable/disable user resource. type: str choices: [disable, enable] more...
- type User resource type. type: str choices: [category, address, domain, malware, url, data, mac-address, generic-address] more...
- update_method (Alias name: update-method) External resource update method. type: str choices: [feed, push] more...
- user_agent (Alias name: user-agent) Http user-agent header (default = curl/7. type: str more...
- username Http basic authentication user name. type: str more...
- uuid Universally unique identifier (uuid; automatically assigned but can be manually reset). type: str more...
- dynamic_mapping Dynamic mapping. type: list more...
- address_comment_field (Alias name: address-comment-field) Json path to address description in generic address entry. type: str more...
- client_cert (Alias name: client-cert) Client certificate name. type: list more...
- namespace Generic external connector address namespace. type: str more...
- object_array_path (Alias name: object-array-path) Json path to array of generic addresses in resource. type: str more...
- source_ip_interface (Alias name: source-ip-interface) Ipv4 source interface for communication with the server. type: list more...
- client_cert_auth (Alias name: client-cert-auth) Enable/disable using client certificate for tls authentication. type: str choices: [disable, enable] more...
- vrf_select (Alias name: vrf-select) Vrf id used for connection to server. type: int more...
- address_data_field (Alias name: address-data-field) Json path to address data in generic address entry. type: str more...
- address_name_field (Alias name: address-name-field) Json path to address name in generic address entry. 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: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure external resource.
fortinet.fmgdevice.fmgd_system_externalresource:
# bypass_validation: false
# workspace_locking_adom: <global or your adom name>
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device: <your own value>
vdom: <your own value>
state: present # <value in [present, absent]>
system_externalresource:
name: "your value" # Required variable, string
# category: <integer>
# comments: <string>
# interface: <list or string>
# interface_select_method: <value in [auto, sdwan, specify]>
# password: <list or string>
# proxy: <string>
# proxy_password: <list or string>
# proxy_port: <integer>
# proxy_username: <string>
# refresh_rate: <integer>
# resource: <string>
# server_identity_check: <value in [none, basic, full]>
# source_ip: <string>
# status: <value in [disable, enable]>
# type: <value in [category, address, domain, ...]>
# update_method: <value in [feed, push]>
# user_agent: <string>
# username: <string>
# uuid: <string>
# dynamic_mapping:
# - _scope:
# - name: <string>
# vdom: <string>
# source_ip: <string>
# address_comment_field: <string>
# client_cert: <list or string>
# namespace: <string>
# object_array_path: <string>
# source_ip_interface: <list or string>
# client_cert_auth: <value in [disable, enable]>
# vrf_select: <integer>
# address_data_field: <string>
# address_name_field: <string>
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:
- meta - The result of the request.returned: always type: dict
- 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_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.