Поддержка PowerShell для кластеров локальных шлюзов данных
Скрипты PowerShell доступны в коллекции PowerShell. Скрипты, описанные в этой статье, предназначены для PowerShell версии 5. При использовании PowerShell версии 7 ознакомьтесь со статьей Командлеты PowerShell для управления локальным шлюзом данных. Скрипты PowerShell можно использовать для выполнения следующих операций:
- получение списка кластеров шлюзов, доступных для пользователя;
- получение списка экземпляров шлюзов, зарегистрированных в кластере, и сведений об их статусе ("В сети" или "Вне сети");
- изменение статуса "Включено" или "Отключено" и других свойств шлюза для экземпляра шлюза в кластере;
- удаление шлюза.
Выполнение команд PowerShell
Чтобы установить эти командлеты, выполните следующую команду в сеансе PowerShell с повышенными правами:
Install-Module -Name OnPremisesDataGatewayHAMgmt
Полный список командлетов можно найти с помощью следующей команды:
Get-Command -Module OnPremisesDataGateway*
Примеры и описания включены в командлеты, доступ к которым можно получить с помощью следующей команды:
get-help <cmdlet-name>
Теперь вы можете использовать команды в следующей таблице для управления кластерами шлюзов.
Command | Description | Параметры |
---|---|---|
Login-OnPremisesDataGateway | Используйте эту команду для входа в систему для управления кластерами локальных шлюзов данных. Для надлежащего выполнения других команд высокого уровня сначала нужно запустить эту команду и войти в систему. Примечание. Маркер проверки подлинности идентификатора Microsoft Entra, полученный в рамках login вызова, действителен только в течение 1 часа, после чего срок действия истекает. Вы можете повторно запустить login команду, чтобы получить новый токен. |
Имя пользователя и пароль идентификатора Microsoft Entra (предоставляется как часть выполнения команды, а не начальное вызов). |
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, указав идентификатор объекта кластера). |