This guide contains command tools that allow your applications to make use of the resources on Synology DiskStation and also includes a list of Synology Error Numbers for reference.

Chapter 1: Introduction

This guide contains command tools that allow your applications to make use of the resources on Synology DiskStation and also includes a list of Synology Error Numbers for reference.

Chapter 2: Synology NAS Administrative Commands

Managing local users — synouser

Synopsis

synouser {--help}
synouser {--add} username passwd full_name expired email app_privilege
synouser {--del} username...
synouser {--rename} old_username new_username
synouser {--modify} username passwd full_name expired email

Description

Restrictions

username:

• Not case sensitive, limited from 1 to 64 UTF-8 characters
• Excluded symbols: ! " # $ % & ' ( ) * + , / : ; < = > ? @ [ ] \ ^ \{} | ~`
• First character cannot be a minus sign or space; last character cannot be a space

passwd:

• Case sensitive, up to 127 displayable characters
• Blank password is allowed

full_name:

• Up to 64 displayable UTF-8 characters, can be empty

expired:

• 0: Account never expires
• 1: Account has expired

email:

• User email address, can be empty

app_privilege:

• Decimal number for user application access privileges, constructed from the sum of:
  • FTP: 0x01
  • File Station: 0x02
  • Audio Station: 0x04
  • Download Station: 0x08
  • Example: A user with FTP, Audio Station, and Surveillance Station access has value 21 (21 = 0x01 + 0x04 + 0x10)

Exit Status

Returns 0 on success, or >0 if any error occurs.

Examples

# Change admin password to "1"
DiskStation> /usr/syno/sbin/synouser --setpw admin 1

# Create user syno with password '1', full name 'Synology Inc.', accessible to FTP, File Station, Audio Station, Download Station, and Surveillance Station
DiskStation> /usr/syno/sbin/synouser --add syno 1 "Synology Inc." 0 synology@example.com 31

Managing local groups — synogroup

Synopsis

synogroup {--help}
synogroup {--add} groupname username...
synogroup {--del} groupname...
synogroup {--rename} old_groupname new_groupname
synogroup {--member} groupname username...

Description

Restrictions

groupname:

• Not case sensitive, limited from 1 to 15 UTF-8 characters
• Excluded symbols: ! " # $ % & ' ( ) * + , / : ; < = > ? @ [ ] \ {} | ~`
• First character cannot be a minus sign or space; last character cannot be a space

Exit Status

Returns 0 on success, or >0 if any error occurs.

Managing share folder information — synoshare

Synopsis

synoshare {--help}
synoshare {--add} sharename share_desc share_path user_list_na user_list_rw user_list_ro share_browsable adv_privilege
synoshare {--del} {TRUE | FALSE} sharename...
synoshare {--rename} old_sharename new_sharename
synoshare {--setuser} sharename {NA | RO | RW} {+ | - | =} user_list

Description

Access Privilege Types:

• NA: No access
• RO: Read-only
• RW: Read/Write

Action Types:

• +: Append user list to original privilege list
• -: Remove user list from original privilege list
• =: Replace original privilege list with new user list

Restrictions

sharename:

• Not case sensitive, limited from 1 to 32 UTF-8 characters
• Excluded symbols: ! " # $ % & ' ( ) * + , / : ; < = > ? @ [ ] \ {} | ~`
• First character cannot be a minus sign or space; last character cannot be a space
• Reserved names (cannot use): global, homes, home, printers, ., .., surveillance, usbbackup, usbshare, esatashare

share_path:

• Must be a valid directory path. If path does not exist, synoshare will create it automatically

share_browsable:

• 1: Show shared folder in “My Network Places”
• 0: Hide shared folder from “My Network Places” (users with proper access can still access directly)

adv_privilege (Advanced Privilege):

• Decimal number, sum of:
  • Disable directory browsing: 0x1
  • Disable modification of existing files: 0x2
  • Disable file downloading: 0x4

Exit Status

Returns 0 on success, or >0 if any error occurs.

Examples

# Create share 'private' with empty access list
DiskStation> /usr/syno/sbin/synoshare --add private "Comment" /volume1/private "" "" "" 1 0

# Add user syno and group stuff with read/write permission to share 'private'
DiskStation> /usr/syno/sbin/synoshare --setuser private RW + syno,@stuff

Managing network settings — synonet

Synopsis

synonet {--help}
synonet {--dhcp} iface
synonet {--manual} iface ip mask [--dont restart service]
synonet {--set_gateway} gateway
synonet {--set_dns} dns
synonet {--set_mtu} iface MTU
synonet {--set_hostname} hostname [--dont restart service]

Description

Restrictions

iface (Network Interface):

• Only eth0 or eth1 (eth1 only supported on NAS with two LAN ports)

hostname:

• Not case sensitive, limited from 1 to 15 displayable characters
• Can contain letters, numbers, underscores, and minus signs
• First character must be a letter

MTU:

• Allowed values: 1500, 2000, 3000, 4000, 5000, 6000, 7000, 8000, 9000
• Only effective when DiskStation is connected to Gigabit network

Exit Status

Returns 0 on success, or >0 if any error occurs.

Examples

# Set eth0 to manual IP: IP=192.168.14.64, Netmask=255.255.0.0
DiskStation> /usr/syno/sbin/synonet --manual eth0 192.168.14.64 255.255.0.0
DiskStation> /usr/syno/sbin/synonet --set_gateway 192.168.15.254
DiskStation> /usr/syno/sbin/synonet --set_dns 192.168.252.254

# Set new hostname to cn406e
DiskStation> /usr/syno/sbin/synonet --set_hostname cn406e

Managing setting of services — synoservice

Synopsis

synoservice {--help}
synoservice {--list} [running]
synoservice {--enable | --disable} service...
synoservice {--start | --stop | --restart} service...
synoservice {--keyon | --keyoff} service...
synoservice {--detail} service...

Description

Available Services

web (Web Station), photo (Photo Station), netbkp (Network Backup), download (Download Station), media (DLNA), audio (Audio Station), itunes (iTunes), mysql (MySQL), printer (Printer), surveillance (Surveillance Station), userhome (User Home), ftp (FTP), telnet, ssh, nfs, afp (Apple File Protocol), samba (CIFS), filestation (File Station), https (HTTPS)

Exit Status

Returns 0 on success, or >0 if any error occurs.

Examples

# Enable SSH service
DiskStation> /usr/syno/sbin/synoservice --enable ssh

# Enable SSH in ds_configure.sh during group install (use --keyon instead of --enable, as services are not started yet)
# ds_configure.sh
/usr/syno/sbin/synoservice --keyon ssh

Managing workgroup or ADS domain setting — synowin

Synopsis

synowin {--help}
synowin {--joinWorkgroup} workgroup
synowin {--joinDomain} {short_domain_name | full_domain_name} username password [-d dns_ip] [-i kdc_ip] [-n netbios_name] [-f fqdn_name]

Description

Restrictions

workgroup:

• Length 1 to 15 characters
• Excluded characters: [ ] ; : " < > * + = \ / | ? ,
• Note: If workgroup name contains &, Mac OS 10.4.4 and earlier users cannot connect via samba

domain_name:

• Domain with period (e.g., synology.com) is treated as full domain name
• Domain without period (e.g., synology) is treated as short domain name

kdc_ip (Domain Controller IP):

• Can specify multiple DC IPs, separated by commas
• Add * after last IP for failover

Exit Status

Returns 0 on success, or >0 if any error occurs.

Chapter 3: Synology Error Numbers

Error Numbers Table

Copyright Notice

© 2015-2021 Synology Inc. All rights reserved.

No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, mechanical, electronic, photocopying, recording, or otherwise, without prior written permission of Synology Inc.

Source: Synology DiskStation Administration CLI Guide