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.

New-NectarLocation

  • Updated on May 15, 2023
  • Published on May 5, 2021
  • 4 minute(s) read
Prev Next

Creates a Nectar DXP location in the location database

Description

Creates 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

New-NectarLocation
  -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>
  -SkipGeoLocate
  -Latitude  <Double>
  -Longitude  <Double>
  -TenantName  <String>

Examples

Example 1

New-NectarLocation -Network 10.14.3.0 -NetworkMask 24 -NetworkName Corp5thFloor -SiteName 'Head Office'

Creates a new location using the minimum required information

Example 2

New-NectarLocation -Network 10.15.1.0 -NetworkMask 24 -ExtNetwork 79.23.155.71 -ExtNetworkMask 28 -NetworkName Corp3rdFloor -SiteName 'Head Office' -SiteCode HO3 -IsWireless True -IsVPN False -Region EastUS -StreetAddress '366 North Broadway' -City Jericho -State 'New York' -Country US -PostCode 11753 -Description 'Head office 3rd floor' -Latitude 40.7818283 -Longitude -73.5351438

Creates a new location using all available fields

Example 3

Import-Csv LocationData.csv | New-NectarLocation

Imports a CSV file called LocationData.csv and creates new locations

Example 4

Import-Csv LocationData.csv | New-NectarLocation -SkipGeolocate

Imports a CSV file called LocationData.csv and creates new locations but will not attempt geolocation

Parameters

-Network <String>
The IP subnet of the network

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

-NetworkMask <String>
The subnet mask of the network

Parameter Value
Required true
Position 2
Required true
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 3
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 4
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 true
Position 5
Required true
Default Value None
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-SiteName <String>
The name to give to the site

Parameter Value
Required true
Position 6
Required true
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 7
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 8
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 9
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 10
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 11
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 12
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 13
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 14
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 15
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 16
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 17
Required false
Default Value None
Accept pipeline input? true (ByPropertyName)
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

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

Parameter Value
Required false
Position 18
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 19
Required false
Default Value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-TenantName <String>
The name of the Nectar DXP tenant. Used in multi-tenant configurations.

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