Server handling

The administrative command-line interface

The nevismeta command-line interface integrates the op and sudo command-line tools. It consists of several commands.

Instances

Instances can be managed by adding an instance name as parameter to the nevismeta command, for example:

# nevismeta instance1 start

If no instance is explicitly specified, the nevismeta command manages the default instance.

Setting up servers

The instance commands are used to install new server instances. There is a "default" instance for easy installation. Other or additional instances need to be configured by providing setup parameters.

nevismeta inst

This command lists the names of all configured server instances.

nevismeta inst create <instancename>

A new server instance is set up by entering the following command:

# nevismeta inst create default

The newly created instance will be deployed on port 8996.

Setup parameters may be provided on the command-line or by passing a setup property file:

# nevismeta inst create default /tmp/setup.properties

nevismeta inst remove <instancename>

This command removes all files related to the specified instance.

nevismeta inst exists <instancename>

This command is used by configuration scripts to query for already installed server instances.

Controlling the server

nevismeta start

Before starting the nevisMeta server, the command nevismeta start checks whether the server is not already running. If the server is already running, the command only provides status information.

The startup procedure may look as follows:

nevismeta start
nevismeta: Starting nevismeta.
Starting standalone instance 'nevismeta' ..
--------------------------------------------------------------------------------
Status : UP
Instance : nevismeta
Process ID : 51788
Ownership : nvauser / nvbgroup
Filedescriptors : 1024
--------------------------------------------------------------------------------

nevismeta stop

To shut down a running server, the command nevismeta stop terminates all running processes. The display may therefore look as follows:

nevismeta stop
nevismeta: Stopping nevismeta.
Stopping standalone instance 'nevismeta' ..
--------------------------------------------------------------------------------
Status : DOWN
Instance : nevismeta
Process ID : 0
Ownership : --- / ---
Network port(s) : ---
Filedescriptors : 1024
--------------------------------------------------------------------------------

nevismeta restart

This command performs a nevismeta stop followed by a nevismeta start. It may be used as a convenient way to restart nevisMeta after applying configuration changes.

Retrieving status information

nevismeta status

This command displays basic information on the server's current runtime state.

A server that is running displays the following output:

nevismeta status
--------------------------------------------------------------------------------
Status : UP
Instance : nevismeta
Process ID : 51788
Ownership : nvauser / nvbgroup
Network port(s) : iam.net:8996
Filedescriptors : 1024
--------------------------------------------------------------------------------

Configuration editing

The configuration files are located in the following directory:

/var/opt/nevismeta/`instancename`/conf/

To apply changes to the configuration, a restart of the nevisMeta server is required. See the chapter:nevismeta restart.

nevismeta config

The command nevismeta config opens the main configuration file nevismeta.properties for editing in a console editor.

Parameter name	Default	Description
fileimportsize	5242880	Maximum size of importable files in bytes. For example, "5242880" means 5 MB.
maxCacheDuration	600	Maximum cache duration for REST interface responses in seconds.For example, "600" means 10 min.
module.oauthv2.import.regenerate.clientsecret	false	Regenerates client secrets when importing OAuthV2 client entities. {true | false}
expiredDataCleaningInterval	3600	Interval after which expired data will be cleaned, in seconds. For example, "3600" means 60 minutes or one hour.
expiredDataCleaningTolerance	120	Minimum time needed to delete data after expiration, in seconds. For example, "120" means 2 minuses. In majority of cases this value should not be changed. If this value is set too high, it could lead to performance issues.
responseCacheExpiry		Specifies the expiry time in milliseconds for the GET entities endpoint response cache. If left unset, caching will not be used. If set, the value should be less than nevisAuth's nevismeta.maxAge. Setting it too high can cause usage of outdated data in nevisAuth.
server.auth.ninja.truststore		Specifies the truststore file to use for Ninja to parse the SecToken.
server.auth.ninja.user-getter		Defines how Ninja gets the user ID from the SecToken.
server.auth.ninja.role-getters		Defines how Ninja gets user role from the SecToken.
server.auth.ninja.sec-role-mapping		Maps SecToken roles to groups or to role principals. Syntax: group | role Recommended setting: "group". See also chapter Configuration of the Web Application in the Ninja reference guide.

In the majority of cases

For more details, see chapter User ID and Roles in the Ninja reference guide.

nevismeta config env

The command nevismeta config env opens the configuration file env.conf for editing in a console editor. Some plugged components may require additional environment information. This is configured by adding entries to the config file as follows:

VARIABLENAME=VALUE
export VARIABLENAME

The following aspects are configured here:

• JAVA_OPTS

Package handling

As a rule, the delivered packages use unversioned links to the latest installed software version to reference required binaries without having to specify an exact version. The following command displays these links:

ls -l /opt/nevismeta

Use the nevismeta version command to display the installed version of nevisMeta.