set-name command - Manual - DCP Utility - Documentation for the SIMATIC AX DCP Utility tool. - DCP Utility,

DCP Utility CLI Tool (dcp-utility)
Portfolio
SIMATIC AX
Product
DCP Utility
Software version
1.1.2
Edition
04/2024
Language
English (original)
Package Name
@ax/dcp-utility-docs
apax dcp-utility set-name [options]

Sends a request to a device to set the device's PROFINET (PN) name.

  • Required:

  • --source-mac – The MAC address of the host network interface

  • --target-mac – The MAC address of the target device

  • -n, --name – The new name of the PROFINET device.

  • Optional:

    • --no-prompt – Do not require confirmation prompt
    • --timeout – The timeout in milliseconds to capture the device feedback on the request (Default 1000, maximum is 60 000)

On execution of this command, the user is prompted for confirmation if the flag '--no-prompt' is not specified. For example: >apax dcp-utility set-name --source-mac 00:E0:4C:08:10:BE --target-mac AC:64:17:F3:DA:9A --name newName Are you sure you want to set PROFINET name for device AC:64:17:F3:DA:9A to 'newName'? [y/N]:

This command sends a request to change the PN name of the device.

It is recommended to follow the PROFINET naming rules, which follow the standard DNS (Domain Name System) naming conventions.

If you enter a name that is not PROFINET-compliant, the name is converted to a valid PROFINET name using IDNs.

PROFINET name rules:

  • The maximum number of characters for the device name is 63.
  • Valid characters are the lower case letters "a" through "z", the digits 0 through 9, the hyphen character (minus sign) and the period character.
  • A name must not have the format n.n.n.n where n is a value of 0 through 999.
  • A name cannot begin with the string port-nnn or the string port-nnnnnnnn, where n is a digit 0 through 9. For example, port-123 and port-123-45678 are not PROFINET-compliant names.
  • A name cannot start or end with a hyphen "-" or period "." character.

For PLCs configured within TIA to be able to set a device's PN interface name, the PLC's interface configuration in the TIA project must specify that the PROFINET device name is set directly at the device.