fortinet.fortimanager.fmgr_extendercontroller_dataplan – FortiExtender dataplan configuration.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_extendercontroller_dataplan.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
extendercontroller_dataplan
dictionary
the top level parameters set
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:
  • all
  • modem1
  • modem2
Dataplans modem specifics, if any.
monthly-fee
integer
Monthly fee of dataplan (0 - 100000, in local currency).
name
string
FortiExtender dataplan name
overage
string
    Choices:
  • disable
  • enable
Enable/disable dataplan overage detection.
password
string
no description
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.
status
string
    Choices:
  • disable
  • enable
FortiExtender dataplan (enable or disable).
type
string
    Choices:
  • carrier
  • slot
  • iccid
  • generic
Type preferences configuration.
username
string
Username.
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
workspace_locking_adom
string
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout
integer
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: FortiExtender dataplan configuration.
     fmgr_extendercontroller_dataplan:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        extendercontroller_dataplan:
           apn: <value of string>
           auth-type: <value in [none, pap, chap]>
           billing-date: <value of integer>
           capacity: <value of integer>
           carrier: <value of string>
           iccid: <value of string>
           modem-id: <value in [all, modem1, modem2]>
           monthly-fee: <value of integer>
           name: <value of string>
           overage: <value in [disable, enable]>
           password: <value of string>
           pdn: <value in [ipv4-only, ipv6-only, ipv4-ipv6]>
           preferred-subnet: <value of integer>
           private-network: <value in [disable, enable]>
           signal-period: <value of integer>
           signal-threshold: <value of integer>
           slot: <value in [sim1, sim2]>
           status: <value in [disable, enable]>
           type: <value in [carrier, slot, iccid, ...]>
           username: <value of string>

Return Values

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

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)