fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_system_externalresource Configure external resource. | "added in version" 2.0.0 of fortinet.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communityfortinet.fortimanager.fmgr_system_externalresource (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- name: Example playbook hosts: fortimanagers connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Configure external resource. fortinet.fortimanager.fmgr_system_externalresource: bypass_validation: false adom: ansible state: present system_externalresource: category: 0 comments: string name: string refresh-rate: 1 resource: string status: disable type: category # <value in [category, address, domain, ...]>
- name: Gathering fortimanager facts hosts: fortimanagers gather_facts: false connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Retrieve all the external resources fortinet.fortimanager.fmgr_fact: facts: selector: "system_externalresource" params: adom: "ansible" external-resource: "your_value"
adom: description: The parameter (adom) in requested url. required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int type: list enable_log: default: false description: Enable/Disable logging for task. type: bool access_token: description: The token to access FortiManager without using username and password. type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str system_externalresource: description: The top level parameters set. required: false suboptions: category: description: User resource category. type: int comments: description: Comment. type: str interface: description: Specify outgoing interface to reach server. type: str interface-select-method: choices: - auto - sdwan - specify description: Deprecated, please rename it to interface_select_method. Specify how to select outgoing interface to reach server. type: str name: description: External resource name. required: true type: str password: description: (list) HTTP basic authentication password. type: raw refresh-rate: description: Deprecated, please rename it to refresh_rate. Time interval to refresh external resource type: int resource: description: URI of external resource. type: str server-identity-check: choices: - none - basic - full description: Deprecated, please rename it to server_identity_check. Certificate verification option. type: str source-ip: description: Deprecated, please rename it to source_ip. Source IPv4 address used to communicate with server. type: str status: choices: - disable - enable description: Enable/disable user resource. type: str type: choices: - category - address - domain - malware - url - mac-address - data description: User resource type. type: str update-method: choices: - feed - push description: Deprecated, please rename it to update_method. External resource update method. type: str user-agent: description: Deprecated, please rename it to user_agent. Override HTTP User-Agent header used when retrieving this external resource. type: str username: description: HTTP basic authentication user name. type: str uuid: description: Universally Unique Identifier type: str type: dict workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. type: int
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list