Note
This module is part of the fortinet.fortios collection [version 2.1.7].
You might already have this collection installed if you are using the ansible
package. It is not included in
ansible-core
. To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortios
.
To use it in a playbook, specify: fortinet.fortios.fortios_system_arp_table
.
New in version 2.0.0: of fortinet.fortios
Synopsis
This module is able to configure a FortiGate or FortiOS [FOS] device by allowing the user to set and modify system feature and arp_table 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.9
Parameters
access_token string | Token-based authentication. Generated from GUI of Fortigate. |
enable_log boolean | Enable/Disable logging for task. Choices:
|
member_path string | Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
member_state string | Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
state string / required | Indicates whether to create or remove the object. Choices:
|
system_arp_table dictionary | Configure ARP table. |
id integer / required | Unique integer ID of the entry. |
interface string | Interface name. Source system.interface.name. |
ip string | IP address. |
mac string | MAC address. |
vdom string | 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. Default: “root” |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- 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: Configure ARP table. fortios_system_arp_table: vdom: "{{ vdom }}" state: "present" access_token: "" system_arp_table: id: "3" interface: " [source system.interface.name]" ip: "" mac: ""
Return Values
Common return values are documented here, the following are the fields unique to this module:
build string | Build number of the fortigate image Returned: always Sample: “1547” |
http_method string | Last method used to provision the content into FortiGate Returned: always Sample: “PUT” |
http_status string | Last result given by FortiGate on last operation applied Returned: always Sample: “200” |
mkey string | Master key [id] used in the last call to FortiGate Returned: success Sample: “id” |
name string | Name of the table used to fulfill the request Returned: always Sample: “urlfilter” |
path string | Path of the table used to fulfill the request Returned: always Sample: “webfilter” |
revision string | Internal revision number Returned: always Sample: “17.0.2.10658” |
serial string | Serial number of the unit Returned: always Sample: “FGVMEVYYQT3AB5352” |
status string | Indication of the operation’s result Returned: always Sample: “success” |
vdom string | Virtual domain used Returned: always Sample: “root” |
version string | Version of the FortiGate Returned: always Sample: “v5.6.3” |
Authors
Link Zheng [@chillancezen]
Jie Xue [@JieX19]
Hongbin Lu [@fgtdev-hblu]
Frank Shen [@frankshen01]
Miguel Angel Munoz [@mamunozgonzalez]
Nicolas Thomas [@thomnico]
Collection links
Issue Tracker Homepage Repository [Sources]