Netgate TNSR Logo
Documentation Powered by ReDoc

clixon-lib API (23.11)

* BEGIN LICENSE BLOCK * Copyright (C) 2009-2019 Olof Hagsand Copyright (C) 2020-2022 Olof Hagsand and Rubicon Communications, LLC(Netgate)

This file is part of CLIXON

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Alternatively, the contents of this file may be used under the terms of the GNU General Public License Version 3 or later (the "GPL"), in which case the provisions of the GPL are applicable instead of those above. If you wish to allow use of your version of this file only under the terms of the GPL, and not to allow others to use your version of this file under the terms of Apache License version 2, indicate your decision by deleting the provisions above and replace them with the notice and other provisions required by the GPL. If you do not delete the provisions above, a recipient may use your version of this file under the terms of any one of the Apache License version 2 or the GPL.

* END LICENSE BLOCK *

Clixon Netconf extensions for communication between clients and backend. This scheme adds:

  • Added values of RFC6022 transport identityref
  • RPCs for debug, stats and process-control
  • Informal description of attributes

Clixon also extends NETCONF for internal use with some internal attributes. These are not visible for external usage bit belongs to the namespace of this YANG. The internal attributes are:

  • content (also RESTCONF)
  • depth (also RESTCONF)
  • username
  • autocommit
  • copystartup
  • transport (see RFC6022)
  • source-host (see RFC6022)
  • objectcreate
  • objectexisted

debug

operates on clixon.lib.Debug

post /operations/clixon-lib:debug

Example URL

https://hostname/restconf/operations/clixon-lib:debug

operates on clixon.lib.Debug

Request Body schema: application/yang-data+json
input
object (clixon.lib.debug.Input)

Responses

201

No response

400

Internal error

Request samples

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

ping

<no summary>

post /operations/clixon-lib:ping

Example URL

https://hostname/restconf/operations/clixon-lib:ping

Responses

201

No response

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/operations/clixon-lib:ping"

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

}

process-control

operates on clixon.lib.ProcessControl

post /operations/clixon-lib:process-control

Example URL

https://hostname/restconf/operations/clixon-lib:process-control

operates on clixon.lib.ProcessControl

Request Body schema: application/yang-data+json
input
object (clixon.lib.processcontrol.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":
    {
    }
}

restart-plugin

operates on clixon.lib.RestartPlugin

post /operations/clixon-lib:restart-plugin

Example URL

https://hostname/restconf/operations/clixon-lib:restart-plugin

operates on clixon.lib.RestartPlugin

Request Body schema: application/yang-data+json
input
object (clixon.lib.restartplugin.Input)

Responses

201

No response

400

Internal error

Request samples

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

stats

operates on clixon.lib.Stats

post /operations/clixon-lib:stats

Example URL

https://hostname/restconf/operations/clixon-lib:stats

operates on clixon.lib.Stats

Request Body schema: application/yang-data+json
input
object (clixon.lib.stats.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":
    {
    }
}