Skip to content

Add Discover local servers#3059

Merged
renetapopova merged 8 commits into
neo4j:devfrom
renetapopova:dev-fleet-discover
May 15, 2026
Merged

Add Discover local servers#3059
renetapopova merged 8 commits into
neo4j:devfrom
renetapopova:dev-fleet-discover

Conversation

@renetapopova
Copy link
Copy Markdown
Collaborator

No description provided.

Comment thread modules/ROOT/pages/monitoring/fleet-management.adoc Outdated
Comment thread modules/ROOT/pages/monitoring/fleet-management.adoc Outdated
Comment thread modules/ROOT/pages/monitoring/fleet-management.adoc Outdated
Comment thread modules/ROOT/pages/monitoring/fleet-management.adoc Outdated
Comment thread modules/ROOT/pages/monitoring/fleet-management.adoc
@renetapopova
Copy link
Copy Markdown
Collaborator Author

renetapopova commented May 12, 2026

@SeBBBe, the release notes also mention "additional options for saving the output to a file in different formats and providing a token which can be used for bulk registration into Fleet Manager," as well as some limitations and configurations. Do you think they refer to the registration code as a token, and if so, is it true that the code is always one regardless of the number of servers? What if I want to monitor 3 out of my 5 local servers?

Here are the quotes from the draft Release notes:

"The server now includes the Neo4j discovery service which can be used to identify running Neo4j deployments on the network. See neo4j-admin section for details of how to use the client. See DOCS for details of limitations and configuration."

"Added client utility for the Neo4j discovery service which can be used to identify running Neo4j deployments on the network. Basic usage is ‘neo4j-admin fleet discover’ which will provide a list to the terminal of discovered services. Additional options allow saving to a file in different formats and providing a token which can be used for bulk registration into Fleet Manager."

@SeBBBe
Copy link
Copy Markdown
Contributor

SeBBBe commented May 12, 2026

@SeBBBe, the release notes also mention "additional options for saving the output to a file in different formats and providing a token which can be used for bulk registration into Fleet Manager," as well as some limitations and configurations. Do you think they refer to the registration code as a token

I think it actually doesn't. The default output from the command is pretty print + the code. But it's also possible to get json or csv output, either to file or in the terminal. It doesn't seem like all the other commands have the complete list of optional parameters documented in the ops manual, so I didn't find the appropriate place this should be added. Or maybe I'm wrong?

The help output from the command itself explains it pretty well:

> ./neo4j-admin fleet discover --help

Discover and list Neo4j servers

USAGE

neo4j-admin fleet discover [-h] [--expand-commands] [--verbose] [--filename=<filename>] [--format=<format>]
                           [--timeout=<timeout>]

DESCRIPTION

Listen for Neo4j fleet discovery broadcasts on the local network and list all discovered Neo4j servers.

OPTIONS

      --expand-commands     Allow command expansion in config value evaluation.
      --filename=<filename> Optional filename to which discovered servers will be written
      --format=<format>     Output format (pretty, csv, json)
                              Default: Pretty
  -h, --help                Show this help message and exit.
      --timeout=<timeout>   Timeout in seconds
                              Default: 60
      --verbose             Enable verbose output.

is it true that the code is always one regardless of the number of servers? What if I want to monitor 3 out of my 5 local servers?

Yes, this is accurate. The choice of which servers to monitor will be made in the Aura Console after the full code is pasted (UI flow: neo4j/docs-aura#991)

@renetapopova
Copy link
Copy Markdown
Collaborator Author

@SeBBBe, thank you so much for the clarifications. I'll update the PR and create a separate page for the command.

Copy link
Copy Markdown
Collaborator

@NataliaIvakina NataliaIvakina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think everything looks good!
The test fails because of the missing periods in the code

@renetapopova
Copy link
Copy Markdown
Collaborator Author

The test failure should be fixed when we merge this PR https://github.com/neo-technology/neo4j/pull/37510.

@neo4j-docops-agent
Copy link
Copy Markdown
Collaborator

neo4j-docops-agent commented May 15, 2026

Thanks for the documentation updates.

The preview documentation has now been torn down - reopening this PR will republish it.

@renetapopova renetapopova merged commit f17a0b5 into neo4j:dev May 15, 2026
5 checks passed
@renetapopova renetapopova deleted the dev-fleet-discover branch May 15, 2026 11:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants