> For the complete documentation index, see [llms.txt](https://docs.parallels.com/landing/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rashalbstatus.md).

# Get-RASHALBStatus

## SYNOPSIS

Retrieves the status for HALB Virtual Server based on the condition of the HALB Devices.

## SYNTAX

```powershell
Get-RASHALBStatus [-Id] <uint> [<CommonParameters>]
```

```powershell
Get-RASHALBStatus [[-Name] <string>] [[-SiteId] <uint>] [<CommonParameters>]
```

## DESCRIPTION

Retrieves the status for HALB Virtual Server based on the condition of the HALB Devices.

## EXAMPLES

### Example 1

```powershell
Get-RASHALBStatus
```

Get list of all the HALB Virtual Server statuses

### Example 2

```powershell
Get-RASHALBStatus -Id 2
```

Get status for the HALB Virtual Server with ID 2

### Example 3

```powershell
Get-RASHALBStatus -Name "HALB-VS" -SiteId 1
```

Get status for the HALB Virtual Server by name from specific site

## PARAMETERS

### -Id

The ID of the HALB Virtual Server.

```yaml
Type: uint
Required: True
Position: 0
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### -Name

The name of the HALB Virtual Server.

```yaml
Type: string
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SiteId

The site ID where the HALB Virtual Server resides.

```yaml
Type: uint
Required: False
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about\_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### None

## OUTPUTS

### [HALBVirtualServerStatus](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/halbvirtualserverstatus.md)

## RELATED LINKS

* [Set-RASHALB](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/set-rashalb.md)
* [Get-RASHALB](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rashalb.md)
* [New-RASHALB](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/new-rashalb.md)
* [Remove-RASHALB](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/remove-rashalb.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rashalbstatus.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
