au3 sync-agent & au3 sync-agent-manager — Command Reference
CLI command groups: au3 sync-agent, au3 sync-agent-manager
Commands for managing sync agents, sync agent plugins, and sync agent connections — plus the separate sync-agent-manager group for publishing manager versions.
Sections
Section
Commands
Sync agent (top-level)
10
Sync agent plugin (sub-group)
9
Sync agent connection (sub-group)
9
sync-agent-manager (separate group)
2
au3 sync-agent
au3 sync-agent list
List sync agents
Option
Type
Required
Default
Notes
--fields
string
Comma-separate list of fields to display
--filter
string
Filter in JSON/YAML format or path to file containing filter
--sort
string
Ordered list of fields to sort by in JSON/YAML format or path to file containing sorting
--search
string
Search in JSON/YAML format or path to file containing search
--limit
100
Number of results to fetch
--skip
Number of results to skip
--all
boolean
false
Whether to fetch results from all pages
--stream
boolean
false
Whether to print results as they are received without buffering (as JSON)
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 sync-agent view
View sync agent
Option
Type
Required
Default
Notes
--id
string
✅
sync agent id
--fields
string
comma-separated list of fields to display
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 sync-agent create
Create sync agent
Option
Type
Required
Default
Notes
--name
string
✅
name of the sync agent
--description
string
description of the sync agent
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 sync-agent update
Update sync agent
Option
Type
Required
Default
Notes
--spec-schema
boolean
view the schema for update
--spec
string
spec in JSON/YAML format or path to file containing spec
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
--spec payload reference
Schema ID: UpdateSyncAgentArgumentDto
This section documents the --spec payload accepted by au3 sync-agent update. Run sync-agent update --spec-schema to fetch this schema live from the CLI at any time.
Tip: additionalProperties: false — the schema rejects any field not listed below.
Top-Level Fields
Field
Type
Required
Notes
id
string
Sync agent id — Pattern: ^sagt-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. sagt-123e4567-e89b-41d2-a345-678901234567
name
string
Object name with 2-64 characters — 2–64 characters
description
string
Object description with 0 or 2-256 characters — Pattern: (^$)|(^.{2,256}$) — 0–256 characters
tags
array
List of tags
deployment_config
string
Stringified JSON
blackout_manual_pause
boolean
Whether manual pause is enabled
blackout_windows
array
blackout_windows (array items)
Field
Type
Required
Notes
enabled
boolean
✅
Whether the blackout window is enabled
timezone
enum
✅
Timezone for the blackout window, either local or UTC — Choices: local, utc
start_time
string
✅
Time of day the blackout window starts in HH:mm:ss format — Pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$ — e.g. 19:51:26
end_time
string
✅
Time of day the blackout window ends in HH:mm:ss format — Pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$ — e.g. 19:51:26
days_of_week
array
Days of the week the blackout window applies to, where 0=Sunday, 1=Monday, ..., 6=Saturday
Example Spec
name : <string>
description : <string>
au3 sync-agent delete
Delete sync agent
Option
Type
Required
Default
Notes
--id
string
✅
The sync agent id
--trash
boolean
Whether the sync agent should be trashed (true) or deleted (false). Defaults to true
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 sync-agent issue-registration-token
Issue sync agent registration token
Option
Type
Required
Default
Notes
--id
string
✅
sync agent id
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 sync-agent register
Register sync agent
Option
Type
Required
Default
Notes
--token
string
✅
sync agent registration token
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 sync-agent publish-version
Publish sync agent version
Option
Type
Required
Default
Notes
--spec-schema
boolean
view the schema for publish
--spec
string
spec in JSON/YAML format or path to file containing spec
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
--spec payload reference
Schema ID: PublishSyncAgentVersionArgumentDto
This section documents the --spec payload accepted by au3 sync-agent publish-version. Run sync-agent publish-version --spec-schema to fetch this schema live from the CLI at any time.
Top-Level Fields
Field
Type
Required
Notes
token
string
✅
Authentication token
base_url
string
Base url to upload the packages to — Default: https://gitlab.aunsight.com/api/v4/projects/14/packages/generic
artifacts
object
✅
version
string
✅
Installation release version — Pattern: ^([a-zA-Z_]+(-beta)?)|([0-9]+(\.[0-9]+){0,2}(-beta)?)$
artifacts
Field
Type
Required
Notes
linux
object
osx
object
windows
object
linux
Field
Type
Required
Notes
agent
string
✅
Path to the sync agent pkg binary
workload
string
✅
Path to the compute workload pkg binary
osx
Field
Type
Required
Notes
agent
string
✅
Path to the sync agent pkg binary
workload
string
✅
Path to the compute workload pkg binary
windows
Field
Type
Required
Notes
agent
string
✅
Path to the sync agent pkg binary
workload
string
✅
Path to the compute workload pkg binary
Example Spec
token : <string>
artifacts : {}
version : <string>
au3 sync-agent update-version
Update sync agent version
Option
Type
Required
Default
Notes
--id
string
✅
sync agent id
--agent-version
string
✅
sync agent version
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 sync-agent sync-agent-plugin
au3 sync-agent sync-agent-plugin list
List sync agent plugins
Option
Type
Required
Default
Notes
--fields
string
Comma-separate list of fields to display
--filter
string
Filter in JSON/YAML format or path to file containing filter
--sort
string
Ordered list of fields to sort by in JSON/YAML format or path to file containing sorting
--search
string
Search in JSON/YAML format or path to file containing search
--limit
100
Number of results to fetch
--skip
Number of results to skip
--all
boolean
false
Whether to fetch results from all pages
--stream
boolean
false
Whether to print results as they are received without buffering (as JSON)
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 sync-agent sync-agent-plugin view
View sync agent plugin
Option
Type
Required
Default
Notes
--id
string
✅
sync agent plugin id
--fields
string
comma-separated list of fields to display
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 sync-agent sync-agent-plugin update
Update sync agent plugin
Option
Type
Required
Default
Notes
--spec-schema
boolean
view the schema for update
--spec
string
spec in JSON/YAML format or path to file containing spec
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
--spec payload reference
Schema ID: UpdateSyncAgentPluginArgumentDto
This section documents the --spec payload accepted by au3 sync-agent sync-agent-plugin update. Run sync-agent sync-agent-plugin update --spec-schema to fetch this schema live from the CLI at any time.
Tip: additionalProperties: false — the schema rejects any field not listed below.
Top-Level Fields
Field
Type
Required
Notes
id
string
Sync agent plugin id — Pattern: ^sapi-[0-9A-Za-z]+[0-9A-Za-z-]*$ — e.g. sapi-mssql
name
string
Object name with 2-64 characters — 2–64 characters
description
string
Object description with 0 or 2-256 characters — Pattern: (^$)|(^.{2,256}$) — 0–256 characters
tags
array
List of tags
logo
string
Object logo image in base64 url encoded png/jpg format. 100x100px max. — 0–50000 characters
oauth
boolean
Whether the plugin requires OAuth authentication
oauth_configuration
object
oauth_configuration
Field
Type
Required
Notes
client_id
string
✅
OAuth client ID
client_secret
string
✅
OAuth client secret
configuration_json
string
✅
Stringified JSON
Example Spec
name : <string>
description : <string>
au3 sync-agent sync-agent-plugin create
Create sync agent plugin
Option
Type
Required
Default
Notes
--id
string
✅
id of the sync agent plugin
--name
string
✅
name of the sync agent plugin
--description
string
description of the sync agent plugin
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 sync-agent sync-agent-plugin create-version
Create sync agent plugin version
Option
Type
Required
Default
Notes
--spec-schema
boolean
view the schema for update
--spec
string
spec in JSON/YAML format or path to file containing spec
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
--spec payload reference
Schema ID: CreateSyncAgentPluginVersionArgumentDto
This section documents the --spec payload accepted by au3 sync-agent sync-agent-plugin create-version. Run sync-agent sync-agent-plugin create-version --spec-schema to fetch this schema live from the CLI at any time.
Tip: additionalProperties: false — the schema rejects any field not listed below.
Top-Level Fields
Field
Type
Required
Notes
id
string
✅
Sync agent plugin id — Pattern: ^sapi-[0-9A-Za-z]+[0-9A-Za-z-]*$ — e.g. sapi-mssql
version
string
✅
Semantic version string — Pattern: ^([a-zA-Z_]+(-beta)?)|([0-9]+(\.[0-9]+){0,2}(-beta)?)$
change_notes
string
✅
Notes about the changes in this version
artifact_urls
object
✅
URLs for all os versions of the plugin
deprecated
boolean
✅
Whether plugin version is deprecated and usage should be updated
configuration_schema
string
✅
JSON schema governing configuration. Used to generate forms and validate.
configuration_init
string
✅
Initial configuration object with default values
executable
string
✅
Name of the executable file
plugin_api_version
enum
✅
Version of the API that the plugin supports — Choices: v1
bucket
object
✅
Bucket-related metadata
warehouse
object
✅
Warehouse-related metadata
artifact_urls
URLs for all os versions of the plugin
Field
Type
Required
Notes
linux
string
Public URL to the published plugin version artifact — Format: uri
osx
string
Public URL to the published plugin version artifact — Format: uri
windows
string
Public URL to the published plugin version artifact — Format: uri
bucket
Bucket-related metadata
Field
Type
Required
Notes
supported
boolean
✅
Whether the plugin supports the bucket interface
warehouse
Warehouse-related metadata
Field
Type
Required
Notes
supported
boolean
✅
Whether the plugin supports the warehouse interface
Example Spec
id : sapi-mssql
version : <string>
change_notes : <string>
artifact_urls : {}
deprecated : true
configuration_schema : <string>
configuration_init : <string>
executable : <string>
plugin_api_version : v1
bucket :
supported : true
warehouse :
supported : true
au3 sync-agent sync-agent-plugin view-version
View sync agent plugin version
Option
Type
Required
Default
Notes
--id
string
✅
sync agent plugin id
--version-id
string
✅
sync agent plugin version
--fields
string
comma-separated list of fields to display
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 sync-agent sync-agent-plugin view-oauth-configuration
View sync agent plugin oauth configuration
Option
Type
Required
Default
Notes
--id
string
✅
sync agent plugin id
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 sync-agent sync-agent-plugin publish-version
Publish sync agent plugin version
Option
Type
Required
Default
Notes
--spec-schema
boolean
view the schema for publish
--spec
string
spec in JSON/YAML format or path to file containing spec
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
--spec payload reference
Schema ID: PublishPluginVersionArgumentDto
This section documents the --spec payload accepted by au3 sync-agent sync-agent-plugin publish-version. Run sync-agent sync-agent-plugin publish-version --spec-schema to fetch this schema live from the CLI at any time.
Top-Level Fields
Field
Type
Required
Notes
token
string
✅
Authentication token
base_url
string
Base url to upload the packages to — Default: https://gitlab.aunsight.com/api/v4/projects/14/packages/generic
artifacts
object
✅
id
string
✅
Sync agent plugin id — Pattern: ^sapi-[0-9A-Za-z]+[0-9A-Za-z-]*$ — e.g. sapi-mssql
version
string
✅
Semantic version string — Pattern: ^([a-zA-Z_]+(-beta)?)|([0-9]+(\.[0-9]+){0,2}(-beta)?)$
artifacts
Field
Type
Required
Notes
linux
object
osx
object
windows
object
linux
Field
Type
Required
Notes
local
string
✅
Path to the local artifact to upload
osx
Field
Type
Required
Notes
local
string
✅
Path to the local artifact to upload
windows
Field
Type
Required
Notes
local
string
✅
Path to the local artifact to upload
Example Spec
token : <string>
artifacts : {}
id : sapi-mssql
version : <string>
au3 sync-agent sync-agent-connection
au3 sync-agent sync-agent-connection list
List sync agent connections
Option
Type
Required
Default
Notes
--fields
string
Comma-separate list of fields to display
--filter
string
Filter in JSON/YAML format or path to file containing filter
--sort
string
Ordered list of fields to sort by in JSON/YAML format or path to file containing sorting
--search
string
Search in JSON/YAML format or path to file containing search
--limit
100
Number of results to fetch
--skip
Number of results to skip
--all
boolean
false
Whether to fetch results from all pages
--stream
boolean
false
Whether to print results as they are received without buffering (as JSON)
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 sync-agent sync-agent-connection view
View sync agent connection
Option
Type
Required
Default
Notes
--id
string
✅
sync agent connection id
--fields
string
comma-separated list of fields to display
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 sync-agent sync-agent-connection create
Create sync agent connection
Option
Type
Required
Default
Notes
--name
string
✅
name of the sync agent connection
--description
string
description of the sync agent connection
--agent
string
✅
id of the sync agent
--plugin
string
✅
id of the sync agent plugin
--plugin-version
string
✅
version of the sync agent plugin
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 sync-agent sync-agent-connection update
Update sync agent connection
Option
Type
Required
Default
Notes
--id
string
✅
sync agent connection id
--name
string
sync agent connection name
--description
string
sync agent connection description
--tags
string
comma-separated list of tags
--configuration
string
configuration in JSON/YAML format or path to file containing spec
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 sync-agent sync-agent-connection delete
Delete sync agent connection
Option
Type
Required
Default
Notes
--id
string
✅
The sync agent connection id
--trash
boolean
Whether the sync agent connection should be trashed (true) or deleted (false). Defaults to true
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 sync-agent sync-agent-connection test-connection
Test sync agent connection
Option
Type
Required
Default
Notes
--id
string
✅
Id of sync agent connection to test
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 sync-agent sync-agent-connection discover-buckets
Discover buckets sync agent connection
Option
Type
Required
Default
Notes
--id
string
✅
Id of sync agent connection
--path
string
Path to discover
--include-patterns
string
List of patterns to include when searching for files
--exclude-patterns
string
List of patterns to exclude when searching for files
--depth
number
1
Depth to discover
--walk
string
BFS
Walk type
--include-directory
boolean
true
Whether to include directories
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 sync-agent sync-agent-connection discover-warehouses
Discover warehouses sync agent connection
Option
Type
Required
Default
Notes
--id
string
✅
Id of sync agent connection
--create-empty-warehouse
boolean
false
Create an empty warehouse if none are discovered
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
au3 sync-agent-manager
au3 sync-agent-manager publish-version
Publish sync agent manager version
Option
Type
Required
Default
Notes
--spec-schema
boolean
view the schema for publish
--spec
string
spec in JSON/YAML format or path to file containing spec
--fmt
enum
human
Output format Choices: "human", "json", "yaml"
--debug
boolean
false
Enable more verbose output on error
--spec payload reference
Schema ID: PublishSyncAgentManagerVersionArgumentDto
This section documents the --spec payload accepted by au3 sync-agent-manager publish-version. Run sync-agent-manager publish-version --spec-schema to fetch this schema live from the CLI at any time.
Top-Level Fields
Field
Type
Required
Notes
token
string
✅
Authentication token
base_url
string
Base url to upload the packages to — Default: https://gitlab.aunsight.com/api/v4/projects/14/packages/generic
artifacts
object
✅
version
string
✅
Semantic version string — Pattern: ^([a-zA-Z_]+(-beta)?)|([0-9]+(\.[0-9]+){0,2}(-beta)?)$
artifacts
Field
Type
Required
Notes
linux
object
osx
object
windows
object
linux
Field
Type
Required
Notes
manager
string
✅
Path to the sync agent manager pkg binary
nssm
string
✅
Path to the nssm binary
osx
Field
Type
Required
Notes
manager
string
✅
Path to the sync agent manager pkg binary
nssm
string
✅
Path to the nssm binary
windows
Field
Type
Required
Notes
manager
string
✅
Path to the sync agent manager pkg binary
nssm
string
✅
Path to the nssm binary
Example Spec
token : <string>
artifacts : {}
version : <string>
Generated from au3 sync-agent --help, au3 sync-agent-manager --help, and subcommand help output.