You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

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

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	Comments
access_token string	Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean	Enable/Disable logging for task. Choices: no ← (default) yes
extender_controller_dataplan dictionary	FortiExtender dataplan configuration.
APN string	APN configuration.
apn string	APN configuration.
auth_type string	Authentication type. Choices: none pap chap
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	Dataplan”s modem specifics, if any. Choices: modem1 modem2 all
monthly_fee integer	Monthly fee of dataplan (0 - 100000, in local currency).
name string / required	FortiExtender dataplan name
overage string	Enable/disable dataplan overage detection. Choices: disable enable
password string	Password.
PDN string	PDN type. Choices: ipv4-only ipv6-only ipv4-ipv6
pdn string	PDN type. Choices: ipv4-only ipv6-only ipv4-ipv6
preferred_subnet integer	Preferred subnet mask (8 - 32).
private_network string	Enable/disable dataplan private network support. Choices: disable enable
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	SIM slot configuration. Choices: sim1 sim2
type string	Type preferences configuration. Choices: carrier slot iccid generic
username string	Username.
member_path string	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.
member_state string	Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices: present absent
state string / required	Indicates whether to create or remove the object. Choices: present absent
vdom string	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. Default: “root”

Notes

Note

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

Examples

- collections:
  - fortinet.fortios
  connection: httpapi
  hosts: fortigate01
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    vdom: root
  tasks:
  - name: fortios_extender_controller_dataplan
    fortios_extender_controller_dataplan:
      vdom: root
      state: present
      extender_controller_dataplan:
        auth_type: none
        billing_date: 1
        capacity: 0
        modem_id: all
        monthly_fee: 0
        name: terr-test-rdmstr
        overage: disable
        pdn: ipv4-only
        preferred_subnet: 32
        private_network: disable
        signal_period: 3600
        signal_threshold: 100
        type: generic

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
build string	Build number of the fortigate image Returned: always Sample: “1547”
http_method string	Last method used to provision the content into FortiGate Returned: always Sample: “PUT”
http_status string	Last result given by FortiGate on last operation applied Returned: always Sample: “200”
mkey string	Master key (id) used in the last call to FortiGate Returned: success Sample: “id”
name string	Name of the table used to fulfill the request Returned: always Sample: “urlfilter”
path string	Path of the table used to fulfill the request Returned: always Sample: “webfilter”
revision string	Internal revision number Returned: always Sample: “17.0.2.10658”
serial string	Serial number of the unit Returned: always Sample: “FGVMEVYYQT3AB5352”
status string	Indication of the operation’s result Returned: always Sample: “success”
vdom string	Virtual domain used Returned: always Sample: “root”
version string	Version of the FortiGate Returned: always 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)