(408) 943-4100               V   Commercial Support

servers/reconnect

  1 minute read.

Last Modified 2021-02-04 11:38 EST
NamespaceNameAdmin OnlyLog SummaryGenerates EventVersion Added
serversreconnectnonono1.3

Description

Trigger TrueCommand to attempt to restart the connection to designated NAS’s. This can be run for any NAS that the user has write-access to.

Update status is reported via the servers/list API output.

Input Arguments

  • Required: “id” (string or JSON Array of strings) : System ID’s for which systems to queue up reconnections
  • Optional:
    • none ({})

Request Example Arguments

ARGUMENTS ONLY: See the basics of API requests for additional formatting information.

{
  "id" : "server_id_1"
}

Reply Example

  • Example Reply Arguments (success):
{
  "result" : "success",
  "restart_queued" : ["server_id_1"]
}
  • Example Reply Arguments (incompatible version of NAS):
{
  "result" : "failure"
}

Events

This API call does not emit any middleware events.

Log Summary

This API call does not generate a detailed log summary item

See Also