CLI-Befehle

CLI-Befehle

FactoryTalk Optix Studio
enthält die folgenden Befehle der Befehlszeilenschnittstelle (CLI).
TIPP:
Bei den folgenden Befehlen wird davon ausgegangen, dass Sie die Installation von
FactoryTalk Optix Studio
am Standardspeicherort durchgeführt haben. Wenn Sie einen benutzerdefinierten Speicherort für Ihre
FactoryTalk Optix Studio
-Installation ausgewählt haben, ändern Sie die Pfade entsprechend.
Um die Befehle zu kürzen und die ausführbare Datei mit
FTOptixStudio
aufzurufen, fügen Sie eine Systemumgebungsvariable hinzu oder navigieren Sie zum Installationsverzeichnis von
FactoryTalk Optix Studio
.
TIPP: Die Befehle
--help
,
-h
und
--version
haben Vorrang vor anderen Befehlen.
--help
und
-h
haben Vorrang vor
--version
.

open

Verwenden Sie den Befehl
open
, um ein Projekt in
FactoryTalk Optix Studio
zu öffnen.
"C:\Program Files\Rockwell Automation\FactoryTalk Optix\
version
\FTOptixStudio" --open
project_to_open
[--silent]
Parameter
Parameter
Wichtigkeit
Beschreibung
version
Erforderlich
Ordnername, der die installierte
FactoryTalk Optix Studio
-Version widerspiegelt.
project_to_open
Erforderlich
Pfad zur
OPTIX
-Datei des zu öffnenden Projekts.
--silent
Optional
Festlegen, dass die Befehlsausgabe in der Eingabeaufforderung nicht ausführlich ist.

new

Mit diesem Befehl
new
können Sie ein Projekt erstellen.
"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]
Parameter
Parameter
Wichtigkeit
Beschreibung
version
Erforderlich
Ordnername, der die installierte
FactoryTalk Optix Studio
-Version widerspiegelt.
project_to_create
Erforderlich
Name für das Projekt.
path
Erforderlich
Speicherort für das Projekt.
-e
oder
--encrypt-secrets
Optional
Geheimnisse im Projekt verschlüsseln.
--template=
template
Optional
Name der Vorlage, die für das Projekt verwendet werden soll.
Die zulässigen Werte für
template
sind:
  • main
    (default)
  • optixPanel
  • empty
--main-window-width=
width
Optional
Breite für das Hauptfenster in Pixel. Die Standardbreite ist
400
Pixel.
--main-window-height=
height
Optional
Höhe des Hauptfensters in Pixel. Die Standardhöhe ist
400
Pixel.
-l
oder
--in-project-location
Optional
Das Projekt direkt unter
path
erstellen.
--silent
Optional
Festlegen, dass die Befehlsausgabe in der Eingabeaufforderung nicht ausführlich ist.

connect

Verwenden Sie den Befehl
connect
, um eine Verbindung von
FactoryTalk Optix Studio
mit einem Endpunkt herzustellen.
"C:\Program Files\Rockwell Automation\FactoryTalk Optix\
version
\FTOptixStudio" --connect
endpoint
[--silent]
Parameter
Parameter
Wichtigkeit
Beschreibung
endpoint
Erforderlich
Die IP-Adresse des Endpunkts, zu dem eine Verbindung hergestellt werden soll.
--silent
Optional
Festlegen, dass die Befehlsausgabe in der Eingabeaufforderung nicht ausführlich ist.

deploy

Mit dem Befehl
deploy
können Sie eine
FactoryTalk Optix-Anwendung
auf einem lokalen Gerät bereitstellen.
Beachten Sie beim Arbeiten mit dem Befehl
deploy
Folgendes:
  • Sie müssen alle erforderlichen Versionsverwaltungsvorgänge vor der
    FactoryTalk Optix-Anwendung
    -Bereitstellung ausführen.
  • Sie müssen sicherstellen, dass die
    FactoryTalk Optix-Anwendung
    vor der Bereitstellung fehlerfrei erstellt wird.
  • Sie können
    FactoryTalk Optix-Anwendungen
    nur auf lokalen Geräten bereitstellen.
  • Sie können
    FactoryTalk Optix-Anwendungen
    nicht mit verschlüsselten Geheimnissen bereitstellen.
"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]
Parameter
Parameter
Wichtigkeit
Beschreibung
version
Erforderlich
Ordnername, der die installierte
FactoryTalk Optix Studio
-Version widerspiegelt.
project_to_deploy
Erforderlich
Pfad zur
OPTIX
-Datei des bereitzustellenden Projekts.
ip_address
Erforderlich
IP-Adresse des Zielgeräts, auf dem die
FactoryTalk Optix-Anwendung
bereitgestellt werden soll.
username
Erforderlich
Benutzername für die Anmeldung beim Zielgerät
Windows®
-Benutzername
Ein Systembenutzername:
  • DOMAIN\
    username
    : für Domänenbenutzer.
  • .username
    : für lokale Benutzer auf Geräten, die der Domäne beigetreten sind.
  • username
    : für lokale Benutzer auf Geräten außerhalb der Domäne.
Linux-Benutzername
Ein Administrator-Benutzername.
WICHTIG: Geben Sie das Benutzerpasswort als Systemumgebungsvariable
OPTIX_STUDIO_DEPLOYMENT_PASSWORD
an.
--thumbprint=
certificate_thumbprint
Optional
Zertifikat-Fingerabdruck des Update-Diensts der Ziel-FactoryTalk Optix-Anwendung bereitstellen, um zu verhindern, dass mit dem Dialogfeld für die Vertrauensstellung interagiert werden muss.
Das Dialogfeld für die Vertrauensstellung wird nur für die erste Bereitstellung angezeigt.
Stellen Sie sicher, dass die FactoryTalk Optix Runtime-Tools und der Update-Dienst installiert sind. Anschließend können Sie den Fingerabdruck abrufen, indem Sie den folgenden Befehl ausführen:
openssl x509 -fingerprint -in
UpdateServicePath
/PKI/Own/Certs/FTOptixApplication.der -inform DER -noout
Dabei ist
UpdateServicePath
das Installationsverzeichnis des Update-Diensts der FactoryTalk Optix-Anwendung.
--disable-project-encryption
Optional
Projektverschlüsselung deaktivieren.
--disable-source-project-transfer
Optional
Die Übertragung des Quellprojekts auf das Zielgerät deaktivieren.
WICHTIG: Sie können Quellprojekte nur auf Windows-Zielgeräte übertragen.
--transfer-optimized-project
Optional
Das Projekt vor der Übertragung optimieren.
Optimierte Projekte:
  • Sind kleiner, weil Knoten nur dann geladen werden, wenn sie zur Laufzeit benötigt werden.
  • Tags sollten sich in einem externen Tag-Repository und nicht im Projekt-Repository befinden.
  • Das Laden und Wechseln von Bildschirmen auf Geräten mit geringer Leistung kann länger dauern.
Sie können keine Projekte optimieren, die OPC UA-Server enthalten, die das gesamte Modell oder mindestens ein Tag veröffentlichen.
--silent
Optional
Festlegen, dass die Befehlsausgabe in der Eingabeaufforderung nicht ausführlich ist.

export

Mit diesem Befehl
export
können Sie eine
FactoryTalk Optix-Anwendung
-Datei in eine Datei exportieren.
"C:\Program Files\Rockwell Automation\FactoryTalk Optix\
version
\FTOptixStudio" export
project_to_export
--platform=
platform
--location=
location
[--silent]
Beispiel:
"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
Beachten Sie beim Arbeiten mit dem Befehl
export
Folgendes:
  • Sie müssen sicherstellen, dass die
    FactoryTalk Optix-Anwendung
    vor dem Export fehlerfrei erstellt wird.
  • Sie können keine Passwörter für exportierte
    FactoryTalk Optix-Anwendungen
    festlegen.
  • Sie können
    FactoryTalk Optix-Anwendungen
    nicht mit verschlüsselten Geheimnissen exportieren.
Parameter
Parameter
Wichtigkeit
Beschreibung
version
Erforderlich
Ordnername, der die installierte
FactoryTalk Optix Studio
-Version widerspiegelt.
project_to_export
Erforderlich
Pfad zur
OPTIX
-Datei des bereitzustellenden Projekts.
--location=
location
Erforderlich
Pfad zu dem Ort, an dem Sie die
FactoryTalk Optix-Anwendung
speichern möchten.
--silent
Optional
Festlegen, dass die Befehlsausgabe in der Eingabeaufforderung nicht ausführlich ist.

--help

Verwenden Sie den Parameter
--help
oder
-h
, um eine Übersicht der verfügbaren Befehle in der Eingabeaufforderung anzuzeigen.
TIPP: Bei der Verwendung unerwarteter Parameter wird auch die Hilfe angezeigt.
"C:\Program Files\Rockwell Automation\FactoryTalk Optix\
version
\FTOptixStudio" --help

--version

Verwenden Sie den Parameter
--version
, um die
FactoryTalk Optix Studio
-Version anzuzeigen.
"C:\Program Files\Rockwell Automation\FactoryTalk Optix\
version
\FTOptixStudio" --version
Rückmeldung geben
Haben Sie Fragen oder Feedback zu dieser Dokumentation? Bitte geben Sie hier Ihr Feedback ab.
Normal