how powercli gives day 1 access to the latest vmware apis

#vmworld

CODE2649U

How PowerCLI Gives Day 1 Access to the Latest VMware APIs

Nikola Klinkachev, VMware, Inc.

#CODE2649U

VMworld 2019 Content: Not for publication or distribution

©2019 VMware, Inc.

Disclaimer

This presentation may contain product features or functionality that are currently under development.

This overview of new technology represents no commitment from VMware to deliver these features in any generally available product.

Features are subject to change, and must not be included in contracts, purchase orders, or sales agreements of any kind.

Technical feasibility and market demand will affect final delivery.

Pricing and packaging for any new features/functionality/technology discussed or presented, have not been determined.

2

The information in this presentation is for informational purposes only and may not be incorporated into any contract. There is no commitment or obligation to deliver any items presented herein. VMworld 2019 Content: Not for publication or distribution

©2019 VMware, Inc.

Agenda

3

PowerCLI

CLI tool for management and automation

Dynamic Bindings

The value of runtime generated bindings

Exploring the API and Built-in Help

Everything you need to make an API call

Instantiating Parameters and Invoking Operations

Q&A


4©2019 VMware, Inc.

PowerCLICLI tool for management and automation


©2019 VMware, Inc. 5

Command-Line Interface tool

Built on Microsoft’s PowerShell

Runs on Windows, Linux and MacOS

Provides High-Level Cmdlets and Low-Level Bindings for management and automation of VMWare products

CLI tool for management and automation

PowerCLI



Dynamic BindingsThe value of runtime generated bindings



No PowerCLI update required

New API features are available faster

You see only what’s relevant to your environment

Great for writing high-level cmdlets

PowerCLI update required

Static

Dynamic

Dynamic BindingsThe value of runtime generated bindings

Generate Code

Build Bindings

Release PowerCLI

Upgrade PowerCLI

Generate CLI Metadata

vProduct development and Release

API Description

API Description

CLI Metadata

Connect and Start Scripting

Connect and Start Scripting

Build Bindings



The building process

Dynamic Bindings

CLI Metadata

Type Descriptions

Operation Descriptions

Service Descriptions

Help

Metadata Manager

Type Mappings

Operation Definitions

Service Definitions

Help

REST/SOAP Mapping

Service Objects

Name

Methods

Help Object

Documentation

Static Analysis

Parsing Build Bindings



Exploring the API and Built-in HelpEverything you need to make an API call



Exploring the API and Built-in HelpExploring and filtering the API capabilities

Get-*Service

• List everything the API can do

Get-*Service –Name ‘*name*’

• Filter only the services you’re interested in

Get-*Service –Name ‘service_name’

• Retrieve a specific service to script against



Exploring the API and Built-in HelpAccessing and using the Built-in help

$service.Help

• List all available methods and documentation

$service.Help.{operation}

• Overloads, parameters, return type and possible errors

$service.Help.{operation}.{parameter}

• Parameter type definition and documentationVMworld 2019 Content: Not for publication or distribution


Instantiating Parameters and Invoking Operations



Instantiating Parameters and Invoking OperationsInstantiating parameters

$param = $jsonStr | Convert-FromJson

• Form json string

• Good option when you have the HTTP request

$param = @{‘key1’=‘value1’}

• As PowerShell HashTable

• Good option when you know the fields of the parameter object

$param = $service.Help.{operation}.{parameter}.Create()

• Automatic instantiation through the help object

• Good option when you don’t know the parameter fields

• Good for object types that inherit a base type



Instantiating Parameters and Invoking OperationsParameter objects, dynamic structures and invoking methods

Parameter objects

• Display all properties

• Only modified fields are sent top the server

Dynamic Structures

• Can be any object or

• Can be duck-typed/base type

$service.{method}($params)

• No surprises – invokes the method and returns a PowerShell object of the specified type



Additional Resources



https://code.vmware.com/web/tool/11.4.0/vmware-powercli

• Latest (Aug 2019) PowerCLI downloads, user’s guide, documentation and examples

https://communities.vmware.com/community/vmtn/automationtools/powercli

• PowerCLI community forum

https://blogs.vmware.com/PowerCLI

• PowerCLI blog

https://powercli.ideas.aha.io/

• User requests and ideas for PowerCLI

Additional resources


https://code.vmware.com/web/tool/11.4.0/vmware-powercli




how powercli gives day 1 access to the latest vmware apis

Documents