Get-B1Endpoint¶
SYNOPSIS¶
Retrieves a list of BloxOne Endpoints from BloxOne Threat Defense.
SYNTAX¶
Default (Default)¶
Get-B1Endpoint [-Name <String>] [-Status <String>] [-Username <String>] [-EndpointGroup <String>]
[-MACAddress <String>] [-EndpointVersion <String>] [-OSVersion <String>] [-SerialNumber <String>]
[-LastIPAddress <String>] [-Country <String>] [-Limit <Int32>] [-Offset <Int32>] [-tfilter <String>]
[-Fields <String[]>] [-OrderBy <String>] [-OrderByTag <String>] [-Strict] [-CustomFilters <Object>]
[-CaseSensitive] [<CommonParameters>]
ID¶
Get-B1Endpoint [-Name <String>] [-Status <String>] [-Username <String>] [-EndpointGroup <String>]
[-MACAddress <String>] [-EndpointVersion <String>] [-OSVersion <String>] [-SerialNumber <String>]
[-LastIPAddress <String>] [-Country <String>] [-Limit <Int32>] [-Offset <Int32>] [-tfilter <String>]
[-Fields <String[]>] [-OrderBy <String>] [-OrderByTag <String>] [-Strict] [-CustomFilters <Object>]
[-CaseSensitive] -id <String> [<CommonParameters>]
DESCRIPTION¶
This function is used to retrieve a list of BloxOne Endpoints from BloxOne Threat Defense.
EXAMPLES¶
EXAMPLE 1¶
PARAMETERS¶
-Name¶
Filter results by Device Name.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Status¶
Filter results by Device Status.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Username¶
Filter results by Username.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EndpointGroup¶
Filter results by the associated Endpoint Group.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MACAddress¶
Filter devices by MAC Address
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EndpointVersion¶
Filter devices by the endpoint version
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OSVersion¶
Filter devices by the OS version
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SerialNumber¶
Filter devices by the Serial Number
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-LastIPAddress¶
Filter devices by the Last Known IP Address.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Country¶
Filter devices by the associated Country
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Limit¶
Use this parameter to limit the quantity of results.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Offset¶
Use this parameter to offset the results by the value entered for the purpose of pagination
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-tfilter¶
Use this parameter to filter the results returned by tag.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Fields¶
Specify a list of fields to return. The default is to return all fields.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OrderBy¶
Optionally return the list ordered by a particular value. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. Using 'asc' or 'desc' as a suffix will change the ordering, with ascending as default.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OrderByTag¶
Optionally return the list ordered by a particular tag value. Using 'asc' or 'desc' as a suffix will change the ordering, with ascending as default.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Strict¶
Use strict filter matching. By default, filters are searched using wildcards where possible. Using strict matching will only return results matching exactly what is entered in the applicable parameters.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-CustomFilters¶
Accepts either an Object, ArrayList or String containing one or more custom filters. See here for usage: https://ibps.readthedocs.io/en/latest/#-customfilters
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CaseSensitive¶
Use Case Sensitive matching. By default, case-insensitive matching both for -Strict matching and regex matching.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-id¶
Filter the results by id
Type: String
Parameter Sets: ID
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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.