fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_system_admin_profile_datamaskcustomfields Customized datamask fields. | "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_admin_profile_datamaskcustomfields (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: Customized datamask fields. fortinet.fortimanager.fmgr_system_admin_profile_datamaskcustomfields: bypass_validation: false profile: ansible-test-profile # profileid state: present system_admin_profile_datamaskcustomfields: field-category: - log - fortiview - alert - ueba - all field-name: ansible-test-mask field-status: disable field-type: string # <value in [string, ip, mac, ...]>
- 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 customized datamask fields of admin profile fortinet.fortimanager.fmgr_fact: facts: selector: "system_admin_profile_datamaskcustomfields" params: profile: "ansible-test-profile" # profileid datamask-custom-fields: "your_value"
state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str profile: description: The parameter (profile) 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_admin_profile_datamaskcustomfields: description: The top level parameters set. required: false suboptions: field-category: choices: - log - fortiview - alert - ueba - all description: Deprecated, please rename it to field_category. elements: str type: list field-name: description: Deprecated, please rename it to field_name. Field name. required: true type: str field-status: choices: - disable - enable description: - Deprecated, please rename it to field_status. - Field status. - disable - Disable field. - enable - Enable field. type: str field-type: choices: - string - ip - mac - email - unknown description: - Deprecated, please rename it to field_type. - Field type. - string - String. - ip - IP. - mac - MAC address. - email - Email address. - unknown - Unknown. type: str 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