Digipass S3 is now DigipassONE. This section is currently being updated to reflect our new name.

Properties Commands

Prev Next

Use these commands to export, import, list, or edit Authentication Server properties for a specific tenant. See Authentication Server Properties for the list of properties and their possible values.

Export

Syntax

./nnl-mgmt.sh properties export [-dir <properties-dir> | -file <file-path>] [‑tenantid <tenantid>]

Parameter

Description

dir

Optional. The Auth Server writes the properties file to this directory. Defaults to your current directory.

file

Optional. A file path. The system exports the tenant's properties to the file path. The file cannot exist.

tenantid

Optional. Properties are exported from this tenant ID. Default value is default.

Description

Export properties for the given tenant.

You either specify a directory or a file path where the system exports the tenant's properties but not both. The file path already includes the directory. If you only specify dir, then the system generates the file name.

Example

./nnl-mgmt.sh properties export -dir /home/zsmith -tenantid default

Import or Update

Syntax

./nnl-mgmt.sh properties import -file <property-file> [-overwrite <yes|no> -tenantid <tenantid>]

Parameter

Description

file

Mandatory. Name of the property file to import. If you don’t provide a file name, the command fails.

overwrite

Optional. Value can be one of the following:

  • Yes: If a property from the file already exists, it is overwritten.

  • No: If a property from the file already exists, it is not overwritten.

tenantid

Optional. Properties are imported/updated for this tenant ID. Default value is default.

Description

Import properties for the given tenant from the specified file. If you don’t provide a tenantid, the file is imported for the default tenant.

By default, the file size of any property file you can import or update must be less than 256 KB. Change the maximum file size for a property file by setting the nnl.auth.server.config.file.size.kb property for the Admin tenant.

Examples

./nnl-mgmt.sh properties import -file nnl-default.properties -tenantid default

Increase the maximum file size limit to 512 KB.

./nnl-mgmt.sh properties set -name nnl.auth.server.config.file.size.kb -value 512 ‑tenantid Admin

Set Property

Syntax

./nnl-mgmt.sh properties set -name <property-name> -value <value> [-tenantid <tenantid>]

Parameter

Description

name

Mandatory. Name of the property that has to be configured. If you don’t provide a property name, the command fails.

value

The value you are assigning to the property. Place quotes around the value if it contains spaces.

tenantid

Optional. Property specific to this tenant ID is configured. Default value is default.

Description

Updates the property with the provided value.

Example

./nnl-mgmt.sh properties set -name nnl.policy.update.poll.interval.seconds -value 120 -tenantid system

Unset

Syntax

./nnl-mgmt.sh properties unset -name <property-name> [-tenantid <tenantid>]

Parameter

Description

name

Mandatory. Undo the configured parameter for this property. If you don’t provide a property name, the command fails.

tenantid

Optional. Property specific to this tenant ID is removed. Default value is default.

Description

Unsets or clears the configured parameter of a property within the nnl-default.properties file or nnl-system.properties file for the given tenant.

Example

./nnl-mgmt.sh properties unset -name nnl.policy.update.poll.interval.seconds -tenantid default

List

Syntax

./nnl-mgmt.sh properties list [-tenantid <tenantid>] [-output <raw | formatted>]

Parameter

Description

tenantid

Optional. Properties specific to this tenant ID are listed. Default value is default.

output

Optional. Values are

  • formatted (default): Formats the properties and their values as a table.

  • raw: Outputs the properties and their values as <property>=<value>.

Description

Lists the properties and their values for the given tenant.

Example

./nnl-mgmt.sh properties list -tenantid default

Delete

Syntax

./nnl-mgmt.sh properties delete -name <property-name> [-tenantid <tenantid>]

Parameter

Description

name

Mandatory. Undo the configured parameter for this property. If you don’t provide a property name, the command fails.

tenantid

Optional. Properties specific to this tenant ID are listed. Default value is default.

Description

Deletes properties for the given tenant.

Example

./nnl-mgmt.sh properties delete -name test -tenantid default