Конфигурационный файл модуля opt/rubackup/etc/rb_module_vmware_vm.conf
1. Параметры файла
Параметр конфигурационного файла | Описание | Возможные значения (по умолчанию) | ||
---|---|---|---|---|
|
Укажите IP-адрес или полное доменное имя сервера FQDN для подключения к платформе виртуализации VMware |
|
||
|
Укажите данные для авторизации пользователя на платформе виртуализации VMware одним из способов:
|
|
||
|
Укажите путь к файлу сертификата, который получен от vCenter. Используйте эту опцию только в случае возникновения проблем с автоматическим получением сертификата. Если путь не указан, то сертификат будет получен из vCenter автоматически. Для получения архива с сертификатами из vCenter выполните:
Поместите файл-сертификата с расширением |
|
||
|
Укажите значение в секундах для промежутка времени, в течении которого модуль будет ожидать ответ на API-запросы на платформу виртуализации VMware. Если время ожидания истекло, а API-запрос отсался без ответа, то соответствующая задача резервного копирования/восстановления завершится ошибкой. Значение |
[1;300] (5) |
||
|
Укажите порт для авторизации на узле платформы виртуализации VMware |
|
||
|
Укажите порт для установки NFC-подключения к узлу гипервизора ESXi |
|
||
|
Укажите количество параллельных потоков для работы с виртуальными жесткими дисками ВМ Если строка с данной опцией отсутствует в файле настроек модуля, закомментирована или значение находится вне допустимого диапазона, то будет использовано значение по умолчанию 2 |
[1;8] (2) |
||
|
Включение режима откладки REST API запросов в vCenter. Возможные значения:
Не используйте режим отладки при штатной работе СРК! |
( |
||
|
Укажите количество потоков для отправки параллельных запросов к платформе виртуализации через REST API |
[1;1000] (10) |
||
|
Включить поддержку резервного копирования и восстановления данных ВМ для неподдерживаемой версии платформы виртуализации VMware При выполнении проверки работоспособности модуля на узле клиента РК выполняется запрос к платформе виртуализации для определения версии. Если версия платформы виртуализации VMware отличается от списка поддерживаемых версий:
|
( |
||
|
Параметр устанавливает тип транспорта, который будет использован для сохранения образа виртуальных дисков в локальный каталог на узле клиента резервного копирования. Возможные значения:
Возможные комбинации разделяются двоеточием с уменьшением приоритета. В строке значения по умолчанию |
( |
||
|
Игнорирование ошибки вызова функции Возможные значения:
|
( |
||
|
Игнорирование вызова функций Возможные значения:
|
( |
||
|
Ведение записи операций библиотеки Возможные значения:
|
( |
||
|
Укажите тип сущности для резервного копирования с использованием модуля Vmware на клиенте РК. Возможные значения:
|
( |
||
|
Укажите значение в секундах для промежутка времени, в течении которого модуль будет ожидать ответ на API-запросы создания шаблона ВМ в библиотеке VMware Content Library в процессе восстановления шаблона ВМ с развёртыванием. Если время ожидания истекло, но от платформы виртуализации не поступил ответ, подтверждающий создание шаблона ВМ в библиотеке VMware Content Library, то задача восстановления РК завершится со статусом Значение |
[0; 3600] (600) |
2. Листинг файла
# 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 vSphere 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
#
# Specifies an instance type (VM ot VM template) to backup using this module installation.
# Possible values:
# - vm
# - vm_template
# Default value: vm
#backup_instance_type vm
#
# Parameter 'vm_template_creation_timeout' specifies the amount of time in seconds
# the module will wait for response from vCenter on request for VM template
# creation in Content Library.
# If this timeout is reached but the response from vCenter is not received
# corresponding restore task will end with status 'Done_With_Defect'.
# However vCenter can handle the request successfully.
# Value '0' means no timeout at all.
# Possible values: [0, 3600]
# Default value: 600
vm_template_creation_timeout 600
#
# Variables value
vcenter https://10.170.33.10
login administrator@vsphere.local:password