fmgr_system_interface – Interface configuration.

Added in version 1.0.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values need to be adjusted to data sources before usage.

  • Tested with FortiManager v6.x and v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.0.0 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • system_interface - Interface configuration. type: dict
    • alias Alias. type: str more...
    • allowaccess Allow management access to interface. type: list choices: [ping, https, ssh, snmp, http, webservice, https-logging, soc-fabric, fabric] more...
    • description Description. type: str more...
    • ip Ip address of interface. type: str default: 0.0.0.0 0.0.0.0 more...
    • ipv6 type: dict
      • ip6_address (Alias name: ip6-address) Ipv6 address/prefix of interface. type: str default: ::/0 more...
      • ip6_allowaccess (Alias name: ip6-allowaccess) Allow management access to interface. type: list choices: [ping, https, ssh, snmp, http, webservice, https-logging, fabric] more...
      • ip6_autoconf (Alias name: ip6-autoconf) Enable/disable address auto config (slaac). type: str choices: [disable, enable] default: enable more...
    • mtu Maximum transportation unit(68 - 9000). type: int default: 1500 more...
    • name Interface name. type: str more...
    • serviceaccess Allow service access to interface. type: list choices: [fgtupdates, fclupdates, webfilter-antispam] more...
    • speed Speed. type: str 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] default: auto more...
    • status Interface status. type: str choices: [down, up, disable, enable] default: up more...
    • rating_service_ip (Alias name: rating-service-ip) Ip address for fgt rating service, must be same subnet with interface ip. type: str default: 0.0.0.0 0.0.0.0 more...
    • update_service_ip (Alias name: update-service-ip) Ip address for fgt/fct update service, must be same subnet with interface ip. type: str default: 0.0.0.0 0.0.0.0 more...
    • aggregate Aggregate interface. type: str more...
    • interface Underlying interface name. type: str more...
    • lacp_mode (Alias name: lacp-mode) Lacp mode. type: str choices: [active] default: active more...
    • lacp_speed (Alias name: lacp-speed) How often the interface sends lacp messages. type: str choices: [slow, fast] default: slow more...
    • link_up_delay (Alias name: link-up-delay) Number of milliseconds to wait before considering a link is up. type: int default: 50 more...
    • member type: list more...
      • interface_name (Alias name: interface-name) Physical interface name. type: str more...
    • min_links (Alias name: min-links) Minimum number of aggregated ports that must be up. type: int default: 1 more...
    • min_links_down (Alias name: min-links-down) Action to take when less than the configured minimum number of links are active. type: str choices: [operational, administrative] default: operational more...
    • type Interface type. type: str choices: [vlan, physical, aggregate] default: vlan more...
    • vlan_protocol (Alias name: vlan-protocol) Ethernet protocol of vlan. type: str choices: [8021q, 8021ad] default: 8021q more...
    • vlanid Vlan id (1 - 4094). type: int default: 0 more...
    • lldp Enable/disable lldp (link layer discovery protocol). type: str choices: [disable, enable] default: disable more...
    • defaultgw Enable/disable default gateway. type: str choices: [disable, enable] default: enable more...
    • dhcp_client_identifier (Alias name: dhcp-client-identifier) Dhcp client identifier. type: str more...
    • dns_server_override (Alias name: dns-server-override) Enable/disable use dns acquired by dhcp or pppoe. type: str choices: [disable, enable] default: enable more...
    • mode Addressing mode (static, dhcp). type: str choices: [static, dhcp] default: static more...
    • mtu_override (Alias name: mtu-override) Enable/disable use mtu acquired by dhcp or pppoe. type: str choices: [disable, enable] default: enable more...

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

- 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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)