fortinet.fortimanager.fmgr_system_interface module – Interface configuration.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.0).
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.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_interface
.
New in fortinet.fortimanager 1.0.0
Synopsis
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.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The top level parameters set. |
|
Aggregate interface. |
|
Alias. |
|
Allow management access to interface. ping - PING access. https - HTTPS access. ssh - SSH access. snmp - SNMP access. http - HTTP access. webservice - Web service access. https-logging - Logging over HTTPS access. Choices:
|
|
Enable/disable default gateway. disable - Disable setting. enable - Enable setting. Choices:
|
|
Description. |
|
Deprecated, please rename it to dhcp_client_identifier. DHCP client identifier. |
|
Deprecated, please rename it to dns_server_override. Enable/disable use DNS acquired by DHCP or PPPoE. disable - Disable setting. enable - Enable setting. Choices:
|
|
Underlying interface name. |
|
IP address of interface. |
|
Ipv6. |
|
Deprecated, please rename it to ip6_address. IPv6 address/prefix of interface. |
|
Deprecated, please rename it to ip6_allowaccess. Allow management access to interface. ping - PING access. https - HTTPS access. ssh - SSH access. snmp - SNMP access. http - HTTP access. webservice - Web service access. https-logging - Logging over HTTPS access. Choices:
|
|
Deprecated, please rename it to ip6_autoconf. Enable/disable address auto config disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to lacp_mode. LACP mode. active - Actively use LACP to negotiate 802. Choices:
|
|
Deprecated, please rename it to lacp_speed. How often the interface sends LACP messages. slow - Send LACP message every 30 seconds. fast - Send LACP message every second. Choices:
|
|
Deprecated, please rename it to link_up_delay. Number of milliseconds to wait before considering a link is up. |
|
Enable/disable LLDP disable - Disable setting. enable - Enable setting. Choices:
|
|
Member. |
|
Deprecated, please rename it to interface_name. Physical interface name. |
|
Deprecated, please rename it to min_links. Minimum number of aggregated ports that must be up. |
|
Deprecated, please rename it to min_links_down. Action to take when less than the configured minimum number of links are active. operational - Set the aggregate operationally down. administrative - Set the aggregate administratively down. Choices:
|
|
Addressing mode static - Static setting. dhcp - External DHCP client mode. Choices:
|
|
Maximum transportation unit |
|
Deprecated, please rename it to mtu_override. Enable/disable use MTU acquired by DHCP or PPPoE. disable - Disable setting. enable - Enable setting. Choices:
|
|
Interface name. |
|
Deprecated, please rename it to rating_service_ip. IP address for fgt rating service, must be same subnet with interface ip. |
|
Allow service access to interface. fgtupdates - FortiGate updates access. fclupdates - FortiClient updates access. webfilter-antispam - Web filtering and antispam access. Choices:
|
|
Speed. auto - Auto adjust speed. 10full - 10M full-duplex. 10half - 10M half-duplex. 100full - 100M full-duplex. 100half - 100M half-duplex. 1000full - 1000M full-duplex. 10000full - 10000M full-duplex. Choices:
|
|
Interface status. down - Interface down. up - Interface up. Choices:
|
|
Interface type. vlan - VLAN interface. physical - Physical interface. aggregate - Aggregate interface. Choices:
|
|
Deprecated, please rename it to update_service_ip. IP address for fgt/fct update service, must be same subnet with interfa… |
|
Deprecated, please rename it to vlan_protocol. Ethernet protocol of VLAN. 8021q - IEEE 802. 8021ad - IEEE 802. Choices:
|
|
VLAN ID |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Interface configuration.
fortinet.fortimanager.fmgr_system_interface:
bypass_validation: false
state: present
system_interface:
allowaccess:
- ping
ip: "222.222.22.2/24"
mtu: 1500
name: port4
serviceaccess:
- fgtupdates
speed: auto # <value in [auto, 10full, 10half, ...]>
status: up
- 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 interfaces
fortinet.fortimanager.fmgr_fact:
facts:
selector: "system_interface"
params:
interface: "your_value"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |