fortios_extension_controller_dataplan – FortiExtender dataplan configuration in Fortinet’s FortiOS and FortiGate.¶
New in version 2.0.0.
Synopsis¶
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify extension_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
FortiOS Version Compatibility¶
v7.2.1 |
v7.2.2 |
v7.2.4 |
v7.4.0 |
|
fortios_extension_controller_dataplan | yes | yes | yes | yes |
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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 default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- extension_controller_dataplan - FortiExtender dataplan configuration. type: dict more...
- apn - APN configuration. type: str more...
- auth_type - Authentication type. type: str choices: none, pap, chap more...
- billing_date - Billing day of the month (1 - 31). type: int more...
- capacity - Capacity in MB (0 - 102400000). type: int more...
- carrier - Carrier configuration. type: str more...
- iccid - ICCID configuration. type: str more...
- modem_id - Dataplan"s modem specifics, if any. type: str choices: modem1, modem2, all more...
- monthly_fee - Monthly fee of dataplan (0 - 100000, in local currency). type: int more...
- name - FortiExtender data plan name. type: str required: true more...
- overage - Enable/disable dataplan overage detection. type: str choices: disable, enable more...
- password - Password. type: str more...
- pdn - PDN type. type: str choices: ipv4-only, ipv6-only, ipv4-ipv6 more...
- preferred_subnet - Preferred subnet mask (0 - 32). type: int more...
- private_network - Enable/disable dataplan private network support. type: str choices: disable, enable more...
- signal_period - Signal period (600 to 18000 seconds). type: int more...
- signal_threshold - Signal threshold. Specify the range between 50 - 100, where 50/100 means -50/-100 dBm. type: int more...
- slot - SIM slot configuration. type: str choices: sim1, sim2 more...
- type - Type preferences configuration. type: str choices: carrier, slot, iccid, generic more...
- username - Username. type: str more...
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_extension_controller_dataplan:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
extension_controller_dataplan:
apn: "<your_own_value>"
auth_type: "none"
billing_date: "1"
capacity: "0"
carrier: "<your_own_value>"
iccid: "<your_own_value>"
modem_id: "modem1"
monthly_fee: "0"
name: "default_name_11"
overage: "disable"
password: "<your_own_value>"
pdn: "ipv4-only"
preferred_subnet: "0"
private_network: "disable"
signal_period: "3600"
signal_threshold: "100"
slot: "sim1"
type: "carrier"
username: "<your_own_value>"
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3