W3cubDocs

/Ansible 2.11

fortinet.fortimanager.fmgr_system_interface – Interface configuration.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_interface.

New in version 2.10: of fortinet.fortimanager

Synopsis
Parameters
Notes
Examples
Return Values

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			Choices/Defaults	Comments
bypass_validation boolean			Choices: no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
rc_failed list / elements=string				the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string				the rc codes list with which the conditions to succeed will be overriden
state string / required			Choices: present absent	the directive to create, update or delete an object
system_interface dictionary				the top level parameters set
	alias string			Alias.
	allowaccess list / elements=string		Choices: ping https ssh snmp http webservice https-logging	no description
	description string			Description.
	ip string		Default: "0.0.0.0 0.0.0.0"	IP address of interface.
	ipv6 dictionary			no description
		ip6-address string	Default: "::/0"	IPv6 address/prefix of interface.
		ip6-allowaccess list / elements=string	Choices: ping https ssh snmp http webservice https-logging	no description
		ip6-autoconf string	Choices: disable enable ←	Enable/disable address auto config (SLAAC). disable - Disable setting. enable - Enable setting.
	mtu integer		Default: 1500	Maximum transportation unit(68 - 9000).
	name string			Interface name.
	serviceaccess list / elements=string		Choices: fgtupdates fclupdates webfilter-antispam	no description
	speed string		Choices: auto ← 10full 10half 100full 100half 1000full 10000full	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.
	status string		Choices: down up ←	Interface status. down - Interface down. up - Interface up.
workspace_locking_adom string				the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout integer			Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

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

- hosts: fortimanager-inventory
  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
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        state: <value in [present, absent]>
        system_interface:
           alias: <value of string>
           allowaccess:
             - ping
             - https
             - ssh
             - snmp
             - http
             - webservice
             - https-logging
           description: <value of string>
           ip: <value of string>
           ipv6:
              ip6-address: <value of string>
              ip6-allowaccess:
                - ping
                - https
                - ssh
                - snmp
                - http
                - webservice
                - https-logging
              ip6-autoconf: <value in [disable, enable]>
           mtu: <value of integer>
           name: <value of string>
           serviceaccess:
             - fgtupdates
             - fclupdates
             - webfilter-antispam
           speed: <value in [auto, 10full, 10half, ...]>
           status: <value in [down, up]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_interface_module.html