---
title: "Set-NectarLocation"
slug: "set-nectarlocation"
updated: 2023-05-15T17:41:30Z
published: 2023-05-15T17:41:30Z
canonical: "support.nectarcorp.com/set-nectarlocation"
---

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

# Set-NectarLocation

Update a Nectar DXP location in the location database

## Description

Update a Nectar DXP location in the location database. This command can use the Google Geocode API to automatically populate the latitude/longitude for each location. You can register for an API key and save it as persistent environment variable called GoogleGeocode_API_Key on this machine. This command will prompt for the GeoCode API key and will save it in the appropriate location. Follow this link to get an API Key - https://developers.google.com/maps/documentation/geocoding/get-api-key. If this is not an option, then use the -SkipGeoLocate switch

## Syntax

```
Set-NectarLocation
  -SearchQuery  <String>
  -Network  <String>
  -NetworkMask  <String>
  -ExtNetwork  <String>
  -ExtNetworkMask  <String>
  -NetworkName  <String>
  -SiteName  <String>
  -SiteCode  <String>
  -Region  <String>
  -StreetAddress  <String>
  -City  <String>
  -State  <String>
  -PostCode  <String>
  -Country  <String>
  -Description  <String>
  -IsWireless  <String>
  -IsExternal  <String>
  -IsVPN  <String>
  -Latitude  <Double>
  -Longitude  <Double>
  -ForceGeoLocate
  -SkipGeoLocate
  -TenantName  <String>
  -Identity  <String>
```

## Examples

### Example 1

```
Set-NectarLocation HeadOffice -Region WestUS
```

Changes the region for HeadOffice to WestUS

### Example 2

```
Get-NectarLocation | Set-NectarLocation
```

Will go through each location and update the latitude/longitude. Useful if a Google Geocode API key was obtained after initial location loading

## Parameters

**-SearchQuery <String>** A string to search for. Will search in Network, NetworkName, City, Street Address, Region etc.

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

**-Network <String>** The IP subnet of the network

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

**-NetworkMask <String>** The subnet mask of the network

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

**-ExtNetwork <String>** The IP subnet of the external/public network. Optional. Used to help differentiate calls from corporate locations that use common home subnets (192.168.x.x)

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

**-ExtNetworkMask <String>** The subnet mask of the external/public network. Optional. Used to help differentiate calls from corporate locations that use common home subnets (192.168.x.x)

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

**-NetworkName <String>** The name to give to the network

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

**-SiteName <String>** The name to give to the siteCode

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

**-SiteCode <String>** A site code to assign to the site

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

**-Region <String>** The name of the region. Typically is set to country name or whatever is appropriate for the company

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

**-StreetAddress <String>** The street address of the location

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

**-City <String>** The city of the location

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

**-State <String>** The state/province of the location

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

**-PostCode <String>** The postal/zip code of the location

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

**-Country <String>** The 2-letter ISO country code of the location

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

**-Description <String>** A description to apply to the location

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

**-IsWireless <String>** True or false if the network is strictly wireless

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

**-IsExternal <String>** True or false if the network is outside the corporate network

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

**-IsVPN <String>** True or false if the network is a VPN

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

**-Latitude <Double>** The geographical latitude of the location. If not specified, will attempt automatic geolocation.

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

**-Longitude <Double>** The geographical longitude of the location. If not specified, will attempt automatic geolocation.

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

**-ForceGeoLocate <SwitchParameter>**

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

**-SkipGeoLocate <SwitchParameter>** Don't attempt geolocation. Do this if you don't have a valid Google Maps API key.

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

**-TenantName <String>**

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

**-Identity <String>** The numerical ID of the location to update. Can be obtained via Get-NectarLocation and pipelined to Set-NectarLocation

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