Get-DNS Cmdlet

Parameters   Output Objects   Config Settings  

The Get-DNS component is used to query a DNS server for records.

Syntax

Get-DNS [parameters]

Remarks

The cmdlet will attempt to obtain DNS records for the domain specified in Domain for records of the type QueryType. The cmdlet will attempt to use the default DNS settings for the system, but the DNS server and port may be explicitly set as DNSServer and Port.

The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.

Example # using default DNS and query type (address) get-dns -domain nsoftware.com # specifying DNS and record type get-dns -dnsserver 10.0.1.1 -port 53 -domain microsoft.com -querytype NS

Parameter List


The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.

LogFileThe location of a file to which debug information is written.
ConfigSpecifies one or more configuration settings.
DNSServerThe address of the DNS Server to use.
DomainThe domain to query.
LocalIPThe IP address of the local interface to use.
LogFileThe location of a file to which debug information is written.
PortThe TCP port in the remote host to which to connect.
QueryTypeThe record type to query.
RecordSourceThe source of records provided in the DnsEntry output.
RecursiveDetermines whether to ask the DNSServer to recursively query other servers.
TimeoutThe maximum time allowed for the operation.

Output Objects


The following is the full list of the output objects returned by the cmdlet with short descriptions. Click on the links for further details.

DnsEntryThis object is created after a DNS record has been returned.

Config Settings


The following is a list of config settings for the cmdlet with short descriptions. Click on the links for further details.

DoHMethodSpecifies the DNS over HTTPS method.
ResponseTruncatedWhether the response is truncated.
UseDNSAPIDLLWhether to use the system dnsapi.dll on Windows Systems.
UseIDNsWhether to encode hostnames to internationalized domain names.
CaptureIPPacketInfoUsed to capture the packet information.
DelayHostResolutionWhether the hostname is resolved when RemoteHost is set.
DestinationAddressUsed to get the destination address from the packet information.
DontFragmentUsed to set the Don't Fragment flag of outgoing packets.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxPacketSizeThe maximum length of the packets that can be received.
QOSDSCPValueUsed to specify an arbitrary QOS/DSCP setting (optional).
QOSTrafficTypeUsed to specify QOS/DSCP settings (optional).
ShareLocalPortIf set to True, allows more than one instance of the component to be active on the same local port.
UseConnectionDetermines whether to use a connected socket.
UseIPv6Whether or not to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

LogFile Parameter (Get-DNS Cmdlet)

The location of a file to which debug information is written.

Syntax

Get-DNS -LogFile string

Remarks

When specified, the cmdlet will log debug information to the file. If the file exists, the information will be appended.

Default Value

null

Config Property (Get-DNS Cmdlet)

Specifies one or more configuration settings.

Syntax

Get-DNS -Config string[]

Remarks

The Config parameter takes one or more name-value pairs that represent the name of the configuration setting and value, i.e.: -config "Name=Value"

Default Value

null

DNSServer Property (Get-DNS Cmdlet)

The address of the DNS Server to use.

Syntax

Get-DNS -DNSServer string

Remarks

The cmdlet will try to figure out the default dns server of the interface that it encounters. You may provide one to override this behavior.

Default Value

""

Parameter Alias

Server

Domain Property (Get-DNS Cmdlet)

The domain to query.

Syntax

Get-DNS -Domain string

Remarks

The cmdlet will query the host in DNSServer for any records of type QueryType.

Default Value

""

Parameter Position

0

Parameter Alias

QueryDomain

This is a required parameter.

LocalIP Property (Get-DNS Cmdlet)

The IP address of the local interface to use.

Syntax

Get-DNS -LocalIP string

Remarks

This parameter is useful when the cmdlet is running on a machine that has more than one network interface (each with its own IP address and network access privileges).

Default Value

""

Parameter Alias

LocalAddress

LogFile Property (Get-DNS Cmdlet)

The location of a file to which debug information is written.

Syntax

Get-DNS -LogFile string

Remarks

When specified, the cmdlet will log debug information to the file. If the file exists, the information will be appended.

Default Value

""

Port Property (Get-DNS Cmdlet)

The TCP port in the remote host to which to connect.

Syntax

Get-DNS -Port int

Remarks

Port specifies a service port on the remote host to which to connect.

A valid port number (a value between 1 and 65535) is required for the connection to take place.

Default Value

53

QueryType Property (Get-DNS Cmdlet)

The record type to query.

Syntax

Get-DNS -QueryType string

Remarks

Before a query is attempted, QueryType must be set to the desired record type. The records are defined as follows:

A Address Records
NSName Server Records
MDMail Destination Records
MFMail Forwarder Records
CNameCanonical Name Records
SOAStart Of Authority Records
MailBoxMailBox Records
MailGroupMail Group Records
MRMailBox Rename Records
NULL NULL Records
WKS Well Known Services Records
Ptr Pointer Records
HInfo Host Information Records
MailInfo Mail Information Records
MX Mail Exchange Records
Text Text Records
RP Responsible Person Records
AFSDB Service Records
X25X25 Records
ISDN ISDN Records
RT Route Through Records
AAAA AAAA Record
SRVSRV Record (location of services)
RevReverse Lookup

Default Value

1

Parameter Position

1

Parameter Alias

type

RecordSource Property (Get-DNS Cmdlet)

The source of records provided in the DnsEntry output.

Syntax

Get-DNS -RecordSource string

Remarks

RecordSource can have one of the following values:

AnswerRecords answering the question/query.
NameServerRecords pointing toward an authoritative name server.
AdditionalRecordsRecords holding additional information.

Default Value

0

Parameter Alias

Source

Recursive Property (Get-DNS Cmdlet)

Determines whether to ask the DNSServer to recursively query other servers.

Syntax

Get-DNS -Recursive SwitchParameter

Remarks

If Recursive is true, the cmdlet will tell the DNS server to perform the query recursively. This means that if the DNS server does not have information about the domain being queried, it will send the request to another DNS server.

Default Value

true

Timeout Property (Get-DNS Cmdlet)

The maximum time allowed for the operation.

Syntax

Get-DNS -Timeout int

Remarks

After the specified interval in seconds, the cmdlet will throw a Timeout error if the operation is not completed.

Default Value

10

DnsEntry Output Object (Get-DNS Cmdlet)

This object is created after a DNS record has been returned.

Syntax

Object DnsEntry {
   string Type;
   string[] Fields;
   string[] Values;
   string Domain;
   int TTL;
   string RecordSource;
   bool Success;
   string ProtocolLog;
}

Remarks

Once the query is complete, one DnsEntry object will be created for each answer returned, and the following properties will contain the results:

TypeThe type of the record being listed.
Fields*An array of field names for each record.
ValuesAn array of field values for each record.
DomainAn array of domains for each record.
TTLAn array of TTL's for each record. TTL specifies the time interval, in seconds, for which the record is valid or the time interval that the record can be cached before the DNS server should be queried again.
SuccessIf the operation completed successfully this will be True. In the case of an error this will be False.
ProtocolLogIf the configuration setting "DNSProtocolLog" is set to "True" this will hold a 'nslookup' style log. The log will be the same in each DnsEntry object.
*Field names

Field names are different depending on the record type. For example, an MX record type will contain two fields: PREFERENCE and EXCHANGE, but an SOA record type contains seven fields.

A RecordsADDRESS
NS RecordsDNAME
MDMADNAME
MFMADNAME
CNAMECNAME
SOAMNAME
SOARNAME
SOASERIAL
SOAREFRESH
SOARETRY
SOAEXPIRE
SOAMINIMUM
MBMADNAME
MGMGMNAME
MRNEWNAME
NULLNULL
WKSADDRESS
WKSPROTOCOL
WKSSERVICEMAP
PTRPTRDNAME
HINFOCPU
HINFOOS
MINFORMAILBX
MINFOEMAILBX
MXPREFERENCE
MXEXCHANGE
TXTTXT
RPMBOXDNAME
RPTXTDNAME
AFSDBSUBTYPE
AFSDBHOSTNAME
X25PSDNADDRESS
ISDNISDNADDRESS
RTPREFERENCE
RTINTERMEDIATE
AAAAADDRESS
SRVPRIORITY
SRVWEIGHT
SRVPORT
SRVTARGET

Config Settings (Get-DNS Cmdlet)

The cmdlet accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the cmdlet, access to these internal properties is provided through the Config method.

DNS Config Settings

DoHMethod:   Specifies the DNS over HTTPS method.

This setting may be used to configure the method used when performing DNS over HTTPS (DoH). Possible values are as follows:

0 (default)HTTP POST (DNS Wireformat)
1HTTP GET (DNS Wireformat)
2HTTP GET (JSON)
This setting is applicable only when Protocol is set to ptHTTPS.

ResponseTruncated:   Whether the response is truncated.

This setting may be queried after calling Query to determine if the response from thet DNSServer is truncated. If the response is large and cannot be transferred over UDP, the server may truncate the response. When this setting is True the response is truncated and the request should be attempted again over a different Protocol, such as ptTCP.

UseDNSAPIDLL:   Whether to use the system dnsapi.dll on Windows Systems.

This setting specifies whether to use the system dnsapi.dll when using the cmdlet. If True, the cmdlet will use the Windows System dnsapi.dll. This may be desirable in some cases to allow querying against the system cache. If set to False (default), the cmdlet will use its own DNS implementation to perform queries.

The default value is False.

NOTE: This functionality is only available in Windows.

UseIDNs:   Whether to encode hostnames to internationalized domain names.

This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified.

UDP Config Settings

CaptureIPPacketInfo:   Used to capture the packet information.

If this is set to true, the component will capture the IP packet information.

The default value for this setting is False.

Note: This setting is only available in Windows.

DelayHostResolution:   Whether the hostname is resolved when RemoteHost is set.

This setting specifies whether a hostname is resolved immediately when RemoteHost is set. If true the cmdlet will resolve the hostname and the IP address will be present in the RemoteHost property. If false, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, ResolveRemoteHost may called to manually resolve the value in RemoteHost at any time.

The default value is false for the default library and true for the Async library. The default value is false.

DestinationAddress:   Used to get the destination address from the packet information.

If CaptureIPPacketInfo is set to true, then this will be populated with the packet's destination address when a packet is received. This information will be accessible in the DataIn event.

Note: This setting is only available in Windows.

DontFragment:   Used to set the Don't Fragment flag of outgoing packets.

When set to True, packets sent by the cmdlet will have the Don't Fragment flag set. The default value is False.

LocalHost:   The name of the local host through which connections are initiated or accepted.

The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the cmdlet initiate connections (or accept in the case of server cmdlets) only through that interface.

If the cmdlet is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

LocalPort:   The port in the local host where the cmdlet binds.

This must be set before a connection is attempted. It instructs the cmdlet to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxPacketSize:   The maximum length of the packets that can be received.

This setting specifies the maximum size of the datagrams that the cmdlet will accept without truncation.

QOSDSCPValue:   Used to specify an arbitrary QOS/DSCP setting (optional).

UseConnection must be True to use this setting. This option allows you to specify an arbitrary DSCP value between 0 and 63. The default is 0. When set to the default value the component will not set a DSCP value.

Note: This setting uses the qWAVE API is only available on Windows 7, Windows Server 2008 R2, and later.

QOSTrafficType:   Used to specify QOS/DSCP settings (optional).

UseConnection must be True to use this setting. You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5).

Note: This setting uses the qWAVE API which is only available on Windows Vista and Windows Server 2008 or above.

Note: QOSTrafficType must be set before setting Active to true.

ShareLocalPort:   If set to True, allows more than one instance of the cmdlet to be active on the same local port.

This option must be set before the cmdlet is activated through the Active property or it will have no effect.

The default value for this setting is False.

UseConnection:   Determines whether to use a connected socket.

UseConnection specifies whether the cmdlet should use a connected socket or not. The connection is defined as an association in between the local address/port and the remote address/port. As such, this is not a connection in the traditional TCP sense. What it means is only that the cmdlet will send and receive data only to and from the specified destination.

The default value for this setting is False.

UseIPv6:   Whether or not to use IPv6.

By default, the component expects an IPv4 address for local and remote host properties, and will create an IPv4 socket. To use IPv6 instead, set this to True.

Socket Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the cmdlet is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the cmdlet is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a cmdlet is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these cmdlets: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Tells the cmdlet whether or not to use the system security libraries or an internal implementation.

When set to false, the cmdlet will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments this is not desirable. To use a completely managed security implementation set this setting to true.

Setting this setting to true tells the cmdlet to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.

Note: This setting is static. The value set is applicable to all cmdlets used in the application.

When this value is set the product's system DLL is no longer required as a reference, as all unmanaged code is stored in that file.