Skip to content

Latest commit

 

History

History
299 lines (255 loc) · 13 KB

fortios_system_object_tagging.rst

File metadata and controls

299 lines (255 loc) · 13 KB
Raw
source:fortios_system_object_tagging.py
orphan:

fortios_system_object_tagging -- Configure object tagging in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and object_tagging 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_system_object_tagging v6.0.0 -> 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
  • system_object_tagging - Configure object tagging. type: dict more...
    Supported Version Ranges
    system_object_tagging v6.0.0 -> latest
    • address - Address. type: str choices: disable, mandatory, optional more...
      Supported Version Ranges
      address v6.0.0 -> latest
      [disable] v6.0.0 -> latest
      [mandatory] v6.0.0 -> latest
      [optional] v6.0.0 -> latest
    • category - Tag Category. type: str required: true more...
      Supported Version Ranges
      category v6.0.0 -> latest
    • color - Color of icon on the GUI. type: int more...
      Supported Version Ranges
      color v6.0.0 -> latest
    • device - Device. type: str choices: disable, mandatory, optional more...
      Supported Version Ranges
      device v6.0.0 -> latest
      [disable] v6.0.0 -> latest
      [mandatory] v6.0.0 -> latest
      [optional] v6.0.0 -> latest
    • interface - Interface. type: str choices: disable, mandatory, optional more...
      Supported Version Ranges
      interface v6.0.0 -> latest
      [disable] v6.0.0 -> latest
      [mandatory] v6.0.0 -> latest
      [optional] v6.0.0 -> latest
    • multiple - Allow multiple tag selection. type: str choices: enable, disable more...
      Supported Version Ranges
      multiple v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • tags - Tags. type: list member_path: tags:name more...
      Supported Version Ranges
      tags v6.0.0 -> latest
      • name - Tag name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> latest

Notes

Note

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

Examples

- name: Configure object tagging.
  fortinet.fortios.fortios_system_object_tagging:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_object_tagging:
          address: "disable"
          category: "<your_own_value>"
          color: "0"
          device: "disable"
          interface: "disable"
          multiple: "enable"
          tags:
              -
                  name: "default_name_10"

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.