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.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- vdom - 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 default: root
- state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
- system_vdom_property - Configure VDOM property. type: dict
- custom_service - Maximum guaranteed number of firewall custom services. type: str
- description - Description. type: str
- dialup_tunnel - Maximum guaranteed number of dial-up tunnels. type: str
- firewall_address - Maximum guaranteed number of firewall addresses. type: str
- firewall_addrgrp - Maximum guaranteed number of firewall address groups. type: str
- firewall_policy - Maximum guaranteed number of firewall policies. type: str
- ipsec_phase1 - Maximum guaranteed number of VPN IPsec phase 1 tunnels. type: str
- ipsec_phase1_interface - Maximum guaranteed number of VPN IPsec phase1 interface tunnels. type: str
- ipsec_phase2 - Maximum guaranteed number of VPN IPsec phase 2 tunnels. type: str
- ipsec_phase2_interface - Maximum guaranteed number of VPN IPsec phase2 interface tunnels. type: str
- log_disk_quota - Log disk quota in MB (range depends on how much disk space is available). type: str
- name - VDOM name. Source system.vdom.name. type: str required: True
- onetime_schedule - Maximum guaranteed number of firewall one-time schedules. type: str
- proxy - Maximum guaranteed number of concurrent proxy users. type: str
- recurring_schedule - Maximum guaranteed number of firewall recurring schedules. type: str
- service_group - Maximum guaranteed number of firewall service groups. type: str
- session - Maximum guaranteed number of sessions. type: str
- snmp_index - Permanent SNMP Index of the virtual domain (0 - 4294967295). type: int
- sslvpn - Maximum guaranteed number of SSL-VPNs. type: str
- user - Maximum guaranteed number of local users. type: str
- user_group - Maximum guaranteed number of user groups. type: str
Examples¶
- 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: "20"
sslvpn: "<your_own_value>"
user: "<your_own_value>"
user_group: "<your_own_value>"
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3