{"id":1385,"date":"2012-03-28T15:46:46","date_gmt":"2012-03-28T13:46:46","guid":{"rendered":"http:\/\/www.itidea.nl\/?p=1385"},"modified":"2015-09-08T20:36:23","modified_gmt":"2015-09-08T18:36:23","slug":"powershell-export-modulemember-vs-export-keys-in-manifest","status":"publish","type":"post","link":"https:\/\/www.itidea.nl\/index.php\/powershell-export-modulemember-vs-export-keys-in-manifest\/","title":{"rendered":"PowerShell Export-ModuleMember vs Export keys in manifest"},"content":{"rendered":"

In PowerShell there are two ways to export functions, cmdlets, variables and aliases from a script module file for use by the calling context:
\n1. By using Export-ModuleMember and specify what resources need to be exported like:
\nExport-ModuleMember -Function or Export-ModuleMember -Variable<\/p>\n

2. By using a module manifest and specifiy what resources need to be exported like:
\n@{
\n….
\nFunctionsToExport = ‘ VariablesToExport = ”
\n….
\n}<\/p>\n

By seeing this I got a little confused on which method to use and why: Export-ModuleMember or the manifest way, so it was time to dig into this matter.
\nBy creating a small module, a manifest and a script file the different options can be tested.<\/p>\n

Module (psm1)<\/h4>\n

In the module three functions, two with an alias and two variables are defined and exported:<\/p>\n

\r\n$msgText = 'Hello world!'\r\n$anotherVariable = 'more here'\r\n\r\nfunction Say-HelloWorld() { Write-Host $msgText }\r\nfunction Calc-Numbers([int] $a,[int] $b) { $a + $b }\r\nfunction I-Am-Private() { Write-Host "private" }\r\n\r\nSet-Alias Add Calc-Numbers\r\nSet-Alias Hello Say-HelloWorld\r\n\r\nExport-ModuleMember -Function Say-HelloWorld, Calc-Numbers\r\nExport-ModuleMember -Variable msgText, anotherVariable\r\nExport-ModuleMember -Alias Hello, Add\r\n<\/pre>\n
Manifest (psd1)<\/h4>\n
The export variables of the manifest are (default) set to ‘*’:<\/p>\n
\r\n# Functions to export from this module\r\nFunctionsToExport = '*'\r\n\r\n# Cmdlets to export from this module\r\nCmdletsToExport = '*'\r\n\r\n# Variables to export from this module\r\nVariablesToExport = '*'\r\n\r\n# Aliases to export from this module\r\nAliasesToExport = '*'\r\n<\/pre>\n
Script (ps1)<\/h4>\n
The script file imports the module and displays information about the module. This is an excellent way to test what resources are exported:<\/p>\n
\r\nImport-Module ExportFunctions -Force\r\nGet-Module -Name ExportFunctions | fl\r\n<\/pre>\n
Tests<\/h4>\n
Running this script results in the following output:
\n\"\"<\/a><\/p>\n
As can be seen two functions, the aliases and variables are exported as defined in Export-ModuleMember in the module.<\/p>\n
The Export-ModuleMembers lines are now removed to test the default settings in the manifest file (all ‘*’ for the export keys). Running the same script now results in:
\n\"\"<\/a><\/p>\n
All the functions are exported, but none of the alias or variables. At first sight this seems a bit strange, because the generated comment of the export keys of the manifest say ‘ to export from this module’. This seems only the case for the functions.<\/p>\n
TechNet <\/a>documentation for FunctionsToExport key:<\/p>\n
Specifies the functions that the module exports (wildcard characters are permitted) to the caller\u2019s session state. By default, all functions are exported. You can use this key to restrict the functions that are exported by the module…<\/p><\/blockquote>\n
And the TechNet documentation for VariableToExport key:<\/p>\n
Specifies the variables that the module exports (wildcard characters are permitted) to the caller\u2019s session state. By default, all variables are exported. You can use this key to restrict the variables that are exported by the module…<\/p><\/blockquote>\n
The statement don’t differ, but the behavior is.<\/p>\n
The ‘*’ at the FunctionsToExport key means the restriction is:<\/h5>\n
If Export-ModuleMember -Function in the module is used, the functions listed there are exported:<\/span>
\nIn module:<\/p>\n
Export-ModuleMember -Function Say-HelloWorld, Calc-Numbers<\/pre>\n
In manifest:<\/p>\n
FunctionsToExport = '*'<\/pre>\n
Result:
\n\"\"<\/a><\/p>\n
 If Export-ModuleMember -Function is NOT used in the module and in manifest ‘*’ is used all functions are exported: <\/span>
\n\"\"<\/a><\/p>\n
The ‘*’ at the VariablesToExport key means: By default none of the variables are exported, unless variables are exported by the Export-ModuleMember in the module.<\/h5>\n
In module: No Export-ModuleMember -Variable
\nIn manifest:<\/p>\n
VariablesToExport = '*'<\/pre>\n
Result:
\n\"\"<\/a><\/p>\n
In module: No Export-ModuleMember -Variable
\nIn manifest:<\/p>\n
VariablesToExport = 'anotherVariable'<\/pre>\n
Result:
\n\"\"<\/a><\/p>\n
In module:<\/p>\n
Export-ModuleMember -Variable msgText, anotherVariable<\/pre>\n
In manifest:<\/p>\n
VariablesToExport = '*'<\/pre>\n
Result:
\n\"\"<\/a><\/p>\n
In module:<\/p>\n
Export-ModuleMember -Variable msgText, anotherVariable<\/pre>\n
In manifest:<\/p>\n
VariablesToExport = 'anotherVariable'<\/pre>\n
Result:
\n\"\"<\/a><\/p>\n
Summary<\/h3>\n
The export keys in the manifest can be seen as an export override of the Export-ModuleMember used in a module. When testing this behavior with functions alone it can be confusing – at least it confused me – which method to use – manifest export key or Export-ModuleMember – to restrict function exports. When trying to control the exports of variables and aliases it all comes clear: export them in the module at all times!<\/p>\n","protected":false},"excerpt":{"rendered":"
In PowerShell there are two ways to export functions, cmdlets, variables and aliases from a script module file for use by the calling context: 1. By using Export-ModuleMember and specify what resources need to be exported like: Export-ModuleMember -Function or … Read More »<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[22,8],"tags":[43],"class_list":["post-1385","post","type-post","status-publish","format-standard","hentry","category-powershell","category-sharepoint-2010","tag-powershell"],"_links":{"self":[{"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/posts\/1385","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/comments?post=1385"}],"version-history":[{"count":12,"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/posts\/1385\/revisions"}],"predecessor-version":[{"id":1405,"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/posts\/1385\/revisions\/1405"}],"wp:attachment":[{"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/media?parent=1385"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/categories?post=1385"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/tags?post=1385"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}