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.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
- 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
- ac_name - PPPoE AC name. type: str
- auth_type - PPP authentication type to use. type: str choices: auto, pap, chap, mschapv1, mschapv2
- device - Name for the physical interface. Source system.interface.name. type: str
- 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
- disc_retry_timeout - PPPoE discovery init timeout value in (0-4294967295 sec). type: int
- idle_timeout - PPPoE auto disconnect after idle timeout (0-4294967295 sec). type: int
- ipunnumbered - PPPoE unnumbered IP. type: str
- ipv6 - Enable/disable IPv6 Control Protocol (IPv6CP). type: str choices: enable, disable
- lcp_echo_interval - PPPoE LCP echo interval in (0-4294967295 sec). type: int
- lcp_max_echo_fails - Maximum missed LCP echo messages before disconnect (0-4294967295). type: int
- name - Name of the PPPoE interface. type: str required: True
- padt_retry_timeout - PPPoE terminate timeout value in (0-4294967295 sec). type: int
- password - Enter the password. type: str
- pppoe_unnumbered_negotiate - Enable/disable PPPoE unnumbered negotiation. type: str choices: enable, disable
- service_name - PPPoE service name. type: str
- username - User name. type: str
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: "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: 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