fmgr_extendercontroller_dataplan – FortiExtender dataplan configuration.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- extendercontroller_dataplan - no description type: dict
- 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 - Dataplans modem specifics, if any. type: str choices: [all, modem1, modem2] more...
- monthly-fee - Monthly fee of dataplan (0 - 100000, in local currency). type: int more...
- name - FortiExtender dataplan name type: str 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 (8 - 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. type: int more...
- slot - SIM slot configuration. type: str choices: [sim1, sim2] more...
- status - FortiExtender dataplan (enable or disable). type: str choices: [disable, enable] more...
- type - Type preferences configuration. type: str choices: [carrier, slot, iccid, generic] more...
- username - Username. type: str more...
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: no description
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict