2.2.17 pico

Owned by Jenni Wallin
Last updated: Dec 27, 2021
4 min read
Usage: pico -list <ip/host> ... | -view <pico name> | -add <ec name> <EC | ECSA> <ip/host> | -delete <ec name> <EC | 
ECSA> <ip/host> | -mark_for_shutdown <ec name> <EC | ECSA> <ip/host> <true | false>

This command is used to:

  • List, view, add, or delete pico instances
  • Signal to the Platform that an EC/ECSA is scheduled to be shut down

Note!

With the introduction of STR, it is typically no longer required to add pico instances. Provided that the value of the property pico.rcp.server.host is set to its default value or that the value can be found in the address attribute of the container, EC/ECSA, and SCs are implicitly added via the STR.

If pico.rcp.server.host does not match with any of the container addresses you can grant access to the system by:

  • Adding the missing address in the container attribute additional-addresses in the STR.
  • Setting the Platform property mz.pico.skip-registration-check to true. This will grant access for any pico host.
  • Adding a new pico host in the Pico Manager.

-list

usage: pico -list <ip/host> ...

pico -list  to list configured pico instances.

Example - pico -list

The following commands lists all pico hosts and pico instances.

MZ>> pico -list


Output:

ec_standard    ec    10.0.0.48 
ec_standard    ec    10.46.100.26 
ecsa_extended  ecsa  10.0.0.100

-view

usage: pico -view <pico name>

Use pico -view to view status of pico instances in the  system.

Example - pico -view

The following displays the status for all pico instances in the system.

MZ>> pico -view

Output:

Pico                 Start       Memory                 Response      Error    Marked For
Name                 Time        (Used, Commited, Max)  Time (ms)     Status   Shutdown
ec1 (ip:port)        <time>      1.1, 24.2, 27.6        1             OK       true             
ec2 (ip:port)        <time>      1.2, 23.3, 28.7        1             OK            
MZSH:45881 (ip:port) <time>      5.9, 15.5, 47.5        2             OK                    
Platform (ip:port)   <time>      8.2, 20.0, 27.6        2             OK

The Memory column is a comma separated list of Used, Committed and Maximum memory, and Response Time is measured in milliseconds.

If Error Status indicates "Error", an OutOfMemoryError has occurred and additional information will be included in the output. For example, in case of an OutOfMemoryError on the Platform, the following could be shown:

Platform: Mon Jan 23 09:59:47 CET 2012 OutOfMemoryError on platform at platform-e6410. 
See log/platform.log for more information

OutOfMemoryError is further described in 2.12 Out of Memory Info in System Log in the System Administration User's Guide.

If Error Status indicates "Connection failure", an RCP error has occurred.

If Marked for Shutdown is set to true, the EC/ECSA is scheduled to be shut down and will not be assigned workflows.

The following command displays the status of the pico instance named ec1.

MZ>> pico -view ec1

Output:

Pico Name:        ec1 (10.0.0.8:37197)
OS:               LINUX
OS Version:       2.6.38-11-generic-pae
Architecture:     I386
Processors:       8
Java Version:     1.8.0_121
Loaded Classes:   2854

-add

usage: pico -add <ec name> <EC | ECSA> <ip/host>

Use pico -add to add a pico instance to the  system.

Example - pico -add

The following command adds an EC named ec1 to host 10.0.0.48.

MZ>> pico -add ec1 ec 10.0.0.48

-delete

usage: pico -delete <ec name> <EC | ECSA> <ip/host>

Use pico -delete to delete a pico instance from the system.

Example - pico -delete

The following command deletes an ECSA named ecsa1 from host 10.0.0.48.

MZ>> pico -delete ecsa1 ecsa 10.0.0.48

mark_for_shutdown

usage: pico -mark_for_shutdown <ec name> <EC | ECSA> <ip/host> <true | false>

Use pico -mark_for_shutdown to signal to the Platform that an EC/ECSA is scheduled to be shut down. As a result, the Platform will no assign workflows to the EC/ECSA.

Example - pico -mark_for_shutdown

The following command signals that the EC named EC1 on 10.0.0.48 should not be assigned workflows.

MZ>> pico -mark_for_shutdown ec1 ec 10.0.0.48 true

Return Codes

Listed below are the different return codes for the pico command:

CodeDescription

0

Will be returned if the command was successful, or if arguments are missing.

1

Will be returned if arguments could not be parsed

2

Will be returned if the communication with the Platform failed.

3

Will be returned if checking of user privileges failed, or if pico already exists when trying to add a new pico.

4

Will be returned if the user does not have permission to add or delete picos.

5

Will be returned if an unexpected error occurred.