lix_fortinet.fortios.fortios_system_vdom_property (102.2.120) — module

Configure VDOM property in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of lix_fortinet.fortios"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

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 system feature and vdom_property category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0


Requirements

Usage examples

  • 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: Configure VDOM property.
    fortios_system_vdom_property:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_vdom_property:
        custom_service: "<your_own_value>"
        description: "<your_own_value>"
        dialup_tunnel: "<your_own_value>"
        firewall_address: "<your_own_value>"
        firewall_addrgrp: "<your_own_value>"
        firewall_policy: "<your_own_value>"
        ipsec_phase1: "<your_own_value>"
        ipsec_phase1_interface: "<your_own_value>"
        ipsec_phase2: "<your_own_value>"
        ipsec_phase2_interface: "<your_own_value>"
        log_disk_quota: "<your_own_value>"
        name: "default_name_14 (source system.vdom.name)"
        onetime_schedule: "<your_own_value>"
        proxy: "<your_own_value>"
        recurring_schedule: "<your_own_value>"
        service_group: "<your_own_value>"
        session: "<your_own_value>"
        snmp_index: "0"
        sslvpn: "<your_own_value>"
        user: "<your_own_value>"
        user_group: "<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

system_vdom_property:
    default: null
    description:
    - Configure VDOM property.
    suboptions:
      custom_service:
        description:
        - Maximum guaranteed number of firewall custom services.
        elements: str
        type: list
      description:
        description:
        - Description.
        type: str
      dialup_tunnel:
        description:
        - Maximum guaranteed number of dial-up tunnels.
        elements: str
        type: list
      firewall_address:
        description:
        - Maximum guaranteed number of firewall addresses (IPv4, IPv6, multicast).
        elements: str
        type: list
      firewall_addrgrp:
        description:
        - Maximum guaranteed number of firewall address groups (IPv4, IPv6).
        elements: str
        type: list
      firewall_policy:
        description:
        - Maximum guaranteed number of firewall policies (policy, DoS-policy4, DoS-policy6,
          multicast).
        elements: str
        type: list
      ipsec_phase1:
        description:
        - Maximum guaranteed number of VPN IPsec phase 1 tunnels.
        elements: str
        type: list
      ipsec_phase1_interface:
        description:
        - Maximum guaranteed number of VPN IPsec phase1 interface tunnels.
        elements: str
        type: list
      ipsec_phase2:
        description:
        - Maximum guaranteed number of VPN IPsec phase 2 tunnels.
        elements: str
        type: list
      ipsec_phase2_interface:
        description:
        - Maximum guaranteed number of VPN IPsec phase2 interface tunnels.
        elements: str
        type: list
      log_disk_quota:
        description:
        - Log disk quota in megabytes (MB). Range depends on how much disk space is available.
        elements: str
        type: list
      name:
        description:
        - VDOM name. Source system.vdom.name.
        required: true
        type: str
      onetime_schedule:
        description:
        - Maximum guaranteed number of firewall one-time schedules.
        elements: str
        type: list
      proxy:
        description:
        - Maximum guaranteed number of concurrent proxy users.
        elements: str
        type: list
      recurring_schedule:
        description:
        - Maximum guaranteed number of firewall recurring schedules.
        elements: str
        type: list
      service_group:
        description:
        - Maximum guaranteed number of firewall service groups.
        elements: str
        type: list
      session:
        description:
        - Maximum guaranteed number of sessions.
        elements: str
        type: list
      snmp_index:
        description:
        - Permanent SNMP Index of the virtual domain (1 - 2147483647).
        type: int
      sslvpn:
        description:
        - Maximum guaranteed number of SSL-VPNs.
        elements: str
        type: list
      user:
        description:
        - Maximum guaranteed number of local users.
        elements: str
        type: list
      user_group:
        description:
        - Maximum guaranteed number of user groups.
        elements: str
        type: list
    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