Get-PSFConfig

NAME Get-PSFConfig



SYNOPSIS

Retrieves configuration elements by name.





SYNTAX

Get-PSFConfig [[-FullName] <String>] [-Force] [<CommonParameters>]



Get-PSFConfig [[-Name] <String>] [[-Module] <String>] [-Force] [<CommonParameters>]





DESCRIPTION

Retrieves configuration elements by name.

Can be used to search the existing configuration list.





PARAMETERS

-FullName <String>

Default: "*"

Search for configurations using the full name



Required? false

Position? 1

Default value *

Accept pipeline input? false

Accept wildcard characters? false



-Name <String>

Default: "*"

The name of the configuration element(s) to retrieve.

May be any string, supports wildcards.



Required? false

Position? 2

Default value *

Accept pipeline input? false

Accept wildcard characters? false



-Module <String>

Default: "*"

Search configuration by module.



Required? false

Position? 1

Default value *

Accept pipeline input? false

Accept wildcard characters? false



-Force [<SwitchParameter>]

Overrides the default behavior and also displays hidden configuration values.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

PSFramework.Configuration.Config





-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-PSFConfig 'Mail.To'



Retrieves the configuration element for the key "Mail.To"









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-PSFConfig -Force



Retrieve all configuration elements from all modules, even hidden ones.











RELATED LINKS