getS2SVpnSummaryModel
The getS2SVpnSummaryModel operation handles configuration related to /api/fmc_config/v1/domain/{domainUUID}/policy/s2svpnsummaries path.
Description
Retrieves all the configured S2S VPN in the system , with short summary along with the health of the tunnels.
Path Parameters
| Parameter | Required | Type | Description | |||
|---|---|---|---|---|---|---|
| domainUUID | True | string | Domain UUID | |||
Query Parameters
| Parameter | Required | Type | Description | |||
|---|---|---|---|---|---|---|
| filter | False | string | The filter criteria for which the details have to be fetched.Following filter are supported.User can enter one or many filter device:{deviceId};name:{Topology name}:routeBased:{true | false} | ||
| 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 'getS2SVpnSummaryModel' operation
cisco.fmcansible.fmc_configuration:
operation: "getS2SVpnSummaryModel"
path_params:
domainUUID: "{{ domain_uuid }}"
query_params:
filter: "{{ filter }}"
offset: "{{ offset }}"
limit: "{{ limit }}"
expanded: "{{ expanded }}"