Netgate TNSR Logo
API docs by Redocly

netgate-system API (25.02)

This YANG module provides a Netgate-defined data-model for SYSTEM data.

Copyright 2018-2024 Rubicon Communications, LLC.

system

returns netgate.system.System

System group configuration.

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system"

	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-system:system": {
    }
}

creates netgate.system.System

System group configuration.

Request Body schema: application/yang-data+json

netgate.system.System to be added to list

object (netgate.system.system.Auth)
object (netgate.system.system.Kernel)
netgate-system:contact
string

The administrator contact information for the system. A server implementation MAY map this leaf to the sysContact MIB object. Such an implementation needs to use some mechanism to handle the differences in size and characters allowed between this leaf and sysContact. The definition of such a mechanism is outside the scope of this document. REF:Optional[RFC 3418: Management Information Base (MIB) for the Simple Network Management Protocol (SNMP) SNMPv2-MIB.sysContact]

netgate-system:login-banner
string

A banner message to be displayed at user login, as part of update-motd.

netgate-system:name
string

The name of the host. This name can be a single domain label or the fully qualified domain name of the host.

netgate-system:description
string

A textual description of the entity. This value should include the full name and version identification of the system's hardware type, software operating-system, and networking software. It is mandatory that this only contain printable ASCII characters.

netgate-system:location
string

The system location.

      A server implementation MAY map this leaf to the sysLocation
      MIB object.  Such an implementation needs to use some
      mechanism to handle the differences in size and characters
      allowed between this leaf and sysLocation.  The definition
      of such a mechanism is outside the scope of this document. REF:Optional[RFC 3418: Management Information Base (MIB) for the
      Simple Network Management Protocol (SNMP)
      SNMPv2-MIB.sysLocation]
Array of objects (netgate.system.system.DnsResolver)

Configuration of the DNS resolver. REF:Optional[RFC 7317: A YANG Data Model for System Management]

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:auth": {
    },
  • "netgate-system:kernel": {
    },
  • "netgate-system:contact": "string",
  • "netgate-system:login-banner": "string",
  • "netgate-system:name": "string",
  • "netgate-system:description": "string",
  • "netgate-system:location": "string",
  • "netgate-system:dns-resolver": [
    ]
}

creates or updates netgate.system.System

System group configuration.

Request Body schema: application/yang-data+json

netgate.system.System to be added or updated

object (netgate.system.System)

System group configuration.

Responses

Request samples

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

removes netgate.system.System

System group configuration.

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system"

	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.system.system.Auth

returns netgate.system.system.Auth

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/auth"

	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-system:auth": {
    }
}

creates netgate.system.system.Auth

creates netgate.system.system.Auth

Request Body schema: application/yang-data+json

netgate.system.system.Auth to be added to list

object (netgate.system.system.auth.ServerGroups)

Server groups to use for authentication methods.

Array of objects (netgate.system.system.auth.User)

allowed users of the system

object (netgate.system.system.auth.AuthenticationMethods)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:server-groups": {
    },
  • "netgate-system:user": [
    ],
  • "netgate-system:authentication-methods": {
    }
}

creates or updates netgate.system.system.Auth

creates or updates netgate.system.system.Auth

Request Body schema: application/yang-data+json

netgate.system.system.Auth to be added or updated

object (netgate.system.system.Auth)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:auth": {
    }
}

removes netgate.system.system.Auth

removes netgate.system.system.Auth

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/auth"

	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.system.system.auth.AuthenticationMethods

returns netgate.system.system.auth.AuthenticationMethods

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/auth/authentication-methods"

	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-system:authentication-methods": {
    }
}

creates netgate.system.system.auth.AuthenticationMethods

creates netgate.system.system.auth.AuthenticationMethods

Request Body schema: application/yang-data+json

netgate.system.system.auth.AuthenticationMethods to be added to list

object (netgate.system.system.auth.authenticationmethods.Radius)

Radius server-group to use.

object (netgate.system.system.auth.authenticationmethods.Ldap)

LDAP server-group to use.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:radius": {
    },
  • "netgate-system:ldap": {
    }
}

creates or updates netgate.system.system.auth.AuthenticationMethods

creates or updates netgate.system.system.auth.AuthenticationMethods

Request Body schema: application/yang-data+json

netgate.system.system.auth.AuthenticationMethods to be added or updated

object (netgate.system.system.auth.AuthenticationMethods)

Responses

Request samples

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

removes netgate.system.system.auth.AuthenticationMethods

removes netgate.system.system.auth.AuthenticationMethods

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/auth/authentication-methods"

	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.system.system.auth.authenticationmethods.Ldap

LDAP server-group to use.

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/auth/authentication-methods/ldap"

	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-system:ldap": {
    }
}

creates netgate.system.system.auth.authenticationmethods.Ldap

LDAP server-group to use.

Request Body schema: application/yang-data+json

netgate.system.system.auth.authenticationmethods.Ldap to be added to list

netgate-system:server-group
string

Responses

Request samples

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

creates or updates netgate.system.system.auth.authenticationmethods.Ldap

LDAP server-group to use.

Request Body schema: application/yang-data+json

netgate.system.system.auth.authenticationmethods.Ldap to be added or updated

object (netgate.system.system.auth.authenticationmethods.Ldap)

LDAP server-group to use.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:ldap": {
    }
}

removes netgate.system.system.auth.authenticationmethods.Ldap

LDAP server-group to use.

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/auth/authentication-methods/ldap"

	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.system.system.auth.authenticationmethods.Radius

Radius server-group to use.

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/auth/authentication-methods/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-system:radius": {
    }
}

creates netgate.system.system.auth.authenticationmethods.Radius

Radius server-group to use.

Request Body schema: application/yang-data+json

netgate.system.system.auth.authenticationmethods.Radius to be added to list

netgate-system:server-group
string

Responses

Request samples

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

creates or updates netgate.system.system.auth.authenticationmethods.Radius

Radius server-group to use.

Request Body schema: application/yang-data+json

netgate.system.system.auth.authenticationmethods.Radius to be added or updated

object (netgate.system.system.auth.authenticationmethods.Radius)

Radius server-group to use.

Responses

Request samples

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

removes netgate.system.system.auth.authenticationmethods.Radius

Radius server-group to use.

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/auth/authentication-methods/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.system.system.auth.ServerGroups

Server groups to use for authentication methods.

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/auth/server-groups"

	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-system:server-groups": {
    }
}

creates netgate.system.system.auth.ServerGroups

Server groups to use for authentication methods.

Request Body schema: application/yang-data+json

netgate.system.system.auth.ServerGroups to be added to list

Array of objects (netgate.system.system.auth.servergroups.ServerGroup)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:server-group": [
    ]
}

creates or updates netgate.system.system.auth.ServerGroups

Server groups to use for authentication methods.

Request Body schema: application/yang-data+json

netgate.system.system.auth.ServerGroups to be added or updated

object (netgate.system.system.auth.ServerGroups)

Server groups to use for authentication methods.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:server-groups": {
    }
}

removes netgate.system.system.auth.ServerGroups

Server groups to use for authentication methods.

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/auth/server-groups"

	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.system.system.auth.servergroups.ServerGroup

creates netgate.system.system.auth.servergroups.ServerGroup

Request Body schema: application/yang-data+json

netgate.system.system.auth.servergroups.ServerGroup to be added to list

netgate-system:name
string

Server group name.

netgate-system:type
string (netgate.system.AaaServerType)
Enum: "radius" "ldap"
object (netgate.system.system.auth.servergroups.servergroup.Servers)

Servers in this group.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:name": "string",
  • "netgate-system:type": "radius",
  • "netgate-system:servers": {
    }
}

returns netgate.system.system.auth.servergroups.ServerGroup

returns netgate.system.system.auth.servergroups.ServerGroup

path Parameters
name
required
string

Id of server-group

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/auth/server-groups/server-group=%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-system:server-group": {
    }
}

creates or updates netgate.system.system.auth.servergroups.ServerGroup

creates or updates netgate.system.system.auth.servergroups.ServerGroup

path Parameters
name
required
string

Id of server-group

Request Body schema: application/yang-data+json

netgate.system.system.auth.servergroups.ServerGroup to be added or updated

object (netgate.system.system.auth.servergroups.ServerGroup)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:server-group": {
    }
}

removes netgate.system.system.auth.servergroups.ServerGroup

removes netgate.system.system.auth.servergroups.ServerGroup

path Parameters
name
required
string

Id of server-group

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/auth/server-groups/server-group=%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.system.system.auth.servergroups.servergroup.Servers

Servers in this group.

path Parameters
name
required
string

Id of server-group

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/auth/server-groups/server-group=%7Bname%7D/servers"

	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-system:servers": {
    }
}

creates netgate.system.system.auth.servergroups.servergroup.Servers

Servers in this group.

path Parameters
name
required
string

Id of server-group

Request Body schema: application/yang-data+json

netgate.system.system.auth.servergroups.servergroup.Servers to be added to list

Array of objects (netgate.system.system.auth.servergroups.servergroup.servers.serverlisttype.subset.Server)

Configured auth server of the type used by this group.

netgate-system:all-servers
string

All configured servers for the auth type used by this group.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:server": [
    ],
  • "netgate-system:all-servers": "string"
}

creates or updates netgate.system.system.auth.servergroups.servergroup.Servers

Servers in this group.

path Parameters
name
required
string

Id of server-group

Request Body schema: application/yang-data+json

netgate.system.system.auth.servergroups.servergroup.Servers to be added or updated

object (netgate.system.system.auth.servergroups.servergroup.Servers)

Servers in this group.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:servers": {
    }
}

removes netgate.system.system.auth.servergroups.servergroup.Servers

Servers in this group.

path Parameters
name
required
string

Id of server-group

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/auth/server-groups/server-group=%7Bname%7D/servers"

	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.system.system.auth.servergroups.servergroup.servers.serverlisttype.subset.Server

Configured auth server of the type used by this group.

path Parameters
name
required
string

Id of server-group

Request Body schema: application/yang-data+json

netgate.system.system.auth.servergroups.servergroup.servers.serverlisttype.subset.Server to be added to list

netgate-system:radius-server
string

Radius server name.

netgate-system:priority
integer <int32>

Server priority (lowest to highest).

netgate-system:ldap-server
string

LDAP server name.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:radius-server": "string",
  • "netgate-system:priority": 0,
  • "netgate-system:ldap-server": "string"
}

returns netgate.system.system.auth.servergroups.servergroup.servers.serverlisttype.subset.Server

Configured auth server of the type used by this group.

path Parameters
name
required
string

Id of server-group

priority
required
integer <int32>

Id of server

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/auth/server-groups/server-group=%7Bname%7D/servers/server=%7Bpriority%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-system:server": {
    }
}

creates or updates netgate.system.system.auth.servergroups.servergroup.servers.serverlisttype.subset.Server

Configured auth server of the type used by this group.

path Parameters
name
required
string

Id of server-group

priority
required
integer <int32>

Id of server

Request Body schema: application/yang-data+json

netgate.system.system.auth.servergroups.servergroup.servers.serverlisttype.subset.Server to be added or updated

object (netgate.system.system.auth.servergroups.servergroup.servers.serverlisttype.subset.Server)

Configured auth server of the type used by this group.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:server": {
    }
}

removes netgate.system.system.auth.servergroups.servergroup.servers.serverlisttype.subset.Server

Configured auth server of the type used by this group.

path Parameters
name
required
string

Id of server-group

priority
required
integer <int32>

Id of server

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/auth/server-groups/server-group=%7Bname%7D/servers/server=%7Bpriority%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.system.system.auth.User

allowed users of the system

Request Body schema: application/yang-data+json

netgate.system.system.auth.User to be added to list

netgate-system:user-name
string

user name identifying user

netgate-system:user-password
string

The hash of the users password.

Array of objects (netgate.system.system.auth.user.UserKeys)

A list of user's public keys.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:user-name": "string",
  • "netgate-system:user-password": "string",
  • "netgate-system:user-keys": [
    ]
}

returns netgate.system.system.auth.User

allowed users of the system

path Parameters
user-name
required
string

Id of user

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/auth/user=%7Buser-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-system:user": {
    }
}

creates or updates netgate.system.system.auth.User

allowed users of the system

path Parameters
user-name
required
string

Id of user

Request Body schema: application/yang-data+json

netgate.system.system.auth.User to be added or updated

object (netgate.system.system.auth.User)

allowed users of the system

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:user": {
    }
}

removes netgate.system.system.auth.User

allowed users of the system

path Parameters
user-name
required
string

Id of user

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/auth/user=%7Buser-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.system.system.auth.user.UserKeys

A list of user's public keys.

path Parameters
user-name
required
string

Id of user

Request Body schema: application/yang-data+json

netgate.system.system.auth.user.UserKeys to be added to list

netgate-system:key-name
string

A unique identifier for this key.

netgate-system:key-data
string

ASCII encoded data for user key.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:key-name": "string",
  • "netgate-system:key-data": "string"
}

returns netgate.system.system.auth.user.UserKeys

A list of user's public keys.

path Parameters
user-name
required
string

Id of user

key-name
required
string

Id of user-keys

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/auth/user=%7Buser-name%7D/user-keys=%7Bkey-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-system:user-keys": {
    }
}

creates or updates netgate.system.system.auth.user.UserKeys

A list of user's public keys.

path Parameters
user-name
required
string

Id of user

key-name
required
string

Id of user-keys

Request Body schema: application/yang-data+json

netgate.system.system.auth.user.UserKeys to be added or updated

object (netgate.system.system.auth.user.UserKeys)

A list of user's public keys.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:user-keys": {
    }
}

removes netgate.system.system.auth.user.UserKeys

A list of user's public keys.

path Parameters
user-name
required
string

Id of user

key-name
required
string

Id of user-keys

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/auth/user=%7Buser-name%7D/user-keys=%7Bkey-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.system.system.DnsResolver

Configuration of the DNS resolver.

Request Body schema: application/yang-data+json

netgate.system.system.DnsResolver to be added to list

netgate-system:namespace
string (netgate.common.NetworkNamespace)
Enum: "host" "dataplane"
Array of objects (netgate.system.system.dnsresolver.Server)

List of the DNS servers that the resolver should query.

      When the resolver is invoked by a calling application, it
      sends the query to the first name server in this list.  If
      no response has been received within 'timeout' seconds,
      the resolver continues with the next server in the list.
      If no response is received from any server, the resolver
      continues with the first server again.  When the resolver
      has traversed the list 'attempts' times without receiving
      any response, it gives up and returns an error to the
      calling application.

      Implementations MAY limit the number of entries in this
      list.
netgate-system:search
Array of strings

An ordered list of domains to search when resolving a host name.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:namespace": "host",
  • "netgate-system:server": [
    ],
  • "netgate-system:search": [
    ]
}

returns netgate.system.system.DnsResolver

Configuration of the DNS resolver.

path Parameters
namespace
required
string

Id of dns-resolver

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/dns-resolver=%7Bnamespace%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-system:dns-resolver": {
    }
}

creates or updates netgate.system.system.DnsResolver

Configuration of the DNS resolver.

path Parameters
namespace
required
string

Id of dns-resolver

Request Body schema: application/yang-data+json

netgate.system.system.DnsResolver to be added or updated

object (netgate.system.system.DnsResolver)

Configuration of the DNS resolver. REF:Optional[RFC 7317: A YANG Data Model for System Management]

Responses

Request samples

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

removes netgate.system.system.DnsResolver

Configuration of the DNS resolver.

path Parameters
namespace
required
string

Id of dns-resolver

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/dns-resolver=%7Bnamespace%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.system.system.dnsresolver.Server

List of the DNS servers that the resolver should query.

      When the resolver is invoked by a calling application, it
      sends the query to the first name server in this list.  If
      no response has been received within 'timeout' seconds,
      the resolver continues with the next server in the list.
      If no response is received from any server, the resolver
      continues with the first server again.  When the resolver
      has traversed the list 'attempts' times without receiving
      any response, it gives up and returns an error to the
      calling application.

      Implementations MAY limit the number of entries in this
      list.
path Parameters
namespace
required
string

Id of dns-resolver

Request Body schema: application/yang-data+json

netgate.system.system.dnsresolver.Server to be added to list

netgate-system:name
string

An arbitrary name for the DNS server.

object (netgate.system.system.dnsresolver.server.transport.udpandtcp.UdpAndTcp)

Contains UDP- and TCP-specific configuration parameters for DNS. REF:Optional[RFC 1035: Domain Names - Implementation and Specification RFC 5966: DNS Transport over TCP - Implementation Requirements]

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:name": "string",
  • "netgate-system:udp-and-tcp": {
    }
}

returns netgate.system.system.dnsresolver.Server

List of the DNS servers that the resolver should query.

      When the resolver is invoked by a calling application, it
      sends the query to the first name server in this list.  If
      no response has been received within 'timeout' seconds,
      the resolver continues with the next server in the list.
      If no response is received from any server, the resolver
      continues with the first server again.  When the resolver
      has traversed the list 'attempts' times without receiving
      any response, it gives up and returns an error to the
      calling application.

      Implementations MAY limit the number of entries in this
      list.
path Parameters
namespace
required
string

Id of dns-resolver

name
required
string

Id of server

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/dns-resolver=%7Bnamespace%7D/server=%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-system:server": {
    }
}

creates or updates netgate.system.system.dnsresolver.Server

List of the DNS servers that the resolver should query.

      When the resolver is invoked by a calling application, it
      sends the query to the first name server in this list.  If
      no response has been received within 'timeout' seconds,
      the resolver continues with the next server in the list.
      If no response is received from any server, the resolver
      continues with the first server again.  When the resolver
      has traversed the list 'attempts' times without receiving
      any response, it gives up and returns an error to the
      calling application.

      Implementations MAY limit the number of entries in this
      list.
path Parameters
namespace
required
string

Id of dns-resolver

name
required
string

Id of server

Request Body schema: application/yang-data+json

netgate.system.system.dnsresolver.Server to be added or updated

object (netgate.system.system.dnsresolver.Server)

List of the DNS servers that the resolver should query.

      When the resolver is invoked by a calling application, it
      sends the query to the first name server in this list.  If
      no response has been received within 'timeout' seconds,
      the resolver continues with the next server in the list.
      If no response is received from any server, the resolver
      continues with the first server again.  When the resolver
      has traversed the list 'attempts' times without receiving
      any response, it gives up and returns an error to the
      calling application.

      Implementations MAY limit the number of entries in this
      list.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:server": {
    }
}

removes netgate.system.system.dnsresolver.Server

List of the DNS servers that the resolver should query.

      When the resolver is invoked by a calling application, it
      sends the query to the first name server in this list.  If
      no response has been received within 'timeout' seconds,
      the resolver continues with the next server in the list.
      If no response is received from any server, the resolver
      continues with the first server again.  When the resolver
      has traversed the list 'attempts' times without receiving
      any response, it gives up and returns an error to the
      calling application.

      Implementations MAY limit the number of entries in this
      list.
path Parameters
namespace
required
string

Id of dns-resolver

name
required
string

Id of server

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/dns-resolver=%7Bnamespace%7D/server=%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.system.system.dnsresolver.server.transport.udpandtcp.UdpAndTcp

Contains UDP- and TCP-specific configuration parameters for DNS.

path Parameters
namespace
required
string

Id of dns-resolver

name
required
string

Id of server

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/dns-resolver=%7Bnamespace%7D/server=%7Bname%7D/udp-and-tcp"

	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-system:udp-and-tcp": {
    }
}

creates netgate.system.system.dnsresolver.server.transport.udpandtcp.UdpAndTcp

Contains UDP- and TCP-specific configuration parameters for DNS.

path Parameters
namespace
required
string

Id of dns-resolver

name
required
string

Id of server

Request Body schema: application/yang-data+json

netgate.system.system.dnsresolver.server.transport.udpandtcp.UdpAndTcp to be added to list

netgate-system:port
integer <int32>
Default: 53

The UDP and TCP port number of the DNS server.

netgate-system:address
string

The address of the DNS server.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:port": 53,
  • "netgate-system:address": "string"
}

creates or updates netgate.system.system.dnsresolver.server.transport.udpandtcp.UdpAndTcp

Contains UDP- and TCP-specific configuration parameters for DNS.

path Parameters
namespace
required
string

Id of dns-resolver

name
required
string

Id of server

Request Body schema: application/yang-data+json

netgate.system.system.dnsresolver.server.transport.udpandtcp.UdpAndTcp to be added or updated

object (netgate.system.system.dnsresolver.server.transport.udpandtcp.UdpAndTcp)

Contains UDP- and TCP-specific configuration parameters for DNS. REF:Optional[RFC 1035: Domain Names - Implementation and Specification RFC 5966: DNS Transport over TCP - Implementation Requirements]

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:udp-and-tcp": {
    }
}

removes netgate.system.system.dnsresolver.server.transport.udpandtcp.UdpAndTcp

Contains UDP- and TCP-specific configuration parameters for DNS.

path Parameters
namespace
required
string

Id of dns-resolver

name
required
string

Id of server

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/dns-resolver=%7Bnamespace%7D/server=%7Bname%7D/udp-and-tcp"

	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.system.system.Kernel

returns netgate.system.system.Kernel

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/kernel"

	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-system:kernel": {
    }
}

creates netgate.system.system.Kernel

creates netgate.system.system.Kernel

Request Body schema: application/yang-data+json

netgate.system.system.Kernel to be added to list

object (netgate.system.system.kernel.Arguments)

Linux kernel arguments

object (netgate.system.system.kernel.Modules)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:arguments": {
    },
  • "netgate-system:modules": {
    }
}

creates or updates netgate.system.system.Kernel

creates or updates netgate.system.system.Kernel

Request Body schema: application/yang-data+json

netgate.system.system.Kernel to be added or updated

object (netgate.system.system.Kernel)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:kernel": {
    }
}

removes netgate.system.system.Kernel

removes netgate.system.system.Kernel

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/kernel"

	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.system.system.kernel.Arguments

Linux kernel arguments

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/kernel/arguments"

	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-system:arguments": {
    }
}

creates netgate.system.system.kernel.Arguments

Linux kernel arguments

Request Body schema: application/yang-data+json

netgate.system.system.kernel.Arguments to be added to list

netgate-system:manual
string

String to be added to kernel command line

object (netgate.system.system.kernel.arguments.configtype.auto.Auto)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:manual": "string",
  • "netgate-system:auto": {
    }
}

creates or updates netgate.system.system.kernel.Arguments

Linux kernel arguments

Request Body schema: application/yang-data+json

netgate.system.system.kernel.Arguments to be added or updated

object (netgate.system.system.kernel.Arguments)

Linux kernel arguments

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:arguments": {
    }
}

removes netgate.system.system.kernel.Arguments

Linux kernel arguments

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/kernel/arguments"

	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.system.system.kernel.arguments.configtype.auto.Auto

returns netgate.system.system.kernel.arguments.configtype.auto.Auto

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/kernel/arguments/auto"

	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-system:auto": {
    }
}

creates netgate.system.system.kernel.arguments.configtype.auto.Auto

creates netgate.system.system.kernel.arguments.configtype.auto.Auto

Request Body schema: application/yang-data+json

netgate.system.system.kernel.arguments.configtype.auto.Auto to be added to list

netgate-system:isolcpus
boolean

Enable or disable isolcpus

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:isolcpus": true
}

creates or updates netgate.system.system.kernel.arguments.configtype.auto.Auto

creates or updates netgate.system.system.kernel.arguments.configtype.auto.Auto

Request Body schema: application/yang-data+json

netgate.system.system.kernel.arguments.configtype.auto.Auto to be added or updated

object (netgate.system.system.kernel.arguments.configtype.auto.Auto)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:auto": {
    }
}

removes netgate.system.system.kernel.arguments.configtype.auto.Auto

removes netgate.system.system.kernel.arguments.configtype.auto.Auto

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/kernel/arguments/auto"

	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.system.system.kernel.Modules

returns netgate.system.system.kernel.Modules

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/kernel/modules"

	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-system:modules": {
    }
}

creates netgate.system.system.kernel.Modules

creates netgate.system.system.kernel.Modules

Request Body schema: application/yang-data+json

netgate.system.system.kernel.Modules to be added to list

object (netgate.system.system.kernel.modules.Vfio)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:vfio": {
    }
}

creates or updates netgate.system.system.kernel.Modules

creates or updates netgate.system.system.kernel.Modules

Request Body schema: application/yang-data+json

netgate.system.system.kernel.Modules to be added or updated

object (netgate.system.system.kernel.Modules)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:modules": {
    }
}

removes netgate.system.system.kernel.Modules

removes netgate.system.system.kernel.Modules

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/kernel/modules"

	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.system.system.kernel.modules.Vfio

returns netgate.system.system.kernel.modules.Vfio

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/kernel/modules/vfio"

	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-system:vfio": {
    }
}

creates netgate.system.system.kernel.modules.Vfio

creates netgate.system.system.kernel.modules.Vfio

Request Body schema: application/yang-data+json

netgate.system.system.kernel.modules.Vfio to be added to list

netgate-system:noiommu
boolean

Enable enable_unsafe_noiommu_mode option for vfio

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:noiommu": true
}

creates or updates netgate.system.system.kernel.modules.Vfio

creates or updates netgate.system.system.kernel.modules.Vfio

Request Body schema: application/yang-data+json

netgate.system.system.kernel.modules.Vfio to be added or updated

object (netgate.system.system.kernel.modules.Vfio)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-system:vfio": {
    }
}

removes netgate.system.system.kernel.modules.Vfio

removes netgate.system.system.kernel.modules.Vfio

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system/kernel/modules/vfio"

	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))

}

system-state

returns netgate.system.SystemState

System group operational state.

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-system:system-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-system:system-state": {
    }
}

returns netgate.system.systemstate.Platform

Contains vendor-specific information for identifying the system platform and operating system.

Responses

Request samples 

package main

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

func main() {

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

	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-system:platform": {
    }
}

returns netgate.system.systemstate.Product

Product specific information.

Responses

Request samples 

package main

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

func main() {

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

	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-system:product": {
    }
}

system-devices-list

/operations/netgate-system:system-devices-list

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/operations/netgate-system:system-devices-list"

	req, _ := http.NewRequest("POST", 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
{
  • "output": {
    }
}

system-nft

operates on netgate.system.SystemNft

operates on netgate.system.SystemNft

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

Responses

Request samples

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

Response samples

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

system-ping

operates on netgate.system.SystemPing

operates on netgate.system.SystemPing

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

Responses

Request samples

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

Response samples

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

system-reboot

operates on netgate.system.SystemReboot

operates on netgate.system.SystemReboot

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

Responses

Request samples

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

system-traceroute

operates on netgate.system.SystemTraceroute

operates on netgate.system.SystemTraceroute

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

Responses

Request samples

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

Response samples

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