Site to Site VPN List (Meraki)
This object returns a list of site to site vpn. Note that it will output either a list of hub or subnets, based on how it is configured.
Input Parameters
Meraki API Key |
String |
Yes |
The API key that will be used to pull information about the environment. The account used to obtain this key must have as a recommended minimum, full read-only access. |
Network ID |
String |
Yes |
The unique Network ID for which we want to pull the vpn list. |
Output Parameters
Subnet List |
Collection
|
The list of subnets linked to the vpns for that network. Note that this will only populate if it is in the right mode:
Local Subnet Information | String | 192.168.2.0/24 | Use VPN | Boolean | True |
|
Count of Subnets |
Number |
The count of subnets returned for that network. |
Hubs List |
Collection
|
The list of hubs linked to the vpns for that network. Note that this will only populate if it is in the right mode:
Hub ID | String | Hubname | Use Default Route | Boolean | True |
|
Counts of Hubs |
Number |
The count of hubs returned for that network. |
VPN Mode |
String |
The mode in which the vpn is configured. |
Result |
Number |
Returns a success value of zero or any value other than zero to indicate failure. |
Result String |
String |
Object execution error details. |
Example Input Parameters
Meraki API Key |
String |
Yes |
1a1a1a1a1a1a1a1a1a1a1a2a2a2a2a2a2a2a3a3a |
Network ID |
String |
Yes |
L_125124 |