Configuration
Command-line Arguments
nms-stormert-extract [-outages [-restored <days>]] [-storms] [-zones] [-customers] [-upload] [-cfg <config path>]
• -outages: extract outage information.
• -restored: number of days of recently restored outages to extract. If not specified, only active outages will be extracted.
• -storms: extract storm information.
• -zones: extract control zone information.
• -customers: extract customer information.
• -upload: upload all extract files to SFTP server or object storage. After successful upload extract files are removed from the extract folder.
• -cfg: full path to the configuration file. If not specified, will use the default value $NMS_HOME/etc/stormert_extract.cfg.
 
At least one of the -outages, -storms, -zones, -customers or -upload options need to be specified.
Configuration File
Data extract and upload process is controlled by a configuration file. The default path to the configuration file is $NMS_HOME/etc/stormert_extract.cfg and can be altered by the command-line argument -cfg.
General Parameters
Parameter
Description
nms.instance
NMS instance identifier. If data from multiple NMS instances is loaded into a single instance of Storm ERT application, then each NMS instance should have unique identifier.
extract.dir
Folder where to store generated files.
cz.hierarchy_type
NMS control zone hierarchy type.
NMS supports multiple control zone hierarchies.
This parameter defines which hierarchy to use when extracting data.
Default: 1
db.host
Entry from NMS database wallet used to connect to the source database.
If empty, then the value of the RDBMS_HOST environment variable is used.
compress.level
Data compression level (1 through 9).
If specified extract files will be compressed using gzip.
 
File Upload Parameters
Generated files can be uploaded to Oracle Cloud Infrastructure Object Storage or SFTP server. If both upload methods are configured files will be uploaded to object storage.
Parameter
Description
oci.bucket
Object storage bucket name.
oci.namespace
Object storage namespace.
sftp.server
SFTP server hostname or IP address.
sftp.port
SFTP server port
Default: 22
sftp.user
SFTP username.
sftp.identity
SSH identity or private key file.
sftp.path
Upload directory on the SFTP server.
 
File Encryption Parameters
Generated files can be encrypted using GPG or OpenSSL. If both encryption method are configured GPG will be used.
Parameter
Description
gpg.key
GPG encryption key id.
openssl.key
Full path to the OpenSSL encryption key.
openssl.cipher
OpenSSL cipher to use.
Default: aes256
 
Reporting Level Labels
Each row in the customer extract file contains five columns that a project can populate with reporting levels others than NMS control zones. These configuration parameters specify the labels that will appear in Storm ERT application for these reporting levels.
Parameter
Description
rpt_level_1
Label for reporting level 1.
rpt_level_2
Label for reporting level 2.
rpt_level_3
Label for reporting level 3.
rpt_level_4
Label for reporting level 4.
rpt_level_5
Label for reporting level 5.
 
Coordinate System Information
Coordinate system information used to perform conversion from the coordinate system used by NMS into latitude/longitude coordinates. Coordinate systems are configured using Oracle Spatial SRID values.
Parameter
Description
nms.srid
SRID for the NMS coordinate system.
If not specified, then value of the MBS_GEO_SRID parameter from the CES_PARAMETERS database table is used.
ll.srid
SRID for the coordinate system used in the extracted data.
If not specified, then value of the MBS_LL_SRID parameter from the CES_PARAMETERS database table is used.