IOPCMD - Parameter Reference

  • Updated on May 7, 2023
  • Published on Mar 20, 2023
  • 4 minute(s) read
Prev Next

Introduction

This article provides a comprehensive list of all IOPCMD commands, sub-commands, parameters, and example. You can use IOPCMD to perform various tasks, including installing and upgrading the IOP, starting and stopping IOP containers, removing IOP configuration data, or setting new configuration parameters.

For optimal readability, hide the category pages while reading this article.

Hide Categories

Reference

Command

Sub-command

Parameters

Description

More info

Examples

-h / --help / <None>

Helper page for IOPCMD:

  • Commands

  • Parameters

  • Descriptions for each command / parameter

Open the help menu:

iopcmd -h

-v

Shows the IOPCMD version

Check running IOPCMD version:

iopcmd -v

--debug

Executes the present command in "debug" mode

Install a standalone node in debug mode:

iopcmd --debug install -t standalone

--install / --upgrade

repo

  • -t / --type [ standalone, master, data]

  • -pwd / --password

  • -iopv / --iop_version [ stable]

  • -m / --master (Only for data node)

  • -f / --force (Only for upgrade)

Installs / upgrade the IOP.
This method pulls the IOP images from Dockerhub, requires Internet access.


During installation: Even if the customer has used a previous version of IOP, we treat their first use of IOP 8.X as a new installation

Set up a standalone node from a repository using a password and image version:

iopcmd install repo -t standalone -pwd changeme! -iopv 8.1.733.42

Update a data node from a repository by providing a password, image version, and a master to connect to, while disabling confirmation prompts:

iopcmd upgrade repo -t data -pwd changeme! -iopv 8.1.733.42 -m 1.1.1.1 -f

local

  • -t / --type [ standalone, master, data]

  • -pwd / --password

  • -p / --file_path [ local images file]

  • -m / --master (Only for data node)

  • -f / --force (Only for upgrade)

Installs or upgrades IOP using a local file containing the IOP images, or using the already available local images.

Deploy a standalone node using a local file, specifying a password and the location of the image file:

iopcmd install -t standalone -pwd changeme! -p /opt/iopcmd/iop_images.tgz

Upgrade a master node by providing a password, using the locally stored images, and suppressing any confirmation prompts:

iopcmd upgrade -t master -pwd changeme! -f

update

repo

  • -iopv / --iop_version [ stable]

  • -f / --force

Updates only the IOP images
This method pulls IOP images from Dockerhub, requires Internet access

This command does not stop and delete the containers.

Upgrade the images to a new version available in the repository:

iopcmd update repo -iopv 8.1.733.42

local

  • -p / --file_path [ local images]

  • -f / --force

Updates only the IOP images from local file.

Updating the images to a new version from local file, and suppressing any confirmation prompts:

iopcmd update -p /opt/iopcmd/iop_images.tgz -f

restart / start / stop

all

Starts / stops / restarts all IOP containers

Restart all IOP containers:

iopcmd restart all

Start only the “iop_master” container:

iopcmd start master

Stop only the “iop_ui” container:

iopcmd stop ui

  • master

  • search

  • data

  • ui

  • proxy

Starts / stops / restarts a specific container

clean

 

all



  • -f / --force
  • Uninstalls IOP
  • Deletes all IOP configurations
  • Deletes all indexed data from IOP

Remove the configuration and data of IOP, while disabling confirmation prompts:

iopcmd clean all -f

Remove only the IOP configurations:

iopcmd clean config


config

Uninstalls IOP

This command also deletes: 

  • All IOP configs made by the user

  • 'config' volume

data

Deletes all indexed data from IOP

show

  • -a / --all

  • -i / --images

  • -c / --containers

  • -cs / --cluster-status

  • -l / --license

OVA:

  • -n / --network

  • -d / --disk

Credentials:

  • -u / --user

  • -pwd / --password

Displays comprehensive details about IOP, such as the status of containers, network information, and disk sizes

Show all IOP information:

iopcmd show -a

Show only info about images and containers:

iopcmd show -ic

Show info about images, containers, disk and network [Used for OVA]:

iopcmd show -icdn

run

  • -d / --diag

OVA:

  • -exp / --expand-disk

Extends commands which run external commands

This command is mostly run heavier functions, which takes more time.

Generates a diagnostic file of the IOP:

iopcmd run -d

Expand the disk on an OVA machine:

iopcmd run -exp

set

  • -t / --toggle-button [enable, disable]

OVA:

  • -hn / --hostname

  • -ip / --static-ip

  • -gwy / --default-gateway

  • -dns / --dns-servers

  • -dhcp / --enable-dhcp

Runs functions which configures the IOP.
(i.e. enable toggle-button, sets a new IP address, changes host name)

This command is mostly run functions which changes current state of property, and make quick changes.

To change the CIDR notation/netmask, run the full command (-ip + -gwy and state the CIDR also). For example:
iopcmd set -ip 10.20.61.2 /22 -gwy 10.20.61.254

Enables the toggle button on IOP site:

iopcmd set -t enable

Sets a new IP and gateway for the OVA machine:

iopcmd set -ip 1.1.1.1 -gwy 1.1.1.254

Sets the server to use DHCP:

iopcmd set -dhcp

password

  • -u / --username

  • -pwd / --admin-password

  • -np / --new-password

This command changes the password for only the IOP account .

To change the root password, use the passwd command.

Change the existing password “changeme!” for the user “admin” to a new one:

iopcmd set password -u admin -pwd changeme! -np SplunkIOP!

Master
  • -m / --master_ip
  • -pwd / --password
 This command is only available on a data node. Note that the password used should be the data node password.

Set the master of an existing data node to 1.1.1.1:

iopcmd set master -m 1.1.1.1 -pwd changeme!

test

ldap

  • -s / --server

  • -dn / --user-dn

  • -pwd / --password

Tests LDAP connections for IOP

Verify the LDAP connection to server 1.1.1.1 using its credentials

iopcmd test ldap -s acmedc.acmecorp.acme.com -dn "CN=John Doe,OU=Users,OU=Accounts,DC=acmecorp,DC=acme,DC=com"
TCP Port
  • -s / --server
  • -p / --port
 Checks the connection of a TCP port to a remote machine

Check if a connection can be established to server 1.1.1.1 on port 8000:

iopcmd test tcp_port -s 1.1.1.1 -p 8000