ncp_class command line options

Use the ncp_class command to start the Active Object Class manager.

It is best practice to configure the ncp_ctrl process, the master process controller, to launch and manage the ncp_class process.

Restriction: If you are using Network Manager with failover, you must start ncp_class using the ncp_ctrl process. The ncp_ctrl process checks the status of the ncp_class process and uses this information to generate the Health Check events used by the failover process.

Prequisites

For ncp_class to run, it requires access to the NCIM database. The connection and access to the database is performed automatically, you do not need to do anything.

The AOC files define the class hierarchy. There is a copy of this hierarchy in the entityClass NCIM database table. If changes are made to the AOC files, ncp_class updates the entityClass database table when it connects to the NCIM database to reflect any changes to the AOC hierarchy.

Note: If you create a new AOC file, you should also add a new insert to the class.classIds database table in the ClassSchema.cfg configuration file.

Example commands

The following command starts the ncp_class process manually in the NCOMS domain:

itnm_class -domain NCOMS

All command line options

The following table describes the command line options of the ncp_class command.

Table 1. ncp_class command line options

Option

Explanation

-cachepercent PERCENTAGE_OF_CACHE_IN_MEMORY

Enables you to specify a ratio of either 0% or 100% of the cache that is resident in memory to the cache that is resident on the hard disk.

The ratio that you specify depends on the amount of memory that exists on the host machine and the number of processes it is running. The default value is 0% cache.

The -cachepercent option can be used to reduce the memory required when the process responds to OQL queries that result in large numbers of records being returned. Do not use this command-line option for permanent data storage, because the cache is cleared when the process exits.

-domain DOMAIN_NAME

The name of the domain under which to run ncp_class.

-debug DEBUG

The level of debugging output (1-4, where 4 represents the most detailed output).

-messagelevel MESSAGELEVEL

The level of messages to be logged (the default is warn):

  • debug
  • info
  • warn
  • error
  • fatal

-messagelog PATH_TO_LOGFILE

The path to the message log file.

-help

Displays the command line options. Does not start the component even if used in conjunction with other arguments.

-latency LATENCY

The maximum time in milliseconds (ms) that ncp_class waits to connect to another Network Manager process by means of the messaging bus. This option is useful for large and busy networks where the default settings can cause processes to assume that there is a problem when in fact the communication delay is a result of network traffic.

-read_aocs_from DIRECTORY_NAME

The full path of the directory from which to read the AOC definitions.

When ncp_class is launched it obtains the AOC definitions either from this directory or from the cache files contained in NCHOME/var/precision.

  • If you omit the -read_aocs_from argument from the command line, ncp_class automatically reads the cache files from NCHOME/var/precision if they are present. If there are no valid cache files, ncp_class uses the definitions in NCHOME/precision/aoc.
  • If you specify a directory using the -read_aocs_from option, ncp_class initializes itself with the AOCs located in the specified directory. The ncp_class process automatically moves any existing cache files to a backup directory.

Regardless of the options specified, ncp_class generates a warning if the files within the NCHOME/precision/aoc directory are more recent than the cache files contained within the NCHOME/var/precision directory.

-version

Displays the version number of the component. Does not start the component even if used in conjunction with other arguments.