Command-line reference

Every command and option in netaudio 0.4.2, released October 11, 2026.

This page is generated from the published package, so it matches what uv tool install netaudio installs. Run netaudio COMMAND --help to see the same text in a terminal. For the daemon’s routes, see the HTTP API reference.

Commands

Global options
clock: Show PTP clock status (leader, followers, preferred leader).
status: Show all discovered network audio devices.
channel: Manage channels on the selected device.
config: Manage netaudio configuration.
daemon: Manage the netaudio daemon.
ddm: Discover Dante Domain Manager or query its Managed API. GraphQL queries and mutations are generated from the bundled schema; status, devices, and refresh read the daemon's inventory.
device: Manage Dante devices.
discovery: Request network service discovery.
events: Inspect the daemon's retained monitoring event journal.
flow: Inspect receiver flows and manage transmitter multicast flows on the selected device.
issues: Inspect current and resolved monitoring issues without changing devices.
lock: Device lock management.
meter: Device metering.
preset: Save and load device presets (DC-compatible XML).
report: Report issues with diagnostic context.
shure: Shure wireless device control.
subscription: Manage audio subscriptions.
virtual: Virtual Dante device.

Global options

CLI for managing network audio devices. Global options go before the command, as in netaudio -n 'avio-*' device list.

-n, --name

Filter by device name (glob).

Value: text. Can be given more than once. Environment variable: NETAUDIO_NAME.

--host

Filter by device IP.

Value: text. Can be given more than once. Environment variable: NETAUDIO_HOST.

-s, --server-name

Filter by mDNS server name (glob).

Value: text. Can be given more than once. Environment variable: NETAUDIO_SERVER_NAME.

-m, --mac

Filter by MAC address (any format).

Value: text. Can be given more than once. Environment variable: NETAUDIO_MAC.

-o, --output

Output format.

Value: plain, table, pretty, json, xml, csv, yaml. Default: plain. Environment variable: NETAUDIO_OUTPUT.

-j, --json

Shorthand for --output=json.

--sort

Sort field[:asc|desc]. Fields: mac, name, ip, model, server-name.

Value: text. Default: mac. Environment variable: NETAUDIO_SORT.

--no-color

Disable colored output.

Environment variable: NETAUDIO_NO_COLOR.

--timeout

mDNS discovery timeout in seconds.

Value: number. Default: 5.0. Environment variable: NETAUDIO_TIMEOUT.

--verify

Wait for each change to be confirmed by a fresh readback instead of sending it and returning.

Environment variable: NETAUDIO_VERIFY.

--lock-state-timeout

Lock state collection timeout in seconds.

Value: number. Default: 4.0. Environment variable: NETAUDIO_LOCK_STATE_TIMEOUT.

--interface

Use only this network interface for discovery and device control.

Value: text. Environment variable: NETAUDIO_INTERFACE.

--context

DDM server/domain context to use.

Value: text. Environment variable: NETAUDIO_CONTEXT.

--log-level

Log level (DEBUG, INFO, WARNING, ERROR, CRITICAL).

Value: text. Default: WARNING. Environment variable: NETAUDIO_LOG_LEVEL.

--debug

Shorthand for --log-level DEBUG.

Environment variable: NETAUDIO_DEBUG.

-v, --verbose

Show all device fields.

Environment variable: NETAUDIO_VERBOSE.

--dissect

Annotated protocol dissection for packet displays.

Environment variable: NETAUDIO_DISSECT.

--capture

Record all packets to capture database.

Environment variable: NETAUDIO_CAPTURE.

--icons

Use Nerd Font icons in output.

Environment variable: NETAUDIO_ICONS.

-V, --version

Show version and exit.

--install-completion

Install completion for the current shell.

--show-completion

Show completion for the current shell, to copy it or customize the installation.

`netaudio clock`

Show PTP clock status (leader, followers, preferred leader).

          netaudio [GLOBAL OPTIONS] clock

`netaudio status`

Show all discovered network audio devices.

          netaudio [GLOBAL OPTIONS] status

`netaudio channel`

Manage channels on the selected device.

          netaudio [GLOBAL OPTIONS] channel COMMAND

`netaudio channel list`

List channels on devices.

              netaudio [GLOBAL OPTIONS] channel list

`netaudio channel name`

Get or set a channel name.

              netaudio [GLOBAL OPTIONS] channel name CHANNEL [NEW_NAME]

CHANNEL

Channel to address: tx:NUMBER, rx:NUMBER, tx:NAME, rx:NAME, or a bare channel name (a bare name searches both directions).

Value: text. Required.

NEW_NAME

New name (omit to get, empty string to reset).

Value: text.

`netaudio channel gain`

Get or set channel gain level.

              netaudio [GLOBAL OPTIONS] channel gain CHANNEL [LEVEL]

CHANNEL

Channel to address: tx:NUMBER, rx:NUMBER, tx:NAME, rx:NAME, or a bare channel name (a bare name searches both directions).

Value: text. Required.

LEVEL

Gain level (1-5).

Value: integer.

`netaudio config`

Manage netaudio configuration.

          netaudio [GLOBAL OPTIONS] config COMMAND

`netaudio config edit`

Open config.toml in $EDITOR.

              netaudio [GLOBAL OPTIONS] config edit

`netaudio config path`

Show the config file path.

              netaudio [GLOBAL OPTIONS] config path

`netaudio config show`

Print the effective configuration as key = value lines.

              netaudio [GLOBAL OPTIONS] config show

`netaudio daemon`

Manage the netaudio daemon.

          netaudio [GLOBAL OPTIONS] daemon COMMAND

`netaudio daemon run`

Run the daemon in the foreground (Ctrl-C to stop).

              netaudio [GLOBAL OPTIONS] daemon run [OPTIONS]

--port

Daemon HTTP API port.

Value: integer. Environment variable: NETAUDIO_DAEMON_PORT.

`netaudio daemon start`

Start the daemon (via the boot service if installed, otherwise in the background).

              netaudio [GLOBAL OPTIONS] daemon start [OPTIONS]

--port

Daemon HTTP API port.

Value: integer. Environment variable: NETAUDIO_DAEMON_PORT.

`netaudio daemon stop`

Stop the daemon.

              netaudio [GLOBAL OPTIONS] daemon stop [OPTIONS]

--port

Daemon HTTP API port.

Value: integer. Environment variable: NETAUDIO_DAEMON_PORT.

`netaudio daemon restart`

Restart the daemon.

              netaudio [GLOBAL OPTIONS] daemon restart [OPTIONS]

--port

Daemon HTTP API port.

Value: integer. Environment variable: NETAUDIO_DAEMON_PORT.

`netaudio daemon status`

Show daemon status.

              netaudio [GLOBAL OPTIONS] daemon status [OPTIONS]

--port

Daemon HTTP API port.

Value: integer. Environment variable: NETAUDIO_DAEMON_PORT.

`netaudio daemon forget`

Drop cached devices from the running daemon.

              netaudio [GLOBAL OPTIONS] daemon forget [OPTIONS] [DEVICE_NAME]

DEVICE_NAME

Device name or mDNS server name to drop from the daemon cache.

Value: text.

--emulated

Forget every cached emulated device.

--offline

Forget every cached device that is currently offline.

--port

Daemon HTTP API port.

Value: integer. Environment variable: NETAUDIO_DAEMON_PORT.

`netaudio daemon install`

Install the daemon as a boot service (systemd on Linux, launchd on macOS, Task Scheduler on Windows).

              netaudio [GLOBAL OPTIONS] daemon install [OPTIONS]

--start, --no-start

Start the service after installing.

Default: True.

--force

Overwrite an existing service file.

--print

Print the generated service file without writing it.

`netaudio daemon uninstall`

Remove the boot service.

              netaudio [GLOBAL OPTIONS] daemon uninstall [OPTIONS]

--force: Remove the service file even if netaudio did not create it.

`netaudio daemon logs`

Show daemon logs.

              netaudio [GLOBAL OPTIONS] daemon logs [OPTIONS]

--follow, -f

Follow new log output.

--lines, -n

Number of recent lines to show.

Value: integer. Default: 50.

`netaudio daemon web`

Show the daemon web interface address.

              netaudio [GLOBAL OPTIONS] daemon web [OPTIONS]

--port

Daemon HTTP API port.

Value: integer. Environment variable: NETAUDIO_DAEMON_PORT.

--open

Open the web interface in the default browser.

`netaudio daemon tls`

Show the daemon's TLS configuration and certificate fingerprint.

              netaudio [GLOBAL OPTIONS] daemon tls

`netaudio ddm`

Discover Dante Domain Manager or query its Managed API. GraphQL queries and mutations are generated from the bundled schema; status, devices, and refresh read the daemon's inventory.

          netaudio [GLOBAL OPTIONS] ddm COMMAND

`netaudio ddm discover`

Discover DDM servers and their advertised control services.

              netaudio [GLOBAL OPTIONS] ddm discover [OPTIONS]

--timeout, -t

Seconds to listen for DDM advertisements.

Value: number. Default: 2.0.

`netaudio ddm status`

Show the daemon's Managed API connection and inventory state.

              netaudio [GLOBAL OPTIONS] ddm status

`netaudio ddm devices`

List devices the daemon has seen through the Managed API, merged with direct discovery.

              netaudio [GLOBAL OPTIONS] ddm devices

`netaudio ddm enroll`

Enroll a device in a Dante Domain Manager domain, keeping its configuration.

              netaudio [GLOBAL OPTIONS] ddm enroll [OPTIONS] DEVICE DOMAIN

DEVICE

Device name or DDM device ID.

Value: text. Required.

DOMAIN

Domain name or ID.

Value: text. Required.

--yes, -y

Skip the confirmation prompt.

`netaudio ddm unenroll`

Unenroll a device from its Dante Domain Manager domain, keeping its configuration.

              netaudio [GLOBAL OPTIONS] ddm unenroll [OPTIONS] DEVICE

DEVICE

Device name or DDM device ID.

Value: text. Required.

--yes, -y

Skip the confirmation prompt.

`netaudio ddm refresh`

Ask the daemon to re-read the Managed API inventory now.

              netaudio [GLOBAL OPTIONS] ddm refresh

`netaudio ddm login`

Discover or select DDM, authenticate, choose a domain, and save a context.

              netaudio [GLOBAL OPTIONS] ddm login [OPTIONS]

--username, -u

DDM username or email address.

Value: text.

--url

Managed API URL ending in /graphql.

Value: text.

--server-profile

Name for the saved DDM server profile, or an existing profile to update.

Value: text.

--domain

Domain ID or unique domain name.

Value: text.

--context-name

Name for the saved server/domain context.

Value: text.

--save-credential

File in which to save the returned Managed API credential.

Value: path.

--credential-file

Authenticate with an existing Managed API credential file instead of username/password.

Value: path.

--default

Make the saved context the default.

--discovery-timeout

Seconds to listen when discovering a server because --url was omitted.

Value: number. Default: 2.0.

`netaudio ddm context`

List and select saved DDM server/domain contexts.

              netaudio [GLOBAL OPTIONS] ddm context COMMAND

`netaudio ddm context list`

List saved DDM server/domain contexts.

              netaudio [GLOBAL OPTIONS] ddm context list

`netaudio ddm context current`

Show the context selected by --context, the environment, or configuration.

              netaudio [GLOBAL OPTIONS] ddm context current

`netaudio ddm context use`

Set the default DDM context.

              netaudio [GLOBAL OPTIONS] ddm context use NAME

NAME

Saved DDM context name.

Value: text. Required.

`netaudio ddm api`

Use the low-level Dante Managed API. Ordinary device control uses the normal NetAudio commands.

              netaudio [GLOBAL OPTIONS] ddm api COMMAND

`netaudio ddm api graphql`

Send any GraphQL document to the Managed API and print the response.

              netaudio [GLOBAL OPTIONS] ddm api graphql [OPTIONS] [QUERY]

QUERY

GraphQL document to send. Omit when using --file.

Value: text.

--file, -f

Read the GraphQL document from a file.

Value: path.

--variables-file, -V

Read a JSON variables object from a file.

Value: path.

--operation-name

Operation to run when the document defines several.

Value: text.

`netaudio ddm api schema`

Browse the bundled Managed API schema: operations, or the fields of one type.

              netaudio [GLOBAL OPTIONS] ddm api schema [TYPE_NAME]

TYPE_NAME

Type to describe. Omit to list queries and mutations.

Value: text.

`netaudio ddm api read`

Run read-only queries from the DDM GraphQL schema.

              netaudio [GLOBAL OPTIONS] ddm api read COMMAND

`netaudio ddm api read device-entitlements`

Query deviceEntitlements. Returns [DeviceEntitlement]!.

              netaudio [GLOBAL OPTIONS] ddm api read device-entitlements [OPTIONS]

--print-query: Print the GraphQL document and variables instead of sending them.

`netaudio ddm api read domain`

Get a single domain based on its unique identifier. Returns Domain.

              netaudio [GLOBAL OPTIONS] ddm api read domain [OPTIONS]

--id

[ID] The unique system-generated identifier of the domain

Value: text.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api read domains`

Get the domains that are visible to the authenticated user or API key. Returns [Domain]!.

              netaudio [GLOBAL OPTIONS] ddm api read domains [OPTIONS]

--print-query: Print the GraphQL document and variables instead of sending them.

`netaudio ddm api read current-user`

Query me. Returns LoginUserPreferences.

              netaudio [GLOBAL OPTIONS] ddm api read current-user [OPTIONS]

--print-query: Print the GraphQL document and variables instead of sending them.

`netaudio ddm api read unenrolled-devices`

Query unenrolledDevices. Returns [Device!]!.

              netaudio [GLOBAL OPTIONS] ddm api read unenrolled-devices [OPTIONS]

--print-query: Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write`

Run DDM GraphQL mutations that can change servers, domains, or devices.

              netaudio [GLOBAL OPTIONS] ddm api write COMMAND

`netaudio ddm api write clocking-group`

Run clocking group mutations from the DDM GraphQL schema.

              netaudio [GLOBAL OPTIONS] ddm api write clocking-group COMMAND

`netaudio ddm api write clocking-group configure-automatically`

Initiate the automatic configuration for a clocking group. Returns ClockingGroupAutomaticallyConfigurePayload.

              netaudio [GLOBAL OPTIONS] ddm api write clocking-group configure-automatically [OPTIONS]

--clocking-group-id

[ID!] Unique identifier (ID) for the clocking group.

Value: text. Required.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write clocking-group set`

Configure a clocking group including PTP settings, AES67 or SMPTE 2110 modes. Returns ClockingGroupSetPayload.

              netaudio [GLOBAL OPTIONS] ddm api write clocking-group set [OPTIONS]

--clocking-group-id

[ID!] Unique identifier for the clocking group.

Value: text. Required.

--mode

[ClockingGroupMode] Set a pre-configured clocking mode.

Value: DEFAULT, AES67, SMPTE.

--ptp

Advanced customizable PTP settings (Dante Director Professional only). JSON object with fields dantePriorities: Boolean, followerOnly: Boolean, v1: Boolean, v1SubdomainName: String, v2: Boolean, v2AnnounceInterval: Int, v2DomainNumber: Int, v2MulticastTtl: Int, v2Priority1: Int, v2Priority2: Int, v2SyncInterval: Int (ClockingGroupPtpInput).

Value: text.

--rtp

Advanced customizable RTP Flow settings (Dante Director Professional only). JSON object with fields prefixV4: Int, rxLatency: Int, systemPacketTime: Int, transmitPort: Int (ClockingGroupRtpInput).

Value: text.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write device`

Run device mutations from the DDM GraphQL schema.

              netaudio [GLOBAL OPTIONS] ddm api write device COMMAND

`netaudio ddm api write device set-ava-video-enabled-and-multicast`

Mutation DeviceAvaVideoEnabledAndMulticastSet. Returns DeviceAvaVideoEnabledAndMulticastSetPayload.

              netaudio [GLOBAL OPTIONS] ddm api write device set-ava-video-enabled-and-multicast [OPTIONS]

--device-id

[ID!] The ID of the device Examples: "0ae3b2edf1374c0c836c96649e879c2f" (for software devices like DVS) "001dc1fffe501c25:0" (for hardware devices like AVIO)

Value: text. Required.

--enabled, --no-enabled

[Boolean!] set to true to enable video and false to disable video

Required.

--multicast-mode

[AvaMulticastMode!] Used to specify which mode AV-A runs in

Value: MULTICAST_ONLY, UNICAST_ONLY. Required.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write device set-clocking-preferences-overrides`

Override certain domain preferences for an individual device, including PTPv2 priorities and RTP settings. Returns DeviceClockingPreferencesOverridesSetPayload.

              netaudio [GLOBAL OPTIONS] ddm api write device set-clocking-preferences-overrides [OPTIONS]

--device-id

[ID!] The ID of the device to override domain preferences for Examples: "0ae3b2edf1374c0c836c96649e879c2f" (for software devices like DVS) "001dc1fffe501c25:0" (for hardware devices like AVIO)

Value: text. Required.

--ptp

Override PTPv2 domain preferences JSON object with fields v2Priority1: Int, v2Priority2: Int (DeviceClockPreferencesOverridesPtp).

Value: text.

--rtp

Override RTP domain preferences JSON object with fields prefixV4: Int (DeviceClockPreferencesOverridesRtp).

Value: text.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write device set-clocking-preferred-leader`

Set or clear the preferred leader option for a device. Returns DeviceClockingPreferredLeaderSetPayload.

              netaudio [GLOBAL OPTIONS] ddm api write device set-clocking-preferred-leader [OPTIONS]

--device-id

[ID!] The ID of the device to set the preferred leader option for Examples: "0ae3b2edf1374c0c836c96649e879c2f" (for software devices like DVS) "001dc1fffe501c25:0" (for hardware devices like AVIO)

Value: text. Required.

--enabled, --no-enabled

[Boolean!] true = preferred leader option enabled

Required.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write device set-clocking-ptpv1-unicast-delay-request`

Enable or disable PTPv1 unicast delay requests for a device In subnets with many devices, enabling unicast delay requests reduces multicast traffic and can help to overcome bandwidth limitations Returns DeviceClockingPTPV1UnicastDelayRequestSetPayload.

              netaudio [GLOBAL OPTIONS] ddm api write device set-clocking-ptpv1-unicast-delay-request [OPTIONS]

--device-id

[ID!] The ID of the device to change the PTPv1 unicast delay requests Examples: "0ae3b2edf1374c0c836c96649e879c2f" (for software devices like DVS) "001dc1fffe501c25:0" (for hardware devices like AVIO)

Value: text. Required.

--enabled, --no-enabled

[Boolean!] true = enable PTPv1 unicast delay requests false = use PTPv2 multicast delay requests (default)

Required.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write device set-clocking-sync-to-external`

Set or clear the sync to external option for a device. Returns DeviceClockingSyncToExternalSetPayload.

              netaudio [GLOBAL OPTIONS] ddm api write device set-clocking-sync-to-external [OPTIONS]

--device-id

[ID!] The ID of the device to set the sync to external option for Example: '0ae3b2edf1374c0c836c96649e879c2f'

Value: text. Required.

--enabled, --no-enabled

[Boolean!] true = sync to external to be enabled on the device

Required.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write device set-clocking-unicast`

Set or clear the unicast clocking option on a device. Returns DeviceClockingUnicastSetPayload.

              netaudio [GLOBAL OPTIONS] ddm api write device set-clocking-unicast [OPTIONS]

--device-id

[ID!] The ID of the device to set unicast clocking for Examples: "0ae3b2edf1374c0c836c96649e879c2f" (for software devices like DVS) "001dc1fffe501c25:0" (for hardware devices like AVIO)

Value: text. Required.

--enabled, --no-enabled

[Boolean!] true = unicast clocking enabled

Required.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write device set-input-edid-preset`

Mutation DeviceInputEdidPresetSet. Returns DeviceInputEdidPresetSetPayload.

              netaudio [GLOBAL OPTIONS] ddm api write device set-input-edid-preset [OPTIONS]

--device-id

[ID!]

Value: text. Required.

--input-key

[ID!]

Value: text. Required.

--edid

[EdidOption!]

Value: UHD_4K_60HZ, UHD_4K_60HZ_HDR, UHD_4K_60HZ_DOLBY_VISION, UHD_4K_30HZ, HD_1080P_60HZ, UNKNOWN. Required.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write device set-name`

Set (or clear) the name of a device. Returns DeviceNameSetPayload.

              netaudio [GLOBAL OPTIONS] ddm api write device set-name [OPTIONS]

--device-id

[ID!] The ID of the device to rename Examples: "0ae3b2edf1374c0c836c96649e879c2f" (for software devices like DVS) "001dc1fffe501c25:0" (for hardware devices like AVIO)

Value: text. Required.

--name

[String!] New name for the device Maximum of 31 characters and must contain only letters, numbers and -.

Value: text. Required.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write device set-parameters`

Set extended 'Dante Device Link' parameters on a device. Returns DeviceParametersSetPayload.

              netaudio [GLOBAL OPTIONS] ddm api write device set-parameters [OPTIONS]

--device-id

[ID!] The ID of the device to set the parameters on Examples: "0ae3b2edf1374c0c836c96649e879c2f" (for software devices like DVS) "001dc1fffe501c25:0" (for hardware devices like AVIO)

Value: text. Required.

--parameters

[[DeviceParameterPathKeyValue!]!] Array of parameter path key values to set on the device Parameters in a parameter group must all be set in the same mutation call but parameters from different groups (and not in a group) can also be included in the one call. JSON list of objects with fields path: String!, key: String!, value: DeviceParameterValueType!.

Value: text. Required.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write device set-policy`

Set the policy (access roles) for a device when controlling additional device functions or other devices in the network. Returns DevicePolicySetPayload.

              netaudio [GLOBAL OPTIONS] ddm api write device set-policy [OPTIONS]

--device-id

[ID!] The ID of the device Example: "0ae3b2edf1374c0c836c96649e879c2f"

Value: text. Required.

--role

[UserDomainRoles!] The role to assign to the device for accessing other devices in the domain.

Value: SiteControl, MediaControl, DomainControl, None, ReadOnly. Required.

--local-control

[DeviceLocalControl!] The level of access control to grant to the device for accessing itself.

Value: READ_WRITE, READ_ONLY, NO_ACCESS. Required.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write device set-rx-channels-subscription`

Set (or clear) channel subscriptions on an RX device Returns DeviceRxChannelsSubscriptionSetPayload.

              netaudio [GLOBAL OPTIONS] ddm api write device set-rx-channels-subscription [OPTIONS]

--device-id

[ID!] The ID of the device which will receive the subscription Examples: "0ae3b2edf1374c0c836c96649e879c2f" (for software devices like DVS) "001dc1fffe501c25:0" (for hardware devices like AVIO)

Value: text. Required.

--subscriptions

[[DeviceRxChannelsSubscriptionInput!]!] JSON list of objects with fields rxChannelIndex: Int!, subscribedDevice: String!, subscribedChannel: String!.

Value: text. Required.

--allow-subscription-to-non-existent-device, --no-allow-subscription-to-non-existent-device

[Boolean] Allows setting a subscription to a device name when that device does not currently exist, typically because it is offline.

--allow-subscription-to-non-existent-channel, --no-allow-subscription-to-non-existent-channel

[Boolean] Allows setting a subscription to a channel name even when the transmitter device does not have a channel by that name Subscriptions to unknown devices or channels may be helpful when restoring a preset.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write device set-serial-port-config`

Mutation DeviceSerialPortConfigSet. Returns DeviceSerialPortConfigSetPayload.

              netaudio [GLOBAL OPTIONS] ddm api write device set-serial-port-config [OPTIONS]

--device-id

[ID!] The ID of the device Examples: "0ae3b2edf1374c0c836c96649e879c2f" (for software devices like DVS) "001dc1fffe501c25:0" (for hardware devices like AVIO)

Value: text. Required.

--name

[String!] The name of the Device

Value: text. Required.

--baud-rate

[Int!] BaudRate setting

Value: integer. Required.

--data-bits

[Int!] DataBits setting

Value: integer. Required.

--parity

[ParityOption!] Parity setting

Value: NONE, ODD, EVEN, UNKNOWN. Required.

--stop-bits

[StopBitsOption!] Stopbits setting

Value: ONE, TWO, UNKNOWN. Required.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write device set-video-enabled-and-multicast`

Mutation DeviceVideoEnabledAndMulticastSet. Returns DeviceAvaVideoEnabledAndMulticastSetPayload.

              netaudio [GLOBAL OPTIONS] ddm api write device set-video-enabled-and-multicast [OPTIONS]

--device-id

[ID!] The ID of the device Examples: "0ae3b2edf1374c0c836c96649e879c2f" (for software devices like DVS) "001dc1fffe501c25:0" (for hardware devices like AVIO)

Value: text. Required.

--enabled, --no-enabled

[Boolean!] set to true to enable video and false to disable video

Required.

--multicast-mode

[AvaMulticastMode!] Used to specify which mode AV-A runs in

Value: MULTICAST_ONLY, UNICAST_ONLY. Required.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write device set-video-enabled`

Mutation DeviceVideoEnabledSet. Returns DeviceVideoEnabledSetPayload.

              netaudio [GLOBAL OPTIONS] ddm api write device set-video-enabled [OPTIONS]

--device-id

[ID!] The ID of the device Examples: "0ae3b2edf1374c0c836c96649e879c2f" (for software devices like DVS) "001dc1fffe501c25:0" (for hardware devices like AVIO)

Value: text. Required.

--enabled, --no-enabled

[Boolean!] set to true to enable video and false to disable video

Required.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write devices`

Run devices mutations from the DDM GraphQL schema.

              netaudio [GLOBAL OPTIONS] ddm api write devices COMMAND

`netaudio ddm api write devices enroll`

Mutation DevicesEnroll. Returns DevicesEnrollPayload.

              netaudio [GLOBAL OPTIONS] ddm api write devices enroll [OPTIONS]

--domain-id

[ID!]

Value: text. Required.

--device-ids

[[ID!]!] Repeatable.

Value: text. Required. Can be given more than once.

--clear-config, --no-clear-config

[Boolean] Clear Configuration will reset the following configuration settings to the device defaults: - Device Name - Channel labels - Latency - Sample rate - Encoding - Subscriptions Note: Clear Configuration is not supported for legacy devices.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write devices unenroll`

Unenroll (unassign) device(s) from their domain, with an option to clear device configuration. Returns DevicesUnenrollPayload.

              netaudio [GLOBAL OPTIONS] ddm api write devices unenroll [OPTIONS]

--device-ids

[[ID!]!] The IDs of the device(s) to unenroll Examples: "0ae3b2edf1374c0c836c96649e879c2f" (for software devices like DVS) "001dc1fffe501c25:0" (for hardware devices like AVIO) Repeatable.

Value: text. Required. Can be given more than once.

--clear-config, --no-clear-config

[Boolean] Clear Configuration will reset the following configuration settings to the device defaults: - Device Name - Channel labels - Latency - Sample rate - Encoding - Channel subscriptions Note: Clear Configuration is not supported for legacy devices.

--yes, -y

Skip the confirmation prompt.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write domain`

Run domain mutations from the DDM GraphQL schema.

              netaudio [GLOBAL OPTIONS] ddm api write domain COMMAND

`netaudio ddm api write domain add`

Add a new domain to the account Returns DomainAddPayload!.

              netaudio [GLOBAL OPTIONS] ddm api write domain add [OPTIONS]

--name

[String!] Name of the domain

Value: text. Required.

--icon

[DomainIcon!] Icon for identifying the domain in the user interface Selected from a preset list of icon types e.g.

Value: BROADCAST, RECORDING_STUDIO, HOUSE_OF_WORSHIP_1, HOUSE_OF_WORSHIP_2, HIGHER_EDUCATION, PRIMARY_EDUCATION, GOVERNMENT, TRANSPORTATION_1, TRANSPORTATION_2, HEALTH_CARE, COMMERCIAL, OFFICE, MANUFACTURING, RETAIL, ARTS_VENUE, THEATRE_CINEMA, RESTAURANT, BAR_CLUB, HOTEL_CASINO, THEMED_ENTERTAINMENT, SPORTS_VENUE_1, SPORTS_VENUE_2, RESIDENTIAL_1, RESIDENTIAL_2, OTHER. Required.

--account-id

[ID] The unique identifier of the account to add the domain to.

Value: text.

--parent-domain-id

[ID] For domains that belong to a parent (e.g.

Value: text.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write domain assign-clocking-group`

Assign a clocking group to a domain. Returns DomainClockingGroupAssignPayload.

              netaudio [GLOBAL OPTIONS] ddm api write domain assign-clocking-group [OPTIONS]

--domain-id

[ID!] The unique ID of the domain to associate with the clocking group.

Value: text. Required.

--clocking-group-id

[ID] The unique ID of the clocking group to associate with the domain.

Value: text.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write domain add-external-sdp-descriptor`

Mutation DomainExternalSdpDescriptorAdd. Returns DomainExternalSdpDescriptorAddPayload!.

              netaudio [GLOBAL OPTIONS] ddm api write domain add-external-sdp-descriptor [OPTIONS]

--sdp

[String!]

Value: text. Required.

--domain-id

[ID!]

Value: text. Required.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write domain remove-external-sdp-descriptor`

Mutation DomainExternalSdpDescriptorRemove. Returns DomainExternalSdpDescriptorRemovePayload!.

              netaudio [GLOBAL OPTIONS] ddm api write domain remove-external-sdp-descriptor [OPTIONS]

--sdp-descriptor-id

[ID!]

Value: text. Required.

--yes, -y

Skip the confirmation prompt.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write domain remove`

Remove a domain. Returns DomainRemovePayload!.

              netaudio [GLOBAL OPTIONS] ddm api write domain remove [OPTIONS]

--id

[ID!] The unique ID of the domain to remove.

Value: text. Required.

--yes, -y

Skip the confirmation prompt.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write domain update`

Update domain metadata including name, icon Returns DomainUpdatePayload!.

              netaudio [GLOBAL OPTIONS] ddm api write domain update [OPTIONS]

--id

[ID!] The unique ID of the domain to update metadata for.

Value: text. Required.

--name

[String] Name of the domain

Value: text.

--icon

[DomainIcon] Icon for identifying the domain in the user interface Selected from a preset list of icon types e.g.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write fqdn`

Run fqdn mutations from the DDM GraphQL schema.

              netaudio [GLOBAL OPTIONS] ddm api write fqdn COMMAND

`netaudio ddm api write fqdn set`

Mutation FqdnSet. Returns FqdnSetPayload.

              netaudio [GLOBAL OPTIONS] ddm api write fqdn set [OPTIONS]

--fqdn

[String!]

Value: text. Required.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write license`

Run license mutations from the DDM GraphQL schema.

              netaudio [GLOBAL OPTIONS] ddm api write license COMMAND

`netaudio ddm api write license activate`

Mutation LicenseActivate. Returns LicenseActivatePayload.

              netaudio [GLOBAL OPTIONS] ddm api write license activate [OPTIONS]

--serial-number

[ID!]

Value: text. Required.

--yes, -y

Skip the confirmation prompt.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio ddm api write user`

Run user mutations from the DDM GraphQL schema.

              netaudio [GLOBAL OPTIONS] ddm api write user COMMAND

`netaudio ddm api write user remove-api-key`

Mutation UserAPIKeyRemove. Returns UserAPIKeyRemovePayload.

              netaudio [GLOBAL OPTIONS] ddm api write user remove-api-key [OPTIONS]

--key-id

[ID!]

Value: text. Required.

--yes, -y

Skip the confirmation prompt.

--print-query

Print the GraphQL document and variables instead of sending them.

`netaudio device`

Manage Dante devices.

          netaudio [GLOBAL OPTIONS] device COMMAND

`netaudio device list`

Show all discovered network audio devices.

              netaudio [GLOBAL OPTIONS] device list

`netaudio device diagnostics`

Show retained receiver-path and clock measurements from the daemon.

              netaudio [GLOBAL OPTIONS] device diagnostics [OPTIONS] DEVICE

DEVICE

Device name or server name.

Value: text. Required.

--reset

Reset local display statistics.

--export

Export retained raw observations as JSON.

`netaudio device show`

Show detailed device information.

              netaudio [GLOBAL OPTIONS] device show

`netaudio device capabilities`

Inspect licensed and sample-rate-dependent audio capabilities.

              netaudio [GLOBAL OPTIONS] device capabilities [OPTIONS]

--timeout

Diagnostic response timeout in seconds.

Value: number. Default: 15.0.

`netaudio device identify`

Blink the identify LED on a device.

              netaudio [GLOBAL OPTIONS] device identify [OPTIONS]

--all: Identify every matched device. Required when more than one device matches.

`netaudio device reboot`

Reboot a device.

              netaudio [GLOBAL OPTIONS] device reboot [OPTIONS]

--all: Reboot every matched device. Required when more than one device matches.

`netaudio device factory-reset`

Erase all retained configuration and request a factory reset.

              netaudio [GLOBAL OPTIONS] device factory-reset [OPTIONS]

--confirm

Exact device name required to authorize erasing all retained configuration.

Value: text. Required.

`netaudio device clear-configuration`

Clear retained configuration with verified device acknowledgement.

              netaudio [GLOBAL OPTIONS] device clear-configuration [OPTIONS]

--mode

Configuration to clear: all, or preserve-network.

Value: all, preserve-network. Required.

--confirm

Exact device name required to authorize clearing retained configuration.

Value: text. Required.

`netaudio device export-capability`

Export the selected device's CAP1 capability partition.

              netaudio [GLOBAL OPTIONS] device export-capability [OPTIONS] OUTPUT

OUTPUT

New raw CAP1 partition image path.

Value: path. Required.

--timeout

Response timeout in seconds.

Value: number. Default: 15.0.

`netaudio device export-logs`

Export the selected device's diagnostic logs.

              netaudio [GLOBAL OPTIONS] device export-logs [OPTIONS] OUTPUT

OUTPUT

New tar archive path.

Value: path. Required.

--timeout

Response timeout in seconds.

Value: number. Default: 15.0.

`netaudio device network-status`

Probe interface statistics and switch-configuration status.

              netaudio [GLOBAL OPTIONS] device network-status [OPTIONS]

--timeout

Per-probe network-status response timeout in seconds.

Value: number. Default: 2.0.

`netaudio device name`

Get or set device name.

              netaudio [GLOBAL OPTIONS] device name [NEW_NAME]

NEW_NAME

New name (omit to get, empty string to reset).

Value: text.

`netaudio device controls`

Inspect and change analog, Bluetooth, video and serial settings.

              netaudio [GLOBAL OPTIONS] device controls COMMAND

`netaudio device controls inspect`

Read the device's settings and supported choices.

              netaudio [GLOBAL OPTIONS] device controls inspect

`netaudio device controls plan`

Preview one setting without sending a change.

              netaudio [GLOBAL OPTIONS] device controls plan CATEGORY SETTINGS

CATEGORY

Setting category to inspect or change.

Value: analog_level, bluetooth_identification, bluetooth_discovery, bluetooth_pairing, video_format, codec_format, serial, bandwidth, hdcp. Required.

SETTINGS

Requested setting as JSON.

Value: text. Required.

`netaudio device controls apply`

Apply one setting once, then check its readback.

              netaudio [GLOBAL OPTIONS] device controls apply [OPTIONS] CATEGORY SETTINGS

CATEGORY

Setting category to inspect or change.

Value: analog_level, bluetooth_identification, bluetooth_discovery, bluetooth_pairing, video_format, codec_format, serial, bandwidth, hdcp. Required.

SETTINGS

Requested setting as JSON.

Value: text. Required.

--confirm-clear, --no-confirm-clear

Confirm clearing all remembered Bluetooth devices.

`netaudio device controls analog-level`

Set analog reference level 1–5 on a reported channel.

              netaudio [GLOBAL OPTIONS] device controls analog-level [OPTIONS] CHANNEL LEVEL

CHANNEL

Reported analog channel, 1 or 2.

Value: integer. Required.

LEVEL

Reference level enumeration, 1 through 5.

Value: integer. Required.

--apply

Apply the change; otherwise preview it.

`netaudio device controls bluetooth-name`

Use a custom Bluetooth name or --device-name.

              netaudio [GLOBAL OPTIONS] device controls bluetooth-name [OPTIONS]

--name

Custom Bluetooth name, up to 32 characters.

Value: text.

--device-name, --no-device-name

Use the Dante device name.

--apply, --no-apply

Apply; otherwise preview.

`netaudio device controls bluetooth-discovery`

Allow or prevent Bluetooth discovery.

              netaudio [GLOBAL OPTIONS] device controls bluetooth-discovery [OPTIONS]

--on, --off

Enable or disable Bluetooth discoverability.

Required.

--apply, --no-apply

Apply; otherwise preview.

`netaudio device controls clear-pairing`

Forget all paired Bluetooth devices.

              netaudio [GLOBAL OPTIONS] device controls clear-pairing [OPTIONS]

--confirm: Clear all remembered Bluetooth devices.

`netaudio device controls bandwidth`

Set transmitter bandwidth within the device's reported bounds.

              netaudio [GLOBAL OPTIONS] device controls bandwidth [OPTIONS] TARGET

TARGET

Target Mbit/s, or 0 to disable user control.

Value: integer. Required.

--apply, --no-apply

Apply; otherwise preview.

`netaudio device controls serial`

Set the serial port format; sends no serial data.

              netaudio [GLOBAL OPTIONS] device controls serial [OPTIONS] BAUD

BAUD

Baud rate supported by the serial port.

Value: integer. Required.

--data-bits

7 or 8 data bits.

Value: integer. Default: 8.

--parity

0 none, 1 even, 2 odd.

Value: integer. Default: 0.

--stop-bits

1 or 2 stop bits.

Value: integer. Default: 1.

--apply, --no-apply

Apply; otherwise preview.

`netaudio device config`

Get or set device configuration.

              netaudio [GLOBAL OPTIONS] device config COMMAND

`netaudio device config sample-rate`

Get or set the sample rate.

              netaudio [GLOBAL OPTIONS] device config sample-rate [OPTIONS] [RATE]

RATE

Sample rate: [44100, 48000, 88200, 96000, 176400, 192000]

Value: integer.

--all

Apply to all devices.

--confirm-destructive

Confirm permanent removal of out-of-capacity transmitter flow members.

`netaudio device config sample-rate-pullup`

Get or set sample-rate pull-up/down.

              netaudio [GLOBAL OPTIONS] device config sample-rate-pullup [OPTIONS] [SELECTION]

SELECTION

none, +4.1667%, +0.1%, -0.1%, -4.0%, or a raw integer.

Value: text.

--all

Apply to all devices.

`netaudio device config encoding`

Get or set the encoding bit depth.

              netaudio [GLOBAL OPTIONS] device config encoding [OPTIONS] [BITS]

BITS

Encoding bit depth: [16, 24, 32]

Value: integer.

--all

Apply to all devices.

`netaudio device config latency`

Get the complete device latency state or set and verify latency.

              netaudio [GLOBAL OPTIONS] device config latency [OPTIONS] [VALUE]

VALUE

Latency in milliseconds.

Value: number.

--all

Read or apply to all devices.

`netaudio device config receive-flow-performance`

Set and verify receive-flow latency and frames per packet.

              netaudio [GLOBAL OPTIONS] device config receive-flow-performance [OPTIONS] LATENCY_MICROSECONDS FRAMES_PER_PACKET

LATENCY_MICROSECONDS

Receive-flow latency in microseconds.

Value: integer. Required.

FRAMES_PER_PACKET

Receive-flow frames per packet.

Value: integer. Required.

--all

Apply to all selected devices.

`netaudio device config transmit-flow-performance`

Set and verify transmit-flow latency and frames per packet.

              netaudio [GLOBAL OPTIONS] device config transmit-flow-performance [OPTIONS] LATENCY_MICROSECONDS FRAMES_PER_PACKET

LATENCY_MICROSECONDS

Transmit-flow latency in microseconds.

Value: integer. Required.

FRAMES_PER_PACKET

Transmit-flow frames per packet.

Value: integer. Required.

--all

Apply to all selected devices.

`netaudio device config unicast-performance`

Set and verify the unicast properties advertised by each device.

              netaudio [GLOBAL OPTIONS] device config unicast-performance [OPTIONS] LATENCY_MICROSECONDS FRAMES_PER_PACKET

LATENCY_MICROSECONDS

Unicast latency in microseconds.

Value: integer. Required.

FRAMES_PER_PACKET

Unicast frames per packet.

Value: integer. Required.

--all

Apply to all selected devices.

`netaudio device config receive-flow-default-slots`

Set and verify the default receive-flow slot count.

              netaudio [GLOBAL OPTIONS] device config receive-flow-default-slots [OPTIONS] SLOTS

SLOTS

Default receive-flow slot count.

Value: integer. Required.

--all

Apply to all selected devices.

`netaudio device config store-current-configuration`

Request storage without claiming persistence confirmation.

              netaudio [GLOBAL OPTIONS] device config store-current-configuration [OPTIONS]

--all: Request storage on all selected devices.

`netaudio device config aes67`

Get or set AES67 mode.

              netaudio [GLOBAL OPTIONS] device config aes67 [OPTIONS] [ENABLED]

ENABLED

on or off

Value: text.

--multicast-prefix

AES67 RTP multicast prefix, for example 239.69.0.0.

Value: text.

--all

Apply to all devices.

`netaudio device config preferred-leader`

Get or set preferred leader mode.

              netaudio [GLOBAL OPTIONS] device config preferred-leader [OPTIONS] [ENABLED]

ENABLED

on or off

Value: text.

--all

Apply to all devices.

`netaudio device config clock-source`

Get or set the device's raw clock-source code.

              netaudio [GLOBAL OPTIONS] device config clock-source [OPTIONS] [SELECTION]

SELECTION

Raw source code in decimal or hexadecimal.

Value: text.

--all

Apply to all devices.

`netaudio device config clock-subdomain`

Get or set the PTP subdomain name.

              netaudio [GLOBAL OPTIONS] device config clock-subdomain [OPTIONS] [SELECTION]

SELECTION

ASCII name, hex:<bytes>, or unset.

Value: text.

--all

Apply to all devices.

`netaudio device config interface`

Read active/configured network settings or set and verify an interface.

              netaudio [GLOBAL OPTIONS] device config interface [OPTIONS] [MODE]

MODE

dhcp or static

Value: text.

--ip

IP address (static only).

Value: text.

--netmask

Subnet mask (static only).

Value: text.

--dns

DNS server (static only).

Value: text.

--gateway

Gateway (static only).

Value: text.

--all

Apply to all devices.

--interface

Target primary or secondary interface.

Value: text. Default: primary.

`netaudio device config redundancy`

Read or set and verify Dante Redundancy. Does not reboot devices.

              netaudio [GLOBAL OPTIONS] device config redundancy [OPTIONS] [MODE]

MODE

switched, redundant, or split_redundant

Value: text.

--all

Read or apply to all devices.

`netaudio device config clock`

Apply clock settings together and confirm them with fresh readback.

              netaudio [GLOBAL OPTIONS] device config clock [OPTIONS]

--source

0 internal, 1 external/BNC, 2 AES; device support required.

Value: integer.

--preferred, --not-preferred

Enable or disable preferred leader.

--subdomain

PTPv1 subdomain name, at most 15 bytes.

Value: text.

--global-unicast, --no-global-unicast

Enable or disable global unicast delay requests.

--ptpv1-unicast, --no-ptpv1-unicast

Enable or disable unicast delay requests on all PTPv1 ports.

--profile

Clock serializer: current or legacy.

Value: text. Default: current.

--follower-only, --no-follower-only

--ptpv2-domain

Value: integer.

--priority1

Value: integer.

--priority2

Value: integer.

--multicast-dscp

Value: integer.

--settings

Typed clock changes as a JSON object, including per-port settings.

Value: text.

--preview

Read current state and show changes without writing.

`netaudio discovery`

Request network service discovery.

          netaudio [GLOBAL OPTIONS] discovery COMMAND

`netaudio discovery refresh`

Request discovery once through the running daemon; replies update its inventory.

              netaudio [GLOBAL OPTIONS] discovery refresh [OPTIONS]

--address

Send directly to one IPv4 address instead of multicast.

Value: text.

`netaudio events`

Inspect the daemon's retained monitoring event journal.

          netaudio [GLOBAL OPTIONS] events COMMAND

`netaudio events list`

List recent monitoring events retained by the daemon.

              netaudio [GLOBAL OPTIONS] events list [OPTIONS]

--device

Match a device identity, name, or server name.

Value: text.

--kind

Filter by event kind.

Value: clock_role_changed, clock_status_changed, device_control_changed, device_disappeared, device_reappeared, interface_error_counter_increased, interface_error_counter_reset, interface_utilization_high, interface_utilization_recovered, issue_opened, issue_resolved, issue_updated, leader_identity_changed, late_packet_count_increased, late_packet_counter_reset, mute_state_changed, ptp_port_state_changed, receiver_flow_latency_high, receiver_flow_latency_recovered, subscription_failed, subscription_recovered, configuration_operation, setting_changed, channel_renamed, route_changed, preset_run.

--severity

Filter by severity.

Value: info, warning, error.

--since

Include events at or after this ISO-8601 timestamp.

Value: text.

--limit

Maximum number of newest events to show.

Value: integer. Default: 100.

`netaudio events export`

Export retained events as stable JSON with their raw evidence.

              netaudio [GLOBAL OPTIONS] events export [OPTIONS]

--file

Write JSON to this file instead of stdout.

Value: path.

--device

Match a device identity, name, or server name.

Value: text.

--kind

Filter by event kind.

--severity

Filter by severity.

Value: info, warning, error.

--since

Include events at or after this ISO-8601 timestamp.

Value: text.

`netaudio events clear`

Clear only the daemon's locally retained event history.

              netaudio [GLOBAL OPTIONS] events clear

`netaudio flow`

Inspect receiver flows and manage transmitter multicast flows on the selected device.

          netaudio [GLOBAL OPTIONS] flow COMMAND

`netaudio flow inspect`

Read transmitter flows into the canonical, lossless flow schema.

              netaudio [GLOBAL OPTIONS] flow inspect

`netaudio flow plan`

Validate and plan a canonical transmit-flow request without sending it.

              netaudio [GLOBAL OPTIONS] flow plan SPECIFICATION_FILE

SPECIFICATION_FILE

Canonical flow JSON file, or - for standard input.

Value: text. Required.

`netaudio flow apply`

Create an evidence-supported canonical transmit flow and verify readback.

              netaudio [GLOBAL OPTIONS] flow apply [OPTIONS] SPECIFICATION_FILE

SPECIFICATION_FILE

Canonical flow JSON file, or - for standard input.

Value: text. Required.

--yes, -y

Confirm transmit-flow creation.

`netaudio flow receiver-list`

List receiver flows and their local channel mappings.

              netaudio [GLOBAL OPTIONS] flow receiver-list

`netaudio flow receiver-port-ranges`

Show the receiver port ranges reported by a device.

              netaudio [GLOBAL OPTIONS] flow receiver-port-ranges

`netaudio flow external-list`

Discover advertised AES67 audio streams.

              netaudio [GLOBAL OPTIONS] flow external-list [OPTIONS]

--listen-seconds

Seconds to wait for stream announcements before showing the results.

Value: number. Default: 2.0.

`netaudio flow subscribe-external`

Subscribe receiver channels to a discovered external RTP/AES67 flow.

              netaudio [GLOBAL OPTIONS] flow subscribe-external [OPTIONS]

--source

Source IPv4 from the discovered SAP identity.

Value: text. Required.

--session-id

Unsigned SDP session ID.

Value: integer. Required.

--receiver-channels

Comma-separated receiver channel IDs.

Value: text. Required.

--flow-slots

Parallel one-based external-flow slots; zero leaves a receiver unassigned in this batch.

Value: text. Required.

--receiver-multiple-interfaces

Declare that the selected receiver supports multiple network interfaces.

--listen-seconds

Additional time to listen for the selected SAP announcement.

Value: number. Default: 1.0.

--yes, -y

Confirm the receiver subscription request.

`netaudio flow transmit-channel-capabilities`

Show the transmitter channel capability ranges reported by a device.

              netaudio [GLOBAL OPTIONS] flow transmit-channel-capabilities [OPTIONS]

--starting-channel

First transmitter channel identifier to query.

Value: integer. Default: 1.

--maximum-count

Maximum channels to return; zero requests all available channels.

Value: integer. Default: 0.

`netaudio flow delete`

Delete a TX multicast flow.

              netaudio [GLOBAL OPTIONS] flow delete [OPTIONS]

--slot

Flow slot number to delete.

Value: integer. Required.

--yes, -y

Confirm deletion of the active multicast flow.

`netaudio issues`

Inspect current and resolved monitoring issues without changing devices.

          netaudio [GLOBAL OPTIONS] issues COMMAND

`netaudio issues list`

List lifecycle-managed issues retained by the daemon.

              netaudio [GLOBAL OPTIONS] issues list [OPTIONS]

--state

Show open issues (current) or resolved issue history.

Value: open, resolved. Default: open.

--device

Match a device identity, name, or server name.

Value: text.

--kind

Filter by issue kind.

Value: address_conflict, subnet_conflict, clock_synchronization, clock_muted, clock_frequency_variation, bluetooth_link_lost, video_signal_failure, pullup_mismatch, subscription_failure, receiver_health_degraded, receiver_latency_pressure, receiver_late_packets, licensing_failure, safe_state, upgrade_required, reboot_required, configuration_partition_fault, persistence_fault, telemetry_stale, telemetry_missing, configuration_divergence.

--severity

Filter by severity.

Value: info, warning, error.

--limit

Maximum number of newest issues to show.

Value: integer. Default: 100.

`netaudio lock`

Device lock management.

          netaudio [GLOBAL OPTIONS] lock COMMAND

`netaudio lock set`

Lock the selected device with a 4-digit PIN.

              netaudio [GLOBAL OPTIONS] lock set PIN

PIN

4-digit numeric PIN to lock the device with.

Value: text. Required.

`netaudio lock clear`

Unlock the selected device with its 4-digit PIN.

              netaudio [GLOBAL OPTIONS] lock clear PIN

PIN

4-digit numeric PIN to unlock the device.

Value: text. Required.

`netaudio lock status`

Show device lock status.

              netaudio [GLOBAL OPTIONS] lock status

`netaudio lock key`

Lock key management.

              netaudio [GLOBAL OPTIONS] lock key COMMAND

`netaudio lock key get`

Show the current device lock key.

              netaudio [GLOBAL OPTIONS] lock key get

`netaudio lock key set`

Set the device lock key in config.

              netaudio [GLOBAL OPTIONS] lock key set VALUE

VALUE

Lock key value (32-char hex string).

Value: text. Required.

`netaudio lock key qr`

Show a QR code that imports the configured lock key into the netaudio iOS app.

              netaudio [GLOBAL OPTIONS] lock key qr [OPTIONS]

--output, -o

Write a PNG or SVG instead of rendering in the terminal.

Value: path.

--open

Open the generated QR code; creates a temporary PNG unless --output is given.

`netaudio lock key clear`

Remove the device lock key from config.

              netaudio [GLOBAL OPTIONS] lock key clear

`netaudio lock key extract`

Extract the device lock key from a Dante Controller installation.

              netaudio [GLOBAL OPTIONS] lock key extract [OPTIONS]

--path

Path to Dante Controller binary (libDanteController.dylib or .dll).

Value: path.

--save

Save extracted key to config.toml.

--qr

Render an iOS lock-key import QR code in the terminal.

--output, -o

Write the QR code to a PNG or SVG instead of the terminal; implies --qr.

Value: path.

--open

Open the generated QR code; implies --qr and creates a file.

`netaudio meter`

Device metering.

          netaudio [GLOBAL OPTIONS] meter [OPTIONS] COMMAND

--timeout, -t

Seconds to wait for fresh metering data.

Value: number. Default: 3.0.

--tx

Show only TX channels.

--rx

Show only RX channels.

--channel, -c

Filter by channel number or name (fnmatch glob). Repeatable.

Value: text. Can be given more than once.

--snapshot

Take a single snapshot instead of live display.

--detailed

Request detailed metering immediately for every selected device. By default, the interactive TUI uses advertised per-channel signal presence when available and otherwise requests detailed metering only from devices that advertise it.

`netaudio meter start`

Start persistent metering (requires daemon).

              netaudio [GLOBAL OPTIONS] meter start

`netaudio meter stop`

Stop persistent metering (requires daemon).

              netaudio [GLOBAL OPTIONS] meter stop

`netaudio meter measure-timeout`

Measure how long a device streams metering after a single start command.

              netaudio [GLOBAL OPTIONS] meter measure-timeout [OPTIONS]

--gap, -g

Seconds of silence before declaring stream ended.

Value: number. Default: 15.0.

--max-wait

Maximum seconds to listen.

Value: number. Default: 120.0.

`netaudio meter status`

Show which devices have persistent metering active.

              netaudio [GLOBAL OPTIONS] meter status

`netaudio preset`

Save and load device presets (DC-compatible XML).

          netaudio [GLOBAL OPTIONS] preset COMMAND

`netaudio preset save`

Save the selected devices' configuration as a preset.

              netaudio [GLOBAL OPTIONS] preset save [OPTIONS] OUTPUT

OUTPUT

Preset name in the preset directory, or an explicit .xml path.

Value: text. Required.

--name, -n

Preset name (defaults to filename).

Value: text.

--force

Replace an existing preset file.

`netaudio preset load`

Apply a saved preset to the devices it names.

              netaudio [GLOBAL OPTIONS] preset load [OPTIONS] INPUT_FILE

INPUT_FILE

Preset name in the preset directory, or an explicit .xml path.

Value: text. Required.

--dry-run

Show what would be applied without making changes.

--confirm-destructive

Confirm permanent transmitter-flow membership loss caused by sample-rate restoration.

--store-current-configuration

Request storage only after each changed device passes all effective-state readbacks.

`netaudio preset show`

Show what a saved preset would apply, without changing anything.

              netaudio [GLOBAL OPTIONS] preset show INPUT_FILE

INPUT_FILE

Preset name in the preset directory, or an explicit .xml path.

Value: text. Required.

`netaudio preset list`

List presets saved in the preset directory.

              netaudio [GLOBAL OPTIONS] preset list

`netaudio report`

Report issues with diagnostic context.

          netaudio [GLOBAL OPTIONS] report COMMAND

`netaudio report create`

Create a GitHub issue with diagnostic context.

              netaudio [GLOBAL OPTIONS] report create [OPTIONS]

--title, -t

Issue title.

Value: text. Required.

--description, -d

Description of the problem.

Value: text. Required.

--level, -l

Privacy level: minimal, network, full.

Value: text. Default: minimal.

--filter, -f

Only include matching devices (comma-separated globs against name, IP, MAC, model).

Value: text.

--session, -s

Attach packets from a capture session (ID or name).

Value: text.

--dry-run

Print the report without creating an issue.

`netaudio report levels`

List the privacy levels available for report content.

              netaudio [GLOBAL OPTIONS] report levels

`netaudio shure`

Shure wireless device control.

          netaudio [GLOBAL OPTIONS] shure COMMAND

`netaudio shure get`

Query a value from a Shure device.

              netaudio [GLOBAL OPTIONS] shure get [OPTIONS] KEY [HOST]

KEY

Key to query (e.g. CHAN_NAME, MODEL).

Value: text. Required.

HOST

Device IP or hostname (omit to auto-discover).

Value: text.

--device, -d

Device type (auto-detected).

Value: rep, report.

--channel, -c

Channel number.

Value: text.

--port, -p

TCP control port.

Value: integer.

`netaudio shure set`

Set a value on a Shure device.

              netaudio [GLOBAL OPTIONS] shure set [OPTIONS] KEY VALUE [HOST]

KEY

Key to set (e.g. CHAN_NAME, AUDIO_GAIN).

Value: text. Required.

VALUE

Value to set.

Value: text. Required.

HOST

Device IP or hostname (omit to auto-discover).

Value: text.

--device, -d

Device type (auto-detected).

Value: rep, report.

--channel, -c

Channel number.

Value: text.

--port, -p

TCP control port.

Value: integer.

`netaudio shure keys`

List the keys supported by a Shure protocol type.

              netaudio [GLOBAL OPTIONS] shure keys [OPTIONS]

--device, -d

Protocol type.

Value: rep, report. Required.

`netaudio shure associate`

Associate a Shure device with a Dante device.

              netaudio [GLOBAL OPTIONS] shure associate DEVICE_A [DEVICE_B]

DEVICE_A

Device identifier (MAC, IP, or name).

Value: text. Required.

DEVICE_B

Second device (omit to use -n/-h for Shure side).

Value: text.

`netaudio shure correlate`

Correlate a Shure device with a Dante device by metering activity.

              netaudio [GLOBAL OPTIONS] shure correlate [OPTIONS] [HOST]

HOST

Shure device IP or hostname.

Value: text.

--device, -d

Device type.

Value: rep, report.

--port, -p

Shure TCP control port.

Value: integer.

--dante

Dante device name filter.

Value: text.

--timeout, -t

Max seconds to wait for correlation.

Value: number. Default: 30.0.

--consecutive

Consecutive matching samples required.

Value: integer. Default: 5.

--save, --no-save

Save correlation to config.

Default: True.

`netaudio shure device`

Shure device commands.

              netaudio [GLOBAL OPTIONS] shure device COMMAND

`netaudio shure device list`

List discovered Shure devices.

              netaudio [GLOBAL OPTIONS] shure device list

`netaudio shure device show`

Show details for one Shure device.

              netaudio [GLOBAL OPTIONS] shure device show [OPTIONS] [HOST]

HOST

Device IP or hostname (omit to auto-discover).

Value: text.

--device, -d

Device type (auto-detected).

Value: rep, report.

--port, -p

TCP control port.

Value: integer.

`netaudio shure channel`

Shure channel commands.

              netaudio [GLOBAL OPTIONS] shure channel COMMAND

`netaudio shure channel list`

List channels on a Shure device.

              netaudio [GLOBAL OPTIONS] shure channel list [OPTIONS] [HOST]

HOST

Device IP or hostname.

Value: text.

--device, -d

Protocol type.

Value: rep, report.

--port, -p

TCP control port.

Value: integer.

`netaudio subscription`

Manage audio subscriptions.

          netaudio [GLOBAL OPTIONS] subscription COMMAND

`netaudio subscription list`

List configured subscriptions.

              netaudio [GLOBAL OPTIONS] subscription list [OPTIONS]

--all: Include unused receiver channels that have no configured source.

`netaudio subscription add`

Add subscriptions. Single: --tx tx:1@DEVICE --rx rx:1@DEVICE. Bulk: --tx DEVICE --rx DEVICE.

              netaudio [GLOBAL OPTIONS] subscription add [OPTIONS]

--tx

TX source: tx:1@DEVICE, 1@DEVICE, or NAME@DEVICE (single), or DEVICE (bulk 1:1).

Value: text. Required.

--rx

RX destination: rx:1@DEVICE, 1@DEVICE, or NAME@DEVICE (single), or DEVICE (bulk 1:1).

Value: text. Required.

--count, -c

Number of channels (bulk only, 0 = all available pairs).

Value: integer. Default: 0.

--offset-tx

Starting TX channel offset (bulk only, 0-based).

Value: integer. Default: 0.

--offset-rx

Starting RX channel offset (bulk only, 0-based).

Value: integer. Default: 0.

`netaudio subscription remove`

Remove subscriptions from RX channels. Supports bulk removal.

              netaudio [GLOBAL OPTIONS] subscription remove [OPTIONS]

--rx

RX channel to unsubscribe: rx:1@DEVICE, 1@DEVICE, or NAME@DEVICE (repeatable).

Value: text. Can be given more than once.

--all

Remove all subscriptions on devices selected by the global filters.

`netaudio virtual`

Virtual Dante device.

          netaudio [GLOBAL OPTIONS] virtual COMMAND

`netaudio virtual start`

Start the virtual Dante device.

              netaudio [GLOBAL OPTIONS] virtual start [OPTIONS]

--name, -n

Device name to advertise.

Value: text. Default: netaudio-virtual.

--model

Model name to advertise.

Value: text. Default: netaudio.

--tx

Number of transmitter channels.

Value: integer. Default: 2.

--rx

Number of receiver channels.

Value: integer. Default: 2.

--sample-rate, -r

Sample rate in Hz.

Value: integer. Default: 48000.

--interface, -i

Network interface to bind.

Value: text.

--foreground, -f

Run in the foreground instead of detaching.

`netaudio virtual stop`

Stop the virtual Dante device.

              netaudio [GLOBAL OPTIONS] virtual stop

`netaudio virtual restart`

Restart the virtual Dante device.

              netaudio [GLOBAL OPTIONS] virtual restart [OPTIONS]

--name, -n

Device name to advertise.

Value: text. Default: netaudio-virtual.

--model

Model name to advertise.

Value: text. Default: netaudio.

--tx

Number of transmitter channels.

Value: integer. Default: 2.

--rx

Number of receiver channels.

Value: integer. Default: 2.

--sample-rate, -r

Sample rate in Hz.

Value: integer. Default: 48000.

--interface, -i

Network interface to bind.

Value: text.

`netaudio virtual status`

Show whether the virtual Dante device is running.

              netaudio [GLOBAL OPTIONS] virtual status

`netaudio virtual logs`

Show the virtual Dante device log.

              netaudio [GLOBAL OPTIONS] virtual logs [OPTIONS]

--follow, -f

Follow the log as it grows.

--lines, -n

Number of trailing lines to show.

Value: integer. Default: 50.

Generated from netaudio 0.4.2 on PyPI.

NetAudio is unofficial and is not affiliated with or endorsed by Audinate.