CLI command: deploy

Use the
deploy
 command to deploy a
FactoryTalk Optix Application
 to a local device.

Guidelines

Consider the following when working with the
deploy
 command:
  • You need to perform any necessary versioning operations before the
    FactoryTalk Optix Application
     deployment.
  • You need to ensure that the
    FactoryTalk Optix Application
     builds without errors before the deployment.
  • You can only deploy
    FactoryTalk Optix Applications
     to local devices.
  • You cannot deploy
    FactoryTalk Optix Applications
     with encrypted secrets.
  • The
    deploy
     command does not start runtime by default. If you include
    --run-after-deploy
    , runtime starts automatically after deployment.

Syntax

"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] [--run-after-deploy] [--silent]
Parameters
Parameter
Importance
Description
version
Required
Folder name that reflects the installed
FactoryTalk Optix Studio
 version.
project_to_deploy
Required
Path to the
OPTIX
 file of the project to deploy.
ip_address
Required
IP address of the target device to deploy the
FactoryTalk Optix Application
 to.
username
Required
Username for logging on to the target device.
Windows®
 username
A system username:
  • DOMAIN\
    username
    , for domain users.
  • .username
    , for local users on domain-joined devices.
  • username
    , for local users on devices that do not belong to a domain.
Linux username
An administrator username.
IMPORTANT: Specify user password as a
OPTIX_STUDIO_DEPLOYMENT_PASSWORD
 system environment variable.
--thumbprint=
certificate_thumbprint
Optional
Provide certificate thumbprint of the target FactoryTalk Optix Application Update Service to prevent the need to interact with the trust dialog.
The trust dialog displays only for the first deployment.
Ensure that the FactoryTalk Optix Runtime Tools and Update Service are installed. Then, you can obtain the thumbprint by running this command
openssl x509 -fingerprint -in
UpdateServicePath
/PKI/Own/Certs/FTOptixApplication.der -inform DER -noout
where
UpdateServicePath
 is the installation directory of the FactoryTalk Optix Application Update Service.
TIP: Embedded devices cannot generate certificate thumbprints.
--disable-project-encryption
Optional
Disable project encryption.
--disable-source-project-transfer
Optional
Disable the transfer of the source project to the target device.
IMPORTANT: You can only transfer source projects to Windows target devices.
--transfer-optimized-project
Optional
Optimize the project before its transfer.
Optimized projects:
  • Are smaller in size because nodes are only loaded when needed at runtime.
  • Keep tags in an external tag repository and not in the project repository.
  • May require more time to load and change screens on low performance devices.
You cannot optimize projects containing OPC UA servers that expose the entire model or at least one tag.
--run-after-deploy
Optional
Start runtime automatically after deployment.
If you omit this parameter, the
deploy
 command does not start runtime and will require a manual restart after deployment.
--silent
Optional
Make the command output non-verbose in the command prompt.

Example

"C:\Program Files\Rockwell Automation\FactoryTalk Optix\Studio 1.6.0.626\FTOptixStudio" deploy "D:\temp\NewHMIProject28\NewHMIProject28.optix" --ip-address=192.168.1.100 --username=admin --transfer-application-files
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal