W3cubDocs

/Ansible

fortinet.fortios.fortios_extender_controller_dataplan – FortiExtender dataplan configuration in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_extender_controller_dataplan.

New in version 2.10: of fortinet.fortios

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

Parameter Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
extender_controller_dataplan
dictionary
FortiExtender dataplan configuration.
APN
string
APN configuration.
apn
string
APN configuration.
auth_type
string
    Choices:
  • none
  • pap
  • chap
Authentication type.
billing_date
integer
Billing day of the month (1 - 31).
capacity
integer
Capacity in MB (0 - 102400000).
carrier
string
Carrier configuration.
iccid
string
ICCID configuration.
modem_id
string
    Choices:
  • modem1
  • modem2
  • all
Dataplan"s modem specifics, if any.
monthly_fee
integer
Monthly fee of dataplan (0 - 100000, in local currency).
name
string / required
FortiExtender dataplan name
overage
string
    Choices:
  • disable
  • enable
Enable/disable dataplan overage detection.
password
string
Password.
PDN
string
    Choices:
  • ipv4-only
  • ipv6-only
  • ipv4-ipv6
PDN type.
pdn
string
    Choices:
  • ipv4-only
  • ipv6-only
  • ipv4-ipv6
PDN type.
preferred_subnet
integer
Preferred subnet mask (8 - 32).
private_network
string
    Choices:
  • disable
  • enable
Enable/disable dataplan private network support.
signal_period
integer
Signal period (600 to 18000 seconds).
signal_threshold
integer
Signal threshold. Specify the range between 50 - 100, where 50/100 means -50/-100 dBm.
slot
string
    Choices:
  • sim1
  • sim2
SIM slot configuration.
type
string
    Choices:
  • carrier
  • slot
  • iccid
  • generic
Type preferences configuration.
username
string
Username.
state
string / required
    Choices:
  • present
  • absent
Indicates whether to create or remove the object.
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

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

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: FortiExtender dataplan configuration.
    fortios_extender_controller_dataplan:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      extender_controller_dataplan:
        apn: "<your_own_value>"
        APN: "<your_own_value>"
        auth_type: "none"
        billing_date: "6"
        capacity: "7"
        carrier: "<your_own_value>"
        iccid: "<your_own_value>"
        modem_id: "modem1"
        monthly_fee: "11"
        name: "default_name_12"
        overage: "disable"
        password: "<your_own_value>"
        pdn: "ipv4-only"
        PDN: "ipv4-only"
        preferred_subnet: "17"
        private_network: "disable"
        signal_period: "19"
        signal_threshold: "20"
        slot: "sim1"
        type: "carrier"
        username: "<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


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_extender_controller_dataplan_module.html