WCCOAtoolCMactivation - License Handling Online

Local PC Operations

Operations shown in this section are common to a WinCC OA installation and do not require any access to the License Portal.

Get the IP address of the license server

This is useful when a container is not attached locally. WCCOAtoolCMactivation cannot guess server or local installation, hence when the container to be handled is possibly remote the search for IP address must be done first.

WCCOAtoolCMactivation -info -serial 130-123456789

Example JSON response:

{
  "returnmessage": {
    "errorcode": 0,
    "errortext": "operation \"info\" completed successfully",
    "internalerrorcode": "0",
    "internalerrortext": ""
  },
  "result": {
    "servername": "license-server.example.com",
    "serverip": "192.168.1.100"
  }
}

Create a new container

This is the action behind the "+" icon in WinCC OA PA license panel. This call works locally or with remote license servers.

WCCOAtoolCMactivation -container -lif "C:\Siemens\Automation\WinCC_OA\3.20\data\license\ETM_pc_-_A_Siemens_Company.WibuCmLif"

Example JSON response:

{
  "returnmessage": {
    "errorcode": 0,
    "errortext": "operation \"cmcontainer\" completed successfully",
    "internalerrorcode": "0",
    "internalerrortext": ""
  },
  "result": {
    "cmcontainer": "130-987654321"
  }
}

This works with the IP address of a license server as well:

WCCOAtoolCMactivation -container -lif "C:\Siemens\Automation\WinCC_OA\3.20\data\license\ETM_pc_-_A_Siemens_Company.WibuCmLif" -server 192.168.1.100

Online Operations

These operations require access to the License Portal URL.

Auto-Update

This allows you to fetch any available license changes for the given container, which requires either changes in the license portal or a license renewal in license central. Call auto-update for subscriptions regularly or whenever necessary. This requires License Portal URL.

WCCOAtoolCMactivation -autoupdate -serial 130-987654321 https://license-portal.example.com/12345-dev/portal

Example JSON response:

{
  "returnmessage": {
    "errorcode": 0,
    "errortext": "operation \"autoupdate\" completed successfully",
    "internalerrorcode": "0",
    "internalerrortext": ""
  }
}

The same can be done for a remote license server:

WCCOAtoolCMactivation -autoupdate -serial 130-987654321 -server 192.168.1.100 https://license-portal.example.com/12345-dev/portal

Download license update file for container

This will download the recent available updates for the given container into a file. The .rau file needs to be transferred to the offline station e.g. via USB drive.

WCCOAtoolCMactivation -download -update license-update.rau -serial 130-987654321 https://license-portal.example.com/12345-dev/portal

Upload receipt

Transfer receipt .rac file to an online PC which can access the License Portal. Then either upload the receipt in the License Portal or do so by using the WCCOAtoolCMactivation.

WCCOAtoolCMactivation -confirm -context license-receipt.rac -serial 130-987654321 https://license-portal.example.com/12345-dev/portal

Connecting Virtual Container to Real Serial Number

This step is only required for brand new bare metal installations. Here, a new license container is created on the PC and a new virtual container is prepared in the License Portal. To attach both new entities, this optional step can be supported (not fully done) with WCCOAtoolCMactivation.

This operation can only be done in the License Portal. However, the connection between a virtual container and a serial number requires a context file. This context file can be created offline and then has to be transferred to an online station. In the License Portal, the virtual container can then be bound to this context file. From here on, the normal license update download can continue.

Create a license context file (offline)

WCCOAtoolCMactivation -create -context license-context.rac -serial 130-987654321

Assign serial number to virtual container (online in portal only)

Find the virtual container and click the container sync button, select the matching container type and assign the context file.

After this you can either directly download the update and transfer back or use the tool download function.