iectl portal¶
iectl portal¶
Description
Run IEM APIs version 1.0.0.
Detailed description
Use IEM APIs to automate tasks, such as IED onboarding or Edge App management.
Usage
iectl portal [OPTIONS]
Options
-h, --help help for portal
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal app-configs¶
Description
App configurations base command.
Usage
iectl portal app-configs [OPTIONS]
Options
-h, --help help for app-configs
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal app-configs get-template¶
Description
Download app configuration template.
Detailed description
This command downloads an app configuration template.
Usage
iectl portal app-configs get-template [OPTIONS]
Options
--appId string The unique application ID
--configId string The unique config ID
-d, --data string use this flag for passing data via json or as datafile with @filename
-h, --help help for get-template
--templateId string The unique config templateId ID
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal app-configs list-config¶
Description
List app configurations.
Detailed description
This command returns a list of configurations of a specific app in the IEM.
Usage
iectl portal app-configs list-config [OPTIONS]
Options
--appId string The unique application ID
-d, --data string use this flag for passing data via json or as datafile with @filename
-h, --help help for list-config
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal applications¶
Description
App related base command.
Usage
iectl portal applications [OPTIONS]
Options
-h, --help help for applications
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal applications list-catalog¶
Description
List apps.
Detailed description
This command returns a list of apps in the catalog.
Usage
iectl portal applications list-catalog [OPTIONS]
Options
-d, --data string use this flag for passing data via json or as datafile with @filename
-h, --help help for list-catalog
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal batches¶
Description
Batches base command.
Usage
iectl portal batches [OPTIONS]
Options
-h, --help help for batches
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal batches get-batch-jobs¶
Description
List jobs using batchId.
Usage
iectl portal batches get-batch-jobs [OPTIONS]
Options
--batchId string The unique batch ID
-d, --data string use this flag for passing data via json or as datafile with @filename
-h, --help help for get-batch-jobs
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal batchesget-batch-status¶
Description
Get batch status using batchId.
Detailed description
This command gets the batch status using batchId. If the status is READY, the batch is completed and its jobs will be created soon. If the status is PROCESSED, all its jobs are created.
Usage
iectl portal batches get-batch-status [OPTIONS]
Options
--batchId string The unique batch ID
-d, --data string use this flag for passing data via json or as datafile with @filename
-h, --help help for get-batch-status
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal batches submit-batch¶
Description
Execute commands on the app.
Detailed description
This command executes operations (install, uninstall or update) on an app in the IEM.
Usage
iectl portal batches submit-batch [OPTIONS]
Options
--appid string The unique application ID
--files stringArray The files to send
-h, --help help for submit-batch
--infoMap string The unique Edge Device ID, other info regarding config,resourses etc (use InfoMap object ).
Valid combinations:
- version config: {"configs":[{"configId":"configid","versionId":"versionid"}
- pre-defined template-based config: e.g. deploying or changing a template configuration: {"configId":"configid","templateId":"templateId"}
- template config: {"configId":"configid","templateId":"templateId",
"editedTemplateText":"editedText"}
- file-based configuration: {"configId":"configid","fileId":"unique id"}]} where fileId is the uploaded file name field
--operation string The operation to perform (install, uninstall, or update)
Valid operations: (installApplication, updateApplication, uninstallApplication, startApplication, restartApplication, stopApplication, updateAppConfig, deleteAppConfig)
--schedule string The time in ticks
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal devices¶
Description
Base command related to IEDs on IEM.
Usage
iectl portal devices [OPTIONS]
Options
-h, --help help for devices
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal devices create-device-body¶
Description
Prints an example body for the create-device command as help. Change according to your requirements.
Usage
iectl portal devices create-device-body [OPTIONS]
Options
-h, --help help for create-device-body
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal devices create-device¶
Description
Create a new Edge Device.
Detailed description
This command creates an Edge Device within the IEM with the given configuration. It returns a JSON string which can be used for onboarding the Edge Device.
Usage
iectl portal devices create-device [OPTIONS]
Options
--body string The device details object
-d, --data string use this flag for passing data via json or as datafile with @filename
-h, --help help for create-device
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal devices delete-device¶
Description
Delete Edge Device.
Detailed description
This command removes an Edge Device and returns the Edge Device ID.
Usage
iectl portal devices delete-device [OPTIONS]
Options
-d, --data string use this flag for passing data via json or as datafile with @filename
--deviceId string The unique Edge Device ID
-h, --help help for delete-device
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal devices get-device¶
Description
Get Edge Device details.
Detailed description
This command returns device metadata of a specified Edge Device.
Usage
iectl portal devices get-device [OPTIONS]
Options
-d, --data string use this flag for passing data via json or as datafile with @filename
--deviceId string UUID of the device
-h, --help help for get-device
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal devices list-apps-on-devices¶
Description
List Edge Device apps.
Detailed description
This command returns a list of all apps installed on a specific Edge Device. If the Edge Device ID is not provided, it lists all apps installed on all Edge Devices assigned to the logged user.
Usage
iectl portal devices list-apps-on-devices [OPTIONS]
Options
-d, --data string use this flag for passing data via json or as datafile with @filename
--deviceid string The unique Edge Device ID
-h, --help help for list-apps-on-devices
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal devices list-devices¶
Description
List Edge Devices.
Detailed description
This command returns a list of all Edge Devices available for the logged user.
Usage
iectl portal devices list-devices [OPTIONS]
Options
-d, --data string use this flag for passing data via json or as datafile with @filename
-h, --help help for list-devices
--page string The page number
--size string The size of the page
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal installjobs¶
Description
Jobs related base command.
Usage
iectl portal installjobs [OPTIONS]
Options
-h, --help help for installjobs
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal installjobs delete-job¶
Description
Delete jobs.
Detailed description
This command removes a list of jobs from the IEM.
Usage
iectl portal installjobs delete-job [OPTIONS]
Options
--body string The list of job IDs
-d, --data string use this flag for passing data via json or as datafile with @filename
-h, --help help for delete-job
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal installjobs get-job-status¶
Description
Get job status from job ID.
Usage
iectl portal installjobs get-job-status [OPTIONS]
Options
-d, --data string use this flag for passing data via json or as datafile with @filename
-h, --help help for get-job-status
--jobId string The unique job ID
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal installjobs retry-rollback-job¶
Description
Perform action (Retry, Rollback, RetryResubmit or RollbackResubmit) on job IDs.
Detailed description
This command performs an intented action and provides the action submission status in map for each job.
Usage
iectl portal installjobs retry-rollback-job [OPTIONS]
Options
--action string The action to perform (Retry, Rollback, RetryResubmit or RollbackResubmit)
--body string The list of job IDs
-d, --data string use this flag for passing data via json or as datafile with @filename
-h, --help help for retry-rollback-job
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal statistics¶
Description
Statistics base command.
Usage
iectl portal statistics [OPTIONS]
Options
-h, --help help for statistics
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal statistics get-statistics¶
Description
Get statistics of an Edge Device.
Usage
iectl portal statistics get-statistics [OPTIONS]
Options
-d, --data string use this flag for passing data via json or as datafile with @filename
--deviceId string The UUID of the device
-h, --help help for get-statistics
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal tokens¶
Description
Token base command.
Usage
iectl portal tokens [OPTIONS]
Options
-h, --help help for tokens
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal tokens get-token¶
Description
Creates a user specific token.
Detailed description
This command logs in a user to the IEM via username, password and verification code (if multi-factor verification is enabled).
Example: '{"username":"myuser", "password":"mypassword"}'
Usage
iectl portal tokens get-token [OPTIONS]
Options
--body string The map of login credentials, including username, password and verificationCode (optional)
-d, --data string use this flag for passing data via json or as datafile with @filename
-h, --help help for get-token
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal tokens invalidate-token¶
Description
Invalidates the token.
Detailed description
This command invalidates the token in the IEM.
Usage
iectl portal tokens invalidate-token [OPTIONS]
Options
-d, --data string use this flag for passing data via json or as datafile with @filename
-h, --help help for invalidate-token
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl portal tokens verify-token¶
Description
Verifies the token.
Usage
iectl portal tokens verify-token [OPTIONS]
Options
-d, --data string use this flag for passing data via json or as datafile with @filename
-h, --help help for verify-token
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output