Skip to content

Latest commit

 

History

History
425 lines (381 loc) · 18.3 KB

fortios_system_pppoe_interface.rst

File metadata and controls

425 lines (381 loc) · 18.3 KB
Raw
source:fortios_system_pppoe_interface.py
orphan:

fortios_system_pppoe_interface -- Configure the PPPoE interfaces in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and pppoe_interface category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

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

  • ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_system_pppoe_interface v6.0.0 -> latest

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • system_pppoe_interface - Configure the PPPoE interfaces. type: dict more...
    Supported Version Ranges
    system_pppoe_interface v6.0.0 -> latest
    • ac_name - PPPoE AC name. type: str more...
      Supported Version Ranges
      ac_name v6.0.0 -> latest
    • auth_type - PPP authentication type to use. type: str choices: auto, pap, chap, mschapv1, mschapv2 more...
      Supported Version Ranges
      auth_type v6.0.0 -> latest
      [auto] v6.0.0 -> latest
      [pap] v6.0.0 -> latest
      [chap] v6.0.0 -> latest
      [mschapv1] v6.0.0 -> latest
      [mschapv2] v6.0.0 -> latest
    • device - Name for the physical interface. Source system.interface.name. type: str more...
      Supported Version Ranges
      device v6.0.0 -> latest
    • dial_on_demand - Enable/disable dial on demand to dial the PPPoE interface when packets are routed to the PPPoE interface. type: str choices: enable, disable more...
      Supported Version Ranges
      dial_on_demand v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • disc_retry_timeout - PPPoE discovery init timeout value in (0-4294967295 sec). type: int more...
      Supported Version Ranges
      disc_retry_timeout v6.0.0 -> latest
    • idle_timeout - PPPoE auto disconnect after idle timeout (0-4294967295 sec). type: int more...
      Supported Version Ranges
      idle_timeout v6.0.0 -> latest
    • ipunnumbered - PPPoE unnumbered IP. type: str more...
      Supported Version Ranges
      ipunnumbered v6.0.0 -> latest
    • ipv6 - Enable/disable IPv6 Control Protocol (IPv6CP). type: str choices: enable, disable more...
      Supported Version Ranges
      ipv6 v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • lcp_echo_interval - Time in seconds between PPPoE Link Control Protocol (LCP) echo requests. type: int more...
      Supported Version Ranges
      lcp_echo_interval v6.0.0 -> latest
    • lcp_max_echo_fails - Maximum missed LCP echo messages before disconnect. type: int more...
      Supported Version Ranges
      lcp_max_echo_fails v6.0.0 -> latest
    • name - Name of the PPPoE interface. type: str required: true more...
      Supported Version Ranges
      name v6.0.0 -> latest
    • padt_retry_timeout - PPPoE terminate timeout value in (0-4294967295 sec). type: int more...
      Supported Version Ranges
      padt_retry_timeout v6.0.0 -> latest
    • password - Enter the password. type: str more...
      Supported Version Ranges
      password v6.0.0 -> latest
    • pppoe_unnumbered_negotiate - Enable/disable PPPoE unnumbered negotiation. type: str choices: enable, disable more...
      Supported Version Ranges
      pppoe_unnumbered_negotiate v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • service_name - PPPoE service name. type: str more...
      Supported Version Ranges
      service_name v6.0.0 -> latest
    • username - User name. type: str more...
      Supported Version Ranges
      username v6.0.0 -> latest

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure the PPPoE interfaces.
  fortinet.fortios.fortios_system_pppoe_interface:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_pppoe_interface:
          ac_name: "<your_own_value>"
          auth_type: "auto"
          device: "<your_own_value> (source system.interface.name)"
          dial_on_demand: "enable"
          disc_retry_timeout: "1"
          idle_timeout: "0"
          ipunnumbered: "<your_own_value>"
          ipv6: "enable"
          lcp_echo_interval: "5"
          lcp_max_echo_fails: "3"
          name: "default_name_13"
          padt_retry_timeout: "1"
          password: "<your_own_value>"
          pppoe_unnumbered_negotiate: "enable"
          service_name: "<your_own_value>"
          username: "<your_own_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:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

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

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

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