CLI 命令

FactoryTalk Optix Studio
 包含以下命令行界面 (Command-Line Interface, CLI) 命令。
小贴士:
以下命令假定您将
FactoryTalk Optix Studio
 安装在默认位置。如果将
FactoryTalk Optix Studio
 安装在自定义位置，请相应地修改路径。
要缩短命令并使用
FTOptixStudio
 调用可执行文件，请添加系统环境变量或导航到
FactoryTalk Optix Studio
 安装目录。
小贴士:
--help
、
-h
 和
--version
 命令优先于其他命令。
--help
 和
-h
 优先于
--version
。

open

open
 命令用于在
FactoryTalk Optix Studio
 中打开项目。
"C:\Program Files\Rockwell Automation\FactoryTalk Optix\
version
\FTOptixStudio" --open
project_to_open
 [--silent]
参数
参数
重要程度
说明
version
必填
反映已安装
FactoryTalk Optix Studio
 版本的文件夹名称。
project_to_open
必填
要打开的项目的
OPTIX
 文件的路径。
--silent
可选的
在命令提示符下不提供详细的命令输出。

new

new
 命令用于创建项目。
"C:\Program Files\Rockwell Automation\FactoryTalk Optix\
version
\FTOptixStudio" --new
project_to_create
path
 [-e | --encrypt-secrets] [--template=
template
] [--main-window-width==
width
] [--main-window-height==
height
] [-l | --in-project-location] [--silent]
参数
参数
重要程度
说明
version
必填
反映已安装
FactoryTalk Optix Studio
 版本的文件夹名称。
project_to_create
必填
项目的名称。
path
必填
项目的位置。
-e
 或
--encrypt-secrets
可选的
对项目中的敏感信息进行加密。
--template=
template
可选的
要用于项目的模板的名称。
template
 允许的值为：
  • main
     (default)
  • optixPanel
  • empty
--main-window-width=
width
可选的
主窗口的宽度（以像素为单位）。默认宽度为
400
 像素
--main-window-height=
height
可选的
主窗口的高度（以像素为单位）。默认高度为
400
 像素
-l
 或
--in-project-location
可选的
直接在
path
 下创建项目
--silent
可选的
在命令提示符下不提供详细的命令输出。

connect

connect
 命令用于连接
FactoryTalk Optix Studio
 和端点。
"C:\Program Files\Rockwell Automation\FactoryTalk Optix\
version
\FTOptixStudio" --connect
endpoint
 [--silent]
参数
参数
重要程度
说明
endpoint
必填
要连接的端点的 IP 地址。
--silent
可选的
在命令提示符下不提供详细的命令输出。

deploy

deploy
 命令用于将
FactoryTalk Optix 应用程序
 部署到本地设备。
使用
deploy
 命令时请注意以下事项：
  • 在部署
    FactoryTalk Optix 应用程序
     之前，必须执行任何必要的版本控制操作。
  • 在部署之前，必须确保
    FactoryTalk Optix 应用程序
     生成且没有错误。
  • 只能将
    FactoryTalk Optix 应用程序
     部署到本地设备。
  • 不能使用加密的敏感信息部署
    FactoryTalk Optix 应用程序
    。
"C:\Program Files\Rockwell Automation\FactoryTalk Optix\
version
\FTOptixStudio" deploy
project_to_deploy
 --ip-address=
ip_address
 --username=
username
 [--thumbprint=
certificate_thumbprint
] [--disable-project-encryption] [--disable-source-project-transfer] [--transfer-application-files] [--transfer-optimized-project] [--silent]
参数
参数
重要程度
说明
version
必填
反映已安装
FactoryTalk Optix Studio
 版本的文件夹名称。
project_to_deploy
必填
要部署的项目的
OPTIX
 文件的路径。
ip_address
必填
要部署
FactoryTalk Optix 应用程序
 的目标设备的 IP 地址。
username
必填
用于登录目标设备的用户名
Windows®
 用户名
系统用户名：
  • DOMAIN\
    username
    ，适用于域用户。
  • .username
    ，适用于已加入域的设备上的本地用户。
  • username
    ，适用于不属于域的设备上的本地用户。
Linux 用户名
管理员用户名。
重要提示: 将用户密码指定为
OPTIX_STUDIO_DEPLOYMENT_PASSWORD
 系统环境变量。
--thumbprint=
certificate_thumbprint
可选的
提供目标 FactoryTalk Optix 应用程序更新服务的证书指纹，以防止需要与信任对话框进行交互。
仅第一个部署会显示信任对话框。
确保已安装 FactoryTalk Optix Runtime 工具和更新服务。然后，可以通过运行以下命令来获取指纹：
openssl x509 -fingerprint -in
UpdateServicePath
/PKI/Own/Certs/FTOptixApplication.der -inform DER -noout
其中，
UpdateServicePath
 是 FactoryTalk Optix 应用程序更新服务的安装目录。
--disable-project-encryption
可选的
禁用项目加密。
--disable-source-project-transfer
可选的
禁止将源项目传输到目标设备。
重要提示: 只能将源项目传输到 Windows 目标设备。
--transfer-optimized-project
可选的
在传输项目前对其进行优化。
优化项目：
  • 之所以大小比较小，是因为节点仅在运行时需要时加载。
  • 将标签保存在外部标签存储库中，而不是项目存储库中。
  • 可能需要更多时间来加载和更改低性能设备上的屏幕。
无法优化包含公开整个模型或至少一个标签的 OPC UA 服务器的项目。
--silent
可选的
在命令提示符下不提供详细的命令输出。

export

export
 命令用于将
FactoryTalk Optix 应用程序
 导出到文件。
"C:\Program Files\Rockwell Automation\FactoryTalk Optix\
version
\FTOptixStudio" export
project_to_export
 --platform=
platform
 --location=
location
 [--silent]
示例：
"C:\Program Files\Rockwell Automation\FactoryTalk Optix\
version
\FTOptixStudio" deploy "D:\Device Sizing Tool\Projects\BlankProject\BlankProject.optix" --ip-address=172.19.16.187 --username=admin
使用
export
 命令时请注意以下事项：
  • 在导出之前，需要确保
    FactoryTalk Optix 应用程序
     生成且没有错误。
  • 不能为导出的
    FactoryTalk Optix 应用程序
     设置密码。
  • 不能导出带加密敏感信息的
    FactoryTalk Optix 应用程序
    。
参数
参数
重要程度
说明
version
必填
反映已安装
FactoryTalk Optix Studio
 版本的文件夹名称。
project_to_export
必填
要部署的项目的
OPTIX
 文件的路径。
--location=
location
必填
用于保存
FactoryTalk Optix 应用程序
 的位置的路径。
--silent
可选的
在命令提示符下不提供详细的命令输出。

--help

--help
 或
-h
 参数用于在命令提示符下显示可用命令的摘要。
小贴士: 在使用非预期的参数时也会显示帮助。
"C:\Program Files\Rockwell Automation\FactoryTalk Optix\
version
\FTOptixStudio" --help

--version

--version
 参数用于显示
FactoryTalk Optix Studio
 版本。
"C:\Program Files\Rockwell Automation\FactoryTalk Optix\
version
\FTOptixStudio" --version
提供反馈
对本文档有问题或反馈吗？ 请在这里提交您的反馈 。