Administração de cache com Windows PowerShell (Cache do Windows Server AppFabric)

  • Artigo

Com o Windows PowerShell, você pode administrar o cluster de cache, os hosts de cache e o cache em si. Se você estiver usando um computador com o recurso Administração de Cache instalado, existem duas maneiras de usar o Windows PowerShell para gerenciar os recursos de cache do AppFabric. No Menu Iniciar, vá para Ferramentas Administrativas e selecione Módulos do Windows PowerShell. Ou então, você pode ir para o Menu Iniciar, clicar em Todos os Programas, em Windows Server AppFabric e em Windows PowerShell de Administração de Cache.

Observação

Nos sistemas operacionais Windows Vista, Windows 7 e Windows Server 2008, execute o Windows PowerShell com privilégios administrativos para que alguns comandos de administração funcionem corretamente. Para o atalho Windows PowerShell de Administração de Cache, clique com o botão direito do mouse no atalho e selecione Executar como administrador.

Existem duas categorias principais de comandos do PowerShell de armazenamento em cache do AppFabric: comandos de administração e comandos de configuração. Este tópico se concentra nos comandos de administração. Para obter mais informações sobre os comandos de configuração, consulte Configuração de cache com Windows PowerShell (Cache do Windows Server AppFabric). As tabelas deste tópico dividem os comandos de administração em categorias. Alguns comandos são apresentados em mais de uma tabela, mostrando como os diferentes parâmetros são aplicados a cada uma das quatro categorias de comandos:

  • Comandos relacionados ao cluster de cache

  • Comandos relacionados ao host de cache

  • Comandos relacionados ao cache

  • Comandos de Gerenciamento do Console

Obtendo ajuda na sessão do Windows PowerShell

As informações a seguir fornecem um resumo dos comandos de administração referentes aos recursos de cache do AppFabric. É importante saber que você pode obter ajuda dentro de sua sessão do Windows PowerShell também. Por exemplo, o seguinte comando exibe todos os comandos de administração:

get-command -module DistributedCacheAdministration

Se você precisar de ajuda sobre um comando específico, use o comando get-help. Por exemplo, o seguinte comando exibe a ajuda completa do comando New-Cache:

get-help New-Cache -full

Considerações importantes

Ao usar os comandos do Windows PowerShell descritos neste tópico, é importante considerar os seguintes pontos:

  • A identidade de segurança da pessoa que está usando esses comandos do Windows PowerShell deve ter privilégios de administrador em todos os servidores de cache do cluster de cache.

  • Os valores de parâmetro dos comandos fazem distinção entre maiúsculas e minúsculas. Por exemplo, se você criar um cache denominado NamedCache1, o comando Get-CacheConfig -CacheName namedcache1 não funcionará. Faça a correspondência de maiúsculas e minúsculas, como em Get-CacheConfig -CacheName NamedCache1.

  • Ao fazer alterações de configuração de cluster baseada em XML com os comandos Export-CacheClusterConfig e Import-CacheClusterConfig, você pode alterar as definições de configuração de cluster (atributos XML) no arquivo XML, mas não há suporte para adicionar ou remover caches nomeados e hosts de cache inserindo ou removendo elementos XML.

  • Os comandos de cluster de cache Start-CacheCluster, Stop-CacheCluster e Restart-CacheCluster envolvem a coordenação do estado do serviço do Windows de host de cache em todos os servidores de cache do cluster. A execução desses comandos pode levar mais tempo quando os hosts principais executam a função de gerenciamento de cluster. É necessário que exista uma maioria de hosts principais em execução enquanto o restante dos hosts de cache são interrompidos e iniciados.

  • Sempre inicie e pare o Serviço de Cache com os comandos de cluster de cache Start-CacheCluster, Stop-CacheCluster e Restart-CacheCluster. Poderá ocorrer uma parada se o serviço for iniciado e interrrompido a partir da ferramenta administrativa de serviços. Além disso, esses comandos devem ser executados em uma sessão elevada do Windows PowerShell com privilégios administrativos.

  • Os comandos de cluster de cache Stop-CacheCluster ou Restart-CacheCluster fazem com que todos os dados sejam liberados da memória de todos os hosts de cache no cluster.

  • Os comandos Set-CacheConfig e Import-CacheClusterConfig exigem que você reinicie o cluster de cache com Restart-CacheCluster para que as alterações sejam efetuadas.

  • Os comandos Remove-Cache e New-Cache podem ser usados para alterar uma configuração de cache nomeado sem impactar outros caches nomeados no cluster.

Comandos relacionados ao cluster de cache

A tabela a seguir lista os comandos do Windows PowerShell de Administração de Cache disponíveis para executar operações relacionadas ao cluster.

Comando Descrição

Use-CacheCluster

Define o contexto de sua sessão do Windows PowerShell para o cluster de cache desejado.

Quando você iniciar uma sessão do Windows PowerShell, primeiro execute esse comando. Se ele estiver em um host de cache, você deverá executar o comando sem parâmetros, uma vez que eles serão obtidos da configuração de cache do computador. Se você estiver executando o comando de um computador não host, poderá usar os parâmetros a seguir para especificar o cluster de cache desejado.

As descrições de parâmetro (alias) são:

  • Provider (P): o provedor usado para armazenar as definições de configuração do cluster. Ela pode ser System.Data.SqlClient ou XML, dependendo de como as informações de configuração estão armazenadas.

  • ConnectionString (C): a cadeia de conexão para o banco de dados ou local do arquivo de configuração XML.

Start-CacheCluster

Inicia todos os serviços de cache no cluster. Os hosts principais são iniciados primeiro. Observe que os serviços de cache não são iniciados automaticamente após uma reinicialização e, sendo assim, Start-CacheCluster ou Start-CacheHost deve ser chamado para iniciar o serviço. Esse comando exige privilégios de administrador.

Stop-CacheCluster

Interrompe todos os serviços de cache no cluster. Esse comando exige privilégios de administrador.

Restart-CacheCluster

Reinicia todos os serviços de cache do cluster na sequência correta. Esse comando exige privilégios de administrador.

Get-CacheClusterHealth

Retorna estatísticas sobre a integridade do cluster de cache.

Export-CacheClusterConfig

Projetado para ser usado junto com Import-CacheClusterConfig, esse comando permite editar as definições de configuração de cluster com XML. Para obter mais informações, consulte Editar definições de configuração de cluster (Cache do Windows Server AppFabric).

Esse comando exporta as definições de configuração de cluster, como elas existem atualmente no cluster, para o arquivo de configuração baseado em XML especificado. Esse comando pode ser usado independentemente de onde você optou por armazenar suas definições de configuração de cluster (SQL Server ou pasta de rede compartilhada).

A descrição do parâmetro (alias) é:

  • File (F): o caminho e o nome totalmente qualificado do arquivo de configuração baseado em XML a ser criado, descrevendo as definições atuais de configuração do cluster de cache.

Exemplo: Export-CacheClusterConfig -File c:\Temp\CurrentClusterConfig.xml

Import-CacheClusterConfig

Projetado para ser usado junto com Export-CacheClusterConfig, esse comando permite editar as definições de configuração de cluster com XML. Para obter mais informações, consulte Editar definições de configuração de cluster (Cache do Windows Server AppFabric).

Esse comando importa as definições de configuração de cluster conforme descrito no arquivo de configuração baseado em XML especificado. Esse comando pode ser usado independentemente de onde você optou por armazenar suas definições de configuração de cluster (SQL Server ou pasta de rede compartilhada).

Reinicie o cluster com o Restart-CacheCluster para que as alterações sejam efetivadas.

A descrição do parâmetro (alias) é:

  • File (Fi): o caminho e o nome totalmente qualificado do arquivo de configuração baseado em XML que descreve as definições de configuração do cluster de cache a serem aplicadas ao cluster.

  • Force (Fo): importa o arquivo de configuração sem solicitar confirmação.

Exemplo: Import-CacheClusterConfig -File c:\CurrentClusterConfig.xml

Grant-CacheAllowedClientAccount

Concede um acesso de conta do Windows ao cluster de cache. Por padrão, qualquer conta de administrador nos hosts de cache tem acesso ao cluster de cache. Outras contas devem ser explicitamente adicionadas à lista de contas de cliente permitidas usando esse comando.

A descrição do parâmetro (alias) é:

  • Account (A): a conta do Windows para conceder acesso ao cluster de cache.

  • Force (F): adiciona a conta de cliente especificada sem validar se ela existe.

Revoke-CacheAllowedClientAccount

Revoga um acesso de conta do Windows ao cluster de cache. Isso não impedirá os administradores nos hosts de cache de acessar o cluster de cache.

A descrição do parâmetro (alias) é:

  • Account (A): a conta do Windows para conceder acesso ao cluster de cache.

Get-Cache

Quando usado sem parâmetros, lista informações sobre todos os caches contidos no cluster de cache.

Observação

Consulte a próxima tabela para obter informações sobre como usar esse comando com o parâmetro HostName.

Comandos relacionados ao host de cache

A tabela a seguir lista os comandos disponíveis para executar operações relacionadas ao host de cache no Windows PowerShell.

Comando Descrição

Get-CacheHost

Lista informações sobre o host de cache especificado. Se nenhum parâmetro for aprovado, todos os serviços de cache que são membros do cluster de cache serão listados.

As descrições de parâmetro (alias) são:

  • HostName (H): o nome do host de cache.

  • CachePort (P): o número da porta de cache do host de cache.

Exemplo: Get-CacheHost

Get-CacheHostConfig

Retorna as informações de configuração sobre o host de cache especificado.

As descrições de parâmetro (alias) são:

  • HostName (H): o nome do host de cache.

  • CachePort (P): o número da porta de cache do host de cache.

Exemplo: Get-CacheConfig -HostName CacheServer1 -CachePort 22233

Set-CacheHostConfig

Atualiza a configuração do host de cache para os valores especificados nos parâmetros de comando. Exceto para HostName e CachePort, todos os parâmetros são opcionais. Para obter mais informações, consulte Editar definições de configuração de cluster (Cache do Windows Server AppFabric).

As descrições de parâmetro (alias) são:

  • HostName (H): o nome do host de cache.

  • CachePort (P): o número atual da porta de cache do host de cache.

  • ClusterPortNumber (CPort): o número da porta de cluster usado pelo host de cache.

  • ArbitratorPortNumber (APort): o novo número da porta de arbitragem.

  • ReplicationPortNumber (RPort): o novo número da porta de replicação.

  • CacheSize (Size): a quantidade total de memória alocada para armazenar dados no host de cache, em unidades de megabytes (MB).

  • HWM (HWM): a porcentagem de marca d' água alta de memória, quando a remoção deve começar a eliminar objetos que ainda não expiraram.

  • LWM (LWM): a porcentagem de marca d' água baixa de memória, quando a remoção deve começar a eliminar objetos expirados. Depois de atingir HWM, quando a remoção deve parar de eliminar objetos que ainda não expiraram.

Exemplo: Set-CacheConfig -HostName CacheServer1 -CachePort 22233 -LowWM 80

Start-CacheHost

Inicia o serviço de cache especificado. Após a reinicialização do servidor de cache, esse comando é obrigatório para permitir que o serviço de cache inclua novamente um cluster de cache em execução. Observe que se o cluster de cache estiver desativado, você deverá usar o comando Start-CacheCluster. Além disso, os serviços de cache não são iniciados automaticamente após uma reinicialização e, sendo assim, Start-CacheHost ou Start-CacheCluster deve ser chamado para iniciar o serviço.

As descrições de parâmetro (alias) são:

  • HostName (HostN): o nome do host de cache.

  • CachePort (P): o número da porta de cache do host de cache.

  • HostTimeout(T): o valor de tempo limite em segundos para o host de cache especificado ser iniciado. O padrão é 60 segundos.

Exemplo: Start-CacheHost -HostName CacheServer1 -CachePort 22233

Stop-CacheHost

Interrompe o serviço de cache especificado.

Observação

O comando Stop-CacheHost não interromperá um serviço do Windows de host de cache se ele estiver executando a função de gerenciamento de cluster. A interrupção do host de cache fará com que todo o cluster seja encerrado. Para obter mais informações, consulte Hosts principais e gerenciamento de cluster (cache do Windows Server AppFabric).

As descrições de parâmetro (alias) são:

  • HostName (HostN): o nome do host de cache.

  • CachePort (P): o número da porta de cache do host de cache.

  • HostTimeout(T): o valor de tempo limite em segundos para o host de cache especificado ser iniciado.

Exemplo: Stop-CacheHost -HostName CacheServer1 -CachePort 22233

Get-CacheStatistics

Mostra estatísticas do host de cache especificado, incluindo: tamanho total (em bytes) e o número de objetos armazenados em cache, regiões, caches nomeados, solicitações e perdas de cache.

Observação

Consulte a próxima tabela para obter informações sobre como usar esse comando com o parâmetro CacheName.

As descrições de parâmetro (alias) são:

  • HostName (H): o nome do host de cache.

  • CachePort (P): o número da porta de cache do host de cache.

Exemplo: Get-CacheStatistics -HostName CacheServer1 -CachePort 22233

Get-Cache

Lista todos os caches e regiões que residem no host de cache especificado.

As descrições de parâmetro (alias) são:

  • HostName (H): o nome do host de cache.

  • CachePort (C): o número da porta de cache do host de cache.

Exemplo: Get-Cache -HostName CacheServer1 -CachePort 22233

Get-CacheRegion

Retorna uma lista de todas as regiões contidas no cluster de cache. As regiões podem ser apenas criadas ou removidas pelo cliente de cache. Porém, o cluster de cache determina o host do cache em que elas residirão. Todos os parâmetros são opcionais.

Observação

Consulte a próxima tabela para obter informações sobre como usar esse comando com o parâmetro CacheName.

As descrições de parâmetro (alias) são:

  • MaxRegions: o número máximo de regiões a serem exibidas. Essa descrição não pode ser usada com o parâmetro MaxRegionsPerHost.

  • MaxRegionsPerHost: o número máximo de regiões a serem exibidas de cada host no cluster de cache.

Exemplo: Get-CacheRegion -MaxRegionsPerHost 4

Comandos relacionados ao cache

A tabela a seguir lista os comandos disponíveis para executar operações relacionadas ao cache usando o Windows PowerShell.

Comando Descrição

New-Cache

Cria um novo cache nomeado quando o cluster está em execução. Todos os valores, exceto para CacheName, são opcionais.

Observação

Há um limite de 128 caches nomeados.

As descrições de parâmetro (alias) são:

  • CacheName (N): o nome do cache.

  • Secondaries (S): o valor 1 habilita o recurso de alta disponibilidade. O valor 0 desabilita o recurso de alta disponibilidade. O valor padrão é 0.

  • NotificationsEnabled (Notif): um valor igual a True habilita o recurso de notificações de cache, enquanto um valor igual a False desabilita-o.

  • Eviction (Evict): um valor igual a LRU habilita a remoção Menos Utilizado Recentemente. Um valor igual a None desabilita a remoção. O valor padrão é LRU.

    Aviso

    Um valor igual a None pode fazer com que um host de cache fique sem memória.

  • TimeToLive (T): o tempo limite padrão dos objetos armazenados em cache antes da expiração, em minutos. O valor padrão é 10.

  • Expirable: um valor igual a True habilita a expiração, enquanto False a desabilita. O padrão é Verdadeiro.

Exemplo: New-Cache -CacheName NamedCache1 -Secondaries 1 -TimeToLive 15

Remove-Cache

Remove um cache nomeado, como especificado pelo parâmetro CacheName.

A descrição do parâmetro (alias) é:

  • CacheName (N): o nome do cache.

Exemplo: Remove-Cache -CacheName NamedCache1

Get-CacheConfig

Retorna os detalhes da configuração do cache nomeado especificado pelo parâmetro CacheName.

A descrição do parâmetro (alias) é:

  • CacheName (N): o nome do cache.

Exemplo: Get-CacheConfig -CacheName NamedCache1

Set-CacheConfig

Atualiza as definições de configuração do cache nomeado, conforme especificado pelo parâmetro CacheName.

O cluster de cache pode não estar sendo executado quando o parâmetro CacheName está sendo usado para fazer alterações de cache. Como alternativa, você pode desejar considerar o uso dos comandos Remove-Cache e New-Cache. Esses comandos podem ser usados para alterar uma configuração de cache nomeado sem impactar em outros caches nomeados no cluster, precisando interromper o cluster.

Para obter mais informações, consulte Editar definições de configuração de cache com o Windows PowerShell (cache do Windows Server AppFabric).

As descrições de parâmetro (alias) são:

  • CacheName (N): o nome do cache.

  • Secondaries (S): o valor 1 habilita o recurso de alta disponibilidade. O valor 0 desabilita o recurso de alta disponibilidade. O valor padrão é 0. Observe que apenas os hosts de cache que executam as edições Enterprise ou DataCenter do Windows Server oferecem suporte para esse recurso.

  • NotificationsEnabled (Notif): um valor igual a True habilita o recurso de notificações de cache, enquanto um valor igual a False desabilita-o.

  • Eviction (Evict): um valor igual a LRU habilita a remoção Menos Utilizado Recentemente. Um valor igual a None desabilita a remoção. O valor padrão é LRU.

    Aviso

    Um valor igual a None pode fazer com que um host de cache fique sem memória.

  • TimeToLive (T): o tempo limite padrão dos objetos armazenados em cache antes da expiração, em minutos. O valor padrão é 10.

  • Expirable: um valor igual a True habilita a expiração, enquanto False a desabilita. O padrão é Verdadeiro.

Exemplo: Set-CacheConfig -CacheName NamedCache1 -TimeToLive 30

Get-CacheStatistics

Retorna estatísticas de um cache nomeado, como especificado pelo parâmetro CacheName.

Observação

Consulte a tabela anterior para obter informações sobre como usar esse comando com os parâmetros HostName e CachePort.

A descrição do parâmetro (alias) é:

  • CacheName (N): o nome do cache.

Exemplo: Get-CacheStatistics -CacheName NamedCache1

Get-CacheRegion

Retorna uma lista de todas as regiões em um cache nomeado, como especificado pelo parâmetro CacheName. As regiões podem ser apenas criadas ou removidas pelo cliente de cache. Os controles do cluster de cache em que o host de cache de cada região residirá.

Observação

Consulte a tabela anterior para obter informações sobre como usar esse comando com os parâmetros HostName e CachePort.

A descrição do parâmetro (alias) é:

  • CacheName (N): o nome do cache.

Exemplo: Get-CacheRegion -CacheName NamedCache1

Comandos de Gerenciamento do Console

A tabela a seguir lista os comandos disponíveis para executar operações relacionadas ao gerenciamento da ferramenta de administração de cache baseada no Windows PowerShell.

Comando Descrição

Set-CacheLogging

Esse comando habilita o log baseado em arquivo para a sessão de ferramenta de administração de cache baseada no Windows PowerShell. O rastreamento de eventos iniciado por esse comando tem duração apenas nas sessões do Windows PowerShell a partir das quais ele foi chamado.

Por padrão, o log é habilitado no nível VERBOSE. O arquivo de log padrão está no diretório %temp% dos usuários com um nome formado pelo prefixo DCacheAdministration seguido pelo identificador do processo e o carimbo de data/hora de criação.

Se já existir um arquivo com o mesmo nome, o Windows PowerShell tentará anexar ao arquivo de log.

As descrições do parâmetro (alias) são:

  • LogLevel (L): o nível de evento que especifica os tipos de eventos capturados pelo rastreamento. Os valores válidos são NONE, ERROR, WARNING, INFO e VERBOSE.

  • File (F): um caminho absoluto de pasta ou arquivo em que os logs devem ser gravados. Se o nome do arquivo não for especificado, DCacheAdminTrace[<ProcessId>].log será assumido como padrão, em que <ProcessId> é o número da ID do processo do Windows da sessão do Windows PowerShell. ".log" é acrescentado em todos os nomes de arquivo especificados.

Este exemplo cria o arquivo c:\WarningLog.log que captura mensagens de aviso e de erro:

Set-CacheLogging -LogLevel WARNING -File c:\WarningLog

Este comando rastreia eventos apenas para a sessão do Windows PowerShell, não para o cliente de cache ou o host de cache.

Invoke-GC

Chama manualmente a coleta de lixo no cluster de cache para liberar a memória não usada. Esse comando está disponível apenas para circunstâncias especiais. Geralmente, a coleta de lixo é gerenciada pelo .NET Framework e pelos recursos de gerenciamento de memória do cluster de cache do AppFabric.

Get-Help

Fornece informações da Ajuda para todos os comandos aceitos. Esta palavra-chave também pode ser usada com um caractere "*" para filtrar a quantidade de informações da Ajuda exibidas, por exemplo:

Get-Help new*

Get-Help Start*

Get-Help *cache

Get-Help *cachehost

exit

Sai da sessão do Windows PowerShell.

cls

Limpa a tela do Windows PowerShell.

Consulte também

Conceitos

Configuração de cache com Windows PowerShell (Cache do Windows Server AppFabric)
Definições de configuração (Cache do Windows Server AppFabric)
Opções de configuração de cache do Windows Server AppFabric
Solucionando problemas de cache do Windows Server AppFabric
Conceitos de cache do Windows Server AppFabric
Desenvolvendo um cliente de cache (cache do Windows Server AppFabric)

  2011-12-05