Plugin procedures

The fleet management plugin provides a set of procedures to manage and monitor the connection to Aura. These procedures can be executed in Neo4j Browser or any other Neo4j client.

Procedure Description Arguments Return

fleetManagement.status

Check the current status of the plugin and its connectivity to Aura.

-

Boolean active, Boolean connected, String statusMessage

fleetManagement.registerToken

Register the deployment with Aura using the provided registration token and start reporting.

String token

String

fleetManagement.disable

Disconnect from Aura, remove the existing token and disable the fleet management feature.

-

String

fleetManagement.reportedData

Obtain a complete listing of all data the plugin is reporting to Aura. A copy of this data can be found on the Data transparency page.

-

Array of (String messageType, String fieldPath, String description, String fieldType, String values)

fleetManagement.debugLogging

Enable or disable debug and traffic logging

Boolean debugLogging, Boolean trafficLogging

String

fleetManagement.inspectToken

Inspect the Neo4j Fleet Management token to validate the Aura project association and expiry.

String token (Optional, if omitted, the currently used token will be inspected)

Array of (String projectId, String tokenExpires, String errorMessage)

fleetManagement.restart

Restarts the plugin by resetting the state and reconnecting to the API.

-

String