PowerShell

https://learn.microsoft.com/en-us/powershell/
Admin
PowerShell is a cross-platform task automation and configuration management framework that combines...
Tokens:163,478,205
Snippets:645,448
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Example 1: Get a client push installation

Source: https://learn.microsoft.com/en-us/powershell/module/configurationmanager/get-cmclientpushinstallation

Gets the client push installation for the site system server named CMClientPushInstallationPoint.Western.Contoso.com.

```powershell
PS XYZ:\> Get-CMClientPushInstallation -SiteSystemServerName "CMClientPushInstallationPoint.Western.Contoso.com"
```

--------------------------------

### Install-SPService Example

Source: https://learn.microsoft.com/en-us/powershell/module/microsoft.sharepoint.powershell/install-spservice

Installs all services, service instances, and service proxies specified in the registry on the local server computer.

```powershell
Install-SPService

```

--------------------------------

### Get-WebsiteState example: get state of a website

Source: https://learn.microsoft.com/en-us/powershell/module/webadministration/get-websitestate

Example command that gets the state of the 'Default Web Site' and shows the output 'Started'.

```powershell
IIS:\> Get-WebsiteState -Name "Default Web Site"
Value
-----
Started

```

--------------------------------

### Client installation properties example

Source: https://learn.microsoft.com/en-us/powershell/module/configurationmanager/set-cmclientpushinstallation

Specify installation properties for the Configuration Manager client. This example sets management point and logging options, including enabling debug logging and specifying cache size and site code.

```unknown
/mp:mp01.contoso.com CCMDEBUGLOGGING="1" CCMLOGGINGENABLED="TRUE" CCMLOGLEVEL="0" CCMLOGMAXHISTORY="5" CCMLOGMAXSIZE="10000000" SMSCACHESIZE="15000" SMSSITECODE="XYZ" SMSMP=mp01.contoso.com
```

--------------------------------

### Example: Enable keyboard, video, and mouse support

Source: https://learn.microsoft.com/en-us/powershell/module/hyper-v/enable-vmconsolesupport

Shows how to retrieve virtual machines from a host named Server01 using Get-VM and then enable console support on them with Enable-VMConsoleSupport.

```powershell
PS C:\> $VM = Get-VM -ComputerName "Server01"
PS C:\> Enable-VMConsoleSupport -VM $VM

```

--------------------------------

### Get maintenance schedule by ID

Source: https://learn.microsoft.com/en-us/powershell/module/operationsmanager/get-scommaintenanceschedule

Example command that retrieves a maintenance schedule using its GUID. The example uses the -Id parameter with a sample GUID.

```powershell
PS C:\>Get-SCOMMaintenanceSchedule -Id "32AAB279-3670-ED11-9626-00155D012405"

```

--------------------------------

### Get-AzDtlAutoStartPolicy Example

Source: https://learn.microsoft.com/en-us/powershell/module/az.devtestlabs/get-azdtlautostartpolicy

Example command to get the auto start policy of a lab, using -LabName and -ResourceGroupName parameters. This is an autogenerated example.

```powershell
Get-AzDtlAutoStartPolicy -LabName <String> -ResourceGroupName MyResourceGroup

```

--------------------------------

### Install-SPApp Example

Source: https://learn.microsoft.com/en-us/powershell/module/microsoft.sharepoint.powershell/install-spapp

Imports an app package and then installs it using the Install-SPApp cmdlet.

```powershell
$spapp = Import-SPAppPackage -Path .\feature-upgrade-v1.spapp -Site https://site_url -Source ([microsoft.sharepoint.administration.spappsource]::ObjectModel)
Install-SPApp -Web https://site_url -Identity $spapp

```

--------------------------------

### Example Output: List Windows Virtual Desktop Start Menu Items

Source: https://learn.microsoft.com/en-us/powershell/module/az.desktopvirtualization/get-azwvdstartmenuitem

Shows the output of the Get-AzWvdStartMenuItem command, listing start menu items with their names and types.

```text
Name                                                Type
----                                                ----
ApplicationGroupName/Character Map                  Microsoft.DesktopVirtualization/applicationgroups/startmenuitems
ApplicationGroupName/Defragment and Optimize Drives Microsoft.DesktopVirtualization/applicationgroups/startmenuitems
ApplicationGroupName/Disk Cleanup                   Microsoft.DesktopVirtualization/applicationgroups/startmenuitems
ApplicationGroupName/Internet Explorer              Microsoft.DesktopVirtualization/applicationgroups/startmenuitems

```

--------------------------------

### Get a stamp by ID with Get-SCSPFStamp -ID

Source: https://learn.microsoft.com/en-us/powershell/module/spfadmin/get-scspfstamp

Gets a stamp by its ID. The ID is a GUID, as shown in the example.

```powershell
PS C:\>$Stamp = Get-SCSPFStamp -ID db656655-68ff-4a21-bd1d-0a06bdbc762f

```

--------------------------------

### Get-SPOFontPackage - Example 2: Get font package by GUID

Source: https://learn.microsoft.com/en-us/powershell/module/microsoft.online.sharepoint.powershell/get-spofontpackage

Returns the font package with the specified GUID.

```powershell
Get-SPOFontPackage -Identity 12345678-1234-1234-1234-123456789012

```

--------------------------------

### NuGet provider installation prompt output

Source: https://learn.microsoft.com/en-us/powershell/gallery/how-to/getting-support/bootstrapping-nuget

Example output shown when installing PowerShellGet prompts to install the NuGet provider. Answering Y installs the provider and nuget.exe if necessary.

```output
NuGet provider is required to continue
PowerShellGet requires NuGet provider version '2.8.5.201' or newer to interact with NuGet
-based repositories. The NuGet provider must be available in 'C:\Program Files\PackageMan
agement\ProviderAssemblies' or 'C:\Users\user1\AppData\Local\PackageManagement\ProviderAs
semblies'. You can also install the NuGet provider by running 'Install-PackageProvider -N
ame NuGet -MinimumVersion 2.8.5.201 -Force'. Do you want PowerShellGet to install and imp
ort the NuGet provider now?
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): Y
VERBOSE: Installing NuGet provider.

```

--------------------------------

### Complete example of hpcframework.py

Source: https://learn.microsoft.com/en-us/powershell/high-performance-computing/hpc-pack-mesos-integration-step-by-step

Complete example of starting the HPC Pack Mesos framework with a setup script, setup executable, head node hostname, SSL thumbprint, and client certificate.

```shell
pipenv run python hpcframework.py "setupscript.ps1" "setup.exe" "hpcheadnode" "0386B1198B956BBAAA4154153B6CA1F44B6D1016" "HPC2016Comm.pem"

```

--------------------------------

### Install a product key

Source: https://learn.microsoft.com/en-us/powershell/module/vamt/install-vamtproductkey

Gets a product by fully qualified domain name and installs a product key on it.

```powershell
PS C:\> $Product = Get-VamtProduct | where { $_.fullyqualifieddomainname -eq 'mymachine' }
PS C:\> Install-VamtProductKey -Products $Product -ProductKey "12345-67890-12345-67890-12345"

```

--------------------------------

### Get-WebAppPoolState Example: Get state of DefaultAppPool

Source: https://learn.microsoft.com/en-us/powershell/module/webadministration/get-webapppoolstate

Gets the run-time state of the DefaultAppPool. The output shows the state value 'Started'.

```powershell
IIS:\> Get-WebAppPoolState -Name "DefaultAppPool"
Value
-----
Started
```

--------------------------------

### Install-AzStackHCIRemoteSupport example

Source: https://learn.microsoft.com/en-us/powershell/module/az.stackhci/install-azstackhciremotesupport

Runs the Install-AzStackHCIRemoteSupport cmdlet to install Remote Support.

```powershell
Install-AzStackHCIRemoteSupport

```

--------------------------------

### Start-SPServiceInstance Example

Source: https://learn.microsoft.com/en-us/powershell/module/microsoft.sharepoint.powershell/start-spserviceinstance

Starts the service instance with the given GUID. The GUID is unique to every farm; use Get-SPServiceInstance to find it.

```powershell
Start-SPServiceInstance 67877d63-bff4-4521-867a-ef4979ba07ce

```

--------------------------------

### Example 1: List all application settings of a static site build

Source: https://learn.microsoft.com/en-us/powershell/module/az.websites/get-azstaticwebappbuildfunctionappsetting

Lists all application settings for a static site build using the specified resource group, static web app name, and environment name.

```powershell
Get-AzStaticWebAppBuildFunctionAppSetting -ResourceGroupName azure-rg-test -Name staticweb-portal04 -EnvironmentName 'default'

```

```text
Kind Name        Type
---- ----        ----
     appsettings Microsoft.Web/staticSites/builds/config/functionappsettings

```

--------------------------------

### Get Server Features Example

Source: https://learn.microsoft.com/en-us/powershell/module/servermanagertasks/get-smserverfeature

Retrieves the server features installed on the local server. This is the basic usage example from the documentation.

```powershell
PS C:\>Get-SMServerFeature

```

--------------------------------

### Get-ProvisioningPackage - Example 1

Source: https://learn.microsoft.com/en-us/powershell/module/provisioning/get-provisioningpackage

Example command that retrieves information about the provisioning package at the specified path.

```powershell
PS C:\> Get-ProvisioningPackage -PackagePath c:\test\testppkg.ppkg

```

--------------------------------

### Get all application settings for an application installed on a virtual machine

Source: https://learn.microsoft.com/en-us/powershell/module/virtualmachinemanager/get-scapplicationsetting

Retrieves application settings for an application installed on a virtual machine. The example gets a virtual machine, its applications, and then the settings for the first application.

```powershell
PS C:\> $VM = Get-SCVirtualMachine "VM01"
PS C:\> $Apps = Get-SCApplication -VM $VM
PS C:\> $AppSetting = Get-SCApplicationSetting -ApplicationDeployment $Apps[0]

```

--------------------------------

### Start-AzsBackup Example 1: Start azurestack backup

Source: https://learn.microsoft.com/en-us/powershell/module/azs.backup.admin/start-azsbackup

Runs the Start-AzsBackup cmdlet to start an Azure Stack backup.

```powershell
PS C:\>Start-AzsBackup
```

--------------------------------

### Install-Dtc Example: Install DTC with LogPath and StartType

Source: https://learn.microsoft.com/en-us/powershell/module/msdtc/install-dtc

Installs local DTC with a specified log path and start type AutoStart.

```powershell
PS C:\> Install-Dtc -LogPath "C:\log" -StartType "AutoStart"
```

--------------------------------

### Install-SPApplicationContent Example

Source: https://learn.microsoft.com/en-us/powershell/module/microsoft.sharepoint.powershell/install-spapplicationcontent

Runs the Install-SPApplicationContent cmdlet to copy data to a Web application in the existing folders.

```powershell
Install-SPApplicationContent
```

--------------------------------

### Start BPA scan on all models via pipeline

Source: https://learn.microsoft.com/en-us/powershell/module/bestpractices/invoke-bpamodel

Gets all installed BPA models and pipes them to Invoke-BPAModel to start a scan on all models.

```powershell
PS C:\> Get-BPAModel | Invoke-BPAModel

```

--------------------------------

### Install-ProvisioningPackage Example 1

Source: https://learn.microsoft.com/en-us/powershell/module/provisioning/install-provisioningpackage

Installs the mypackage.ppkg file silently without customer interaction using the -QuietInstall switch.

```powershell
PS C:\> Install-ProvisioningPackage -PackagePath C:\mypackage.ppkg -QuietInstall

```

--------------------------------

### Open-WmsVirtualDesktop example: open a window to a virtual desktop template

Source: https://learn.microsoft.com/en-us/powershell/module/multipointvdi/open-wmsvirtualdesktop

Example command that opens a window connected to the virtual desktop template with the specified GUID.

```powershell
PS C:\> Open-WmsVirtualDesktop -TemplateVirtualMachineGuid "53F56307-B6BF-11D0-94F2-00A0C91EFB8B"
```
Tokens:
Raw