fortios_system_vdom_property – Configure VDOM property in Fortinet’s FortiOS and FortiGate

New in version 2.9.

Synopsis

• 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

The below requirements are needed on the host that executes this module.

• fortiosapi>=0.9.8

Parameters

Parameter		Choices/Defaults	Comments
host string			FortiOS or FortiGate IP address.
https boolean		Choices: no yes ←	Indicates if the requests towards FortiGate must use HTTPS protocol.
password string		Default: ""	FortiOS or FortiGate password.
ssl_verify boolean		Choices: no yes ←	Ensures FortiGate certificate must be verified by a proper CA.
state string / required		Choices: present absent	Indicates whether to create or remove the object.
system_vdom_property dictionary			Configure VDOM property.
	custom_service string		Maximum guaranteed number of firewall custom services.
	description string		Description.
	dialup_tunnel string		Maximum guaranteed number of dial-up tunnels.
	firewall_address string		Maximum guaranteed number of firewall addresses (IPv4, IPv6, multicast).
	firewall_addrgrp string		Maximum guaranteed number of firewall address groups (IPv4, IPv6).
	firewall_policy string		Maximum guaranteed number of firewall policies (IPv4, IPv6, policy46, policy64, DoS-policy4, DoS-policy6, multicast).
	ipsec_phase1 string		Maximum guaranteed number of VPN IPsec phase 1 tunnels.
	ipsec_phase1_interface string		Maximum guaranteed number of VPN IPsec phase1 interface tunnels.
	ipsec_phase2 string		Maximum guaranteed number of VPN IPsec phase 2 tunnels.
	ipsec_phase2_interface string		Maximum guaranteed number of VPN IPsec phase2 interface tunnels.
	log_disk_quota string		Log disk quota in MB (range depends on how much disk space is available).
	name string / required		VDOM name. Source system.vdom.name.
	onetime_schedule string		Maximum guaranteed number of firewall one-time schedules.
	proxy string		Maximum guaranteed number of concurrent proxy users.
	recurring_schedule string		Maximum guaranteed number of firewall recurring schedules.
	service_group string		Maximum guaranteed number of firewall service groups.
	session string		Maximum guaranteed number of sessions.
	snmp_index integer		Permanent SNMP Index of the virtual domain (0 - 4294967295).
	sslvpn string		Maximum guaranteed number of SSL-VPNs.
	user string		Maximum guaranteed number of local users.
	user_group string		Maximum guaranteed number of user groups.
username string			FortiOS or FortiGate username.
vdom string		Default: "root"	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.

Notes

Note

• Requires fortiosapi library developed by Fortinet

• Run as a local_action in your playbook

Examples

- 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>"

Return Values

Common return values are documented here, the following are the fields unique to this module:

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

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]

• This module is maintained by the Ansible Community. [community]

Authors

• Miguel Angel Munoz (@mamunozgonzalez)

• Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.