fortios_system_pppoe_interface.rst

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
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

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.9

Tips

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

FortiOS Version Compatibility

v6.0.0

v6.0.5

v6.0.11

v6.2.0

v6.2.3

v6.2.5

v6.2.7

v6.4.0

v6.4.1

v6.4.4

v7.0.0

v7.0.1

v7.0.2

v7.0.3

v7.0.4

v7.0.5

v7.0.6

v7.0.7

v7.0.8

v7.0.12

v7.2.0

v7.2.1

v7.2.2

v7.2.4

v7.4.0

fortios_system_pppoe_interface

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

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...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  system_pppoe_interface

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• ac_name - PPPoE AC name. type: str more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  ac_name

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• auth_type - PPP authentication type to use. type: str choices: auto, pap, chap, mschapv1, mschapv2 more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  auth_type

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [auto]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [pap]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [chap]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [mschapv1]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [mschapv2]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• device - Name for the physical interface. Source system.interface.name. type: str more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  device

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• 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...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  dial_on_demand

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [enable]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [disable]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• disc_retry_timeout - PPPoE discovery init timeout value in (0-4294967295 sec). type: int more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  disc_retry_timeout

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• idle_timeout - PPPoE auto disconnect after idle timeout (0-4294967295 sec). type: int more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  idle_timeout

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• ipunnumbered - PPPoE unnumbered IP. type: str more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  ipunnumbered

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• ipv6 - Enable/disable IPv6 Control Protocol (IPv6CP). type: str choices: enable, disable more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  ipv6

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [enable]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [disable]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• lcp_echo_interval - Time in seconds between PPPoE Link Control Protocol (LCP) echo requests. type: int more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  lcp_echo_interval

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• lcp_max_echo_fails - Maximum missed LCP echo messages before disconnect. type: int more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  lcp_max_echo_fails

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• name - Name of the PPPoE interface. type: str required: true more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  name

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• padt_retry_timeout - PPPoE terminate timeout value in (0-4294967295 sec). type: int more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  padt_retry_timeout

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• password - Enter the password. type: str more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  password

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• pppoe_unnumbered_negotiate - Enable/disable PPPoE unnumbered negotiation. type: str choices: enable, disable more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  pppoe_unnumbered_negotiate

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [enable]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [disable]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• service_name - PPPoE service name. type: str more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  service_name

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• username - User name. type: str more...

  v6.0.0

  v6.0.5

  v6.0.11

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  username

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

Notes

Note

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

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure the PPPoE interfaces.
    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.