本文档包含命令行工具，使应用程序能够利用群晖DiskStation上的资源，同时包含群晖错误代码参考列表。

第一章：简介

本文档包含命令行工具，使您的应用程序能够利用群晖DiskStation上的资源，同时包含群晖错误代码参考列表。

第二章：群晖NAS管理命令

管理本地用户 — synouser

概要

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

描述

限制条件

username（用户名）：

• 不区分大小写，长度限制为1到64个UTF-8字符
• 禁止使用的符号：! " # $ % & ' ( ) * + , / : ; < = > ? @ [ ] \ ^ \{} | ~`
• 首个字符不能是减号或空格，末尾字符不能是空格

passwd（密码）：

• 区分大小写，最多127个可显示字符
• 可以设置为空密码

full_name（全名）：

• 最多64个可显示UTF-8字符，可以为空

expired（过期）：

• 0：账户永不过期
• 1：账户已过期

email（邮箱）：

• 用户邮箱地址，可以为空

app_privilege（应用权限）：

• 使用十进制数字设置用户访问应用的权限，值为以下值的和：
  • FTP：0x01
  • File Station：0x02
  • Audio Station：0x04
  • Download Station：0x08
  • 例如：同时具有FTP、Audio Station和Surveillance Station权限的值为21（21 = 0x01 + 0x04 + 0x10）

退出状态

synouser成功退出返回0，否则返回大于0的值。

示例

# 修改admin密码为"1"
DiskStation> /usr/syno/sbin/synouser --setpw admin 1

# 创建用户syno，密码为"1"，全名为"Synology Inc."，可访问FTP、File Station、Audio Station、Download Station和Surveillance Station
DiskStation> /usr/syno/sbin/synouser --add syno 1 "Synology Inc." 0 synology@example.com 31

管理本地用户组 — synogroup

概要

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

描述

限制条件

groupname（组名）：

• 不区分大小写，长度限制为1到15个UTF-8字符
• 禁止使用的符号：! " # $ % & ' ( ) * + , / : ; < = > ? @ [ ] \ {} | ~`
• 首个字符不能是减号或空格，末尾字符不能是空格

退出状态

synogroup成功退出返回0，否则返回大于0的值。

管理共享文件夹信息 — synoshare

概要

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

描述

访问权限类型：

• NA：无访问权限
• RO：只读权限
• RW：读写权限

操作类型：

• +：追加用户列表到原权限列表
• -：从原权限列表移除用户列表
• =：替换原权限列表为新用户列表

限制条件

sharename（共享名）：

• 不区分大小写，长度限制为1到32个UTF-8字符
• 禁止使用的符号：! " # $ % & ' ( ) * + , / : ; < = > ? @ [ ] \ {} | ~`
• 首个字符不能是减号或空格，末尾字符不能是空格
• 保留名称（不可用）：global、homes、home、printers、.、..、surveillance、usbbackup、usbshare、esatashare

share_path（共享路径）：

• 必须是有效的目录路径。如果路径不存在，synoshare会自动创建

share_browsable（在"网络邻居"中显示）：

• 1：在"网络邻居"中显示共享文件夹
• 0：隐藏共享文件夹（隐藏后，拥有权限的用户仍可直接访问）

adv_privilege（高级权限）：

• 使用十进制数字，可选值或以下值的和：
  • 禁用目录浏览：0x1
  • 禁用修改现有文件：0x2
  • 禁用文件下载：0x4

退出状态

synoshare成功退出返回0，否则返回大于0的值。

示例

# 创建名为'private'的共享，空访问列表
DiskStation> /usr/syno/sbin/synoshare --add private "Comment" /volume1/private "" "" "" 1 0

# 向共享'private'添加用户syno和组stuff，拥有读写权限
DiskStation> /usr/syno/sbin/synoshare --setuser private RW + syno,@stuff

管理网络设置 — synonet

概要

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]

描述

限制条件

iface（网络接口）：

• 只能是eth0或eth1（仅双网口NAS支持eth1）

hostname（主机名）：

• 不区分大小写，长度限制为1到15个可显示字符
• 只能包含字母、数字、下划线和减号
• 首字符必须是字母

MTU：

• 可选值：1500、2000、3000、4000、5000、6000、7000、8000、9000
• 仅在千兆网络连接时生效

退出状态

synonet成功退出返回0，否则返回大于0的值。

示例

# 手动设置eth0：IP=192.168.14.64，子网掩码=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

# 设置新主机名为cn406e
DiskStation> /usr/syno/sbin/synonet --set_hostname cn406e

管理服务设置 — synoservice

概要

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

描述

支持的服务列表

web（Web Station）、photo（Photo Station）、netbkp（网络备份）、download（Download Station）、media（DLNA）、audio（Audio Station）、itunes（iTunes）、mysql（MySQL）、printer（打印机）、surveillance（Surveillance Station）、userhome（用户家目录）、ftp（FTP）、telnet、ssh、nfs、afp（Apple File Protocol）、samba（CIFS）、filestation（File Station）、https（HTTPS）

退出状态

synoservice成功退出返回0，否则返回大于0的值。

示例

# 启用SSH服务
DiskStation> /usr/syno/sbin/synoservice --enable ssh

# 在ds_configure.sh中启用SSH（使用--keyon而非--enable，因为此时服务尚未启动）
/usr/syno/sbin/synoservice --keyon ssh

##管理工作组或ADS域设置 — synowin

概要

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]

描述

限制条件

workgroup（工作组名）：

• 长度1到15个字符
• 禁止使用：[ ] ; : " < > * + = \ / | ? ,
• 注意：如果工作组名包含&字符，Mac OS 10.4.4及更早版本的用户将无法通过samba连接

domain_name（域名）：

• 含句点的域名（如synology.com）视为完整域名
• 不含句点的域名（如synology）视为短域名

kdc_ip（域控制器IP）：

• 可指定多个DC IP，用逗号分隔
• 在最后一个IP后加*可实现故障转移

退出状态

synowin成功退出返回0，否则返回大于0的值。

第三章：群晖错误代码

错误代码表

版权声明

© 2015-2021 群晖科技股份有限公司保留所有权利。

本文档版权归群晖科技股份有限公司所有，未经书面许可，禁止以任何形式复制、存储或传播。

来源：Synology DiskStation Administration CLI Guide