Como exibir informações detalhadas de ajuda sobre os comandos do PowerShell

Existem várias maneiras de encontrar informações de ajuda para os comandos disponíveis do PowerShell. Basta iniciar um console do PowerShell, importar o módulo STProtect e digitar qualquer um dos comandos a seguir. A instalação do Security Controls inclui documentação de ajuda completa e localizada.

Exibir a lista completa de comandos disponíveis

PS C:\> (Get-Module -Name STProtect).ExportedCommands

Os comandos disponíveis são:

  • Add-MachineGroup: adiciona um novo grupo de máquinas com o nome, a descrição e o caminho especificados.
  • Add-MachineGroupItem: adiciona ou atualiza um conjunto de nomes de máquina resolvíveis em um grupo de máquinas. É suportada a opção para especificar explicitamente as credenciais e definir o status incluir/excluir.
  • Add-PatchGroup: adiciona um novo grupo de patches.
  • Add-PatchGroupItem: adiciona patches a um grupo de patches existente.
  • Add-STCredential: adiciona uma credencial ao repositório de credenciais do usuário atual para uso em operações de implantação e patch.
  • Format-PatchDeployTable: formata o resultado de uma implantação de patch em uma tabela contendo informações operacionais de nível superior e estatísticas resumidas das máquinas.
  • Format-PatchScanTable: formata o resultado de uma análise de patch em uma tabela contendo informações operacionais de nível superior e estatísticas resumidas das máquinas.
  • Get-MachineGroup: se um nome for fornecido, um grupo de máquinas será recuperado pelo nome. Caso contrário, serão retornados todos os grupos de máquinas definidos.
  • Get-PatchDeploy: interroga o repositório de dados para recuperar informações de implantação de patch registradas, incluindo os estados de implantação de máquinas individuais. São recuperadas informações parciais se a implantação de patch estiver em andamento.
  • Get-PatchGroup: obtém informações do grupo de patches.
  • Get-PatchScan: interroga o repositório de dados para recuperar informações de análise de patch registradas, incluindo estatísticas resumidas de máquinas individuais. São recuperadas informações parciais se a análise de patch estiver em andamento.
  • Get-PatchScanTemplate: se um nome for fornecido, um modelo de análise de patch será recuperado pelo nome. Caso contrário, todos os modelos de análise de patch definidos serão exibidos.
  • Get-STCredential: obtém uma ou mais referências de credencial a partir do repositório de credenciais do usuário atual, de acordo com os critérios. Se nenhum critério for especificado, todas as referências de credencial serão exibidas.
  • Get-VendorFamilyProductHierarchy: recupera os pares de nome e id para incluir/excluir fornecedores, famílias e produtos usando New-VendorFamilyProduct.
  • Invoke-DownloadMissingPatches: baixa todos os patches ausentes detectados em uma análise de patch. Se um patch já tiver sido baixado para o repositório de patches, nenhuma ação será realizada nesse patch.
  • Invoke-PowerStateDeploy: executa uma tarefa de gerenciamento de energia nas máquinas-alvo especificadas. É possível usar uma combinação de nomes de pontos de extremidade explicitamente definidos e/ou grupos de máquinas predefinidos para especificar os alvos.
  • Invoke-WakeOnLan: inicia uma nova operação Wake-On-LAN nas máquinas-alvo especificadas. Os alvos especificados devem ter passado por uma análise de ativos de hardware para identificar o endereço de MAC.
  • New-PatchFilter: cria um novo filtro de patches. Os filtros criados com este comando são usados como entrada para New-PatchScanTemplate ou Set-PatchScanTemplate.
  • New-PatchPropertyFilter: cria um filtro de detecção de patch com base nas propriedades do patch. Os filtros criados com este comando são usados como entrada para New-PatchFilter.
  • New-PatchScanTemplate: cria um novo modelo de análise de patch
  • New-VendorFamilyProductFilter: cria um novo filtro de produtos da família do fornecedor.
  • Remove-MachineGroup: remove um grupo de máquinas e todos os itens filhos.
  • Remove-MachineGroupItem: remove um conjunto de nomes de máquina resolvíveis de um grupo de máquinas.
  • Remove-PatchGroup: exclui as informações do grupo de patches.
  • Remove-PatchGroupItem: remove patches de um grupo de patches existente.
  • Remove-PatchScanTemplate: remove o modelo de análise de patch com o nome especificado.
  • Remove-STCredential: remove uma credencial do repositório de credenciais. Apenas credenciais pertencentes ao usuário atual podem ser removidas.
  • Set-MachineGroupCredential: define ou remove a credencial de nível superior de um grupo máquinas, usada como credencial padrão para todas as máquinas definidas no grupo. Esta credencial é usada apenas quando nenhuma credencial de ponto de extremidade ou de máquina tiver sido especificada.
  • Set-PatchScanTemplate: atualiza um modelo de análise de patch.
  • Start-PatchDeploy: coloca na fila uma nova operação de patch para implantar todos os patches identificados em uma análise de patch.
  • Start-PatchScan: coloca na fila uma nova operação de análise de patch para as máquinas-alvo especificadas. É possível usar uma combinação de nomes de pontos de extremidade explicitamente definidos e/ou grupos de máquinas predefinidos para especificar os alvos.
  • Stop-PatchDeploy: cancela uma operação de implantação de patch ativa.
  • Stop-PatchScan: cancela uma operação de análise de patch ativa.
  • Update-STCredential: atualiza uma credencial no repositório de credenciais do usuário atual para uso em operações de implantação e patch.
  • ValidateElementsNotNullOrWhiteSpace:
  • ValidateNotNullOrWhiteSpace:
  • ValidatePSCustomObjectType:
  • Wait-PatchDeploy: aguarda a conclusão de uma operação de implantação de patch ativa.
  • Wait-PatchScan: aguarda a conclusão de uma operação de análise de patch ativa.
  • Watch-PatchDeploy: monitora uma operação de implantação de patch ativa, relatando o andamento e o status periodicamente até que ela seja concluída. A operação, o status, a porcentagem de conclusão e o tempo decorrido na implantação do patch são relatados conforme o andamento.
  • Watch-PatchScan: monitora uma operação de análise de patch ativa, relatando o andamento e o status periodicamente até que ela seja concluída. A operação, o status, a porcentagem de conclusão e o tempo decorrido na análise de patch são relatados conforme o andamento.

Exibir ajuda detalhada para um comando individual

PS C:\> Get-Help <command> -detailed

Exibir ajuda completa para todos os comandos

PS C:\> (Get-Module STProtect).ExportedCommands.Values | ForEach-Object { $_ | Get-Help –Full}

Para direcionar a saída em um arquivo de texto:

PS C:\> (Get-Module STProtect).ExportedCommands.Values | ForEach-Object { $_ | Get-Help –Full} | Out-File “C:\SampleDirectory\HelpOutputFull.txt”