drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_extensioncontroller_dataplan FortiExtender dataplan configuration. | "added in version" 2.2.0 of drmofu.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communitydrmofu.fortimanager.fmgr_extensioncontroller_dataplan (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
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.
- 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_extensioncontroller_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]> extensioncontroller_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]> type: <value in [carrier, slot, iccid, ...]> username: <value of string>
adom: description: the parameter (adom) in requested url required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int required: false type: list enable_log: default: false description: Enable/Disable logging for task. required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int required: false type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. required: false type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. required: false type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. required: false type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. required: false type: int extensioncontroller_dataplan: description: the top level parameters set required: false suboptions: apn: description: APN configuration. type: str auth-type: choices: - none - pap - chap description: Authentication type. type: str billing-date: description: Billing day of the month type: int capacity: description: Capacity in MB type: int carrier: description: Carrier configuration. type: str iccid: description: ICCID configuration. type: str modem-id: choices: - all - modem1 - modem2 description: Dataplans modem specifics, if any. type: str monthly-fee: description: Monthly fee of dataplan type: int name: description: FortiExtender data plan name. type: str overage: choices: - disable - enable description: Enable/disable dataplan overage detection. type: str password: description: description type: str pdn: choices: - ipv4-only - ipv6-only - ipv4-ipv6 description: PDN type. type: str preferred-subnet: description: Preferred subnet mask type: int private-network: choices: - disable - enable description: Enable/disable dataplan private network support. type: str signal-period: description: Signal period type: int signal-threshold: description: Signal threshold. type: int slot: choices: - sim1 - sim2 description: SIM slot configuration. type: str type: choices: - carrier - slot - iccid - generic description: Type preferences configuration. type: str username: description: Username. type: str type: dict
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list