IP availability per property

Get-GTMIPAvailability

Synopsis

Get IP availability per property.

Syntax

Get-GTMIPAvailability [-DomainName] <String> [-PropertyName] <String> [-Start] <String> [-End] <String> [[-IP] <String>] [-MostRecent] [[-DatacenterID] <Int32>] [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

GTM combines scores (based on liveness tests) from all web agents to calculate server scores and makes liveness decisions.

The cutoff value is computed for each property from the median scores for all the servers in the property. Any property server with a score over the cutoff value is considered dead and it won't be handed out.

In the request, you should provide values either for the -Start and -End time or the -MostRecent parameter, and not both.

In the response, the handedOut parameter in JSON or the handOut parameter in CSV indicates whether the server was handed out. The alive parameter indicates whether GTM considered the server as alive or not.

Parameters

‑AccountSwitchKey

An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use Get-AccountSwitchKey.

‑DatacenterID

A numeric D of the data center.

‑DomainName
Required

The full GTM domain name.

‑EdgeRCFile

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

‑End
Required

The end date of the report, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time.

‑IP

The IP address of the server.

‑MostRecent

The most recent update.

‑PropertyName
Required

The name of Traffic Management property.

‑Section

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

‑Start
Required

The start date of the report, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time.

Related Links