omshell

omshell [-c command] [-d debug_level] [-f config_file] [-h]

-c command
    Executes a specified OMS command and then exits.

-d debug_level
    Sets the debug level (0-9) for verbose output. Higher values provide more detailed debugging information.

-f config_file
    Specifies an alternate configuration file to use. Defaults to omshell.conf.

-h
    Displays help information and exits.

omshell is a command-line shell for interacting with the Open Management System (OMS) API. It provides an interactive environment for managing and querying OMS servers, allowing users to perform tasks such as creating, modifying, and deleting objects, as well as retrieving information about the system's configuration and status.

It's used to send commands to the OMS server and interpret their results, providing a textual interface to OMS functionality. Users can execute individual commands or run scripts containing a sequence of OMS operations.

omshell is a powerful tool for administrators and developers working with OMS-based systems, enabling automation and scripting of common management tasks. It relies on a configuration file (usually omshell.conf or located in the same folder as the omshell) to determine where the server is located. Error management is minimal, so the user needs to be careful when writing commands and interpret the server response.

Error handling is minimal, so the user needs to ensure command correctness. Requires a properly configured omshell.conf to connect to the OMS server.

The omshell.conf file contains connection parameters, such as the OMS server's address, port, and key information.

This is used to authenticate with the server and gain access to resources.

If the configuration file is missing in the standard location, the program will search for it in the same folder of the executable.

server server_name

port port_number

key key_name secret

connect

new object_type

set attribute = value

create

print

update

delete

omshell is related to the Bind9 software package and was created by Internet Systems Consortium (ISC). It is a shell-like tool specifically designed to interact with the OMS API, enabling dynamic updates and management of DNS zones and DHCP configurations.

The primary use for omshell is to interact with the DHCP server using the OMAPI protocol.

omapi(3)