fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_firewall_addrgrp Configure IPv4 address groups. | "added in version" 1.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_firewall_addrgrp (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 IPv4 address groups. fortinet.fortimanager.fmgr_firewall_addrgrp: bypass_validation: false adom: ansible state: present firewall_addrgrp: allow-routing: disable color: 0 member: "ansible-test1" # IPv4 address name name: "ansible-addrgrp4" # could not the same with other group, adress name, including IPv6 group and address visibility: disable
- 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 IPv4 address groups fortinet.fortimanager.fmgr_fact: facts: selector: "firewall_addrgrp" params: adom: "ansible" addrgrp: "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 firewall_addrgrp: description: The top level parameters set. required: false suboptions: _image-base64: description: Deprecated, please rename it to _image_base64. _Image-Base64. type: str allow-routing: choices: - disable - enable description: Deprecated, please rename it to allow_routing. Enable/disable use of this group in the static route configuration. type: str category: choices: - default - ztna-ems-tag - ztna-geo-tag description: Address group category. type: str color: description: Color of icon on the GUI. type: int comment: description: (dict or str) No description. type: raw dynamic_mapping: description: Dynamic_Mapping. elements: dict suboptions: _image-base64: description: Deprecated, please rename it to _image_base64. _Image-Base64. type: str _scope: description: _Scope. elements: dict suboptions: name: description: Name. type: str vdom: description: Vdom. type: str type: list allow-routing: choices: - disable - enable description: Deprecated, please rename it to allow_routing. Enable/disable use of this group in the static route configuration. type: str category: choices: - default - ztna-ems-tag - ztna-geo-tag description: Address group category. type: str color: description: Color of icon on the GUI. type: int comment: description: (dict or str) No description. type: raw exclude: choices: - disable - enable description: Enable/disable address exclusion. type: str exclude-member: description: (list or str) Deprecated, please rename it to exclude_member. Address exclusion member. type: raw fabric-object: choices: - disable - enable description: Deprecated, please rename it to fabric_object. Security Fabric global object setting. type: str global-object: description: Deprecated, please rename it to global_object. Global-Object. type: int member: description: Address objects contained within the group. elements: str type: list tags: description: (list or str) Tags. type: raw type: choices: - default - array - folder description: Type. type: str uuid: description: Universally Unique Identifier type: str visibility: choices: - disable - enable description: Enable/disable address visibility in the GUI. type: str type: list exclude: choices: - disable - enable description: Enable/disable address exclusion. type: str exclude-member: description: (list or str) Deprecated, please rename it to exclude_member. Address exclusion member. type: raw fabric-object: choices: - disable - enable description: Deprecated, please rename it to fabric_object. Security Fabric global object setting. type: str global-object: description: Deprecated, please rename it to global_object. Global Object. type: int member: description: Address objects contained within the group. elements: str type: list name: description: Address group name. required: true type: str tagging: description: Tagging. elements: dict suboptions: category: description: Tag category. type: str name: description: Tagging entry name. type: str tags: description: (list) Tags. type: raw type: list tags: description: Name type: str type: choices: - default - array - folder description: Address group type. type: str uuid: description: Universally Unique Identifier type: str visibility: choices: - disable - enable description: Enable/disable address visibility in the GUI. type: str type: dict 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 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