Netgate TNSR Logo
API docs by Redocly

netgate-ipsec API (24.06)

This YANG module provides mappings of the CLI command structure to the underlying data-model elements for the Netgate router.

Copyright 2016-2023 Rubicon Communications, LLC.

ipsec-config

returns netgate.ipsec.IpsecConfig

returns netgate.ipsec.IpsecConfig

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:ipsec-config": {
    }
}

creates netgate.ipsec.IpsecConfig

creates netgate.ipsec.IpsecConfig

Request Body schema: application/yang-data+json

netgate.ipsec.IpsecConfig to be added to list

object (netgate.ipsec.ipsecconfig.GlobalOptions)

Global IPsec options.

Array of objects (netgate.ipsec.ipsecconfig.Tunnel)

IPsec tunnel configurations

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:global-options": {
    },
  • "netgate-ipsec:tunnel": [
    ]
}

creates or updates netgate.ipsec.IpsecConfig

creates or updates netgate.ipsec.IpsecConfig

Request Body schema: application/yang-data+json

netgate.ipsec.IpsecConfig to be added or updated

object (netgate.ipsec.IpsecConfig)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:ipsec-config": {
    }
}

removes netgate.ipsec.IpsecConfig

removes netgate.ipsec.IpsecConfig

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.ipsec.ipsecconfig.GlobalOptions

Global IPsec options.

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/global-options"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:global-options": {
    }
}

creates netgate.ipsec.ipsecconfig.GlobalOptions

Global IPsec options.

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.GlobalOptions to be added to list

object (netgate.ipsec.ipsecconfig.globaloptions.EapRadius)

EAP-RADIUS plugin settings.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:eap-radius": {
    }
}

creates or updates netgate.ipsec.ipsecconfig.GlobalOptions

Global IPsec options.

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.GlobalOptions to be added or updated

object (netgate.ipsec.ipsecconfig.GlobalOptions)

Global IPsec options.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:global-options": {
    }
}

removes netgate.ipsec.ipsecconfig.GlobalOptions

Global IPsec options.

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/global-options"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.ipsec.ipsecconfig.globaloptions.EapRadius

EAP-RADIUS plugin settings.

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/global-options/eap-radius"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:eap-radius": {
    }
}

creates netgate.ipsec.ipsecconfig.globaloptions.EapRadius

EAP-RADIUS plugin settings.

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.globaloptions.EapRadius to be added to list

netgate-ipsec:server-group
string

The RADIUS server group for IPsec.

object (netgate.ipsec.ipsecconfig.globaloptions.eapradius.Accounting)

RADIUS accounting settings.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:server-group": "string",
  • "netgate-ipsec:accounting": {
    }
}

creates or updates netgate.ipsec.ipsecconfig.globaloptions.EapRadius

EAP-RADIUS plugin settings.

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.globaloptions.EapRadius to be added or updated

object (netgate.ipsec.ipsecconfig.globaloptions.EapRadius)

EAP-RADIUS plugin settings.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:eap-radius": {
    }
}

removes netgate.ipsec.ipsecconfig.globaloptions.EapRadius

EAP-RADIUS plugin settings.

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/global-options/eap-radius"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.ipsec.ipsecconfig.globaloptions.eapradius.Accounting

RADIUS accounting settings.

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/global-options/eap-radius/accounting"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:accounting": {
    }
}

creates netgate.ipsec.ipsecconfig.globaloptions.eapradius.Accounting

RADIUS accounting settings.

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.globaloptions.eapradius.Accounting to be added to list

netgate-ipsec:interim-interval
integer <int32>

Seconds between interim updates.

netgate-ipsec:enabled
boolean

If true, send accounting packets for remote access IPsec tunnels.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:interim-interval": 0,
  • "netgate-ipsec:enabled": true
}

creates or updates netgate.ipsec.ipsecconfig.globaloptions.eapradius.Accounting

RADIUS accounting settings.

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.globaloptions.eapradius.Accounting to be added or updated

object (netgate.ipsec.ipsecconfig.globaloptions.eapradius.Accounting)

RADIUS accounting settings.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:accounting": {
    }
}

removes netgate.ipsec.ipsecconfig.globaloptions.eapradius.Accounting

RADIUS accounting settings.

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/global-options/eap-radius/accounting"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.ipsec.ipsecconfig.Tunnel

IPsec tunnel configurations

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.Tunnel to be added to list

netgate-ipsec:remote-type
string (netgate.ipsec.RemoteType)
Enum: "gateway" "endpoint"
netgate-ipsec:tunnel-type
string (netgate.ipsec.TunnelType)
Value: "interface"
netgate-ipsec:instance
integer <int64>

Numeric identifier of tunnel

netgate-ipsec:tunnel-enable
boolean
Default: false
object (netgate.ipsec.ipsecconfig.tunnel.Crypto)

Tunnel cryptographic settings

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:remote-type": "gateway",
  • "netgate-ipsec:tunnel-type": "interface",
  • "netgate-ipsec:instance": 0,
  • "netgate-ipsec:tunnel-enable": false,
  • "netgate-ipsec:crypto": {
    }
}

returns netgate.ipsec.ipsecconfig.Tunnel

IPsec tunnel configurations

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:tunnel": {
    }
}

creates or updates netgate.ipsec.ipsecconfig.Tunnel

IPsec tunnel configurations

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.Tunnel to be added or updated

object (netgate.ipsec.ipsecconfig.Tunnel)

IPsec tunnel configurations

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:tunnel": {
    }
}

removes netgate.ipsec.ipsecconfig.Tunnel

IPsec tunnel configurations

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.ipsec.ipsecconfig.tunnel.Crypto

Tunnel cryptographic settings

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:crypto": {
    }
}

creates netgate.ipsec.ipsecconfig.tunnel.Crypto

Tunnel cryptographic settings

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.Crypto to be added to list

object (netgate.ipsec.ipsecconfig.tunnel.crypto.Manual)
object (netgate.ipsec.ipsecconfig.tunnel.crypto.Ike)
netgate-ipsec:config-type
string (netgate.ipsec.ConfigType)
Enum: "ike" "manual"

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:manual": {
    },
  • "netgate-ipsec:ike": {
    },
  • "netgate-ipsec:config-type": "ike"
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.Crypto

Tunnel cryptographic settings

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.Crypto to be added or updated

object (netgate.ipsec.ipsecconfig.tunnel.Crypto)

Tunnel cryptographic settings

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:crypto": {
    }
}

removes netgate.ipsec.ipsecconfig.tunnel.Crypto

Tunnel cryptographic settings

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.ipsec.ipsecconfig.tunnel.crypto.Ike

returns netgate.ipsec.ipsecconfig.tunnel.crypto.Ike

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:ike": {
    }
}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.Ike

creates netgate.ipsec.ipsecconfig.tunnel.crypto.Ike

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.Ike to be added to list

netgate-ipsec:role
string (netgate.ipsec.Role)
Enum: "initiator-only" "responder-only" "both"
netgate-ipsec:udp-encapsulation
boolean
Default: false

Force UDP encapsulation.

netgate-ipsec:unique-id-policy
string (netgate.ipsec.IkeUniquePolicyT)
Enum: "never" "no" "keep" "replace"
netgate-ipsec:lifetime
integer <int64>
Default: 14400

Lifetime of IKE SA in seconds.

netgate-ipsec:mobike
string

Enable MOBIKE mobility/multihoming extension.

object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.RemoteAccess)

Configurations for remote access VPN

netgate-ipsec:dpd-poll-interval
integer <int32>

Seconds between DPD peer status checks.

netgate-ipsec:version
integer <int32>
Default: 2
netgate-ipsec:key-renewal
string (netgate.ipsec.KeyRenewalT)
Enum: "reauth" "rekey"
Array of objects (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.ChildSa)

Child (phase 2) SA.

Array of objects (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Identity)

The ID data for one peer in the SA

Array of objects (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Proposals)

Proposed parameters for IKE SA

Array of objects (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Authentication)

The auth data for an IKE peer

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:role": "initiator-only",
  • "netgate-ipsec:udp-encapsulation": false,
  • "netgate-ipsec:unique-id-policy": "never",
  • "netgate-ipsec:lifetime": 14400,
  • "netgate-ipsec:mobike": "string",
  • "netgate-ipsec:remote-access": {
    },
  • "netgate-ipsec:dpd-poll-interval": 0,
  • "netgate-ipsec:version": 2,
  • "netgate-ipsec:key-renewal": "reauth",
  • "netgate-ipsec:child-sa": [
    ],
  • "netgate-ipsec:identity": [
    ],
  • "netgate-ipsec:proposals": [
    ],
  • "netgate-ipsec:authentication": [
    ]
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.Ike

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.Ike

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.Ike to be added or updated

object (netgate.ipsec.ipsecconfig.tunnel.crypto.Ike)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:ike": {
    }
}

removes netgate.ipsec.ipsecconfig.tunnel.crypto.Ike

removes netgate.ipsec.ipsecconfig.tunnel.crypto.Ike

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Authentication

The auth data for an IKE peer

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Authentication to be added to list

Array of objects (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.authentication.Round)

An authentication round for one peer.

netgate-ipsec:peer
string (netgate.ipsec.PeerPositionT)
Enum: "remote" "local"

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:round": [
    ],
  • "netgate-ipsec:peer": "remote"
}

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Authentication

The auth data for an IKE peer

path Parameters
instance
required
integer <int64>

Id of tunnel

peer
required
string

Id of authentication

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/authentication=%7Bpeer%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:authentication": {
    }
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Authentication

The auth data for an IKE peer

path Parameters
instance
required
integer <int64>

Id of tunnel

peer
required
string

Id of authentication

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Authentication to be added or updated

object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Authentication)

The auth data for an IKE peer

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:authentication": {
    }
}

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Authentication

The auth data for an IKE peer

path Parameters
instance
required
integer <int64>

Id of tunnel

peer
required
string

Id of authentication

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/authentication=%7Bpeer%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.authentication.Round

An authentication round for one peer.

path Parameters
instance
required
integer <int64>

Id of tunnel

peer
required
string

Id of authentication

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.authentication.Round to be added to list

netgate-ipsec:certificate
string

Name of a certificate file

netgate-ipsec:number
integer <int32>

Numeric field to order multiple authentications

netgate-ipsec:eap-radius
string

Enable EAP-RADIUS using global settings

netgate-ipsec:psk
string

Pre Shared Key

netgate-ipsec:eap-tls-ca-certificate
string

Name of a CA certificate file

netgate-ipsec:ca-certificate
string

Name of a CA certificate file

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:certificate": "string",
  • "netgate-ipsec:number": 0,
  • "netgate-ipsec:eap-radius": "string",
  • "netgate-ipsec:psk": "string",
  • "netgate-ipsec:eap-tls-ca-certificate": "string",
  • "netgate-ipsec:ca-certificate": "string"
}

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.authentication.Round

An authentication round for one peer.

path Parameters
instance
required
integer <int64>

Id of tunnel

peer
required
string

Id of authentication

number
required
integer <int32>

Id of round

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/authentication=%7Bpeer%7D/round=%7Bnumber%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:round": {
    }
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.authentication.Round

An authentication round for one peer.

path Parameters
instance
required
integer <int64>

Id of tunnel

peer
required
string

Id of authentication

number
required
integer <int32>

Id of round

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.authentication.Round to be added or updated

object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.authentication.Round)

An authentication round for one peer.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:round": {
    }
}

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.authentication.Round

An authentication round for one peer.

path Parameters
instance
required
integer <int64>

Id of tunnel

peer
required
string

Id of authentication

number
required
integer <int32>

Id of round

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/authentication=%7Bpeer%7D/round=%7Bnumber%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.ChildSa

Child (phase 2) SA.

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.ChildSa to be added to list

Array of objects (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal)
netgate-ipsec:mode
string (netgate.ipsec.Mode)
Value: "tunnel"
netgate-ipsec:protocol
string (netgate.ipsec.Protocol)
Value: "esp"
netgate-ipsec:lifetime
integer <int64>
Default: 3600

The length of time in seconds until the child SA is no longer valid.

netgate-ipsec:name
string

Name of the child SA

Array of objects (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.TrafficSelector)

Specification of traffic which should be routed through an IPsec tunnel.

netgate-ipsec:replay-window
integer <int64>

Number of packets in replay window. Currently, 64 packets is the only supported value. Setting anything here will enable a 64 packet replay window.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:proposal": [
    ],
  • "netgate-ipsec:mode": "tunnel",
  • "netgate-ipsec:protocol": "esp",
  • "netgate-ipsec:lifetime": 3600,
  • "netgate-ipsec:name": "string",
  • "netgate-ipsec:traffic-selector": [
    ],
  • "netgate-ipsec:replay-window": 0
}

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.ChildSa

Child (phase 2) SA.

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of child-sa

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/child-sa=%7Bname%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:child-sa": {
    }
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.ChildSa

Child (phase 2) SA.

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of child-sa

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.ChildSa to be added or updated

object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.ChildSa)

Child (phase 2) SA.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:child-sa": {
    }
}

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.ChildSa

Child (phase 2) SA.

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of child-sa

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/child-sa=%7Bname%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal

creates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of child-sa

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal to be added to list

netgate-ipsec:name
string
netgate-ipsec:sequence-number
string (netgate.ipsec.IpsecSeqNumberTypeT)
Enum: "esn" "noesn"
netgate-ipsec:encryption-algorithm
string (netgate.ipsec.DataplaneEspEncryptionAlgorithmT)
Enum: "aes128gcm16" "aes192gcm16" "aes256gcm16" "chacha20poly1305" "aes128" "aes192" "aes256"
netgate-ipsec:dh-group
string (netgate.ipsec.NgDiffieHellmanGroupT)
Enum: "modp768" "modp1024" "modp1536" "modp2048" "modp3072" "modp4096" "modp6144" "modp8192" "ecp256" "ecp384" "ecp521" "modp1024s160" "modp2048s224" "modp2048s256" "curve25519"
netgate-ipsec:integrity-algorithm
string (netgate.ipsec.DataplaneEspIntegrityAlgorithmT)
Enum: "sha1" "sha256" "sha384" "sha512"

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:name": "string",
  • "netgate-ipsec:sequence-number": "esn",
  • "netgate-ipsec:encryption-algorithm": "aes128gcm16",
  • "netgate-ipsec:dh-group": "modp768",
  • "netgate-ipsec:integrity-algorithm": "sha1"
}

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of child-sa

proposal-name
required
string

Id of proposal

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/child-sa=%7Bname%7D/proposal=%7Bproposal-name%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:proposal": {
    }
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of child-sa

proposal-name
required
string

Id of proposal

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal to be added or updated

object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:proposal": {
    }
}

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of child-sa

proposal-name
required
string

Id of proposal

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/child-sa=%7Bname%7D/proposal=%7Bproposal-name%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.TrafficSelector

Specification of traffic which should be routed through an IPsec tunnel.

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of child-sa

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.TrafficSelector to be added to list

netgate-ipsec:ts-number
integer <int32>

Numeric identifier for traffic selector.

netgate-ipsec:local
string

Local IPv4 or IPv6 network prefix.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:ts-number": 0,
  • "netgate-ipsec:local": "string"
}

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.TrafficSelector

Specification of traffic which should be routed through an IPsec tunnel.

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of child-sa

ts-number
required
integer <int32>

Id of traffic-selector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/child-sa=%7Bname%7D/traffic-selector=%7Bts-number%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:traffic-selector": {
    }
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.TrafficSelector

Specification of traffic which should be routed through an IPsec tunnel.

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of child-sa

ts-number
required
integer <int32>

Id of traffic-selector

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.TrafficSelector to be added or updated

object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.TrafficSelector)

Specification of traffic which should be routed through an IPsec tunnel.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:traffic-selector": {
    }
}

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.TrafficSelector

Specification of traffic which should be routed through an IPsec tunnel.

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of child-sa

ts-number
required
integer <int32>

Id of traffic-selector

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/child-sa=%7Bname%7D/traffic-selector=%7Bts-number%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Identity

The ID data for one peer in the SA

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Identity to be added to list

netgate-ipsec:type
string (netgate.ipsec.IkeIdentityTypeT)
Enum: "none" "email" "fqdn" "dn" "key-id" "address"
netgate-ipsec:value
string

The ID of the peer.

netgate-ipsec:peer
string (netgate.ipsec.PeerPositionT)
Enum: "remote" "local"

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:type": "none",
  • "netgate-ipsec:value": "string",
  • "netgate-ipsec:peer": "remote"
}

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Identity

The ID data for one peer in the SA

path Parameters
instance
required
integer <int64>

Id of tunnel

peer
required
string

Id of identity

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/identity=%7Bpeer%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:identity": {
    }
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Identity

The ID data for one peer in the SA

path Parameters
instance
required
integer <int64>

Id of tunnel

peer
required
string

Id of identity

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Identity to be added or updated

object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Identity)

The ID data for one peer in the SA

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:identity": {
    }
}

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Identity

The ID data for one peer in the SA

path Parameters
instance
required
integer <int64>

Id of tunnel

peer
required
string

Id of identity

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/identity=%7Bpeer%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Proposals

Proposed parameters for IKE SA

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Proposals to be added to list

netgate-ipsec:name
string

IKE proposal name.

netgate-ipsec:encryption-algorithm
string (netgate.ipsec.NgIkeEncryptionAlgorithmT)
Enum: "aes128" "aes192" "aes256" "aes128ctr" "aes192ctr" "aes256ctr" "aes128ccm8" "aes192ccm8" "aes256ccm8" "aes128ccm12" "aes192ccm12" "aes256ccm12" "aes128ccm16" "aes192ccm16" "aes256ccm16" "aes128gcm8" "aes192gcm8" "aes256gcm8" "aes128gcm12" "aes192gcm12" "aes256gcm12" "aes128gcm16" "aes192gcm16" "aes256gcm16" "camellia128" "camellia192" "camellia256" "camellia128ctr" "camellia192ctr" "camellia256ctr" "camellia128ccm8" "camellia192ccm8" "camellia256ccm8" "camellia128ccm12" "camellia192ccm12" "camellia256ccm12" "camellia128ccm16" "camellia192ccm16" "camellia256ccm16" "chacha20poly1305"
netgate-ipsec:prf
string (netgate.ipsec.NgPseudoRandomFunctionT)
Enum: "prfsha1" "prfsha256" "prfsha384" "prfsha512"
netgate-ipsec:dh-group
string (netgate.ipsec.NgDiffieHellmanGroupT)
Enum: "modp768" "modp1024" "modp1536" "modp2048" "modp3072" "modp4096" "modp6144" "modp8192" "ecp256" "ecp384" "ecp521" "modp1024s160" "modp2048s224" "modp2048s256" "curve25519"
netgate-ipsec:integrity-algorithm
string (netgate.ipsec.NgIkeIntegrityAlgorithmT)
Enum: "sha1" "aesxcbc" "aescmac" "sha256" "sha384" "sha512"

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:name": "string",
  • "netgate-ipsec:encryption-algorithm": "aes128",
  • "netgate-ipsec:prf": "prfsha1",
  • "netgate-ipsec:dh-group": "modp768",
  • "netgate-ipsec:integrity-algorithm": "sha1"
}

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Proposals

Proposed parameters for IKE SA

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of proposals

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/proposals=%7Bname%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:proposals": {
    }
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Proposals

Proposed parameters for IKE SA

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of proposals

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Proposals to be added or updated

object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Proposals)

Proposed parameters for IKE SA

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:proposals": {
    }
}

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Proposals

Proposed parameters for IKE SA

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of proposals

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/proposals=%7Bname%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.RemoteAccess

Configurations for remote access VPN

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:remote-access": {
    }
}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.RemoteAccess

Configurations for remote access VPN

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.RemoteAccess to be added to list

object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.Dns)

DNS configurations.

object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.AddressPools)

Pools for assigning remote client addresses.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:dns": {
    },
  • "netgate-ipsec:address-pools": {
    }
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.RemoteAccess

Configurations for remote access VPN

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.RemoteAccess to be added or updated

object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.RemoteAccess)

Configurations for remote access VPN

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:remote-access": {
    }
}

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.RemoteAccess

Configurations for remote access VPN

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.AddressPools

Pools for assigning remote client addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access/address-pools"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:address-pools": {
    }
}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.AddressPools

Pools for assigning remote client addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.AddressPools to be added to list

netgate-ipsec:radius
string

Enable virtual IP address allocation by radius server.

object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv4Range)

Range of client virtual IPv4 addresses.

object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv6Range)

Range of client virtual IPv6 addresses.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:radius": "string",
  • "netgate-ipsec:ipv4-range": {
    },
  • "netgate-ipsec:ipv6-range": {
    }
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.AddressPools

Pools for assigning remote client addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.AddressPools to be added or updated

object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.AddressPools)

Pools for assigning remote client addresses.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:address-pools": {
    }
}

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.AddressPools

Pools for assigning remote client addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access/address-pools"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv4Range

Range of client virtual IPv4 addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access/address-pools/ipv4-range"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:ipv4-range": {
    }
}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv4Range

Range of client virtual IPv4 addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv4Range to be added to list

netgate-ipsec:first-address
string

First IPv4 address in range.

netgate-ipsec:last-address
string

Last IPv4 address in range.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:first-address": "string",
  • "netgate-ipsec:last-address": "string"
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv4Range

Range of client virtual IPv4 addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv4Range to be added or updated

object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv4Range)

Range of client virtual IPv4 addresses.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:ipv4-range": {
    }
}

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv4Range

Range of client virtual IPv4 addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access/address-pools/ipv4-range"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv6Range

Range of client virtual IPv6 addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access/address-pools/ipv6-range"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:ipv6-range": {
    }
}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv6Range

Range of client virtual IPv6 addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv6Range to be added to list

netgate-ipsec:first-address
string

First IPv6 address in range.

netgate-ipsec:last-address
string

Last IPv6 address in range.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:first-address": "string",
  • "netgate-ipsec:last-address": "string"
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv6Range

Range of client virtual IPv6 addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv6Range to be added or updated

object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv6Range)

Range of client virtual IPv6 addresses.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:ipv6-range": {
    }
}

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv6Range

Range of client virtual IPv6 addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access/address-pools/ipv6-range"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.Dns

DNS configurations.

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access/dns"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:dns": {
    }
}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.Dns

DNS configurations.

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.Dns to be added to list

Array of objects (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.dns.Resolver)

Address of DNS resolvers to be used by clients.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:resolver": [
    ]
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.Dns

DNS configurations.

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.Dns to be added or updated

object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.Dns)

DNS configurations.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:dns": {
    }
}

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.Dns

DNS configurations.

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access/dns"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.dns.Resolver

Address of DNS resolvers to be used by clients.

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.dns.Resolver to be added to list

netgate-ipsec:res-number
integer <int32>

Numeric identifier of resolver.

netgate-ipsec:address
string

IPv4 or IPv6 address of resolver.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:res-number": 0,
  • "netgate-ipsec:address": "string"
}

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.dns.Resolver

Address of DNS resolvers to be used by clients.

path Parameters
instance
required
integer <int64>

Id of tunnel

res-number
required
integer <int32>

Id of resolver

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access/dns/resolver=%7Bres-number%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:resolver": {
    }
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.dns.Resolver

Address of DNS resolvers to be used by clients.

path Parameters
instance
required
integer <int64>

Id of tunnel

res-number
required
integer <int32>

Id of resolver

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.dns.Resolver to be added or updated

object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.dns.Resolver)

Address of DNS resolvers to be used by clients.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:resolver": {
    }
}

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.dns.Resolver

Address of DNS resolvers to be used by clients.

path Parameters
instance
required
integer <int64>

Id of tunnel

res-number
required
integer <int32>

Id of resolver

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access/dns/resolver=%7Bres-number%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.ipsec.ipsecconfig.tunnel.crypto.Manual

returns netgate.ipsec.ipsecconfig.tunnel.crypto.Manual

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/manual"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:manual": {
    }
}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.Manual

creates netgate.ipsec.ipsecconfig.tunnel.crypto.Manual

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.Manual to be added to list

object (netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption)
netgate-ipsec:protocol
string (netgate.ipsec.Protocol)
Value: "esp"
object (netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:encryption": {
    },
  • "netgate-ipsec:protocol": "esp",
  • "netgate-ipsec:integrity": {
    }
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.Manual

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.Manual

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.Manual to be added or updated

object (netgate.ipsec.ipsecconfig.tunnel.crypto.Manual)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:manual": {
    }
}

removes netgate.ipsec.ipsecconfig.tunnel.crypto.Manual

removes netgate.ipsec.ipsecconfig.tunnel.crypto.Manual

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/manual"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption

returns netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/manual/encryption"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:encryption": {
    }
}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption

creates netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption to be added to list

netgate-ipsec:key
string
netgate-ipsec:algorithm
string (netgate.ipsec.DataplaneEspEncryptionAlgorithmT)
Enum: "aes128gcm16" "aes192gcm16" "aes256gcm16" "chacha20poly1305" "aes128" "aes192" "aes256"

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:key": "string",
  • "netgate-ipsec:algorithm": "aes128gcm16"
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption to be added or updated

object (netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:encryption": {
    }
}

removes netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption

removes netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/manual/encryption"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity

returns netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/manual/integrity"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:integrity": {
    }
}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity

creates netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity to be added to list

netgate-ipsec:key
string
netgate-ipsec:algorithm
string (netgate.ipsec.DataplaneEspIntegrityAlgorithmT)
Enum: "sha1" "sha256" "sha384" "sha512"

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:key": "string",
  • "netgate-ipsec:algorithm": "sha1"
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity to be added or updated

object (netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:integrity": {
    }
}

removes netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity

removes netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/manual/integrity"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

ipsec-state

returns netgate.ipsec.IpsecState

Operational state data for IPsec.

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-state"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:ipsec-state": {
    }
}

returns netgate.ipsec.ipsecstate.Tunnel

IPsec tunnel

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel=%7Binstance%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:tunnel": {
    }
}

returns netgate.ipsec.ipsecstate.tunnel.IkeSa

IKE SA

path Parameters
instance
required
integer <int64>

Id of tunnel

ike-unique-id
required
integer <int64>

Id of ike-sa

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel=%7Binstance%7D/ike-sa=%7Bike-unique-id%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:ike-sa": {
    }
}

returns netgate.ipsec.ipsecstate.tunnel.ikesa.ChildSa

Child SA

path Parameters
instance
required
integer <int64>

Id of tunnel

ike-unique-id
required
integer <int64>

Id of ike-sa

name
required
string

Id of child-sa

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel=%7Binstance%7D/ike-sa=%7Bike-unique-id%7D/child-sa=%7Bname%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:child-sa": {
    }
}

returns netgate.ipsec.ipsecstate.tunnel.ikesa.childsa.Sa

Child SA instance

path Parameters
instance
required
integer <int64>

Id of tunnel

ike-unique-id
required
integer <int64>

Id of ike-sa

name
required
string

Id of child-sa

unique-id
required
integer <int64>

Id of sa

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel=%7Binstance%7D/ike-sa=%7Bike-unique-id%7D/child-sa=%7Bname%7D/sa=%7Bunique-id%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:sa": {
    }
}

returns netgate.ipsec.ipsecstate.tunnel.ikesa.childsa.sa.Crypto

Cryptographic Parameters

path Parameters
instance
required
integer <int64>

Id of tunnel

ike-unique-id
required
integer <int64>

Id of ike-sa

name
required
string

Id of child-sa

unique-id
required
integer <int64>

Id of sa

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel=%7Binstance%7D/ike-sa=%7Bike-unique-id%7D/child-sa=%7Bname%7D/sa=%7Bunique-id%7D/crypto"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:crypto": {
    }
}

returns netgate.ipsec.ipsecstate.tunnel.ikesa.childsa.sa.Status

SA status

path Parameters
instance
required
integer <int64>

Id of tunnel

ike-unique-id
required
integer <int64>

Id of ike-sa

name
required
string

Id of child-sa

unique-id
required
integer <int64>

Id of sa

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel=%7Binstance%7D/ike-sa=%7Bike-unique-id%7D/child-sa=%7Bname%7D/sa=%7Bunique-id%7D/status"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:status": {
    }
}

returns netgate.ipsec.ipsecstate.tunnel.ikesa.Crypto

Cryptographic Parameters

path Parameters
instance
required
integer <int64>

Id of tunnel

ike-unique-id
required
integer <int64>

Id of ike-sa

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel=%7Binstance%7D/ike-sa=%7Bike-unique-id%7D/crypto"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:crypto": {
    }
}

returns netgate.ipsec.ipsecstate.tunnel.ikesa.Status

SA status

path Parameters
instance
required
integer <int64>

Id of tunnel

ike-unique-id
required
integer <int64>

Id of ike-sa

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel=%7Binstance%7D/ike-sa=%7Bike-unique-id%7D/status"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-ipsec:status": {
    }
}

ike-control

operates on netgate.ipsec.IkeControl

operates on netgate.ipsec.IkeControl

Request Body schema: application/yang-data+json
object (netgate.ipsec.ikecontrol.Input)

Responses

Request samples

Content type
application/yang-data+json
{
  • "input": {
    }
}

Response samples

Content type
application/yang-data+json
{
  • "output": {
    }
}

ike-coredump

operates on netgate.ipsec.IkeCoredump

operates on netgate.ipsec.IkeCoredump

Request Body schema: application/yang-data+json
object (netgate.ipsec.ikecoredump.Input)

Responses

Request samples

Content type
application/yang-data+json
{
  • "input": {
    }
}

Response samples

Content type
application/yang-data+json
{
  • "output": {
    }
}