Skip to content

Commit b27a217

Browse files
Merge pull request #12389 from nextcloud/feat-files-external-scan
feat(admin): Add command to scan external storages directly
2 parents 6bfd88a + 31815f2 commit b27a217

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

admin_manual/occ_command.rst

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -965,27 +965,32 @@ Commands for handling shares::
965965
Files external
966966
--------------
967967

968+
These commands are used for managing Nextcloud's *External Storage* feature. In
969+
addition to replicating the configuration capabilities in the Web UI, additional
970+
capabilities include exporting / importing configurations, scanning *External
971+
Storage* mounts that require login credentials, and configuring update notifications
972+
(if supported by the storage type).
973+
968974
.. note::
969975
These commands are only available when the "External storage support" app
970976
(``files_external``) is enabled.
971977

972-
Commands for managing external storage::
978+
Available commands for the "files_external" namespace::
973979

974-
files_external
975980
files_external:applicable Manage applicable users and groups for a mount
976981
files_external:backends Show available authentication and storage backends
977982
files_external:config Manage backend configuration for a mount
978983
files_external:create Create a new mount configuration
979984
files_external:delete Delete an external mount
980985
files_external:export Export mount configurations
981986
files_external:import Import mount configurations
982-
files_external:list List configured mounts
987+
files_external:list List configured admin or personal mounts
988+
files_external:notify Listen for active update notifications for a configured external mount
983989
files_external:option Manage mount options for a mount
990+
files_external:scan Scan an external storage for changed files
984991
files_external:verify Verify mount configuration
985-
files_external:notify Listen for active update notifications for a configured external mount
986992

987-
These commands replicate the functionality in the Nextcloud Web GUI, plus two new
988-
features: ``files_external:export`` and ``files_external:import``.
993+
``files_external:scan`` provides the ability to provide a username and/or password for cases where login credentials are used.
989994

990995
Use ``files_external:export`` to export all admin mounts to stdout, and
991996
``files_external:export [user_id]`` to export the mounts of the specified

0 commit comments

Comments
 (0)