diff --git a/developer/TOC.md b/developer/TOC.md new file mode 100644 index 000000000000..06913f7aeffb --- /dev/null +++ b/developer/TOC.md @@ -0,0 +1 @@ +# [Index](index.md) \ No newline at end of file diff --git a/developer/breadcrumb/toc.yml b/developer/breadcrumb/toc.yml new file mode 100644 index 000000000000..61d8fca61ed1 --- /dev/null +++ b/developer/breadcrumb/toc.yml @@ -0,0 +1,3 @@ +- name: Docs + tocHref: / + topicHref: / \ No newline at end of file diff --git a/developer/index.md b/developer/index.md new file mode 100644 index 000000000000..8b6592d3b73f --- /dev/null +++ b/developer/index.md @@ -0,0 +1 @@ +# Welcome to developer-docs! \ No newline at end of file diff --git a/dsc/TOC.md b/dsc/TOC.md new file mode 100644 index 000000000000..06913f7aeffb --- /dev/null +++ b/dsc/TOC.md @@ -0,0 +1 @@ +# [Index](index.md) \ No newline at end of file diff --git a/dsc/breadcrumb/toc.yml b/dsc/breadcrumb/toc.yml new file mode 100644 index 000000000000..61d8fca61ed1 --- /dev/null +++ b/dsc/breadcrumb/toc.yml @@ -0,0 +1,3 @@ +- name: Docs + tocHref: / + topicHref: / \ No newline at end of file diff --git a/dsc/index.md b/dsc/index.md index 04fdc06bd91a..32a8fffdce87 100644 --- a/dsc/index.md +++ b/dsc/index.md @@ -1,3 +1 @@ ---- -redirect_url: overview ---- \ No newline at end of file +# Welcome to PowerShell_PowerShell-docs_dsc! \ No newline at end of file diff --git a/gallery/TOC.md b/gallery/TOC.md new file mode 100644 index 000000000000..06913f7aeffb --- /dev/null +++ b/gallery/TOC.md @@ -0,0 +1 @@ +# [Index](index.md) \ No newline at end of file diff --git a/gallery/breadcrumb/toc.yml b/gallery/breadcrumb/toc.yml new file mode 100644 index 000000000000..61d8fca61ed1 --- /dev/null +++ b/gallery/breadcrumb/toc.yml @@ -0,0 +1,3 @@ +- name: Docs + tocHref: / + topicHref: / \ No newline at end of file diff --git a/gallery/index.md b/gallery/index.md new file mode 100644 index 000000000000..9bcf2a84d91d --- /dev/null +++ b/gallery/index.md @@ -0,0 +1 @@ +# Welcome to PowerShell_PowerShell-docs_gallery! \ No newline at end of file diff --git a/jea/TOC.md b/jea/TOC.md new file mode 100644 index 000000000000..06913f7aeffb --- /dev/null +++ b/jea/TOC.md @@ -0,0 +1 @@ +# [Index](index.md) \ No newline at end of file diff --git a/jea/breadcrumb/toc.yml b/jea/breadcrumb/toc.yml new file mode 100644 index 000000000000..61d8fca61ed1 --- /dev/null +++ b/jea/breadcrumb/toc.yml @@ -0,0 +1,3 @@ +- name: Docs + tocHref: / + topicHref: / \ No newline at end of file diff --git a/jea/index.md b/jea/index.md new file mode 100644 index 000000000000..4d2931acfb0a --- /dev/null +++ b/jea/index.md @@ -0,0 +1 @@ +# Welcome to PowerShell_PowerShell-docs_jea! \ No newline at end of file diff --git a/reference/3.0/Microsoft.PowerShell.Core/Get-Module.md b/reference/3.0/Microsoft.PowerShell.Core/Get-Module.md index 05fc64f13d11..c26c904e3a2c 100644 --- a/reference/3.0/Microsoft.PowerShell.Core/Get-Module.md +++ b/reference/3.0/Microsoft.PowerShell.Core/Get-Module.md @@ -201,36 +201,39 @@ This lets you see the module files that each script is exporting. ### Example 6: Display the contents of a module manifest -```powershell -The first command gets the PSModuleInfo object that represents BitsTransfer module. It saves the object in the $m variable. +These commands display the contents of the module manifest for the Windows PowerShell **BitsTransfer** module. -PS> $m = Get-Module -list -Name BitsTransfer +Modules are not required to have manifest files. +When they do have a manifest file, the manifest file is required only to include a version number. +However, manifest files often provide useful information about a module, its requirements, and its contents. -The second command uses the Get-Content cmdlet to get the content of the manifest file in the specified path. It uses dot notation to get the path to the manifest file, which is stored in the Path property of the object. The output shows the contents of the module manifest. +```powershell +# First command +PS> $m = Get-Module -list -Name BitsTransfer +# Second command PS> Get-Content $m.Path ``` ```output -@{ -GUID="{8FA5064B-8479-4c5c-86EA-0D311FE48875}" -Author="Microsoft Corporation" -CompanyName="Microsoft Corporation" -Copyright="© Microsoft Corporation. All rights reserved." -ModuleVersion="1.0.0.0" -Description="Windows Powershell File Transfer Module" -PowerShellVersion="2.0" -CLRVersion="2.0" -NestedModules="Microsoft.BackgroundIntelligentTransfer.Management" -FormatsToProcess="FileTransfer.Format.ps1xml" -RequiredAssemblies=Join-Path $psScriptRoot "Microsoft.BackgroundIntelligentTransfer.Management.Interop.dll" +@ { + GUID = "{8FA5064B-8479-4c5c-86EA-0D311FE48875}" + Author = "Microsoft Corporation" + CompanyName = "Microsoft Corporation" + Copyright = "© Microsoft Corporation. All rights reserved." + ModuleVersion = "1.0.0.0" + Description = "Windows Powershell File Transfer Module" + PowerShellVersion = "2.0" + CLRVersion = "2.0" + NestedModules = "Microsoft.BackgroundIntelligentTransfer.Management" + FormatsToProcess = "FileTransfer.Format.ps1xml" + RequiredAssemblies = Join-Path $psScriptRoot "Microsoft.BackgroundIntelligentTransfer.Management.Interop.dll" } ``` -These commands display the contents of the module manifest for the Windows PowerShell **BitsTransfer** module. +The first command gets the PSModuleInfo object that represents BitsTransfer module. It saves the object in the `$m` variable. -Modules are not required to have manifest files and, when they do have a manifest file, the manifest file is required only to include a version number. -However, manifest files often provide useful information about a module, its requirements, and its contents. +The second command uses the `Get-Content` cmdlet to get the content of the manifest file in the specified path. It uses dot notation to get the path to the manifest file, which is stored in the Path property of the object. The output shows the contents of the module manifest. ### Example 7: List files in module directory @@ -274,25 +277,24 @@ For more information, see [`Import-Module`](Import-Module.md) and [`Import-PSSes ### Example 9: Manage a computer that does not run the Windows operating system -```powershell -The first command uses the New-CimSession cmdlet to create a session on the RSDGF03 remote computer. The session connects to WMI on the remote computer. The command saves the CIM session in the $cs variable. +The commands in this example enable you to manage the storage systems of a remote computer that is not running the Windows operating system. +In this example, because the administrator of the computer has installed the Module Discovery WMI provider, the CIM commands can use the default values, which are designed for the provider. +```powershell +# First command PS> $cs = New-CimSession -ComputerName RSDGF03 -The second command uses the CIM session in the $cs variable to run a Get-Module command on the RSDGF03 computer. The command uses the Name parameter to specify the Storage module. The command uses a pipeline operator (|) to send the Storage module to the Import-Module cmdlet, which imports it into the local session. - +# Second command PS> Get-Module -CimSession $cs -Name Storage | Import-Module -The third command runs the Get-Command cmdlet on the Get-Disk command in the Storage module. When you import a CIM module into the local session, Windows PowerShell converts the CDXML files that represent the CIM module into Windows PowerShell scripts, which appear as functions in the local session. - +# Third command PS> Get-Command Get-Disk CommandType Name ModuleName ----------- ---- ---------- Function Get-Disk Storage -The fourth command runs the Get-Disk command. Although the command is typed in the local session, it runs implicitly on the remote computer from which it was imported. The command gets objects from the remote computer and returns them to the local session. - +# Fourth command PS> Get-Disk Number Friendly Name OperationalStatus Total Size Partition Style @@ -300,8 +302,13 @@ Number Friendly Name OperationalStatus Total Size Partitio 0 Virtual HD ATA Device Online 40 GB MBR ``` -The commands in this example enable you to manage the storage systems of a remote computer that is not running a Windows operating system. -In this example, because the administrator of the computer has installed the Module Discovery WMI provider, the CIM commands can use the default values, which are designed for the provider. +The first command uses the `New-CimSession` cmdlet to create a session on the RSDGF03 remote computer. The session connects to WMI on the remote computer. The command saves the CIM session in the `$cs` variable. + +The second command uses the CIM session in the `$cs` variable to run a `Get-Module` command on the RSDGF03 computer. The command uses the Name parameter to specify the Storage module. The command uses a pipeline operator (|) to send the Storage module to the `Import-Module` cmdlet, which imports it into the local session. + +The third command runs the `Get-Command` cmdlet on the `Get-Disk` command in the Storage module. When you import a CIM module into the local session, Windows PowerShell converts the CDXML files that represent the CIM module into Windows PowerShell scripts, which appear as functions in the local session. + +The fourth command runs the `Get-Disk` command. Although the command is typed in the local session, it runs implicitly on the remote computer from which it was imported. The command gets objects from the remote computer and returns them to the local session. ## PARAMETERS diff --git a/reference/4.0/Microsoft.PowerShell.Core/Get-Module.md b/reference/4.0/Microsoft.PowerShell.Core/Get-Module.md index 963af272cbb2..f573f8d1d194 100644 --- a/reference/4.0/Microsoft.PowerShell.Core/Get-Module.md +++ b/reference/4.0/Microsoft.PowerShell.Core/Get-Module.md @@ -112,9 +112,9 @@ PS> Get-Module -FullyQualifiedName @{ModuleName="Microsoft.PowerShell.Management ``` ```output -Name Version ----- ------- -Microsoft.PowerShell.Management 3.1.0.0 +Name Version +---- ------- +Microsoft.PowerShell.Management 3.1.0.0 ``` This command gets the **Microsoft.PowerShell.Management** module by specifying the module's fully qualified name, with the **FullyQualifiedName** parameter. @@ -219,36 +219,39 @@ This lets you see the module files that each script is exporting. ### Example 7: Display the contents of a module manifest -```powershell -The first command gets the PSModuleInfo object that represents BitsTransfer module. It saves the object in the $m variable. +These commands display the contents of the module manifest for the Windows PowerShell **BitsTransfer** module. -PS> $m = Get-Module -list -Name BitsTransfer +Modules are not required to have manifest files. +When they do have a manifest file, the manifest file is required only to include a version number. +However, manifest files often provide useful information about a module, its requirements, and its contents. -The second command uses the Get-Content cmdlet to get the content of the manifest file in the specified path. It uses dot notation to get the path to the manifest file, which is stored in the Path property of the object. The output shows the contents of the module manifest. +```powershell +# First command +PS> $m = Get-Module -list -Name BitsTransfer +# Second command PS> Get-Content $m.Path ``` ```output -@{ -GUID="{8FA5064B-8479-4c5c-86EA-0D311FE48875}" -Author="Microsoft Corporation" -CompanyName="Microsoft Corporation" -Copyright="© Microsoft Corporation. All rights reserved." -ModuleVersion="1.0.0.0" -Description="Windows Powershell File Transfer Module" -PowerShellVersion="2.0" -CLRVersion="2.0" -NestedModules="Microsoft.BackgroundIntelligentTransfer.Management" -FormatsToProcess="FileTransfer.Format.ps1xml" -RequiredAssemblies=Join-Path $psScriptRoot "Microsoft.BackgroundIntelligentTransfer.Management.Interop.dll" +@ { + GUID = "{8FA5064B-8479-4c5c-86EA-0D311FE48875}" + Author = "Microsoft Corporation" + CompanyName = "Microsoft Corporation" + Copyright = "© Microsoft Corporation. All rights reserved." + ModuleVersion = "1.0.0.0" + Description = "Windows Powershell File Transfer Module" + PowerShellVersion = "2.0" + CLRVersion = "2.0" + NestedModules = "Microsoft.BackgroundIntelligentTransfer.Management" + FormatsToProcess = "FileTransfer.Format.ps1xml" + RequiredAssemblies = Join-Path $psScriptRoot "Microsoft.BackgroundIntelligentTransfer.Management.Interop.dll" } ``` -These commands display the contents of the module manifest for the Windows PowerShell **BitsTransfer** module. +The first command gets the PSModuleInfo object that represents BitsTransfer module. It saves the object in the `$m` variable. -Modules are not required to have manifest files and, when they do have a manifest file, the manifest file is required only to include a version number. -However, manifest files often provide useful information about a module, its requirements, and its contents. +The second command uses the `Get-Content` cmdlet to get the content of the manifest file in the specified path. It uses dot notation to get the path to the manifest file, which is stored in the Path property of the object. The output shows the contents of the module manifest. ### Example 8: List files in module directory @@ -292,25 +295,24 @@ For more information, see [`Import-Module`](Import-Module.md) and [`Import-PSSes ### Example 10: Manage a computer that does not run the Windows operating system -```powershell -The first command uses the New-CimSession cmdlet to create a session on the RSDGF03 remote computer. The session connects to WMI on the remote computer. The command saves the CIM session in the $cs variable. +The commands in this example enable you to manage the storage systems of a remote computer that is not running the Windows operating system. +In this example, because the administrator of the computer has installed the Module Discovery WMI provider, the CIM commands can use the default values, which are designed for the provider. +```powershell +# First command PS> $cs = New-CimSession -ComputerName RSDGF03 -The second command uses the CIM session in the $cs variable to run a Get-Module command on the RSDGF03 computer. The command uses the Name parameter to specify the Storage module. The command uses a pipeline operator (|) to send the Storage module to the Import-Module cmdlet, which imports it into the local session. - +# Second command PS> Get-Module -CimSession $cs -Name Storage | Import-Module -The third command runs the Get-Command cmdlet on the Get-Disk command in the Storage module. When you import a CIM module into the local session, Windows PowerShell converts the CDXML files that represent the CIM module into Windows PowerShell scripts, which appear as functions in the local session. - +# Third command PS> Get-Command Get-Disk CommandType Name ModuleName ----------- ---- ---------- Function Get-Disk Storage -The fourth command runs the Get-Disk command. Although the command is typed in the local session, it runs implicitly on the remote computer from which it was imported. The command gets objects from the remote computer and returns them to the local session. - +# Fourth command PS> Get-Disk Number Friendly Name OperationalStatus Total Size Partition Style @@ -318,8 +320,13 @@ Number Friendly Name OperationalStatus Total Size Partitio 0 Virtual HD ATA Device Online 40 GB MBR ``` -The commands in this example enable you to manage the storage systems of a remote computer that is not running a Windows operating system. -In this example, because the administrator of the computer has installed the Module Discovery WMI provider, the CIM commands can use the default values, which are designed for the provider. +The first command uses the `New-CimSession` cmdlet to create a session on the RSDGF03 remote computer. The session connects to WMI on the remote computer. The command saves the CIM session in the `$cs` variable. + +The second command uses the CIM session in the `$cs` variable to run a `Get-Module` command on the RSDGF03 computer. The command uses the Name parameter to specify the Storage module. The command uses a pipeline operator (|) to send the Storage module to the `Import-Module` cmdlet, which imports it into the local session. + +The third command runs the `Get-Command` cmdlet on the `Get-Disk` command in the Storage module. When you import a CIM module into the local session, Windows PowerShell converts the CDXML files that represent the CIM module into Windows PowerShell scripts, which appear as functions in the local session. + +The fourth command runs the `Get-Disk` command. Although the command is typed in the local session, it runs implicitly on the remote computer from which it was imported. The command gets objects from the remote computer and returns them to the local session. ## PARAMETERS diff --git a/reference/5.0/Microsoft.PowerShell.Core/Get-Module.md b/reference/5.0/Microsoft.PowerShell.Core/Get-Module.md index 7cf4fba28221..a39d3bbc84b7 100644 --- a/reference/5.0/Microsoft.PowerShell.Core/Get-Module.md +++ b/reference/5.0/Microsoft.PowerShell.Core/Get-Module.md @@ -115,9 +115,9 @@ PS> Get-Module -FullyQualifiedName @{ModuleName="Microsoft.PowerShell.Management ``` ```output -Name Version ----- ------- -Microsoft.PowerShell.Management 3.1.0.0 +Name Version +---- ------- +Microsoft.PowerShell.Management 3.1.0.0 ``` This command gets the **Microsoft.PowerShell.Management** module by specifying the fully qualified name of the module by using the **FullyQualifiedName** parameter. @@ -222,37 +222,39 @@ This lets you see the module files that each script is exporting. ### Example 7: Display the contents of a module manifest -```powershell -The first command gets the PSModuleInfo object that represents BitsTransfer module. It saves the object in the $m variable. +These commands display the contents of the module manifest for the Windows PowerShell **BitsTransfer** module. -PS> $m = Get-Module -list -Name BitsTransfer +Modules are not required to have manifest files. +When they do have a manifest file, the manifest file is required only to include a version number. +However, manifest files often provide useful information about a module, its requirements, and its contents. -The second command uses the Get-Content cmdlet to get the content of the manifest file in the specified path. It uses dot notation to get the path to the manifest file, which is stored in the Path property of the object. The output shows the contents of the module manifest. +```powershell +# First command +PS> $m = Get-Module -list -Name BitsTransfer +# Second command PS> Get-Content $m.Path ``` ```output -@{ -GUID="{8FA5064B-8479-4c5c-86EA-0D311FE48875}" -Author="Microsoft Corporation" -CompanyName="Microsoft Corporation" -Copyright="© Microsoft Corporation. All rights reserved." -ModuleVersion="1.0.0.0" -Description="Windows Powershell File Transfer Module" -PowerShellVersion="2.0" -CLRVersion="2.0" -NestedModules="Microsoft.BackgroundIntelligentTransfer.Management" -FormatsToProcess="FileTransfer.Format.ps1xml" -RequiredAssemblies=Join-Path $psScriptRoot "Microsoft.BackgroundIntelligentTransfer.Management.Interop.dll" +@ { + GUID = "{8FA5064B-8479-4c5c-86EA-0D311FE48875}" + Author = "Microsoft Corporation" + CompanyName = "Microsoft Corporation" + Copyright = "© Microsoft Corporation. All rights reserved." + ModuleVersion = "1.0.0.0" + Description = "Windows Powershell File Transfer Module" + PowerShellVersion = "2.0" + CLRVersion = "2.0" + NestedModules = "Microsoft.BackgroundIntelligentTransfer.Management" + FormatsToProcess = "FileTransfer.Format.ps1xml" + RequiredAssemblies = Join-Path $psScriptRoot "Microsoft.BackgroundIntelligentTransfer.Management.Interop.dll" } ``` -These commands display the contents of the module manifest for the Windows PowerShell **BitsTransfer** module. +The first command gets the PSModuleInfo object that represents BitsTransfer module. It saves the object in the `$m` variable. -Modules are not required to have manifest files. -When they do have a manifest file, the manifest file is required only to include a version number. -However, manifest files often provide useful information about a module, its requirements, and its contents. +The second command uses the `Get-Content` cmdlet to get the content of the manifest file in the specified path. It uses dot notation to get the path to the manifest file, which is stored in the Path property of the object. The output shows the contents of the module manifest. ### Example 8: List files in module directory @@ -296,25 +298,24 @@ For more information, see [`Import-Module`](Import-Module.md) and [`Import-PSSes ### Example 10: Manage a computer that does not run the Windows operating system -```powershell -The first command uses the New-CimSession cmdlet to create a session on the RSDGF03 remote computer. The session connects to WMI on the remote computer. The command saves the CIM session in the $cs variable. +The commands in this example enable you to manage the storage systems of a remote computer that is not running the Windows operating system. +In this example, because the administrator of the computer has installed the Module Discovery WMI provider, the CIM commands can use the default values, which are designed for the provider. +```powershell +# First command PS> $cs = New-CimSession -ComputerName RSDGF03 -The second command uses the CIM session in the $cs variable to run a Get-Module command on the RSDGF03 computer. The command uses the Name parameter to specify the Storage module. The command uses a pipeline operator (|) to send the Storage module to the Import-Module cmdlet, which imports it into the local session. - +# Second command PS> Get-Module -CimSession $cs -Name Storage | Import-Module -The third command runs the Get-Command cmdlet on the Get-Disk command in the Storage module. When you import a CIM module into the local session, Windows PowerShell converts the CDXML files that represent the CIM module into Windows PowerShell scripts, which appear as functions in the local session. - +# Third command PS> Get-Command Get-Disk CommandType Name ModuleName ----------- ---- ---------- Function Get-Disk Storage -The fourth command runs the Get-Disk command. Although the command is typed in the local session, it runs implicitly on the remote computer from which it was imported. The command gets objects from the remote computer and returns them to the local session. - +# Fourth command PS> Get-Disk Number Friendly Name OperationalStatus Total Size Partition Style @@ -322,8 +323,13 @@ Number Friendly Name OperationalStatus Total Size Partitio 0 Virtual HD ATA Device Online 40 GB MBR ``` -The commands in this example enable you to manage the storage systems of a remote computer that is not running the Windows operating system. -In this example, because the administrator of the computer has installed the Module Discovery WMI provider, the CIM commands can use the default values, which are designed for the provider. +The first command uses the `New-CimSession` cmdlet to create a session on the RSDGF03 remote computer. The session connects to WMI on the remote computer. The command saves the CIM session in the `$cs` variable. + +The second command uses the CIM session in the `$cs` variable to run a `Get-Module` command on the RSDGF03 computer. The command uses the Name parameter to specify the Storage module. The command uses a pipeline operator (|) to send the Storage module to the `Import-Module` cmdlet, which imports it into the local session. + +The third command runs the `Get-Command` cmdlet on the `Get-Disk` command in the Storage module. When you import a CIM module into the local session, Windows PowerShell converts the CDXML files that represent the CIM module into Windows PowerShell scripts, which appear as functions in the local session. + +The fourth command runs the `Get-Disk` command. Although the command is typed in the local session, it runs implicitly on the remote computer from which it was imported. The command gets objects from the remote computer and returns them to the local session. ## PARAMETERS diff --git a/reference/5.1/Microsoft.PowerShell.Core/Get-Module.md b/reference/5.1/Microsoft.PowerShell.Core/Get-Module.md index 10654490013d..8f2423456cf5 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/Get-Module.md +++ b/reference/5.1/Microsoft.PowerShell.Core/Get-Module.md @@ -115,9 +115,9 @@ PS> Get-Module -FullyQualifiedName @{ModuleName="Microsoft.PowerShell.Management ``` ```output -Name Version ----- ------- -Microsoft.PowerShell.Management 3.1.0.0 +Name Version +---- ------- +Microsoft.PowerShell.Management 3.1.0.0 ``` This command gets the **Microsoft.PowerShell.Management** module by specifying the fully qualified name of the module by using the **FullyQualifiedName** parameter. @@ -222,37 +222,39 @@ This lets you see the module files that each script is exporting. ### Example 7: Display the contents of a module manifest -```powershell -The first command gets the PSModuleInfo object that represents BitsTransfer module. It saves the object in the $m variable. +These commands display the contents of the module manifest for the Windows PowerShell **BitsTransfer** module. -PS> $m = Get-Module -list -Name BitsTransfer +Modules are not required to have manifest files. +When they do have a manifest file, the manifest file is required only to include a version number. +However, manifest files often provide useful information about a module, its requirements, and its contents. -The second command uses the Get-Content cmdlet to get the content of the manifest file in the specified path. It uses dot notation to get the path to the manifest file, which is stored in the Path property of the object. The output shows the contents of the module manifest. +```powershell +# First command +PS> $m = Get-Module -list -Name BitsTransfer +# Second command PS> Get-Content $m.Path ``` ```output -@{ -GUID="{8FA5064B-8479-4c5c-86EA-0D311FE48875}" -Author="Microsoft Corporation" -CompanyName="Microsoft Corporation" -Copyright="© Microsoft Corporation. All rights reserved." -ModuleVersion="1.0.0.0" -Description="Windows Powershell File Transfer Module" -PowerShellVersion="2.0" -CLRVersion="2.0" -NestedModules="Microsoft.BackgroundIntelligentTransfer.Management" -FormatsToProcess="FileTransfer.Format.ps1xml" -RequiredAssemblies=Join-Path $psScriptRoot "Microsoft.BackgroundIntelligentTransfer.Management.Interop.dll" +@ { + GUID = "{8FA5064B-8479-4c5c-86EA-0D311FE48875}" + Author = "Microsoft Corporation" + CompanyName = "Microsoft Corporation" + Copyright = "© Microsoft Corporation. All rights reserved." + ModuleVersion = "1.0.0.0" + Description = "Windows Powershell File Transfer Module" + PowerShellVersion = "2.0" + CLRVersion = "2.0" + NestedModules = "Microsoft.BackgroundIntelligentTransfer.Management" + FormatsToProcess = "FileTransfer.Format.ps1xml" + RequiredAssemblies = Join-Path $psScriptRoot "Microsoft.BackgroundIntelligentTransfer.Management.Interop.dll" } ``` -These commands display the contents of the module manifest for the Windows PowerShell **BitsTransfer** module. +The first command gets the PSModuleInfo object that represents BitsTransfer module. It saves the object in the `$m` variable. -Modules are not required to have manifest files. -When they do have a manifest file, the manifest file is required only to include a version number. -However, manifest files often provide useful information about a module, its requirements, and its contents. +The second command uses the `Get-Content` cmdlet to get the content of the manifest file in the specified path. It uses dot notation to get the path to the manifest file, which is stored in the Path property of the object. The output shows the contents of the module manifest. ### Example 8: List files in module directory @@ -296,25 +298,24 @@ For more information, see [`Import-Module`](Import-Module.md) and [`Import-PSSes ### Example 10: Manage a computer that does not run the Windows operating system -```powershell -The first command uses the New-CimSession cmdlet to create a session on the RSDGF03 remote computer. The session connects to WMI on the remote computer. The command saves the CIM session in the $cs variable. +The commands in this example enable you to manage the storage systems of a remote computer that is not running the Windows operating system. +In this example, because the administrator of the computer has installed the Module Discovery WMI provider, the CIM commands can use the default values, which are designed for the provider. +```powershell +# First command PS> $cs = New-CimSession -ComputerName RSDGF03 -The second command uses the CIM session in the $cs variable to run a Get-Module command on the RSDGF03 computer. The command uses the Name parameter to specify the Storage module. The command uses a pipeline operator (|) to send the Storage module to the Import-Module cmdlet, which imports it into the local session. - +# Second command PS> Get-Module -CimSession $cs -Name Storage | Import-Module -The third command runs the Get-Command cmdlet on the Get-Disk command in the Storage module. When you import a CIM module into the local session, Windows PowerShell converts the CDXML files that represent the CIM module into Windows PowerShell scripts, which appear as functions in the local session. - +# Third command PS> Get-Command Get-Disk CommandType Name ModuleName ----------- ---- ---------- Function Get-Disk Storage -The fourth command runs the Get-Disk command. Although the command is typed in the local session, it runs implicitly on the remote computer from which it was imported. The command gets objects from the remote computer and returns them to the local session. - +# Fourth command PS> Get-Disk Number Friendly Name OperationalStatus Total Size Partition Style @@ -322,8 +323,13 @@ Number Friendly Name OperationalStatus Total Size Partitio 0 Virtual HD ATA Device Online 40 GB MBR ``` -The commands in this example enable you to manage the storage systems of a remote computer that is not running the Windows operating system. -In this example, because the administrator of the computer has installed the Module Discovery WMI provider, the CIM commands can use the default values, which are designed for the provider. +The first command uses the `New-CimSession` cmdlet to create a session on the RSDGF03 remote computer. The session connects to WMI on the remote computer. The command saves the CIM session in the `$cs` variable. + +The second command uses the CIM session in the `$cs` variable to run a `Get-Module` command on the RSDGF03 computer. The command uses the Name parameter to specify the Storage module. The command uses a pipeline operator (|) to send the Storage module to the `Import-Module` cmdlet, which imports it into the local session. + +The third command runs the `Get-Command` cmdlet on the `Get-Disk` command in the Storage module. When you import a CIM module into the local session, Windows PowerShell converts the CDXML files that represent the CIM module into Windows PowerShell scripts, which appear as functions in the local session. + +The fourth command runs the `Get-Disk` command. Although the command is typed in the local session, it runs implicitly on the remote computer from which it was imported. The command gets objects from the remote computer and returns them to the local session. ## PARAMETERS diff --git a/reference/TOC.md b/reference/TOC.md new file mode 100644 index 000000000000..06913f7aeffb --- /dev/null +++ b/reference/TOC.md @@ -0,0 +1 @@ +# [Index](index.md) \ No newline at end of file diff --git a/reference/breadcrumb/toc.yml b/reference/breadcrumb/toc.yml new file mode 100644 index 000000000000..61d8fca61ed1 --- /dev/null +++ b/reference/breadcrumb/toc.yml @@ -0,0 +1,3 @@ +- name: Docs + tocHref: / + topicHref: / \ No newline at end of file diff --git a/reference/index.md b/reference/index.md index a9a0d2ece740..ac9cd0c372de 100644 --- a/reference/index.md +++ b/reference/index.md @@ -1,3 +1 @@ ---- -redirect_url: readme ---- \ No newline at end of file +# Welcome to PowerShell_PowerShell-docs_reference! \ No newline at end of file diff --git a/wmf/TOC.md b/wmf/TOC.md new file mode 100644 index 000000000000..06913f7aeffb --- /dev/null +++ b/wmf/TOC.md @@ -0,0 +1 @@ +# [Index](index.md) \ No newline at end of file diff --git a/wmf/breadcrumb/toc.yml b/wmf/breadcrumb/toc.yml new file mode 100644 index 000000000000..61d8fca61ed1 --- /dev/null +++ b/wmf/breadcrumb/toc.yml @@ -0,0 +1,3 @@ +- name: Docs + tocHref: / + topicHref: / \ No newline at end of file diff --git a/wmf/index.md b/wmf/index.md new file mode 100644 index 000000000000..f014313b1e40 --- /dev/null +++ b/wmf/index.md @@ -0,0 +1 @@ +# Welcome to PowerShell_PowerShell-docs_wmf! \ No newline at end of file