manage-users command - Manual - Hardware Compiler - The AX Hardware Compiler - Hardware Compiler (hwc),tool

Hardware Compiler CLI Tool (hwc)

Portfolio
SIMATIC AX
Product
Hardware Compiler
Software version
1.1.154
Edition
07/2024
Language
English (original)
Package Name
@ax/hwc

The manage-users command allows managing user credentials for a PLC. Therefore users and password need to be created.

Note

The creator is responsible for defining the usernames and must comply with the guidelines for the handling of personal data.

These credentials are used in the configuration of the webserver or for the access to the plc.

apax hwc manage-users --moduleName <PLC_NAME> --input <HARDWARE_DECLARATION> <SUBCOMMAND>

*Subcommands

The manage-users command consists of several sub-commands:

Subcommand
list Lists configured users
set-password Sets the password for the specified user. If the specified user does not exist, it will be created automatically.
delete Deletes a user from a PLC

Options

All subcommands share the following common options:

Option Description
-i, --input Path to directory or file of the textual hardware declaration for compile. Mandatory.
This parameter can be specified multiple times.
-n, --moduleName Unique name of a PLC, which must already be existing in the hardware configuration. Mandatory

Return codes

The following return codes are possible:

  • 0 - Command was executed successfully
  • ≠0 - An error occurred