drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_system_interface Interface configuration. | "added in version" 1.0.0 of drmofu.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 communitydrmofu.fortimanager.fmgr_system_interface (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
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: gathering fortimanager facts hosts: fortimanager00 gather_facts: no connection: httpapi collections: - fortinet.fortimanager vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: retrieve all the interfaces fmgr_fact: facts: selector: 'system_interface' params: interface: 'your_value'
- hosts: fortimanager00 collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Interface configuration. 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
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 required: false type: list enable_log: default: false description: Enable/Disable logging for task. required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int required: false type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. required: false type: str system_interface: description: the top level parameters set required: false suboptions: aggregate: description: Aggregate interface. type: str alias: description: Alias. type: str allowaccess: choices: - ping - https - ssh - snmp - http - webservice - https-logging - soc-fabric description: Allow management access to interface. elements: str type: list description: description: Description. type: str interface: description: Underlying interface name. type: str ip: description: IP address of interface. type: str ipv6: description: no description required: false suboptions: ip6-address: description: IPv6 address/prefix of interface. type: str ip6-allowaccess: choices: - ping - https - ssh - snmp - http - webservice - https-logging description: Allow management access to interface. elements: str type: list ip6-autoconf: choices: - disable - enable description: - Enable/disable address auto config - disable - Disable setting. - enable - Enable setting. type: str type: dict lacp-mode: choices: - active description: - LACP mode. - active - Actively use LACP to negotiate 802. type: str lacp-speed: choices: - slow - fast description: - How often the interface sends LACP messages. - slow - Send LACP message every 30 seconds. - fast - Send LACP message every second. type: str link-up-delay: description: Number of milliseconds to wait before considering a link is up. type: int lldp: choices: - disable - enable description: - Enable/disable LLDP - disable - Disable setting. - enable - Enable setting. type: str member: description: description elements: dict suboptions: interface-name: description: Physical interface name. type: str type: list min-links: description: Minimum number of aggregated ports that must be up. type: int min-links-down: choices: - operational - administrative description: - 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. type: str mtu: description: Maximum transportation unit type: int name: description: Interface name. type: str rating-service-ip: description: IP address for fgt rating service, must be same subnet with interface ip. type: str serviceaccess: choices: - fgtupdates - fclupdates - webfilter-antispam description: Allow service access to interface. elements: str type: list speed: choices: - auto - 10full - 10half - 100full - 100half - 1000full - 10000full - 1g/full - 2.5g/full - 5g/full - 10g/full - 14g/full - 20g/full - 25g/full - 40g/full - 50g/full - 56g/full - 100g/full - 1g/half description: - 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. type: str status: choices: - down - up - disable - enable description: - Interface status. - down - Interface down. - up - Interface up. type: str type: choices: - vlan - physical - aggregate description: - Interface type. - vlan - VLAN interface. - physical - Physical interface. - aggregate - Aggregate interface. type: str update-service-ip: description: IP address for fgt/fct update service, must be same subnet with interface ip. type: str vlan-protocol: choices: - 8021q - 8021ad description: - Ethernet protocol of VLAN. - 8021q - IEEE 802. - 8021ad - IEEE 802. type: str vlanid: description: VLAN ID type: int 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. required: false 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. required: false type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. required: false 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