< Back
Get-OAOLogs
Post
NAME Get-OAOLogs
SYNTAX
Get-OAOLogs [[-Page] <int>] [[-PerPage] <int>] [[-Sort] <string>] [[-Query] <string>] [[-Fields] <string>]
[[-Period] {LAST_HOUR | LAST_24H | LAST_7D | LAST_30D | LAST_365D | CUSTOM}] [[-StartDate] <datetime>] [[-EndDate]
<datetime>] [[-LogId] <string>] [<CommonParameters>]
PARAMETERS
-EndDate <datetime>
(date) The second date in a custom range. Required only if selected period is CUSTOM.
Required? false
Position? 7
Accept pipeline input? true (ByValue)
Parameter set name (All)
Aliases None
Dynamic? false
-Fields <string>
Returns only the parameters requested: fields=id,name,description,hardware.ram
Required? false
Position? 4
Accept pipeline input? true (ByValue)
Parameter set name (All)
Aliases None
Dynamic? false
-LogId <string>
Log ID
Required? false
Position? 8
Accept pipeline input? true (ByValue)
Parameter set name (All)
Aliases None
Dynamic? false
-Page <int>
Allows to use pagination. Sets the number of servers that will be shown in each page.
Required? false
Position? 0
Accept pipeline input? true (ByValue)
Parameter set name (All)
Aliases None
Dynamic? false
-PerPage <int>
Current page to show.
Required? false
Position? 1
Accept pipeline input? true (ByValue)
Parameter set name (All)
Aliases None
Dynamic? false
-Period <PeriodType>
required (one of LAST_HOUR,LAST_24H,LAST_7D,LAST_30D,LAST_365D,CUSTOM ),Time range whose logs will be shown.
Required? false
Position? 5
Accept pipeline input? true (ByValue)
Parameter set name (All)
Aliases None
Dynamic? false
-Query <string>
Allows to search one string in the response and return the elements that contain it. In order to specify the
string use parameter q: q=My server
Required? false
Position? 3
Accept pipeline input? true (ByValue)
Parameter set name (All)
Aliases None
Dynamic? false
-Sort <string>
Allows to sort the result by priority:sort=name retrieves a list of elements ordered by their
names.sort=-creation_date retrieves a list of elements ordered according to their creation date in descending
order of priority.
Required? false
Position? 2
Accept pipeline input? true (ByValue)
Parameter set name (All)
Aliases None
Dynamic? false
-StartDate <datetime>
(date) The first date in a custom range. Required only if selected period is CUSTOM.
Required? false
Position? 6
Accept pipeline input? true (ByValue)
Parameter set name (All)
Aliases None
Dynamic? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
System.String
OneAndOne.POCO.PeriodType
System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
OUTPUTS
OneAndOne.POCO.Response.Logs.LogsResponse
ALIASES
None
REMARKS
None
SYNTAX
Get-OAOLogs [[-Page] <int>] [[-PerPage] <int>] [[-Sort] <string>] [[-Query] <string>] [[-Fields] <string>]
[[-Period] {LAST_HOUR | LAST_24H | LAST_7D | LAST_30D | LAST_365D | CUSTOM}] [[-StartDate] <datetime>] [[-EndDate]
<datetime>] [[-LogId] <string>] [<CommonParameters>]
PARAMETERS
-EndDate <datetime>
(date) The second date in a custom range. Required only if selected period is CUSTOM.
Required? false
Position? 7
Accept pipeline input? true (ByValue)
Parameter set name (All)
Aliases None
Dynamic? false
-Fields <string>
Returns only the parameters requested: fields=id,name,description,hardware.ram
Required? false
Position? 4
Accept pipeline input? true (ByValue)
Parameter set name (All)
Aliases None
Dynamic? false
-LogId <string>
Log ID
Required? false
Position? 8
Accept pipeline input? true (ByValue)
Parameter set name (All)
Aliases None
Dynamic? false
-Page <int>
Allows to use pagination. Sets the number of servers that will be shown in each page.
Required? false
Position? 0
Accept pipeline input? true (ByValue)
Parameter set name (All)
Aliases None
Dynamic? false
-PerPage <int>
Current page to show.
Required? false
Position? 1
Accept pipeline input? true (ByValue)
Parameter set name (All)
Aliases None
Dynamic? false
-Period <PeriodType>
required (one of LAST_HOUR,LAST_24H,LAST_7D,LAST_30D,LAST_365D,CUSTOM ),Time range whose logs will be shown.
Required? false
Position? 5
Accept pipeline input? true (ByValue)
Parameter set name (All)
Aliases None
Dynamic? false
-Query <string>
Allows to search one string in the response and return the elements that contain it. In order to specify the
string use parameter q: q=My server
Required? false
Position? 3
Accept pipeline input? true (ByValue)
Parameter set name (All)
Aliases None
Dynamic? false
-Sort <string>
Allows to sort the result by priority:sort=name retrieves a list of elements ordered by their
names.sort=-creation_date retrieves a list of elements ordered according to their creation date in descending
order of priority.
Required? false
Position? 2
Accept pipeline input? true (ByValue)
Parameter set name (All)
Aliases None
Dynamic? false
-StartDate <datetime>
(date) The first date in a custom range. Required only if selected period is CUSTOM.
Required? false
Position? 6
Accept pipeline input? true (ByValue)
Parameter set name (All)
Aliases None
Dynamic? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
System.String
OneAndOne.POCO.PeriodType
System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
OUTPUTS
OneAndOne.POCO.Response.Logs.LogsResponse
ALIASES
None
REMARKS
None