security_fortiguard_local_categories - FortiGuard Local Category Resource

Added in version 1.0.0.

Synopsis

FortiGuard Local Category Resource.

Use API “/resource-api/v2/security/fortiguard-local-categories”.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.17.0

Parameters

  • state The state of the module. "present" means create or update the resource, "absent" means delete the resource.type: strchoices: ['present', 'absent']default: present
  • force_behavior Specify this option to force the method to use to interact with the resource.type: strchoices: ['none', 'read', 'create', 'update', 'delete']default: none
  • bypass_validation Bypass validation of the module.type: booldefault: False
  • params The parameters of the module.[Required]type: dict
    • primary_key [Required]type: str
    • threat_weight type: strchoices: ['critical', 'high', 'low', 'medium', 'none']
    • urls type: listelements: str

Examples

- name: Security FortiGuard Local Categories
  hosts: fortisase
  gather_facts: false
  vars:
    primary_key: "asbcategories"
  tasks:
    - name: Create/Update Security FortiGuard Local Categories
      fortinet.fortisase.security_fortiguard_local_categories:
        state: present
        params:
          primary_key: "{{ primary_key }}"
          threat_weight: "low"
          urls: ["example.com"]
    - name: Delete Security FortiGuard Local Categories
      fortinet.fortisase.security_fortiguard_local_categories:
        state: absent
        params:
          primary_key: "{{ primary_key }}"

Return Values

  • http_code type: intreturned: always
  • response type: rawreturned: always

Authors

  • Xinwei Du (@dux-fortinet)