Unregister-PSSessionConfiguration

Модуль:
Microsoft.PowerShell.Core Module

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

Синтаксис

Default (По умолчанию) 

Unregister-PSSessionConfiguration
    [-Name] <String>
    [-Force]
    [-NoServiceRestart]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Описание

Этот командлет доступен только на платформе Windows.

Командлет Unregister-PSSessionConfiguration удаляет зарегистрированные конфигурации сеансов с компьютера. Этот командлет предназначен для системных администраторов для управления настраиваемыми конфигурациями сеансов для пользователей.

Чтобы изменить это изменение, Unregister-PSSessionConfiguration перезапускает службу WinRM. Чтобы предотвратить перезапуск, укажите параметр NoServiceRestart.

Если случайно удалить конфигурации сеансов по умолчанию Microsoft.PowerShell или Microsoft.PowerShell32, используйте командлет Enable-PSRemoting для их восстановления. Дополнительные сведения см. в about_Session_Configurations.

Примеры

Пример 1. Удаление конфигурации сеанса

В этом примере удаляется конфигурация сеанса MaintenanceShell с компьютера.

Unregister-PSSessionConfiguration -Name "MaintenanceShell"

Пример 2. Удаление конфигурации сеанса и перезапуск службы WinRM

В этом примере мы удалим конфигурацию MaintenanceShell и перезапустите службу WinRM. Параметр Force подавляет все пользовательские сообщения, чтобы перезапустить службу WinRM без запроса.

Unregister-PSSessionConfiguration -Name MaintenanceShell -Force

Пример 3. Удаление всех конфигураций сеанса

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

Unregister-PSSessionConfiguration -Name *
Get-PSSessionConfiguration -Name * | Unregister-PSSessionConfiguration

Пример 4. Отмена регистрации без перезапуска

В этом примере показано, как использовать параметр NoServiceRestart, чтобы предотвратить перезапуск службы, который приведет к нарушению сеансов на компьютере.

PS> Unregister-PSSessionConfiguration -Name "MaintenanceShell" -NoServiceRestart
PS> Get-PSSessionConfiguration -Name "MaintenanceShell"

Get-PSSessionConfiguration -Name MaintenanceShell : No Session Configuration matches criteria "MaintenanceShell".
+ CategoryInfo          : NotSpecified: (:) [Write-Error], WriteErrorException
+ FullyQualifiedErrorId : Microsoft.PowerShell.Commands.WriteErrorException

PS> New-PSSession -ConfigurationName "MaintenanceShell"

Id Name      ComputerName    State    Configuration         Availability
-- ----      ------------    -----    -------------         ------------
1 Session1  localhost       Opened   MaintenanceShell      Available

PS> Restart-Service winrm
PS> New-PSSession -ConfigurationName MaintenanceShell

[localhost] Connecting to remote server failed with the following error message :
 The WS-Management service cannot process the request.
 The resource URI (http://schemas.microsoft.com/powershell/MaintenanceShell) was not found in the WS-Management catalog.
 The catalog contains the metadata that describes resources, or logical endpoints.
 For more information, see the about_Remote_Troubleshooting Help topic.
 + CategoryInfo          : OpenError: (System.Manageme....RemoteRunspace:RemoteRunspace) [], PSRemotingTransportException
 + FullyQualifiedErrorId : PSSessionOpenFailed

Unregister-PSSessionConfiguration удаляет конфигурацию сеанса MaintenanceShell. Однако, так как команда использует параметр NoServiceRestart, служба WinRM не перезапускается, и изменение еще не является полностью эффективным.

Затем Get-PSSessionConfiguration пытается получить сеанс MaintenanceShell. Так как сеанс был удален из таблицы ресурсов WS-Management, Get-PSSessionConfiguration не может вернуть его.

Командлет New-PSSession создает сеанс с помощью конфигурации MaintenanceShell. Команда успешно выполнена. Затем мы перезагрузим службу WinRM.

Наконец, командлет New-PSSession пытается создать сеанс, использующий конфигурацию MaintenanceShell. На этот раз сеанс завершается ошибкой, так как конфигурация MaintenanceShell была удалена при перезапуске службы WinRM.

Параметры

-Confirm

Запрашивает подтверждение перед запуском cmdlet.

Свойства параметров

Тип:SwitchParameter
Default value:False
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:cf

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Force

Указывает, что командлет не запрашивает подтверждение и перезапускает службу WinRM без запроса. Перезапуск службы делает изменение конфигурации эффективным.

Чтобы предотвратить перезапуск и отключить запрос перезапуска, используйте параметр NoServiceRestart.

Свойства параметров

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Name

Задает имена конфигураций сеанса для удаления. Введите имя конфигурации одного сеанса или шаблон имени конфигурации. Разрешено использование подстановочных символов. Этот параметр является обязательным.

Можно также передать конфигурации сеанса в Unregister-PSSessionConfiguration.

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:True
DontShow:False

Наборы параметров

(All)
Position:0
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-NoServiceRestart

Указывает, что этот командлет не перезапускает службу WinRM и подавляет запрос на перезапуск службы.

По умолчанию при выполнении команды Unregister-PSSessionConfiguration вам будет предложено перезапустить службу WinRM, чтобы сделать это изменение эффективным. Пока служба WinRM не будет перезапущена, пользователи по-прежнему могут использовать незарегистрированную конфигурацию сеанса, даже если Get-PSSessionConfiguration не находит ее.

Чтобы перезапустить службу WinRM без запроса, укажите параметр Force. Чтобы перезапустить службу WinRM вручную, используйте командлет Restart-Service.

Свойства параметров

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-WhatIf

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

Свойства параметров

Тип:SwitchParameter
Default value:False
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:wi

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

Входные данные

Microsoft.PowerShell.Commands.PSSessionConfigurationCommands

Объект конфигурации сеанса можно передать в этот командлет.

Выходные данные

None

Этот командлет не возвращает выходные данные.

Примечания

Этот командлет доступен только на платформах Windows.

Чтобы запустить этот командлет, необходимо запустить PowerShell с помощью параметра запуска от имени администратора.