getAllDevice

The getAllDevice operation handles configuration related to /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords path.

Description

Retrieves or modifies the device record associated with the specified ID. Registers or unregisters a device. If no ID is specified for a GET, retrieves list of all device records.

Path Parameters

Parameter	Required	Type	Description
domainUUID	True	string	Domain UUID

Query Parameters

Parameter	Required	Type	Description
filter	False	string	Filter to retrieve or delete device records based upon filter parameters specified. For bulk deletion, we need the filter="ids:" with `bulk=true` flag, Value is of format : `"ids:id1,id2,..."`. `ids:id1,id2,...` is a comma-separated list of device uuids to be deleted. For fetching device records, Filter criteria should be `name:{name};hostName:{hostName};serialNumber:{ABCXXXXX};containerType:{value};version:{x.x.x};clusterBootstrapSupported:{true`	false};analyticsOnly:{true
offset	False	integer	Index of first item to return.
limit	False	integer	Number of items to return.
expanded	False	boolean	If set to true, the GET response displays a list of objects with additional attributes.

Example

- name: Execute 'getAllDevice' operation
  cisco.fmcansible.fmc_configuration:
    operation: "getAllDevice"
    path_params:
        domainUUID: "{{ domain_uuid }}"
    query_params:
        filter: "{{ filter }}"
        offset: "{{ offset }}"
        limit: "{{ limit }}"
        expanded: "{{ expanded }}"