ansible.builtin.fortios_system_pppoe_interface (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
host:
    description:
    - FortiOS or FortiGate IP address.
    required: false
    type: str

vdom:
    default: root
    description:
    - 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

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol.
    type: bool

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

password:
    default: ''
    description:
    - FortiOS or FortiGate password.
    type: str

username:
    description:
    - FortiOS or FortiGate username.
    required: false
    type: str

ssl_verify:
    default: true
    description:
    - Ensures FortiGate certificate must be verified by a proper CA.
    type: bool

system_pppoe_interface:
    default: null
    description:
    - Configure the PPPoE interfaces.
    suboptions:
      ac_name:
        description:
        - PPPoE AC name.
        type: str
      auth_type:
        choices:
        - auto
        - pap
        - chap
        - mschapv1
        - mschapv2
        description:
        - PPP authentication type to use.
        type: str
      device:
        description:
        - Name for the physical interface. Source system.interface.name.
        type: str
      dial_on_demand:
        choices:
        - enable
        - disable
        description:
        - Enable/disable dial on demand to dial the PPPoE interface when packets are routed
          to the PPPoE interface.
        type: str
      disc_retry_timeout:
        description:
        - PPPoE discovery init timeout value in (0-4294967295 sec).
        type: int
      idle_timeout:
        description:
        - PPPoE auto disconnect after idle timeout (0-4294967295 sec).
        type: int
      ipunnumbered:
        description:
        - PPPoE unnumbered IP.
        type: str
      ipv6:
        choices:
        - enable
        - disable
        description:
        - Enable/disable IPv6 Control Protocol (IPv6CP).
        type: str
      lcp_echo_interval:
        description:
        - PPPoE LCP echo interval in (0-4294967295 sec).
        type: int
      lcp_max_echo_fails:
        description:
        - Maximum missed LCP echo messages before disconnect (0-4294967295).
        type: int
      name:
        description:
        - Name of the PPPoE interface.
        required: true
        type: str
      padt_retry_timeout:
        description:
        - PPPoE terminate timeout value in (0-4294967295 sec).
        type: int
      password:
        description:
        - Enter the password.
        type: str
      pppoe_unnumbered_negotiate:
        choices:
        - enable
        - disable
        description:
        - Enable/disable PPPoE unnumbered negotiation.
        type: str
      service_name:
        description:
        - PPPoE service name.
        type: str
      username:
        description:
        - User name.
        type: str
    type: dict

Outputs

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