cisco.meraki.organizations_appliance_vpn_third_party_vpn_peers module – Resource module for organizations _appliance _vpn _third _party _vpn _peers

meraki_action_batch_retry_wait_time

integer

meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry wait time

Default: 60

meraki_api_key

string / required

meraki_api_key (string), API key generated in dashboard; can also be set as an environment variable MERAKI_DASHBOARD_API_KEY

meraki_base_url

string

meraki_base_url (string), preceding all endpoint resources

Default: "https://api.meraki.com/api/v1"

meraki_be_geo_id

string

meraki_be_geo_id (string), optional partner identifier for API usage tracking; can also be set as an environment variable BE_GEO_ID

Default: ""

meraki_certificate_path

string

meraki_certificate_path (string), path for TLS/SSL certificate verification if behind local proxy

Default: ""

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (boolean), Inherits your own logger instance

Choices:

• false ← (default)
• true

meraki_log_file_prefix

string

meraki_log_file_prefix (string), log file name appended with date and timestamp

Default: "meraki_api_"

meraki_log_path

string

log_path (string), path to output log; by default, working directory of script if not specified

Default: ""

meraki_maximum_retries

integer

meraki_maximum_retries (integer), retry up to this many times when encountering 429s or other server-side errors

Default: 2

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time

Default: 60

meraki_output_log

boolean

meraki_output_log (boolean), create an output log file?

Choices:

• false
• true ← (default)

meraki_print_console

boolean

meraki_print_console (boolean), print logging output to console?

Choices:

• false
• true ← (default)

meraki_requests_proxy

string

meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS

Default: ""

meraki_retry_4xx_error

boolean

meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides 429)?

Choices:

• false ← (default)
• true

meraki_retry_4xx_error_wait_time

integer

meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time

Default: 60

meraki_simulate

boolean

meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes?

Choices:

• false ← (default)
• true

meraki_single_request_timeout

integer

meraki_single_request_timeout (integer), maximum number of seconds for each API call

Default: 60

meraki_suppress_logging

boolean

meraki_suppress_logging (boolean), disable all logging? you’re on your own then!

Choices:

• false ← (default)
• true

meraki_use_iterator_for_get_pages

boolean

meraki_use_iterator_for_get_pages (boolean), list* methods will return an iterator with each object instead of a complete list with all items

Choices:

• false ← (default)
• true

meraki_wait_on_rate_limit

boolean

meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered?

Choices:

• false
• true ← (default)

organizationId

string

OrganizationId path parameter. Organization ID.

peers

list / elements=dictionary

The list of VPN peers.

ebgpNeighbor

dictionary

Optional The BGP neighbor configuration for the VPN peer. Supported only for MX 19.1 and above.

ebgpHoldTimer

integer

The eBGP hold timer in seconds for each neighbor. The eBGP hold timer must be an integer between 12 and 240.

ebgpMultihop

integer

Configure this if the neighbor is not adjacent. The eBGP multi-hop must be an integer between 1 and 255.

ipVersion

integer

The IP version of the neighbor.

multiExitDiscriminator

integer

Configures the local metric associated with routes received from the remote peer. Routes from peers with lower metrics are will be preferred. Must be an integer between 0 and 4294967295. MED is 6th in the decision tree when identical routes from multiple peers exist.

neighborIp

string

IPv4/IPv6 address of the neighbor.

pathPrepend

list / elements=integer

Prepends the AS_PATH BGP Attribute associated with routes received from the remote peer. Configurable value of ASNs to prepend. Length of the array may not exceed 10, and each ASN in the array must be an integer between 1 and 4294967295. AS_PATH is 4th in the decision tree when identical routes from multiple peers exist.

remoteAsNumber

integer

Remote ASN of the neighbor. The remote ASN must be an integer between 1 and 4294967295.

sourceIp

string

Source IP of eBGP neighbor.

weight

integer

Configures the local metric associated with routes received from the remote peer. Routes from peers with lower metrics are will be preferred. Must be an integer between 0 and 4294967295. MED is 6th in the decision tree when identical routes from multiple peers exist.

ecmpUplinkConfigs

list / elements=dictionary

Optional The ECMP per-uplink BGP-over-IPsec configuration for the VPN peer.

ebgpNeighbor

dictionary

Optional The BGP neighbor configuration for the VPN peer. Supported only for MX 19.1 and above.

neighborIp

string

IPv4/IPv6 address of the neighbor.

sourceIp

string

Source IP of eBGP neighbor.

id

string

ID of the ECMP uplink configuration.

privateSubnets

list / elements=string

The list of the private subnets of the VPN peer.

wan

string

The WAN uplink associated with this ECMP configuration.

group

dictionary

Optional Contains the mapping between primary tunnel and backup tunnels.

activeActiveTunnel

boolean

Optional Both primary and backup tunnels are active.

Choices:

• false
• true

failover

dictionary

Optional Contains the failover configuration for the group.

directToInternet

boolean

Optional When both primary and backup tunnels are down, direct traffic to the internet. Traffic will be routed via the WAN.

Choices:

• false
• true

number

integer

Optional Represents the ordering of primary and backup tunnels group. Primary and backup tunnels are grouped by this number. If you submit a request with the numbers 1, 9, 999, these numbers will be automatically adjusted to a sequential order starting from 1. So, they will be changed to 1, 2, 3 to reflect their positions in the sequence.

ikeVersion

string

Optional The IKE version to be used for the IPsec VPN peer configuration. Defaults to ‘1’ when omitted.

ipsecPolicies

dictionary

Custom IPSec policies for the VPN peer. If not included and a preset has not been chosen, the default preset for IPSec policies will be used.

childAuthAlgo

list / elements=string

This is the authentication algorithms to be used in Phase 2. The value should be an array with one of the following algorithms ‘sha256’, ‘sha1’, ‘md5’.

childCipherAlgo

list / elements=string

This is the cipher algorithms to be used in Phase 2. The value should be an array with one or more of the following algorithms ‘aes256’, ‘aes192’, ‘aes128’, ‘tripledes’, ‘des’, ‘null’.

childLifetime

integer

The lifetime of the Phase 2 SA in seconds.

childPfsGroup

list / elements=string

This is the Diffie-Hellman group to be used for Perfect Forward Secrecy in Phase 2. The value should be an array with one of the following values ‘disabled’,’group14’, ‘group5’, ‘group2’, ‘group1’.

ikeAuthAlgo

list / elements=string

This is the authentication algorithm to be used in Phase 1. The value should be an array with one of the following algorithms ‘sha256’, ‘sha1’, ‘md5’.

ikeCipherAlgo

list / elements=string

This is the cipher algorithm to be used in Phase 1. The value should be an array with one of the following algorithms ‘aes256’, ‘aes192’, ‘aes128’, ‘tripledes’, ‘des’.

ikeDiffieHellmanGroup

list / elements=string

This is the Diffie-Hellman group to be used in Phase 1. The value should be an array with one of the following algorithms ‘group14’, ‘group5’, ‘group2’, ‘group1’.

ikeLifetime

integer

The lifetime of the Phase 1 SA in seconds.

ikePrfAlgo

list / elements=string

Optional This is the pseudo-random function to be used in IKE_SA. The value should be an array with one of the following algorithms ‘prfsha256’, ‘prfsha1’, ‘prfmd5’, ‘default’. The ‘default’ option can be used to default to the Authentication algorithm.

ipsecPoliciesPreset

string

One of the following available presets ‘default’, ‘aws’, ‘azure’, ‘umbrella’, ‘zscaler’. If this is provided, the ‘ipsecPolicies’ parameter is ignored.

isRouteBased

boolean

Optional If true, the VPN peer is route-based. If not included, the default is false. Supported only for MX 19.1 and above.

Choices:

• false
• true

localId

string

Optional The local ID is used to identify the MX to the peer. This will apply to all MXs this peer applies to.

name

string

The name of the VPN peer.

network

dictionary

Optional A list of network Names and IDs that will connect with this peer. Supported only for MX 19.1 and above.

ids

list / elements=string

Optional A list of network IDs.

networkTags

list / elements=string

A list of network tags that will connect with this peer. Use ‘all’ for all networks. Use ‘none’ for no networks. If not included, the default is ‘all’.

peerId

string

The ID of the IPsec peer.

priorityInGroup

integer

Optional Represents the order of peer inside a group. If you submit a request with the numbers 1, 9, 999, these numbers will be automatically adjusted to a sequential order starting from 1. So, they will be changed to 1, 2, 3 to reflect their positions in the sequence.

privateSubnets

list / elements=string

The list of the private subnets of the VPN peer.

publicHostname

string

Optional The public hostname of the VPN peer.

publicIp

string

Optional The public IP of the VPN peer.

remoteId

string

Optional The remote ID is used to identify the connecting VPN peer. This can either be a valid IPv4 Address, FQDN or User FQDN.

secret

string

The shared secret with the VPN peer.

slaPolicy

dictionary

Optional Information about the SLA policy to be applied to the peer.

id

string

The ID of the SLA policy.

meraki_response

dictionary

A dictionary or list with the response returned by the Cisco Meraki Python SDK

Returned: always

Sample: "[\n  {\n    \"peerId\": \"string\",\n    \"name\": \"string\",\n    \"publicIp\": \"string\",\n    \"remoteId\": \"string\",\n    \"localId\": \"string\",\n    \"secret\": \"string\",\n    \"privateSubnets\": [\n      \"string\"\n    ],\n    \"ipsecPolicies\": {\n      \"ikeCipherAlgo\": [\n        \"string\"\n      ],\n      \"ikeAuthAlgo\": [\n        \"string\"\n      ],\n      \"ikePrfAlgo\": [\n        \"string\"\n      ],\n      \"ikeDiffieHellmanGroup\": [\n        \"string\"\n      ],\n      \"ikeLifetime\": 0,\n      \"childCipherAlgo\": [\n        \"string\"\n      ],\n      \"childAuthAlgo\": [\n        \"string\"\n      ],\n      \"childPfsGroup\": [\n        \"string\"\n      ],\n      \"childLifetime\": 0\n    },\n    \"slaPolicy\": {\n      \"id\": \"string\"\n    },\n    \"ipsecPoliciesPreset\": \"string\",\n    \"ikeVersion\": \"string\",\n    \"networkTags\": [\n      \"string\"\n    ],\n    \"network\": {\n      \"names\": [\n        \"string\"\n      ],\n      \"ids\": [\n        \"string\"\n      ]\n    },\n    \"isRouteBased\": true,\n    \"ebgpNeighbor\": {\n      \"neighborId\": 0,\n      \"neighborIp\": \"string\",\n      \"ipVersion\": 0,\n      \"remoteAsNumber\": 0,\n      \"ebgpHoldTimer\": 0,\n      \"ebgpMultihop\": 0,\n      \"sourceIp\": \"string\",\n      \"pathPrepend\": [\n        0\n      ],\n      \"multiExitDiscriminator\": 0,\n      \"weight\": 0\n    },\n    \"ecmpUplinkConfigs\": [\n      {\n        \"id\": \"string\",\n        \"wan\": \"string\",\n        \"privateSubnets\": [\n          \"string\"\n        ],\n        \"ebgpNeighbor\": {\n          \"neighborIp\": \"string\",\n          \"sourceIp\": \"string\"\n        }\n      }\n    ],\n    \"priorityInGroup\": 0,\n    \"group\": {\n      \"number\": 0,\n      \"failover\": {\n        \"directToInternet\": true\n      },\n      \"activeActiveTunnel\": true\n    }\n  }\n]\n"