Copyright © Cloud Software Group, Inc. All Rights Reserved

Configuring and Managing Fulfillment Provisioning Nodes

The provadmin commands are used to install and manage a Fulfillment Provisioning node. Use these commands in the directory containing the node.

To get help and a list of available commands, use the following:

provadmin help fp

Fulfillment Provisioning Commands

This topic describes the different types of Fulfillment Provisioning commands.

Parameters between angle brackets are mandatory. Parameters between square brackets are optional.

install fp

This command is used to install a Fulfillment Provisioning node:

provadmin install fp [ configpath=<value> ]
[ adminport=<value> ]
[ memorysize=<value> ]
[ nameserviceport=<value> ]
[ buildtype=<value> ]
[ nodename=<value> ]
[ nogui=<value> ]
[ debugfilter=<value> ]
[ lockedObjectHashSize=<value> ]
[ language=<value> ]

The following table describes the general options that are valid with the install command.

Option	Description
configpath	The directory from which configuration files are loaded. The default directory is: $SW_HOME/distrib/kabira/kpsa/samples/prov/conf. After installation, the following configuration files are loaded: • fp.kds :Deploy specification. If a custom fp.kds is not found in configuration path, the application looks for kpsa.kds. If kpsa.kds is not found, then $SW_HOME/distrib/kabira/kpsa/deploy/fp.kds will be used. • provisioning.bpmn : BPMN file for the main flow. It searches for provisioning.bpmn if provisioning.bpmn is not found. • kop-<version>.def: Fulfillment Provisioning Catalog definition files. These are created using the Fulfillment Provisioning Catalog Application. • *.xml and *.bpmn : XMI files for ProductOrderFlows. The cpr.def file will reference *.bpmn and *.xml files. After installation, these files are loaded into the $SW_HOME/<nodename>/conf directory.
adminport	The web server port. The default value is a random number.
memorysize	The size of shared memory in MB, The default size is 512 MB.
nameserviceport	The port used for name service. The default value is a random number.
buildtype	The build type of components to be loaded. The values can be PRODUCTION or DEVELOPMENT. The default value is PRODUCTION.
nodename	The name of the Fulfillment Provisioning node.The default value is the name of the server.
nogui	Used to specify whether or not Fulfillment Provisioning should install or start Catalog GUI. The default value is false.
debugfilter	Sets the debug trace level. To set a debug level, use the following as a guide: NoSubsystems = 0x00000000, SystemServices = 0x00000001, EventDistributionBus = 0x00000002, ObjectServices = 0x00000004, SystemManagement = 0x00000008, SystemMonitor = 0x00000010, WhiteBoxTesting = 0x00000020, NetworkElement = 0x00000040, Persistence = 0x00000080, Distribution = 0x00000100, CodeGeneration = 0x00000200, Exceptions = 0x00000400, Script = 0x00000800, Performance = 0x00001000, Recovery = 0x00002000, Java = 0x00004000, SystemCoordinator = 0x00008000, Engine = 0x00010000, Allocator = 0x00020000, Corba = 0x00040000, Transform = 0x00080000, DistributionDisc = 0x00100000, DistributionPDU = 0x00200000, User = 0x00400000, DirectoryServices = 0x00800000, Security = 0x01000000, DesignCenter = 0x02000000, AllSubsystems = 0x03FFFFFF
lockedObjectHashSize	Is used to configure the node\ObjectServices-> lockedObjectHashSize registry value before starting the node. The default value is 101.This number must be a prime number greater than 101. This value represents the hash start size for locked objects inside one transaction. When you have small transactions, with lesser objects locked, setting a high value will decrease performance. On the other hand, if you have transactions involving large numbers of objects, you may experience a significant performance boost by setting this to a high value. Please consult TIBCO before changing this value.
language	The language to be used in the event dictionary. The default value is en. The list of available languages depends on the language package that is installed in SW_HOME.

The following shows the usage and output of the install fp command.

>provadmin fp install debugfilter=0x03FFFFFF adminport=18000 memorysize=500
Loading hlralcatelr5.bpmn
Loading pof04.bpmn
Loading provisioning.bpmn
Loading vms.bpmn
Loading cpr.def
Loading cps.def
Loading kop-1.0.0.def
Loading kop-1.1.0.def
Loading xdsl.def
Loading CA_exchanges.ini
Loading CA_request_latency.ini
Loading checkpointconfig.ini
Loading config.ini
Loading fwriter.ini
Loading kpsastats-default.ini
Loading Shared_Memory.ini
Loading SO_in_queue.ini
Loading SO_number.ini
Loading SO_processing_time.ini
Loading trace.ini
Loading WO_number.ini
Loading WO_processing_time.ini
Loading mapping.dm
Loading createCarts.tst
Loading deleteCarts.tst
Loading cesrouter.trn
Loading hlralcatelr5.trn
Loading vms.trn
Checkpoint directory is ../checkpoints
Installing node

Starting node einsteinium ...
Installing Registry ...
Updating Registry ...
Installing Components ...
Starting Components ...
Waiting for security services to start ...
Loading Security Policy ...
Startup complete

Node einsteinium is configured to use PRODUCTION executables
Node einsteinium shared memory size is 500Mb
Node einsteinium path: /home/nicolas/einsteinium
Node einsteinium host: einsteinium

System Coordinator Host: All Interfaces
System Coordinator Port: 21325

Web Server Host: All Interfaces
Web Server Port: 18000


Node einsteinium is configured to use PRODUCTION executables
Node einsteinium shared memory size is 500Mb
Node einsteinium path: /opt/kabira/users/svngate9/TOTO/einsteinium
Node einsteinium host: einsteinium

System Coordinator Host: All Interfaces
System Coordinator Port: 21325

Web Server Host: All Interfaces
Web Server Port: 18000

Loading fp components
Setting traceDebugFilter to 0x03FFFFFF for fp::fp

$ ls einsteinium/
conf dcpid DSERegistry.sm manual_archive php.ini
swsrv.kds System::osw_config.xml System::swcoordadmin.log
coordinator.log dcport einsteinium_config.xml manual_input prodlib
System::kssl_config.xml System::osw.log
coordinator.stdout devlib fp::fp_config.xml ossm reinject_archive
System::kssl.log System::swcoordadmin_config.xml

>

remove fp

This command is used to stop and remove a Fulfillment Provisioning node.

provadmin remove fp [ nodename=<value> ]
[ savelog=<value> ]
[ saveconf=<value> ]

The following table describes the general options that are valid with the remove command.

Option	Description
nodename	Fulfillment Provisioning node name. By default, it is the name of the server.
savelog	If true, the log files are saved. The default value is true.
saveconf	If true, the configuration files are saved. The default value is true.

The following shows the usage and output of the remove fp command.

>$ provadmin remove fp
Saving catalog data to /home/nicolas/saved/conf
Copying log files to /home/nicolas/saved/log_2012-10-10:14:17:59
Checkpoint directory is ../checkpoints

Stopping node einsteinium...
Done.

Removing node einsteinium directory ...
$ >

start fp

This command starts a previously installed node and the Fulfillment Provisioning engine.

provadmin start fp [ nodename=<value> ]

The following table describes the general options that are valid with the start command.

Option	Description
nodename	Fulfillment Provisioning node name. By default, it is the name of the server.
catalogadminport	The port for Fulfillment Provisioning Catalog UI. The default is 18081.

The following shows the usage and output of the start fp command.

>$ provadmin start fp
Starting node einsteinium

metautils.php: creating provhead::AppManagerInterface...created.

FP status is <Idle>
FP status is <Loaded>
Catalog Web Admin URL: http://einsteinium:18080
>

stop fp

This command is used to stop a running node and all its engines.

provadmin stop fp [ nodename=<value> ]
[ stopcoordinator=<value>

The following table describes the general options that are valid with the stop command.

Option	Description
nodename	Fulfillment Provisioning node name. By default, it is the name of the server.
stopcoordinator	Indicates whether or not the Kabira Infrastructure Server coordinator is stopped. The default value is false.

The following shows the usage and output of the stop fp command.

>$ provadmin stop fp
Stopping Catalog Web Admin.
Stopping fp node
fp node stopped
>

display fp

This command displays the state of a previously installed Fulfillment Provisioning node and its installed components.

provadmin display fp [ nodename=<value> ]

The following table describes the general options that are valid with the display command.

Option	Description
nodename	Fulfillment Provisioning node name. By default, it is the name of the server.

The following shows the usage and output of the display fp command.

>$ provadmin display fp
State of node einsteinium:
Engine fp::fp
State: running
Components:
DynamicEngine
kis
...
pomapper
basesodata
sop
myRouting
rollbackdecisionmodule
xmlscanner

>

getadminport fp

This command returns the port number allocated to the admin port.

provadmin getadminport fp [ nodename=<value> ]

The following table describes the general options that are valid with the getadminport command.

Option	Description
nodename	Fulfillment Provisioning node name. By default, it is the name of the server.

The following shows the usage and ouput of the getadminport FP command.

>provadmin getadminport fp nodename=kpsa01
18000
>

getallports fp

This command returns the port numbers for the coordinator, web, and Java Naming and Directory Interface (JNDI).

provadmin getallports fp [ nodename=<value> ]

The following table describes the general options that are valid with the getallports command.

Option	Description
nodename	Fulfillment Provisioning node name. By default, it is the name of the server.

Statistical Configuration Commands

The fpstats command is used for statistical configuration. For more detailed information on the fpstats commands, refer to the Fulfillment Provisioning Developers Guide.

load fpstats

This command loads a statistic configuration file.

provadmin load fpstats [ nodename=<value> ]
file=<value>

The following table describes the general options that are valid with the load fpstats command.

Option	Description
nodename	Fulfillment Provisioning node name. By default, it is the name of the server.
file	Path of the configuration file to load.

The following shows the usage and output of the load fpstats command.

> provadmin load fpstats nodename=myNode file=SO_number.ini

> provadmin load fpstats nodename=myNode file=badConfig.ini
error: fpstats load file=badConfig.ini failed: Failed

unload fpstats

This command removes the period managers, data savers, counters, and threshold objects from memory.

provadmin unload fpstats [ nodename=<value> ]
otype=<value>
[ ctrname=<value> ]
[ dataname=<value> ]
[ name=<value> ]

The following table describes the general options that are valid with the unload fpstats command.

Option	Description
nodename	Fulfillment Provisioning node name. By default, it is the name of the server.
otype	Type of object: • "pm" or "PeriodManager" for period manager, • "ds" or "DataSaver" for data saver, • "c" or "Counter" for counter, • "t" or "Threshold" for threshold.
ctrname	Counter name.
dataname	CounterData name.
name	Period manager name, data saver name, or threshold name.

The following shows the parameters taken into account by unload fpstats according to the value of parameter 'otype'.

provadmin unload fpstats otype=pm name=PeriodManagerName

A period manager can be removed only if there is no counter linked to it.

provadmin unload fpstats otype=ds name=DataSaverName

A data saver can be removed only if there is no counter linked to it.

provadmin unload fpstats otype=c ctrname=CounterName

If CounterName is a dynamic counter, all its related dynamic instance counters are removed.

provadmin unload fpstats otype=t ctrname=CounterName dataname=DataName name=ThresholdName

start fpstats

This command starts the period managers, data savers, counters, and threshold objects.

provadmin start fpstats [ nodename=<value> ]
otype=<value>
[ ctrname=<value> ]
[ dataname=<value> ]
[ name=<value> ]
[ withall=<value> ]

The following table describes the general options that are valid with the start fpstats command.

Option	Description
nodename	Fulfillment Provisioning node name. By default, it is the name of the server.
otype	Type of object: • "pm" or "PeriodManager" for period manager, • "ds" or "DataSaver" for data saver, • "c" or "Counter" for counter, • "t" or "Threshold" for threshold.
ctrname	Counter name.
dataname	CounterData name.
name	Period manager name, data saver name, or threshold name.
withall	"true" or "false" (false by default) to start all counters linked to a period manager.

The following shows the parameters taken into account by start fpstats according to the value of parameter 'otype'.

provadmin start fpstats otype=pm name=PeriodManagerName [ withall=false|true ]

If withall=true, all counters linked to the period manager are started.

provadmin start fpstats otype=ds name=DataSaverName

provadmin start fpstats otype=c ctrname=CounterName [ withall=false|true ]

If withall=true, the period manager to which the counter, "CounterName," is linked and all counters linked to it are started.

provadmin start fpstats otype=t ctrname=CounterName dataname=DataName name=ThresholdName

stop fpstats

This command stops the period managers, data savers, counters, and threshold objects.

provadmin stop fpstats [ nodename=<value> ]
otype=<value>
[ ctrname=<value> ]
[ dataname=<value> ]
[ name=<value> ]
[ withall=<value> ]

The following table describes the general options that are valid with the stop fpstats command.

Option	Description
nodename	Fulfillment Provisioning node name. By default, it is the name of the server.
otype	Type of object: • "pm" or "PeriodManager" for period manager, • "ds" or "DataSaver" for data saver, • "c" or "Counter" for counter, • "t" or "Threshold" for threshold.
ctrname	Counter name.
dataname	CounterData name.
name	Period manager name, data saver name, or threshold name.
withall	"true" or "false" (false by default) to stop all counters linked to a period manager.

The following shows the parameters taken into account by stop fpstats according to the value of parameter 'otype'.

provadmin stop fpstats otype=pm name=PeriodManagerName [ withall=false|true ]

If withall=true, all counters linked to the period manager are stopped.

provadmin stop fpstats otype=ds name=DataSaverName

provadmin stop fpstats otype=c ctrname=CounterName [ withall=false|true ]

If withall=true, the period manager to which counter "CounterName" is linked and all counters linked to it are stopped.

provadmin stop fpstats otype=t ctrname=CounterName dataname=DataName name=ThresholdName

display fpstats

This command displays configurations of period managers, data savers, counters, or displays a counter with its values.

provadmin display fpstats [ nodename=<value> ]
otype=<value>
[ ctrname=<value> ]
[ dataname=<value> ]
[ name=<value> ]> ]

The following table describes the general options that are valid with the display fpstats command.

Option	Description
nodename	Fulfillment Provisioning node name. By default, it is the name of the server.
otype	Type of object: • "pm" or "PeriodManager" for period manager, • "ds" or "DataSaver" for data saver, • "c" or "Counter" for counter, • "rv" or "Raw" for raw counterData value, • "sv" or "Sampled" for sampled counterData value, • "v" or "Values" for both (raw and sampled) counterData values.
ctrname	Counter name.
dataname	CounterData name.
name	Period manager name, or data saver name.

The following shows the parameters taken into account by display fpstats according to the value of the parameter, 'otype'.

provadmin display fpstats otype=pm [ name=PeriodManagerName ]

If parameter name is not provided, all period managers are displayed.

If the period manager, "PeriodManagerName" is not found, all period managers which contain "PeriodManagerName" in their name are displayed.

provadmin display fpstats otype=ds [ name=DataSaverName ]

If parameter name is not provided, all data savers are displayed.

If data saver named "DataSaverName" is not found, all data savers which contain "DataSaverName" in their name are displayed.

provadmin display fpstats otype=c [ ctrname=CounterName ]

If parameter ctrname is not provided, all counters are displayed.

If counter named "CounterName" is not found, all counters which contain "CounterName" in their name are displayed.

provadmin display fpstats otype=rv|sv|v ctrname=CounterName [ dataname=DataName ]

Counter named "CounterName" must exist.

If the parameter dataname is not provided, values of all counterData are displayed. Otherwise, if the parameter dataname is provided then only the value(s) of counterData named "DataName" are displayed.

Catalog Configuration Commands

This plugin is used to create an offline Catalog application by installing a new instance of Fulfillment Provisioning. It is primarily used to administer and configure the Catalog in a Fulfillment Provisioning node. The lifecycle of the plug-in involves installing, starting, stopping, removing an offline catalog.

The plugin is used to start a node for Fulfillment Provisioning Catalog configuration only :

1.	provadmin install catalog

2.	provadmin start catalog

3.	provadmin update catalog configpath=<location of the def/xml files>

4.	provadmin stop catalog

5.	provadmin remove catalog

install catalog

This command installs the Fulfillment Provisioning catalog application.

provadmin install catalog [ configpath=<value> ]
[ nodename=<value> ]
[ adminport=<value> ]
[ memorysize=<value> ]
[ buildtype=<value> ]

The following table describes the general options that are valid with the install catalog command.

Option	Description
configpath	Configuration files are loaded from the specified directory. The default directory is: $SW_HOME/distrib/kabira/kpsa/sample/conf These are the configuration files loaded from configpath upon install: • fp.kds: Deploy specification. If a custom fp.kds is not found in configpath, then $SW_HOME/distrib/kabira/kpsa/deploy/fp.kds will be used. • provisioning.bpmn: XMI file for the main flow. • *.def: Fulfillment Provisioning Catalog definition files. These can be created manually, or using the Fulfillment Provisioning Catalog Application. • *.xml: XMI files for ProductOrderFlows. The cpr.def file will reference these *.xml files. On installation, these files are loaded into the $SW_HOME/<nodename>/conf directory.
adminport	Set web server port. By default, it is a randomly generated number.
memorysize	Size of the shared memory in MB. The default value is 450.
buildtype	The build type of components to be loaded, must be PRODUCTION or DEVELOPMENT . The default is PRODUCTION.
nodename	Fulfillment Provisioning node name. By default, it is the name of the server.

The following shows the usage of install catalog and a typical output from the command.

>provadmin install catalog configpath=$SW_HOME/kpsaconf nodename=kpsa02 adminport=18083 memorysize=600 buildtype=DEVELOPMENT

Installing node

Starting node kpsa02 ...
Installing Registry ...
Updating Registry ...
Installing Components ...
Starting Components ...
Waiting for security services to start ...
Loading Security Policy ...
Startup complete

Node kpsa02 is configured to use DEVELOPMENT executables
Node kpsa02 shared memory size is 600Mb
Node kpsa02 path: /opt/kabira/users/iphillip/data/kpsa02
Node kpsa02 host: wokingham

System Coordinator Host: All Interfaces
System Coordinator Port: 31138

Web Server Host: All Interfaces
Web Server Port: 18083

Loading catalog components
Copying /opt/kabira/users/iphillip/kpsaconf/cpr.def to kpsa02/conf
Copying /opt/kabira/users/iphillip/kpsaconf/pof04.xml to kpsa02/conf
Copying /opt/kabira/users/iphillip/kpsaconf/cps.def to kpsa02/conf

catalogadmin port: 18083
>

start catalog

This command starts the Fulfillment Provisioning Catalog application.

provadmin start catalog [ nodename=<value> ]

The following table describes the general options that are valid with the start catalog command.

Option	Description
nodename	Fulfillment Provisioning node name. By default, it is the name of the server.

The following shows the usage of start catalog and a typical output from the command.

>provadmin start catalog nodename=kpsa02
Starting node
Starting Catalog.
Catalog Web Admin URL: http://wokingham:18080

>

stop catalog

stop catalog

This command stops the Fulfillment Provisioning Catalog application.

provadmin stop catalog [ nodename=<value> ]

The following table describes the general options that are valid with the stop catalog command.

Option	Description
nodename	Fulfillment Provisioning node name. By default, it is the name of the server.

The following shows the usage of stop catalog and a typical output from the command.

>provadmin stop catalog nodename=kpsa02
Stopping node
Stopping catalog node
catalog node stopped
>

remove catalog

This command removes the Fulfillment Provisioning Catalog application.

provadmin remove catalog [ nodename=<value> ]
[ saveconf=<value> ]

The following table describes the general options that are valid with the remove catalog command.

Option	Description
nodename	Fulfillment Provisioning node name. By default, it is the name of the server.
saveconf	Indicates whether or not the configuration files are saved. The default value is true.

The following shows the usage of remove catalog and a typical output from the command.

>provadmin remove catalog nodename=kpsa02
Stopping node
Stopping catalog node
catalog node stopped
Removing node
Saving catalog data to /opt/kabira/users/iphillip/data/saved/conf

Stopping node kpsa02...
Done.

Removing node kpsa02 directory ...

>

save catalog

This command saves the catalog information. The files cpr.def, cps.def and all XML files used by Fulfillment Provisioning Catalog are copied to ./saved/conf.

save catalog [ nodename=<value> ]

The following table describes the general options that are valid with the save catalog command.

Option	Description
nodename	Fulfillment Provisioning node name. By default, it is the name of the server.

The following shows the usage of save catalog and a typical output from the command.

>provadmin save catalog nodename=kpsa02
Saving catalog data to /opt/kabira/users/iphillip/data/saved/conf
>

update catalog

This command reloads the Fulfillment Provisioning Catalog application.

provadmin update catalog [ configpath=<value> ]
[ nodename=<value> ]

Option	Description
configpath (required)	The catalog reads configuration files from this directory .
nodename	Fulfillment Provisioning node name. By default, it is the name of the server.

Managing Catalog Versions

 

The plug-in is used to manage catalog versions. The default behavior of Fulfillment Provisioning changes based on the number of catalog versions. The following table lists the various possibilities:

Number of Versions	Default
Catalog starts with one version	The version is treated as default.
Catalog starts with multiple versions, and none are configured as default	The first activated configuration will be treated as default.
Only one versions is set as default	The default configuration cannot be deactivated, but it can be replaced with a new one.

Except the locked versions, loaded and activated versions can be edited using the Catalog UI. The Service Order Processing will be able to select and use only the activated and default catalog versions. To select the right domain version, the Service Order Processing looks for the #KOPVERSION in the SOD dataset. The course of action will change based on the availability of #KOPVERSION in the dataset. The following table lists the possibilities:

Availability of #KOPVERSION in The Dataset	Default
#KOPVERSION not found in the dataset	The Service Order Processing selects the default version of the domain.
#KOPVERSION found in the dataset and it contains the name of the used version. For example, 1.3.6::GSM	If the service order comes back to Service Order Processing, it will use the used version.

Default Catalog Versions

The default catalog version depends on #KOPVERSION. For example, a Fulfillment Provisioning node can have two versions: 1.3.5, which is the default, or 1.3.6, which is an active version.

Version of the Incoming Order	Version on the Fulfillment Provisioning Node
1.3.5	Either ther is no #KOPVERSION or #KOPVERSION =1.3.5
1.3.6	#KOPVERSION =1.3.6

If you switch the default from 1.3.5 to 1.3.6, all incoming orders that are without #KOPVERSION will start using 1.3.6.

Stream Gate Commands

This topic describes the different types of gate commands.

display gate

Displays the status of the stream gates.

provadmin display gate [ name=<value> ]
[ delimiter=<value> ]
[ nodename=<value> ]

The following table describes the general options that are valid with the display gate command:

Option	Description
name	The runtimeName of the gate module. The default is all.
nodename	Fulfillment Provisioning node name.
delimiter	The delimiter character used in the display report.

The following is a typical output from this command:

>provadmin display gate nodename=banks
afterSopGate is Open
>

open gate

This command opens a stream gate.

provadmin open gate [ name=<value> ]
[ nodename=<value> ]

The following table describes the general option that are valid with the open gate command.

Option	Description
name	The runtimeName of the gate module. The default value is all.
nodename	Fulfillment Provisioning node name.

The following is a typical output from this command:

>provadmin open gate nodename=banks name=afterSopGate
>

close gate

Closes a stream gate.

provadmin close gate [ name=<value> ]
[ nodename=<value> ]

The following table describes the general options that are valid with the close gate command.

Option	Description
name	The runtimeName of the gate module. The default value is all.
nodename	Fulfillment Provisioning node name.

The following is a typical output from this command:

>provadmin close gate nodename=bank name=afterSopGate
>

Checkpoint Commands

This topic describes the different types of checkpoint commands.

load checkpoints

Loads all checkpoints in the Fulfillment Provisioning node.

provadmin load checkpoints [ nodename=<value> ]
[ cpnodename=<value> ]
[ types=<t1,t2,...,tn> ]
[ chunksize=<value> ]
[ autoStartFC=<value> ]

The following table describes the general options that are valid with the load command of the checkpoints plug-in.

Option	Description
nodename	Application node name.
cpnodename	Checkpoint node name. If empty (default), it uses the checkpoint node name configured in the application.
types	Comma separated list of checkpoint types (kinds) to load. If empty (default), all checkpoint types actually handled by the application are loaded.
chunksize	Number of checkpoints to load per transaction. If empty, uses the value configured on the node.
autoStartFC	Start the flow controller at end of command.It is automatically stopped at the beginning of the command.The default value is true.

The following is a typical output from this command:

>provadmin load checkpoints nodename=banks autoStartFC=false
kpsa status is <CheckpointsLoaded>
>

Loading the checkpoint should only be done on a newly installed and started KPSA node. Before and during the reload, the client adapters must remain disabled and locked. The reload process starts the flow controller at the end of the load command, allowing reloaded orders to begin processing.

migrate checkpoints

Migrates all checkpoints in the Fulfillment Provisioning node to the checkpoint version of the current application.

provadmin migrate checkpoints [ nodename=<value> ]
[ cpnodename=<value> ]
[ types=<t1,t2,...,tn> ]
[ chunksize=<value> ]
[ autoStartFC=<value> ]

The following table describes the general options that are valid with the migrate command of the checkpoints plug-in.

Option	Description
nodename	Application node name.
cpnodename	Checkpoint node name. If empty (default), it uses the checkpoint node name configured in the application.
types	Comma separated list of checkpoint types (kinds) to migrate. If empty (default) all checkpoint types handled by the application are migrated.
chunksize	Number of checkpoints to migrate per transaction. If empty, the application uses the value configured on the node.
autoStartFC	Start the flow controller at end of command. .It is automatically stopped at the beginning of the command.The default value is true.

Before starting a migration, it is recommended to take a snapshot of the checkpoints so that if there is a problem, it is possible to rollback and restore the checkpoints to their pre-migration state.

Migrating checkpoints should be done on a newly installed node. You should not use this command on an existing node.

snapshot checkpoints

Takes a snapshot of all checkpoints in the Fulfillment Provisioning node.

provadmin snapshot checkpoints [ nodename=<value> ]
[ cpnodename=<value> ]
[ snapshotId=<value> ]
[ autoStartFC=<value> ]

The following table describes the general options that are valid with the snapshot command of the checkpoints plugin.

Option	Description
nodename	Application node name
cpnodename	Checkpoint node name. If empty (default), it uses the checkpoint node name configured in the application.
snapshotId	Id of the snapshot to take.

When a back-end file is used, the command creates a compressed archive of the checkpoints. The snapshot command is useful to safely prepare a checkpoint migration. Taking a snapshot of checkpoints should be done on an idle node.

rollback checkpoints

Restores a snapshot of checkpoints.

provadmin rollback checkpoints [ nodename=<value> ]
[ cpnodename=<value> ]
[ snapshotId=<value> ]

The following table describes the general options that are valid with the rollback command of the checkpoints plugin.

Option	Description
nodename	Application node name
cpnodename	Checkpoint node name. If empty (default), it uses the checkpoint node name configured in the application.
snapshotId	Id of the snapshot to take.

Rollbacking checkpoints can be useful in case a migration goes wrong and you want to restore checkpoints from a snapshot.

Rollbacking checkpoints to a snapshot should be done on an idle Fulfillment Provisioning node.

listsnapshots checkpoints

List snapshots of checkpoints.

provadmin listsnapshots checkpoints [ nodename=<value> ]
[ cpnodename=<value> ]

The following table describes the general options that are valid with the listsnapshots command of the checkpoints plugin.

Option	Description
nodename	Application node name
cpnodename	Checkpoint node name. If empty (default), it uses the checkpoint node name configured in the application.

Client Adapter Commands

This topic describes the different types of ca commands.

enableall ca

 

Enables all client adapters in the Fulfillment Provisioning instance.

provadmin enableall ca [ nodename=<value> ]

The following table describes the general options that are valid with the enableall ca command.

Option	Description
nodename	Application node name

Client adapters should be enabled after reinjecting a checkpoint.

The following is a typical output from this command:

>provadmin enableall ca nodename=banks
starting all client adapters
>

disableall ca

 

Disables all client adapters in the Fulfillment Provisioning instance.

provadmin disableall ca [ nodename=<value> ]

The following table describes the general options that are valid with the disableall ca command.

Option	Description
nodename	Application node name

The following is a typical output from this command:

>provadmin disableall ca nodename=banks
disabling all client adapters
>

enable ca

 

Enables an instance of the client adapter specified by name.

provadmin enable ca [ nodename=<value> ]
caname=<value>

The following table describes the general options that are valid with the enable ca command.

Option	Description
nodename	Application node name
caname	The client adapter runtime name. If the name is not valid no action is taken.

The following is a typical output from this command.

>provadmin enable ca nodename=banks caname=scan_manual
enabling client adapter scan_manual
>

disable ca

 

Disables an instance of the client adapter specified by name.

provadmin disable ca [ nodename=<value> ]
caname=<value>

The following table describes the general options that are valid with the disable ca command.

Option	Description
nodename	Application node name
caname	The client adapter runtime name. If the name is not valid, no action is taken.

The following is a typical output from this command.

>provadmin disable ca nodename=banks caname=scan_manual
disabling client adapter scan_manual
>

lockall ca

 

Locks all client adapters in the Fulfillment Provisioning instance.

provadmin lockall ca [ nodename=<value> ]

The following table describes the general options that are valid with the lockall ca command.

Option	Description
nodename	Application node name

The following is a typical output from this command.

>provadmin lockall ca nodename=banks
locking all client adapters
>

unlockall ca

 

Unlocks all client adapters in the Fulfillment Provisioning instance.

provadmin unlockall ca [ nodename=<value> ]

The following table describes the general options that are valid with the unlockall ca command.

Option	Description
nodename	Application node name

The following is a typical output from this command.

>provadmin unlockall ca nodename=banks
unlocking all client adapters
unlockall
>

lock ca

 

Locks an instance of the client adapter specified by name.

provadmin lock ca [ nodename=<value> ]
caname=<value>

The following table describes the general options that are valid with the lock ca command.

Option	Description
nodename	Application node name
caname	The client adapter runtime name. If the name is not valid, no action is taken.

The following is a typical output from this command.

>provadmin lock ca nodename=banks caname=scan_manual
locking client adapter scan_manual
>

unlock ca

 

Unlocks an instance of the client adapter based on the name of the adapter.

provadmin unlock ca [ nodename=<value> ]
caname=<value>

The following table describes the general options that are valid with the unlock ca command.

Option	Description
nodename	Application node name
caname	The client adapter runtime name. If the name is not valid no action is taken.

The following is a typical output from this command.

>provadmin unlock ca nodename=banks caname=scan_manual
unlocking client adapter scan_manual
>

display ca

 

Display a client adapter instance.

provadmin display ca [ nodename=<value> ]
caname=<value>

The following table describes the general options that are valid with the unlock ca command.

Option	Description
nodename	Application node name
caname	The client adapter runtime name. If the name is not valid no action is taken.

The following is a typical output from this command.

>provadmin unlock ca nodename=banks caname=scan_manual
unlocking client adapter scan_manual
>

displayall ca

 

Displays all client adapters in the Fulfillment Provisioning instance.

provadmin unlock ca [ nodename=<value> ]
caname=<value>

The following table describes the general options that are valid with the unlock ca command.

Option	Description
nodename	Application node name
caname	The client adapter runtime name. If the name is not valid, no action is taken.

The following is a typical output from this command.

>provadmin unlock ca nodename=banks caname=scan_manual
unlocking client adapter scan_manual
>

configure ca

 

Configures a client adapter instance.

provadmin configure ca [ nodename=<value> ]
caname=<value>

The following table describes the general options that are valid with the configure ca command.

Option	Description
nodename	Application node name
caname	The client adapter runtime name. If the name is not valid, no action is taken.

Flow Controller Commands

 

This topic describes the different types of fc commands.

start fc

 

Starts all the flow controllers.

provadmin start fc [ nodename=<value> ]

The following table describes the general options that are valid with the start fc command.

Option	Description
nodename	Application node name

The following is a typical output from this command.

>provadmin start fc nodename=banks

stop fc

 

Stops all the flow controllers

provadmin stop fc [ nodename=<value> ]

The following table describes the general options that are valid with the stop fc command.

Option	Description
nodename	Application node name

The following is a typical output from this command.

>provadmin stop fc nodename=banks
>

getstatus fc

 

Returns the status of flow controllers.

provadmin getstatus fc [ nodename=<value> ]
[ name=<value> ]

The following table describes the general options that are valid with the getstatus fc command.

Option	Description
nodename	Application node name
name	Is the flow controller name. If not specified, then the status of the first flow controller is returned.

The following is a typical output from this command.

>provadmin getstatus fc nodename=banks name=fc

[FlowController : fc]
status = FCS_Stopped
>

configure fc

 

Configure the controllers.

provadmin configure fc [ nodename=<value> ]
[ filename=<value> ]

The following table describes the general options that are valid with the configure fc command.

Option	Description
nodename	Application node name
filename	Is the name of the configuration file. The file must be in the conf directory of the node. The default value is config.fc.

The following is ta typical output from this command.

>provadmin configure fc nodename=banks filename=config.fc
Loaded file <conf/config.fc>.
----------------
All elements configured.
Flow controllers are ready.

>

Queue Commands

This topic describes the different types of queue commands.

display queue

 

Displays the number of orders in all the queues.

provadmin display queue nodename=<value>
[ detailed=<value> ]

The following table describes the general options that are valid with the display queue command.

Option	Description
nodename	Application node name
detailed	If false, only the items in the queue is displayed. Otherwise, items in the heap are displayed. The default is false.

The following is a typical output from this command.

>provadmin display queue nodename=banks
Available queues and their sizes:
EndQ 0
CatalogFuncError 0
CatalogTechError 0
NetworkExecutionError 0
ReservoirError 0
SequencerError 0
priorityReservoir 0
PendingForRetry 0
pop_POPWaitingQueue 0
custseq 0
afterSopGate 0
entryGate 0
scan_manual 0
>

A detailed output may look like:

>provadmin display queue nodename=banks detailed=true
Available queues and their sizes:
queue 0
- queue_QueueOut 0
res 1
- __SUSPENDED__ 0
- res_QueueOut 1
>

displaySuspendedCount queue

 

Displays the number of suspended orders in all the queues.

provadmin displaySuspendedCount queue nodename=<value>
[ name=<value> ]

The following table describes the general options that are valid with the displaySuspendedCount queue command.

Option	Description
nodename	Application node name
name	Name of the order queue to display. If left blank, all order queues are listed.

The following is a typical output from this command.

>provadmin displaySuspendedCount queue nodename=banks
Suspended order counts:
res 1
Total: 1
>

displaySuspended queue

 

Displays the ID of suspended orders in all the queues.

provadmin displaySuspended queue nodename=<value>
[ name=<value> ]

The following table describes the general options that are valid with the displaySuspended queue command.

Option	Description
nodename	Application node name
name	Name of the order queue to display. If left blank, all order queues are listed.

The following isa typical output from this command.

>provadmin displaySuspendedCount queue nodename=banks
Suspended orders:
res|test_suspend_twice@@1
>

(The previous output assumes that the order with ID "test_suspend_twice@@1" is suspended in the order queue named "res".)

flush queue

 

Flushes the number of orders in all the queues.

provadmin flush queue name=<value>
nodename=<value>

The following table describes the general options that are valid with the flush queue command.

Option	Description
nodename	Application node name
name	The runtimeName of the queue module. This field does not take a default value.

The following is a typical output from this command.

>provadmin flush queue nodename=banks name=scan_manual
Flushing 0 service orders from scan_manual...
There are no service orders to flush
>

Order Processing Commands

This topic describes the different types of order commands.

cancel order

 

Cancels a service order.

provadmin cancel order [ nodename=<value> ]
[ orderId=<value> ]
[ timeout=<value> ]
[ description=<value> ]
[ force=<value> ]
[ portnum-<value> ]

The following table describes the general options that are valid with the cancel order command.

Option	Description
nodename	Application node name
orderId	The ID of the order to cancel.
timeout	The number of seconds the provadmin command waits for the command execution. After this period, the provadmin command ends in error, but the administrative command on the service order will still be ongoing. The default value is 60.
description	Additional textual information field that is added to the command. This shows up in the Fulfillment Provisioning logs. The default is provadmin command.
force	If false, new commands submitted to a service order will be piled up. If true, the command executes first as soon as the order enters an order queue. The default is false.
portnum	Allows you to flush order to a specific port. If not specified, flush uses the cancel port.

The following is a typical output from this command.

>provadmin cancel order orderId=my_order nodename=banks
Command <soadmin::Cancel:provadmin command> launched on <my_order>.
Command <Cancel:provadmin command> completed.
>

abort order

 

Aborts a service order.

provadmin abort order [ nodename=<value> ]
orderId=<value>
[ timeout=<value> ]
[ description=<value> ]
[ force=<value> ]

The following table describes the general options that are valid with the command.

Option	Description
nodename	Application node name
orderId	The ID of the order to cancel.
timeout	The number of seconds the provadmin command waits for the command execution. After this period, the provadmin command ends in error, but the administrative command on the service order will still be ongoing. The default value is 60.
description	Additional textual information field that is added to the command. This will show up in the Fulfillment Provisioning logs. The default is provadmin command.
force	If false, new commands submitted to a service order will be piled up. If true, the command executes first as soon as the order enters an order queue. The default is false.

The following is a typical output from this command.

>provadmin abort order orderId=my_order nodename=banks
Command <soadmin::Abortk:provadmin command> launched on <my_order>.
Command <Abort:provadmin command> completed.
>

suspend order

 

Suspends a service order.

provadmin suspend order [ nodename=<value> ]
orderId=<value>
[ timeout=<value> ]
[ description=<value> ]
[ force=<value> ]

The following table describes the general options that are valid with the suspend order command.

Option	Description
nodename	Application node name
orderId	The ID of the order to cancel.
timeout	The number of seconds the provadmin command will wait for the command execution. After this period, the provadmin command ends in error, but the administrative command on the service order will still be ongoing. The default value is 60.
description	Additional textual information field that is added to the command. This will show up in the Fulfillment Provisioning logs. The default is provadmin command.
force	If false, new commands submitted to a service order will be piled up. If true, the command executes first as soon as the order enters an order queue. The default is false.

The following is a typical output from this command.

>provadmin suspend order orderId=my_order nodename=banks
Command <soadmin::Suspend:provadmin command> launched on <my_order>.
Command <Suspend:provadmin command> completed.
>

resume order

 

Resumes a service order.

provadmin resume order [ nodename=<value> ]
orderId=<value>
[ timeout=<value> ]
[ description=<value> ]
[ force=<value> ]

The following table describes the general options that are valid with the command.

Option	Description
nodename	Application node name
orderId	The ID of the order to cancel.
timeout	The number of seconds the provadmin command will wait for the command execution.After this period, the provadmin command ends in error, but the administrative command on the service order will still be ongoing. The default value is 60.
description	Additional textual information field that is added to the command. This will show up in the Fulfillment Provisioning logs. The default is provadmin command.
force	If false, new commands submitted to a service order will be piled up. If true, the command executes first as soon as the order enters an order queue. The default is false.

The following is a typical output from this command.

>provadmin resume order orderId=my_order nodename=banks
Command <soadmin::Resume:provadmin command> launched on <my_order>.
Command <Resume:provadmin command> completed.
>

Mapping Commands

This topic describes the different types of mapping commands.

load mapping

 

Resets and loads the mapping defined in the .dm files present in the configpath directory of a node, which is the /conf directory.

provadmin load mapping [ nodename=<value> ]

The following table describes the general options that are valid with the load mapping command.

Option	Description
nodename	Application node name

The following is a typical output from this command:

>provadmin load mapping nodename=banks
Loading mapping configuration files (/opt/kabira/users/iphillip/data/banks/conf)...done
>

reset mapping

 

Resets the mapping defined in the .dm files present in the configpath directory, which is the /conf directory.

provadmin reset mapping [ nodename=<value> ]

The following table describes the general options that are valid with the reset mapping command.

Option	Description
nodename	Application node name

The following is a typical output from this command:

>provadmin reset mapping nodename=banks
resetting the mapping configuration...
resetting the mapping configuration: done
>

Dictionary Configuration Commands

This topic describes the different types of eventdictionary commands.

load eventdictionary

 

Loads dictionary files and its sub directories.

provadmin load eventdictionary [ nodename=<value> ]
type=<value>

The following table describes the general options that are valid with the load eventdictionary command.

Option	Description
nodename	Application node name
filter	Type of dictionary to load. This must be one of the following values: • all-- (Re)load all dictionary files (.dic, .enr, .flt). • if -- Like all, but only if not yet loaded correctly. • enr -- Reload only enrichment files (.enr). • flt -- Reload only filter files (.flt).

The following is a typical output from this command:

>provadmin load eventdictionary nodename=banks type=flt
>

setfilter eventdictionary

 

Load dictionary files.

provadmin setfilter eventdictionary [ nodename=<value> ]
[ name=<value> ]
filter=<value>

The following table describes the general options that are valid with the setfilter eventdictionary command.

Option	Description
nodename	Application node name
name	Dictionary name on which the filtering value will be applied. If not set, the filtering value is set at the global level.
filter	Filtering value to apply. It must be one of the following values: Allow, Warning, Error, Deny, Default, ForceAllow, ForceWarning, ForceError, and ForceDeny.

The following is a typical output from this command:

>provadmin setfilter eventdictionary nodename=banks name=kop filter=Warning
>

getfilter eventdictionary

 

Display current filtering values.

provadmin getfilter eventdictionary [ nodename=<value> ]
[ name=<value> ]
level=<value>

The following table describes the genreal options that are valid with the getfilter eventdictionary command.

Option	Description
nodename	Application node name
name	Dictionary name from which the filtering values are displayed. If not set, the filtering values are displayed for all dictionaries.
level	Level of filtering to display. This must be one of the following values: • global to display only filter value at the global level. • dictionary (or 'dic') to display filter values at global and dictionary levels. • event to display filter values at all three levels.

The following is a typical output from this command:

>provadmin getfilter eventdictionary nodename=banks level=dictionary
Global: Default
Dic. alcatelNGHLR: Allow (Allow)
Dic. kop: Warning (Allow)
Dic. sodata: Allow (Allow)
Dic. basesodata: Allow (Allow)
Dic. cartbase: Allow (Allow)
Dic. logservice: Allow (Allow)
Dic. simplugin: Allow (Allow)
Dic. sop: Allow (Allow)
Dic. pop: Allow (Allow)
Dic. pop_modelmachine: Allow (Allow)
Dic. wop: Allow (Allow)
Dic. dirscan: Allow (Allow)
Dic. dirscanner: Allow (Allow)
Dic. prov: Allow (Allow)
Dic. provdriver: Allow (Allow)
Dic. alarmservice: Allow (Allow)
Dic. cart_modelmachine: Allow (Allow)
Dic. cartplugin: Allow (Allow)
Dic. cartpool: Allow (Allow)
Dic. cartses: Allow (Allow)
Dic. cmf: Allow (Allow)
Dic. csl: Allow (Allow)
Dic. checkpoint: Allow (Allow)
Dic. routing: Allow (Allow)
Dic. soreplayq: Allow (Allow)
>

Cartridge Maintenance Commands

This topic describes the different types of cart commands.

configure cart

Configures all cartridges in a directory by processing all createCarts.tst files under conf/cartridges, and loads them at at runtime. Given a new configuration from Fulfillment Studio, when an application is being deployed, starting a new node configures the corresponding cartridges automatically.

 

provadmin configure cart [ nodename=<value> ]
[ directory=<value> ]

 

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

Option	Description
nodename	Application node name.
directory	The relative directory of a node used by the configure command. It is the location from where all the createCarts.tst are loaded.

install cart

 

Install the files needed to run cartridges.

provadmin install cart [ nodename=<value> ]
[ configpath=<value> ]

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

Option	Description
nodename	Application node name.
configpath	Upon installation, the script loads files from this directory. The default location is $SW_HOME/distrib/kabira/kpsa/sample/conf.

The following is typical output from this command:

>bash $ provadmin install cart
Installing cartridge files...
cesrouter.trn
hlralcatelr5.trn
vms.trn
createCarts.tst
deleteCarts.tst
fwriter.ini

remove cart

 

Removes cartridge files.

provadmin remove cart [ nodename=<value> ]

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

Option	Description
nodename	Application node name.

The following is typical output from this command:

>bash $ provadmin remove cart
Removing cesrouter.trn
Removing hlralcatelr5.trn
Removing vms.trn
Removing createCarts.tst
Removing deleteCarts.tst
Removing fwriter.ini
>

start cart

 

Executes the file, createCarts.tst, found in the configpath and loads the mapping defined in the .dm files of the configpath.

provadmin start cart [ nodename=<value> ]
[ configpath=<value> ]
If using simulators, execute 'start telnetsim' first

The following table describes the general options that are valid with the start cart command.

Option	Description
nodename	Application node name
configpath	Upon installation, the script loads files from this directory. The default location is $SW_HOME/distrib/kabira/kpsa/sample/conf.

The following is typical output from this command:

>provadmin start cart nodename=banks configpath=/opt/kabira/users/iphillip/distrib/kabira/kpsa/demo/conf
Executing cartridge configuration: createCarts.tst
execCarts.php: read conf/createCarts.tst OK.
execCarts.php: 17:41:47 - starting conf/createCarts.tst...
execCarts.php: waiting...
execCarts.php: 17:41:49 conf/createCarts.tst successful !
execCarts.php: -------

Loading the data mappers

Loading mapping configuration files (/opt/kabira/users/iphillip/data/banks/conf)...done
Auditing WOD...done
>

stop cart

 

Executes the file, deleteCarts.tst, found in the configpath.

provadmin stop cart [ nodename=<value> ]
[ configpath=<value> ]

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

Option	Description
nodename	Application node name.
configpath	Upon installation, the script loads files from this directory. The default location is $SW_HOME/distrib/kabira/Fulfillment Provisioning/sample/conf.

The following is typical output from this command:

>provadmin stop cart nodename=banks configpath=/opt/kabira/users/iphillip/distrib/kabira/Fulfillment Provisioning/demo/conf
Executing cartridge configuration: deleteCarts.tst
execCarts.php: read conf/deleteCarts.tst OK.
execCarts.php: 17:41:54 - starting conf/deleteCarts.tst...

execCarts.php: 17:41:55 conf/deleteCarts.tst successful !
execCarts.php: -------

>

enable cart

 

Enables the cartridge.

provadmin enable cart [ nodename=<value> ]
[ instance=<value> ]
[ allowerror=<value> ]
[ timeout=<value> ]

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

Option	Description
nodename	Application node name.
instance	The name of a particular 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.

The following is typical output from this command:

>provadmin enable cart nodename=. allowerror=false
Performing: enable on all cartridges.
Instance DisabledLocked: launched.
Instance EnabledLocked: failure, Already in processing.

Instance EnabledUnlocked: launched.
Instance DisabledUnlocked: launched.
Instance NotConfigured: launched.
Instance DisabledLocked: success.
Instance EnabledUnlocked: success.
Instance DisabledUnlocked: success.
Instance NotConfigured: Operation on PoolFactory:SimCart:NotConfigured, failed : <This Cartridge Element needs to be configured correctly before this action.>. KO
DATA: Name: enable
Operation : Event_changeState

disable cart

 

Disables the cartridge.

provadmin disable cart [ nodename=<value> ]
[ instance=<value> ]
[ allowerror=<value> ]
[ timeout=<value> ]

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

Option	Description
nodename	Application node name.
instance	The name of a particular 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.

The following is typical output from this command:

>provadmin disable cart nodename=. instance=DisabledLocked
Performing: disable on cartridge <DisabledLocked>.
Instance DisabledLocked: launched.
Instance DisabledLocked: success.

lock cart

 

Locks the cartridge.

provadmin lock cart [ nodename=<value> ]
[ instance=<value> ]
[ allowerror=<value> ]
[ timeout=<value> ]

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

Option	Description
nodename	Application node name.
instance	The name of a particular 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.

unlock cart

 

Unlocks the cartridge.

provadmin unlock cart [ nodename=<value> ]
[ instance=<value> ]
[ allowerror=<value> ]
[ timeout=<value> ]

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

Option	Description
nodename	Application node name.
instance	The name of a particular 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.

display cart

 

Displays the administrative and operational states of one or all cartridges. If an instance name is specified, only that instance is displayed; if the instance name is omitted, all cartridges are displayed.

provadmin display cart [ nodename=<value> ]
[ instance=<value> ]
[ detailed=<value> ]
[ timeout=<value> ]
[ addMaintenance=<value> ]

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

Option	Description
nodename	Application node name.
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.
detailed	A boolean value that indicates whether or not an instance status should be displayed in detail. If true, the operational status of sessions is also displayed. The default is false.
timeout	The duration to wait for command completion, in seconds. The default is 600 seconds.
addMaintenance	A boolean value that indicates whether or not the maintenance state of an instance is displayed. The default is false.

The following is typical output from this command:

>provadmin display cart nodename=. instance=DisabledLocked detailed=true
Displaying cartridge <DisabledLocked>.
Cartridge Instance:
m_instanceName = DisabledLocked
m_operationalState = OS_Disabled
m_administrativeState = AS_Locked
Session[0]: OS_Disabled
Session[1]: OS_Disabled

loadNEConfig cart

 

Loads or reloads the Network Element configuration file that may be used in conjunction with cartdyn/cartridges for Work or Product Order Network element data enrichment. The Network Element configuration file is conf/cartNEConfig.cmt.

provadmin loadNEConfig cart [ nodename=<value> ]
[ force=<value> ]

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

Option	Description
nodename	Application node name.
force	Boolean value specifying whether to force the reload of the network element configuration file. The defaul is set to False, meaning that if the configuration file has already been loaded, is not loaded again. Set this parameter to True to force a reload. The reload is transactional, and the online data is not changed partially, if there is an error in the file.

The following is typical output from this command:

>provadmin loadNEConfig cart nodename=.
Successfully loaded Cartridge NE Configuration <conf/cartNEConfig.cmt>.

displayNEConfig cart

 

Displays specific or full information that has been read from conf/cartNEConfig.cmt.

provadmin displayNEConfig cart [ nodename=<value> ]
[ name=<value> ]

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

Option	Description
nodename	Application node name.
name	Name of the element or subelement for which to display information. If not specified, displays the full content of the network element configuration.

The following is typical output from this command:

>provadmin displayNEConfig cart nodename=.
ELEMENT:first
In dataset:
Found pm:<data1>, with value list : <a> <b>
Found pm:<data2>, with value list : <c> <d>

SUBELEMENT:first.sub
In dataset:
Found pm:<data1>, with value list : <a> <b>
Found pm:<data2>, with value list : <e> <f>
ELEMENT:second
In dataset:
Found pm:<data>, with value list : <blah>

Or, to display a specific sub element:

>provadmin displayNEConfig cart nodename=. name=first.sub
ELEMENT:first.sub
In dataset:
Found pm:<data1>, with value list : <a> <b>
Found pm:<data2>, with value list : <e> <f>

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.

stopMaintenance cart

 

Stops the maintenance state on the cartridge. Fulfillment Provisioning can now send orders to the cartridge. The Message Store and Forward (MSF) probes the cartridge and re-inject work orders on receiving the probe results.

stopMaintenance cart [ nodename=<value> ]
[ instance=<value> ]
[ allowerror=<value> ]
[ timeout=<value> ]

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.

Password Commands

 

Converts clear text password into non-clear text passwords.

provadmin hash password [ nodename=<value> ]

The following table describes the arguments of the hash password command.

Option	Description
nodename	Application node name.

This command prompts the user for a password and converts the password into an non-clear text format.

The password text entered by the user is not displayed at the command prompt. The behavior is similar to the way UNIX handles a password.

The following is a typical output from this command:

>provadmin hash password nodename=banks
[ The password to convert, hidden ]
230:208:42:41:23:48:120:27:188:81:78:83:123:198:210:4:
>

The resulting output string may now be copied into the cartridge configuration file or a command eval script.

Copyright © Cloud Software Group, Inc. All Rights Reserved