Поддержка PowerShell для локальных кластеров шлюза данных

Скрипты PowerShell доступны в коллекции PowerShell. Скрипты, описанные в этой статье, предназначены для PowerShell версии 5. При использовании PowerShell версии 7, обратитесь к командлетам PowerShell для управления локальным шлюзом данных. Скрипты PowerShell можно использовать для выполнения следующих операций:

  • Получение списка кластеров шлюза, доступных для пользователя.
  • Получение списка экземпляров шлюза, зарегистрированных в кластере, и их состояния — в сети или в автономном режиме.
  • Измените статус включения или отключения экземпляра шлюза в кластере, а также другие свойства шлюза.
  • удаление шлюза.

Выполнение команд PowerShell

Чтобы установить эти командлеты, выполните следующую команду в PowerShell с повышенными правами:

Install-Module -Name OnPremisesDataGatewayHAMgmt

Весь список командлетов можно найти с помощью следующей команды:

Get-Command -Module OnPremisesDataGateway*

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

get-help <cmdlet-name>

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

Команда Описание Параметры
Login-OnPremisesDataGateway Используйте эту команду для входа в систему для управления кластерами локальных шлюзов данных. Перед правильной работой других команд высокой доступности необходимо выполнить эту команду и войти в систему. Примечание. Маркер проверки подлинности идентификатора Microsoft Entra, полученный в рамках login вызова, действителен только в течение 1 часа, после чего срок действия истекает. Вы можете повторно запустить login команду, чтобы получить новый токен. Имя пользователя и пароль Microsoft Entra ID (предоставляются как часть выполнения команды, а не начального вызова команды).
Get-OnPremisesDataGatewayClusters Извлекает список кластеров шлюзов для пользователя, вошедшего в систему. При необходимости можно передать параметры форматирования этой команде для повышения удобочитаемости, например Format-Table -AutoSize -Wrap.
Get-OnPremisesDataClusterGateways Извлекает список шлюзов в указанном кластере и дополнительные сведения для каждого шлюза, такие как состояние (в сети или автономно) и имя компьютера. -ClusterObjectID xyz (где xyz заменяется фактическим значением идентификатора объекта кластера, которое можно получить с помощью команды Get-OnPremisesDataGatewayClusters ).
Set-OnPremisesDataGateway Используйте эту команду, чтобы задать значения свойств для заданного шлюза в кластере, что включает возможность включать или отключать конкретный экземпляр шлюза. -ClusterObjectID xyz (где xyz заменяется фактическим значением идентификатора объекта кластера, которое можно получить с помощью команды Get-OnPremisesDataGatewayClusters ).

-GatewayObjectID abc (где abc заменяется фактическим значением идентификатора объекта шлюза, которое можно получить с помощью команды Get-OnPremisesDataClusterGateways с идентификатором объекта кластера).
Get-OnPremisesDataGatewayStatus Используйте эту команду, чтобы получить состояние для данного экземпляра шлюза в кластере. -ClusterObjectID xyz (где xyz заменяется фактическим значением идентификатора объекта кластера, которое можно получить с помощью команды Get-OnPremisesDataGatewayClusters ).

-GatewayObjectID abc (где abc заменяется фактическим значением идентификатора объекта шлюза, которое можно получить с помощью команды Get-OnPremisesDataClusterGateways с идентификатором объекта кластера).
Remove-OnPremisesDataGateway Используйте эту команду для удаления экземпляра шлюза из кластера. Примечание. Основной шлюз в кластере нельзя удалить, пока все остальные шлюзы в кластере не будут удалены. -ClusterObjectID xyz (где xyz заменяется фактическим значением идентификатора объекта кластера, которое можно получить с помощью команды Get-OnPremisesDataGatewayClusters ).

-GatewayObjectID abc (где abc заменяется фактическим значением идентификатора объекта шлюза, которое можно получить с помощью команды Get-OnPremisesDataClusterGateways с идентификатором объекта кластера).

Связанный контент

  • Last updated on