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

New in version 2.8.

- Synopsis

- Requirements

- Parameters

- Notes

- Examples

- Return Values

- Status

## Synopsis

- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify extender_controller feature and extender 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
--- | --- | ---
extender_controller_extender dictionary | Default: null | Extender controller configuration.
| aaa_shared_secret string |  | AAA shared secret.
| access_point_name string |  | Access point name(APN).

admin
string

Choices:
- disable
- discovered
- enable

FortiExtender Administration (enable or disable).

| at_dial_script string |  | Initialization AT commands specific to the MODEM.
| billing_start_day integer |  | Billing start day.
| cdma_aaa_spi string |  | CDMA AAA SPI.
| cdma_ha_spi string |  | CDMA HA SPI.
| cdma_nai string |  | NAI for CDMA MODEMS.
| conn_status integer |  | Connection status.
| description string |  | Description.

dial_mode
string

Choices:
- dial-on-demand
- always-connect

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

| dial_status integer |  | Dial status.
| ext_name string |  | FortiExtender name.
| ha_shared_secret string |  | HA shared secret.
| id string / required |  | FortiExtender serial number.
| ifname string |  | FortiExtender interface name.

initiated_update
string

Choices:
- enable
- disable

Allow/disallow network initiated updates to the MODEM.

mode
string

Choices:
- standalone
- redundant

FortiExtender mode.

| modem_passwd string |  | MODEM password.

modem_type
string

Choices:
- cdma
- gsm/lte
- wimax

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

multi_mode
string

Choices:
- auto
- auto-3g
- force-lte
- force-3g
- force-2g

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

ppp_auth_protocol
string

Choices:
- auto
- pap
- chap

PPP authentication protocol (PAP,CHAP or auto).

ppp_echo_request
string

Choices:
- enable
- disable

Enable/disable PPP echo request.

| ppp_password string |  | PPP password.
| ppp_username string |  | PPP username.
| primary_ha string |  | Primary HA.
| quota_limit_mb integer |  | Monthly quota limit (MB).

redial
string

Choices:
- none
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10

Number of redials allowed based on failed attempts.

| redundant_intf string |  | Redundant interface.

roaming
string

Choices:
- enable
- disable

Enable/disable MODEM roaming.

role
string

Choices:
- none
- primary
- secondary

FortiExtender work role(Primary, Secondary, None).

| secondary_ha string |  | Secondary HA.
| sim_pin string |  | SIM PIN.

state
string

Choices:
- present
- absent

Deprecated
Starting with Ansible 2.9 we recommend using the top-level 'state' parameter.

Indicates whether to create or remove the object.

| vdom integer |  | VDOM

wimax_auth_protocol
string

Choices:
- tls
- ttls

WiMax authentication protocol(TLS or TTLS).

| wimax_carrier string |  | WiMax carrier.
| wimax_realm string |  | WiMax realm.
host string |  | FortiOS or FortiGate IP address.

https
boolean

Choices:
- no
- yes ←

Indicates if the requests towards FortiGate must use HTTPS protocol.

password string | Default: "" | FortiOS or FortiGate password.

ssl_verify
boolean
added in 2.9

Choices:
- no
- yes ←

Ensures FortiGate certificate must be verified by a proper CA.

state
string
added in 2.9

Choices:
- present
- absent

Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level.

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: Extender controller configuration.
        fortios_extender_controller_extender:
          host:  "{{ host }}"
          username: "{{ username }}"
          password: "{{ password }}"
          vdom:  "{{ vdom }}"
          https: "False"
          state: "present"
          extender_controller_extender:
            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

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