fortinet.fortios.fortios_system_pppoe_interface module – Configure the PPPoE interfaces in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortios
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_system_pppoe_interface
.
New in fortinet.fortios 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.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Configure the PPPoE interfaces. |
|
PPPoE AC name. |
|
PPP authentication type to use. Choices:
|
|
Name for the physical interface. Source system.interface.name. |
|
Enable/disable dial on demand to dial the PPPoE interface when packets are routed to the PPPoE interface. Choices:
|
|
PPPoE discovery init timeout value in (0-4294967295 sec). |
|
PPPoE auto disconnect after idle timeout (0-4294967295 sec). |
|
PPPoE unnumbered IP. |
|
Enable/disable IPv6 Control Protocol (IPv6CP). Choices:
|
|
Time in seconds between PPPoE Link Control Protocol (LCP) echo requests. |
|
Maximum missed LCP echo messages before disconnect. |
|
Name of the PPPoE interface. |
|
PPPoE terminate timeout value in (0-4294967295 sec). |
|
Enter the password. |
|
CoS in VLAN tag for outgoing PPPoE/PPP packets. Choices:
|
|
Enable/disable PPPoE unnumbered negotiation. Choices:
|
|
PPPoE service name. |
|
User name. |
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
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_egress_cos: "cos0"
pppoe_unnumbered_negotiate: "enable"
service_name: "<your_own_value>"
username: "<your_own_value>"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |