Skip to content
CapaSystems Docs

Configure Windows Service

Configures a Windows service by changing its display name, description, startup type, status, and logon account

Parameters

Section titled “Parameters”

Service Name

Section titled “Service Name”

Required

Specifies the service name of the service to be changed. This is the actual service name, not the display name.\nSample: wuauserv (Windows Update service)

Display Name

Section titled “Display Name”

Optional

Specifies a new display name for the service (wildcard supported). This is the friendly name shown in Windows Services.\nSample: Windows Update

Description

Section titled “Description”

Optional

Specifies a new description for the service. The service description appears in Computer Management under Services.\nSample: Enables detection, download, and installation of updates for Windows and other programs.

Startup Type

Section titled “Startup Type”

Optional — Default: Automatic

Specifies the start mode of the service.\n• Automatic - Started at system boot\n• AutomaticDelayedStart - Started shortly after system boot\n• Manual - Started manually by user or application\n• Disabled - Cannot be started Allowed values: Automatic, Automatic (Delayed Start), Manual, Disabled.

Service Status

Section titled “Service Status”

Optional — Default: Running

Specifies the desired status for the service.\n• Running - Starts the service\n• Stopped - Stops the service\n• Paused - Pauses the service Allowed values: Running, Stopped, Paused.

Restart Service

Section titled “Restart Service”

Optional — Default: False

Specifies whether to restart the service after applying changes.\nTrue - Service will be stopped and started after changes are applied\nFalse - Service state will not be changed (unless Status parameter is specified)

Details

Section titled “Details”
  • Category: Windows service
  • Brick ID: Windows-Service-Configure

Raw JSON definition

Section titled “Raw JSON definition”
{
  "category": "windowsService",
  "description": "Configures a Windows service by changing its display name, description, startup type, status, and logon account",
  "developerVendor": "CapaSystems A/S",
  "displayName": null,
  "id": "Windows-Service-Configure",
  "name": "Configure Windows Service",
  "parameters": [
    {
      "defaultValue": "",
      "defaultValueObject": null,
      "description": "Specifies the service name of the service to be changed. This is the actual service name, not the display name.\\nSample: wuauserv (Windows Update service)",
      "id": "ServiceName",
      "name": "Service Name",
      "regExValidation": "",
      "required": true,
      "type": "TextBox",
      "value": null,
      "values": [],
      "valuesObject": null
    },
    {
      "defaultValue": "",
      "defaultValueObject": null,
      "description": "Specifies a new display name for the service (wildcard supported). This is the friendly name shown in Windows Services.\\nSample: Windows Update",
      "id": "DisplayName",
      "name": "Display Name",
      "regExValidation": "",
      "required": false,
      "type": "TextBox",
      "value": null,
      "values": [],
      "valuesObject": null
    },
    {
      "defaultValue": "",
      "defaultValueObject": null,
      "description": "Specifies a new description for the service. The service description appears in Computer Management under Services.\\nSample: Enables detection, download, and installation of updates for Windows and other programs.",
      "id": "Description",
      "name": "Description",
      "regExValidation": "",
      "required": false,
      "type": "TextBox",
      "value": null,
      "values": [],
      "valuesObject": null
    },
    {
      "defaultValue": "",
      "defaultValueObject": {
        "id": "Automatic",
        "name": "Automatic"
      },
      "description": "Specifies the start mode of the service.\\n• Automatic - Started at system boot\\n• AutomaticDelayedStart - Started shortly after system boot\\n• Manual - Started manually by user or application\\n• Disabled - Cannot be started",
      "id": "StartupType",
      "name": "Startup Type",
      "regExValidation": "",
      "required": false,
      "type": "ComboBox",
      "value": null,
      "values": [],
      "valuesObject": [
        {
          "id": "Automatic",
          "name": "Automatic"
        },
        {
          "id": "AutomaticDelayedStart",
          "name": "Automatic (Delayed Start)"
        },
        {
          "id": "Manual",
          "name": "Manual"
        },
        {
          "id": "Disabled",
          "name": "Disabled"
        }
      ]
    },
    {
      "defaultValue": "",
      "defaultValueObject": {
        "id": "Running",
        "name": "Running"
      },
      "description": "Specifies the desired status for the service.\\n• Running - Starts the service\\n• Stopped - Stops the service\\n• Paused - Pauses the service",
      "id": "Status",
      "name": "Service Status",
      "regExValidation": "",
      "required": false,
      "type": "ComboBox",
      "value": null,
      "values": [],
      "valuesObject": [
        {
          "id": "Running",
          "name": "Running"
        },
        {
          "id": "Stopped",
          "name": "Stopped"
        },
        {
          "id": "Paused",
          "name": "Paused"
        }
      ]
    },
    {
      "defaultValue": "False",
      "defaultValueObject": null,
      "description": "Specifies whether to restart the service after applying changes.\\nTrue - Service will be stopped and started after changes are applied\\nFalse - Service state will not be changed (unless Status parameter is specified)",
      "id": "RestartService",
      "name": "Restart Service",
      "regExValidation": "",
      "required": false,
      "type": "Boolean",
      "value": null,
      "values": [],
      "valuesObject": null
    }
  ],
  "powershell": {
    "base64Encoded": true,
    "function": "ZnVuY3Rpb2..."
  },
  "type": "powerbrick",
  "version": "2026.7.2.1"
}