This page includes parameters associated only with a user account, rather than any particular managed Agent or ADM. These parameters include: * Username * Email * First Name * Last Name * Membership Length

Figure 1.2. User Profile Example

The Email, First Name, and Last Name fields can be edited on this page. Clicking the green Update button will update the user profile with these changes.

The Grafana display at the bottom of the Monitor tab allows a user to create custom panels - graphs, charts, alerts, etc. - to visualize information gathered by the ANMS that is stored in the database.

Navigate to the Monitor tab, and select New Panel under the Grafana section.

Figure 1.6. Create a Custom Panel for Monitoring

A new page is then displayed; this is the Grafana’s panel creation wizard.

There are three sections in the panel creator, which can be resized for easy viewing and editing.

Figure 1.7. Grafana Panel Creation Wizard

Section A, as depicted in Figure 1.7 in the upper left box, displays a preview of what the panel you are creating will look like or will show an error screen if it can not be generated.

Figure 1.8. Sample Panel Data Selection from the amp-core Database

Section B, in the bottom left of Figure 1.7, is where you select the data you would like to display in your custom panel. It is best to resize this section to easily set up the data you would like to view.

Under data source, you can select which database to use. amp_core is a PostgreSQL database for ANMS that contains health and status for the ANMS system and stores the information generated and used by the AMP network manager. The amp-core database is selected in the sample query provided in Figure 1.8.

Section C, on the right side of Figure 1.7, provides the settings for the panel. You can edit the title of the graph, the type of graph, and other attributes.

To build out a Grafana panel, select the amp_core database to display data from the manager. Then, choose the table or view from the database that you wish to display.

Next, select the columns you would like to use. The Generate SQL option may be useful to you if you are familiar with SQL.

Once the data for the panel is selected, you can preview the graph in Section A.

The Query Inspector button will display the results of the SQL query and is useful for debugging if the panel is not displaying correctly.

Additional information on the use of Grafana to build panels can be found in the detailed documentation available online [grafana-docs], including a tutorial on building a [grafana-dashboard] and instructions on how to customize [grafana-panels].

Figure 1.22. ARI String Input Toggle

The ANMS transcodes string ARIs to CBOR, which can then be sent to Agents. To perform this translation, toggle the switch at the top of the screen to select the ARI String Input option.

Figure 1.23. ARI String Transcoder

In the top input box, enter a string ARI (Ex: "ari://ietf/dtnma-agent/EDD/num-msg-rx") and select the SUBMIT button to transcode the given ARI. The CBOR generated by the ANMS will be populated in the table below the input options on the page, as shown in Figure 1.25.

Figure 1.24. Search Transcoded ARIs

To search the ARIs that have been transcoded by the ANMS, enter one of the following: 1. Transcoder Log ID 2. String ARI (URI) 3. CBOR

Next to the search button is the refresh button that can be used to refresh the entries in transcoder log id table. Entries are updated when new entries are submitted or when switching between pages.

Figure 1.25. Transcoded ARIs with String and CBOR Versions Shown

The transcoded ARIs are presented in the table at the bottom of the Build tab. The table provides the Transcoder Log ID, String form of the ARI, a description of what the provided string was parsed as (currently, all string input is parsed as a URI), the CBOR translation for the ARI, the URI, and details on transcoding errors if an issue with the input was detected.

Figure 1.26. ARI Builder Toggle

The ANMS allows a user to build ARIs from existing ADMs. To begin building an ARI, type in the search bar as shown in Figure 1.27 to filter available ARIs by type, ADM, or name. Also there is a checkbox to toggle if the ARI will be apart of an execution set. When selected a new correlator_nonce field will appear where a user can populate with a unique nonce that is used to track report sets generated by the execution set.

Figure 1.27. ARI Search Bar

The user may also choose an ARI from the drop down list, as shown in Figure 1.28.

Figure 1.28. Search Available ARIs

If the chosen ARI has parameters, input boxes will be provided for each required field. The parameters will be displayed as a comma separated list after the name of the ARI. ARIs with complex parameters include additional guidance for populating these required fields. For instance, an ARI Collection (AC) builder is provided for ARIs requiring an AC parameter, as shown in Figure 1.29. The left side of the screen allows a user to search for the ARI they want to add to the AC and the right-hand side of the screen displays the selected ARI(s).

Figure 1.29. ARI Parameter Input

ARI parameters can be searched and selected from a dropdown menu, similar to the search to initiate the ARI build process.

Figure 1.30. Selecting an ARI Parameter

When an ARI is selected from the search box on the left, it is populated in the box below, Selected ARIs. The finale ARI is updated automatically as new ARIs are added or removed from the AC.

Figure 1.31. ARI Parameter Added to an AC

For parameters that also require parameters, the system will generate additional input fields.

Figure 1.32. ARI Parameter Added to an AC with its own parameter

After all ARI parameters have been filled in, the system will generate the new string URI that is shown beneath the parameter fields. This string URI is sent via anms-core to the transcoder to be translated. The final result of the translation is displayed in the table at the bottom of the page, as depicted in Figure 1.34.

Figure 1.33. ARI in "pending" State

Figure 1.34. Translated ARI with Input String and CBOR Output

To start building a new ARI simply select the 'X' clear selected button on the right hand side of the search bar. This will reset the builder screen, making it ready for the user to select a new ARI to build.

Figure 1.35. reset ari builder area

The transcoded ARI table provides the following information:

The ANMS-generated CBOR in the table provides ARIs in the format Agents expect. To send the CBOR ARI to an Agent, click the value in the table. This will display all registered Agents. When an Agent is selected, the details for that Agent and the option to send a CBOR ARI is provided. This process is discussed in detail in Section 1.3.

Also included int the transcoder log table are checkboxes that can be used to send multiple ARI to the agents page at once. The values will be sent to the agents in the order in which they are selected in the transcoder log table. There is a button at the bottom of the table labeled Send to Agents that can be selected to send the ARIS to the Agents page.

Selecting the "Get ADMs" button, a user can refresh the table of supported ADMs. The table displays the Enumeration, Name, Namespace, Version, and Use Description associated with each ADM.

Figure 1.39. Supported ADMs

Selecting an ADM’s name will download the associated yang file.

Figure 1.40. Downloading ADM

The file selection option at the bottom of the ADMs page allows a user to add an ADM to the ANMS. Selecting the "Browse" button, the user can select any JSON ADM file from their local filesystem. Selecting the blue "Upload adm yang" button will upload the file and the ADM information is populated in the table above. Uploading an ADM causes updates to the ANMS database but will not extend these changes to registered agents. Updating individual agents would be an action that is specific to the environment in which the registered agents are deployed in.

Figure 1.41. Add an ADM by Uploading a JSON file

If the new ADM is not displayed in the table, it may be necessary to click the "Get ADMs" button to refresh the table contents.

To generate a report, the inspect or report-on control can be used. inspect accepts one parameter: 1. An ARI of the object(EDD, CONST, or VAR) that you would like to report the value of

report-on accepts two parameters: 1. An ARI Collection (AC) specifying the report template(s) that should be populated by the Agent. 2. A endpoint-or-uri identifying the Manager(s) that are the intended recipients of the report(s). Can be null.

First, navigate to the Build tab of the ANMS and toggle the switch at the top to use the ARI Builder. Check the Execution set box and enter in a unique nonce. In the ARI search box, find the AMP Agent report-on or inspect control. ari://ietf/dtnma-agent/CTRL/report-on(//ietf/amm-base/typedef/rpt-tgt/template,//ietf/network-base/typedef/endpoint-or-uri|/aritype/null/destinations) ari://ietf/dtnma-agent/CTRL/inspect(//ietf/amm-base/typedef/VALUE-OBJ/ref)

Figure 2.4. Inspect ARI

Next, the parameters for the control must be chosen. Select the object to be populated by the Agent.

Figure 2.5. Search for objects

For this sample workflow, the num-exec-succeeded EDD is selected with the Inspect control.

Figure 2.6. Full execution set with inspect control

The system create the AC and any additional parameter fields as needed. num-exec-succeeded does not require any parameters,

Now that all the parameters are filled out, select the SUBMIT ARI String button which will generate the string ARI. This string ARI is sent to the transcoder and will be available in the lower table after it has ben processed.

Resulting String ARI: ari:/EXECSET/n=42;(ari://ietf/dtnma-agent/CTRL/inspect(ari://ietf/dtnma-agent/EDD/num-exec-succeeded)) CBOR: 0x821482182A8564696574666B64746E6D612D6167656E742267696E7370656374818464696574666B64746E6D612D6167656E7423726E756D2D657865632D737563636565646564

Figure 2.7. Generate Report ARI and CBOR Representations

Now that the control has been built, the CBOR can be sent to the desired Agent(s). Click the CBOR entry for the translated ARI and the UI will redirect to the Agents tab.

From the available agent table, select the Agent(s) to send the control to. In Figure 2.8, the Agent address selected ipn:2.6.

Figure 2.8. Manage Agent ipn:2.6

Select the Manage button to open a menu of options for Agent handling. The input field for a Text Input will be auto-filled with the CBOR selected from the Build tab. Select the Submit button and then Send to send the CBOR command to the Agent.

Figure 2.9. Auto-filled CBOR in RAW Command Field

After successfully sending the control to the Agent a success popup should be displayed in the upper right portion of the screen.

TODO

Figure 2.10. Generate Report ARI and CBOR Representations

Now that the control has been built, the CBOR can be sent to the desired Agent(s). Click the CBOR entry for the translated ARI and the UI will redirect to the Agents tab.

At the bottom of the page, fill in the address of the Agent (or a comma separated list if providing multiple Agents) to send the control to. In Figure 2.11, the Agent address is ipn:2.6.

Figure 2.11. Manage Agent ipn:2.6

Select the Manage button to open the modal for Agent handling. The input box for a Text Input will be auto-filled with the CBOR selected from the Build tab. Select the Submit button to send the CBOR command to the Agent.

TODO

Figure 2.12. Auto-filled CBOR in RAW Command Field

After successfully sending the control to the Agent a success popup should be displayed in the upper right portion of the screen.

TODO

Figure 2.13. Command Sent Successfully