Использование

Синтаксис

Для правильного функционирования команд необходимо соблюдать правильный синтаксис при их форматировании, при этом структура команды может включать в себя префикс, контекст, аргументы, параметры и т. д. Ниже приведен общий синтаксис, используемый в интерфейсе eShell.

[<префикс>] [<путь команды>] <команда> [<аргументы>]

Пример (команда активирует защиту документов):

SET AV DOCUMENT STATUS ENABLED

SET — префикс.

AV DOCUMENT — путь к конкретной команде, контекст, к которому данная команда относится.

STATUS — непосредственно команда.

ENABLED — аргумент для команды.

Если использовать HELP или ? вместе с командой, на экран будет выведен синтаксис непосредственно для этой команды. Например, CLEANLEVEL HELP отобразит синтаксис для команды CLEANLEVEL .

СИНТАКСИС:

 [get] | restore cleanlevel

 set cleanlevel none | normal | strict

Видно, что конструкция [get] заключена в скобки. Это указывает на то, что префикс get используется по умолчанию для команды cleanlevel . Это означает, что при выполнении команды cleanlevel без указания какого-либо префикса будет использоваться префикс по умолчанию (в данном случае get cleanlevel). Использование команд без префиксов позволяет сэкономить время на ввод данных. Обычно get является префиксом по умолчанию для большинства команд, но нужно точно знать префикс по умолчанию для конкретной команды и иметь уверенность в том, что он соответствует задаче, которую необходимо выполнить.

ПРИМЕЧАНИЕ.: В командах не учитывается регистр, можно использовать как прописные (заглавные), так и строчные буквы, и это не повлияет на выполнение команд.

Префикс/операция

Префикс — это операция. Префикс GET предоставляет сведения о том, как сконфигурирована определенная функция ESET Mail Security, или указывает на состояние (например, GET AV STATUS покажет текущее состояние защиты). Префикс SET конфигурирует функциональность или меняет состояние (SET AV STATUS ENABLED активирует защиту).

Ниже приведены префиксы, которые можно использовать в интерфейсе eShell. Команда может поддерживать или не поддерживать какие-либо из следующих префиксов.

GET — возвращает текущую настройку или состояние.

SET — задает значение или состояние.

SELECT — выбирает элемент.

ADD — добавляет элемент.

REMOVE — удаляет элемент.

CLEAR — удаляет все элементы или файлы.

START — запускает действие.

STOP — прекращает действие.

PAUSE — приостанавливает действие.

RESUME — возобновляет действие.

RESTORE — восстанавливает параметры, объект или файл по умолчанию.

SEND — отправляет объект или файл.

IMPORT — выполняет импорт из файла.

EXPORT — выполняет экспорт в файл.

Такие префиксы, как GET и SET, используются со многими командами, но в некоторых командах (например, EXIT) префикс не используется.

Путь команды/контекст

Команды размещаются в контекстах, которые образуют древовидную структуру. Верхний уровень древовидной структуры является корневым. При запуске eShell открывается именно корневой уровень.

eShell>

Можно либо выполнять команды непосредственно здесь или вводить имя контекста, чтобы перемещаться по древовидной структуре. Например, при вводе контекста TOOLS на экран будут выведены все команды и подчиненные контексты, доступные в данном контексте.

ESHELL_CONTEXT

Желтым цветом обозначены команды, которые можно выполнять, а серым — подчиненные контексты, в которые можно войти. В подчиненном контексте содержатся дальнейшие команды.

Если нужно вернуться на более высокий уровень, следует использовать .. (две точки). Например, предположим, что мы находимся здесь.

eShell av options>

Введите .. для перехода на один уровень вверх к

eShell av>

Если же необходимо вернуться на корневой уровень с уровня eShell av options> (который отделен от корневого уровня двумя уровнями), просто введите .. .. (две точки, пробел, еще две точки). Это позволит перейти на два уровня вверх, то есть в данном случае — к корневому контексту. Эту возможность можно использовать независимо от того, насколько глубоко в древовидной структуре контекстов вы находитесь. Используйте нужное количество сочетаний символов .. для перехода на необходимый уровень.

Путь указывается относительно текущего контекста. Если команда содержится в текущем контексте, путь вводить не нужно. Например, для выполнения команды GET AV STATUS введите

GET AV STATUS (если вы находитесь в корневом контексте) — командная строка показывает eShell>)

GET STATUS (если вы находитесь в контексте AV) — командная строка показывает eShell av>)

.. GET STATUS (если вы находитесь в контексте AV OPTIONS) — командная строка показывает eShell av options>)

Аргумент

Аргумент — это действие, которое выполняется для конкретной команды. Например, команда CLEANLEVEL может использоваться с такими аргументами.

none — без очистки.

normal — стандартная очистка.

strict — тщательная очистка.

Другой пример: аргументы ENABLED или DISABLED, которые используются для включения и отключения определенной функции или функциональности.

Сокращенная форма или краткие команды

В eShell можно сокращать контексты, команды и аргументы (при условии, что аргумент является параметром или альтернативным вариантом). Невозможно сократить префикс или аргумент, который является конкретным значением, таким как число, имя или путь.

Примеры краткой формы:

set status enabled => set stat en

 add av exclusions C:\path\file.ext => add av exc C:\path\file.ext

Если две команды или два контекста начинаются с одних и тех же букв (например, ABOUT и AV и вводится буква A в качестве сокращенной команды), eShell не сможет решить, какую из этих двух команд необходимо выполнить. Поэтому на экран будет выведено сообщение об ошибке и список команд, начинающихся на букву A, из которого можно выбрать необходимое.

eShell>a

Не является уникальной команда: a

 

В этом контексте доступны следующие команды.

ABOUT: показывает информацию о программе.

AV: изменяет контекст на av.

При добавлении еще одной или нескольких букв (например, AB вместо одной буквы A) eShell выполнит команду ABOUT , поскольку теперь эта команда является уникальной.

ПРИМЕЧАНИЕ.: Чтобы команда выполнялась надлежащим образом, рекомендуется не сокращать команды, аргументы и т. д. и использовать их полную форму. В этом случае все будет выполнено именно так, как нужно, и удастся избежать нежелательных ошибок. Это особенно актуально для пакетных файлов и сценариев.

Псевдонимы

Псевдоним — это альтернативное название, которое может использоваться для выполнения команды (при условии, что этой команде присвоен псевдоним). Существует несколько псевдонимов по умолчанию, которые перечислены ниже.

(global) help - ?

(global) close — соответствует команде EXIT

(global) quit — соответствует команде EXIT

(global) bye — соответствует команде EXIT

warnlog — соответствует команде TOOLS LOG EVENTS

virlog — соответствует команде TOOLS LOG DETECTIONS

Индикатор (global) указывает на то, что такую команду можно использовать в любом месте, независимо от текущего контекста. Одной команде может быть назначено несколько псевдонимов. Например, у команды EXIT есть псевдонимы CLOSE, QUIT и BYE. Для выхода из eShell можно использовать непосредственно команду EXIT или любой из ее псевдонимов. Псевдоним VIRLOG является псевдонимом команды DETECTIONS в контексте TOOLS LOG . Таким образом команда DETECTIONS доступна из корневого контекста ROOT , что делает ее более доступной (не нужно вводить контекст TOOLS и затем LOG и выполнять ее непосредственно в корневом контексте ROOT).

В eShell пользователи могут задавать собственные псевдонимы.

Защищенные команды

Некоторые команды являются защищенными и могут быть выполнены только после ввода пароля.

Guide

При выполнении команды GUIDE на экран выводится окно первого запуска, в котором объясняется использование eShell. Эта команда доступна в контексте ROOT (eShell>).

Help

Когда команда HELP используется самостоятельно, на экран выводится список всех доступных команд с префиксами, а также всех подчиненных контекстов, существующих в текущем контексте. Кроме того, предоставляется краткое описание каждой команды или подчиненного контекста. При использовании команды HELP в качестве аргумента с какой-либо командой (например, CLEANLEVEL HELP) на экране отображаются сведения об этой команде. На экран выводятся СИНТАКСИС, ОПЕРАЦИИ, АРГУМЕНТЫ И ПСЕВДОНИМЫ для этой команды с кратким описанием каждого элемента.

Журнал команд

eShell хранит записи о выполненных ранее командах. Это распространяется только на текущий интерактивный сеанс eShell. После завершения сеанса работы eShell журнал команд удаляется. С помощью стрелок вверх и вниз на клавиатуре можно перемещаться по журналу. Обнаружив нужную команду, можно выполнить ее повторно или внести в нее изменения, причем не нужно вводить заново всю команду целиком.

CLS или очистка экрана

Команду CLS можно использовать для очистки экрана. Она работает точно так же, как в командной строке Windows и других аналогичных интерфейсах командной строки.

EXIT/CLOSE/QUIT/BYE

Чтобы закрыть eShell или выйти из этого интерфейса, можно воспользоваться любой из этих команд (EXIT, CLOSE, QUIT или BYE).

[an error occurred while processing this directive]