Dev Center

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

--add

--del

--rename

--modify

The format or limitation of each argument is described in Restrictions. Only the super-user is permitted to run this utility.

username The user name is not case sensitive and limited from 1 to 64 UTF-8 characters, excluding the following symbols: ! " # $ % & ' ( ) * + , / : ; < = > ? @ [ ] \ ^ ` { } | ˜

The first character cannot be a minus sign or a space, and the last character cannot be a space.

passwd The password is case sensitive and limited up to 127 displayable characters, including letters, numbers, signs, and space.

You may choose an empty password or specify your own password, which will be encrypted before being stored in the user database.

full_name The user description can include up to 64 displayable UTF-8 characters. This field may be left empty.

expired This account is expired or not. You should specify 0 (not expired) or 1 (expired).

email The email address of this user. This field may be left empty.

app_privilege Set a decimal number to assign user's privilege to access applications. You may choose 0 to make this user access no application or a number constructed from the sum of the following values:

FTP
Value 0x01
File Station
Value 0x02
Audio Station
Value 0x04
Download Station
Value 0x08
Surveillance Station
Value 0x10

For example, the value of a user's privilege who is able to access FTP, Audio Station and Surveillance Station is 21 (21 = 0x15 = 0x01 + 0x04 + 0x10).

The synouser utility returns 0 when exits successfully, or >0 if any error occurs.

When user is created, no welcome email will be sent.

The following example shows how to change the admin password to "1".

Create user syno with password '1' and full name 'Synology Inc.'. Applications that this user can access are FTP, File Station, Audio Station, Download Station and Surveillance Station.

synogroup {--help}

synogroup {--add} groupname username...

synogroup {--del] groupname...

synogroup {--rename} old groupname new groupname

synogroup {--memberg} groupname username...

--add

--del

--rename

--member

The format or limitation of each argument is described in Restrictions. Only the super-user is permitted to run this utility.

groupname The group name is not case sensitive and limited from 1 to 15 UTF-8 characters, excluding the following symbols: ! " # $ % & ’ ( ) * + , / : ; < = > ? @ [ ] n ˆ ` { } | ˜

The first character cannot be a minus sign or a space, and the last character cannot be a space.

The synogroup utility returns 0 when exits successfully, or >0 if any error occurs.

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

--add

--del

--rename

--setuser

NA
Modify the list of deny-access.
RO
Modify the list of read-only privilege.
RW
modify the list of read/write privilege.
The fourth parameter is the action to the user list of access privilege.
+ Append the user_list to the original user list of access privilege
- Remove the user_list from the original user list of access privilege
= Replace the original user list of access privilege with the new user_list

The format or limitation of each argument is described in Restrictions. Only the super-user is permitted to run this utility.

sharename The shared folder names are not case sensitive and limited from 1 to 32 UTF-8 characters, excluding the following symbols: ! " # $ % & ’ ( ) * + , / : ; <= > ? @ [ ] n ˆ ` { } | ˜

The first character of a shared folder name cannot be a minus sign or a space, and the last character cannot be a space character either.

Shared folder names in the following are reserved for system use only:

• global
• homes
• home
• printers
• .
• ..
• surveillance
• usbbackup
• usbshare
• esatashare

share_description The shared folder description is case sensitive and limited up to 64 displayable Unicode characters. It can be an empty string.

share_path It has to be a valid directory to the shared folder. If the path is not existed, synoshare will create it automatically.

user_list Separate each username with a comma, ",". It allows groupname as well, but please append "@" in front of the groupname. It will return an error if either username or groupname does not exist.

Ex. 'user1,user2,@group3'

share_browsable 1, show a shared folder in "My Network Places." 0, hide a shared folder in "My Network Places."

Hiding a shared folder in "My Network Places" does not affect its access right. The access right of the hidden shared folder will remain unchanged. Users who have the proper access rights to the shared folder can still access it by entering "\\server name\shared folder name".

adv privilege Configure the advanced privileges of this shared folder. When accessing this folder with FTP or File Station, the following settings will be applied in addition to the current shared folder privileges.

You should specify this value in decimal. You may choose 0 or a number constructed from the sum of the following values:

Disable directory browsing Value: 0x1

Disable modification of existing files Value: 0x2

Disable file downloading Value: 0x4

adv privilege Configure the advanced privileges of this shared folder. When accessing this folder with FTP or File Station, the following settings will be applied in addition to the current shared folder privileges.

The synoshare utility returns 0 when exits successfully, or >0 if any error occurs.

Create share 'private' with empty access list.

Add user syno and group stuff with read/write permission in share 'private'.

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]

--dhcp

--manual

--set_gateway

--set_dns

--set_mtu

--set_hostname

The format or limitation of each argument is described in Restrictions. Only the super-user is permitted to run this utility.

iface It is limited to the following two strings only:

eth0

eth1 (Supported on DiskStation with two LAN ports only)

ip, mask, gateway, dns Those inputs should be in the format of IPv4.

hostname The server name is not case sensitive and limited from 1 to 15 displayable characters, which may consist of letters, numbers, underscores and minus signs. The first character must be a letter.

MTU It is limited to the following values only:

1500

2000

3000

4000

5000

6000

7000

8000

9000

The synonet utility returns 0 when exits successfully, and >0 if any error occurs.

The below example will show you how to manually assign eth0 with the following information:

IP: 192.168.14.64

Netmask: 255.255.0.0

Default gateway: 192.168.15.254

DNS server: 192.168.252.254

The below example will show you how to set your DiskStation to the new Hostname, cn406e.

synoservice {--help}

synoservice {--list} [running]

synoservice {--enable | --disable} service...

synoservice {--start | --stop | --restart} service...

synoservice {--keyon | --keyoff} service...

synoservice {--detail} service...

--list

--enable, --disable

--start, --stop, --restart

--keyon, --keyoff

--detail

service The settings of the following services are available to be set up.

web Web Station

photo Photo Station

netbkp Network backup service

download Download Station

media DLNA service

audio Audio Station

itunes iTunes service

mysql MySQL service

printer Printer service

surveillance Surveillance Station

userhome User Home Service

ftp FTP server

telnet Telnet service

ssh SSH service

nfs NFS service

afp Apple File Protocol service

samba CIFS service

filestation File Station

https HTTPS service

The synoservice utility returns 0 when exits successfully, or >0 if any error occurs.

To enable ssh service

To enable ssh in ds_configure.sh when group install. Use --keyon instead of --enable, because the services are not started when ds_configure.sh is called.

synowin {--help}

synowin {--joinWorkgroup} workgroup

synowin {--joinDomai} {short_domain_name | full_domain_name} username password [-d dns_ip] [-i kdc_ip] [-n netbios_name] [-f fqdn_name]

--joinWorkgroup

--joinDomain

workgroup The name of a Workgroup can contain 1 to 15 characters. Invalid characters include: [ ] ; : " < > * + = n / | ? ,

If your workgroup name includes the character '&', users of Mac OS 10.4.4 or earlier versions will not be able to connect to DiskStation via samba.

domain_name If the input domain contains period, ”synology.com”, it will be treated as full domain name. If it is "synology", it will be treated as short domain name.

kdc_ip The DC (Domain Controller) IP.

Specify a DC IP and DiskStation will try to communicate with it. If there is more than one IP, insert a comma in between each of them. Add an asterisk (*) after the last DC IP if you wish, and DiskStation will try to communicate with other DC when all specified ones failed. You will need to add a comma between the asterisk and the last IP.

netbios_name The NetBIOS name of the domain.

fqdn_name The FQDN (DNS name) of the domain.

The synowin utility returns 0 when exits successfully, or >0 if any error occurs.