Перейти к основному содержимому

Руководство по базовой конфигурации

1 Настройка управления системой

1.1 Обзор​

Введение в функцию​

Функция баннера используется для настройки сообщений на устройствах. Пользователь может указать любые сообщения для уведомления других пользователей. Неправильные действия могут привести к критическим ситуациям, таким как прерывание работы сервиса, поэтому в таких случаях необходимо предварительное уведомление. (Например, для уведомления пользователей "Не перезагружайте" ("Don't reboot"))

На данный момент поддерживаются три типа сообщений:

  • MOTD (message-of-the-day). Сообщения будут отображаться на терминале, когда пользователь подключится к устройству.
  • Баннер входа. Сообщения будут отображаться на терминале, при подключении пользователя к устройству. Для отображения этого сообщения требуется «Режим входа» ("Login mode"). См. раздел «Настройка управления пользователями» ("Configuring User Management").
  • Exec banner. Сообщения будут отображаться на терминале, при входе пользователя в режим в режим EXEC.

Описание принципа​

Эта функция отображает уведомления на терминале для предотвращения ошибочных действий.

1.2 Конфигурация​

Настройка баннера входа MOTD (MOTD Login Banner)​

шаг 1. Войдите в режим конфигурации​

    Switch# configure terminal

шаг 2 Создайте уведомление​

Пользователь может создать уведомление (однострочное или многострочное) для отображения на всех подключенных терминалах. В следующем примере символ # используется как разделитель. Все символы между двумя разделителями будут отображаться на терминалах при подключении пользователя к устройству.

Сообщение может содержать до 99 строк, по 1023 символа в каждой.

    Switch(config)# banner motd # This is a switch #

шаг 3 Выйдите из режима конфигурации​

    Switch(config)# exit

шаг 4. Проверка​

Используйте следующую команду для отображения конфигурации:

    switch# show running
        banner motd ^C
        ` `This is a switch
        ^C

Настройка баннера входа (Login Banner)​

шаг 1. Войдите в режим конфигурации​

    Switch# configure terminal

шаг 2 Создайте уведомление​

Пользователь может создать уведомление (однострочное или многострочное) для отображения на всех подключенных терминалах. Для отображения этого сообщения требуется "режим входа" ("Login mode"). См. раздел "Настройка управления пользователями".

В следующем примере символ # используется как разделитель. Все символы между двумя разделителями будут отображаться на терминалах при подключении пользователя к устройству.

Сообщение может содержать до 99 строк по 1023 символа в каждой строке.

    Switch(config)# banner login # admin login #

шаг 3 Выйдите из режима конфигурации​

    Switch(config)# exit

шаг 4. Проверка​

Используйте следующую команду для отображения конфигурации

    switch# show running
        banner login ^C
        ` `admin login 
        ^C

Настройка баннера Exec (Exec Banner)​

шаг 1. Войдите в режим конфигурации​

    Switch# configure terminal

шаг 2 Создайте уведомление​

Пользователь может создать уведомление (однострочное или многострочное) для отображения на всех подключенных терминалах. В следующем примере символ # используется как разделитель. Все символы между двумя разделителями будут отображаться на терминалах, когда пользователь входит в режим EXEC.

Сообщение может содержать до 99 строк по 1023 символа в каждой строке.

    Switch(config)# banner exec # do not reboot! #

шаг 3 Выйдите из режима конфигурации​

    Switch(config)# exit

шаг 4. Проверка​

Используйте следующую команду для отображения конфигурации:

    switch# show running
    banner exec ^C
    ` `do not reboot! 
    ^C

1.3 Примеры применения​

Пример 1: Отметьте назначение устройства​

Установите сообщение MOTD как «Это коммутатор определённой зоны/отдела» ("This is a switch of some area/department"), и пользователь увидит это сообщение при подключении к устройству. Если пользователю требуется работать с коммутатором другого отдела, он сможет понять, что подключился к неправильному устройству, и избежать ошибки в работе.

Шаги настройки​

    Switch# configure terminal
    Switch(config)# banner motd # This is a switch of IT DEPARTMENT ！！！ #
    Switch(config)# exit

Файлы конфигурации​

    switch# show running
    banner motd ^C
    ` `This is a switch of IT DEPARTMENT ！！！
    ^C

2 Настройка управления пользователями

2.1 Обзор​

Введение в функцию​

Управление пользователями повышает безопасность системы, предотвращая попытки неавторизованных пользователей угадать пароль. Пользователю предоставляется ограниченное количество попыток для успешного входа на коммутатор.

В коммутаторе доступны три режима загрузки:

  • Режим "без входа" (“no login”): любой может загрузить коммутатор без аутентификации.
  • Режим "вход" (“login”): доступен только один пользователь по умолчанию.
  • Режим "локальный вход" (“login local”): для загрузки коммутатора требуется учетная запись пользователя. Локальная аутентификация пользователя использует локальные учетные записи и пароли, созданные для проверки попыток входа локальных пользователей. Каждый коммутатор поддерживает максимум 32 локальных учетных записи. Перед включением локальной аутентификации необходимо создать хотя бы одну учетную запись. Учетные записи настраиваются путем создания уникальной комбинации имени пользователя и пароля для каждого пользователя. Имя пользователя должно содержать менее 32 символов. Для каждой учетной записи можно задать уровень привилегий: допустимые уровни — 1 или 4. После входа пользователя в систему отображаются только те команды, которые соответствуют его уровню привилегий.

Только один пользователь может войти в режим конфигурации одновременно.

2.2 Конфигурация​

Настройка управления пользователями в режиме локального входа​

шаг 1. Войдите в режим конфигурации​

    Switch# configure terminal

шаг 2 Установите имя пользователя и пароль​

    Switch(config)# username testname privilege 4 password 123abc<>

шаг 3 Войдите в режим конфигурации и установите режим управления пользователями​

    Switch(config)# line vty 0 7
    Switch(config-line)# login local
    Switch(config-line)# exit

шаг 4 Выйдите из режима конфигурации​

    Switch(config)# exit

шаг 5. Проверка​

После вышеуказанной настройки для входа на коммутатор потребуется имя пользователя и пароль. Пользователь может войти в систему, используя ранее созданные имя пользователя и пароль. Ниже приведён пример вывода запроса на вход.

    Username:

После ввода имени пользователя потребуется пароль.

    Username: testname
    Password:

Аутентификация прошла успешно:

    Password: 
    Switch#

Настройка управления пользователями в режиме входа​

шаг 1. Войдите в режим конфигурации​

    Switch# configure terminal

шаг 2 Войдите в режим конфигурации и установите пароль​

    Switch(config)# line vty 0 7
    Switch(config-line)# line-password abc
    Switch(config-line)# login

шаг 3 Выйдите из режима конфигурации​

    Switch(config)# exit

шаг 4. Проверка​

После вышеуказанной настройки для входа на коммутатор потребуется линейный пароль. Пользователь может войти в систему, используя ранее созданный пароль. Ниже приведён пример вывода запроса на вход.

    Password:

Настройка процедуры восстановления пароля​

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

шаг 1 Включите систему. Загрузчик начнет запускаться. Следующая информация будет выведена на консоль​

    CPU:   MPC8247 (HiP7 Rev 14, Mask 1.0 1K50M) at 350 MHz
    Board: 8247 (PCI Agent Mode)
    I2C:   ready
    DRAM:  256 MB
    In:    serial
    Out:   serial
    Err:   serial
    Net:   FCC1 ETHERNET, FCC2 ETHERNET [PRIME]
    Press ctrl+b to stop autoboot: 3

шаг 2 Нажмите ctrl+b. Остановите автозагрузку​

    Bootrom#

шаг 3 В интерфейсе загрузчика используйте следующие инструкции​

    Bootrom# boot\_flash\_nopass
    Bootrom# Do you want to  revert  to the default config file ? [Y|N|E]:
осторожно

Важно: Пожалуйста, запомните свое имя пользователя и пароль. Восстановление пароля может привести к потере конфигурации или прерыванию работы сервиса; настоятельно рекомендуем пользователю запомнить имя пользователя и пароль.

3 Настройка FTP

3.1 Обзор​

Введение в функцию​

Вы можете загрузить файл конфигурации коммутатора с FTP-сервера или загрузить его с коммутатора на FTP-сервер. Загрузка файла конфигурации с сервера используется для обновления конфигурации коммутатора. Текущий файл начальной конфигурации можно перезаписать новым. Выгрузка файла конфигурации на сервер осуществляется для создания резервной копии. Этот загруженный файл конфигурации можно использовать для будущих загрузок на коммутатор или на другой коммутатор того же типа.

3.2 Конфигурация​

Вы можете копировать файлы конфигурации на FTP-сервер или с него. Протокол FTP требует, чтобы клиент отправлял удаленное имя пользователя и пароль при каждом FTP-запросе к серверу.

Перед загрузкой или выгрузкой файла конфигурации с использованием FTP выполните следующие задачи:

  • Убедитесь, что у коммутатора есть маршрут к FTP-серверу. Коммутатор и FTP-сервер должны находиться в одной сети, если у вас нет маршрутизатора для маршрутизации трафика между подсетями. Проверьте подключение к FTP-серверу с помощью команды ping.
  • Если вы подключаетесь к коммутатору через консоль или Telnet-сеанс и у вас нет действительного имени пользователя, убедитесь, что текущее имя пользователя FTP — это то, которое вы хотите использовать для загрузки через FTP.
  • При загрузке файла конфигурации на FTP-сервер он должен быть правильно настроен для принятия запроса на запись от пользователя на коммутаторе.

Для получения дополнительной информации см. документацию к вашему FTP-серверу.

Загрузка файла конфигурации с использованием FTP в сети IPv4​

шаг 1 Скопируйте файл конфигурации​

    Switch# copy mgmt-if ftp://test:test@10.10.10.163/ startup-config.conf  flash:/startup-config.conf

шаг 2. Проверка​

Используйте следующую команду для отображения конфигурации

    Switch# show startup-config

Выгрузка файла конфигурации с использованием FTP в сети IPv4​

шаг 1 Скопируйте файл конфигурации​

    Switch# copy flash:/startup-config.conf mgmt-if ftp://test:test@10.10.10.163/startup-config.conf

Загрузка файла конфигурации с использованием FTP в сети IPv6​

Настройки имени пользователя и пароля такие же, как в сети IPv4.

шаг 1 скопируйте файл конфигурации​

    Switch# copy ftp://root: root@2001:1000::2/startup-config.conf  flash:/startup-config.conf

Выгрузка файла конфигурации с использованием FTP в сети IPv6​

Настройки имени пользователя и пароля такие же, как в сети IPv4.

шаг 1 Скопируйте файл конфигурации​

    Switch# копировать flash:/startup-config.conf mgmt-if ftp://root:root@2001:1000::2 startup-config.conf

4 Настройка FTP-Сервера (FTP SERVER)

4.1 Обзор​

Введение в функцию​

Вы можете загрузить файл конфигурации коммутатора с FTP-сервера или выгрузить его с коммутатора на FTP-сервер. Загрузка файла конфигурации с сервера используется для обновления конфигурации коммутатора. Текущий файл начальной конфигурации можно заменить новым. Выгрузка файла конфигурации на сервер осуществляется для создания резервной копии. Этот загруженный файл конфигурации можно использовать для последующих загрузок на коммутатор или на другой коммутатор того же типа.

4.2 Конфигурация​

Вы можете копировать файлы конфигурации на FTP-сервер или с него. Протокол FTP требует, чтобы клиент отправлял удаленное имя пользователя и пароль при каждом FTP-запросе к серверу.

Перед загрузкой или выгрузкой файла конфигурации с использованием FTP выполните следующие действия:

  • Убедитесь, что у коммутатора есть маршрут к FTP-серверу. Коммутатор и FTP-сервер должны находиться в одной сети, если у вас нет маршрутизатора для маршрутизации трафика между подсетями. Проверьте подключение к FTP-серверу с помощью команды ping.
  • Если вы подключаетесь к коммутатору через консоль или Telnet-сеанс и у вас нет действительного имени пользователя, убедитесь, что текущее имя пользователя FTP — это то, которое вы хотите использовать для загрузки через FTP.
  • При выгрузке файла конфигурации на FTP-сервер он должен быть правильно настроен для принятия запроса на запись от пользователя на коммутаторе.

Для получения дополнительной информации обратитесь к документации вашего FTP-сервера.

Настройка FTP-сервера​

шаг 1. Войдите в режим конфигурации​

    Switch# configure terminal

шаг 2. Включите FTP-сервер на интерфейсе управления​

    Switch(config)# ftp server mgmt-if enable

шаг 3 Настройте системных пользователей коммутатора​

Пользователи должны настроить пароль, и уровень привилегий должен быть установлен на 4

    Switch(config)# username admin privilege 4 password admin

шаг 4. Проверка​

Клиент подключается к FTP-серверу, вводит имя пользователя и пароль. IP-адрес интерфейса управления сервером — 10.10.10.10

    Switch# ftp mgmt-if 10.10.10.10
    Connected to 10.10.10.10.
    220---------- Welcome to FTP-SERVER ----------
    220-You are user number 1 of 50 allowed.
    220-Local time is now 06:41. Server port: 21.
    220-IPv6 connections are also welcome on this server.
    220 You will be disconnected after 15 minutes of inactivity.
    Name (10.10.10.10:LOGIN): admin
    331 User admin OK. Password required
    Password:
    230 OK. Current directory is /
    Remote system type is UNIX.
    Using binary mode to transfer files.

Другая дополнительная конфигурация​

Настройте порт FTP-сервера, по умолчанию 21​

    Switch# ftp server port 10000

Настройте время ожидания FTP-сервера, по умолчанию 15 мин​

    Switch# ftp server time-out 5

Настройте VRF или IP-адреса в группе FTP-сервера. Исходный IP-адрес конфигурации — 1.1.1.1, исходный VRF конфигурации — тестовый, исходный VRF конфигурации — тестовый, а исходный IP-адрес — 2.2.2.2​

    Switch# ftp server source address 1.1.1.1
    Switch# ftp server source address vrf test 0.0.0.0
    Switch# ftp server source address vrf test 2.2.2.2

5 Настройка TFTP

5.1 Обзор​

Введение в функцию​

Вы можете загрузить файл конфигурации коммутатора с сервера TFTP или выгрузить его с коммутатора на FTP-сервер. Загрузка файла конфигурации с сервера используется для обновления конфигурации коммутатора. Текущий файл начальной конфигурации можно заменить новым. Выгрузка файла конфигурации на сервер осуществляется для создания резервной копии. Этот загруженный файл конфигурации можно использовать для последующих загрузок на коммутатор или на другой коммутатор того же типа.

5.2 Конфигурация​

Перед загрузкой или выгрузкой файла конфигурации с использованием TFTP выполните следующие действия:

  • Убедитесь, что рабочая станция, действующая как TFTP-сервер, правильно настроена.
  • Убедитесь, что у коммутатора есть маршрут к TFTP-серверу. Коммутатор и TFTP-сервер должны находиться в одной сети, если у вас нет маршрутизатора для маршрутизации трафика между подсетями. Проверьте подключение к TFTP-серверу с помощью команды ping.
  • Убедитесь, что загружаемая конфигурация находится в правильном каталоге на TFTP-сервере.
  • Для операций загрузки убедитесь, что разрешения на файл настроены правильно.
  • При выполнении операций выгрузки, если вы перезаписываете существующий файл (включая пустой файл, если пришлось создать его на сервере), убедитесь, что разрешения на файл настроены правильно.

Загрузка файла конфигурации с использованием TFTP в сети IPv4​

    Switch# copy mgmt-if tftp://10.10.10.163/startup-config.conf flash:/startup-config.conf

Выгрузка файла конфигурации с использованием TFTP в сети IPv4​

    Switch# copy flash:/startup-config.conf mgmt-if tftp://10.10.10.163/startup-config.conf

Загрузка файла конфигурации с использованием TFTP в сети IPv6​

    Switch# copy mgmt-if tftp://2001:1000::2/startup-config.conf flash:/startup-config.conf

Выгрузка файла конфигурации с использованием TFTP в сети IPv6​

    Switch# copy flash:/startup-config.conf mgmt-if tftp://2001:1000::2/startup-config.conf

6 Настройка SCP

6.1 Обзор​

Введение в функцию​

SCP (Secure Copy Protocol) является частью протокола SSH. Это технология удаленного копирования, основанная на протоколе SSH. Пользователь может загрузить файл конфигурации коммутатора с SCP-сервера или выгрузить файл с коммутатора на SCP-сервер. Загрузка файла конфигурации с сервера позволяет обновить конфигурацию коммутатора и перезаписать текущий файл новым. Выгрузка файла конфигурации на сервер выполняется для создания резервной копии; этот загруженный файл можно использовать для последующих загрузок на тот же коммутатор или на другой коммутатор того же типа.

6.2 Конфигурация​

Перед загрузкой или выгрузкой файла конфигурации с использованием SCP выполните следующие действия:

  • Убедитесь, что рабочая станция, действующая как SCP-сервер, правильно настроена.
  • Убедитесь, что у коммутатора есть маршрут к SCP-серверу. Коммутатор и SCP-сервер должны находиться в одной сети, если у вас нет маршрутизатора для маршрутизации трафика между подсетями. Проверьте подключение к SCP-серверу с помощью команды ping.
  • Убедитесь, что загружаемая конфигурация находится в правильном каталоге на SCP-сервере.
  • Для операций загрузки убедитесь, что разрешения на файл настроены правильно.
  • При выполнении операций выгрузки, если вы перезаписываете существующий файл (включая пустой файл, если его пришлось создать на сервере), убедитесь, что разрешения на файл настроены правильно.

Загрузка файла конфигурации с использованием SCP в сети IPv4​

    Switch# copy mgmt-if scp://10.10.10.163/startup-config.conf flash:/startup-config.conf

Выгрузка файла конфигурации с использованием SCP в сети IPv4​

    Switch# copy flash:/startup-config.conf mgmt-if scp://10.10.10.163/startup-config.conf

Загрузка файла конфигурации с использованием SCP в сети IPv6​

    Switch# copy mgmt-if scp://2001:1000::2/startup-config.conf flash:/startup-config.conf

Выгрузка файла конфигурации с использованием SCP в сети IPv6​

    Switch# copy flash:/startup-config.conf mgmt-if scp://2001:1000::2/startup-config.conf

7 Настройка Telnet

7.1 Обзор​

Введение в функцию​

Telnet — это сетевой протокол, используемый в Интернете или локальных сетях для обеспечения двунаправленной интерактивной текстовой связи посредством виртуального терминального подключения. Пользовательские данные передаются в одном потоке с управляющей информацией Telnet в 8-битном байт-ориентированном соединении данных через протокол TCP. Telnet был разработан в 1969 году, начиная с RFC 15, расширен в RFC 854 и стандартизирован как Internet Standard STD 8 рабочей группой IETF, став одним из первых стандартов Интернета. Исторически Telnet предоставлял доступ к интерфейсу командной строки (обычно операционной системы) на удаленном хосте. Большинство сетевого оборудования и операционных систем с поддержкой TCP/IP поддерживают службу Telnet для удаленной настройки (включая системы на базе Windows NT). Из-за проблем с безопасностью использование Telnet для этих целей уменьшилось, уступив место SSH.

7.2 Конфигурация​

Подключитесь к коммутатору по Telnet через внутренний порт​

Пример 1. Сеть IPv4​

    Switch# telnet 10.10.29.247
    Entering character mode
    Escape character is '^]'.
    Switch #

Пример 2. Сеть IPv6​

    Switch# telnet 2001:1000::71
    Entering character mode
    Escape character is '^]'.
    Switch #

Подключитесь к коммутатору по Telnet через порт управления​

Пример 1. Сеть IPv4​

    Switch# telnet mgmt-if 10.10.29.247
    Entering character mode
    Escape character is '^]'.
    Switch #

Пример 2. Сеть IPv6​

    Switch# telnet mgmt-if 2001:1000::2
    Entering character mode
    Escape character is '^]'.
    Switch #

Настройте Telnet-сервер​

шаг 1. Войдите в режим конфигурации​

    Switch# configure terminal

шаг 2 Включите службу Telnet​

    Switch(config)# service telnet enable

шаг 3 Выйдите из режима конфигурации​

    Switch(config)# exit

8 Настройка SSH

8.1 Обзор​

Введение в функцию​

Протокол Secure Shell (SSH) обеспечивает безопасное удаленное подключение к устройству. В отличие от Telnet, SSH обеспечивает более высокий уровень безопасности удаленных подключений за счет сильного шифрования при аутентификации устройства. SSH поддерживает алгоритмы шифрования Data Encryption Standard (DES), Triple DES (3DES) и аутентификацию пользователей на основе пароля. Функция SSH включает SSH-сервер и встроенный SSH-клиент, которые являются приложениями, работающими на коммутаторе. Вы можете использовать SSH-клиент для подключения к коммутатору, на котором работает SSH-сервер. SSH-сервер совместим с SSH-клиентом, поддерживаемым в данной версии, а также с другими SSH-клиентами. Также SSH-клиент работает с SSH-сервером, поддерживаемым в данной версии, и с другими SSH-серверами.

8.2 Конфигурация​

Рисунок 2-1 Приложение SSH-системы

Создать ключ для SSH​

шаг 1. Войдите в режим конфигурации​

    Switch# configure terminal

шаг 2 Создайте ключ​

    Switch(config)# rsa key a generate

шаг 3 Создайте приватный ключ с именем a.pri с ключом a и сохраните его в память устройства (flash)​

    Switch(config)# rsa key a export url flash:/a.pri private ssh2

шаг 4 Создайте публичный ключ с именем a.pub с ключом a и сохраните его в память устройства (flash)​

    Switch(config)# rsa key a export url flash:/a.pub public ssh2

шаг 5 Выйдите из режима конфигурации​

    Switch(config)# exit

Импортируйте ключ​

шаг 1. Войдите в режим конфигурации​

    Switch# configure terminal

шаг 2 Импортируйте созданный ключ a.pub как importKey​

    Switch(config)# rsa key importKey import url flash:/a.pub public ssh2

шаг 3 Создайте имя пользователя и пароль​

    Switch(config)# username aaa privilege 4 password abc

шаг 4 Назначьте ключ пользователю aaa​

    Switch(config)# username aaa assign rsa key importKey

шаг 5 Выйдите из режима конфигурации​

    Switch(config)# exit

Используйте SSH для подключения​

шаг 1 Загрузите ключ a.pri на SSH-клиент​

шаг 2. Подключитесь к клиенту​

    [root@test1 tftpboot]# ssh -i a.pri aaa@10.10.39.101
    aaa@10.10.39.101's password: 
    Switch#

9 Настройка времени и часового пояса

9.1 Обзор​

Введение в функцию​

Если нет другого источника времени, вы можете вручную настроить время и дату после перезагрузки системы. Время останется точным до следующей перезагрузки системы. Рекомендуем использовать ручную настройку только в крайнем случае. Если у вас есть внешний источник, с которым коммутатор может синхронизироваться, вам не нужно вручную устанавливать системные часы.

9.2 Конфигурация​

шаг 1. Войдите в режим конфигурации​

''' Switch# configure terminal '''

шаг 2. Настройка времени и часового пояса​

    Switch(config)# clock set datetime 11:30:00 10 26 2013
    Switch(config)# clock set summer-time dst date 6 1 2013 02:00:00 10 31 2013 02:00:00 120

шаг 3 Выйдите из режима конфигурации​

    Switch(config)# exit

шаг 4. Проверка​

Для отображения информации о времени и дате используйте следующую команду:

    Switch# show clock detail
    13:31:10 dst Sat Oct 26 2024
    Time zone: (GMT + 08:00:00)  beijing
    Summer time starts at beijing 02:00:00  06/01/2024
    Summer time ends at dst 02:00:00  10/31/2024
    Summer time offset:  120 minutes

10 Руководство по настройке API RPC

10.1 Обзор​

Введение в функцию​

Сервис RPC API позволяет пользователю настраивать и мониторить систему коммутатора через удалённые вызовы процедур (RPC) из вашей программы. В настоящее время сервис поддерживает JSON-RPC по протоколу HTTP с использованием базовой аутентификации HTTP.

Описание принципа​

Сервис RPC API использует стандартный JSON-RPC по протоколу HTTP для взаимодействия между коммутатором и вашей программой. Пользователь может выполнять команды CLI коммутатора с помощью метода JSON-RPC: executeCmds. По умолчанию режим CLI находится в привилегированном EXEC-режиме (#).

Пользователь может отправить JSON-RPC запрос через HTTP POST запрос на URL:

http://<IP-адрес>:<порт>/command-api

Подробные примеры JSON-RPC запроса и ответа показаны ниже:

Запрос JSON-RPC​

    {
    `    `"params":[                                          Parameters for command
    `        `{                                               
    `            `"format":"text",                            Expected response format, can be ‘text’ or ‘json’, 
    the default format is ‘text’                            
    `            `"version":1,                                The API version
    `            `"cmds":[                                    List of CLI commands
    `                `"show run",                             CLI command 1
    `                `"config t",                             CLI command 2
    `                `"vlan database",                        CLI command 3
    `                `"vlan 1-8",                             CLI command 4
    `                `"interface eth-0-1",                    CLI command 5
    `                `"switchport mode trunk",                CLI command 6
    `                `"switchport trunk allowed vlan add 2",  CLI command 7
    `                `"shutdown",                             CLI command 8
    `                `"end",                                  CLI command 9
    `                `"show interface switchport"             CLI command 10
    `            `]                                           
    `        `}                                               
    `    `],                                                  
    `    `"jsonrpc":"2.0",                                    JSON RPC protocol version. Always 2.0.
    `    `"method":"executeCmds",                             Method to run the switch CLI commands
    `    `"id":"70853aff-af77-420e-8f3c-fa9430733a19"         JSON RPC unique identifier
    }

Ответ JSON-RPC​

    {
    `    `"jsonrpc":"2.0",                                     JSON RPC protocol version. Always 2.0.
    `    `"id":"70853aff-af77-420e-8f3c-fa9430733a19",         JSON RPC unique identifier
    `    `"result":[                                           Result list of objects from each CLI command executed. 
    `        `{                                                
    `            `"sourceDetails":"version 5.1.6.fcs\n!\n …",  Output information of CLI Command 1.
    `                                                         `The Original ASCII output information returned from CLI command if this command is successfully executed.
    `            `"errorCode":-1003,                           Error code if it is available.
    `            `"errorDesc":"unsupported command…",          Error description if it is available.
    `            `"warnings":"% Invalid…",                     Warnings if it is available.
    `                                                         `Formatted JSON object will also be returned if it is available.
    `        `},                                               
    `        `{ },                                             Output information of CLI Command 2.
    `        `{ },                                             Output information of CLI Command 3.
    `        `{ },                                             Output information of CLI Command 4.
    `        `{ },                                             Output information of CLI Command 5.
    `        `{ },                                             Output information of CLI Command 6.
    `        `{ },                                             Output information of CLI Command 7.
    `        `{ },                                             Output information of CLI Command 8.
    `        `{ },                                             Output information of CLI Command 9.
    `        `{
    `            `"sourceDetails":" Interface name          : eth-0-1\n Switchport mode         : trunk\n …\n"
    `        `}                                                Output information of CLI Command 10.
    `    `]
    }

Пример кода клиента Python​

Пример кода с использованием библиотеки «pyjsonrpc»:


    import pyjsonrpc
    import json
    http\_client = pyjsonrpc.HttpClient(
    `    `url = "http://10.10.39.64:80/command-api",
    `    `username = "username",
    `    `password = "password"
    )
    cmds = {}
    cmd\_list = ["show run", "config t", "vlan database", "vlan 1-8", "interface eth-0-1", "switchport mode trunk", "switchport trunk allowed vlan add 2", "shutdown", "end", "show interface switchport"]
    cmds['cmds'] = cmd\_list
    cmds['format'] = 'text'
    cmds['version'] = 1
    try:
    `    `response = http\_client.call("executeCmds", cmds)
    `    `print("json response:");
    `    `json\_result = json.dumps(response, indent=4)
    `    `print(json\_result)
    except Exception, e:
    `    `if e.code == 401:
    `        `print "Unauthorized user"
    `    `else:
    `        `print e.message
    `        `print e.data

Код ошибки​

Список кодов ошибок JSON-RPC 2.0:

Код ошибкиОписание
-32700Ошибка синтаксического анализа
-32600Неверный запрос
-32601Метод не найден
-32602Неверный параметр
-32603Внутренняя ошибка

Список кодов ошибок RPC-API:

Код ошибкиОписание
-1000Общая ошибка
-2001Ошибка API JSON RPC: неподдерживаемая версия API
-2002Ошибка API JSON RPC: необходимо указать «params» с «cmds» в JSON RPC
-2003Ошибка API JSON RPC: неподдерживаемый формат ответа команды
-3001Выполнение команды не удалось: истекло время ожидания
-3002Выполнение команды не удалось: неподдерживаемая команда
-3003Выполнение команды не удалось: несанкционированная команда
-3004Выполнение команды не удалось: строка не соответствует ни одной команде в текущем режиме
-3005Выполнение команды не удалось: невозможно преобразовать в формат JSON
-3006Выполнение команды не удалось: список команд слишком короткий
-3007Выполнение команды не удалось: слишком длинный список команд

10.2 Конфигурация​

Настройка сервиса RPC API​

Пользователь может включить сервис RPC API, выполнив следующие шаги.

Порт по умолчанию — 80.

шаг 1. Войдите в режим конфигурации​

    Switch# configure terminal

шаг 2. Включите сервис RPC API​

    Switch(config)# service rpc-api enable

Примечание: Для отключения сервиса rpc-api используйте следующую команду:

    Switch(config)# service rpc-api disable

шаг 3 Выйдите из режима конфигурации​

    Switch(config)# end

Настройка службы RPC API с аутентификацией HTTP​

Пользователь может настроить режим аутентификации HTTP для службы RPC API. В настоящее время поддерживается только базовая аутентификация HTTP. При предоставлении недействительного имени пользователя или пароля пользователь получит статусный код 401 (Несанкционированный доступ).

шаг 1. Войдите в режим конфигурации​

    Switch# configure terminal

шаг 2. Установите имя пользователя и пароль, затем включите аутентификацию RPC API​

    Switch(config)# username myuser password mypass privilege 4
    Switch(config)# service rpc-api auth-mode basic

Примечание: Для отключения аутентификации используйте следующую команду:

    Switch(config)# нет службы rpc-api auth-mode

Примечание: Настройки HTTP-аутентификации для RPC API вступят в силу после перезапуска сервиса или системы.

шаг 3 Выйдите из режима конфигурации​

    Switch(config)# end

шаг 4. Проверка​

    Switch# show services rpc-api 
    RPC API service configuration:
    ` `Server State        : enable
    ` `Port                : 80
    ` `Authentication Mode : basic
    ` `VRF                 : default

11 Настройка HTTP

11.1 Обзор​

Введение в функцию​

Эта глава описывает, как настроить коммутатор для запуска функции управления через веб-интерфейс.

11.2 Конфигурация​

Подготовка​

Поместите допустимое веб-изображение в каталог flash:. См. руководство по FTP или TFTP для получения подробной информации.

Настройка HTTP-сервера​

шаг 1. Войдите в режим конфигурации​

    Switch# configure terminal

шаг 2. Загрузка веб-изображения​

    Switch(config)# http server load flash:/webImage.bin

шаг 3. Настройка адреса HTTP-сервера (по желанию)​

Используйте этот шаг для указания исходного адреса веб-сервера HTTP; поддерживается только адрес loopback. Если исходный адрес веб-сервера HTTP указан, это будет единственный адрес для доступа к веб-интерфейсу. Если исходный адрес не указан, доступ к веб-интерфейсу возможен через тот же адрес, что и для Telnet. Необходимо наличие маршрута между устройством и клиентом.

    Switch(config)# interface loopback 0
    Switch(config-if)# ip address 192.168.1.100/32
    Switch(config-if)# quit
    Switch(config)# http server source address 192.168.1.100
    This operation will cause all the online HTTP(S) users to be offline.
    Continue? [yes/no]: yes
    Switch(config)# ip route 0.0.0.0/0 192.168.1.1

шаг 4. Включение сервиса HTTP​

    Switch(config)# service http enable 
    This operation will cause all the online HTTP(S) users to be offline.
    Continue? [yes/no]: yes

шаг 5 Выйдите из режима конфигурации​

    Switch(config)# exit

шаг 6. Вход в веб-интерфейс через браузер​

Введите IP-адрес для входа в веб-интерфейс.