VIRL¶

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

get¶

API to send GET command to the device.

GET arguments¶
Argument	Description	Default
`url`	REST API url	Mandatory
`expected_status_code`	Expected result	200

# Assuming the device is already connected
url = '/simengine/rest/list'
output = device.get(url)

API to send POST command to the device.

POST arguments¶
Argument	Description	Default
`url`	REST API url	Mandatory
`payload`	JSON data of VIRL config	Mandatory
`expected_status_code`	Expected result	200
`timeout`	Maximum time it can take to disconnect to the device.	30 seconds

# Assuming the device is already connected
payload = """
{
    (VIRL Config)
}
"""

url = '/simengine/rest/launch'
device.post(url, payload)

API to send DELETE command to the device.

DELETE arguments¶
Argument	Description	Default
`url`	REST API url	Mandatory
`expected_status_code`	Expected result	200
`timeout`	Maximum time it can take to disconnect to the device.	30 seconds

# Assuming the device is already connected
url = '/simengine/rest/tracking/{tracking_id}'
output = device.delete(url)

Section author: Takashi Higashimura <tahigash@cisco.com>