fortios_firewall_proxy_addrgrp – Configure web proxy address group in Fortinet’s FortiOS and FortiGate.
New in version 2.0.0.
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and proxy_addrgrp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
Parameters
- 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
- firewall_proxy_addrgrp - Configure web proxy address group. type: dict more...
- color - Integer value to determine the color of the icon in the GUI (1 - 32). type: int more...
- comment - Optional comments. type: str more...
- member - Members of address group. type: list member_path: member:name more...
- name - Address name. Source firewall.proxy-address.name firewall.proxy-addrgrp.name. type: str required: true more...
- name - Address group name. type: str required: true more...
- tagging - Config object tagging. type: list member_path: tagging:name more...
- category - Tag category. Source system.object-tagging.category. type: str more...
- name - Tagging entry name. type: str required: true more...
- tags - Tags. type: list member_path: tagging:name/tags:name more...
- name - Tag name. Source system.object-tagging.tags.name. type: str required: true more...
- type - Source or destination address group type. type: str choices: src, dst more...
- uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
- visibility - Enable/disable visibility of the object in the GUI. type: str choices: enable, disable more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure web proxy address group.
fortinet.fortios.fortios_firewall_proxy_addrgrp:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_proxy_addrgrp:
color: "0"
comment: "Optional comments."
member:
-
name: "default_name_6 (source firewall.proxy-address.name firewall.proxy-addrgrp.name)"
name: "default_name_7"
tagging:
-
category: "<your_own_value> (source system.object-tagging.category)"
name: "default_name_10"
tags:
-
name: "default_name_12 (source system.object-tagging.tags.name)"
type: "src"
uuid: "<your_own_value>"
visibility: "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:
- 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
Status
This module is not guaranteed to have a backwards compatible interface.