ansible.builtin.fortios_system_vdom_property (v2.9.27) — module

Configure VDOM property in Fortinet's FortiOS and FortiGate.

| "added in version" 2.9 of ansible.builtin"

Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

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.5


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure VDOM property.
    fortios_system_vdom_property:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      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: "20"
        sslvpn: "<your_own_value>"
        user: "<your_own_value>"
        user_group: "<your_own_value>"

Inputs

    
host:
    description:
    - FortiOS or FortiGate IP address.
    required: false
    type: str

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

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol.
    type: bool

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

password:
    default: ''
    description:
    - FortiOS or FortiGate password.
    type: str

username:
    description:
    - FortiOS or FortiGate username.
    required: false
    type: str

ssl_verify:
    default: true
    description:
    - Ensures FortiGate certificate must be verified by a proper CA.
    type: bool

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