PowerCLI Reference

Get-CisService

Synopsis

This cmdlet retrieves PSObject objects that represent a proxy to a vSphere Automation SDK API service and can be used to invoke the operations of that vSphere Automation SDK API service.

Syntax

Get-CisService [[-Name] <String[]>] [-Server <CisServer[]>] [<CommonParameters>]

Related Commands

Online version

Detailed Description

This cmdlet retrieves PSObject objects that represent a proxy to a vSphere Automation SDK API service and can be used to invoke the operations of that vSphere Automation SDK API service. The cmdlet returns one PSObject object for every service available on the vSphere Automation SDK server.

Every service proxy has a top-level Help property that contains documentation about the service's methods, parameters, constants, and so on. The Help object is hierarchical and mirrors the rest of the service's methods, parameters, constants, and so on. The Help object can also be used for easy creation of parameters that the service methods accept (see Example 2).

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Specifies the service type ID.falsefalse
ServerCisServer[]Specifies the vSphere Automation SDK servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-CisServer.falsefalse

Return Type

One or more PSObject objects

Notes

Examples

-------------- Example 1 --------------

Get-CisService -Name 'com.vmware.cis.tagging.tag'

Retrieves the binding for the specified service.

-------------- Example 2 --------------

# Connect to the vSphere Automation SDK API
Connect-CisServer -Server $serverAddress -User $user -Password $pass
 
# Get the service for VM management
$vmService = Get-CisService com.vmware.vcenter.VM
 
# Create a VM creation specification
$createSpec = $vmService.Help.create.spec.CreateExample()
 
# Fill in the creation details
$createSpec.name = "ExampleVM"
$createSpec.guest_OS = "WINDOWS_7_64"
$createSpec.placement.folder = (Get-Folder vm).ExtensionData.MoRef.Value
$createSpec.placement.host = (Get-VMHost)[0].ExtensionData.MoRef.Value
$createSpec.placement.datastore = (Get-Datastore)[0].ExtensionData.MoRef.Value
$createSpec.placement.cluster = $null
$createSpec.placement.resource_pool = $null
 
# Call the create method passing the specification
$vmService.create( $createSpec )

Connects to a vSphere Automation SDK server, retrieves the service for virtual machine management, and creates a virtual machine, based on the provided creation details, by passing the specification to the create method.


Copyright © VMware, Inc. All rights reserved.