Class ThirdPartyVpnPeer

Namespace

Meraki.Api.Data

Assembly

Meraki.Api.dll

Peer

[DataContract]
public class ThirdPartyVpnPeer : NamedItem

Inheritance

object

NamedItem

ThirdPartyVpnPeer

Inherited Members

NamedItem.Name

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ThirdPartyVpnPeer()

public ThirdPartyVpnPeer()

Properties

EbgpNeighbor

[optional] The BGP neighbor configuration for the VPN peer. Supported only for MX 19.1 and above.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "ebgpNeighbor")]
public ThirdPartyVpnPeerEbgpNeighbor? EbgpNeighbor { get; set; }

Property Value

ThirdPartyVpnPeerEbgpNeighbor

Group

[optional] Contains the mapping between primary tunnel and backup tunnels.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "group")]
public ThirdPartyVpnPeerGroup? Group { get; set; }

Property Value

ThirdPartyVpnPeerGroup

IkeVersion

[optional] The IKE version to be used for the IPsec VPN peer configuration. Defaults to '1' when omitted.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "ikeVersion")]
public string? IkeVersion { get; set; }

Property Value

string

IpsecPolicies

Gets or Sets IpsecPolicies

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "ipsecPolicies")]
public IpsecPolicies? IpsecPolicies { get; set; }

Property Value

IpsecPolicies

IpsecPoliciesPreset

One of the following available presets: 'default', 'aws', 'azure'. If this is provided, the 'ipsecPolicies' parameter is ignored.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "ipsecPoliciesPreset")]
public string? IpsecPoliciesPreset { get; set; }

Property Value

string

IsRouteBased

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

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "isRouteBased")]
public bool? IsRouteBased { get; set; }

Property Value

bool?

LocalId

Local ID - Undocumented

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "localId")]
public string? LocalId { get; set; }

Property Value

string

Network

[optional] A list of network Names.Supported only for MX 19.1 and above.The order of items matches the order of IDs.

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "network")]
public ThirdPartyVpnPeerNetwork? Network { get; set; }

Property Value

ThirdPartyVpnPeerNetwork

NetworkTags

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'].

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "networkTags")]
public List<string>? NetworkTags { get; set; }

Property Value

List<string>

PeerId

The ID of the IPsec peer

[ApiKey]
[DataMember(Name = "peerId")]
public string? PeerId { get; set; }

Property Value

string

PriorityInGroup

[optional] Represents the order of peer inside a group

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "priorityInGroup")]
public int? PriorityInGroup { get; set; }

Property Value

int?

PrivateSubnets

The list of the private subnets of the VPN peer

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "privateSubnets")]
public List<string>? PrivateSubnets { get; set; }

Property Value

List<string>

PublicHostname

Undocumented 2025-02-21

[ApiAccess(ApiAccess.Read)]
[DataMember(Name = "publicHostname")]
public string? PublicHostname { get; set; }

Property Value

string

PublicIp

The public IP of the VPN peer

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "publicIp")]
public string? PublicIp { get; set; }

Property Value

string

RemoteId

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

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "remoteId")]
public string? RemoteId { get; set; }

Property Value

string

Secret

The shared secret with the VPN peer

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "secret")]
public string? Secret { get; set; }

Property Value

string

SlaPolicy

[optional] Information about the SLA policy to be applied to the peer

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "slaPolicy")]
public ThirdPartyVpnPeerSlaPolicy? SlaPolicy { get; set; }

Property Value

ThirdPartyVpnPeerSlaPolicy