Netgate TNSR Logo
Documentation Powered by ReDoc

netgate-system API (24.02)

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

Copyright 2018-2024 Rubicon Communications, LLC.

system

returns netgate.system.System

get /data/netgate-system:system

Example URL

https://hostname/restconf/data/netgate-system:system

System group configuration.

Responses

200

netgate.system.System

400

Internal error

Request samples

Copy
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
Copy
 Expand all Collapse all
{
  • "netgate-system:system-wrapper":
    {
    }
}

creates netgate.system.System

post /data/netgate-system:system

Example URL

https://hostname/restconf/data/netgate-system:system

System group configuration.

Request Body schema: application/yang-data+json

netgate.system.System to be added to list

netgate-system:system
object (netgate.system.System)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.system.System

put /data/netgate-system:system

Example URL

https://hostname/restconf/data/netgate-system:system

System group configuration.

Request Body schema: application/yang-data+json

netgate.system.System to be added or updated

netgate-system:system-wrapper
object (netgate.system.SystemWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-system:system-wrapper":
    {
    }
}

removes netgate.system.System

delete /data/netgate-system:system

Example URL

https://hostname/restconf/data/netgate-system:system

System group configuration.

Responses

204

Object deleted

400

Internal error

Request samples

Copy
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

get /data/netgate-system:system/auth

Example URL

https://hostname/restconf/data/netgate-system:system/auth

returns netgate.system.system.Auth

Responses

200

netgate.system.system.Auth

400

Internal error

Request samples

Copy
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
Copy
 Expand all Collapse all
{
  • "netgate-system:auth-wrapper":
    {
    }
}

creates netgate.system.system.Auth

post /data/netgate-system:system/auth

Example URL

https://hostname/restconf/data/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

auth
object (netgate.system.system.Auth)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "auth":
    {
    }
}

creates or updates netgate.system.system.Auth

put /data/netgate-system:system/auth

Example URL

https://hostname/restconf/data/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

netgate-system:auth-wrapper
object (netgate.system.system.AuthWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-system:auth-wrapper":
    {
    }
}

removes netgate.system.system.Auth

delete /data/netgate-system:system/auth

Example URL

https://hostname/restconf/data/netgate-system:system/auth

removes netgate.system.system.Auth

Responses

204

Object deleted

400

Internal error

Request samples

Copy
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

get /data/netgate-system:system/auth/authentication-methods

Example URL

https://hostname/restconf/data/netgate-system:system/auth/authentication-methods

returns netgate.system.system.auth.AuthenticationMethods

Responses

200

netgate.system.system.auth.AuthenticationMethods

400

Internal error

Request samples

Copy
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
Copy
 Expand all Collapse all
{
  • "netgate-system:authentication-methods-wrapper":
    {
    }
}

creates netgate.system.system.auth.AuthenticationMethods

post /data/netgate-system:system/auth/authentication-methods

Example URL

https://hostname/restconf/data/netgate-system:system/auth/authentication-methods

creates netgate.system.system.auth.AuthenticationMethods

Request Body schema: application/yang-data+json

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

authentication-methods
object (netgate.system.system.auth.AuthenticationMethods)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "authentication-methods":
    {
    }
}

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

put /data/netgate-system:system/auth/authentication-methods

Example URL

https://hostname/restconf/data/netgate-system:system/auth/authentication-methods

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

netgate-system:authentication-methods-wrapper
object (netgate.system.system.auth.AuthenticationMethodsWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-system:authentication-methods-wrapper":
    {
    }
}

removes netgate.system.system.auth.AuthenticationMethods

delete /data/netgate-system:system/auth/authentication-methods

Example URL

https://hostname/restconf/data/netgate-system:system/auth/authentication-methods

removes netgate.system.system.auth.AuthenticationMethods

Responses

204

Object deleted

400

Internal error

Request samples

Copy
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

get /data/netgate-system:system/auth/authentication-methods/ldap

Example URL

https://hostname/restconf/data/netgate-system:system/auth/authentication-methods/ldap

LDAP server-group to use.

Responses

200

netgate.system.system.auth.authenticationmethods.Ldap

400

Internal error

Request samples

Copy
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
Copy
 Expand all Collapse all
{
  • "netgate-system:ldap-wrapper":
    {
    }
}

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

post /data/netgate-system:system/auth/authentication-methods/ldap

Example URL

https://hostname/restconf/data/netgate-system:system/auth/authentication-methods/ldap

LDAP server-group to use.

Request Body schema: application/yang-data+json

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

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "ldap":
    {
    }
}

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

put /data/netgate-system:system/auth/authentication-methods/ldap

Example URL

https://hostname/restconf/data/netgate-system:system/auth/authentication-methods/ldap

LDAP server-group to use.

Request Body schema: application/yang-data+json

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

netgate-system:ldap-wrapper
object (netgate.system.system.auth.authenticationmethods.LdapWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-system:ldap-wrapper":
    {
    }
}

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

delete /data/netgate-system:system/auth/authentication-methods/ldap

Example URL

https://hostname/restconf/data/netgate-system:system/auth/authentication-methods/ldap

LDAP server-group to use.

Responses

204

Object deleted

400

Internal error

Request samples

Copy
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

get /data/netgate-system:system/auth/authentication-methods/radius

Example URL

https://hostname/restconf/data/netgate-system:system/auth/authentication-methods/radius

Radius server-group to use.

Responses

200

netgate.system.system.auth.authenticationmethods.Radius

400

Internal error

Request samples

Copy
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
Copy
 Expand all Collapse all
{
  • "netgate-system:radius-wrapper":
    {
    }
}

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

post /data/netgate-system:system/auth/authentication-methods/radius

Example URL

https://hostname/restconf/data/netgate-system:system/auth/authentication-methods/radius

Radius server-group to use.

Request Body schema: application/yang-data+json

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

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "radius":
    {
    }
}

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

put /data/netgate-system:system/auth/authentication-methods/radius

Example URL

https://hostname/restconf/data/netgate-system:system/auth/authentication-methods/radius

Radius server-group to use.

Request Body schema: application/yang-data+json

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

netgate-system:radius-wrapper
object (netgate.system.system.auth.authenticationmethods.RadiusWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-system:radius-wrapper":
    {
    }
}

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

delete /data/netgate-system:system/auth/authentication-methods/radius

Example URL

https://hostname/restconf/data/netgate-system:system/auth/authentication-methods/radius

Radius server-group to use.

Responses

204

Object deleted

400

Internal error

Request samples

Copy
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

get /data/netgate-system:system/auth/server-groups

Example URL

https://hostname/restconf/data/netgate-system:system/auth/server-groups

Server groups to use for authentication methods.

Responses

200

netgate.system.system.auth.ServerGroups

400

Internal error

Request samples

Copy
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
Copy
 Expand all Collapse all
{
  • "netgate-system:server-groups-wrapper":
    {
    }
}

creates netgate.system.system.auth.ServerGroups

post /data/netgate-system:system/auth/server-groups

Example URL

https://hostname/restconf/data/netgate-system:system/auth/server-groups

Server groups to use for authentication methods.

Request Body schema: application/yang-data+json

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

server-groups
object (netgate.system.system.auth.ServerGroups)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "server-groups":
    {
    }
}

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

put /data/netgate-system:system/auth/server-groups

Example URL

https://hostname/restconf/data/netgate-system:system/auth/server-groups

Server groups to use for authentication methods.

Request Body schema: application/yang-data+json

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

netgate-system:server-groups-wrapper
object (netgate.system.system.auth.ServerGroupsWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-system:server-groups-wrapper":
    {
    }
}

removes netgate.system.system.auth.ServerGroups

delete /data/netgate-system:system/auth/server-groups

Example URL

https://hostname/restconf/data/netgate-system:system/auth/server-groups

Server groups to use for authentication methods.

Responses

204

Object deleted

400

Internal error

Request samples

Copy
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

post /data/netgate-system:system/auth/server-groups/server-group

Example URL

https://hostname/restconf/data/netgate-system:system/auth/server-groups/server-group

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

server-group
object (netgate.system.system.auth.servergroups.ServerGroup)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "server-group":
    {
    }
}

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

get /data/netgate-system:system/auth/server-groups/server-group={name}

Example URL

https://hostname/restconf/data/netgate-system:system/auth/server-groups/server-group={name}

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

path Parameters
name
required
string

Id of server-group

Responses

200

netgate.system.system.auth.servergroups.ServerGroup

400

Internal error

Request samples

Copy
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
Copy
 Expand all Collapse all
{
  • "netgate-system:server-group-wrapper":
    {
    }
}

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

put /data/netgate-system:system/auth/server-groups/server-group={name}

Example URL

https://hostname/restconf/data/netgate-system:system/auth/server-groups/server-group={name}

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

netgate-system:server-group-wrapper
object (netgate.system.system.auth.servergroups.ServerGroupWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-system:server-group-wrapper":
    {
    }
}

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

delete /data/netgate-system:system/auth/server-groups/server-group={name}

Example URL

https://hostname/restconf/data/netgate-system:system/auth/server-groups/server-group={name}

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

path Parameters
name
required
string

Id of server-group

Responses

204

Object deleted

400

Internal error

Request samples

Copy
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

get /data/netgate-system:system/auth/server-groups/server-group={name}/servers

Example URL

https://hostname/restconf/data/netgate-system:system/auth/server-groups/server-group={name}/servers

Servers in this group.

path Parameters
name
required
string

Id of server-group

Responses

200

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

400

Internal error

Request samples

Copy
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
Copy
 Expand all Collapse all
{
  • "netgate-system:servers-wrapper":
    {
    }
}

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

post /data/netgate-system:system/auth/server-groups/server-group={name}/servers

Example URL

https://hostname/restconf/data/netgate-system:system/auth/server-groups/server-group={name}/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

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "servers":
    {
    }
}

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

put /data/netgate-system:system/auth/server-groups/server-group={name}/servers

Example URL

https://hostname/restconf/data/netgate-system:system/auth/server-groups/server-group={name}/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

netgate-system:servers-wrapper
object (netgate.system.system.auth.servergroups.servergroup.ServersWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-system:servers-wrapper":
    {
    }
}

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

delete /data/netgate-system:system/auth/server-groups/server-group={name}/servers

Example URL

https://hostname/restconf/data/netgate-system:system/auth/server-groups/server-group={name}/servers

Servers in this group.

path Parameters
name
required
string

Id of server-group

Responses

204

Object deleted

400

Internal error

Request samples

Copy
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

post /data/netgate-system:system/auth/server-groups/server-group={name}/servers/server

Example URL

https://hostname/restconf/data/netgate-system:system/auth/server-groups/server-group={name}/servers/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

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "server":
    {
    }
}

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

get /data/netgate-system:system/auth/server-groups/server-group={name}/servers/server={priority}

Example URL

https://hostname/restconf/data/netgate-system:system/auth/server-groups/server-group={name}/servers/server={priority}

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

200

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

400

Internal error

Request samples

Copy
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
Copy
 Expand all Collapse all
{
  • "netgate-system:server-wrapper":
    {
    }
}

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

put /data/netgate-system:system/auth/server-groups/server-group={name}/servers/server={priority}

Example URL

https://hostname/restconf/data/netgate-system:system/auth/server-groups/server-group={name}/servers/server={priority}

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

netgate-system:server-wrapper
object (netgate.system.system.auth.servergroups.servergroup.servers.serverlisttype.subset.ServerWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-system:server-wrapper":
    {
    }
}

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

delete /data/netgate-system:system/auth/server-groups/server-group={name}/servers/server={priority}

Example URL

https://hostname/restconf/data/netgate-system:system/auth/server-groups/server-group={name}/servers/server={priority}

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

204

Object deleted

400

Internal error

Request samples

Copy
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

post /data/netgate-system:system/auth/user

Example URL

https://hostname/restconf/data/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

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "user":
    {
    }
}

returns netgate.system.system.auth.User

get /data/netgate-system:system/auth/user={user-name}

Example URL

https://hostname/restconf/data/netgate-system:system/auth/user={user-name}

allowed users of the system

path Parameters
user-name
required
string

Id of user

Responses

200

netgate.system.system.auth.User

400

Internal error

Request samples

Copy
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
Copy
 Expand all Collapse all
{
  • "netgate-system:user-wrapper":
    {
    }
}

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

put /data/netgate-system:system/auth/user={user-name}

Example URL

https://hostname/restconf/data/netgate-system:system/auth/user={user-name}

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

netgate-system:user-wrapper
object (netgate.system.system.auth.UserWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-system:user-wrapper":
    {
    }
}

removes netgate.system.system.auth.User

delete /data/netgate-system:system/auth/user={user-name}

Example URL

https://hostname/restconf/data/netgate-system:system/auth/user={user-name}

allowed users of the system

path Parameters
user-name
required
string

Id of user

Responses

204

Object deleted

400

Internal error

Request samples

Copy
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

post /data/netgate-system:system/auth/user={user-name}/user-keys

Example URL

https://hostname/restconf/data/netgate-system:system/auth/user={user-name}/user-keys

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

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "user-keys":
    {
    }
}

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

get /data/netgate-system:system/auth/user={user-name}/user-keys={key-name}

Example URL

https://hostname/restconf/data/netgate-system:system/auth/user={user-name}/user-keys={key-name}

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

200

netgate.system.system.auth.user.UserKeys

400

Internal error

Request samples

Copy
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
Copy
 Expand all Collapse all
{
  • "netgate-system:user-keys-wrapper":
    {
    }
}

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

put /data/netgate-system:system/auth/user={user-name}/user-keys={key-name}

Example URL

https://hostname/restconf/data/netgate-system:system/auth/user={user-name}/user-keys={key-name}

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

netgate-system:user-keys-wrapper
object (netgate.system.system.auth.user.UserKeysWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-system:user-keys-wrapper":
    {
    }
}

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

delete /data/netgate-system:system/auth/user={user-name}/user-keys={key-name}

Example URL

https://hostname/restconf/data/netgate-system:system/auth/user={user-name}/user-keys={key-name}

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

204

Object deleted

400

Internal error

Request samples

Copy
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

post /data/netgate-system:system/dns-resolver

Example URL

https://hostname/restconf/data/netgate-system:system/dns-resolver

Configuration of the DNS resolver.

Request Body schema: application/yang-data+json

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

dns-resolver
object (netgate.system.system.DnsResolver)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "dns-resolver":
    {
    }
}

returns netgate.system.system.DnsResolver

get /data/netgate-system:system/dns-resolver={namespace}

Example URL

https://hostname/restconf/data/netgate-system:system/dns-resolver={namespace}

Configuration of the DNS resolver.

path Parameters
namespace
required
string

Id of dns-resolver

Responses

200

netgate.system.system.DnsResolver

400

Internal error

Request samples

Copy
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
Copy
 Expand all Collapse all
{
  • "netgate-system:dns-resolver-wrapper":
    {
    }
}

creates or updates netgate.system.system.DnsResolver

put /data/netgate-system:system/dns-resolver={namespace}

Example URL

https://hostname/restconf/data/netgate-system:system/dns-resolver={namespace}

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

netgate-system:dns-resolver-wrapper
object (netgate.system.system.DnsResolverWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-system:dns-resolver-wrapper":
    {
    }
}

removes netgate.system.system.DnsResolver

delete /data/netgate-system:system/dns-resolver={namespace}

Example URL

https://hostname/restconf/data/netgate-system:system/dns-resolver={namespace}

Configuration of the DNS resolver.

path Parameters
namespace
required
string

Id of dns-resolver

Responses

204

Object deleted

400

Internal error

Request samples

Copy
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

post /data/netgate-system:system/dns-resolver={namespace}/server

Example URL

https://hostname/restconf/data/netgate-system:system/dns-resolver={namespace}/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

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "server":
    {
    }
}

returns netgate.system.system.dnsresolver.Server

get /data/netgate-system:system/dns-resolver={namespace}/server={name}

Example URL

https://hostname/restconf/data/netgate-system:system/dns-resolver={namespace}/server={name}

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

200

netgate.system.system.dnsresolver.Server

400

Internal error

Request samples

Copy
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
Copy
 Expand all Collapse all
{
  • "netgate-system:server-wrapper":
    {
    }
}

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

put /data/netgate-system:system/dns-resolver={namespace}/server={name}

Example URL

https://hostname/restconf/data/netgate-system:system/dns-resolver={namespace}/server={name}

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

netgate-system:server-wrapper
object (netgate.system.system.dnsresolver.ServerWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-system:server-wrapper":
    {
    }
}

removes netgate.system.system.dnsresolver.Server

delete /data/netgate-system:system/dns-resolver={namespace}/server={name}

Example URL

https://hostname/restconf/data/netgate-system:system/dns-resolver={namespace}/server={name}

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

204

Object deleted

400

Internal error

Request samples

Copy
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

get /data/netgate-system:system/dns-resolver={namespace}/server={name}/udp-and-tcp

Example URL

https://hostname/restconf/data/netgate-system:system/dns-resolver={namespace}/server={name}/udp-and-tcp

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

200

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

400

Internal error

Request samples

Copy
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
Copy
 Expand all Collapse all
{
  • "netgate-system:udp-and-tcp-wrapper":
    {
    }
}

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

post /data/netgate-system:system/dns-resolver={namespace}/server={name}/udp-and-tcp

Example URL

https://hostname/restconf/data/netgate-system:system/dns-resolver={namespace}/server={name}/udp-and-tcp

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

udp-and-tcp
object (netgate.system.system.dnsresolver.server.transport.udpandtcp.UdpAndTcp)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "udp-and-tcp":
    {
    }
}

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

put /data/netgate-system:system/dns-resolver={namespace}/server={name}/udp-and-tcp

Example URL

https://hostname/restconf/data/netgate-system:system/dns-resolver={namespace}/server={name}/udp-and-tcp

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

netgate-system:udp-and-tcp-wrapper
object (netgate.system.system.dnsresolver.server.transport.udpandtcp.UdpAndTcpWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-system:udp-and-tcp-wrapper":
    {
    }
}

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

delete /data/netgate-system:system/dns-resolver={namespace}/server={name}/udp-and-tcp

Example URL

https://hostname/restconf/data/netgate-system:system/dns-resolver={namespace}/server={name}/udp-and-tcp

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

204

Object deleted

400

Internal error

Request samples

Copy
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

get /data/netgate-system:system/kernel

Example URL

https://hostname/restconf/data/netgate-system:system/kernel

returns netgate.system.system.Kernel

Responses

200

netgate.system.system.Kernel

400

Internal error

Request samples

Copy
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
Copy
 Expand all Collapse all
{
  • "netgate-system:kernel-wrapper":
    {
    }
}

creates netgate.system.system.Kernel

post /data/netgate-system:system/kernel

Example URL

https://hostname/restconf/data/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

kernel
object (netgate.system.system.Kernel)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "kernel":
    {
    }
}

creates or updates netgate.system.system.Kernel

put /data/netgate-system:system/kernel

Example URL

https://hostname/restconf/data/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

netgate-system:kernel-wrapper
object (netgate.system.system.KernelWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-system:kernel-wrapper":
    {
    }
}

removes netgate.system.system.Kernel

delete /data/netgate-system:system/kernel

Example URL

https://hostname/restconf/data/netgate-system:system/kernel

removes netgate.system.system.Kernel

Responses

204

Object deleted

400

Internal error

Request samples

Copy
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

get /data/netgate-system:system/kernel/arguments

Example URL

https://hostname/restconf/data/netgate-system:system/kernel/arguments

Linux kernel arguments

Responses

200

netgate.system.system.kernel.Arguments

400

Internal error

Request samples

Copy
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
Copy
 Expand all Collapse all
{
  • "netgate-system:arguments-wrapper":
    {
    }
}

creates netgate.system.system.kernel.Arguments

post /data/netgate-system:system/kernel/arguments

Example URL

https://hostname/restconf/data/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

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "arguments":
    {
    }
}

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

put /data/netgate-system:system/kernel/arguments

Example URL

https://hostname/restconf/data/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

netgate-system:arguments-wrapper
object (netgate.system.system.kernel.ArgumentsWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-system:arguments-wrapper":
    {
    }
}

removes netgate.system.system.kernel.Arguments

delete /data/netgate-system:system/kernel/arguments

Example URL

https://hostname/restconf/data/netgate-system:system/kernel/arguments

Linux kernel arguments

Responses

204

Object deleted

400

Internal error

Request samples

Copy
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

get /data/netgate-system:system/kernel/arguments/auto

Example URL

https://hostname/restconf/data/netgate-system:system/kernel/arguments/auto

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

Responses

200

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

400

Internal error

Request samples

Copy
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
Copy
 Expand all Collapse all
{
  • "netgate-system:auto-wrapper":
    {
    }
}

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

post /data/netgate-system:system/kernel/arguments/auto

Example URL

https://hostname/restconf/data/netgate-system:system/kernel/arguments/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

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "auto":
    {
    }
}

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

put /data/netgate-system:system/kernel/arguments/auto

Example URL

https://hostname/restconf/data/netgate-system:system/kernel/arguments/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

netgate-system:auto-wrapper
object (netgate.system.system.kernel.arguments.configtype.auto.AutoWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-system:auto-wrapper":
    {
    }
}

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

delete /data/netgate-system:system/kernel/arguments/auto

Example URL

https://hostname/restconf/data/netgate-system:system/kernel/arguments/auto

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

Responses

204

Object deleted

400

Internal error

Request samples

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

}

system-state

returns netgate.system.SystemState

get /data/netgate-system:system-state

Example URL

https://hostname/restconf/data/netgate-system:system-state

System group operational state.

Responses

200

netgate.system.SystemState

400

Internal error

Request samples

Copy
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
Copy
 Expand all Collapse all
{
  • "netgate-system:system-state-wrapper":
    {
    }
}

returns netgate.system.systemstate.Platform

get /data/netgate-system:system-state/platform

Example URL

https://hostname/restconf/data/netgate-system:system-state/platform

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

Responses

200

netgate.system.systemstate.Platform

400

Internal error

Request samples

Copy
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
Copy
 Expand all Collapse all
{
  • "netgate-system:platform-wrapper":
    {
    }
}

returns netgate.system.systemstate.Product

get /data/netgate-system:system-state/product

Example URL

https://hostname/restconf/data/netgate-system:system-state/product

Product specific information.

Responses

200

netgate.system.systemstate.Product

400

Internal error

Request samples

Copy
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
Copy
 Expand all Collapse all
{
  • "netgate-system:product-wrapper":
    {
    }
}

system-devices-list

<no summary>

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

Example URL

https://hostname/restconf/operations/netgate-system:system-devices-list

Responses

200

Correct response

201

No response

400

Internal error

Request samples

Copy
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
Copy
 Expand all Collapse all
{
  • "output":
    {
    }
}

system-nft

operates on netgate.system.SystemNft

post /operations/netgate-system:system-nft

Example URL

https://hostname/restconf/operations/netgate-system:system-nft

operates on netgate.system.SystemNft

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

Responses

200

Correct response

201

No response

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "input":
    {
    }
}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "output":
    {
    }
}

system-ping

operates on netgate.system.SystemPing

post /operations/netgate-system:system-ping

Example URL

https://hostname/restconf/operations/netgate-system:system-ping

operates on netgate.system.SystemPing

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

Responses

200

Correct response

201

No response

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "input":
    {
    }
}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "output":
    {
    }
}

system-reboot

operates on netgate.system.SystemReboot

post /operations/netgate-system:system-reboot

Example URL

https://hostname/restconf/operations/netgate-system:system-reboot

operates on netgate.system.SystemReboot

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

Responses

201

No response

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "input":
    {
    }
}

system-traceroute

operates on netgate.system.SystemTraceroute

post /operations/netgate-system:system-traceroute

Example URL

https://hostname/restconf/operations/netgate-system:system-traceroute

operates on netgate.system.SystemTraceroute

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

Responses

200

Correct response

201

No response

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "input":
    {
    }
}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "output":
    {
    }
}