fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_system_dhcp_server_options DHCP options. | "added in version" 2.0.0 of fortinet.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communityfortinet.fortimanager.fmgr_system_dhcp_server_options (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- name: Example playbook hosts: fortimanagers connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: DHCP options. fortinet.fortimanager.fmgr_system_dhcp_server_options: bypass_validation: false adom: ansible server: 1 # id state: present system_dhcp_server_options: id: 1 ip: 222.222.222.1 type: hex # <value in [hex, string, ip, ...]> value: ansible
- name: Gathering fortimanager facts hosts: fortimanagers gather_facts: false connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Retrieve all the DHCP options of DHCP server fortinet.fortimanager.fmgr_fact: facts: selector: "system_dhcp_server_options" params: adom: "ansible" server: "1" # id options: "your_value"
adom: description: The parameter (adom) in requested url. required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str server: description: The parameter (server) in requested url. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int type: list enable_log: default: false description: Enable/Disable logging for task. type: bool access_token: description: The token to access FortiManager without using username and password. type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. type: int system_dhcp_server_options: description: The top level parameters set. required: false suboptions: code: description: DHCP option code. type: int id: description: ID. required: true type: int ip: description: (list) No description. type: raw type: choices: - hex - string - ip - fqdn description: DHCP option type. type: str uci-match: choices: - disable - enable description: Deprecated, please rename it to uci_match. Enable/disable user class identifier type: str uci-string: description: (list) Deprecated, please rename it to uci_string. type: raw value: description: DHCP option value. type: str vci-match: choices: - disable - enable description: Deprecated, please rename it to vci_match. Enable/disable vendor class identifier type: str vci-string: description: (list) Deprecated, please rename it to vci_string. type: raw type: dict
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list