fortios_system_pppoe_interface – Configure the PPPoE interfaces in Fortinet’s FortiOS and FortiGate
New in version 2.9.
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.5
Requirements
The below requirements are needed on the host that executes this module.
- fortiosapi>=0.9.8
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
host string | FortiOS or FortiGate IP address. | ||
https boolean |
| Indicates if the requests towards FortiGate must use HTTPS protocol. | |
password string | Default: "" | FortiOS or FortiGate password. | |
ssl_verify boolean |
| Ensures FortiGate certificate must be verified by a proper CA. | |
state string / required |
| Indicates whether to create or remove the object. | |
system_pppoe_interface dictionary | Default: null | Configure the PPPoE interfaces. | |
ac_name string | PPPoE AC name. | ||
auth_type string |
| PPP authentication type to use. | |
device string | Name for the physical interface. Source system.interface.name. | ||
dial_on_demand string |
| Enable/disable dial on demand to dial the PPPoE interface when packets are routed to the PPPoE interface. | |
disc_retry_timeout integer | PPPoE discovery init timeout value in (0-4294967295 sec). | ||
idle_timeout integer | PPPoE auto disconnect after idle timeout (0-4294967295 sec). | ||
ipunnumbered string | PPPoE unnumbered IP. | ||
ipv6 string |
| Enable/disable IPv6 Control Protocol (IPv6CP). | |
lcp_echo_interval integer | PPPoE LCP echo interval in (0-4294967295 sec). | ||
lcp_max_echo_fails integer | Maximum missed LCP echo messages before disconnect (0-4294967295). | ||
name string / required | Name of the PPPoE interface. | ||
padt_retry_timeout integer | PPPoE terminate timeout value in (0-4294967295 sec). | ||
password string | Enter the password. | ||
pppoe_unnumbered_negotiate string |
| Enable/disable PPPoE unnumbered negotiation. | |
service_name string | PPPoE service name. | ||
username string | User name. | ||
username string | FortiOS or FortiGate username. | ||
vdom string | Default: "root" | 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. |
Notes
Note
- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook
Examples
- hosts: localhost vars: host: "192.168.122.40" username: "admin" password: "" vdom: "root" ssl_verify: "False" tasks: - name: Configure the PPPoE interfaces. fortios_system_pppoe_interface: host: "{{ host }}" username: "{{ username }}" password: "{{ password }}" vdom: "{{ vdom }}" https: "False" state: "present" 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: "7" idle_timeout: "8" ipunnumbered: "<your_own_value>" ipv6: "enable" lcp_echo_interval: "11" lcp_max_echo_fails: "12" name: "default_name_13" padt_retry_timeout: "14" password: "<your_own_value>" 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 | Returned | Description |
---|---|---|
build string | always | Build number of the fortigate image Sample: 1547 |
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT |
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200 |
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id |
name string | always | Name of the table used to fulfill the request Sample: urlfilter |
path string | always | Path of the table used to fulfill the request Sample: webfilter |
revision string | always | Internal revision number Sample: 17.0.2.10658 |
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 |
status string | always | Indication of the operation's result Sample: success |
vdom string | always | Virtual domain used Sample: root |
version string | always | Version of the FortiGate Sample: v5.6.3 |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_system_pppoe_interface_module.html