No Description
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

gdns_query.Rd 3.1KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. % Generated by roxygen2: do not edit by hand
  2. % Please edit documentation in R/resolver.R
  3. \name{gdns_query}
  4. \alias{gdns_query}
  5. \title{Arbitrary DNS queries}
  6. \usage{
  7. gdns_query(gctx = NULL, name, rr_type = "txt", rr_class = 1L,
  8. include_reporting = FALSE)
  9. }
  10. \arguments{
  11. \item{gctx}{gdns resolver context created with \code{\link[=gdns_resolver]{gdns_resolver()}}. If \code{NULL} a
  12. temporary context will be created but is not ideal since there is overhead
  13. associated with context creation and garbage collection.}
  14. \item{name}{an entity to query for}
  15. \item{rr_type}{what resource record type do you want to queyr for? See \code{Details}.}
  16. \item{include_reporting}{if \code{TRUE} include debugging information for queries
  17. such as the length of time it takes for each query. Default: \code{FALSE}}
  18. }
  19. \description{
  20. Perform any valid resource record inquiry for a given name. See \code{Details}.
  21. }
  22. \details{
  23. This returns a fairly complex result object but that is the nature
  24. of DNS queries. You're likely going to want what is in \code{$replies_tree$answer}
  25. but the rest of the structure contains lovely metadata about the query and
  26. remote query environment. There will eventually be "as data frame"-ish helpers
  27. for this object.
  28. Valid values for \code{rr_type}:
  29. \itemize{
  30. \item \code{a}
  31. \item \code{a6}
  32. \item \code{aaaa}
  33. \item \code{afsdb}
  34. \item \code{any}
  35. \item \code{apl}
  36. \item \code{atma}
  37. \item \code{avc}
  38. \item \code{axfr}
  39. \item \code{caa}
  40. \item \code{cdnskey}
  41. \item \code{cds}
  42. \item \code{cert}
  43. \item \code{cname}
  44. \item \code{csync}
  45. \item \code{dhcid}
  46. \item \code{dlv}
  47. \item \code{dname}
  48. \item \code{dnskey}
  49. \item \code{doa}
  50. \item \code{ds}
  51. \item \code{eid}
  52. \item \code{eui48}
  53. \item \code{eui64}
  54. \item \code{gid}
  55. \item \code{gpos}
  56. \item \code{hinfo}
  57. \item \code{hip}
  58. \item \code{ipseckey}
  59. \item \code{isdn}
  60. \item \code{ixfr}
  61. \item \code{key}
  62. \item \code{kx}
  63. \item \code{l32}
  64. \item \code{l64}
  65. \item \code{loc}
  66. \item \code{lp}
  67. \item \code{maila}
  68. \item \code{mailb}
  69. \item \code{mb}
  70. \item \code{md}
  71. \item \code{mf}
  72. \item \code{mg}
  73. \item \code{minfo}
  74. \item \code{mr}
  75. \item \code{mx}
  76. \item \code{naptr}
  77. \item \code{nid}
  78. \item \code{nimloc}
  79. \item \code{ninfo}
  80. \item \code{ns}
  81. \item \code{nsap}
  82. \item \code{nsap_ptr}
  83. \item \code{nsec}
  84. \item \code{nsec3}
  85. \item \code{nsec3param}
  86. \item \code{null}
  87. \item \code{nxt}
  88. \item \code{openpgpkey}
  89. \item \code{opt}
  90. \item \code{ptr}
  91. \item \code{px}
  92. \item \code{rkey}
  93. \item \code{rp}
  94. \item \code{rrsig}
  95. \item \code{rt}
  96. \item \code{sig}
  97. \item \code{sink}
  98. \item \code{smimea}
  99. \item \code{soa}
  100. \item \code{spf}
  101. \item \code{srv}
  102. \item \code{sshfp}
  103. \item \code{ta}
  104. \item \code{talink}
  105. \item \code{tkey}
  106. \item \code{tlsa}
  107. \item \code{tsig}
  108. \item \code{txt}
  109. \item \code{uid}
  110. \item \code{uinfo}
  111. \item \code{unspec}
  112. \item \code{uri}
  113. \item \code{wks}
  114. \item \code{x25}
  115. \item \code{zonemd}
  116. }
  117. }
  118. \note{
  119. Local hosts files are ignored when using this \code{getdns} API endpoint
  120. }
  121. \examples{
  122. x <- gdns_resolver()
  123. gdns_query(x, "example.com")
  124. }
  125. \references{
  126. \url{https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml}
  127. }
  128. \seealso{
  129. Other query functions: \code{\link{gdns_context}},
  130. \code{\link{gdns_get_address}}
  131. }
  132. \concept{query functions}