Changing the configuration of an agent using the REST API

Instructions and examples in this document use an IP address that is reserved for documentation, 192.0.2.5, as an example of the IP address for the switch. To access your switch, you must use the IP address or hostname of that switch.

Prerequisites
  • You must be logged in to the switch REST API with a user name that has administrator rights.

  • The switch REST API access mode must be read-write.

Procedure
  1. Disable the agent.

    For example:

    PUT https://192.0.2.5/rest/v1/system/nae_scripts/com.arubanetworks.bgp_monitor/nae_agents/com.arubanetworks.bgp_monitor.Agent1
    {
         "disabled":true
    }
  2. Update and enable the agent by using the PUT method on the URI of the agent.

    The PUT method replaces the agent specified by the URI. If the agent has multiple parameters in parameters_values, any parameters that you do not specify in the PUT method are reset to their default values.

    This example changes the value of the short-term high threshold for com.arubanetworks.bgp_monitor.Agent1 to 22.

    PUT https://192.0.2.5/rest/v1/system/nae_scripts/com.arubanetworks.bgp_monitor/nae_agents/com.arubanetworks.bgp_monitor.Agent1
    {
         "disabled":false,
         "parameters_values":{
               "short_term_high_threshold":"22"
          }
    }