Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated using 4PSA automated script

Excerpt
This document describes how to work with Command Line Interface.
Table of Contents
maxLevel2

Overview

The DNS Manager CLI has two main usage scenarios:

  • Experienced administrators can use the CLI to perform daily management tasks.
    The CLI can serve as an alternative to the web-based interface because it offers quicker access to most of the objects in the DNS Manager system. The utilities that can be accessed through the CLI use the DNS Manager core functionality to create, manage, and delete objects such as: clients, zones, records, etc.
  • Developers of third-party applications can use the CLI to integrate their software with DNS Manager.
    Command Line Interface utilities can be used even if the dnsmanager process (i.e. the web-based interface) has been stopped. Command line utilities can be used from the console, but also in shell scripts. Third-party software can use these shell scripts in order to interact with the DNS Manager system.
Note

The CLI utilities require rootprivileges to work.

Using Command Line Utilities

In order to access the CLI scripts, you should first log in as root on your DNS Manager system using a SSH client (PuTTY). Command line utilities scripts are located at /usr/local/dnsmanager/bin/.

Here are the scripts:

Script name

Purpose

client.sh

Manage the client accounts and their data.

client_prefs.sh

Manage client preferences.

zone.sh

Manage DNS zones.

zone_prefs.sh

Manage DNS records.

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 4.0 International.