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, “Grafana Panel Creation Wizard” 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, “Grafana Panel Creation Wizard”, 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, “Sample Panel Data Selection from the amp-core Database”.

Section C, on the right side of Figure 1.7, “Grafana Panel Creation Wizard”, 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:/IANA:bp_agent/EDD.endpoint_names") 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, “Transcoded ARIs with String and CBOR Versions Shown”.

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

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, “ARI Search Bar” to filter available ARIs by type, ADM, or name.

Figure 1.27. ARI Search Bar

The user may also choose an ARI from the drop down list, as shown in Figure 1.28, “Search Available ARIs”.

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.

Figure 1.29. ARI Parameter Input

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.30, “Sample ARI with an AC Parameter”. 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.30. Sample ARI with an AC Parameter

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

Figure 1.31. 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 automaticly as new ARIs are added or removed from the AC.

Figure 1.32. ARI Parameter Added to an AC

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

Figure 1.33. 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.35, “Translated ARI with Input String and CBOR Output”.

Figure 1.34. ARI in "pending" State

Figure 1.35. Translated ARI with Input String and CBOR Output

To start building a new ARI simply select the 'X' clear seleceted 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.36. 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, “Agents”.

Selecting the "Get ADMs" button, a user can refresh the table of supported ADMs. The table displays the enumeration, ADM name, Namespace, version, and description associated with each ADM.

Figure 1.40. Supported ADMs

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

Figure 1.41. Downlaoding 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 json" button will upload the file and the ADM information is populated in the table above.

Figure 1.42. 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 AMP Agent gen_rpts control is used. This control accepts two parameters: 1. An ARI Collection (AC) specifying the report template(s) (RPTTs) that should be populated by the Agent. 2. A Type-Name-Value Collection (TNVC) identifying the Manager(s) that are the intended recipients of the report(s).

First, navigate to the Build tab of the ANMS and toggle the switch at the top to use the ARI Builder. In the ARI search box, find the AMP Agent gen_rpts control. ari:/IANA:amp_agent/CTRL.gen_rpts(AC, TNVC)

Figure 2.4. Generate Report ARI

Next, the parameters for the control must be chosen. Select the report templates (RPTTs) to be populated by the Agent and add them to the AC.

Figure 2.5. Search for RPTTs to Add to the AC

For this sample workflow, the AMP Agent Full Report and BP Agent Endpoint Report templates have been selected.

Figure 2.6. Full Report and Endpoint Report Selected for AC

The system create the AC and any additional parameter fields as needed. The AMP Agent Full Report does not require any parameters, but the BP Agent Endpoint Report requires a string identifying the endpoint(s) for which the report should be generated for. This input option is generated when added the RPTT is added to the AC, as shown in Figure 2.7, “Endpoint Report Parameter”.

Figure 2.7. Endpoint Report Parameter

Enter the desired endpoint - in the case of this example, "ipn:2.6" is used. The AC is updated automaticly to include the parameter value, as seen in Figure 2.8, “AC Updated with Endpoint Report Parameter "ipn:2.6"”.

Figure 2.8. AC Updated with Endpoint Report Parameter "ipn:2.6"

The second parameter for the gen_rpts control is a type-name-value collection: rxmgrs. This parameter specifies the Manager(s) that will receive the generated report(s). This is not a required parameter when just using the gen_rpts command. By default, the reports generated by this control will be sent to the Manager that issued the control. If this default option is desired, leave these fields blank.

Figure 2.9. Optional Receiving Managers Parameter

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:/IANA:amp_agent/CTRL.gen_rpts([ari:/IANA:amp_agent/RPTT.full_report,ari:/IANA:bp_agent/RPTT.endpoint_report("ipn:2.6")],[]) CBOR: 0xC115410505022523828718194100C7182D41010501274769706E3A322E3600

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.

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

Figure 2.11. 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.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.

To generate a tabular report, the AMP Agent gen_tbls control is used. This control accepts two parameters: 1. An ARI Collection (AC) specifying the tabular report template(s) (TBLTs) that should be populated by the Agent. 2. A Type-Name-Value Collection (TNVC) identifying the Manager(s) that are the intended recipients of the tabular report(s).

First, navigate to the Build tab of the ANMS and toggle the switch at the top to use the ARI Builder. In the ARI search box, find the AMP Agent gen_tbls control. ari:/IANA:amp_agent/CTRL.gen_tbls(AC, TNVC)

Figure 2.13. Generate Tabular Report ARI

Next, the parameters for the control must be chosen. Select the tabular report templates (TBLTs) to be populated by the Agent and add them to the AC.

Figure 2.14. Search for TBLTs to Add to the AC

For this sample workflow, the AMP Agent ADM Tabular Report template is selected, to determine the ADMs known to the Agent.

Figure 2.15. ADM Tabular Report Selected for AC

The AC and any additional parameter fields will update automaticly as needed. Since the ADM Tabular Report does not require any further parameters the AC parameter is ready.

The second parameter for the gen_tbls control is a type-name-value collection: rxmgrs. This parameter specifies the Manager(s) that will receive the generated tabular report(s). This is not a required parameter. By default, the tabular reports generated by this control will be sent to the Manager that issued the control. If this default option is desired, leave these fields blank.

Figure 2.16. Optional Receiving Managers Parameter

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:/IANA:amp_agent/CTRL.gen_tbls([ari:/IANA:amp_agent/TBLT.adms],[]) CBOR: 0xC115410605022523818A181B410000

TODO

Figure 2.17. 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.18, “Manage Agent ipn:2.6”, the Agent address is ipn:2.6.

Figure 2.18. 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.19. 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.20. Command Sent Successfully

This feature is not currently supported by the ANMS.

A State-Based Rule (SBR) can be used to specify an action that should be executed by the Agent when a particular internal state is identified. This state information may be obtained from one of the applications or services associated with the Agent.

For the purpose of this example, a SBR is created to instruct an Agent to TODO

Use the Build tab to construct the add_sbr ARI, which follows the form ari:/IANA:amp_agent/CTRL.add_sbr(ARI, TV, EXPR, UVAST, UVAST, AC, STR).

The add_sbr control has the following parameters:

Populate these parameters in the fields provided by the ANMS. The ARI will update as new parameters are populated.

Figure 2.21. Sample SBR Parameters

After finalizing the parameters, click the SUBMIT Ari String button to send the ARI to the transcoder to be translated.

Resulting String ARI: ari:/IANA:amp_agent/CTRL.add_sbr(ari:/SBR.ex,0,(BOOL)[ari:/IANA:amp_agent/EDD.run_tbr,ari:/IANA:amp_agent/EDD.run_sbr,ari:/IANA:amp_agent/OPER.Equal],30,20,[ari:/IANA:amp_agent/CTRL.gen_rpts([ari:/IANA:amp_agent/RPTT.full_report],["ipn:1.7"])],"generate a report when run_sbr = run_tbr") CBOR: 0xC115410B050724152615152512084265780010838216410482164106851818421831181E1481C1154105050225238187181941000501126769706E3A312E37782867656E65726174652061207265706F7274207768656E2072756E5F736272203D2072756E5F746272

TODO: add a reference to section for issuing commands to the agent.

A Time-Based Rule (TBR) can be used to instruct an Agent to send a report at a user-specified time interval.

For the purpose of this example, a TBR is created to instruct an Agent to send an AMP Agent Full Report to the local Manager every 60 seconds, until 100 reports have been sent.

The process is similar to generating a report command, but with a few additional parameters.

Use the Build tab to construct the add_tbr ARI, which follows the form ari:/IANA:amp_agent/CTRL.add_tbr(ARI, TV, TV, UVAST, AC, STR).

The add_tbr control has the following parameters:

Populate these parameters in the fields provided by the ANMS, selecting Create AC and Submit AC to build the Action AC.

Figure 2.22. Sample TBR Parameters

After finalizing the parameters, click the SUBMIT for add_tbr button to send the ARI to the transcoder to be translated.

Resulting String ARI: ari:/IANA:amp_agent/CTRL.add_tbr(ari:/tbr.ex,TV.0,TV.60,UVAST.100,[ari:/IANA:amp_agent/CTRL.gen_rpts([ari:/IANA:amp_agent/RPTT.full_report],["ipn:1.7])],"gen full rpt") CBOR: 0xC115410A05062420201625120B42657800183C186481C115410505022523818718194100006C67656E2066756C6C20727074

TODO: add a reference to section for issuing commands to the agent.