getInterfaceGroupObject

The getInterfaceGroupObject operation handles configuration related to /api/fmc_config/v1/domain/{domainUUID}/object/interfacegroups/{objectId} path.

Description

Retrieves, deletes, creates, or modifies the Interface group objects associated with the specified ID. If no ID is specified for a GET, retrieves list of all interface group objects.

Path Parameters

Parameter	Required	Type	Description
objectId	True	string	Unique identifier of the object.
domainUUID	True	string	Domain UUID

Query Parameters

Parameter	Required	Type	Description
groupByDevice	False	string	Set true to group interfaces by device and return as `devices` attribute, instead of `interfaces`.

Example

- name: Execute 'getInterfaceGroupObject' operation
  cisco.fmcansible.fmc_configuration:
    operation: "getInterfaceGroupObject"
    path_params:
        objectId: "{{ object_id }}"
        domainUUID: "{{ domain_uuid }}"
    query_params:
        groupByDevice: "{{ group_by_device }}"