Управление целевыми папками

Для управления целевыми папками в пространстве имен с помощью утилиты samba-tool используется группа подкоманд dfsn folder target.

См. описание последовательности настройки пространства имен в разделе «Настройка DFSN».

Общие сведения

Целевая папка представляет собой реальное местоположение данных, связанное с папкой в пространстве имен. Она соответствует общей папке на файловом сервере и указывается в формате UNC-имени.

Один объект папки может содержать несколько целевых папок.

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

Ограничения

Поддерживается только одноуровневая модель именования общего ресурса (share).

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

Пример допустимого пути:

\\server\shared_folder

Пример недопустимого пути (содержит вложенные сегменты, что выходит за пределы поддерживаемой модели):

\\server\shared\folder\subfolder

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

Добавление целевой папки

Формат вызова:

samba-tool dfsn folder target create <dfs_path> <target_path> [options]

В качестве обязательных аргументов ожидаются:

  • путь к папке, в которую требуется добавить целевую папку, в пространстве имен в формате UNC-имени (например, \\elles.inno.tech\namespace1\documents);

  • путь к добавляемой целевой папке в формате UNC-имени (например, \\fs01.elles.inno.tech\share).

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

Подкоманда добавляет целевую папку в указанную папку в пространстве имен в соответствии с переданными значениями параметров.

Параметры

Параметры вызова:

  • --server=DFSSERVERHOST — имя хоста (NetBIOS-имя) или полное доменное имя (FQDN) сервера пространства имен, используя соединение с которым будет выполнено изменение или запрошена информация;

    Этот параметр предназначен для использования только в исключительных случаях, когда необходимо явно указать сервер пространства имен (например, при нештатных ситуациях или тестировании). Задавать его при штатной эксплуатации не требуется.

  • --referral-priority-class=CLASS — класс приоритета для целевого ресурса;

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

    Возможные значения:

    • GlobalHigh — наивысший приоритет среди всех целевых ресурсов вне зависимости от принадлежности к сайту;

    • SiteCostHigh — повышенный приоритет среди целевых ресурсов с одной стоимостью связи между сайтом клиента и сайтом целевого ресурса;

    • SiteCostNormal (по умолчанию) — стандартный приоритет среди целевых ресурсов с одной стоимостью связи между сайтом клиента и сайтом целевого ресурса;

    • SiteCostLow — пониженный приоритет среди целевых ресурсов с одной стоимостью связи между сайтом клиента и сайтом целевого ресурса;

    • GlobalLow — наименьший приоритет среди всех целевых ресурсов вне зависимости от принадлежности к сайту.

  • --referral-priority-rank=RANK — числовой ранг в рамках класса приоритета;

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

    Допустимый диапазон значений — от 0 (по умолчанию) до 31. Чем меньше число, тем выше ранг приоритета; нулевое значение соответствует наивысшему рангу приоритета.

  • --state=STATE — состояние целевого ресурса;

    Параметр определяет состояние целевого ресурса и управляет его видимостью для клиентов. Состояние может использоваться для временного исключения целевого ресурса из списка перенаправления без фактического его удаления.

    Возможные значения:

    • Online (по умолчанию) — целевой ресурс доступен и участвует в формировании списка перенаправления;

    • Offline — целевой ресурс исключается из списка перенаправления, но остается в конфигурации DFSN.

Примеры

Пример добавления новой целевой папки в папку в пространстве имен:

samba-tool dfsn folder target create "\\\\elles.inno.tech\\namespace1\\documents" "\\\\fs01.elles.inno.tech\\documents" \
    --referral-priority-class=SiteCostHigh \
    --referral-priority-rank=1
Create folder target:
DFS path:                \\elles.inno.tech\namespace1\documents
Target path:             \\fs01.elles.inno.tech\share
State:                   2 (Online)
Referral priority class: 2 (SITE_COST_HIGH)
Referral priority rank:  1
...
Result: SUCCESS

Получение информации о целевой папке

Формат вызова:

samba-tool dfsn folder target get <dfs_path> [<target_path>] [options]

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

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

  • путь к целевой папке;

  • состояние:

    • Online — целевой ресурс доступен и участвует в формировании списка перенаправления;

    • Offline — целевой ресурс исключается из списка перенаправления, но остается в конфигурации DFSN;

  • настройки приоритета:

    • класс приоритета:

      • GLOBAL_HIGH — наивысший приоритет среди всех целевых ресурсов вне зависимости от принадлежности к сайту;

      • SITE_COST_HIGH — повышенный приоритет среди целевых ресурсов с одной стоимостью связи между сайтом клиента и сайтом целевого ресурса;

      • SITE_COST_NORMAL — стандартный приоритет среди целевых ресурсов с одной стоимостью связи между сайтом клиента и сайтом целевого ресурса;

      • SITE_COST_LOW — пониженный приоритет среди целевых ресурсов с одной стоимостью связи между сайтом клиента и сайтом целевого ресурса;

      • GLOBAL_LOW — наименьший приоритет среди всех целевых ресурсов вне зависимости от принадлежности к сайту;

    • числовой ранг целевого ресурса внутри выбранного класса приоритета.

Параметры

Параметры вызова:

  • --server=DFSSERVERHOST — имя хоста (NetBIOS-имя) или полное доменное имя (FQDN) сервера пространства имен, используя соединение с которым будет выполнено изменение или запрошена информация.

    Этот параметр предназначен для использования только в исключительных случаях, когда необходимо явно указать сервер пространства имен (например, при нештатных ситуациях или тестировании). Задавать его при штатной эксплуатации не требуется.

Примеры

Пример получения списка целевых папок, включенных в папку:

samba-tool dfsn folder target get "\\\\elles.inno.tech\\namespace1\\documents"
Get folder target info:
DFS path:    \\elles.inno.tech\namespace1\documents
Target path: None
...
Result:
Stores:
             \\fs01.elles.inno.tech\share    Online    SITE_COST_NORMAL    0
             \\fs02.elles.inno.tech\share    Online    SITE_COST_NORMAL    0

Пример получения информации о целевой папке:

samba-tool dfsn folder target get "\\\\elles.inno.tech\\namespace1\\documents" "\\\\fs01.elles.inno.tech\\documents"
Get folder target info:
DFS path:    \\elles.inno.tech\namespace1\documents
Target path: \\fs01.elles.inno.tech\share
...
Result:
Stores:
             \\fs01.elles.inno.tech\share    Online    SITE_COST_NORMAL    0

Изменение настроек целевой папки

Формат вызова:

samba-tool dfsn folder target set <dfs_path> <target_path> [options]

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

Подкоманда изменяет настройки указанной целевой папки в соответствии с переданными значениями параметров.

Параметры

Параметры вызова:

  • --server=DFSSERVERHOST — имя хоста (NetBIOS-имя) или полное доменное имя (FQDN) сервера пространства имен, используя соединение с которым будет выполнено изменение или запрошена информация;

    Этот параметр предназначен для использования только в исключительных случаях, когда необходимо явно указать сервер пространства имен (например, при нештатных ситуациях или тестировании). Задавать его при штатной эксплуатации не требуется.

  • --referral-priority-class=CLASS — класс приоритета для целевого ресурса;

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

    Возможные значения:

    • GlobalHigh — наивысший приоритет среди всех целевых ресурсов вне зависимости от принадлежности к сайту;

    • SiteCostHigh — повышенный приоритет среди целевых ресурсов с одной стоимостью связи между сайтом клиента и сайтом целевого ресурса;

    • SiteCostNormal (по умолчанию) — стандартный приоритет среди целевых ресурсов с одной стоимостью связи между сайтом клиента и сайтом целевого ресурса;

    • SiteCostLow — пониженный приоритет среди целевых ресурсов с одной стоимостью связи между сайтом клиента и сайтом целевого ресурса;

    • GlobalLow — наименьший приоритет среди всех целевых ресурсов вне зависимости от принадлежности к сайту.

  • --referral-priority-rank=RANK — числовой ранг в рамках класса приоритета;

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

    Допустимый диапазон значений — от 0 (по умолчанию) до 31. Чем меньше число, тем выше ранг приоритета; нулевое значение соответствует наивысшему рангу приоритета.

  • --state=STATE — состояние целевого ресурса;

    Возможные значения:

    • Online (по умолчанию) — целевой ресурс доступен и участвует в формировании списка перенаправления;

    • Offline — целевой ресурс исключается из списка перенаправления, но остается в конфигурации DFSN.

Примеры

Пример изменения настроек целевой папки:

samba-tool dfsn folder target set "\\\\elles.inno.tech\\namespace1\\documents" "\\\\fs01.elles.inno.tech\\documents" \
    --referral-priority-rank=1
Set folder target settings:
DFS path:               \\elles.inno.tech\namespace1\documents
Target path:            \\fs01.elles.inno.tech\share
Referral priority rank: 1
...
Result: SUCCESS

Удаление целевой папки

Формат вызова:

samba-tool dfsn folder target remove <dfs_path> <target_path> [options]

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

Подкоманда удаляет целевую папку из папки. Общая папка и файлы в ней на файловом сервере не удаляются.

Если удаляемая целевая папка последняя в папке, папка также удаляется.

Параметры

Параметры вызова:

  • --server=DFSSERVERHOST — имя хоста (NetBIOS-имя) или полное доменное имя (FQDN) сервера пространства имен, используя соединение с которым будет выполнено изменение или запрошена информация.

    Этот параметр предназначен для использования только в исключительных случаях, когда необходимо явно указать сервер пространства имен (например, при нештатных ситуациях или тестировании). Задавать его при штатной эксплуатации не требуется.

Примеры

Пример удаления целевой папки на текущем сервере:

samba-tool dfsn folder target remove "\\\\elles.inno.tech\\namespace1\\documents" "\\\\fs02.elles.inno.tech\\documents"
Remove folder target:
DFS path:    \\elles.inno.tech\namespace1\documents
Target path: \\fs02.elles.inno.tech\share
...
Result: SUCCESS

Получение списка целевых папок

Формат вызова:

samba-tool dfsn folder target list <dfs_path> [options]

В качестве обязательного аргумента ожидается путь к папке в пространстве имен, информацию о целевых папках которой требуется получить, в формате UNC-имени (например, \\elles.inno.tech\namespace1\documents);

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

  • путь к целевой папке;

  • состояние:

    • Online — целевой ресурс доступен и участвует в формировании списка перенаправления;

    • Offline — целевой ресурс исключается из списка перенаправления, но остается в конфигурации DFSN;

  • настройки приоритета:

    • класс приоритета:

      • GLOBAL_HIGH — наивысший приоритет среди всех целевых ресурсов вне зависимости от принадлежности к сайту;

      • SITE_COST_HIGH — повышенный приоритет среди целевых ресурсов с одной стоимостью связи между сайтом клиента и сайтом целевого ресурса;

      • SITE_COST_NORMAL — стандартный приоритет среди целевых ресурсов с одной стоимостью связи между сайтом клиента и сайтом целевого ресурса;

      • SITE_COST_LOW — пониженный приоритет среди целевых ресурсов с одной стоимостью связи между сайтом клиента и сайтом целевого ресурса;

      • GLOBAL_LOW — наименьший приоритет среди всех целевых ресурсов вне зависимости от принадлежности к сайту;

    • числовой ранг целевого ресурса внутри выбранного класса приоритета.

Параметры

Параметры вызова:

  • --server=DFSSERVERHOST — имя хоста (NetBIOS-имя) или полное доменное имя (FQDN) сервера пространства имен, используя соединение с которым будет выполнено изменение или запрошена информация.

    Этот параметр предназначен для использования только в исключительных случаях, когда необходимо явно указать сервер пространства имен (например, при нештатных ситуациях или тестировании). Задавать его при штатной эксплуатации не требуется.

  • --extended — включить в вывод информацию о конфигурации целевой папки (состояние, настройки приоритета).

Примеры

Пример получения списка целевых папок, связанных с указанной папкой в пространстве имен:

samba-tool dfsn folder target list "\\\\elles.inno.tech\\namespace1\\documents"
List DFS folder targets:
DFS path: \\elles.inno.tech\namespace\documents
...
Result:
\\fs01.elles.inno.tech\share
\\fs02.elles.inno.tech\share

Пример получения расширенной информации о папках указанного пространства имен:

samba-tool dfsn root target list "\\\\elles.inno.tech\\namespace1\\documents" --extended
List DFS folder targets:
DFS path: \\elles.inno.tech\namespace1\documents
...
Result:
\\fs01.elles.inno.tech\share
        State:                   2 (Online)
        Referral priority class: 0 (SITE_COST_NORMAL)
        Referral priority rank:  0
\\fs02.elles.inno.tech\share
        State:                   2 (Online)
        Referral priority class: 0 (SITE_COST_NORMAL)
        Referral priority rank:  0