Get-PSFScriptblock
SYNOPSIS
Access the scriptblocks stored with Set-PSFScriptblock.
SYNTAX
Name (Default)
Get-PSFScriptblock -Name <String[]> [<CommonParameters>]
Container
Get-PSFScriptblock -Name <String[]> [-Container] [<CommonParameters>]
Search
Get-PSFScriptblock [-Name <String[]>] [-List] [-Description <String>] [-Tag <String[]>] [<CommonParameters>]
DESCRIPTION
Access the scriptblocks stored with Set-PSFScriptblock.
Use this command to access scriptblocks designed for easy, processwide access.
EXAMPLES
EXAMPLE 1
Get-PSFScriptblock -Name 'MyModule.TestServer'
Returns the scriptblock stored as 'MyModule.TestServer'
EXAMPLE 2
Get-PSFScriptblock -List
Returns a list of all scriptblocks
EXAMPLE 3
Get-PSFScriptblock -List -Name 'MyModule.TestServer'
Returns scriptblock and meta information for the MyModule.TestServer scriptblock.
EXAMPLE 4
Get-PSFScriptblock -Name 'MyModule.*' -Tag StateChanging, Networking
Returns scriptblock and meta information for all scriptblocks tagged StateChanging or Networking and with a name starting with MyModule.
EXAMPLE 5
Get-PSFScriptblock -Description '*Infrastructure Script*'
Returns scriptblock and meta information for all script blocks containing the description 'Infrastructure Script'.
PARAMETERS
-Name
The name of the scriptblock to request. It's mandatory for explicitly requesting a scriptblock, but optional to use with -List as a filter.
Type: String[]
Parameter Sets: Name, Container
Aliases:
Required: True
Position: Named
Default value: *
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
Type: String[]
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: *
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-List
Instead of requesting a specific scriptblock, list the available ones. This can be further filtered by using a wildcard supporting string as -Name.
Type: SwitchParameter
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Description
Filter scriptblocks by their description using wildcard characters. This can be further filtered by using a wildcard supporting string as -Name.
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Tag
Filter scriptblocks by their tags. This can be further filtered by using a wildcard supporting string as -Name.
Type: String[]
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Container
Return the scriptblock container item rather than the scriptblock directly.
Type: SwitchParameter
Parameter Sets: Container
Aliases:
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.