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
Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Account Switch Keys can be found using Get-AccountSwitchKey
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DatacenterID
Numeric id
of the data center.
Type: Int32
Parameter Sets: (All)
Aliases: None
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DomainName
The full GTM domain name.
Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EdgeRCFile
EdgeRC file to authenticate your command. Defaults to ~/.edgerc
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-End
End date of report, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ
in UTC time.
Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IP
IP address of the server.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MostRecent
Most recent update.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-PropertyName
Name of Traffic Management property.
Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Section
EdgeRC section to retrieve authentication credentials from. Defaults to default
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Start
Start date of report, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ
in UTC time.
Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common Parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
Outputs
System.Object