Get-CentreonHostStatus

NAME Get-CentreonHostStatus



SYNOPSIS

Retrieve host status information.





SYNTAX

Get-CentreonHostStatus [-Session] <Object> [[-viewType] <String>] [[-fields] <Array>] [[-status] <String>]

[[-hostgroup] <Int32>] [[-instance] <Int32>] [[-search] <String>] [[-criticality] <String>] [[-sortType] <String>]

[[-limit] <Int32>] [[-number] <Int32>] [[-order] <String>] [<CommonParameters>]





DESCRIPTION

All monitoring information regarding hosts are available in throw the Centreon API.

With this call, you can also get host informations in the same time that service information.

This web service provide the same possibility that the service monitoring view.





PARAMETERS

-Session <Object>

Specify object get from New-CentreonCommand cmdlet.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-viewType <String>

Select monitoring view type.

Values accepted: "all", "unhandled", "problems"

Default is 'all'.



Required? false

Position? 2

Default value all

Accept pipeline input? false

Accept wildcard characters? false



-fields <Array>

Select-Object separated by a ','



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-status <String>

Select hosts by status.

Values accepted: "all", "up", "down", "unreachable", "pending"

Default is 'all'.



Required? false

Position? 4

Default value all

Accept pipeline input? false

Accept wildcard characters? false



-hostgroup <Int32>

Hostgroup id to filter.



Required? false

Position? 5

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-instance <Int32>

Instance id filter.



Required? false

Position? 6

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-search <String>

Search by name of service via an SQL LIKE type search.



Required? false

Position? 7

Default value

Accept pipeline input? false

Accept wildcard characters? false



-criticality <String>

Criticality Filter.



Required? false

Position? 8

Default value

Accept pipeline input? false

Accept wildcard characters? false



-sortType <String>

Sort by field.



Required? false

Position? 9

Default value

Accept pipeline input? false

Accept wildcard characters? false



-limit <Int32>

Number of object return.



Required? false

Position? 10

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-number <Int32>

Page number.



Required? false

Position? 11

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-order <String>

Sort objects return.

Values accepted: "ASC", "DESC".

Default is 'ASC'.



Required? false

Position? 12

Default value ASC

Accept pipeline input? false

Accept wildcard characters? 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



OUTPUTS



NOTES





https://github.com/ClissonFlorian/Centr ... ell-Module



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-CentreonHostStatus -status all -order ASC -fields description -Session $Session













-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-CentreonHostStatus -search 'cent%' -Session $Session















RELATED LINKS

https://documentation.centreon.com/docs ... ost-status