This page illustrates the work-flow for introducing resources in OpenNaaS. It does so by using the CLI.
Creating resources
First step in OpenNaaS is registering existing infrastructure. For this tutorial, let's assume there is a single router device to be registered.
In order to register a resource, a resource descriptor file is required. This file describes resource device type and name, all capabilities OpenNaaS should load for it, and what drivers will it use. More information about the Resource descriptor concept is available in System Architecture section.
A descriptor from the project examples directory, or a custom one can be used.
The CLI command to register a device with this descriptor will be:
resource:create /path/to/descriptor/resource.descriptor
Note: For this guide, we used a router descriptor, specifying junos20 as name.
Registering protocol contexts
Each resource can use many different protocols to communicate with the physical device it represents. Required protocols are determined by the driver in use. For a resource to be able to use a required protocol, a Protocol Context is needed. Protocol Context stores all required information to communicate with the device using a protocol known to OpenNaaS.
In this example we're going to use netconf protocol. Hence, we introduce all netconf Protocol Context required data:
- protocol type
- authentication type
- uri
- authentication parameters
The following command illustrates how to register a protocol context for our resource using password authentication:
protocols:context router:junos20 netconf password ssh://myuser:mypassword@193.1.190.254:22/netconf
and the following, using key authentication:
protocols:context router:junos20 netconf publickey ssh://myuser@193.1.190.254.22/netconf privateKeyPath {key-passphrase}
Notice that only one context per protocol type is registered in a resource. Last one lasts.
Starting resources
A resource will populate its model and enable all its capabilities when started. Hence, in order to operate with it using opennaas, it must be started.
To start it, we use the following command:
resource:start router:junos20
Doing operations with resources
A resource includes a set of capabilities or features. These capabilities determine the set of available operations for this resource.
OpenNaaS supported capabilities are specified in this section.
Please, remember that capabilities to load for a particular resource are specified in the resource descriptor.
Removing resources
Finally, if the resource isn't needed anymore, it can be stopped and removed. First, we stop it:
resource:stop router:junos20
The resource will deactivate all its capabilities and it will be reset. After, we'll destroy it and delete any resource information in OpenNaaS.
resource:remove router:junos20