fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_extendercontroller_dataplan FortiExtender dataplan configuration. | "added in version" 2.1.0 of fortinet.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 communityfortinet.fortimanager.fmgr_extendercontroller_dataplan (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
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.
- name: Example playbook (generated based on argument schema) hosts: fortimanagers connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: FortiExtender dataplan configuration. fortinet.fortimanager.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: present # <value in [present, absent]> extendercontroller_dataplan: apn: <string> auth_type: <value in [none, pap, chap]> billing_date: <integer> capacity: <integer> carrier: <string> iccid: <string> modem_id: <value in [all, modem1, modem2]> monthly_fee: <integer> name: <string> overage: <value in [disable, enable]> password: <list or string> pdn: <value in [ipv4-only, ipv6-only, ipv4-ipv6]> preferred_subnet: <integer> private_network: <value in [disable, enable]> signal_period: <integer> signal_threshold: <integer> slot: <value in [sim1, sim2]> status: <value in [disable, enable]> type: <value in [carrier, slot, iccid, ...]> username: <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 type: list enable_log: default: false description: Enable/Disable logging for task. type: bool access_token: description: The token to access FortiManager without using username and password. type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. 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. 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. type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. type: int extendercontroller_dataplan: description: The top level parameters set. required: false suboptions: apn: description: APN configuration. type: str auth-type: choices: - none - pap - chap description: Deprecated, please rename it to auth_type. Authentication type. type: str billing-date: description: Deprecated, please rename it to billing_date. 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: Deprecated, please rename it to modem_id. Dataplans modem specifics, if any. type: str monthly-fee: description: Deprecated, please rename it to monthly_fee. Monthly fee of dataplan type: int name: description: FortiExtender dataplan name required: true type: str overage: choices: - disable - enable description: Enable/disable dataplan overage detection. type: str password: description: (list) Password. type: raw pdn: choices: - ipv4-only - ipv6-only - ipv4-ipv6 description: PDN type. type: str preferred-subnet: description: Deprecated, please rename it to preferred_subnet. Preferred subnet mask type: int private-network: choices: - disable - enable description: Deprecated, please rename it to private_network. Enable/disable dataplan private network support. type: str signal-period: description: Deprecated, please rename it to signal_period. Signal period type: int signal-threshold: description: Deprecated, please rename it to signal_threshold. Signal threshold. type: int slot: choices: - sim1 - sim2 description: SIM slot configuration. type: str status: choices: - disable - enable description: FortiExtender dataplan 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