set-accessprotection-password 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
apax hwc set-accessprotection-password --name <PLC_NAME> --input <HARDWARE_DECLARATION> --level <ACCESS_PROTECTION_LEVEL> --password <ACCESS_PROTECTION_PASSWORD>
  • Defines an access protection password for a given PLC for a given access protection level. This password is used for authorization purposes during performing of an online operation with the PLC (such as during downloading to the PLC).
    • Execution of this command causes an update in the security configuration file. This file contains key-value pairs, where keys are human-readable strings and values are machine-readable byte arrays.

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, --name Unique name of a PLC, which must already be existing in the hardware configuration. Mandatory
-l, --level Access protection level, for which the password is defined. Mandatory
Accepted access protection levels: FullAccessWithSafety, FullAccess, ReadAccess, HmiAccess are the supported .
-p, --password Password of the given access level. Mandatory

Return codes

The following return codes are possible:

  • 0 - Access protection password is set successfully.
  • ≠0 - An error occurred during access protection password setup.

Important

  • The security configuration file "PLCName".SecurityConfiguration.json will be created under the hwc.gen folder while running the set-accessprotection-password command, if this file does not exist inside the same folder where the hardware declaration is located.
  • In case the access level is not configured in the hardware declaration when set-accessprotection-password command is executed, the command will succeed and the security configuration file will be updated with the password. A warning will be displayed to inform the user about the necessity to configure the access level in the hardware declaration file.