faz_cli_system_interface – Interface configuration.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiAnalyzer device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements

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

  • ansible>=2.9.0

FortiAnalyzer Version Compatibility


6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
cli_system_interface yes yes yes yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool required: false default: False
  • 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
  • cli_system_interface - Interface configuration. type: dict
    • alias - Alias. type: str more...
    • allowaccess - No description for the parameter type: array choices: [ping, https, ssh, snmp, http, webservice, fgfm, https-logging, soc-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 - IPv6 address/prefix of interface. type: str default: ::/0 more...
      • ip6-allowaccess - No description for the parameter type: array choices: [ping, https, ssh, snmp, http, webservice, fgfm, https-logging] more...
      • 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...
    • speed - Speed. type: str choices: [auto, 10full, 10half, 100full, 100half, 1000full, 10000full] default: auto more...
    • status - Interface status. type: str choices: [down, up, disable, enable] default: up more...
    • aggregate - Aggregate interface. type: str more...
    • lacp-mode - LACP mode. type: str choices: [active] default: active more...
    • lacp-speed - How often the interface sends LACP messages. type: str choices: [slow, fast] default: slow more...
    • link-up-delay - Number of milliseconds to wait before considering a link is up. type: int default: 50 more...
    • member - No description for the parameter type: array more...
      • interface-name - Physical interface name. type: str more...
    • min-links - Minimum number of aggregated ports that must be up. type: int default: 1 more...
    • 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 - Set type of interface (physical/aggregate). type: str choices: [physical, aggregate, vlan] default: physical more...
    • interface - Underlying interface name. type: str more...
    • vlan-protocol - Ethernet protocol of VLAN. type: str choices: [8021q, 8021ad] default: 8021q more...
    • vlanid - VLAN ID (1 - 4094). type: int default: 0 more...

Notes

Note

  • 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

- collections:
  - fortinet.fortianalyzer
  connection: httpapi
  hosts: fortianalyzer-inventory
  tasks:
  - faz_cli_system_interface:
        state: present
        cli_system_interface:
         name: fooaggregate
         status: up
         type: aggregate
  - faz_cli_system_interface_member:
      cli_system_interface_member:
        interface-name: port4
      interface: fooaggregate
      state: present
    name: Physical interfaces that belong to the aggregate or redundant interface.
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false

- collections:
  - fortinet.fortianalyzer
  connection: httpapi
  hosts: fortianalyzer-inventory
  tasks:
  - faz_cli_system_interface:
      cli_system_interface:
        allowaccess:
        - ping
        - https
        - ssh
        - snmp
        - http
        - webservice
        - fgfm
        - https-logging
        - soc-fabric
        description: second port
        ip: 22.22.22.222 255.255.255.0
        name: port2
        status: down
        #type: physical
      state: present
    name: Interface configuration.
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false

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:

  • 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_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

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

Authors

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

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.