Search icon CANCEL
Subscription
0
Cart icon
Your Cart (0 item)
Close icon
You have no products in your basket yet
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Free Learning
Arrow right icon
Mastering PowerCLI
Mastering PowerCLI

Mastering PowerCLI: Master PowerCLI to automate all aspects of VMware environments

eBook
€24.99 €36.99
Paperback
€45.99
Subscription
Free Trial
Renews at €18.99p/m

What do you get with a Packt Subscription?

Free for first 7 days. $19.99 p/m after that. Cancel any time!
Product feature icon Unlimited ad-free access to the largest independent learning library in tech. Access this title and thousands more!
Product feature icon 50+ new titles added per month, including many first-to-market concepts and exclusive early access to books as they are being written.
Product feature icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Product feature icon Thousands of reference materials covering every tech concept you need to stay up to date.
Subscribe now
View plans & pricing
Table of content icon View table of contents Preview book icon Preview Book

Mastering PowerCLI

Chapter 2. Reusable Advanced Functions and Scripts

In the first chapter, we revisited PowerShell and PowerCLI basics. Then, we discussed how we could use the GitHub version to control our work and collaborate with others to work on the same project. We also learned how to use Pester to do unit testing on our work. In this chapter, we are going to cover advanced functions and their implementations in PowerShell. Specifically, we are going to talk about the following topics:

  • Specifying function attributes
  • Specifying parameter attributes
  • Using parameter validation attributes
  • Using dynamic parameters
  • PowerShell help files
  • Creating comment-based help
  • Error handling in PowerShell

Before we start discussing advanced functions, let's take a look at normal functions. If you type Get-Help About_Functions in PowerShell, you can get the details of functions. The description says a function is a list of Windows PowerShell statements that has a name that you can assign. When you run a function...

Specifying function attributes

In case of advanced functions, we use Cmdlet bindings to control the feature or function of the function itself. With this, we define how the function works or behaves.

Addition of the [CmdletBinding()]line allows you to define these controls in an advanced function. Note that with the use of CmdletBinding(), we get the $PSCmdlet automatic variable, but the $Args variable is not available in these functions.

In advanced functions, with the CmdletBinding attribute, unknown parameters and positional arguments that do not have any matching positional parameters results in parameter binding to fail.

Let's examine the available options with the CmdletBinding() attribute and their meaning:

<#
     Comment Based Help
#>
function <function_name> {

[CmdletBinding(ConfirmImpact=<String>,
                     DefaultParameterSetName=<String>,
                     HelpURI=<URI>,
                     SupportsPaging=<Boolean>,
   ...

Specifying parameter attributes

In this section, we will discuss the parameter attributes and how to set them. The attributes falling under this category define the different attributes of the parameter itself. Let's take a closer look at the most useful and common options available to define parameter attributes and their uses:

  • Mandatory argument: This argument indicates that this particular parameter is compulsory, otherwise it is optional. For example, if I am writing a function to connect to a vCenter server and doing some work and I want the vCenter name to be provided at runtime, then the following code makes sure that the cmdlet call will fail without the $VCName parameter:
    Param (
      [parameter(Mandatory=$true)]
      [String]$VCName
    )
  • Position argument: We define the positional argument to specify which value will be assigned to which parameter by the position of the values at runtime, without the need to specify the parameter name. PowerShell will understand which parameter the value...

Using parameter validation attributes

Attributes falling under this category define the attributes that we can use to validate the value of a parameter/variable itself. The following is a list of the most commonly used parameters:

  • AllowNull / AllowEmptyString: This attribute allows a mandatory parameter to accept a NULL value or empty string. Check the following example. When this attribute is not set, the function does not allow us to give an empty string as an input to the $VCName parameter, as it is a mandatory input. When we comment out the AllowEmptyString parameter, it throws an error:
    Function Get-VC{
        [cmdletbinding()]
    
        Param(
        [Parameter(Mandatory = $true)]
    #    [AllowEmptyString()]
        [String]$VCName
        )
        Write-Host "vCenter Name: $VCName"
    }
    Using parameter validation attributes

    Notice that, when this attribute is set, the function allows us to give an empty string as the input to the $VCName parameter:

    Using parameter validation attributes
  • ValidateCount: This attribute specifies the minimum and maximum number of values that a parameter...

Dynamic parameters

All the earlier examples were examples of static parameters. Before the cmdlets of the function are executed, these parameters come into existence and remain available for the entire duration of the scope of the function. Dynamic parameters are those parameters that are defined in such a way that depending on certain conditions only, they come into existence. It may be designed in such a way that a dynamic parameter will come into existence only when another parameter is used in the function or a parameter has a certain value. So, late binding is applied for these types of parameters.

For example, let's discuss the following requirements:

  • We want to create a VM, provided the VM name is given by a user.
  • We have three different environments named Dedicated, Shared, and Cloud where the VM can be created.
  • If any environment is not mentioned by a user, then by default the VM will be created in the shared environment.
  • For a shared and Cloud environment, providing a VM name...

Switch parameters

Switch parameters are parameters without any need to assign any value to them. As the name suggests, they act as a switch. By default, their values are $false. Once these parameters are mentioned in the command line, their values become $true. We can use this switch parameter to perform our checks and run their respective script blocks. The following example is a function that connects to a vCenter server or vCloud Director server based on the input that we provide. As parameter values, we accept ServerName and UserName to connect to the server, Password for the connection, and another parameter that will act as a switch. If we mention –VCServer in the command line, then the Connect-VIServer cmdlets will be executed; if –VCDServer is mentioned, then the Connect-CIServer cmdlets will be executed. So, run the following code snippet:

Function Connect-Server{
[CmdletBinding()]
 Param(
    [Parameter(Mandatory=$true)]
            [string]$ServerName,
         ...

Specifying function attributes


In case of advanced functions, we use Cmdlet bindings to control the feature or function of the function itself. With this, we define how the function works or behaves.

Addition of the [CmdletBinding()]line allows you to define these controls in an advanced function. Note that with the use of CmdletBinding(), we get the $PSCmdlet automatic variable, but the $Args variable is not available in these functions.

In advanced functions, with the CmdletBinding attribute, unknown parameters and positional arguments that do not have any matching positional parameters results in parameter binding to fail.

Let's examine the available options with the CmdletBinding() attribute and their meaning:

<#
     Comment Based Help
#>
function <function_name> {

[CmdletBinding(ConfirmImpact=<String>,
                     DefaultParameterSetName=<String>,
                     HelpURI=<URI>,
                     SupportsPaging=<Boolean>,
          ...

Specifying parameter attributes


In this section, we will discuss the parameter attributes and how to set them. The attributes falling under this category define the different attributes of the parameter itself. Let's take a closer look at the most useful and common options available to define parameter attributes and their uses:

  • Mandatory argument: This argument indicates that this particular parameter is compulsory, otherwise it is optional. For example, if I am writing a function to connect to a vCenter server and doing some work and I want the vCenter name to be provided at runtime, then the following code makes sure that the cmdlet call will fail without the $VCName parameter:

    Param (
      [parameter(Mandatory=$true)]
      [String]$VCName
    )
  • Position argument: We define the positional argument to specify which value will be assigned to which parameter by the position of the values at runtime, without the need to specify the parameter name. PowerShell will understand which parameter the value...

Using parameter validation attributes


Attributes falling under this category define the attributes that we can use to validate the value of a parameter/variable itself. The following is a list of the most commonly used parameters:

  • AllowNull / AllowEmptyString: This attribute allows a mandatory parameter to accept a NULL value or empty string. Check the following example. When this attribute is not set, the function does not allow us to give an empty string as an input to the $VCName parameter, as it is a mandatory input. When we comment out the AllowEmptyString parameter, it throws an error:

    Function Get-VC{
        [cmdletbinding()]
    
        Param(
        [Parameter(Mandatory = $true)]
    #    [AllowEmptyString()]
        [String]$VCName
        )
        Write-Host "vCenter Name: $VCName"
    }

    Notice that, when this attribute is set, the function allows us to give an empty string as the input to the $VCName parameter:

  • ValidateCount: This attribute specifies the minimum and maximum number of values that a parameter accepts...

Dynamic parameters


All the earlier examples were examples of static parameters. Before the cmdlets of the function are executed, these parameters come into existence and remain available for the entire duration of the scope of the function. Dynamic parameters are those parameters that are defined in such a way that depending on certain conditions only, they come into existence. It may be designed in such a way that a dynamic parameter will come into existence only when another parameter is used in the function or a parameter has a certain value. So, late binding is applied for these types of parameters.

For example, let's discuss the following requirements:

  • We want to create a VM, provided the VM name is given by a user.

  • We have three different environments named Dedicated, Shared, and Cloud where the VM can be created.

  • If any environment is not mentioned by a user, then by default the VM will be created in the shared environment.

  • For a shared and Cloud environment, providing a VM name would...

Left arrow icon Right arrow icon

Key benefits

  • • Leverage PowerCLI to perform administration tasks in a more effective and efficient way
  • • Escape from daily tedious and repetitive tasks by unleashing the full potential of your creative side through scripting
  • • Master the intricate workings of PowerShell and PowerCLI through easy and real-life examples

Description

Have you ever wished that every morning you could automatically get a report with all the relevant information about your datacenter in exactly the same format you want? Or whether you could automate that boring, exhausting task? What if some crucial task needs to be performed on a regular basis without any error? PowerCLI scripts do all that and much more for VMware environments. It is built on top of the popular Windows PowerShell, with which you can automate server tasks and reduce manual input, allowing you to focus on more important tasks. This book will help you to achieve your goals by starting with a short refresher on PowerShell and PowerCLI and then covering the nuances of advanced functions and reusable scripts. Next you will learn how to build a vSphere-powered virtualized datacenter using PowerCLI while managing different aspects of the environment including automated installation, network, and storage. You will then manage different logical constructs of vSphere environment and different aspects of a virtual machine. Later, you will implement the best practices for a security implementation in vSphere Environment through PowerCLI before discovering how to manage other VMware environments such as SRM, vCloud Director and vCloud Air through PowerCLI. You will also learn to manage vSphere environments using advanced properties by accessing vSphere API and REST APIs through PowerCLI. Finally, you will build a Windows GUI application using PowerShell followed by a couple of sample scripts for reporting and managing vSphere environments with detailed explanations of the scripts. By the end of the book, you will have the required in-depth knowledge to master the art of PowerCLI scripting.

Who is this book for?

If you are a system administrator with working knowledge of PowerShell and PowerCLI who wants to perform quick and easy scripting but at the same time achieve complex results and write production grade scripts, then this book is for you.

What you will learn

  • • Use GitHub for collaboration and Pester to automate unit tests
  • • Write advanced reusable functions and dynamic variables and learn about error handling in PowerShell
  • • Automate ESXi host installation using Auto-Deploy, host profile, and host image
  • • Implement security best practices in a vSphere data center
  • • Manage SRM, vCloud Air, and vRealize Operations environments
  • • Access and utilize vSphere APIs to manage advanced aspects of vSphere and work with .NET view objects
  • • Utilize REST APIs to manage vRealize Automation environments
  • • Create a Windows GUI through the use of PowerShell and Sapien PrimalForms CE

Product Details

Country selected
Publication date, Length, Edition, Language, ISBN-13
Publication date : Oct 16, 2015
Length: 430 pages
Edition : 1st
Language : English
ISBN-13 : 9781785286858
Vendor :
Microsoft
Languages :
Tools :

What do you get with a Packt Subscription?

Free for first 7 days. $19.99 p/m after that. Cancel any time!
Product feature icon Unlimited ad-free access to the largest independent learning library in tech. Access this title and thousands more!
Product feature icon 50+ new titles added per month, including many first-to-market concepts and exclusive early access to books as they are being written.
Product feature icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Product feature icon Thousands of reference materials covering every tech concept you need to stay up to date.
Subscribe now
View plans & pricing

Product Details

Publication date : Oct 16, 2015
Length: 430 pages
Edition : 1st
Language : English
ISBN-13 : 9781785286858
Vendor :
Microsoft
Languages :
Tools :

Packt Subscriptions

See our plans and pricing
Modal Close icon
€18.99 billed monthly
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Simple pricing, no contract
€189.99 billed annually
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just €5 each
Feature tick icon Exclusive print discounts
€264.99 billed in 18 months
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just €5 each
Feature tick icon Exclusive print discounts

Frequently bought together


Stars icon
Total 129.97
Mastering PowerCLI
€45.99
PowerCLI Cookbook
€41.99
Learning PowerCLI
€41.99
Total 129.97 Stars icon
Banner background image

Table of Contents

13 Chapters
1. PowerShell and PowerCLI Refresher Chevron down icon Chevron up icon
2. Reusable Advanced Functions and Scripts Chevron down icon Chevron up icon
3. Deploying vSphere Hosts Chevron down icon Chevron up icon
4. Managing Networks Chevron down icon Chevron up icon
5. Managing Storage Chevron down icon Chevron up icon
6. Managing Clusters and Other Constructs Chevron down icon Chevron up icon
7. Managing Virtual Machines Chevron down icon Chevron up icon
8. Managing vSphere Security, SRM, vCloud Air, and vROps Chevron down icon Chevron up icon
9. Managing the vSphere API Chevron down icon Chevron up icon
10. Using REST APIs Chevron down icon Chevron up icon
11. Creating Windows GUI Chevron down icon Chevron up icon
12. Best Practices and Sample Scripts Chevron down icon Chevron up icon
Index Chevron down icon Chevron up icon

Customer reviews

Rating distribution
Full star icon Full star icon Full star icon Full star icon Full star icon 5
(2 Ratings)
5 star 100%
4 star 0%
3 star 0%
2 star 0%
1 star 0%
Amazon Customer Dec 07, 2015
Full star icon Full star icon Full star icon Full star icon Full star icon 5
The book is useful for every VMware administrator having daily hands on of various VMware solutions.The book covers right mix of content across the VMware solutions to automate them.
Amazon Verified review Amazon
Andru Dec 01, 2015
Full star icon Full star icon Full star icon Full star icon Full star icon 5
Very good read and highly recommended. It does require a decent base knowledge of .NET objects and Powershell, but the author does a great job breaking the numerous tasks in the book down into a way that that is easily understandable. Debanth touches various tasks ranging from simply connecting to a vCenter Server as well as using REST APIs. Very dynamic range of information.There were a few typos that the publishers were made aware of and they put in the effort to respond and verify that they would be correcting them. The main one was dealing with comparison operators and their syntax.Overall definitely recommended if you require PowerCLI on a regular basis for your occupation or for fun!
Amazon Verified review Amazon
Get free access to Packt library with over 7500+ books and video courses for 7 days!
Start Free Trial

FAQs

What is included in a Packt subscription? Chevron down icon Chevron up icon

A subscription provides you with full access to view all Packt and licnesed content online, this includes exclusive access to Early Access titles. Depending on the tier chosen you can also earn credits and discounts to use for owning content

How can I cancel my subscription? Chevron down icon Chevron up icon

To cancel your subscription with us simply go to the account page - found in the top right of the page or at https://subscription.packtpub.com/my-account/subscription - From here you will see the ‘cancel subscription’ button in the grey box with your subscription information in.

What are credits? Chevron down icon Chevron up icon

Credits can be earned from reading 40 section of any title within the payment cycle - a month starting from the day of subscription payment. You also earn a Credit every month if you subscribe to our annual or 18 month plans. Credits can be used to buy books DRM free, the same way that you would pay for a book. Your credits can be found in the subscription homepage - subscription.packtpub.com - clicking on ‘the my’ library dropdown and selecting ‘credits’.

What happens if an Early Access Course is cancelled? Chevron down icon Chevron up icon

Projects are rarely cancelled, but sometimes it's unavoidable. If an Early Access course is cancelled or excessively delayed, you can exchange your purchase for another course. For further details, please contact us here.

Where can I send feedback about an Early Access title? Chevron down icon Chevron up icon

If you have any feedback about the product you're reading, or Early Access in general, then please fill out a contact form here and we'll make sure the feedback gets to the right team. 

Can I download the code files for Early Access titles? Chevron down icon Chevron up icon

We try to ensure that all books in Early Access have code available to use, download, and fork on GitHub. This helps us be more agile in the development of the book, and helps keep the often changing code base of new versions and new technologies as up to date as possible. Unfortunately, however, there will be rare cases when it is not possible for us to have downloadable code samples available until publication.

When we publish the book, the code files will also be available to download from the Packt website.

How accurate is the publication date? Chevron down icon Chevron up icon

The publication date is as accurate as we can be at any point in the project. Unfortunately, delays can happen. Often those delays are out of our control, such as changes to the technology code base or delays in the tech release. We do our best to give you an accurate estimate of the publication date at any given time, and as more chapters are delivered, the more accurate the delivery date will become.

How will I know when new chapters are ready? Chevron down icon Chevron up icon

We'll let you know every time there has been an update to a course that you've bought in Early Access. You'll get an email to let you know there has been a new chapter, or a change to a previous chapter. The new chapters are automatically added to your account, so you can also check back there any time you're ready and download or read them online.

I am a Packt subscriber, do I get Early Access? Chevron down icon Chevron up icon

Yes, all Early Access content is fully available through your subscription. You will need to have a paid for or active trial subscription in order to access all titles.

How is Early Access delivered? Chevron down icon Chevron up icon

Early Access is currently only available as a PDF or through our online reader. As we make changes or add new chapters, the files in your Packt account will be updated so you can download them again or view them online immediately.

How do I buy Early Access content? Chevron down icon Chevron up icon

Early Access is a way of us getting our content to you quicker, but the method of buying the Early Access course is still the same. Just find the course you want to buy, go through the check-out steps, and you’ll get a confirmation email from us with information and a link to the relevant Early Access courses.

What is Early Access? Chevron down icon Chevron up icon

Keeping up to date with the latest technology is difficult; new versions, new frameworks, new techniques. This feature gives you a head-start to our content, as it's being created. With Early Access you'll receive each chapter as it's written, and get regular updates throughout the product's development, as well as the final course as soon as it's ready.We created Early Access as a means of giving you the information you need, as soon as it's available. As we go through the process of developing a course, 99% of it can be ready but we can't publish until that last 1% falls in to place. Early Access helps to unlock the potential of our content early, to help you start your learning when you need it most. You not only get access to every chapter as it's delivered, edited, and updated, but you'll also get the finalized, DRM-free product to download in any format you want when it's published. As a member of Packt, you'll also be eligible for our exclusive offers, including a free course every day, and discounts on new and popular titles.