Get-FogHost¶
SYNOPSIS¶
Gets the object of a specific fog host
SYNTAX¶
searchTerm (Default)¶
Get-FogHost [-uuid <String>] [-hostName <String>] [-macAddr <String>] [<CommonParameters>]
byID¶
Get-FogHost -hostID <String> [<CommonParameters>]
serialNumber¶
Get-FogHost -serialNumber <String> [<CommonParameters>]
DESCRIPTION¶
Searches a new or existing object of hosts for a specific host (or hosts) with search options of uuid, hostname, or mac address
if no search terms are specified then it gets the search terms from your host that is making the request and tries to find your
computer in fog.
IF you specify the id of the host, then only that host is queried for in the api, otherwise it gets all hosts and searches
that object with the given parameters.
EXAMPLES¶
EXAMPLE 1¶
Get-FogHost -hostName MeowMachine
This would return the fog details of a host named MeowMachine in your fog instance
EXAMPLE 2¶
Get-FogHost
If you specify no param it will return your current host from fog
EXAMPLE 3¶
Get-FogHost -hostID 1234
Will get the host of id 1234 directly, this is the fastest way to call the function
EXAMPLE 4¶
Get-FogHost -serialNumber 12345678
Will find the given serial number in fog server inventory and then find the host of the hostID that inventory belongs to
PARAMETERS¶
-uuid¶
the uuid of the host
Type: String
Parameter Sets: searchTerm
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-hostName¶
the hostname of the host
Type: String
Parameter Sets: searchTerm
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-macAddr¶
a mac address linked to the host
Type: String
Parameter Sets: searchTerm
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-hostID¶
{{ Fill hostID Description }}
Type: String
Parameter Sets: byID
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-serialNumber¶
{{ Fill serialNumber Description }}
Type: String
Parameter Sets: serialNumber
Aliases:
Required: True
Position: Named
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.