netgate-radius API (23.11)

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

Copyright 2023 Rubicon Communications, LLC.

radius-client

returns netgate.radius.RadiusClient

get /data/netgate-radius:radius-client

Example URL

https://hostname/restconf/data/netgate-radius:radius-client

Radius client configuration for PAM subsystem.

Responses

200

netgate.radius.RadiusClient

400

Internal error

Request samples

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

creates netgate.radius.RadiusClient

post /data/netgate-radius:radius-client

Example URL

https://hostname/restconf/data/netgate-radius:radius-client

Radius client configuration for PAM subsystem.

Request Body schema: application/yang-data+json

netgate.radius.RadiusClient to be added to list

netgate-radius:radius-client
object (netgate.radius.RadiusClient)

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

creates or updates netgate.radius.RadiusClient

put /data/netgate-radius:radius-client

Example URL

https://hostname/restconf/data/netgate-radius:radius-client

Radius client configuration for PAM subsystem.

Request Body schema: application/yang-data+json

netgate.radius.RadiusClient to be added or updated

netgate-radius:radius-client-wrapper
object (netgate.radius.RadiusClientWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.radius.RadiusClient

delete /data/netgate-radius:radius-client

Example URL

https://hostname/restconf/data/netgate-radius:radius-client

Radius client configuration for PAM subsystem.

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

get /data/netgate-radius:radius-client/client

Example URL

https://hostname/restconf/data/netgate-radius:radius-client/client

The Radius client parameters.

Responses

200

netgate.radius.radiusclient.Client

400

Internal error

Request samples

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

creates netgate.radius.radiusclient.Client

post /data/netgate-radius:radius-client/client

Example URL

https://hostname/restconf/data/netgate-radius:radius-client/client

The Radius client parameters.

Request Body schema: application/yang-data+json

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

client
object (netgate.radius.radiusclient.Client)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.radius.radiusclient.Client

put /data/netgate-radius:radius-client/client

Example URL

https://hostname/restconf/data/netgate-radius:radius-client/client

The Radius client parameters.

Request Body schema: application/yang-data+json

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

netgate-radius:client-wrapper
object (netgate.radius.radiusclient.ClientWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.radius.radiusclient.Client

delete /data/netgate-radius:radius-client/client

Example URL

https://hostname/restconf/data/netgate-radius:radius-client/client

The Radius client parameters.

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

post /data/netgate-radius:radius-client/client/servers

Example URL

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

servers
object (netgate.radius.radiusclient.client.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":
    {
    }
}

returns netgate.radius.radiusclient.client.Servers

get /data/netgate-radius:radius-client/client/servers={name}

Example URL

https://hostname/restconf/data/netgate-radius:radius-client/client/servers={name}

returns netgate.radius.radiusclient.client.Servers

path Parameters
name
required
string

Id of servers

Responses

200

netgate.radius.radiusclient.client.Servers

400

Internal error

Request samples

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

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

put /data/netgate-radius:radius-client/client/servers={name}

Example URL

https://hostname/restconf/data/netgate-radius:radius-client/client/servers={name}

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

netgate-radius:servers-wrapper
object (netgate.radius.radiusclient.client.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-radius:servers-wrapper":
    {
    }
}

removes netgate.radius.radiusclient.client.Servers

delete /data/netgate-radius:radius-client/client/servers={name}

Example URL

https://hostname/restconf/data/netgate-radius:radius-client/client/servers={name}

removes netgate.radius.radiusclient.client.Servers

path Parameters
name
required
string

Id of servers

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

get /data/netgate-radius:radius-client/client/servers={name}/server

Example URL

https://hostname/restconf/data/netgate-radius:radius-client/client/servers={name}/server

Server name or address, and port number.

path Parameters
name
required
string

Id of servers

Responses

200

netgate.radius.ServerTuple

400

Internal error

Request samples

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

creates netgate.radius.ServerTuple

post /data/netgate-radius:radius-client/client/servers={name}/server

Example URL

https://hostname/restconf/data/netgate-radius:radius-client/client/servers={name}/server

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

server
object (netgate.radius.ServerTuple)

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

creates or updates netgate.radius.ServerTuple

put /data/netgate-radius:radius-client/client/servers={name}/server

Example URL

https://hostname/restconf/data/netgate-radius:radius-client/client/servers={name}/server

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

netgate-radius:server-tuple-wrapper
object (netgate.radius.ServerTupleWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.radius.ServerTuple

delete /data/netgate-radius:radius-client/client/servers={name}/server

Example URL

https://hostname/restconf/data/netgate-radius:radius-client/client/servers={name}/server

Server name or address, and port number.

path Parameters
name
required
string

Id of servers

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

post /operations/netgate-radius:radius-config-operation