ietf-netconf API (22.10)

NETCONF Protocol Data Types and Protocol Operations.

Copyright (c) 2011 IETF Trust and the persons identified as the document authors. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info).

This version of this YANG module is part of RFC 6241; see the RFC itself for full legal notices.

cancel-commit

operates on ietf.netconf.CancelCommit

post /operations/ietf-netconf:cancel-commit

Example URL

https://hostname/restconf/operations/ietf-netconf:cancel-commit

operates on ietf.netconf.CancelCommit

Request Body schema: application/yang-data+json
input
object (ietf.netconf.cancelcommit.Input)

Responses

201

No response

400

Internal error

Request samples

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

close-session

<no summary>

post /operations/ietf-netconf:close-session

Example URL

https://hostname/restconf/operations/ietf-netconf:close-session

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/ietf-netconf:close-session"

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

}

commit

operates on ietf.netconf.Commit

post /operations/ietf-netconf:commit

Example URL

https://hostname/restconf/operations/ietf-netconf:commit

operates on ietf.netconf.Commit

Request Body schema: application/yang-data+json
input
object (ietf.netconf.commit.Input)

Responses

201

No response

400

Internal error

Request samples

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

copy-config

operates on ietf.netconf.CopyConfig

post /operations/ietf-netconf:copy-config

Example URL

https://hostname/restconf/operations/ietf-netconf:copy-config

operates on ietf.netconf.CopyConfig

Request Body schema: application/yang-data+json
input
object (ietf.netconf.copyconfig.Input)

Responses

201

No response

400

Internal error

Request samples

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

delete-config

operates on ietf.netconf.DeleteConfig

post /operations/ietf-netconf:delete-config

Example URL

https://hostname/restconf/operations/ietf-netconf:delete-config

operates on ietf.netconf.DeleteConfig

Request Body schema: application/yang-data+json
input
object (ietf.netconf.deleteconfig.Input)

Responses

201

No response

400

Internal error

Request samples

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

discard-changes

<no summary>

post /operations/ietf-netconf:discard-changes

Example URL

https://hostname/restconf/operations/ietf-netconf:discard-changes

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/ietf-netconf:discard-changes"

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

}

edit-config

operates on ietf.netconf.EditConfig

post /operations/ietf-netconf:edit-config

Example URL

https://hostname/restconf/operations/ietf-netconf:edit-config

operates on ietf.netconf.EditConfig

Request Body schema: application/yang-data+json
input
object (ietf.netconf.editconfig.Input)

Responses

201

No response

400

Internal error

Request samples

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

get

operates on ietf.netconf.Get

post /operations/ietf-netconf:get

Example URL

https://hostname/restconf/operations/ietf-netconf:get

operates on ietf.netconf.Get

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

get-config

operates on ietf.netconf.GetConfig

post /operations/ietf-netconf:get-config

Example URL

https://hostname/restconf/operations/ietf-netconf:get-config

operates on ietf.netconf.GetConfig

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

kill-session

operates on ietf.netconf.KillSession

post /operations/ietf-netconf:kill-session

Example URL

https://hostname/restconf/operations/ietf-netconf:kill-session

operates on ietf.netconf.KillSession

Request Body schema: application/yang-data+json
input
object (ietf.netconf.killsession.Input)

Responses

201

No response

400

Internal error

Request samples

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

lock

operates on ietf.netconf.Lock

post /operations/ietf-netconf:lock

Example URL

https://hostname/restconf/operations/ietf-netconf:lock

operates on ietf.netconf.Lock

Request Body schema: application/yang-data+json
input
object (ietf.netconf.lock.Input)

Responses

201

No response

400

Internal error

Request samples

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

unlock

operates on ietf.netconf.Unlock

post /operations/ietf-netconf:unlock

Example URL

https://hostname/restconf/operations/ietf-netconf:unlock

operates on ietf.netconf.Unlock

Request Body schema: application/yang-data+json
input
object (ietf.netconf.unlock.Input)

Responses

201

No response

400

Internal error

Request samples

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

validate

operates on ietf.netconf.Validate

post /operations/ietf-netconf:validate

Example URL

https://hostname/restconf/operations/ietf-netconf:validate

operates on ietf.netconf.Validate

Request Body schema: application/yang-data+json
input
object (ietf.netconf.validate.Input)

Responses

201

No response

400

Internal error

Request samples

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