lix_fortinet.fortios.fortios_extender_controller_dataplan (102.2.120) — module

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120

Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify extender_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

Requirements

• ansible>=2.9

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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_extender_controller_dataplan:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      extender_controller_dataplan:
        apn: "<your_own_value>"
        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_12"
        overage: "disable"
        password: "<your_own_value>"
        pdn: "ipv4-only"
        PDN: "ipv4-only"
        preferred_subnet: "32"
        private_network: "disable"
        signal_period: "3600"
        signal_threshold: "100"
        slot: "sim1"
        type: "carrier"
        username: "<your_own_value>"

Inputs

    
vdom:
    default: root
    description:
    - 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

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

extender_controller_dataplan:
    default: null
    description:
    - FortiExtender dataplan configuration.
    suboptions:
      APN:
        description:
        - APN configuration.
        type: str
      PDN:
        choices:
        - ipv4-only
        - ipv6-only
        - ipv4-ipv6
        description:
        - PDN type.
        type: str
      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 (1 - 31).
        type: int
      capacity:
        description:
        - Capacity in MB (0 - 102400000).
        type: int
      carrier:
        description:
        - Carrier configuration.
        type: str
      iccid:
        description:
        - ICCID configuration.
        type: str
      modem_id:
        choices:
        - modem1
        - modem2
        - all
        description:
        - Dataplan"s modem specifics, if any.
        type: str
      monthly_fee:
        description:
        - Monthly fee of dataplan (0 - 100000, in local currency).
        type: int
      name:
        description:
        - FortiExtender data plan name.
        required: true
        type: str
      overage:
        choices:
        - disable
        - enable
        description:
        - Enable/disable dataplan overage detection.
        type: str
      password:
        description:
        - Password.
        type: str
      pdn:
        choices:
        - ipv4-only
        - ipv6-only
        - ipv4-ipv6
        description:
        - PDN type.
        type: str
      preferred_subnet:
        description:
        - Preferred subnet mask (0 - 32).
        type: int
      private_network:
        choices:
        - disable
        - enable
        description:
        - Enable/disable dataplan private network support.
        type: str
      signal_period:
        description:
        - Signal period (600 to 18000 seconds).
        type: int
      signal_threshold:
        description:
        - Signal threshold. Specify the range between 50 - 100, where 50/100 means -50/-100
          dBm.
        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

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str