Começar com cmdlets do Gestor de Configuração

Artigo
08/11/2021

Aplica-se a: Configuration Manager (ramo atual)

Utilize Windows PowerShell para gerir a sua hierarquia de Gestor de Configuração. Pode utilizar scripts PowerShell para automatizar ou estender o Gestor de Configuração semelhante a outras abordagens documentadas utilizando WMI e C#. Para obter mais informações, consulte o Gestor de Configuração SDK.

Executar cmdlets e scripts do Gestor de Configuração em PowerShell a partir da consola Do Gestor de Configuração ou de uma sessão de Windows PowerShell. Quando executa os cmdlets do Gestor de Configuração utilizando a consola 'Gestor de Configuração', a sessão é executada automaticamente no contexto do site.

Nota

Todas as versões suportadas atualmente do suporte de filial do Gestor de Configuração Windows PowerShell versão 5.1. Se já instalou a versão 7 do PowerShell, ainda pode utilizar a versão 5.1 do PowerShell. Para obter mais informações, consulte utilizar o PowerShell 7 lado a lado com Windows PowerShell 5.1.

A partir da versão 2010, a biblioteca cmdlet PowerShell do Gestor de Configuração suporta o PowerShell 7. Para obter mais informações, consulte Suporte para powerShell versão 7.

A partir da versão 2103, o módulo PowerShell De Configuração requer a versão 4.7.2 ou posterior da Microsoft .NET.

PowerShell da consola Do Gestor de Configuração

O método mais fácil de abrir o PowerShell é diretamente da consola Do Gestor de Configuração.

Lançar a consola Do Gestor de Configuração. No canto superior esquerdo, há um retângulo azul. Selecione a seta branca no retângulo azul e escolha Ligação através de Windows PowerShell.
Depois de Windows PowerShell cargas, verá uma solicitação que contém o seu código de site. Por exemplo, se o código do site for "ABC", o pedido parece: PS ABC:\>
Para verificar se funciona, utilize o cmdlet Get-CMSite. Este cmdlet retorna informações sobre o site do Gestor de Configuração a que está atualmente ligado e quaisquer sites infantis. Por exemplo, o nome do servidor do site, o diretor de instalação, o nome do site e a versão.

Importar o módulo PowerShell do Gestor de Configuração

Ligação ao Gestor de Configuração de uma sessão de Windows PowerShell existente carregando manualmente o módulo 'Gestor de Configuração'.

Abra uma sessão de Windows PowerShell do menu Iniciar.
Importe o módulo Gestor de Configuração utilizando o cmdlet do Módulo de Importação. Especifique o caminho para o módulo Gestor de Configuração ou altere para o diretório que contém o módulo. Por predefinição, o módulo encontra-se no seguinte caminho: C:\Program Files (x86)\Microsoft Endpoint Manager\AdminConsole\bin\ConfigurationManager.psd1
Importante

Este caminho mudou a partir da versão 1910 para utilizar a Microsoft Endpoint Manager pasta. Certifique-se de que não importa uma versão mais antiga do módulo que pode existir noutra pasta. Depois de importar o módulo, utilize os seguintes comandos para verificar a versão e o caminho do módulo:
```
(Get-Module -Name ConfigurationManager).Version
(Get-Module -Name ConfigurationManager).Path
```
O exemplo a seguir altera-se no diretório do módulo e, em seguida, importa-o:
```
Set-Location 'C:\Program Files (x86)\Microsoft Endpoint Manager\AdminConsole\bin'
Import-Module .\ConfigurationManager.psd1
```
Dica

Também pode utilizar a variável ambiente SMS_ADMIN_UI_PATH. Por exemplo:
```
Set-Location "$env:SMS_ADMIN_UI_PATH\..\"
```
Além disso, pode utilizar o pseudónimo do CD para alterar diretórios em vez do cmdlet Set-Location.
Se for a primeira vez que importa o módulo Gestor de Configuração neste computador, poderá ter de criar a unidade do site. Por exemplo:
```
New-PSDrive -Name "ABC" -PSProvider "AdminUI.PS.Provider\CMSite" -Root "siteserver.contoso.com" -Description "Primary site"
```
Dica

Quando inicias o PowerShell a partir da consola, cria automaticamente o PSDrive como uma conveniência para o site atualmente ligado. Se estiver numa hierarquia, use o New-PSDrive para criar unidades para cada site.
Para executar os cmdlets do Gestor de Configuração, tem de mudar o caminho para o site do Gestor de Configuração. No exemplo seguinte, o código do site ABC é:
```
Set-Location ABC:
```
Confirme se o PowerShell carregou corretamente o módulo 'Gestor de Configuração', utilizando o cmdlet Get-CMSite.

Atualizar ajuda

A partir da versão 2010, para obter as informações mais recentes para o módulo PowerShell do Gestor de Configuração, utilize o cmdlet Update-Help. Este conteúdo é o mesmo que é publicado no docs.microsoft.com para o módulo ConfigurationManager.

Importante

Devido a uma alteração na forma como o conteúdo atualização é estruturado e publicado com o lançamento da versão 2103, não utilize o Update-Help num site de versão 2010. Atualize o site para a versão 2103 e, em seguida, atualize o conteúdo da ajuda local.

Para obter mais informações, consulte as notas de lançamento da versão 2103 da PowerShell.

O computador em que executou este cmdlet necessita de acesso à Internet, pshelpprod.blob.core.windows.net especificamente. Em seguida, executar o seguinte comando a partir de uma sessão elevada powerShell:

Update-Help -Module ConfigurationManager

Depois de atualizar a ajuda cmdlet do Gestor de Configuração, pode obter ajuda sobre os cmdlets utilizando o cmdlet Get-Help. Por exemplo:

Get-Help Get-CMDevice
Get-Help Get-CMDevice -Examples
Get-Help Get-CMDevice -Parameter *

Para mais informações, consulte a seguinte publicação de blogue PowerShell: You've got Help!

Parâmetros comuns

Todos os cmdlets do Gestor de Configuração suportam os parâmetros comuns do PowerShell:

Depurar
ErrorAction
ErroVariável
InformaçãoAcção
Informação Variavel
OutVariable
OutBuffer
PipelineVariable
Verboso
Advertência
AdvertênciaVariável

Para mais informações, consulte about_CommonParameters.

Suporte para powerShell versão 7

A partir da versão 2010, a biblioteca cmdlet PowerShell do Gestor de Configuração suporta a versão 7 do PowerShell. Para obter mais informações sobre o PowerShell 7, incluindo instruções sobre como descarregar e instalar, consulte instalar o PowerShell no Windows.

Dica

PowerShell 7 funciona como pwsh.exe . As versões anteriores do PowerShell funcionam como powershell.exe .

Cmdlets que não suportam a versão 7 do PowerShell

Os seguintes cmdlets não suportam PowerShell 7:

Import-CMPackage
Import-CMDriverPackage
Import-CMTaskSequence
Export-CMPackage
Export-CMDriverPackage
Export-CMTaskSequence

Exigem o .NET Framework em vez de .NET Core que é usado com a versão 7 do PowerShell.

A partir da versão 2103, se tentar utilizar estes cmdlets numa sessão da versão 7 da PowerShell, eles falham com o seguinte erro: This cmdlet only supports the ".NET Framework" runtime.

Problemas conhecidos com a versão 7 da PowerShell

Não é possível lançar o PowerShell 7 diretamente a partir da consola Do Gestor de Configuração. Iniciar manualmente o PowerShell 7 e, em seguida, importar o módulo Gestor de Configuração.
O suporte atual é apenas para os cmdlets do Gestor de Configuração. Outras funcionalidades do Gestor de Configuração que dependem do PowerShell podem não suportar a versão 7. Por exemplo, executar scripts, CMPivotou o passo da sequência de tarefas do Script de Execução PowerShell.

Feedback para PowerShell

Se tiver feedback sobre os cmdlets PowerShell do Gestor de Configuração, utilize as mesmas opções na consola 'Gestor de Configuração' para enviar feedback. Para mais informações, consulte o feedback do Produto.

Quando enviar uma franja, inclua as seguintes informações adicionais específicas da PowerShell:

A sintaxe exata do script ou do comando que usou para que a Microsoft possa tentar reproduzir o problema.
Que comportamento esperavas comparado com o comportamento real.
A saída completa quando a executou com o parâmetro comum verbose.
A versão e o caminho do módulo ConfigurationManager. Por exemplo, incluir a saída dos seguintes comandos:
```
(Get-Module -Name ConfigurationManager).Version
(Get-Module -Name ConfigurationManager).Path
```
Se um cmdlet retornar um erro, utilize o seguinte comando para obter detalhes de exceção:
```
$Error[0].Exception | Format-List * -Force
```

Notas de lançamento de pré-visualização

O artigo de pré-visualização técnica na biblioteca de documentação principal inclui notas de lançamento para PowerShell. Por exemplo, consulte a versão técnica de pré-visualização 2106.

Passos seguintes

Para obter mais informações sobre o que mudou no lançamento mais recente do Gestor de Configuração, selecione as últimas Notas de Lançamento da tabela de conteúdos.

Para obter mais informações sobre os cmdlets individuais, consulte a referência cmdlet do Gestor de Configuração.

Para obter mais informações sobre a aprendizagem e começar com Windows PowerShell, consulte PowerShell 101.