getTunnelStatus
The getTunnelStatus operation handles configuration related to /api/fmc_config/v1/domain/{domainUUID}/health/tunnelstatuses path.
Description
Retrieves tunnel status for S2S VPN on all managed Firewall Threat Defenses.
Path Parameters
| Parameter | Required | Type | Description | |||
|---|---|---|---|---|---|---|
| domainUUID | True | string | Domain UUID | |||
Query Parameters
| Parameter | Required | Type | Description | |||
|---|---|---|---|---|---|---|
| filter | False | string | The allowed filters are "vpnTopologyId:{uuid}" which filters the tunnel statuses by S2S VPN Topology id, "deviceId:{UUID}" which filters the tunnel statuses by Device id, status:{TUNNEL_UP |
TUNNEL_DOWN | ||
| 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 'getTunnelStatus' operation
cisco.fmcansible.fmc_configuration:
operation: "getTunnelStatus"
path_params:
domainUUID: "{{ domain_uuid }}"
query_params:
filter: "{{ filter }}"
offset: "{{ offset }}"
limit: "{{ limit }}"
expanded: "{{ expanded }}"