| source: | fortios_system_vdom_exception.py |
|---|---|
| orphan: |
fortios_system_vdom_exception -- Global configuration objects that can be configured independently across different ha peers for all VDOMs or for the defined VDOM scope in Fortinet's FortiOS and FortiGate.
.. versionadded:: 2.0.0
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and vdom_exception category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
The below requirements are needed on the host that executes this module.
- ansible>=2.9
Using member operation to add an element to an existing object.
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.0.12 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
v7.2.4 |
v7.4.0 |
|
| fortios_system_vdom_exception | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- system_vdom_exception - Global configuration objects that can be configured independently across different ha peers for all VDOMs or for the defined VDOM scope. type: dict
more...
v6.0.0v6.0.5v6.0.11v6.2.0v6.2.3v6.2.5v6.2.7v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0system_vdom_exception yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - id - Index (1 - 4096). type: int required: true
more...
v6.0.0v6.0.5v6.0.11v6.2.0v6.2.3v6.2.5v6.2.7v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0id yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - object - Name of the configuration object that can be configured independently for all VDOMs. type: str choices: log.fortianalyzer.setting, log.fortianalyzer.override-setting, log.fortianalyzer2.setting, log.fortianalyzer2.override-setting, log.fortianalyzer3.setting, log.fortianalyzer3.override-setting, log.fortianalyzer-cloud.setting, log.fortianalyzer-cloud.override-setting, log.syslogd.setting, log.syslogd.override-setting, log.syslogd2.setting, log.syslogd2.override-setting, log.syslogd3.setting, log.syslogd3.override-setting, log.syslogd4.setting, log.syslogd4.override-setting, system.gre-tunnel, system.central-management, system.csf, user.radius, system.interface, vpn.ipsec.phase1-interface, vpn.ipsec.phase2-interface, router.bgp, router.route-map, router.prefix-list, firewall.ippool, firewall.ippool6, router.static, router.static6, firewall.vip, firewall.vip6, system.sdwan, system.saml, router.policy, router.policy6, log.syslogd.setting, log.syslogd.override-setting, firewall.vip46, firewall.vip64
more...
v6.0.0v6.0.5v6.0.11v6.2.0v6.2.3v6.2.5v6.2.7v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0object yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [log.fortianalyzer.setting] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [log.fortianalyzer.override-setting] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [log.fortianalyzer2.setting] yes no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [log.fortianalyzer2.override-setting] yes no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [log.fortianalyzer3.setting] yes no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [log.fortianalyzer3.override-setting] yes no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [log.fortianalyzer-cloud.setting] no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [log.fortianalyzer-cloud.override-setting] no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [log.syslogd.setting] no no no no no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [log.syslogd.override-setting] no no no no no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [log.syslogd2.setting] no no no no no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [log.syslogd2.override-setting] no no no no no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [log.syslogd3.setting] no no no no no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [log.syslogd3.override-setting] no no no no no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [log.syslogd4.setting] no no no no no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [log.syslogd4.override-setting] no no no no no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [system.gre-tunnel] no no no no no no no no no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes [system.central-management] yes no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [system.csf] yes no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [user.radius] yes no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [system.interface] no no no no no no no no no no no no no no no no no no no no no no no no no [vpn.ipsec.phase1-interface] no no no no no no no no no no no no no no no no no no no no no no no no no [vpn.ipsec.phase2-interface] no no no no no no no no no no no no no no no no no no no no no no no no no [router.bgp] no no no no no no no no no no no no no no no no no no no no no no no no no [router.route-map] no no no no no no no no no no no no no no no no no no no no no no no no no [router.prefix-list] no no no no no no no no no no no no no no no no no no no no no no no no no [firewall.ippool] no no no no no no no no no no no no no no no no no no no no no no no no no [firewall.ippool6] no no no no no no no no no no no no no no no no no no no no no no no no no [router.static] no no no no no no no no no no no no no no no no no no no no no no no no no [router.static6] no no no no no no no no no no no no no no no no no no no no no no no no no [firewall.vip] no no no no no no no no no no no no no no no no no no no no no no no no no [firewall.vip6] no no no no no no no no no no no no no no no no no no no no no no no no no [system.sdwan] no no no no no no no no no no no no no no no no no no no no no no no no no [system.saml] no no no no no no no no no no no no no no no no no no no no no no no no no [router.policy] no no no no no no no no no no no no no no no no no no no no no no no no no [router.policy6] no no no no no no no no no no no no no no no no no no no no no no no no no [log.syslogd.setting] no no no no no no no n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes [log.syslogd.override-setting] no no no no no no no n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes [firewall.vip46] no no no no no no no no no no no n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a [firewall.vip64] no no no no no no no no no no no n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a - oid - Object ID. type: int
more...
v6.0.0v6.0.5v6.0.11v6.2.0v6.2.3oid yes yes yes no yes - scope - Determine whether the configuration object can be configured separately for all VDOMs or if some VDOMs share the same configuration. type: str choices: all, inclusive, exclusive
more...
v6.0.0v6.0.5v6.0.11v6.2.0v6.2.3v6.2.5v6.2.7v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0scope yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [all] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [inclusive] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [exclusive] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - vdom - Names of the VDOMs. type: list member_path: vdom:name
more...
v6.0.0v6.0.5v6.0.11v6.2.0v6.2.3v6.2.5v6.2.7v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0vdom yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - VDOM name. Source system.vdom.name. type: str required: true
more...
v6.0.0v6.0.5v6.0.11v6.2.0v6.2.3v6.2.5v6.2.7v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Global configuration objects that can be configured independently across different ha peers for all VDOMs or for the defined VDOM scope.
fortios_system_vdom_exception:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_vdom_exception:
id: "3"
object: "log.fortianalyzer.setting"
oid: "32767"
scope: "all"
vdom:
-
name: "default_name_8 (source system.vdom.name)"
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:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
- This module is not guaranteed to have a backwards compatible interface.
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can create a pull request to improve it.