Creating a SharePoint 2013 PowerShell Help Document with Examples
Creating a SharePoint 2013 PowerShell Help Document with Examples
All of this was done inside of the SharePoint 2013 Management Shell running as Administrator in my test and development environment. Do Not Try In Production.
(For instructor-led SharePoint 2013 training, see our course schedule)
I first ran the following command in order to get all the SharePoint Commandlets into the variable:
$com
1 | $com = Get-Command “*-SP*” |
I then typed $com into the shell and it wrote a list of all the SharePoint commandlets to the host screen!
Next I looped through the collection and got the help documentation including examples for each commandlet and wrote it out to a txt file using the –NoClobber (don’t overwrite) and the –Append (add to the file flags to create a text file of all the SharePoint Commandlets including their help documentation and examples using this line:
1 | foreach($s in $com){help $s.Name –Examples | Out-File max.txt –NoClobber –Append} |
(I typed it all on one line in the shell)
I then typed:
1 | Notepad max.txt |
And there it was in all its glory, my own personal detailed, comprehensive help file!
My help file is almost 800 pages when I pasted it into Microsoft Word 2013!!
I will keep both the .docx as well as the .txt versions, one for readability and one for copy pasting.
I will be working on outing it to html or xml and creating a JQuery site with the results, but that’s another blog post.
Spike Xavier
SharePoint Instructor – Interface Technical Training
Phoenix, AZ
You May Also Like
Agile Methodology in Project Management
0 162 0In this video, you will gain an understanding of Agile and Scrum Master Certification terminologies and concepts to help you make better decisions in your Project Management capabilities. Whether you’re a developer looking to obtain an Agile or Scrum Master Certification, or you’re a Project Manager/Product Owner who is attempting to get your product or … Continue reading Agile Methodology in Project Management
Windows 10 Managing, Deploying and Configuring – December 2, 2015
0 444 1In this recorded Windows 10 training webinar from December 2, 2015, Windows Server instructor Rick Trader presents the deployment and management of Windows 10 Enterprise and the new Provisioning capability in Windows 10. Learn how to manage Windows 10 deployments using System Center Configuration Manager, Mobile Device Management and Intune. Also included in his presentation … Continue reading Windows 10 Managing, Deploying and Configuring – December 2, 2015
Detailed Forensic Investigation of Malware Infections – April 21, 2015
4 647 5How does an investigator hunt down and identify unknown malware? In this recording of our IT Security training webinar on April 21, 2015, Security expert Mike Danseglio (CISSP / CEH) performed several malware investigations on infected computers and identify symptoms, find root cause, and follow the leads to determine what’s happening. He demonstrated his preferred … Continue reading Detailed Forensic Investigation of Malware Infections – April 21, 2015