startMaintenance cart

Starts a maintenance state on the cartridge. When a cartridge is in maintenance, it has the following effects:

  1. Asynchronous Work Orders in need of a notification coming from the Product Order Processor Waiting Queue are processed as usual.

  2. New or replaying Work Orders are not sent to the cartridge when they are processed by the Product Order Processor. They are automatically considered to be in the "network error" state.
  3. The Message Store and Forward (MSF) queue will consider the network element represented by the cartridge to be in the "in failure" state and will stop checking on the network element. The Message Store and Forward will wait for the cartridge to be out of the maintenance state before re-injecting work orders. 
startMaintenance cart [ nodename=<value> ]
            [ instance=<value> ]
            [ allowerror=<value> ]
            [ timeout=<value> ]

The following table describes the arguments of the startMaintenance cart command.

Option Description
nodename Name of the application node.
instance The name of a cartridge instance. This refers to the short name, not the fully scoped name. If the instance name is not specified, the change is reflected on all instances.
allowerror If "false", the command exits with an error. The default is true.
timeout The duration to wait for command completion, in seconds. The default is 600 seconds.