set-ip 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-ip [options]

Sends a request to a device to set the device IP parameters.

WARNING

To prevent network issues and conflicts, please ensure that you are using the correct MAC address for the device. Also check for any potential IP address conflicts with other devices on the network before assigning the IP address.

Options (all options are required)

  • Required:

    • --source-mac – The MAC address of the host network interface
    • --target-mac – The MAC address of the target device
    • --ip – The new IP address of the device
    • --subnet-mask – The new Subnet mask of the network
    • --gateway – The new address of the network Gateway

  • 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 request, the user is prompted for confirmation if the flag '--no-prompt' is not specified.

For example: >apax dcp-utility set-ip --source-mac 00:E0:4C:08:10:BE --target-mac AC:64:17:F3:DA:9A --ip ... Are you sure you want to set IP address for device AC:64:17:F3:DA:9A to 192.168.0.1. [y/N]: y

The IP-related options are checked for basic validity. (https://en.wikipedia.org/wiki/Subnetwork#Network_addressing_and_routing)

For example:

--subnet-mask 255.255.0.1 - is not a valid subnet mask.

--ip 192.168.0.10 --subnet-mask 255.255.255.0 --gateway 192.168.1.1 -is not valid. Gateway is not in range with IP address within provided Subnet mask.

The request should include all three parameters, IP, Subnet mask and Gateway. For PLCs configured in TIA Portal to be able to set a device IP address that persists after a power cycle of the device, the device configuration in the TIA Portal project must specify that the IP address is set at the device.

You can set a temporary IP address if the TIA Portal project in the device does not enable this setting. The PLC must be in STOP mode and the address that you set is temporary until the next power cycle. For more details, see Emergency IP definition.