:source: fmgr_system_externalresource.py
:orphan:
.. _fmgr_system_externalresource:
fmgr_system_externalresource -- Configure external resource.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.0.0
.. warning::
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0: ``var-name``, ``var name``, ``var.name``
- New argument name starting in 3.0.0: ``var_name``
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name.
You will receive deprecation warnings if you keep using the previous argument name.
You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
.. contents::
:local:
:depth: 1
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
----------------------------------
.. raw:: html
Supported Version Ranges: v6.0.0 -> latest
Parameters
----------
.. raw:: html
- 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
- revision_note - The change note that can be specified when an object is created or updated. type: string required: false
- adom - The parameter in requested url type: str required: true
- system_externalresource - Configure external resource. type: dict
- category User resource category. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- comments Comment. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- name External resource name. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- refresh_rate (Alias name: refresh-rate) Time interval to refresh external resource (1 - 43200 min, default = 5 min). type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- resource Uri of external resource. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- status Enable/disable user resource. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- type User resource type. type: str choices: [category, address, domain, malware, url, mac-address, data, generic-address]
more...
Supported Version Ranges: v6.0.0 -> latest
- password Http basic authentication password. type: list
more...
Supported Version Ranges: v6.2.0 -> latest
- source_ip (Alias name: source-ip) Source ipv4 address used to communicate with server. type: str
more...
Supported Version Ranges: v6.2.1 -> latest
- username Http basic authentication user name. type: str
more...
Supported Version Ranges: v6.2.0 -> latest
- interface Specify outgoing interface to reach server. type: str
more...
Supported Version Ranges: v6.4.2 -> latest
- interface_select_method (Alias name: interface-select-method) Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify]
more...
Supported Version Ranges: v6.4.2 -> latest
- user_agent (Alias name: user-agent) Override http user-agent header used when retrieving this external resource. type: str
more...
Supported Version Ranges: v6.4.2 -> latest
- uuid Universally unique identifier (uuid; automatically assigned but can be manually reset). type: str
more...
Supported Version Ranges: v7.0.0 -> latest
- server_identity_check (Alias name: server-identity-check) Certificate verification option. type: str choices: [none, basic, full]
more...
Supported Version Ranges: v7.0.5 -> v7.0.16, v7.2.2 -> latest
- update_method (Alias name: update-method) External resource update method. type: str choices: [feed, push]
more...
Supported Version Ranges: v7.2.1 -> latest
- address_comment_field (Alias name: address-comment-field) Json path to address description in generic address entry. type: str
more...
Supported Version Ranges: v7.6.2 -> latest
- address_data_field (Alias name: address-data-field) Json path to address data in generic address entry. type: str
more...
Supported Version Ranges: v7.6.2 -> latest
- address_name_field (Alias name: address-name-field) Json path to address name in generic address entry. type: str
more...
Supported Version Ranges: v7.6.2 -> latest
- client_cert (Alias name: client-cert) Client certificate name. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- client_cert_auth (Alias name: client-cert-auth) Enable/disable using client certificate for tls authentication. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.2 -> latest
- dynamic_mapping Dynamic mapping. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- _scope Scope. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- name Name. type: str
more...
Supported Version Ranges: v7.6.2 -> latest
- vdom Vdom. type: str
more...
Supported Version Ranges: v7.6.2 -> latest
- source_ip (Alias name: source-ip) Source ip. type: str
more...
Supported Version Ranges: v7.6.2 -> latest
- namespace Generic external connector address namespace. type: str
more...
Supported Version Ranges: v7.6.2 -> latest
- object_array_path (Alias name: object-array-path) Json path to array of generic addresses in resource. type: str
more...
Supported Version Ranges: v7.6.2 -> latest
- vrf_select (Alias name: vrf-select) Vrf id used for connection to server. type: int
more...
Supported Version Ranges: v7.6.2 -> latest
- proxy Proxy. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- proxy_password (Alias name: proxy-password) Proxy password. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- proxy_port (Alias name: proxy-port) Proxy port. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- proxy_username (Alias name: proxy-username) Proxy username. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- source_ip_interface (Alias name: source-ip-interface) Ipv4 source interface for communication with the server. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
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
--------
.. code-block:: yaml+jinja
- name: Example playbook
hosts: fortimanagers
gather_facts: false
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 #
- 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"
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:
.. raw:: html
- 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.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)