Конфигурационный файл

1. Параметры файла

  1. Определите значения параметров конфигурационного файла модуля opt/rubackup/etc/rb_module_vmware_vm.conf, приведенных в таблице Таблица 1:

    sudo nano /opt/rubackup/etc/rb_module_vmware_vm.conf
    Таблица 1. Параметры конфигурационного файла модуля резервного копирования Vmware
    Параметр Назначение Значение по умолчанию

    IP address

    Укажите IP-адрес или полное доменное имя сервера FQDN для подключения к vCenter

    login crypted

    Использование параметра login. Укажите значение для данного параметра в виде строки вида user_name:password, где:

    • user_name - имя пользователя

    • password – пароль

    Использование параметра login crypted вместо login. В качестве значения для данного параметра укажите строку вида user_name:password, зашифрованную алгоритмом Base64, где:

    • user_name - имя пользователя

    • password - пароль

    Для получения зашифрованной строки для использования в качестве значения параметра login crypted, выполните следующую команду:

    echo -n 'user_name:password' | base64

    ‍ca_info <PATH_TO_CERT_FILE>

    Укажите путь к файлу сертификата, который получен от vCenter. После получения и распаковки файла download.zip укажите в параметре ca_info путь до файла-сертификата с расширением .0 из папки /opt/rubackup/etc/certs/lin.

    ‍timeout

    Укажите значение в секундах для промежутка времени, в течении которого модуль будет ожидать ответ на API запросы в vCenter. Минимальное значение для опции - 1, максимальное значение - 300. Значение по умолчанию - 5.

    5

    ‍port

    Укажите порт, который будет использоваться для аутентификации.

    nfc_host_port

    Укажите порт, который будет использоваться для установления соединения NFC c ESXi

    ‍workers

    Параметр устанавливает количество параллельных потоков для работы с виртуальными жесткими дисками. Минимальное значение для данной опции 1, максимальное 8. Если строка с данной опцией отсутствует в файле настроек модуля, закомментирована или значение находится вне допустимого диапазона, то будет использовано значение по умолчанию 2.

    2

    curl_verbose

    Включение режима откладки REST API запросов в vCenter. Для включения режима откладки установите значение yes. Значение no является значением по умолчанию, при котором режим отладки API запросов выключен.

    Режим отладки не должен быть активирован при штатной работе СРК.

    no

    curl_workers

    Параметр указывает количество потоков для отправки параллельных запросов к vCenter через REST API. Минимальное значение для опции 1, максимальное значение 1000. Значение по умолчанию 2.

    10

    disk_transport nbdssl

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

    • nbd — сетевое блочное устройство, доступ к виртуальному диску через сеть.

    • nbdssl — сетевое блочное устройство с SSL, доступ к виртуальному диску через сеть с использованием TLS.

    • hotadd — подключение виртуального диска непосредственно к хосту клиента. Только для клиентов, расположенных на хостах Vmware.

    Возможные комбинации разделяются двоеточием с уменьшением приоритета. Значение по умолчанию, если оно не задано в текущем файле конфигурации: file:san:hotadd:nbdssl:nbd.

    file:san:hotadd:nbdssl:nbd

    ignore_access_errors

    При значении yes параметра ошибки вызова функции VixDiskLib_PrepareForAccess игнорируются и записываются в журнальный файл модуля RuBackup, при этом модуль продолжает работу. Значение no является значением по умолчанию, при котором ошибка вызова библиотечной функции приведет к ошибке выполнения задачи резервного копирования или восстановления.

    no

    disable_access_calls

    При значении yes параметра вызовы библиотечных функций VixDiskLib_PrepareForAccess и VixDiskLib_EndAccess не производятся при взаимодействии модуля RuBackup с виртуальными дисками. Сообщения об этом записываются журнальный файл модуля. Значение no является значением по умолчанию, при котором библиотечные вызовы функций выше выполняются при взаимодействии модуля с виртуальными дисками.

    no

    allow_work_with_incompatible_versions

    Возможные значения: yes, no. Значение по умолчанию: no. При выполнении проверки работоспособности модуля на хосте клиента RuBackup выполняется запрос к vCenter для определения его версии. При значении no для параметра allow_work_with_incompatible_versions проверка работоспособности модуля завершится с ошибкой в случае, если версия vCenter отличается от списка версий, с которыми выполнялась интеграция данного модуля RuBackup. В таком случае будет невозможно выполнять резервирование и восстановление ВМ с данного Клиента RuBackup. Если при этом изменить значение параметра на yes` при проверке работоспособности модуля в его журнальный файл будет выведено предупреждение о неподдерживаемой версии vCenter, однако модуль можно будет использовать для резервирование и восстановление ВМ.

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

    no

  2. Сохраните изменения в файле модуля opt/rubackup/etc/rb_module_vmware_vm.conf.

  3. Для применения настроек перезапустите сервис клиента РК RuBackup на узле, на котором установлен клиент РК и модуль Vmware:

    sudo systemctl restart rubackup_client

2. Листинг файла

Пример листинга конфигурационного файла /opt/rubackup/etc/rb_module_vmware_vm.conf
# Description variables
# Symbol "#" at the beginning of the line treats as a comment
# "#" in the middle of the line treats as a parameter value
# So please do not use comments in one line with parameter
# Mandatory parameters
#
# IP address or FQDN for vCenter
#vcenter https://<ADDRESS_OF_vCenter>
#
# Data for authentication in vCenter can be provided in one of the following forms:
# 1. Not encrypted string.
#    For example: login user_name:password
#
# 2. String of the format 'user_name:password' encrypted using the 'base64' algorithm.
#    For example: login crypted dXNlcl9uYW1lOnBhc3N3b3JkCg==
#    To encode login and password use command
#    echo -n 'LOGIN:PASSWORD' | base64
#login crypted <LOGIN AND PASSWORD>
#
# Path to the certificate file got from vCenter, optional.
# If not specified certificate will be obtained from vCenter automatically.
# Use this option only in case of issue in getting the certificate  automatically.
# The following command can be used to obtain an archive with certificates from vCenter:
# wget <IP address or FQDN for vCenter>/certs/download.zip --no-check-certificate
#ca_info <PATH_TO_CERT_FILE>
#
# A timeout value in seconds RuBackup module will wait for response from vCenter on corresponding API requests
# minimum 1, maximum 300, default 5
#timeout 20
# Port to use for authenticating with host
#port 0
# Port to use for establishing NFC connection to ESXi host
#nfc_host_port 0
# Number of parallel workers to work with virtual disks
# min 1, max 8, default 2
#workers 2
# Turn on debug of REST requests
#curl_verbose no
# Amount of parallel workers for REST requests
# min 1, max 1000, default 10
#curl_workers 10
#
# Try using the module if the vCenter platform version is not compatible with RuBackup. Default: no
#allow_work_with_incompatible_versions no
#
#Virtual disk dump method aka disk transport that will be used for disks local dump
# Possible values:
# - nbd: network block device, access virtual disk via network
# - nbdssl: network block device with ssl, access virtual disk via network using TLS
# - san: storage area network, actual only for virtual disks located at SAN storages
# - hotadd: attaching virtual disk directly to the client's host. Only for clients located at VMware hosts
# - file: used in case if virtual disk is a local file
# Possible combinations: separated by colon(:) with reducing priority nbd:san:hotadd
# Default value if not set in current configuration file: "file:san:hotadd:nbdssl:nbd"
#disk_transport nbdssl
# Ignore error of PrepareForAccess vixDiskLib function calls
#ignore_access_errors no
# Don't call PrepareForAccess and EndAccess vixDiskLib functions
#disable_access_calls no
#
#Enable or disable VixDiskLib logging
#Possible values: yes, no
#Default value: yes
#enable_vix_disk_lib_logging yes
#
# Variables value
vcenter https://10.177.33.52
login administrator@test.local:P@ssw0rd
allow_work_with_incompatible_versions yes
timeout 300
workers 1