.. _Introduction:

Introduction
============

This guide describes the syntax and parameters of the ``vinfra`` command-line tool that can be used to manage |product_name| from console and automate such management tasks.

.. note:: While the following chapters provide a reference of specific operations that you can perform with ``vinfra``, you can also run ``vinfra help`` to get a list of all supported commands and their descriptions. For help on a specific command, either run ``vinfra help <command>`` or ``vinfra <command> --help``.

In addition, this guide describes how to use the command line to perform operations unsupported by ``vinfra`` as of now.

Note that the following operations should not be done from the command line:

- setting custom paths for |product_name| services, in particular:

  - creating S3 clusters only in ``/mnt/vstorage/vols/s3``,
  - creating iSCSI targets only in ``/mnt/vstorage/vols/iscsi``,

- mounting clusters or change cluster mount options,
- configuring firewall with ``firewall-cmd``,
- renaming network connections,
- managing MDS/CS,
- managing partitions, LVMs, or software RAID,
- modifying files in ``/mnt/vstorage/vols`` and ``/mnt/vstorage/webcp/backup`` directories,
- setting encoding or replication of cluster root.

.. toctree::
   :name: EkxaSeind0XgQh5K
   :caption: In this chapter:
   :maxdepth: 3

   providing-credentials
   managing-tasks