Manual
Search…
⌃K

Get-BluGenieSessionAliasList



Get-BluGenieSessionAliasList

SYNOPSIS

Get-BluGenieSessionAliasList will display, remove, and export all user defined Aliases for the current powershell session

SYNTAX

Get-BluGenieSessionAliasList [-RemoveAll] [-Force] [-Export] [[-ExportPath] <String>] [[-FormatView] <String>] [-Walkthrough] [-ReturnObject] [-OutUnEscapedJSON] [<CommonParameters>]

DESCRIPTION

Get-BluGenieSessionAliasList will display, remove, and export all user defined Aliases for the current powershell session

EXAMPLES

EXAMPLE 1

Command: Get-BluGenieSessionAliasList
Description: Get the user defined Aliases for the current PowerShell session
Notes:

EXAMPLE 2

Command: Get-BluGenieSessionAliasList -RemoveAll
Description: Remove all user defined Aliases for the current PowerShell session
Notes:

EXAMPLE 3

Command: Get-BluGenieSessionAliasList -Help
Description: Call Help Information
Notes: If Help / WalkThrough is setup as a parameter, this script will be called to setup the Dynamic Help Menu if not the normal
Get-Help will be called with the -Full parameter

EXAMPLE 4

Command: Get-BluGenieSessionAliasList -WalkThrough
Description: Call Help Information [2]
Notes: If Help / WalkThrough is setup as a parameter, this script will be called to setup the Dynamic Help Menu if not the normal
Get-Help will be called with the -Full parameter

EXAMPLE 5

Command: Get-BluGenieSessionAliasList -OutUnEscapedJSON
Description: Get the user defined Aliases for the current PowerShell session and Return Output as UnEscaped JSON format
Notes: The OutUnEscapedJSON is used to beatify the JSON return and not Escape any Characters. Normal return data is a Hash Table.

EXAMPLE 6

Command: Get-BluGenieSessionAliasList -ReturnObject
Description: Get the user defined Aliases for the current PowerShell session and Return Output an Object
Notes: The ReturnObject is used to return a PowerShell Object. Normal return data is a Hash Table.

EXAMPLE 7

Command: Get-BluGenieSessionAliasList -ReturnObject -FormatView JSON
Description: Get the user defined Aliases for the current PowerShell session and Return Object formatted in a JSON view
Notes: The ReturnObject is used to return a PowerShell Object. Normal return data is a Hash Table.

EXAMPLE 8

Command: Get-BluGenieSessionAliasList -ReturnObject -FormatView Custom
Description: Get the user defined Aliases for the current PowerShell session and Return Object formatted in a PSCustom view
Notes: Format-Custom is designed to display views that are not just tables or just lists. You can use the views defined in the
*format.PS1XML files in the PowerShell directory, or you can create your own views in new PS1XML files and use the
Update-FormatData cmdlet to add them to PowerShell.

PARAMETERS

RemoveAll

-RemoveAll [<SwitchParameter>]
Description: Remove all user defined Aliases
Notes:
Alias:
ValidateSet:
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false

Force

-Force [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false

Export

-Export [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false

ExportPath

-ExportPath <String>
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false

FormatView

-FormatView <String>
Description: Select which format to return the object data in.
Notes: Default value is set to (None). This value is only valid when using the -ReturnObject parameter
Alias:
ValidateSet: 'Table','Custom','CustomModified','None','JSON','OutUnEscapedJSON','CSV'
Required? false
Position? 2
Default value Table
Accept pipeline input? false
Accept wildcard characters? false

Walkthrough

-Walkthrough [<SwitchParameter>]
Description: Start the dynamic help menu system to help walk through the current command and all of the parameters
Notes:
Alias: Help
ValidateSet:
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false

ReturnObject

-ReturnObject [<SwitchParameter>]
Description: Return information as an Object
Notes: This is the default return type
Alias:
ValidateSet:
Required? false
Position? named
Default value True
Accept pipeline input? false
Accept wildcard characters? false

OutUnEscapedJSON

-OutUnEscapedJSON [<SwitchParameter>]
Description: Remove UnEsacped Char from the JSON information.
Notes: This will beautify json and clean up the formatting.
Alias:
ValidateSet:
Required? false
Position? named
Default value False
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.