{"id":141,"date":"2018-05-29T07:29:30","date_gmt":"2018-05-29T07:29:30","guid":{"rendered":"http:\/\/michaelschultz.net\/tech\/?p=141"},"modified":"2018-05-29T07:29:30","modified_gmt":"2018-05-29T07:29:30","slug":"powershell-script-template","status":"publish","type":"post","link":"https:\/\/michaelschultz.net\/tech\/powershell-script-template\/","title":{"rendered":"PowerShell Script Template"},"content":{"rendered":"

I recently went to Midwest Management Summit<\/a> aka MMS (and if you are in the ConfigMan world and don’t go then you are missing out). A few of the sessions I attended were centered around scripting and how to improve things.  One thing that was brought up a few times is having a standard on how your scripts are formatted.  This is important as it helps when viewing the script to understand what it does and doing any work on the script.  With that I developed the following PowerShell template I would like to share.<\/p>\n

I did a few searches to get an idea of how others formatted their scripts and what to include in my template.  What I found was that I was leaving a lot out of my previous scripts.  Now that I have this that will no longer be the case.<\/p>\n

<#
\n.SYNOPSIS
\nScript synopsis
\n
\n.SYNTAX
\nScript syntax
\n
\n.DESCRIPTION
\nScript description
\n
\n.PARAMETER
\nParameter input descriptions and repeat this as needed for each parameter
\n
\n.INPUTS
\nInput description if used
\n
\n.OUTPUTS
\nOutput description if used
\n
\n.NOTES
\nFileName:
\nAuthor:
\nContact:
\nCreated:
\nModified:
\nVersion:
\n
\n.EXAMPLE
\nExample description and example
\n#><\/span>
\n
\n#-----Parameters-----<\/span>
\n
\nParam<\/span> (<\/span>
\n
\n)<\/span>
\n
\n#-----Initializations and Module Imports-----<\/span>
\n
\n#-----Variables-----<\/span>
\n
\n#-----Functions-----<\/span>
\n
\n#-----Execution-----<\/span><\/div><\/div>\n","protected":false},"excerpt":{"rendered":"

I recently went to Midwest Management Summit aka MMS (and if you are in the ConfigMan world and don’t go then you are missing out). A few of the sessions I attended were centered around scripting and how to improve things.  One thing that was brought up a few times is having a standard on … Continue reading “PowerShell Script Template”<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"nf_dc_page":"","jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":true,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2}},"categories":[14,13],"tags":[],"class_list":["post-141","post","type-post","status-publish","format-standard","hentry","category-powershell","category-scripting"],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"jetpack_shortlink":"https:\/\/wp.me\/p98a2r-2h","post_mailing_queue_ids":[],"_links":{"self":[{"href":"https:\/\/michaelschultz.net\/tech\/wp-json\/wp\/v2\/posts\/141","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/michaelschultz.net\/tech\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/michaelschultz.net\/tech\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/michaelschultz.net\/tech\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/michaelschultz.net\/tech\/wp-json\/wp\/v2\/comments?post=141"}],"version-history":[{"count":3,"href":"https:\/\/michaelschultz.net\/tech\/wp-json\/wp\/v2\/posts\/141\/revisions"}],"predecessor-version":[{"id":144,"href":"https:\/\/michaelschultz.net\/tech\/wp-json\/wp\/v2\/posts\/141\/revisions\/144"}],"wp:attachment":[{"href":"https:\/\/michaelschultz.net\/tech\/wp-json\/wp\/v2\/media?parent=141"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/michaelschultz.net\/tech\/wp-json\/wp\/v2\/categories?post=141"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/michaelschultz.net\/tech\/wp-json\/wp\/v2\/tags?post=141"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}