Netgate TNSR Logo
API docs by Redocly

netgate-radius API (24.10)

The YANG module provides a data-model for the Radius client.

Copyright 2023 Rubicon Communications, LLC.

radius-client

returns netgate.radius.RadiusClient

Radius client configuration for PAM subsystem.

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-radius:radius-client"

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

creates netgate.radius.RadiusClient

Radius client configuration for PAM subsystem.

Request Body schema: application/yang-data+json

netgate.radius.RadiusClient to be added to list

object (netgate.radius.radiusclient.Client)

The Radius client parameters.

Responses

Request samples

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

creates or updates netgate.radius.RadiusClient

Radius client configuration for PAM subsystem.

Request Body schema: application/yang-data+json

netgate.radius.RadiusClient to be added or updated

object (netgate.radius.RadiusClient)

Radius client configuration for PAM subsystem.

Responses

Request samples

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

removes netgate.radius.RadiusClient

Radius client configuration for PAM subsystem.

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-radius:radius-client"

	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.radius.radiusclient.Client

The Radius client parameters.

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-radius:radius-client/client"

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

creates netgate.radius.radiusclient.Client

The Radius client parameters.

Request Body schema: application/yang-data+json

netgate.radius.radiusclient.Client to be added to list

Array of objects (netgate.radius.radiusclient.client.Servers)

Responses

Request samples

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

creates or updates netgate.radius.radiusclient.Client

The Radius client parameters.

Request Body schema: application/yang-data+json

netgate.radius.radiusclient.Client to be added or updated

object (netgate.radius.radiusclient.Client)

The Radius client parameters.

Responses

Request samples

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

removes netgate.radius.radiusclient.Client

The Radius client parameters.

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-radius:radius-client/client"

	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.radius.radiusclient.client.Servers

creates netgate.radius.radiusclient.client.Servers

Request Body schema: application/yang-data+json

netgate.radius.radiusclient.client.Servers to be added to list

netgate-radius:name
string

Server handle.

object (netgate.radius.ServerTuple)
netgate-radius:secret
string

Shared secret for server.

netgate-radius:source-address
string

Client address to use.

netgate-radius:timeout
integer <int64>
Default: 3

Timeout for server requests.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-radius:name": "string",
  • "netgate-radius:server": {
    },
  • "netgate-radius:secret": "string",
  • "netgate-radius:source-address": "string",
  • "netgate-radius:timeout": 3
}

returns netgate.radius.radiusclient.client.Servers

returns netgate.radius.radiusclient.client.Servers

path Parameters
name
required
string

Id of servers

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-radius:radius-client/client/servers=%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-radius:servers": {
    }
}

creates or updates netgate.radius.radiusclient.client.Servers

creates or updates netgate.radius.radiusclient.client.Servers

path Parameters
name
required
string

Id of servers

Request Body schema: application/yang-data+json

netgate.radius.radiusclient.client.Servers to be added or updated

object (netgate.radius.radiusclient.client.Servers)

Responses

Request samples

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

removes netgate.radius.radiusclient.client.Servers

removes netgate.radius.radiusclient.client.Servers

path Parameters
name
required
string

Id of servers

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-radius:radius-client/client/servers=%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.radius.ServerTuple

Server name or address, and port number.

path Parameters
name
required
string

Id of servers

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-radius:radius-client/client/servers=%7Bname%7D/server"

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

creates netgate.radius.ServerTuple

Server name or address, and port number.

path Parameters
name
required
string

Id of servers

Request Body schema: application/yang-data+json

netgate.radius.ServerTuple to be added to list

netgate-radius:host
string
netgate-radius:port
integer <int32>

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-radius:host": "string",
  • "netgate-radius:port": 0
}

creates or updates netgate.radius.ServerTuple

Server name or address, and port number.

path Parameters
name
required
string

Id of servers

Request Body schema: application/yang-data+json

netgate.radius.ServerTuple to be added or updated

object (netgate.radius.ServerTuple)

Responses

Request samples

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

removes netgate.radius.ServerTuple

Server name or address, and port number.

path Parameters
name
required
string

Id of servers

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-radius:radius-client/client/servers=%7Bname%7D/server"

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

}

radius-config-operation

operates on netgate.radius.RadiusConfigOperation

operates on netgate.radius.RadiusConfigOperation

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

Responses

Request samples

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

Response samples

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