fortios_virtual_patch_profile.rst

source:	fortios_virtual_patch_profile.py
orphan:

fortios_virtual_patch_profile -- Configure virtual-patch profile in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

Synopsis

• This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify virtual_patch feature and profile 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.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_virtual_patch_profile	v7.4.1 -> latest

Parameters

• access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
• enable_log - Enable/Disable logging for task. type: bool required: false default: 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
• member_path - Member attribute path to operate on. type: str
• member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
• state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
• virtual_patch_profile - Configure virtual-patch profile. type: dict more...

  	Supported Version Ranges
  virtual_patch_profile	v7.4.1 -> latest

• action - Action (pass/block). type: str choices: pass, block more...

  	Supported Version Ranges
  action	v7.4.1 -> latest
  [pass]	v6.0.0 -> latest
  [block]	v6.0.0 -> latest

• comment - Comment. type: str more...

  	Supported Version Ranges
  comment	v7.4.1 -> latest

• exemption - Exempt devices or rules. type: list member_path: exemption:id more...

  	Supported Version Ranges
  exemption	v7.4.1 -> latest

• device - Device MAC addresses. type: list member_path: exemption:id/device:mac more...

  	Supported Version Ranges
  device	v7.4.1 -> latest

• mac - Device MAC address. type: str required: true more...

  	Supported Version Ranges
  mac	v7.4.1 -> latest

• id - IDs. see Notes. type: int required: true more...

  	Supported Version Ranges
  id	v7.4.1 -> latest

• rule - Patch signature rule IDs. type: list member_path: exemption:id/rule:id more...

  	Supported Version Ranges
  rule	v7.4.1 -> latest

• id - Rule IDs. see Notes. type: int required: true more...

  	Supported Version Ranges
  id	v7.4.1 -> latest

• status - Enable/disable exemption. type: str choices: enable, disable more...

  	Supported Version Ranges
  status	v7.4.1 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• log - Enable/disable logging of detection. type: str choices: enable, disable more...

  	Supported Version Ranges
  log	v7.4.1 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• name - Profile name. type: str required: true more...

  	Supported Version Ranges
  name	v7.4.1 -> latest

• severity - Relative severity of the signature (low, medium, high, critical). type: list choices: low, medium, high, critical more...

  	Supported Version Ranges
  severity	v7.4.1 -> latest
  [low]	v6.0.0 -> latest
  [medium]	v6.0.0 -> latest
  [high]	v6.0.0 -> latest
  [critical]	v6.0.0 -> latest

Notes

Note

• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure virtual-patch profile.
  fortinet.fortios.fortios_virtual_patch_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      virtual_patch_profile:
          action: "pass"
          comment: "Comment."
          exemption:
              -
                  device:
                      -
                          mac: "<your_own_value>"
                  id: "8"
                  rule:
                      -
                          id: "10"
                  status: "enable"
          log: "enable"
          name: "default_name_13"
          severity: "low"

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

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.