Skip to content

Get-B1CustomRedirect

SYNOPSIS

Retrieves a Custom Redirects from BloxOne Threat Defense

SYNTAX

Default (Default)

Get-B1CustomRedirect [-Name <String>] [-Limit <Int32>] [-Offset <Int32>] [-Fields <String[]>]
 [-OrderBy <String>] [-CustomFilters <Object>] [<CommonParameters>]

ID

Get-B1CustomRedirect [-Fields <String[]>] -id <String> [<CommonParameters>]

DESCRIPTION

This function is used to retrieve named redirects from BloxOne Threat Defense.

EXAMPLES

EXAMPLE 1

Get-B1CustomRedirect -Name 'guest-redirect'

created_time : 6/18/2024 11:59:25AM
data         : 2.3.4.5
id           : 1234
name         : guest-redirect
policy_ids   : {123456}
policy_names : {guest-policy}
updated_time : 6/18/2024 11:59:25AM

PARAMETERS

-Name

Filter results by Name.

Type: String
Parameter Sets: Default
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: Default
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: Default
Aliases:

Required: False
Position: Named
Default value: 0
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: Default
Aliases:

Required: False
Position: Named
Default value: None
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: Default
Aliases:

Required: False
Position: Named
Default value: None
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.

INPUTS

OUTPUTS

NOTES