---
title: "Get-NCXAlarm"
slug: "get-ncxalarm"
updated: 2024-08-21T16:19:45Z
published: 2024-08-21T16:19:45Z
canonical: "support.nectarcorp.com/get-ncxalarm"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.nectarcorp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get-NCXAlarm

Shows NCX alarms

## Syntax

```
Get-NCXAlarm
  -AlarmType  <String>
  -TimePeriod  <String>
  -AlarmType  <String>
  -TimePeriodFrom  <DateTime>
  -TimePeriodTo  <DateTime>
```

## Examples

### Example 1

```
Get-NCXAlarm
```

## Parameters

**-AlarmType <String>**

| Parameter | Value |
| --- | --- |
| Required | true |
| Position | 1 |
| Required | true |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-TimePeriod <String>**

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | named |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-TimePeriodFrom <DateTime>**

| Parameter | Value |
| --- | --- |
| Required | true |
| Position | named |
| Required | true |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-TimePeriodTo <DateTime>**

| Parameter | Value |
| --- | --- |
| Required | true |
| Position | named |
| Required | true |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |