Hub Command-line Introduction - ironstream_for_elastic - ironstream_for_splunk - ironstream_for_kafka - Ironstream_Hub - 1.3

Ironstream Hub Administration

Product type
Software
Portfolio
Integrate
Product family
Ironstream
Product
Ironstream > Ironstream for Splunk®
Ironstream > Ironstream for Elastic®
Ironstream > Ironstream Hub
Ironstream > Ironstream for Kafka®
Version
1.3
Language
English
ContentType
Administration
Product name
Ironstream Hub
Title
Ironstream Hub Administration
First publish date
2022
ft:lastEdition
2024-04-15
ft:lastPublication
2024-04-15T10:44:03.897025

Ironstream Hub comes with a command-line tool that can be used to perform local actions and receive information. It is called ihubcmd and can only be run on the same machine where the Hub is installed.

The Hub should be managed and controlled using a browser to the Hub Portal wherever possible – the functionality here is evolving with each release of the Hub.

The Hub Command-line application uses a REST server, and the port used to access it should not be exposed to external sources. This port is set in the ihubmain.json configuration file.

The only output of ihubcmd will be the terminal, no log is created. The only outputs will be responses from commands and any warning or error log level messages that occurred during the execution of the commands. The format of executing commands with the executable is:

ihubcmd -option

You can use ihubcmd -help to get information about the arguments that can be passed into the executable.

An instance of Hub needs to be running for ihubcmd to function, with these exceptions:

ihubcmd -version

ihubcmd -help

Apart from the two options above, the only operational function of ihubcmd not currently available through the Hub Portal is the ability to clone pipelines. All other functionality is achievable interactively and you are encouraged to use the Portal. Please note that as features evolve it is intended that ihubcmd will be withdrawn from user use over time.