fortios_extender_controller_extender – Extender controller configuration in Fortinet’s FortiOS and FortiGate

From Get docs
Ansible/docs/2.8/modules/fortios extender controller extender module


fortios_extender_controller_extender – Extender controller configuration in Fortinet’s FortiOS and FortiGate

New in version 2.8.


Synopsis

  • This module is able to configure a FortiGate or FortiOS by allowing the user to configure extender_controller feature and extender category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2

Requirements

The below requirements are needed on the host that executes this module.

  • fortiosapi>=0.9.8

Parameters

Parameter Choices/Defaults Comments

extender_controller_extender

-

Default:

null

Extender controller configuration.

aaa-shared-secret

-

AAA shared secret.

access-point-name

-

Access point name(APN).

admin

-

  • disable
  • discovered
  • enable

FortiExtender Administration (enable or disable).

at-dial-script

-

Initialization AT commands specific to the MODEM.

billing-start-day

-

Billing start day.

cdma-aaa-spi

-

CDMA AAA SPI.

cdma-ha-spi

-

CDMA HA SPI.

cdma-nai

-

NAI for CDMA MODEMS.

conn-status

-

Connection status.

description

-

Description.

dial-mode

-

  • dial-on-demand
  • always-connect

Dial mode (dial-on-demand or always-connect).

dial-status

-

Dial status.

ext-name

-

FortiExtender name.

ha-shared-secret

-

HA shared secret.

id

- / required

FortiExtender serial number.

ifname

-

FortiExtender interface name.

initiated-update

-

  • enable
  • disable

Allow/disallow network initiated updates to the MODEM.

mode

-

  • standalone
  • redundant

FortiExtender mode.

modem-passwd

-

MODEM password.

modem-type

-

  • cdma
  • gsm/lte
  • wimax

MODEM type (CDMA, GSM/LTE or WIMAX).

multi-mode

-

  • auto
  • auto-3g
  • force-lte
  • force-3g
  • force-2g

MODEM mode of operation(3G,LTE,etc).

ppp-auth-protocol

-

  • auto
  • pap
  • chap

PPP authentication protocol (PAP,CHAP or auto).

ppp-echo-request

-

  • enable
  • disable

Enable/disable PPP echo request.

ppp-password

-

PPP password.

ppp-username

-

PPP username.

primary-ha

-

Primary HA.

quota-limit-mb

-

Monthly quota limit (MB).

redial

-

  • none
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10

Number of redials allowed based on failed attempts.

redundant-intf

-

Redundant interface.

roaming

-

  • enable
  • disable

Enable/disable MODEM roaming.

role

-

  • none
  • primary
  • secondary

FortiExtender work role(Primary, Secondary, None).

secondary-ha

-

Secondary HA.

sim-pin

-

SIM PIN.

state

-

  • present
  • absent

Indicates whether to create or remove the object

vdom

-

VDOM

wimax-auth-protocol

-

  • tls
  • ttls

WiMax authentication protocol(TLS or TTLS).

wimax-carrier

-

WiMax carrier.

wimax-realm

-

WiMax realm.

host

- / required

FortiOS or FortiGate ip address.

https

boolean

  • no

  • yes

Indicates if the requests towards FortiGate must use HTTPS protocol

password

-

Default:

""

FortiOS or FortiGate password.

username

- / required

FortiOS or FortiGate username.

vdom

-

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"
  tasks:
  - name: Extender controller configuration.
    fortios_extender_controller_extender:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      extender_controller_extender:
        state: "present"
        aaa-shared-secret: "<your_own_value>"
        access-point-name: "<your_own_value>"
        admin: "disable"
        at-dial-script: "<your_own_value>"
        billing-start-day: "7"
        cdma-aaa-spi: "<your_own_value>"
        cdma-ha-spi: "<your_own_value>"
        cdma-nai: "<your_own_value>"
        conn-status: "11"
        description: "<your_own_value>"
        dial-mode: "dial-on-demand"
        dial-status: "14"
        ext-name: "<your_own_value>"
        ha-shared-secret: "<your_own_value>"
        id:  "17"
        ifname: "<your_own_value>"
        initiated-update: "enable"
        mode: "standalone"
        modem-passwd: "<your_own_value>"
        modem-type: "cdma"
        multi-mode: "auto"
        ppp-auth-protocol: "auto"
        ppp-echo-request: "enable"
        ppp-password: "<your_own_value>"
        ppp-username: "<your_own_value>"
        primary-ha: "<your_own_value>"
        quota-limit-mb: "29"
        redial: "none"
        redundant-intf: "<your_own_value>"
        roaming: "enable"
        role: "none"
        secondary-ha: "<your_own_value>"
        sim-pin: "<your_own_value>"
        vdom: "36"
        wimax-auth-protocol: "tls"
        wimax-carrier: "<your_own_value>"
        wimax-realm: "<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

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.8/modules/fortios_extender_controller_extender_module.html