PowerCLI Reference

Get-NsxtPolicyService

Synopsis

This cmdlet retrieves PSObject objects that represent a proxy to an NSX-T API service.

Syntax

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

Related Commands

Online Version

Detailed Description

This cmdlet retrieves PSObject objects that represent a proxy to a NSX-T Policy API service and can be used to invoke the operations of the NSX-T Policy API service. The cmdlet returns one PSObject object for every policy service available on NSX-T 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 service's methods, parameters, constants, and so on. The Help object can also be used for creation of parameters that the service methods accept through a method named "Create".


The "Create" method is available for the following objects:


- A parameter.


- Inheritors of a parameter that accepts instances of types that derive the declared parameter type.


- Elements of a parameter that is of type List, Set or Optional.




- Key and Value of a parameter of type Map.


- Fields of a parameter of type Structure.

For more information, see Example 2.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Specifies the service type ID.falseFalse
ServerCisServer[]Specifies the NSX-T 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 the Connect-NsxtServer cmdlet.falseFalse

Return Type

One or more PSObject objects

Notes

Examples

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

$service = Get-NsxtPolicyService com.vmware.nsx_policy.infra.domains.groups
$service.list("domain_id")

Retrieves the binding for the specified service and invokes a service operation.

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

# Retrieves the "com.vmware.nsx_policy.infra.domains.groups" service.
$service = Get-NsxtPolicyService com.vmware.nsx_policy.infra.domains.groups

# Creates string parameters.
$domain_id = "vmc"
$group_id = "webgroup"

# Creates the "group" input parameter.
$group = $service.Help.patch.group.Create()
$group.display_name = "web group"
$group.description = "web group"

# Creates an empty list of expressions.
$group.expression = $service.Help.patch.group.expression.Create()

# Creates a single expression of type Condition. The resource_type field is prefilled with the correct value.
$expression = $service.Help.patch.group.expression.Element.condition.Create()
$expression.member_type = "VirtualMachine"
$expression.value = "webvm"
$expression.key = "Tag"
$expression.operator = "EQUALS"
[void]($group.expression.Add($expression))

# Creates or patches the group.
$service.patch($domain_id, $group_id, $group)

Creates a domain workgroup.

Copyright © VMware, Inc. All rights reserved.