Serviço

Sinopse

Gerenciar um serviço do Windows.

Sintaxe

Service [String] #ResourceName
{
    Name = [string]
    [BuiltInAccount = [string]{ LocalService | LocalSystem | NetworkService }]
    [Credential = [PSCredential]]
    [Dependencies = [string[]]]
    [DependsOn = [string[]]]
    [Description = [string]]
    [DesktopInteract = [bool]]
    [DisplayName = [string]]
    [Ensure = [string]{ Absent | Present }]
    [Path = [string]]
    [PsDscRunAsCredential = [PSCredential]]
    [StartupTimeout = [UInt32]]
    [StartupType = [string]{ Automatic | Disabled | Manual }]
    [State = [string]{ Ignore | Running | Stopped }]
    [TerminateTimeout = [UInt32]]
}

Descrição

O Service recurso permite adicionar, atualizar e remover serviços.

Requisitos

Nenhum.

Propriedades da chave

Nome

Especifique o nome do serviço como uma cadeia de caracteres.

Observação

Às vezes, esse valor é diferente do nome de exibição. É possível obter uma lista dos serviços e seus estados atuais com o cmdlet Get-Service.

Type: System.String

Propriedades opcionais

BuiltInAccount

Especifique o nome da conta do computador para executar o serviço como. A conta deve ter acesso ao executável especificado pelo Path para iniciar o serviço.

Não especifique essa propriedade com a propriedade Credential .

Type: System.String
Accepted Values:
  - LocalService
  - LocalSystem
  - NetworkService
Default Value: Null

Credencial

Especifique a credencial de uma conta para executar o serviço como. A conta deve ter acesso ao executável especificado pelo Caminho para iniciar o serviço. O recurso concede automaticamente a essa conta o direito "Logon como serviço".

Não especifique essa propriedade com a propriedade BuiltInAccount .

Type: System.Management.Automation.PSCredential
Default Value: None

Dependências

Especifique os nomes dos serviços necessários para que esse serviço seja executado como uma matriz de cadeias de caracteres.

Type: System.String[]
Default Value: None

Descrição

Especifique a descrição do serviço como uma cadeia de caracteres. A descrição do serviço aparece no Gerenciamento de Computadores, Serviços.

Type: System.String
Default Value: None

DesktopInteract

Especifique se o serviço pode criar ou se comunicar com uma janela na área de trabalho. Essa propriedade deve ser $false se BuiltInAccount não for especificado como LocalSystem.

O valor padrão é $false.

Type: System.Boolean
Default Value: false

DisplayName

Especifique o nome de exibição amigável do serviço como uma cadeia de caracteres.

Type: System.String
Default Value: None

Ensure

Especifique se o serviço deve existir. Para adicionar ou atualizar um serviço, defina essa propriedade como Present. Para remover um serviço, defina essa propriedade como Absent.

O valor padrão é Present.

Type: System.String
Accepted Values:
  - Absent
  - Present
Default Value: Present

Caminho

Especifique o caminho para o arquivo executável do serviço como uma cadeia de caracteres. Essa propriedade será necessária se o serviço não existir.

Type: System.String
Default Value: None

StartupTimeout

Especifique o tempo para aguardar o início do serviço em milissegundos.

O valor padrão é 30000.

Type: System.UInt32
Default Value: 30000

StartupType

Especifique como o serviço deve se comportar na inicialização do sistema. O valor deve ser um dos seguintes:

  • Automatic - O serviço é iniciado pelo sistema operacional na inicialização do sistema. Se um serviço iniciado automaticamente depender de um serviço iniciado manualmente, o serviço iniciado manualmente também será iniciado automaticamente na inicialização do sistema.
  • Disabled - O serviço está desabilitado e não pode ser iniciado por um usuário ou aplicativo.
  • Manual - O serviço é iniciado apenas manualmente, por um usuário, usando o Gerenciador de Controle de Serviço ou por um aplicativo.

Se o serviço não existir, o valor padrão será Automatic.

Type: System.String
Behavior: Write
Accepted Values:
  - Automatic
  - Disabled
  - Manual
Default Value: None

Estado

Especifique se o serviço deve ser executado. O valor deve ser um dos seguintes:

  • Running - O recurso iniciará o serviço se ele ainda não tiver sido iniciado.
  • Stopped - O recurso interromperá o serviço se ele estiver em execução.
  • Ignore - O recurso não inicia nem interrompe o serviço.

O valor padrão é Running.

Type: System.String
Accepted Values:
  - Running
  - Stopped
  - Ignore
Default Value: Running

TerminateTimeout

Especifique o tempo de espera para que o serviço pare em milissegundos. O valor padrão é 30000.

Type: System.UInt32
Default Value: 30000

Exemplos