NSO

The following services are supported by the REST connector for NSO.

connect

API to connect to the device.

The NSO REST implementation supports specifying the port to connect to and allows to specify the username and password in the testbed YAML file.

# Example
# -------
#
#   pyATS testbed yaml example for defining a REST connection

testbed:
    name: myTestbed

devices:
    PE1:
        custom:
            abstraction:
                order: [os]
        connections:
            rest:
                # Rest connector class
                class: rest.connector.Rest
                ip: 1.2.3.4
                port: 8080
                credentials:
                    rest:
                        username: admin
                        password: admin

If no port is specified, he default of 8080 is used. If no username or password is specified, the default of admin is used.

GET arguments
Argument	Description	Default
`default_content_type`	Default content type for GET requests, json or xml	json
`timeout`	Maximum time it can take to disconnect to the device. (optional)	30

disconnect

same as the generic implementation.

get

API to send GET command to the device.

GET arguments
Argument	Description	Default
`api_url`	API url string (required)
`content_type`	Content type to be returned (xml or json) (optional)	json
`headers`	Dictionary of headers (optional)
`expected_status_codes`	List of expected status codes (optional)	200
`timeout`	timeout in seconds (optional)	30

url = '/api/running/devices'
output = device.rest.get(url)

post

API to send POST command with optional payload to the device.

POST arguments
Argument	Description	Default
`api_url`	API url string (required)
`payload`	payload to sent, can be string or dict (optional)
`content_type`	content type to be returned (xml or json) (optional)
`headers`	dictionary of HTTP headers (optional)
`expected_status_codes`	list of expected result codes (optional)	200, 201, 204
`timeout`	timeout in seconds (optional)	30

If the content_type option is not passed, the script will try to detect if the payload is XML, otherwise it will assume JSON. The content-type and accept headers will be set based on the detected payload or on the passed content-type.

If you pass a dict() object as payload, a conversion will be done to JSON or XML string.

url = '/api/running/devices/device/R1/_operations/check-sync'
output = device.rest.post(url)

patch

API to send POST command with payload to the device.

PATCH arguments
Argument	Description	Default
`api_url`	API url string (required)
`payload`	payload to sent, can be string or dict (required)
`content_type`	content type to be returned (xml or json) (optional)
`headers`	dictionary of HTTP headers (optional)
`expected_status_codes`	list of expected result codes (optional)	200, 201, 204
`timeout`	timeout in seconds (optional)	30

If the content_type option is not passed, the script will try to detect if the payload is XML, otherwise it will assume JSON. The content-type and accept headers will be set based on the detected payload or on the passed content-type.

If you pass a dict() object as payload, a conversion will be done to JSON or XML string.

config_routes = """
{
  "tailf-ned-cisco-ios:route": {
    "ip-route-forwarding-list": [
      {
        "prefix": "10.6.1.0",
        "mask": "255.255.255.0",
        "forwarding-address": "10.2.2.2"
      }
    ]
  }
}
"""
output = device.rest.patch("/api/running/devices/device/R1/config/ios:ip/route", payload=config_routes)

put

API to send PUT command with payload to the device.

PUT arguments
Argument	Description	Default
`api_url`	API url string (required)
`payload`	payload to sent, can be string or dict (required)
`content_type`	content type to be returned (xml or json) (optional)
`headers`	dictionary of HTTP headers (optional)
`expected_status_codes`	list of expected result codes (optional)	200, 201, 204
`timeout`	timeout in seconds (optional)	30

If the content_type option is not passed, the script will try to detect if the payload is XML, otherwise it will assume JSON. The content-type and accept headers will be set based on the detected payload or on the passed content-type.

If you pass a dict() object as payload, a conversion will be done to JSON or XML string.

config_routes = """
{
  "tailf-ned-cisco-ios:route": {
    "ip-route-forwarding-list": [
      {
        "prefix": "10.1.1.0",
        "mask": "255.255.255.0",
        "forwarding-address": "10.2.2.2"
      },
      {
        "prefix": "10.2.1.0",
        "mask": "255.255.255.0",
        "forwarding-address": "10.2.2.2"
      }
    ]
  }
}
"""

output = device.rest.put("/api/running/devices/device/R1/config/ios:ip/route", payload=config_routes)

delete

API to send DELETE command with payload to the device.

DELETE arguments
Argument	Description	Default
`api_url`	API url string (required)
`content_type`	content type to be returned (xml or json)
`headers`	dictionary of HTTP headers (optional)
`expected_status_codes`	list of expected result codes	200, 201, 204
`timeout`	timeout in seconds (optional)	30

device.rest.delete('/api/running/devices/device/R1/config/ios:ip/route')

Section author: Dave Wapstra <dwapstra@cisco.com>