Lib/Default/en-US/Globalping.PowerShell.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Start-GlobalpingDns --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-GlobalpingDns</command:name> <command:verb>Start</command:verb> <command:noun>GlobalpingDns</command:noun> <maml:description> <maml:para>Start a DNS lookup using Globalping.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Queries DNS records from remote probes and converts them to DnsRecordResult objects.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Start-GlobalpingDns</maml:name> <!-- Parameter: Target --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Target</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Token"> <maml:name>ApiKey</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Classic --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Classic</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: InProgressUpdates --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InProgressUpdates</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Locations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Locations</maml:name> <command:parameterValue required="true">LocationRequest[]</command:parameterValue> <dev:type> <maml:name>Globalping.LocationRequest[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Options --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Options</maml:name> <command:parameterValue required="true">DnsOptions</command:parameterValue> <dev:type> <maml:name>Globalping.DnsOptions</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Raw --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="AsRaw"> <maml:name>Raw</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReuseLocationsFromId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReuseLocationsFromId</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SimpleLocations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SimpleLocations</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WaitTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitTime</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>150</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Raw --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="AsRaw"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Return the raw measurement response.</maml:para> <maml:para>Use this switch to inspect the MeasurementResponse object without conversion.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Classic --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Classic</maml:name> <maml:description> <maml:para>Output DNS results in classic text form.</maml:para> <maml:para>The original text returned by the resolver is emitted.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Options --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Options</maml:name> <maml:description> <maml:para>Additional DNS options for the request.</maml:para> <maml:para>Allows custom resolver, query type or trace options.</maml:para> </maml:description> <command:parameterValue required="true">DnsOptions</command:parameterValue> <dev:type> <maml:name>Globalping.DnsOptions</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Target --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Target</maml:name> <maml:description> <maml:para>Target host names, IP addresses or URLs to test.</maml:para> <maml:para>Each value is passed verbatim to the underlying measurement API.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Locations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Locations</maml:name> <maml:description> <maml:para>Detailed location definitions for probes.</maml:para> <maml:para>Each LocationRequest may specify city, country, ASN or provider details.</maml:para> </maml:description> <command:parameterValue required="true">LocationRequest[]</command:parameterValue> <dev:type> <maml:name>Globalping.LocationRequest[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReuseLocationsFromId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReuseLocationsFromId</maml:name> <maml:description> <maml:para>Reuse probe locations from a previous measurement.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SimpleLocations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SimpleLocations</maml:name> <maml:description> <maml:para>Short location identifiers such as city or country codes.</maml:para> <maml:para>Two-letter strings are treated as ISO country codes. Longer values map to the "magic" location syntax used by the API.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Maximum number of probes to use.</maml:para> <maml:para>If omitted the cmdlet estimates a value based on provided locations.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InProgressUpdates --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InProgressUpdates</maml:name> <maml:description> <maml:para>Request progress updates while the measurement runs.</maml:para> <maml:para>When set the API streams partial results that are written as they arrive.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: WaitTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitTime</maml:name> <maml:description> <maml:para>Time in seconds to wait for progress updates.</maml:para> <maml:para>Only applies when InProgressUpdates is specified.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>150</dev:defaultValue> </command:parameter> <!-- Parameter: ApiKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Token"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>API key used to authenticate with Globalping.</maml:para> <maml:para>Anonymous requests may be rate limited.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: DnsRecordResult --> <command:returnValue> <dev:type> <maml:name>Globalping.DnsRecordResult</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: MeasurementResponse --> <command:returnValue> <dev:type> <maml:name>Globalping.MeasurementResponse</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- Example 1: Resolve A record ----------</maml:title> <maml:introduction> <maml:para>PS> </maml:para> </maml:introduction> <dev:code>Start-GlobalpingDns -Target "evotec.xyz"</dev:code> <dev:remarks> <maml:para>Returns DNS records from available probes.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 2: Use custom resolver ----------</maml:title> <maml:introduction> <maml:para>PS> </maml:para> </maml:introduction> <dev:code>Start-GlobalpingDns -Target "cloudflare.com" -Options @{ Resolver = "8.8.8.8" }</dev:code> <dev:remarks> <maml:para>Sends the DNS query using the Google public resolver.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-GlobalpingHttp --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-GlobalpingHttp</command:name> <command:verb>Start</command:verb> <command:noun>GlobalpingHttp</command:noun> <maml:description> <maml:para>Start an HTTP request using Globalping.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sends an HTTP request from remote probes and returns HttpResponseResult objects.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Start-GlobalpingHttp</maml:name> <!-- Parameter: Target --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Target</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Token"> <maml:name>ApiKey</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Classic --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Classic</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HeadersOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HeadersOnly</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: InProgressUpdates --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InProgressUpdates</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Locations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Locations</maml:name> <command:parameterValue required="true">LocationRequest[]</command:parameterValue> <dev:type> <maml:name>Globalping.LocationRequest[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Options --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Options</maml:name> <command:parameterValue required="true">HttpOptions</command:parameterValue> <dev:type> <maml:name>Globalping.HttpOptions</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Raw --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="AsRaw"> <maml:name>Raw</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReuseLocationsFromId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReuseLocationsFromId</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SimpleLocations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SimpleLocations</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WaitTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitTime</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>150</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Raw --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="AsRaw"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Return the raw measurement response.</maml:para> <maml:para>The full MeasurementResponse is emitted without conversion.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Classic --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Classic</maml:name> <maml:description> <maml:para>Output HTTP results in classic text form.</maml:para> <maml:para>Each probe returns the textual output of the underlying HTTP tool.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HeadersOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HeadersOnly</maml:name> <maml:description> <maml:para>Emit only HTTP headers from each response.</maml:para> <maml:para>Ignores the body content from the probes.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Options --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Options</maml:name> <maml:description> <maml:para>Additional HTTP options for the request.</maml:para> <maml:para>Allows setting request method, headers or body.</maml:para> </maml:description> <command:parameterValue required="true">HttpOptions</command:parameterValue> <dev:type> <maml:name>Globalping.HttpOptions</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Target --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Target</maml:name> <maml:description> <maml:para>Target host names, IP addresses or URLs to test.</maml:para> <maml:para>Each value is passed verbatim to the underlying measurement API.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Locations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Locations</maml:name> <maml:description> <maml:para>Detailed location definitions for probes.</maml:para> <maml:para>Each LocationRequest may specify city, country, ASN or provider details.</maml:para> </maml:description> <command:parameterValue required="true">LocationRequest[]</command:parameterValue> <dev:type> <maml:name>Globalping.LocationRequest[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReuseLocationsFromId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReuseLocationsFromId</maml:name> <maml:description> <maml:para>Reuse probe locations from a previous measurement.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SimpleLocations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SimpleLocations</maml:name> <maml:description> <maml:para>Short location identifiers such as city or country codes.</maml:para> <maml:para>Two-letter strings are treated as ISO country codes. Longer values map to the "magic" location syntax used by the API.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Maximum number of probes to use.</maml:para> <maml:para>If omitted the cmdlet estimates a value based on provided locations.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InProgressUpdates --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InProgressUpdates</maml:name> <maml:description> <maml:para>Request progress updates while the measurement runs.</maml:para> <maml:para>When set the API streams partial results that are written as they arrive.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: WaitTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitTime</maml:name> <maml:description> <maml:para>Time in seconds to wait for progress updates.</maml:para> <maml:para>Only applies when InProgressUpdates is specified.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>150</dev:defaultValue> </command:parameter> <!-- Parameter: ApiKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Token"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>API key used to authenticate with Globalping.</maml:para> <maml:para>Anonymous requests may be rate limited.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: HttpResponseResult --> <command:returnValue> <dev:type> <maml:name>Globalping.HttpResponseResult</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: MeasurementResponse --> <command:returnValue> <dev:type> <maml:name>Globalping.MeasurementResponse</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- Example 1: Fetch a webpage ----------</maml:title> <maml:introduction> <maml:para>PS> </maml:para> </maml:introduction> <dev:code>Start-GlobalpingHttp -Target "evotec.xyz" -SimpleLocations "Krakow+PL"</dev:code> <dev:remarks> <maml:para>Returns HTTP response details from the Krakow probe.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 2: Headers only ----------</maml:title> <maml:introduction> <maml:para>PS> </maml:para> </maml:introduction> <dev:code>Start-GlobalpingHttp -Target "https://example.com" -HeadersOnly</dev:code> <dev:remarks> <maml:para>Outputs only the HTTP headers from each probe.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-GlobalpingLimit --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GlobalpingLimit</command:name> <command:verb>Get</command:verb> <command:noun>GlobalpingLimit</command:noun> <maml:description> <maml:para>Retrieve current API rate limits.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Calls the Globalping /limits endpoint and returns limit information.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GlobalpingLimit</maml:name> <!-- Parameter: ApiKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Token"> <maml:name>ApiKey</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Raw --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="AsRaw"> <maml:name>Raw</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ApiKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Token"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>API key used for authenticated calls.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Raw --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="AsRaw"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Return the raw Limits object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Credits --> <command:returnValue> <dev:type> <maml:name>Globalping.Credits</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: LimitInfo --> <command:returnValue> <dev:type> <maml:name>Globalping.LimitInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: Limits --> <command:returnValue> <dev:type> <maml:name>Globalping.Limits</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- Example 1: Check remaining requests ----------</maml:title> <dev:code>Get-GlobalpingLimit</dev:code> <dev:remarks> <maml:para>Returns rate limit information for the anonymous user or provided API key.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-GlobalpingMtr --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-GlobalpingMtr</command:name> <command:verb>Start</command:verb> <command:noun>GlobalpingMtr</command:noun> <maml:description> <maml:para>Start an MTR (My Traceroute) measurement using Globalping.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Combines ping and traceroute information from multiple probes.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Start-GlobalpingMtr</maml:name> <!-- Parameter: Target --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Target</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Token"> <maml:name>ApiKey</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Classic --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Classic</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: InProgressUpdates --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InProgressUpdates</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Locations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Locations</maml:name> <command:parameterValue required="true">LocationRequest[]</command:parameterValue> <dev:type> <maml:name>Globalping.LocationRequest[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Options --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Options</maml:name> <command:parameterValue required="true">MtrOptions</command:parameterValue> <dev:type> <maml:name>Globalping.MtrOptions</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Raw --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="AsRaw"> <maml:name>Raw</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReuseLocationsFromId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReuseLocationsFromId</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SimpleLocations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SimpleLocations</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WaitTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitTime</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>150</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Raw --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="AsRaw"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Return the raw measurement response.</maml:para> <maml:para>Useful when converting the result to custom objects.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Classic --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Classic</maml:name> <maml:description> <maml:para>Output MTR results in classic text form.</maml:para> <maml:para>The text output mirrors the behaviour of the MTR command line tool.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Options --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Options</maml:name> <maml:description> <maml:para>Additional MTR options for the request.</maml:para> <maml:para>Use to configure packet count or other low level parameters.</maml:para> </maml:description> <command:parameterValue required="true">MtrOptions</command:parameterValue> <dev:type> <maml:name>Globalping.MtrOptions</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Target --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Target</maml:name> <maml:description> <maml:para>Target host names, IP addresses or URLs to test.</maml:para> <maml:para>Each value is passed verbatim to the underlying measurement API.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Locations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Locations</maml:name> <maml:description> <maml:para>Detailed location definitions for probes.</maml:para> <maml:para>Each LocationRequest may specify city, country, ASN or provider details.</maml:para> </maml:description> <command:parameterValue required="true">LocationRequest[]</command:parameterValue> <dev:type> <maml:name>Globalping.LocationRequest[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReuseLocationsFromId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReuseLocationsFromId</maml:name> <maml:description> <maml:para>Reuse probe locations from a previous measurement.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SimpleLocations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SimpleLocations</maml:name> <maml:description> <maml:para>Short location identifiers such as city or country codes.</maml:para> <maml:para>Two-letter strings are treated as ISO country codes. Longer values map to the "magic" location syntax used by the API.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Maximum number of probes to use.</maml:para> <maml:para>If omitted the cmdlet estimates a value based on provided locations.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InProgressUpdates --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InProgressUpdates</maml:name> <maml:description> <maml:para>Request progress updates while the measurement runs.</maml:para> <maml:para>When set the API streams partial results that are written as they arrive.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: WaitTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitTime</maml:name> <maml:description> <maml:para>Time in seconds to wait for progress updates.</maml:para> <maml:para>Only applies when InProgressUpdates is specified.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>150</dev:defaultValue> </command:parameter> <!-- Parameter: ApiKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Token"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>API key used to authenticate with Globalping.</maml:para> <maml:para>Anonymous requests may be rate limited.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: MeasurementResponse --> <command:returnValue> <dev:type> <maml:name>Globalping.MeasurementResponse</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: MtrHopResult --> <command:returnValue> <dev:type> <maml:name>Globalping.MtrHopResult</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- Example 1: Run MTR against a host ----------</maml:title> <maml:introduction> <maml:para>PS> </maml:para> </maml:introduction> <dev:code>Start-GlobalpingMtr -Target "evotec.xyz"</dev:code> <dev:remarks> <maml:para>Produces hop statistics for the target.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 2: Limit packets ----------</maml:title> <maml:introduction> <maml:para>PS> </maml:para> </maml:introduction> <dev:code>Start-GlobalpingMtr -Target "example.com" -Options @{ Packets = 3 }</dev:code> <dev:remarks> <maml:para>Configures the probe to send three packets per hop.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-GlobalpingPing --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-GlobalpingPing</command:name> <command:verb>Start</command:verb> <command:noun>GlobalpingPing</command:noun> <maml:description> <maml:para>Start a ping measurement using Globalping.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Instructs remote probes to send ICMP echo requests to the specified target.</maml:para> <maml:para>The cmdlet outputs PingTimingResult objects, raw results or classic text depending on the selected parameters.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Start-GlobalpingPing</maml:name> <!-- Parameter: Target --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Target</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Token"> <maml:name>ApiKey</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Classic --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Classic</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: InProgressUpdates --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InProgressUpdates</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Locations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Locations</maml:name> <command:parameterValue required="true">LocationRequest[]</command:parameterValue> <dev:type> <maml:name>Globalping.LocationRequest[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Options --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Options</maml:name> <command:parameterValue required="true">PingOptions</command:parameterValue> <dev:type> <maml:name>Globalping.PingOptions</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Raw --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="AsRaw"> <maml:name>Raw</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReuseLocationsFromId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReuseLocationsFromId</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SimpleLocations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SimpleLocations</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WaitTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitTime</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>150</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Raw --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="AsRaw"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Return the unprocessed measurement response.</maml:para> <maml:para>When set the cmdlet outputs the MeasurementResponse object returned by the API.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Classic --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Classic</maml:name> <maml:description> <maml:para>Output ping results in the classic text format.</maml:para> <maml:para>Each probe returns the textual output of its ping utility.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Options --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Options</maml:name> <maml:description> <maml:para>Additional ping options sent with the request.</maml:para> <maml:para>Use this to configure packet count or other low level settings.</maml:para> </maml:description> <command:parameterValue required="true">PingOptions</command:parameterValue> <dev:type> <maml:name>Globalping.PingOptions</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Target --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Target</maml:name> <maml:description> <maml:para>Target host names, IP addresses or URLs to test.</maml:para> <maml:para>Each value is passed verbatim to the underlying measurement API.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Locations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Locations</maml:name> <maml:description> <maml:para>Detailed location definitions for probes.</maml:para> <maml:para>Each LocationRequest may specify city, country, ASN or provider details.</maml:para> </maml:description> <command:parameterValue required="true">LocationRequest[]</command:parameterValue> <dev:type> <maml:name>Globalping.LocationRequest[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReuseLocationsFromId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReuseLocationsFromId</maml:name> <maml:description> <maml:para>Reuse probe locations from a previous measurement.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SimpleLocations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SimpleLocations</maml:name> <maml:description> <maml:para>Short location identifiers such as city or country codes.</maml:para> <maml:para>Two-letter strings are treated as ISO country codes. Longer values map to the "magic" location syntax used by the API.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Maximum number of probes to use.</maml:para> <maml:para>If omitted the cmdlet estimates a value based on provided locations.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InProgressUpdates --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InProgressUpdates</maml:name> <maml:description> <maml:para>Request progress updates while the measurement runs.</maml:para> <maml:para>When set the API streams partial results that are written as they arrive.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: WaitTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitTime</maml:name> <maml:description> <maml:para>Time in seconds to wait for progress updates.</maml:para> <maml:para>Only applies when InProgressUpdates is specified.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>150</dev:defaultValue> </command:parameter> <!-- Parameter: ApiKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Token"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>API key used to authenticate with Globalping.</maml:para> <maml:para>Anonymous requests may be rate limited.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: MeasurementResponse --> <command:returnValue> <dev:type> <maml:name>Globalping.MeasurementResponse</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: PingTimingResult --> <command:returnValue> <dev:type> <maml:name>Globalping.PingTimingResult</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- Example 1: Ping from multiple locations ----------</maml:title> <maml:introduction> <maml:para>PS> </maml:para> </maml:introduction> <dev:code>Start-GlobalpingPing -Target "evotec.xyz" -SimpleLocations "DE", "US"</dev:code> <dev:remarks> <maml:para>Runs ping from probes in Germany and the United States.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 2: Request five packets ----------</maml:title> <maml:introduction> <maml:para>PS> </maml:para> </maml:introduction> <dev:code>Start-GlobalpingPing -Target "example.com" -SimpleLocations "PL" -Options @{ Packets = 5 }</dev:code> <dev:remarks> <maml:para>Uses PingOptions to set the packet count.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 3: Output classic text ----------</maml:title> <maml:introduction> <maml:para>PS> </maml:para> </maml:introduction> <dev:code>Start-GlobalpingPing -Target "example.com" -Classic</dev:code> <dev:remarks> <maml:para>Displays the raw ping output returned by the probe.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-GlobalpingProbe --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GlobalpingProbe</command:name> <command:verb>Get</command:verb> <command:noun>GlobalpingProbe</command:noun> <maml:description> <maml:para>Retrieve currently online probes.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Calls the Globalping /probes endpoint and returns probe information.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GlobalpingProbe</maml:name> <!-- Parameter: ApiKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Token"> <maml:name>ApiKey</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Raw --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="AsRaw"> <maml:name>Raw</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ApiKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Token"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>API key used for authenticated calls.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Raw --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="AsRaw"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Return the raw Probes objects.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ProbeInfo --> <command:returnValue> <dev:type> <maml:name>Globalping.ProbeInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: Probes --> <command:returnValue> <dev:type> <maml:name>Globalping.Probes</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- Example 1: List probes ----------</maml:title> <dev:code>Get-GlobalpingProbe</dev:code> <dev:remarks> <maml:para>Outputs flattened probe objects describing each online probe.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-GlobalpingTraceroute --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-GlobalpingTraceroute</command:name> <command:verb>Start</command:verb> <command:noun>GlobalpingTraceroute</command:noun> <maml:description> <maml:para>Start a traceroute measurement using Globalping.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Collects hop information from remote probes with optional classic text output.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Start-GlobalpingTraceroute</maml:name> <!-- Parameter: Target --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Target</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Token"> <maml:name>ApiKey</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Classic --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Classic</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: InProgressUpdates --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InProgressUpdates</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Locations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Locations</maml:name> <command:parameterValue required="true">LocationRequest[]</command:parameterValue> <dev:type> <maml:name>Globalping.LocationRequest[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Options --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Options</maml:name> <command:parameterValue required="true">TracerouteOptions</command:parameterValue> <dev:type> <maml:name>Globalping.TracerouteOptions</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Raw --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="AsRaw"> <maml:name>Raw</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReuseLocationsFromId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReuseLocationsFromId</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SimpleLocations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SimpleLocations</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WaitTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitTime</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>150</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Raw --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="AsRaw"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Return the full measurement response.</maml:para> <maml:para>The object is not converted to individual hops.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Classic --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Classic</maml:name> <maml:description> <maml:para>Output traceroute in classic text form.</maml:para> <maml:para>Returns the text produced by the traceroute utility.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Options --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Options</maml:name> <maml:description> <maml:para>Additional traceroute options for the request.</maml:para> <maml:para>Allows packet size or protocol customization.</maml:para> </maml:description> <command:parameterValue required="true">TracerouteOptions</command:parameterValue> <dev:type> <maml:name>Globalping.TracerouteOptions</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Target --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Target</maml:name> <maml:description> <maml:para>Target host names, IP addresses or URLs to test.</maml:para> <maml:para>Each value is passed verbatim to the underlying measurement API.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Locations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Locations</maml:name> <maml:description> <maml:para>Detailed location definitions for probes.</maml:para> <maml:para>Each LocationRequest may specify city, country, ASN or provider details.</maml:para> </maml:description> <command:parameterValue required="true">LocationRequest[]</command:parameterValue> <dev:type> <maml:name>Globalping.LocationRequest[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReuseLocationsFromId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReuseLocationsFromId</maml:name> <maml:description> <maml:para>Reuse probe locations from a previous measurement.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SimpleLocations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SimpleLocations</maml:name> <maml:description> <maml:para>Short location identifiers such as city or country codes.</maml:para> <maml:para>Two-letter strings are treated as ISO country codes. Longer values map to the "magic" location syntax used by the API.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Limit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Maximum number of probes to use.</maml:para> <maml:para>If omitted the cmdlet estimates a value based on provided locations.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InProgressUpdates --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InProgressUpdates</maml:name> <maml:description> <maml:para>Request progress updates while the measurement runs.</maml:para> <maml:para>When set the API streams partial results that are written as they arrive.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: WaitTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitTime</maml:name> <maml:description> <maml:para>Time in seconds to wait for progress updates.</maml:para> <maml:para>Only applies when InProgressUpdates is specified.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>150</dev:defaultValue> </command:parameter> <!-- Parameter: ApiKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Token"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>API key used to authenticate with Globalping.</maml:para> <maml:para>Anonymous requests may be rate limited.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: MeasurementResponse --> <command:returnValue> <dev:type> <maml:name>Globalping.MeasurementResponse</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: TracerouteHopResult --> <command:returnValue> <dev:type> <maml:name>Globalping.TracerouteHopResult</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- Example 1: Traceroute to a host ----------</maml:title> <maml:introduction> <maml:para>PS> </maml:para> </maml:introduction> <dev:code>Start-GlobalpingTraceroute -Target "evotec.xyz"</dev:code> <dev:remarks> <maml:para>Performs traceroute to the target host.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 2: Return raw output ----------</maml:title> <maml:introduction> <maml:para>PS> </maml:para> </maml:introduction> <dev:code>Start-GlobalpingTraceroute -Target "example.com" -Classic</dev:code> <dev:remarks> <maml:para>Writes the traceroute text produced by the probe.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> </helpItems> |