lix_fortinet.fortios.fortios_extender_controller_extender (102.2.120) — module

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120

Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

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

Requirements

• ansible>=2.9

Usage examples

Scanned by Steampunk Spotter

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

- 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: Extender controller configuration.
    fortios_extender_controller_extender:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      extender_controller_extender:
        aaa_shared_secret: "<your_own_value>"
        access_point_name: "<your_own_value>"
        admin: "disable"
        allowaccess: "ping"
        at_dial_script: "<your_own_value>"
        authorized: "disable"
        bandwidth_limit: "1024"
        billing_start_day: "14"
        cdma_aaa_spi: "<your_own_value>"
        cdma_ha_spi: "<your_own_value>"
        cdma_nai: "<your_own_value>"
        conn_status: "2147483647"
        controller_report:
            interval: "300"
            signal_threshold: "10"
            status: "disable"
        description: "<your_own_value>"
        device_id: "1024"
        dial_mode: "dial-on-demand"
        dial_status: "2147483647"
        enforce_bandwidth: "enable"
        ext_name: "<your_own_value>"
        extension_type: "wan-extension"
        ha_shared_secret: "<your_own_value>"
        id:  "27"
        ifname: "<your_own_value> (source system.interface.name)"
        initiated_update: "enable"
        login_password: "<your_own_value>"
        login_password_change: "yes"
        mode: "standalone"
        modem_passwd: "<your_own_value>"
        modem_type: "cdma"
        modem1:
            auto_switch:
                dataplan: "disable"
                disconnect: "disable"
                disconnect_period: "600"
                disconnect_threshold: "3"
                signal: "disable"
                switch_back: "time"
                switch_back_time: "<your_own_value>"
                switch_back_timer: "86400"
            conn_status: "0"
            default_sim: "sim1"
            gps: "disable"
            ifname: "<your_own_value> (source system.interface.name)"
            preferred_carrier: "<your_own_value>"
            redundant_intf: "<your_own_value>"
            redundant_mode: "disable"
            sim1_pin: "disable"
            sim1_pin_code: "<your_own_value>"
            sim2_pin: "disable"
            sim2_pin_code: "<your_own_value>"
        modem2:
            auto_switch:
                dataplan: "disable"
                disconnect: "disable"
                disconnect_period: "600"
                disconnect_threshold: "3"
                signal: "disable"
                switch_back: "time"
                switch_back_time: "<your_own_value>"
                switch_back_timer: "86400"
            conn_status: "0"
            default_sim: "sim1"
            gps: "disable"
            ifname: "<your_own_value> (source system.interface.name)"
            preferred_carrier: "<your_own_value>"
            redundant_intf: "<your_own_value>"
            redundant_mode: "disable"
            sim1_pin: "disable"
            sim1_pin_code: "<your_own_value>"
            sim2_pin: "disable"
            sim2_pin_code: "<your_own_value>"
        multi_mode: "auto"
        name: "default_name_78"
        override_allowaccess: "enable"
        override_enforce_bandwidth: "enable"
        override_login_password_change: "enable"
        ppp_auth_protocol: "auto"
        ppp_echo_request: "enable"
        ppp_password: "<your_own_value>"
        ppp_username: "<your_own_value>"
        primary_ha: "<your_own_value>"
        profile: "<your_own_value> (source extender-controller.extender-profile.name)"
        quota_limit_mb: "5242880"
        redial: "none"
        redundant_intf: "<your_own_value>"
        roaming: "enable"
        role: "none"
        secondary_ha: "<your_own_value>"
        sim_pin: "<your_own_value>"
        vdom: "0"
        wan_extension:
            modem1_extension: "<your_own_value> (source system.interface.name)"
            modem2_extension: "<your_own_value> (source system.interface.name)"
        wimax_auth_protocol: "tls"
        wimax_carrier: "<your_own_value>"
        wimax_realm: "<your_own_value>"

Inputs

    
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

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

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

extender_controller_extender:
    default: null
    description:
    - Extender controller configuration.
    suboptions:
      aaa_shared_secret:
        description:
        - AAA shared secret.
        type: str
      access_point_name:
        description:
        - Access point name(APN).
        type: str
      admin:
        choices:
        - disable
        - discovered
        - enable
        description:
        - FortiExtender Administration (enable or disable).
        type: str
      allowaccess:
        choices:
        - ping
        - telnet
        - http
        - https
        - ssh
        - snmp
        description:
        - Control management access to the managed extender. Separate entries with a space.
        elements: str
        type: list
      at_dial_script:
        description:
        - Initialization AT commands specific to the MODEM.
        type: str
      authorized:
        choices:
        - disable
        - enable
        description:
        - FortiExtender Administration (enable or disable).
        type: str
      bandwidth_limit:
        description:
        - FortiExtender LAN extension bandwidth limit (Mbps).
        type: int
      billing_start_day:
        description:
        - Billing start day.
        type: int
      cdma_aaa_spi:
        description:
        - CDMA AAA SPI.
        type: str
      cdma_ha_spi:
        description:
        - CDMA HA SPI.
        type: str
      cdma_nai:
        description:
        - NAI for CDMA MODEMS.
        type: str
      conn_status:
        description:
        - Connection status.
        type: int
      controller_report:
        description:
        - FortiExtender controller report configuration.
        suboptions:
          interval:
            description:
            - Controller report interval.
            type: int
          signal_threshold:
            description:
            - Controller report signal threshold.
            type: int
          status:
            choices:
            - disable
            - enable
            description:
            - FortiExtender controller report status.
            type: str
        type: dict
      description:
        description:
        - Description.
        type: str
      device_id:
        description:
        - Device ID.
        type: int
      dial_mode:
        choices:
        - dial-on-demand
        - always-connect
        description:
        - Dial mode (dial-on-demand or always-connect).
        type: str
      dial_status:
        description:
        - Dial status.
        type: int
      enforce_bandwidth:
        choices:
        - enable
        - disable
        description:
        - Enable/disable enforcement of bandwidth on LAN extension interface.
        type: str
      ext_name:
        description:
        - FortiExtender name.
        type: str
      extension_type:
        choices:
        - wan-extension
        - lan-extension
        description:
        - Extension type for this FortiExtender.
        type: str
      ha_shared_secret:
        description:
        - HA shared secret.
        type: str
      id:
        description:
        - FortiExtender serial number.
        type: str
      ifname:
        description:
        - FortiExtender interface name. Source system.interface.name.
        type: str
      initiated_update:
        choices:
        - enable
        - disable
        description:
        - Allow/disallow network initiated updates to the MODEM.
        type: str
      login_password:
        description:
        - Set the managed extender"s administrator password.
        type: str
      login_password_change:
        choices:
        - 'yes'
        - default
        - 'no'
        description:
        - Change or reset the administrator password of a managed extender (yes, default,
          or no).
        type: str
      mode:
        choices:
        - standalone
        - redundant
        description:
        - FortiExtender mode.
        type: str
      modem1:
        description:
        - Configuration options for modem 1.
        suboptions:
          auto_switch:
            description:
            - FortiExtender auto switch configuration.
            suboptions:
              dataplan:
                choices:
                - disable
                - enable
                description:
                - Automatically switch based on data usage.
                type: str
              disconnect:
                choices:
                - disable
                - enable
                description:
                - Auto switch by disconnect.
                type: str
              disconnect_period:
                description:
                - Automatically switch based on disconnect period.
                type: int
              disconnect_threshold:
                description:
                - Automatically switch based on disconnect threshold.
                type: int
              signal:
                choices:
                - disable
                - enable
                description:
                - Automatically switch based on signal strength.
                type: str
              switch_back:
                choices:
                - time
                - timer
                description:
                - Auto switch with switch back multi-options.
                elements: str
                type: list
              switch_back_time:
                description:
                - Automatically switch over to preferred SIM/carrier at a specified time
                  in UTC (HH:MM).
                type: str
              switch_back_timer:
                description:
                - Automatically switch over to preferred SIM/carrier after the given time
                  (3600 - 2147483647 sec).
                type: int
            type: dict
          conn_status:
            description:
            - Connection status.
            type: int
          default_sim:
            choices:
            - sim1
            - sim2
            - carrier
            - cost
            description:
            - Default SIM selection.
            type: str
          gps:
            choices:
            - disable
            - enable
            description:
            - FortiExtender GPS enable/disable.
            type: str
          ifname:
            description:
            - FortiExtender interface name. Source system.interface.name.
            type: str
          preferred_carrier:
            description:
            - Preferred carrier.
            type: str
          redundant_intf:
            description:
            - Redundant interface.
            type: str
          redundant_mode:
            choices:
            - disable
            - enable
            description:
            - FortiExtender mode.
            type: str
          sim1_pin:
            choices:
            - disable
            - enable
            description:
            - SIM
            type: str
          sim1_pin_code:
            description:
            - SIM
            type: str
          sim2_pin:
            choices:
            - disable
            - enable
            description:
            - SIM
            type: str
          sim2_pin_code:
            description:
            - SIM
            type: str
        type: dict
      modem2:
        description:
        - Configuration options for modem 2.
        suboptions:
          auto_switch:
            description:
            - FortiExtender auto switch configuration.
            suboptions:
              dataplan:
                choices:
                - disable
                - enable
                description:
                - Automatically switch based on data usage.
                type: str
              disconnect:
                choices:
                - disable
                - enable
                description:
                - Auto switch by disconnect.
                type: str
              disconnect_period:
                description:
                - Automatically switch based on disconnect period.
                type: int
              disconnect_threshold:
                description:
                - Automatically switch based on disconnect threshold.
                type: int
              signal:
                choices:
                - disable
                - enable
                description:
                - Automatically switch based on signal strength.
                type: str
              switch_back:
                choices:
                - time
                - timer
                description:
                - Auto switch with switch back multi-options.
                elements: str
                type: list
              switch_back_time:
                description:
                - Automatically switch over to preferred SIM/carrier at a specified time
                  in UTC (HH:MM).
                type: str
              switch_back_timer:
                description:
                - Automatically switch over to preferred SIM/carrier after the given time
                  (3600 - 2147483647 sec).
                type: int
            type: dict
          conn_status:
            description:
            - Connection status.
            type: int
          default_sim:
            choices:
            - sim1
            - sim2
            - carrier
            - cost
            description:
            - Default SIM selection.
            type: str
          gps:
            choices:
            - disable
            - enable
            description:
            - FortiExtender GPS enable/disable.
            type: str
          ifname:
            description:
            - FortiExtender interface name. Source system.interface.name.
            type: str
          preferred_carrier:
            description:
            - Preferred carrier.
            type: str
          redundant_intf:
            description:
            - Redundant interface.
            type: str
          redundant_mode:
            choices:
            - disable
            - enable
            description:
            - FortiExtender mode.
            type: str
          sim1_pin:
            choices:
            - disable
            - enable
            description:
            - SIM
            type: str
          sim1_pin_code:
            description:
            - SIM
            type: str
          sim2_pin:
            choices:
            - disable
            - enable
            description:
            - SIM
            type: str
          sim2_pin_code:
            description:
            - SIM
            type: str
        type: dict
      modem_passwd:
        description:
        - MODEM password.
        type: str
      modem_type:
        choices:
        - cdma
        - gsm/lte
        - wimax
        description:
        - MODEM type (CDMA, GSM/LTE or WIMAX).
        type: str
      multi_mode:
        choices:
        - auto
        - auto-3g
        - force-lte
        - force-3g
        - force-2g
        description:
        - MODEM mode of operation(3G,LTE,etc).
        type: str
      name:
        description:
        - FortiExtender entry name.
        required: true
        type: str
      override_allowaccess:
        choices:
        - enable
        - disable
        description:
        - Enable to override the extender profile management access configuration.
        type: str
      override_enforce_bandwidth:
        choices:
        - enable
        - disable
        description:
        - Enable to override the extender profile enforce-bandwidth setting.
        type: str
      override_login_password_change:
        choices:
        - enable
        - disable
        description:
        - Enable to override the extender profile login-password (administrator password)
          setting.
        type: str
      ppp_auth_protocol:
        choices:
        - auto
        - pap
        - chap
        description:
        - PPP authentication protocol (PAP,CHAP or auto).
        type: str
      ppp_echo_request:
        choices:
        - enable
        - disable
        description:
        - Enable/disable PPP echo request.
        type: str
      ppp_password:
        description:
        - PPP password.
        type: str
      ppp_username:
        description:
        - PPP username.
        type: str
      primary_ha:
        description:
        - Primary HA.
        type: str
      profile:
        description:
        - FortiExtender profile configuration. Source extender-controller.extender-profile.name.
        type: str
      quota_limit_mb:
        description:
        - Monthly quota limit (MB).
        type: int
      redial:
        choices:
        - none
        - '1'
        - '2'
        - '3'
        - '4'
        - '5'
        - '6'
        - '7'
        - '8'
        - '9'
        - '10'
        description:
        - Number of redials allowed based on failed attempts.
        type: str
      redundant_intf:
        description:
        - Redundant interface.
        type: str
      roaming:
        choices:
        - enable
        - disable
        description:
        - Enable/disable MODEM roaming.
        type: str
      role:
        choices:
        - none
        - primary
        - secondary
        description:
        - FortiExtender work role(Primary, Secondary, None).
        type: str
      secondary_ha:
        description:
        - Secondary HA.
        type: str
      sim_pin:
        description:
        - SIM PIN.
        type: str
      vdom:
        description:
        - VDOM.
        type: int
      wan_extension:
        description:
        - FortiExtender wan extension configuration.
        suboptions:
          modem1_extension:
            description:
            - FortiExtender interface name. Source system.interface.name.
            type: str
          modem2_extension:
            description:
            - FortiExtender interface name. Source system.interface.name.
            type: str
        type: dict
      wimax_auth_protocol:
        choices:
        - tls
        - ttls
        description:
        - WiMax authentication protocol(TLS or TTLS).
        type: str
      wimax_carrier:
        description:
        - WiMax carrier.
        type: str
      wimax_realm:
        description:
        - WiMax realm.
        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