:source: fortios_system_dhcp_server.py :orphan: .. fortios_system_dhcp_server: fortios_system_dhcp_server -- Configure DHCP servers in Fortinet's FortiOS and FortiGate. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 2.0.0 .. contents:: :local: :depth: 1 Synopsis -------- - This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_dhcp feature and server 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.16 Tips ---- Using member operation to add an element to an existing object. FortiOS Version Compatibility ----------------------------- Supported Version Ranges: v6.0.0 -> v7.6.6 Parameters ---------- .. raw:: html Notes ----- .. note:: - We highly recommend using your own value as the id instead of 0, while '0' is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A. - Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks - The module supports check_mode. Examples -------- .. code-block:: yaml+jinja - name: Configure DHCP servers. fortinet.fortios.fortios_system_dhcp_server: vdom: "{{ vdom }}" state: "present" access_token: "" system_dhcp_server: auto_configuration: "disable" auto_managed_status: "disable" conflicted_ip_timeout: "1800" ddns_auth: "disable" ddns_key: "" ddns_keyname: "" ddns_server_ip: "" ddns_ttl: "300" ddns_update: "disable" ddns_update_override: "disable" ddns_zone: "" default_gateway: "" dhcp_settings_from_fortiipam: "disable" dns_server1: "" dns_server2: "" dns_server3: "" dns_server4: "" dns_service: "local" domain: "" exclude_range: - end_ip: "" id: "24" lease_time: "0" start_ip: "" uci_match: "disable" uci_string: - uci_string: "" vci_match: "disable" vci_string: - vci_string: "" filename: "" forticlient_on_net_status: "disable" id: "35" interface: " (source system.interface.name)" ip_mode: "range" ip_range: - end_ip: "" id: "40" lease_time: "0" start_ip: "" uci_match: "disable" uci_string: - uci_string: "" vci_match: "disable" vci_string: - vci_string: "" ipsec_lease_hold: "60" lease_time: "604800" mac_acl_default_action: "assign" netmask: "" next_server: "" ntp_server1: "" ntp_server2: "" ntp_server3: "" ntp_service: "local" options: - code: "0" id: "60" ip: "" type: "hex" uci_match: "disable" uci_string: - uci_string: "" value: "" vci_match: "disable" vci_string: - vci_string: "" relay_agent: "" reserved_address: - action: "assign" circuit_id: "" circuit_id_type: "hex" description: "" id: "76" ip: "" mac: "" remote_id: "" remote_id_type: "hex" type: "mac" server_type: "regular" shared_subnet: "disable" status: "disable" tftp_server: - tftp_server: "" timezone: "01" timezone_option: "disable" vci_match: "disable" vci_string: - vci_string: "" wifi_ac_service: "specify" wifi_ac1: "" wifi_ac2: "" wifi_ac3: "" wins_server1: "" wins_server2: "" 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: .. raw:: html
  • 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
Status ------ - This module is not guaranteed to have a backwards compatible interface. Authors ------- - Link Zheng (@chillancezen) - Jie Xue (@JieX19) - Hongbin Lu (@fgtdev-hblu) - Frank Shen (@frankshen01) - Miguel Angel Munoz (@mamunozgonzalez) - Nicolas Thomas (@thomnico) .. hint:: If you notice any issues in this documentation, you can create a pull request to improve it.