[{"label":"Latest (v1.0)","version":"latest"}]

nsx-vmc-policy

List Profile Supported Attributes

Description

Returns supported attribute and sub-attributes for specified attribute key with their supported values, if provided in query/request parameter, else will fetch all supported attributes and sub-attributes for all supported attribute keys. Alternatively, to get a list of supported attributes and sub-attributes fire the following REST API GET https://<policy-mgr>/policy/api/v1/infra/context-profiles/attributes

Request

URL

get

https://nsxmanager.your.domain/policy/api/v1/infra/context-profiles/attributes

Copy

Query Parameters

string

attribute_key Optional

Fetch attributes and sub-attributes for the given attribute key

string

cursor Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

boolean

include_mark_for_delete_objects Optional

Include objects that are marked for deletion in results

string

included_fields Optional

Comma separated list of fields that should be included in query result

integer

page_size Optional

Maximum number of results to return in this page (server may return fewer)

boolean

sort_ascending Optional

string

sort_by Optional

Field by which records are sorted

Authentication

This operation uses the following authentication methods.

BasicAuth

Response

Response Body

200 OK

Returns PolicyContextProfileListResult of type(s) application/json

This response body class contains all of the following: ListResult, InlinePolicyContextProfileListResult1

Errors

ApiError

400

Bad Request

ApiError

403

Forbidden

ApiError

404

Not Found

ApiError

412

Precondition Failed

ApiError

500

Internal Server Error

ApiError

503

Service Unavailable

Code Samples

PowerCLI Client SDK Example

Invoke-ListProfileSupportedAttributes -attributeKey "MyattributeKey" -attributeSource "ALL" -cursor "Mycursor" -includeMarkForDeleteObjects $true -includedFields "MyincludedFields" -pageSize 789 -sortAscending $true -sortBy "MysortBy"

cURL Command

curl https://nsxmanager.your.domain/policy/api/v1/infra/context-profiles/attributes

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-vmw-doc-operation: list-profile-supported-attributes
x-vmw-nsx-module: PolicyContextProfile

[{"label":"Latest (v1.0)","version":"latest"}]

nsx-vmc-policy

Infrastructure Operations

get

List Profile Supported Attributes

List Profile Supported Attributes

Request

URL

Query Parameters

Authentication

BasicAuth

Response

Response Body

200 OK

Errors

Code Samples

PowerCLI Client SDK Example

cURL Command

Vendor Extensions

On This Page

Infrastructure Operations

Was this page helpful?