---
title: "Get-NectarRIGAgent"
slug: "get-nectarrigagent"
updated: 2024-08-20T19:49:07Z
published: 2024-08-20T19:49:07Z
canonical: "support.nectarcorp.com/get-nectarrigagent"
---

> ## 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-NectarRIGAgent

Return information about RIG agents connected to the environment

## Syntax

```
Get-NectarRIGAgent
  -SearchQuery  <String>
  -OrderByField  <String>
  -OrderDirection  <String>
  -PageSize  <Int32>
  -ResultSize  <Int32>
  -Name  <String>
```

## Examples

### Example 1

```
Get-NectarRIGAgent
```

Returns information about all RIG agents in the environment

### Example 2

```
Get-NectarRIGAgent -SearchQuery contoso -OrderByField
```

Returns information about gateways from all Cisco clusters

## Parameters

**-SearchQuery <String>** A string to search for. Will search for match against all fields

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

**-OrderByField <String>** Sort the output by the selected field

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 2 |
| Required | false |
| Default Value | name |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-OrderDirection <String>** Sort ordered output in ascending or descending order

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 3 |
| Required | false |
| Default Value | asc |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-PageSize <Int32>** The size of the page used to return data. Defaults to 10000

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 4 |
| Required | false |
| Default Value | 10000 |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-ResultSize <Int32>** The total number of results to return. Maximum result size is 9,999,999 results

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 5 |
| Required | false |
| Default Value | 0 |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-Name <String>**

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 6 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |