network_host_groups - Host Group Resource

Added in version 1.0.0.

Synopsis

Host Group Resource.

Use API “/resource-api/v2/network/host-groups”.

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
  • members type: listelements: dict
    • primary_key type: str
    • datasource type: strchoices: ['network/host-groups', 'network/hosts']

Examples

- name: Network Host Groups
  hosts: fortisase
  gather_facts: false
  vars:
    host_group: "network_host_group"
  tasks:
    - name: Create/Update Network Host Groups
      fortinet.fortisase.network_host_groups:
        state: present
        params:
          primary_key: "{{ host_group }}"
          members:
            - datasource: "network/hosts"
              primary_key: "all"
    - name: Delete Network Host Groups
      fortinet.fortisase.network_host_groups:
        state: absent
        params:
          primary_key: "{{ host_group }}"

Return Values

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

Authors

• Xinwei Du (@dux-fortinet)