iectl publisher¶

Description

Manage and handle Industrial Edge Apps via the IE App Publisher.

Usage

iectl publisher [OPTIONS]

Options

  -h, --help   help for publisher

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

iectl publisher dockerengine¶

Description

Manage the connectivity to the Docker daemon socket.

Usage

iectl publisher dockerengine [OPTIONS]

Options

  -h, --help   help for dockerengine

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

iectl publisher dockerengine connect¶

Description

Connect to an exposed Docker daemon socket via TCP.

Usage

iectl publisher dockerengine connect [OPTIONS]

Options

  -f, --cafile string     CA file path [Optional]
  -c, --certfile string   Certificate file path [Optional]
  -h, --help              help for connect
  -k, --keyfile string    Key file path [Optional]
  -u, --url string        set this argument which is passed as url parameter

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher dockerengine connect -u http(s)://172.16.219.130:2375

iectl publisher dockerengine disconnect¶

Description

Disconnect the currently connected Docker daemon socket.

Usage

iectl publisher dockerengine disconnect [OPTIONS]

Options

  -h, --help   help for disconnect

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher dockerengine disconnect

iectl publisher edgemanagement¶

Description

Manage Edge Apps.

Usage

iectl publisher edgemanagement [OPTIONS]

Options

  -h, --help   help for edgemanagement

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

iectl publisher edgemanagement application¶

Description

App related commands.

Usage

iectl publisher edgemanagement application [OPTIONS]

Options

  -h, --help   help for application

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

iectl publisher edgemanagement application addconfiguration¶

Description

Add configuration to an app.

Detailed description

Add configuration of following configuration types to an app:

Versioned
Minimum options needed: (-a, -n, -d , -p , -v)
Browse
Minimum options needed: (-a, -n, -d , -p)
Template
Minimum options needed: (-a, -n, -d , -p, -t, -e, -f)

If a versioned configuration type is provided including template details, such as template name or template description, it will be ignored.

Usage

iectl publisher edgemanagement application addconfiguration [OPTIONS]

Options

  -a, --appid string                 Unique id of an application
  -c, --configdescription string     description of the configuration to display during deployment
  -n, --configname string            name of the configuration to display during deployment
  -f, --filepath string              path to the configuration file to be added,for Unversioned type and Template type configurations
  -h, --help                         help for addconfiguration
  -p, --hostpath string              host path to be used as relative mount point to application's root folder
  -j, --jsonschema string            enables the schema-based templated configuration
  -x, --secure                       encrypts the configuration on IEM NOTE: configuration will not be encrypted during transmission / on IED
  -s, --subpath string               sub path to be used as mount point within the container
  -e, --templatedescription string   description for the templated configuration displayed during deployment
  -t, --templatename string          name of the templated configuration displayed during deployment
  -i, --versiondescription string    description for the versioned configuration displayed during deployment
  -w, --versioned                    switches to configuration type versioned
  -r, --versionname string           name of the versioned configuration displayed during deployment for selection

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

Versioned:

iectl publisher em app ac -a "adcf2013b01f48238a8ca48188c3894e" -n "Config1" -p "./data/" -s "myfolder" -x -v -r "version1" -i "Version one of mysql configuration" -f "/home/config.txt"

Browse:

iectl publisher em app ac -a "adcf2013b01f48238a8ca48188c3894e" -n "Config1" -d "Mysql password" -p "./data/" -s "myfolder"

Template:

iectl publisher em app ac -a "adcf2013b01f48238a8ca48188c3894e" -n "Config1" -d "Mysql password" -p "./data/" -s "myfolder" -x -t "ConfigTemplate" -e "My Template Configuration" -f "/home/config.txt"

Template with JSON schema:

iectl publisher em app ac -a "adcf2013b01f48238a8ca48188c3894e" -n "Config1" -d "Mysql password" -p "./data/" -s "myfolder" -x -t "ConfigTemplate" -e "My Template Configuration" -j -f "/home/config.json"

iectl publisher edgemanagement application addconfigurationversion¶

Description

Add version of already added versioned configuration type.

Usage

iectl publisher edgemanagement application addconfigurationversion [OPTIONS]

Options

  -a, --appid string                Unique id of an application
  -c, --configurationid string      configuration id for the versioned configuration
  -f, --filepath string             path to the file to use as versioned configuration
  -h, --help                        help for addconfigurationversion
  -t, --versiondescription string   displayed during deployment as description
  -w, --versionname string          displayed during deployment for selection

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher em app acv -a "adcf2013b01f48238a8ca48188c3894e" -c "acf013b1f48238a8ca48188c37896a" -w "version1" -f "/home/config.txt"

iectl publisher edgemanagement application createunpublishedversion¶

Description

Create app version.

Usage

iectl publisher edgemanagement application createunpublishedversion [OPTIONS]

Options

  -x, --accesswithoutlogin        Allow application access without login [Optional]
  -a, --appid string               Application unique id for which the version has to be created
  -g, --authservice string        Auth Service [Optional]
  -c, --changelogs string          Release Notes [Optional]
  -m, --defaultmountpath string   To add default mount path (./publish/ and ./cfg-data/) [Optional]
  -e, --eventservice string       Event Service [Optional]
  -h, --help                      help for createunpublishedversion
  -i, --imagetagjson string       Json map of service name and tag of image. Only for kubernetes applications [Optional]
  -j, --imagetarjson string       List of services with the reference to their exported docker images [Optional]
  -n, --nginxjson string          Json map of nginx configuration. [Optional]
  -s, --redirectsection string    Redirect Section [Optional]
  -t, --redirecttype string       Redirect Type["FromBoxReverseProxy","FromBoxSpecificPort","ExternalLink"] [Optional] (default "ExternalLink")
  -u, --redirecturl string        Redirect URL [Optional]
  -r, --restredirecturl string    Rest Redirect URL [Optional]
  -w, --versionnumber string      Version Number refers to versioning
  -y, --yamlpath string           Path of docker compose yaml or folder path in case of kubernetes application

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

Kubernetes-based apps:

iectl publisher edgemanagement application createunpublishedversion -a "39853716a55048c9935e451a63eecc89" -w "0.0.1" -y "./k8s/" -i "{"nginx":"1.3","nginx1":"1.4"}" -c "changelogs" -n "{"nginx":{"nginxConfig":"./CertFiles/nginxconf","isBehindIEMS":"true","port":"80"}}" -s "nginx" -t "FromBoxSpecificPort" -u "80" -r "" -e {"nginx:/.publish/"} -o {"nginx:/.publish/"}

Docker Compose-based apps:

iectl publisher edgemanagement application createunpublishedversion -a "39853716a55048c9935e451a63eecc89" -w "0.0.1" -y "/yaml/" -c "changelogs" -n "{"nginx":{"nginxConfig":"./CertFiles/nginxconf","isBehindIEMS":"false","port":"80"}}" -s "nginx" -t "FromBoxSpecificPort" -u "80" -r "" -e {"nginx:/.publish/"} -o {"nginx:/.publish/"}

iectl publisher edgemanagement application deleteConfigurationVersion¶

Description

Delete configuration version.

Usage

iectl publisher edgemanagement application deleteConfigurationVersion [OPTIONS]

Options

  -c, --appconfigid string          config id of versioned configuration
  -w, --appconfigversionid string   config version id of configuration version to delete from the application
  -a, --appid string                Unique id of an application
  -h, --help                        help for deleteConfigurationVersion

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher edgemanagement application deleteConfigurationVersion -a "adcf2013b01f48238a8ca48188c3894e" -c "acf013b1f48238a8ca48188c37896a" -w "217d0ed97c694ff5b7935b133ed8c147"

iectl publisher edgemanagement application deletecatalogapplication¶

Description

Delete app from catalog.

Usage

iectl publisher edgemanagement application deletecatalogapplication [OPTIONS]

Options

  -a, --appid string   appid
  -h, --help           help for deletecatalogapplication

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher em app dca -a "ae94575c8de74b4496357231534a7e3c"

iectl publisher edgemanagement application deleteconfiguration¶

Description

Delete configuration of an app.

Usage

iectl publisher edgemanagement application deleteconfiguration [OPTIONS]

Options

  -a, --appid string      Unique id of an application
  -c, --configid string   config id of configuration to delete from the application
  -h, --help              help for deleteconfiguration

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher em app dc -a "adcf2013b01f48238a8ca48188c3894e" -c "acf013b1f48238a8ca48188c37896a"

iectl publisher edgemanagement application deletepublishedversion¶

Description

Delete published app version.

Usage

iectl publisher edgemanagement application deletepublishedversion [OPTIONS]

Options

  -a, --appid string           Application unique id for which the version has to be deleted
  -h, --help                   help for deletepublishedversion
  -w, --versionnumber string   Version Number

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher em app dpv -a drjmB165b5R7K6qlzq5UKPmYx74cHN8X -w 0.0.4

iectl publisher edgemanagement application deleteunpublishedversion¶

Description

Delete unpublished app version.

Usage

iectl publisher edgemanagement application deleteunpublishedversion [OPTIONS]

Options

  -a, --appid string   Unique id of an application
  -h, --help           help for deleteunpublishedversion

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher em app duv -a "CvWrdRJ4sHB79R4uuVc4v5VqUN4N40l0"

iectl publisher edgemanagement application detail¶

Description

List details including app versions.

Usage

iectl publisher edgemanagement application detail [OPTIONS]

Options

  -a, --appId string      Unique id of an application
  -d, --data string       use this flag for passing data via json or as datafile with @filename
  -h, --help              help for detail
  -k, --key stringArray   List of keys separated by comma. Example: "title,applicationId,appVersions"
  -p, --private           if application is not published to catalog. [Optional]

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher em app dt -a 93a99b3fdc4344029459f234987611f4 -p -k "title,applicationId,appVersions"

iectl publisher edgemanagement application exportpublishedversion¶

Description

Export app version.

Usage

iectl publisher edgemanagement application exportpublishedversion [OPTIONS]

Options

  -a, --appid string            Application unique id for which the version has to be exported
  -d, --data string             use this flag for passing data via json or as datafile with @filename
  -e, --exportpath string       Export path
  -h, --help                    help for exportpublishedversion
  -k, --privatekeypath string   private key to use for signing the application (deprecated)
  -w, --versionnumber string    Version Number refers to versioning

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher em app epv -a "191880046efb4173909aaab04fc6de51" -w "0.0.1" -e "/homeDesktop/export_folder" -k /home/Desktop/private_rsa_private.pem

iectl publisher edgemanagement application importstandaloneversion¶

Description

Import standalone app version.

Usage

iectl publisher edgemanagement application importstandaloneversion [OPTIONS]

Options

  -a, --applicationname string   Name of the stand-alone application.
  -c, --categoryid string        Unique id of category available on Edge Management under which you want to add this application. Mandatory for importing the version for the first time. [Optional]
  -l, --changelogs string        Release Notes [Optional]
  -h, --help                     help for importstandaloneversion
  -p, --projectid string        Unique id of projects available on Edge Management under which you want to add this application. Mandatory for importing the version for the first time. [Optional]
  -g, --signuptype string        Signup type of an application["SignUpWithOrWithoutCode","SignUpWithCodeOnly","NoSignUp","SignUpWithoutCode","None"]. [Optional]
  -w, --versionnumber string     Version Number which you want to import to Edge Management.
  -e, --webaddress string        Web address for application. Mandatory if not provided while creating application. [Optional]

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher em app isav -a "myapp" -w "0.0.1" -v "www.cli.com" -g "None" -l "change_logs" -p "8091818e834d4945a1fe4a8f2698d57e" -c "971686ca3fd2451ab05f9b4d993e3a33"

iectl publisher edgemanagement application linkdocumenttopublishedversion¶

Description

Upload document link of an app version.

Usage

iectl publisher edgemanagement application linkdocumenttopublishedversion [OPTIONS]

Options

  -a, --appid string       Unique id of an application
  -l, --doclink string     Document link of an application
  -h, --help               help for linkdocumenttopublishedversion
  -s, --srclink string     Source link of an application
  -w, --versionid string   Version unique id

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher em app ldpv -a "CvWrdRJ4sHB79R4uuVc4v5VqUN4N40l0" -w "al6lCzyr6FeVtszzulHR8LceSQ9xOTob" -s "https://192.168.7.8/pbc/"

iectl publisher edgemanagement application listConfigurationsofApplication¶

Description

List all configurations of an app.

Usage

iectl publisher edgemanagement application listConfigurationsofApplication [OPTIONS]

Options

  -a, --appid string      Unique id of an application
  -h, --help              help for listConfigurationsofApplication
  -k, --key stringArray   list of keys to display as means of filtering"

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher em app lac -a 93a99b3fdc4344029459f234987611f4 -k "appConfigId,displayName"

iectl publisher edgemanagement application listunpublishedversion¶

Description

List unpublished app version.

Usage

iectl publisher edgemanagement application listunpublishedversion [OPTIONS]

Options

  -a, --appid string   Unique id of an application
  -h, --help           help for listunpublishedversion

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher em app luv -a "CvWrdRJ4sHB79R4uuVc4v5VqUN4N40l0"

iectl publisher edgemanagement application unpublishcatalogversion¶

Description

Unpublish app version from catalog.

Usage

iectl publisher edgemanagement application unpublishcatalogversion [OPTIONS]

Options

  -a, --appid string   appid
  -h, --help           help for unpublishcatalogversion

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher em app ucv -a "ae94575c8de74b4496357231534a7e3c"

iectl publisher edgemanagement application uploadtocatalog¶

Description

Import standalone app or .app file to the catalog.

Usage

iectl publisher edgemanagement application uploadtocatalog [OPTIONS]

Options

  -a, --appname string         Application Name
  -f, --filepath string        Path of app file to upload
  -h, --help                   help for uploadtocatalog
  -w, --versionnumber string   Version Number refers to versioning

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher em app uc -a "myapp" -w "0.0.1"

iectl publisher edgemanagement application uploadunpublishedversion¶

Description

Upload unpublished app version.

Usage

iectl publisher edgemanagement application uploadunpublishedversion [OPTIONS]

Options

  -a, --appid string           Unique id of an application
  -h, --help                   help for uploadunpublishedversion
  -w, --versionnumber string   Version Number

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher em app uuv -a "CvWrdRJ4sHB79R4uuVc4v5VqUN4N40l0" -w "0.0.1"

Description

List all categories.

Usage

iectl publisher edgemanagement listcategories [OPTIONS]

Options

  -h, --help              help for listcategories
  -k, --key stringArray   List of keys separated by comma. Example: "categoryId,name"

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher em lc -k "categoryId,name"

Description

Log into given IEM.

Usage

iectl publisher edgemanagement login [OPTIONS]

Options

  -e, --email string       email address used for login
  -h, --help               help for login
  -p, --password string    password used for login
  -u, --portalurl string   url of Edge Management on which you want to create application version

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher em li -u "https://iem.my.domain.name.com" -e email@siemens.com -p Password

iectl publisher edgemanagement logout¶

Description

Logout from IEM.

Usage

iectl publisher edgemanagement logout [OPTIONS]

Options

  -h, --help          help for logout

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher em lo

iectl publisher edgemanagement project¶

Description

Project related commands.

Usage

iectl publisher edgemanagement project [OPTIONS]

Options

  -h, --help   help for project

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

iectl publisher edgemanagement project list¶

Description

List all projects.

Usage

iectl publisher edgemanagement project list [OPTIONS]

Options

  -h, --help              help for list
  -k, --key stringArray   list of keys to display as means of filtering

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher em pr l -k "projectId,name"

iectl publisher edgemanagement project listapps¶

Description

List all apps in the project.

Usage

iectl publisher edgemanagement project listapps [OPTIONS]

Options

  -h, --help               help for listapps
  -k, --key stringArray    List of keys separated by comma. Example: "applicationId,title"
  -p, --projectId string   Unique id of Project of which you want to list applications

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher em pr la -p "758aa412254545465" -k "applicationId,title"

iectl publisher environment¶

Description

View environment variables set for the IE App Publisher.

Detailed description

The following environment variables are being supported and can be set:

Variable	Description
IE_SKIP_CERTIFICATE	Enable skipping TLS
IE_DOCKER_URL	URL to the exposed Docker daemon in format ://:
IE_DOCKER_CAFILE	CA file to use for connection to Docker daemon
IE_DOCKER_CERTFILE	Certificate to use for connection to Docker daemon
IE_DOCKER_KEYFILE	Key to use for connection to Docker daemon
IE_WORKSPACE	Path to the workspace to use
IE_URL	URL for the IEM in format <protocol://:
IE_USER	User name to use when authenticating with the IEM
IE_PASSWORD	Password to use when authenticating with the IEM
IE_CONFIG_PATH	Path of .env which specifies the environment variables
HTTP_PROXY & http_proxy	Proxy related settings for connectivity with the IEM
HTTPS_PROXY & https_proxy	Proxy related settings for connectivity with the IEM
NO_PROXY & no_proxy	Proxy related settings for connectivity with the IEM

Usage

iectl publisher environment [OPTIONS]

Options

  -h, --help          help for environment

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

iectl publisher iehub¶

Description

IE Hub related commands.

Usage

iectl publisher iehub [OPTIONS]

Options

  -h, --help   help for iehub

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

iectl publisher iehub application¶

Description

App related commands on the IE Hub.

Usage

iectl publisher iehub application [OPTIONS]

Options

  -h, --help   help for application

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

iectl publisher iehub application activateversion¶

Description

Activate app version on the IE Hub.

Usage

iectl publisher iehub application activateversion [OPTIONS]

Options

  -a, --appname string         Application Name
  -d, --data string            use this flag for passing data via json or as datafile with @filename
  -h, --help                   help for activateversion
  -w, --versionnumber string   Version Number refers to versioning

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher iehub application activateversion --appname applicationame --versionnumber "0.0.1"

iectl publisher iehub application createversion¶

Description

Create new app version and upload .app / OSS / release notes file of an app to the IE Hub.

Usage

iectl publisher iehub application createversion [OPTIONS]

Options

  -t, --activate               Activate the application version [Optional]
  -b, --appbinary string       App file of the application version to upload [Optional]
  -a, --appname string         Application Name
  -h, --help                   help for createversion
  -s, --ossfile string         OSS file associated with application version to upload. Supported formats : .7z, .zip [Optional]
  -n, --releasenotes string    Release notes file associated with application version to upload. Supported formats : .txt, .pdf,.7z, .zip  [Optional]
  -w, --versionnumber string   Version Number refers to versioning

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher iehub application createversion --appname applicationame --versionnumber "0.0.1" --appbinary "path/to/appbinary" --ossfile "path/to/ossfile" --releasenotes "path/to/relesenotesfile" --activate

iectl publisher iehub application deleteversion¶

Description

Delete app version on IE Hub.

Usage

iectl publisher iehub application deleteversion [OPTIONS]

Options

  -a, --appname string         Application Name
  -h, --help                   help for deleteversion
  -w, --versionnumber string   Version Number refers to versioning

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher iehub application deleteversion --appname applicationame --versionnumber "0.0.1"

iectl publisher iehub application listversion¶

Description

List all versions of an app in the IE Hub.

Usage

iectl publisher iehub application listversion [OPTIONS]

Options

  -a, --appname string    Application Name
  -h, --help              help for listversion
  -k, --key stringArray   List of keys separated by comma. Example: "categoryId,name" [Optional]

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher iehub application listversion --appname applicationame --key "version,id"

iectl publisher iehub application releaseversion¶

Description

Release app version on the IE Hub.

Usage

iectl publisher iehub application releaseversion [OPTIONS]

Options

  -a, --appname string         Application Name
  -d, --data string            use this flag for passing data via json or as datafile with @filename
  -h, --help                   help for releaseversion
  -w, --versionnumber string   Version Number refers to versioning

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher iehub application releaseversion --appname applicationame --versionnumber "0.0.1"

iectl publisher iehub application versiondetail¶

Description

Check version details of an app in the IE Hub.

Usage

iectl publisher iehub application versiondetail [OPTIONS]

Options

  -a, --appname string         Application Name
  -h, --help                   help for versiondetail
  -k, --key stringArray        List of keys separated by comma. Example:"version,status" [Optional]
  -w, --versionnumber string   Version Number refers to versioning

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher iehub application versiondetail --appname applicationname --versionnumber "0.0.1" --key "version,status"

Description

Log into IE Hub.

Usage

iectl publisher iehub login [OPTIONS]

Options

  -e, --email string      email address used for login
  -h, --help              help for login
  -p, --password string   password used for login
  -u, --url string        URL of IE Hub on which you want perform operations

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher iehub login -url "https://iehub.eu1.edge.siemens.cloud" -email email@siemens.com -password password

iectl publisher iehub logout¶

Description

Log out from IE Hub.

Usage

iectl publisher iehub logout [OPTIONS]

Options

  -h, --help          help for logout

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher iehub logout

iectl publisher image¶

Description

Manage image commands.

Usage

iectl publisher image [OPTIONS]

Options

  -h, --help   help for image

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

iectl publisher image createmendiximage¶

Description

Create Mendix image.

Usage

iectl publisher image createmendiximage [OPTIONS]

Options

  -f, --filepath string    File Path, of the .mda file. Supported format : .mda
  -h, --help               help for createmendiximage
  -n, --imagename string   Image Name

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher im c -n myimage -f "path/to/image.mda"

iectl publisher standaloneapp¶

Description

Manage standalone apps.

Usage

iectl publisher standaloneapp [OPTIONS]

Options

  -h, --help   help for standaloneapp

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

iectl publisher standaloneapp addconfiguration¶

Description

Add configurations to an app.

Detailed description

Following configuration types are being supported:

Unversioned
Versioned
Templated (with an additional flavor of schema based configurations)

Each configuration will be mounted into the container. The mountpoint within the container is specified by the --hostpath and --subpath flags, whereas hostpath is considered as the directory and subpath as the file name relative to the hostpath. The hostpath and subpath will be thus merged together to a complete path. The subpath can also be omitted and the original file name will be used automatically.

Example:

--hostpath /my/data --subpath config.json

This will result in the mountpoint /my/data/config.json within the container.

The unversioned configuration type is the configuration type used by default. This configuration type is mutable and a file should be added during deployment of the app. If a versioned configuration type is provided including template details, such as template name or template description, it will be ignored.

Usage

iectl publisher standaloneapp addconfiguration [OPTIONS]

Options

  -a, --appname string               name of the application for which configuration shall be added
  -c, --configdescription string     description of the configuration to display during deployment
  -n, --configname string            name of the configuration to display during deployment
  -f, --filepath string              path to the configuration file to be added [Optional]
  -h, --help                         help for addconfiguration
  -p, --hostpath string              host path to be used as mount point within the container
  -j, --jsonschema                   enables the schema-based templated configuration [Optional]
  -x, --secure                       encrypts the configuration on IEM NOTE: configuration will not be encrypted during transmission / on IED [Optional]
  -s, --subpath string               sub path to be used as mount point within the container [Optional]
  -e, --templatedescription string   description for the templated configuration displayed during deployment [Optional]
  -t, --templatename string          name of the templated configuration displayed during deployment [Optional]
  -i, --versiondescription string    description for the versioned configuration displayed during deployment [Optional]
  -w, --versioned                    switches to configuration type versioned [Optional]
  -r, --versionname string           name of the versioned configuration displayed during deployment for selection [Optional]

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

Unversioned configuration

iectl publisher sa ac -a "myapp" -n "Config1" -p "./data/" -s "myfolder"

Versioned configuration

iectl publisher sa ac -a "myapp" -n "Config1" "Mysql password" -p "./data/" -s "myfolder" -x -v -r "version1" -i "Version one of mysql configuration" -f "/home/config.txt"

Templated configuration

iectl publisher sa ac -a "myapp" -n "Config1" "Mysql password" -p "./data/" -s "myfolder" -x -t "ConfigTemplate" -e "My Template Configuration" -f "/home/config.txt"

Templated configuration with JSON schema

iectl publisher sa ac -a "adcf2013b01f48238a8ca48188c3894e" -n "Config1" "Mysql password" -p "./data/" -s "myfolder" -x -t "ConfigTemplate" -e "My Template Configuration" -j -f "/home/config.json"

iectl publisher standaloneapp addconfigurationversion¶

Description

Add a versioned configuration to an app within the workspace.

Usage

iectl publisher standaloneapp addconfigurationversion [OPTIONS]

Options

  -a, --appname string              application name within workspace
  -c, --configurationid string      configuration id for the versioned configuration
  -f, --filepath string             path to the file to use as versioned configuration
  -h, --help                        help for addconfigurationversion
  -t, --versiondescription string   displayed during deployment as description
  -w, --versionname string          displayed during deployment for selection

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher sa acv -a "myapp" -c "acf013b1f48238a8ca48188c37896a"-w "version1" -f "/home/config.txt"

iectl publisher standaloneapp create¶

Description

Create a standalone app within the current workspace.

Usage

iectl publisher standaloneapp create [OPTIONS]

Options

  -t, --appdescription string   description to associate with the new app
  -a, --appname string          application name to associate with the new app
  -h, --help                    help for create
  -i, --iconpath string         path to an icon to associate with the new app
  -r, --reponame string         repository name to associate with the new app. This will be used as a namespace within the container registry
      --appid string            Unique application id of 32 characters, if it is not provided then auto generated application id will be used. [Optional]

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher sa c -a "application_name" -r "repo_name" -i ‘icon_path’

iectl publisher standaloneapp createAndExport¶

Description

Create an app, an app version and export the app version to a specified path as .app file.

Usage

iectl publisher standaloneapp createAndExport [OPTIONS]

Options

  -x, --accesswithoutlogin       allow application access without authentication (default true)
  -p, --appdescription string    description to associate with the new app
      --appid string             Unique application id of 32 characters, if it is not provided then auto generated application id will be used. [Optional]
  -a, --appname string           name of the application to export
  -g, --authservice string        Auth Service
  -c, --changelogs string        changelogs to associate with the new version
  -m, --defaultmountpath         add default mount paths ./cfg-data & ./publish to docker-compose file
  -f, --eventservice string       Event Service
  -e, --exportpath string        path to save the .app file
  -h, --help                     help for createAndExport
  -i, --iconpath string          path to an icon to associate with the new app
  -j, --imagetarjson string      List of services with the reference to their exported docker images.
  -n, --nginxjson string          JSON map of nginx configuration.
  -k, --privatekeypath string    private key to use for signing the application (deprecated)
  -s, --redirectsection string   Redirect Section [Optional]
  -t, --redirecttype string      Redirect Type ("FromBoxReverseProxy","FromBoxSpecificPort","ExternalLink") [Optional] (default "ExternalLink")
  -u, --redirecturl string       Redirect URL [Optional]
  -r, --reponame string          repository name to associate with the new app. This will be used as a namespace within the container registry
  -z, --restredirecturl string   rest redirect url
  -w, --versionnumber string     version to export
  -y, --yamlpath string          Path of folder that contains version details

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher sa cae -a myapp -w 0.0.4 -e /home/Desktop/export_folder -o "app description" -r "myapp repo" -i /home/Desktop/abc.jpg -y /home/Desktop/yaml_folder/docker-compose.yml -k /home/Desktop/private_rsa_private.pem -t "FromBoxSpecificPort" -u "url" -s "section" -c "change logs" -m -x

iectl publisher standaloneapp createversion¶

Description

Create a new app version within workspace.

Usage

iectl publisher standaloneapp createversion [OPTIONS]

Options

  -x, --accesswithoutlogin       Allow application access without login
  -a, --appname string           name of the application for which a new version should be created
  -g, --authservice string       Auth Service
  -c, --changelogs string        Release Notes
  -m, --defaultmountpath         To add default mount path (./publish/ and ./cfg-data/)
  -e, --eventservice string      Event Service
  -h, --help                     help for createversion
  -j, --imagetarjson string      List of services with the reference to their exported docker images
  -n, --nginxjson string         JSON map of nginx configuration
  -s, --redirectsection string   Redirect Section
  -t, --redirecttype string      Redirect Type ("FromBoxReverseProxy","FromBoxSpecificPort","ExternalLink")
  -u, --redirecturl string       Redirect URL
  -r, --restredirecturl string   Rest Redirect URL
  -w, --versionnumber string     version number associated with the new version
  -y, --yamlpath string          Path of docker compose yaml or folder path in case of kubernetes application

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher sa cv -a "myapp" -w 0.0.2 -y "/home/Desktop/yamlfolder/docker-compose.yml" -c "changes logs" -m

iectl publisher standaloneapp delete¶

Description

Delete an app within workspace.

Usage

iectl publisher standaloneapp delete [OPTIONS]

Options

  -a, --appname string   application name to associate with the new app
  -h, --help             help for delete

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher sa d -a myapp

iectl publisher standaloneapp deleteConfigurationVersion¶

Description

Delete a configuration version from an app within the workspace.

Usage

iectl publisher standaloneapp deleteConfigurationVersion [OPTIONS]

Options

  -c, --appconfigid string          app config id to delete from the application
  -w, --appconfigversionid string   app config version id to delete from the application
  -a, --appname string              name of application within workspace
  -h, --help                        help for deleteConfigurationVersion

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher sa dcv -a "myapp" -c "acf013b1f48238a8ca48188c37896a" -w "217d0ed97c694ff5b7935b133ed8c147"

iectl publisher standaloneapp deleteconfiguration¶

Description

Delete a configuration from an app within the workspace.

Usage

iectl publisher standaloneapp deleteconfiguration [OPTIONS]

Options

  -a, --appname string    name of application within workspace
  -c, --configid string   config id to delete from the application
  -h, --help              help for deleteconfiguration

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher sa dc -a "myapp" -c "acf013b1f48238a8ca48188c37896a"

iectl publisher standaloneapp deleteversion¶

Description

Delete an app version within workspace.

Usage

iectl publisher standaloneapp deleteversion [OPTIONS]

Options

  -a, --appname string         name of the application to delete a version from
  -h, --help                   help for deleteversion
  -w, --versionnumber string   version to delete

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher sa dv -a myapp -w 0.0.1

iectl publisher standaloneapp export¶

Description

Export an app from workspace to a specific path.

Usage

iectl publisher standaloneapp export [OPTIONS]

Options

  -a, --appname string   application name to associate with the new app
  -h, --help             help for export
  -p, --path string      path where the exported application should be stored to

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher sa e -a myapp1 -p /home/Desktop/exportfolder

iectl publisher standaloneapp exportversion¶

Description

Export an app version as .app file.

Usage

iectl publisher standaloneapp exportversion [OPTIONS]

Options

  -a, --appname string          name of the application to export
  -e, --exportpath string       path to save the .app file
  -h, --help                    help for exportversion
  -k, --privatekeypath string   private key to use for signing the application [Optional] (deprecated)
  -w, --versionnumber string    version to export

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher sa ev -a myapp -w 0.0.3 -e /home/Desktop/export_folder -k /home/Desktop/private_rsa_private.pem

iectl publisher standaloneapp import¶

Description

Import an .app file to current workspace.

Usage

iectl publisher standaloneapp import [OPTIONS]

Options

  -a, --apptarpath string   path of the .app file that should be imported
  -h, --help                help for import

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher sa i -a /home/Desktop/exportfolder/myapp.tar

iectl publisher standaloneapp list¶

Description

List apps within workspace.

Usage

iectl publisher standaloneapp list [OPTIONS]

Options

  -h, --help              help for list
  -k, --key stringArray   list of keys to display as means of filtering [Optional]

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher sa l -k "applicationId,title"

iectl publisher standaloneapp listConfigurationsofApplication¶

Description

List all configurations of an app within the workspace.

Usage

iectl publisher standaloneapp listConfigurationsofApplication [OPTIONS]

Options

  -a, --appname string    name of application within workspace
  -h, --help              help for listConfigurationsofApplication
  -k, --key stringArray   list of keys to display as means of filtering

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

iectl publisher standaloneapp listversions¶

Description

List all versions of an app within workspace.

Usage

iectl publisher standaloneapp listversions [OPTIONS]

Options

  -a, --appname string    name of the application to list versions from
  -h, --help              help for listversions
  -k, --key stringArray   list of keys to display as means of filtering

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher sa lv -a myapp -k "versionNumber,versionId"

iectl publisher standaloneapp validate¶

Description

Validate an .app file for using it within Industrial Edge.

Detailed description

The validation steps check the following by default:

validate the .app file according to its scheme
validate the integrity of the .app file according to its digests
validate the signature, if the app is signed
validate the docker-compose according to its scheme
validate IE specifics regarding docker-compose (e.g. volume mounts)
validate app metadata (e.g. service exposure, dependencies)
validate Docker images (e.g. images are importable, tags are correctly set)

These steps are customizable by the user with the --skip option.

Usage

iectl publisher standaloneapp validate [OPTIONS]

Options

  -a, --auth-service stringArray    list of services within the application that have a dependency to the auth service [Optional]
  -e, --event-service stringArray   list of services within the application that have a dependency to the event service [Optional]
  -h, --help                        help for validate
  -i, --ignore-errors               ignores all errors that may occur during validation. NOTE: this will not return a failing exit code [Optional]
  -n, --networks string             JSON Object which specifies the docker network dependencies of a service within the application. Format: {\\\"my-app\\\":[\\\"one\\\",\\\"two\\\"]} [Optional]
  -p, --path string                 path to the app file to validate
  -k, --public-key string           path to the public key used for validating the signed [Optional] (deprecated)
  -s, --skip stringArray            list of validation steps to skip. available steps to skip: validate_app_file_schema,validate_digest,validate_signature,validate_yaml_schema,validate_ie_rules,validate_meta_files,validate_docker_images [Optional]

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher sa val -p /home/application.app  -k "/home/TrustStore.pem" -n {"secureapp1":["proxy"]} -a "secureapp ,secureapp2" -e "secureapp ,secureapp2" -s "validate_meta_files,validate_docker_images" -i

iectl publisher workspace¶

Description

Handle workspaces of the IE App Publisher.

Usage

iectl publisher workspace [OPTIONS]

Options

  -h, --help   help for workspace

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

iectl publisher workspace export¶

Description

Export the currently used workspace.

Detailed description

Export the currently used workspace to a specific location. The workspace is either inferred from the current directory or from the IE_WORKSPACE environment variable.

Usage

iectl publisher workspace export [OPTIONS]

Options

  -h, --help          help for export
  -p, --path string   output path for the exported workspace

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

iectl publisher ws e -p /home/Desktop/

iectl publisher workspace init¶

Description

Initialize workspace.

Detailed description

Run this command in an empty folder.

Usage

iectl publisher workspace init [OPTIONS]

Options

  -h, --help          help for init

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

 iectl publisher ws i

iectl publisher¶

iectl publisher¶

iectl publisher dockerengine¶

iectl publisher dockerengine connect¶

iectl publisher dockerengine disconnect¶

iectl publisher edgemanagement¶

iectl publisher edgemanagement application¶

iectl publisher edgemanagement application addconfiguration¶

iectl publisher edgemanagement application addconfigurationversion¶

iectl publisher edgemanagement application createunpublishedversion¶

iectl publisher edgemanagement application deleteConfigurationVersion¶

iectl publisher edgemanagement application deletecatalogapplication¶

iectl publisher edgemanagement application deleteconfiguration¶

iectl publisher edgemanagement application deletepublishedversion¶

iectl publisher edgemanagement application deleteunpublishedversion¶

iectl publisher edgemanagement application detail¶

iectl publisher edgemanagement application exportpublishedversion¶

iectl publisher edgemanagement application importstandaloneversion¶

iectl publisher edgemanagement application linkdocumenttopublishedversion¶

iectl publisher edgemanagement application listConfigurationsofApplication¶

iectl publisher edgemanagement application listunpublishedversion¶

iectl publisher edgemanagement application unpublishcatalogversion¶

iectl publisher edgemanagement application uploadtocatalog¶

iectl publisher edgemanagement application uploadunpublishedversion¶

iectl publisher edgemanagement listcategories¶

iectl publisher edgemanagement login¶

iectl publisher edgemanagement logout¶

iectl publisher edgemanagement project¶

iectl publisher edgemanagement project list¶

iectl publisher edgemanagement project listapps¶

iectl publisher environment¶

iectl publisher iehub¶

iectl publisher iehub application¶

iectl publisher iehub application activateversion¶

iectl publisher iehub application createversion¶

iectl publisher iehub application deleteversion¶

iectl publisher iehub application listversion¶

iectl publisher iehub application releaseversion¶

iectl publisher iehub application versiondetail¶

iectl publisher iehub login¶

iectl publisher iehub logout¶

iectl publisher image¶

iectl publisher image createmendiximage¶

iectl publisher standaloneapp¶

iectl publisher standaloneapp addconfiguration¶

iectl publisher standaloneapp addconfigurationversion¶

iectl publisher standaloneapp create¶

iectl publisher standaloneapp createAndExport¶

iectl publisher standaloneapp createversion¶

iectl publisher standaloneapp delete¶

iectl publisher standaloneapp deleteConfigurationVersion¶

iectl publisher standaloneapp deleteconfiguration¶

iectl publisher standaloneapp deleteversion¶

iectl publisher standaloneapp export¶

iectl publisher standaloneapp exportversion¶

iectl publisher standaloneapp import¶

iectl publisher standaloneapp list¶

iectl publisher standaloneapp listConfigurationsofApplication¶

iectl publisher standaloneapp listversions¶

iectl publisher standaloneapp validate¶

iectl publisher workspace¶

iectl publisher workspace export¶

iectl publisher workspace init¶