Cmdlets PowerShell (Modo do SharePoint do Reporting Services)

Artigo
06/03/2015

Quando você instala o modo do SharePoint do SQL Server 2012 Reporting Services, os cmdlets do PowerShell são instalados para oferecer suporte a servidores de relatório no modo do SharePoint. Os cmdlets abrangem três categorias de funcionalidade.

Instalação do serviço compartilhado e proxy do Reporting Services SharePoint.
Provisionando e gerenciamento de aplicativos de serviço Reporting Services e proxy associados.
Gerenciamento de recursos do Reporting Services, por exemplo, extensões e chave de criptografia.

Este tópico inclui o seguinte:

Cmdlet Summary
Shared Service Cmdlets
Service Application Cmdlets
Reporting Services functionality related Cmdlets
Basic Samples
Detailed Samples
- Create a service application and proxy
- Review and update a delivery extension
- Get and set Properties of the Reporting Service Application Database
- List Data Extensions
- Change and list subscription owners

Resumo do cmdlet

Para executar os cmdlets, é necessário abrir o Shell de Gerenciamento do SharePoint. Você também pode usar o editor de interface gráfica do usuário incluído no Microsoft Windows, o Ambiente de Script Integrado do Windows PowerShell (ISE). Para obter mais informações, consulte Starting Windows PowerShell on Windows Server (Iniciando o Windows PowerShell no Windows Server) (https://technet.microsoft.com/library/hh847814.aspx). Nos resumos de cmdlet a seguir, as referências a 'bancos de dados' de aplicativo de serviço referem-se a todos os bancos de dados criados e usados por um aplicativo de serviço Reporting Services. Isso inclui a os bancos de dados de configuração, alerta e temp.

Se uma mensagem de erro semelhante à seguinte for exibida quando você digitar os exemplos do PowerShell:

Install-SPRSService: O termo 'Install-SPRSService' não é reconhecido como o nome de cmdlet, função, arquivo de script ou programa operável. Verifique a ortografia do nome ou, se um caminho tiver sido incluído, verifique se ele está correto e tente novamente.

Um destes problemas está ocorrendo:

O modo do SharePoint do Reporting Services não está instalado e, portanto, os cmdlets do Reporting Services também não estão instalados.
Você executou o comando do PowerShell no Windows PowerShell ou no ISE do Windows PowerShell, e não no Shell de Gerenciamento do SharePoint. Use o Shell de Gerenciamento do SharePoint ou adicione o Snap-in do SharePoint à janela do Windows PowerShell com o seguinte comando:
```
Add-PSSnapin Microsoft.SharePoint.PowerShell
```

Para obter mais informações, consulte Usar o Windows PowerShell para administrar o SharePoint 2013 (https://technet.microsoft.com/library/ee806878.aspx).

Para abrir p Shell de Gerenciamento do SharePoint e executar cmdlets

Clique no botão Iniciar
Clique no grupo Produtos do Microsoft SharePoint.
Abra o Shell de Gerenciamento do SharePoint.

Para exibir a ajuda de linha de comando de um cmdlet, use o comando 'Get-Help' do PowerShell no prompt de comando do PowerShell. Por exemplo:

Get-Help Get-SPRSServiceApplicationServers

Ícone de seta usado com o link Voltar ao Início Top

Cmdlets de serviço compartilhado e proxy

A tabela a seguir contém os cmdlets PowerShell do serviço compartilhado Reporting Services SharePoint.

Cmdlet	Descrição
Install-SPRSService	Instala e registra, ou desinstala, o aplicativo do serviço compartilhado Reporting Services. Só pode ser feito em um computador que tenha o SQL Server Reporting Services instalado no modo integrado do SharePoint. Para instalação, há duas operações: O serviço Reporting Services é instalado no farm. A instância do serviço Reporting Services é instalada no computador atual. Para desinstalação, há duas operações: Desinstalar o serviço Reporting Services do computador atual. O serviço Reporting Services é desinstalado do farm. OBSERVAÇÃO: se houver outros computadores no farm que tenham o serviço Reporting Services instalado, ou se ainda houver aplicativos do serviço Reporting Services em execução no farm, uma mensagem de aviso será exibida.
Install-SPRSServiceProxy	Instala e registra, ou desinstala, o proxy do serviço Reporting Services no farm do SharePoint.
Obtém-SPRSProxyUrl	Obtém as URLs para acessar o serviço Reporting Services.
Get-SPRSServiceApplicationServers	Acessa todos os servidores no farm local do SharePoint que contém uma instalação do serviço compartilhado Reporting Services.

Ícone de seta usado com o link Voltar ao Início Top

Cmdlets de serviço de aplicativo e proxy

A tabela a seguir contém cmdlets PowerShell para aplicativos de serviço Reporting Services e seus proxies associados.

cmdlet	Descrição
Get-SPRSServiceApplication	Obtém um ou mais aplicativos de serviço Reporting Services.
New-SPRSServiceApplication	Cria um novo aplicativo do serviço Reporting Services e os bancos de dados associados. Parâmetro LogonType: especifica se o servidor de relatório usa a conta do Pool de Aplicativos SSRS ou um logon do SQL Server para acessar o banco de dados do servidor de relatório. Pode ser um dos seguintes: 0 Autenticação do Windows 1 SQL Server 2 Conta do pool de aplicativos (padrão)
Remove-SPRSServiceApplication	Remove o aplicativo do serviço Reporting Services especificado. Isso também removerá os bancos de dados associados.
Set-SPRSServiceApplication	Edita as propriedades de um aplicativo do serviço Reporting Services existente.
New-SPRSServiceApplicationProxy	Cria um novo proxy do aplicativo do serviço Reporting Services.
Get-SPRSServiceApplicationProxy	Obtém um ou mais proxies de aplicativo do serviço Reporting Services.
Dismount-SPRSDatabase	Desmonta os bancos de dados do aplicativo de serviço de um aplicativo do serviço Reporting Services.
Remove-SPRSDatabase	Remove os bancos de dados do aplicativo de serviço de um aplicativo do serviço Reporting Services.
Set-SPRSDatabase	Define as propriedades dos bancos de dados associados a um aplicativo do serviço Reporting Services.
Mount-SPRSDatabase	Monta bancos de dados para um aplicativo de serviço Reporting Services.
New-SPRSDatabase	Cria novos bancos de dados do aplicativo de serviço para o aplicativo do serviço Reporting Services especificado.
Get-SPRSDatabaseCreationScript	Imprime o script de criação do banco de dados na tela do banco de dados de aplicativo do serviço Reporting Services. Assim, você pode executar o script no SQL Server Management Studio.
Get-SPRSDatabase	Obtém um ou mais proxies de bancos de dados do aplicativo do serviço Reporting Services.
Get-SPRSDatabaseRightsScript	Imprime o script de direitos do banco de dados na tela do banco de dados de aplicativo do serviço Reporting Services. O usuário e o banco de dados desejados serão solicitados e o transact SQL que você pode executar para modificar permissões é retornado. Assim, você pode executar esse script no SQL Server Management Studio.
Get-SPRSDatabaseUpgradeScript	Gera um script de atualização de banco de dados na tela. O script atualizará os bancos de dados do aplicativo de serviço Reporting Services para a versão do banco de dados da instalação atual do Reporting Services.

Ícone de seta usado com o link Voltar ao Início Top

Cmdlets de funcionalidade personalizada do Reporting Services

Cmdlet	Descrição
Update-SPRSEncryptionKey	Atualiza a chave de criptografia do aplicativo do serviço Reporting Services especificado e recriptografa seus dados.
Restore-SPRSEncryptionKey	Restaura a chave de criptografia com backup anterior para um aplicativo do serviço Reporting Services.
Remove-SPRSEncryptedData	Exclui os dados criptografados do aplicativo do serviço Reporting Services especificado.
Backup-SPRSEncryptionKey	Atualiza a chave de criptografia do aplicativo de serviço especificado do Reporting Services e recriptografa seus dados.
New-SPRSExtension	Registra uma nova extensão com um aplicativo do serviço Reporting Services.
Set-SPRSExtension	Define as propriedades de uma extensão existente do Reporting Services.
Remove-SPRSExtension	Remove uma extensão de um aplicativo do serviço Reporting Services.
Get-SPRSExtension	Obtém uma ou mais extensões do Reporting Services para um aplicativo do serviço Reporting Services.
Get-SPRSSite	Acessa sites do SharePoint com base na habilitação ou não do recurso "ReportingService". Por padrão, os sites que habilitam o recurso "ReportingService" são retornados.

Exemplos básicos

Retorna uma lista de cmdlets que contém 'SPRS' no nome. Essa será a lista completa de cmdlets Reporting Services.

Get-command –noun *SPRS*

Ou com um pouco mais de detalhes, conectada a um arquivo de texto denominado commandlist.txt

Get-command -noun *SPRS*| select name, definition |Format-list | Out-File c:\commandlist.txt

Instala o serviço e o proxy de serviço do Reporting Services SharePoint.

Install-SPRSService

Install-SPRSServiceProxy

Inicie o serviço Reporting Services

get-spserviceinstance -all |where {$_.TypeName -like "SQL Server Reporting*"} | Start-SPServiceInstance

Digite o comando a seguir do SharePoint Management Shell para retornar uma lista filtrada de linhas de um arquivo de log. O comando filtrará por linhas que contêm “ssrscustomactionerror”. Este exemplo examina o arquivo de log criado quando o rssharepoint.msi foi instalado.

Get-content -path C:\Users\testuser\AppData\Local\Temp\rs_sp_0.log | select-string "ssrscustomactionerror"

Ícone de seta usado com o link Voltar ao Início Top

Exemplos detalhados

Além dos exemplos a seguir, consulte a seção "Script do Windows PowerShell" no tópico (Steps 1-4) Windows PowerShell script for Steps 1–4.

Criar um aplicativo de serviço e proxy

Este script de exemplo conclui as tarefas seguintes:

Cria um aplicativo de serviço e proxy Reporting Services. O script assume que o pool de aplicativos "My App Pool" já existe.
Adicione o proxy ao grupo proxy padrão.
Conceda o acesso de aplicativo de serviço à porta 80 ao banco de dados de conteúdo de aplicativo Web. O script assume que "http://sitename" de site já existe.

# Create service application and service application proxy
$appPool = Get-SPServiceApplicationPool “My App Pool”
$serviceApp = New-SPRSServiceApplication “My RS Service App” –ApplicationPool $appPool
$serviceAppProxy = New-SPRSServiceApplicationProxy –Name “My RS Service App Proxy” –ServiceApplication $serviceApp

# Add service application proxy to default proxy group.  Any web application that uses the default proxy group will now be able to use this service application.
Get-SPServiceApplicationProxyGroup –default | Add-SPServiceApplicationProxyGroupMember –Member $serviceAppProxy

# Grant application pool account access to the port 80 web application’s content database.
$webApp = Get-SPWebApplication “http://sitename”
$appPoolAccountName = $appPool.ProcessAccount.LookupName()
$webApp.GrantAccessToProcessIdentity($appPoolAccountName)

Revisar e atualizar uma extensão de entrega

O exemplo de script PowerShell a seguir atualiza a configuração da extensão de entrega de email do servidor de relatório para o aplicativo de serviço chamado My RS Service App. Atualize os valores do nome de servidor SMTP (<email server name>) e o alias de email FROM (<your FROM email address>).

$app=get-sprsserviceapplication -Name "My RS Service App"
$emailCfg = Get-SPRSExtension -identity $app -ExtensionType "Delivery" -name "Report Server Email" | select -ExpandProperty ConfigurationXml 
$emailXml = [xml]$emailCfg 
$emailXml.SelectSingleNode("//SMTPServer").InnerText = “<email server name>”
$emailXml.SelectSingleNode("//SendUsing").InnerText = "2"
$emailXml.SelectSingleNode("//SMTPAuthenticate").InnerText = "2"
$emailXml.SelectSingleNode("//From").InnerText = '<your FROM email address>'
Set-SPRSExtension -identity $app -ExtensionType "Delivery" -name "Report Server Email" -ExtensionConfiguration $emailXml.OuterXml

No exemplo acima, se você não sabia o nome exato do aplicativo de serviço, poderia reescrever a primeira instrução para obter o aplicativo de serviço com base em uma pesquisa de nome parcial. Por exemplo:

$app=get-sprsserviceapplication | where {$_.name -like " My RS Ser *"}

O script a seguir retornará os valores de configuração atual da extensão de entrega de email do servidor de relatório para o aplicativo de serviço chamado “My RS Service App”. A primeira etapa define o valor da variável $app para o objeto do aplicativo de serviço chamado "My RS Service App"

A segunda instrução obterá a extensão de entrega 'Email de Servidor de Relatório' para o objeto de aplicativo de serviço na variável $app e selecionará configurationXML

$app=get-sprsserviceapplication –Name "My RS Service App"
Get-SPRSExtension -identity $app -ExtensionType "Delivery" -name "Report Server Email" | select -ExpandProperty ConfigurationXml

Ícone de seta usado com o link Voltar ao Início Top

Get and set Properties of the Reporting Service Application Database (Propriedades get e set do banco de dados do aplicativo de serviço de relatório)

O exemplo a seguir primeiro retorna uma lista dos bancos de dados e propriedades para que seja possível determinar o guid do banco de dados (ID) que você fornecerá para o comando set. Para obter uma lista completa das propriedades, use Get-SPRSDatabase | format-list.

get-SPRSDatabase | select id, querytimeout,connectiontimeout, status, server, ServiceInstance

O item a seguir é um exemplo da saída. Determine a ID do banco de dados que você deseja modificar e use a ID no cmdlet SET.

Id : 56f8d1bc-cb04-44cf-bd41-a873643c5a14

QueryTimeout : 120

ConnectionTimeout : 15

Status : Online

Server : SPServer Name=uetestb01

ServiceInstance : SPDatabaseServiceInstance

Set-SPRSDatabase –identity 56f8d1bc-cb04-44cf-bd41-a873643c5a14 -QueryTimeout 300

Para verificar se o valor está definido, execute o cmdlet GET novamente.

Get-SPRSDatabase –identity 56f8d1bc-cb04-44cf-bd41-a873643c5a14 | select id, querytimeout,connectiontimeout, status, server, ServiceInstance

Ícone de seta usado com o link Voltar ao Início Top

Listar extensões de dados

O exemplo a seguir percorre cada aplicativo de serviço do Reporting Services e lista as extensões de dados atuais para cada um.

$apps = Get-SPRSServiceApplication
foreach ($app in $apps) 
{
Write-host -ForegroundColor "yellow" Service App Name $app.Name
Get-SPRSExtension -identity $app -ExtensionType “Data” | select name,extensiontype | Format-Table -AutoSize
}

Exemplo de saída:

Name ExtensionType

---- -------------

SQL Data

SQLAZURE Data

SQLPDW Data

OLEDB Data

OLEDB-MD Data

ORACLE Data

ODBC Data

XML Data

SHAREPOINTLIST Data