ipsecSite

ipsecSite
ipsecSite

NSX Edge IPsec Site configuration details.

JSON Example
{
    "psk": "string",
    "localId": "string",
    "enablePfs": false,
    "authenticationMode": "string",
    "peerSubnets": {
        "subnets": [
            "string"
        ]
    },
    "dhGroup": "string",
    "siteId": "string",
    "description": "string",
    "peerIp": "string",
    "name": "string",
    "certificate": "string",
    "localIp": "string",
    "encryptionAlgorithm": "string",
    "enabled": false,
    "mtu": 0,
    "extension": "string",
    "peerId": "string",
    "localSubnets": {
        "subnets": [
            "string"
        ]
    }
}
string
psk
Optional
Constraints: minLength: 0 maxLength: 128

Pre Shared Key for the IPsec Site. Required if Site peerIp is not 'any'. Global PSK is used when Authentication mode is PSK and Site peerIp is 'any'.

string
localId
Optional
Constraints: minLength: 0 maxLength: 255

Local ID of the IPsec Site. Defaults to the local IP.

boolean
enablePfs
Optional

Enable/disable Perfect Forward Secrecy. Default is true.

string
authenticationMode
Optional

Authentication mode for the IPsec Site. Valid values are psk and x.509, with psk as default.

peerSubnets
Optional

peerSubnets

string
dhGroup
Optional

Diffie-Hellman algorithm group. Defaults to DH14 for FIPS enabled NSX Edge. DH2 and DH5 are not supported when FIPS is enabled on NSX Edge. Valid values are DH2, DH5, DH14, DH15, DH16.

string
siteId
Optional

ID of the IPsec Site configuration provided by NSX Manager.

string
description
Optional
Constraints: minLength: 0 maxLength: 8192

Description of the IPsec Site.

string
peerIp
Optional
Constraints: minLength: 0 maxLength: 255

IP (IPv4) address or FQDN of the Peer. Can also be specified as 'any'. Required.

string
name
Optional
Constraints: minLength: 0 maxLength: 255

Name of the IPsec Site.

string
certificate
Optional
Constraints: minLength: 0 maxLength: 255

certificate

string
localIp
Optional
Constraints: minLength: 0 maxLength: 255

Local IP of the IPsec Site. Should be one of the IP addresses configured on the uplink interfaces of the NSX Edge. Required.

string
encryptionAlgorithm
Optional

IPsec encryption algorithm with default as aes256. Valid values are 'aes', 'aes256', '3des', 'aes-gcm'.

boolean
enabled
Optional

Enable/disable IPsec Site.

integer As int32 As int32
mtu
Optional

MTU for the IPsec site. Defaults to the mtu of the NSX Edge vnic specified by the localIp. Optional.

string
extension
Optional
Constraints: minLength: 0 maxLength: 1024

extension

string
peerId
Optional
Constraints: minLength: 0 maxLength: 255

Peer ID. Should be unique for all IPsec Site's configured for an NSX Edge.

localSubnets
Optional

localSubnets

Property Of