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-NectarExtCities

Prev Next

Returns a list of cities found via IP geolocation

Description

Most call records include the user's external IP address. Nectar DXP does a geo-IP lookup of the external IP address and stores the geographic information for later use. This command will return all the cities where Nectar DXP was able to successfully geolocate an external IP address.

Syntax

Get-NectarExtCities
  -SearchQuery  <String>
  -TenantName  <String>
  -ResultSize  <Int32>

Examples

Example 1

Get-NectarExtCities

Returns the first 1000 cities sorted alphabetically.

Example 2

Get-NectarExtCities -ResultSize 5000

Returns the first 5000 cities sorted alphabetically.

Example 3

Get-NectarExtCities -SearchQuery Gu

Returns all cities that contain the letters 'gu'

Parameters

-SearchQuery <String>
The name of the city to locate. Can be a partial match, and may return more than one entry.

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

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

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

-ResultSize <Int32>
The number of results to return. Defaults to 1000.

Parameter Value
Required false
Position 3
Required false
Default Value 1000
Accept pipeline input? false
Accept wildcard characters? false