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

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

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

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

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

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

Ограничения

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

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

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

\\server\shared_folder

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

\\server\shared\folder\subfolder

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

Создание папки

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

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

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

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

Дополнительно могут быть указаны параметры, определяющие:

  • необходимость учета сайта клиента при выдаче ему списков перенаправления на ресурсы общего доступа;

  • необходимость возвращения клиента к предпочтительному целевому ресурсу после периода временной недоступности;

  • состояние папки;

  • состояние целевых папок в папке;

  • период хранения в кэше клиентов списка перенаправления;

  • приоритет при формировании списка перенаправления.

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

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

Параметры

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

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

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

  • --comment=DESCRIPTION — произвольное текстовое описание папки;

  • --enable-insite-referrals=True|False — управление доступом клиентов к целевым ресурсам в других сайтах;

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

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

    • True — клиентам возвращаются целевые ресурсы только в том же сайте, в котором они сами находятся.

  • --enable-target-failback=True|False — управление автоматическим восстановлением подключения к приоритетному целевому ресурсу;

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

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

    • False (по умолчанию) — клиент продолжает использовать текущий целевой ресурс до обновления локального кэша или до повторного разрешения пространства имен, даже если более предпочтительный ресурс уже доступен;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • --target-state=STATE — состояние целевого ресурса (целевой папки, на которую указывает папка);

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

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

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

  • --ttl=TIMETOLIVE — время хранения в кэше на клиенте списка перенаправления в секундах (значение по умолчанию — 1800).

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

    1. Сохраняет его в локальном кэше.

    2. Использует этот список для доступа к ресурсам, не запрашивая обновления.

    3. По истечении значения параметра --ttl выполняет новое разрешение пути к ресурсу и получает актуальный список перенаправления.

Примеры

Пример создания папки на указанном сервере пространства имен:

samba-tool dfsn folder create "\\\\elles.inno.tech\\namespace1\\documents" "\\\\fs01.elles.inno.tech\\documents" \
    --comment="DFS folder"
Create folder:
DFS path:                \\elles.inno.tech\namespace1\documents
Target path:             \\fs01.elles.inno.tech\share
Insite referrals:        false
Target failback:         false
State:                   4 (Online)
Time-to-live (sec):      1800
Comment:                 DFS folder
Target state:            2 (Online)
Referral priority class: 0 (SITE_COST_NORMAL)
Referral priority rank:  0
...
Result: SUCCESS

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

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

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

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

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

  • путь к папке в пространстве имен;

  • состояние:

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

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

  • период кэширования списков перенаправления клиентами;

  • список флагов, установленных в конфигурации папки:

    • Insite referrals — установлен флаг, указывающий на необходимость возвращать клиенту целевые ресурсы только в том же сайте, в котором он находится;

    • Target failback — установлен флаг, включающий автоматическое восстановление подключения к приоритетному целевому ресурсу;

  • описание;

  • целевые папки.

Параметры

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

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

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

Примеры

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

samba-tool dfsn folder get "\\\\elles.inno.tech\\namespace1\\documents"
Get folder info:
DFS path:           \\elles.inno.tech\namespace1\documents
...
Result:
DFS path:           \\elles.inno.tech\namespace1\documents
State:              4 (Online)
Properties:
Time-to-live (sec): 1800
Comment:            DFS Folder
Stores:
        \\fs01.elles.inno.tech\share    Online
        \\fs02.elles.inno.tech\share    Online

Изменение настроек папки

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

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

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

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

Параметры

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

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

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

  • --comment=DESCRIPTION — произвольное текстовое описание папки;

  • --enable-insite-referrals=True|False — управление доступом клиентов к целевым ресурсам в других сайтах;

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

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

    • True — клиентам возвращаются целевые ресурсы только в том же сайте, в котором они сами находятся.

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

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

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

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

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

  • --enable-target-failback=True|False — управление автоматическим восстановлением подключения к приоритетному целевому ресурсу;

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

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

    • False (по умолчанию) — клиент продолжает использовать текущий целевой ресурс до обновления локального кэша или до повторного разрешения пространства имен, даже если более предпочтительный ресурс уже доступен;

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

  • --ttl=TIMETOLIVE — время хранения в кэше на клиенте списка перенаправления в секундах (значение по умолчанию — 1800).

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

    1. Сохраняет его в локальном кэше.

    2. Использует этот список для доступа к ресурсам, не запрашивая обновления.

    3. По истечении значения параметра --ttl выполняет новое разрешение пути к ресурсу и получает актуальный список перенаправления.

Примеры

Пример изменения настроек папки:

samba-tool dfsn folder set "\\\\elles.inno.tech\\namespace1\\documents" \
    --ttl=900
Set folder settings:
DFS path: \\elles.inno.tech\namespace1\documents
Time-to-live (sec): 900
...
Result: SUCCESS

Перемещение или переименование папки

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

samba-tool dfsn folder move <dfs_path> <new_dfs_path> [options]

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

  • текущий путь к папке в пространстве имен в формате UNC-имени (например, \\elles.inno.tech\namespace1\documents);

  • новый путь к папке в пространстве имен в формате UNC-имени (например, \\elles.inno.tech\namespace1\documents-old).

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

Параметры

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

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

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

Примеры

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

samba-tool dfsn folder move "\\\\elles.inno.tech\\namespace1\\documents" "\\\\elles.inno.tech\\namespace1\\documents-archived"
Move folder:
DFS path:     \\elles.inno.tech\namespace1\documents
New DFS path: \\elles.inno.tech\namespace1\documents-archived
...
Result: SUCCESS

Удаление папки

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

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

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

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

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

Если при вызове передается дополнительный параметр --force, операция выполняется без подтверждения.

Для удаления корневого каталога пространства имен используйте подкоманду sama-tool dfsn root remove (см. раздел «Управление пространствами имен»).

Параметры

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

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

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

  • --force — не запрашивать подтверждение операции.

Примеры

Пример удаления папки с запросом подтверждения:

samba-tool dfsn folder remove "\\\\elles.inno.tech\\namespace1\\documents"
Are you sure you want to perform this action?
Performing operation "Delete DFS Namespace folder" [Y/n]: y
Remove folder:
DFS path: \\elles.inno.tech\namespace1\documents
...
Result: SUCCESS

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

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

Получение списка папок

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

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

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

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

  • путь к папке в пространстве имен;

  • состояние:

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

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

  • период кэширования списков перенаправления клиентами;

  • список флагов, установленных в конфигурации папки:

    • Insite referrals — установлен флаг, указывающий на необходимость возвращать клиенту целевые ресурсы только в том же сайте, в котором он находится;

    • Target failback — установлен флаг, включающий автоматическое восстановление подключения к приоритетному целевому ресурсу;

  • описание.

Параметры

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

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

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

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

Примеры

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

samba-tool dfsn folder list "\\\\elles.inno.tech\\namespace1"
List DFS folders:
DFS path: \\elles.inno.tech\namespace1
...
Result:
\\elles.inno.tech\namespace1\documents
\\elles.inno.tech\namespace1\documents-archived

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

samba-tool dfsn folder list "\\\\elles.inno.tech\\namespace1" --extended
List DFS folders:
DFS path: \\elles.inno.tech\namespace1
...
Result:
\\elles.inno.tech\namespace1\documents
        DFS path:           \\elles.inno.tech\namespace1\documents
        State:              2 (Online)
        Properties:         Insite referrals, Target failback
        Time-to-live (sec): 300
        Comment:            DFS Folder
\\elles.inno.tech\namespace1\documents-archived
        DFS path:           \\elles.inno.tech\namespace1\documents-archived
        State:              2 (Online)
        Properties:         Insite referrals, Target failback
        Time-to-live (sec): 300
        Comment:            Archived DFS Folder