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

Create Update Policy Context Profile

Description

Creates/Updates a PolicyContextProfile, which encapsulates attribute and sub-attributes of network services. Rules for using attributes and sub-attributes in single PolicyContextProfile

  1. One type of attribute can’t have multiple occurrences. ( Eg. - Attribute type APP_ID can be used only once per PolicyContextProfile.)
  2. For specifying multiple values for an attribute, provide them in an array.
  3. If sub-attribtes are mentioned for an attribute, then only single value is allowed for that attribute.
  4. 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

Request

URL

URL


put
https://nsxmanager.your.domain/policy/api/v1/infra/context-profiles/{context-profile-id}
Copy

Path Parameters

Path Parameters

string
context-profile-id Required

Request Body

Request Body

PolicyContextProfile of type(s) application/json Required
This request body class requires all of the following: PolicyConfigResource, InlinePolicyContextProfile1
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns PolicyContextProfile of type(s) application/json
This response body class contains all of the following: PolicyConfigResource, InlinePolicyContextProfile1
Errors

Errors

400

Bad Request


403

Forbidden


404

Not Found


412

Precondition Failed


500

Internal Server Error


503

Service Unavailable

Code Samples

Code Samples

PowerCLI Client SDK Example

$ResourceLink = Initialize-ResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$SelfResourceLink = Initialize-SelfResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$Tag = Initialize-Tag -Scope "MyScope" -_Tag "My_Tag"
$PolicyRequestParameter = Initialize-PolicyRequestParameter -ResourceType "MyResourceType"
$ChildPolicyConfigResource = Initialize-ChildPolicyConfigResource -Links $ResourceLink -Schema "MySchema" -Self $SelfResourceLink -Revision 0 -CreateTime 0 -CreateUser "MyCreateUser" -LastModifiedTime 0 -LastModifiedUser "MyLastModifiedUser" -Protection "MyProtection" -SystemOwned $false -Description "MyDescription" -DisplayName "MyDisplayName" -Id "MyId" -ResourceType "MyResourceType" -Tags $Tag -MarkForOverride $false -MarkedForDelete $false -RequestParameter $PolicyRequestParameter
$ContextProfileAttributesMetadata = Initialize-ContextProfileAttributesMetadata -Key "MyKey" -Value "MyValue"
$PolicySubAttributes = Initialize-PolicySubAttributes -Datatype "STRING" -Key "TLS_CIPHER_SUITE" -Value "MyValue"
$PolicyAttributes = Initialize-PolicyAttributes -AttributeSource "SYSTEM" -CustomUrlPartialMatch $false -Datatype "STRING" -Description "MyDescription" -IsALGType $false -Key "APP_ID" -Metadata $ContextProfileAttributesMetadata -SubAttributes $PolicySubAttributes -Value "MyValue"
$PolicyContextProfile = Initialize-PolicyContextProfile -Links $ResourceLink -Schema "MySchema" -Self $SelfResourceLink -Revision 0 -CreateTime 0 -CreateUser "MyCreateUser" -LastModifiedTime 0 -LastModifiedUser "MyLastModifiedUser" -Protection "MyProtection" -SystemOwned $false -Description "MyDescription" -DisplayName "MyDisplayName" -Id "MyId" -ResourceType "MyResourceType" -Tags $Tag -ParentPath "MyParentPath" -Path "MyPath" -RealizationId "MyRealizationId" -RelativePath "MyRelativePath" -UniqueId "MyUniqueId" -Children $ChildPolicyConfigResource -MarkedForDelete $false -Overridden $false -Attributes $PolicyAttributes
Invoke-PutCreateOrUpdatePolicyContextProfile -contextProfileId "MycontextProfileId" -policyContextProfile $policyContextProfile -_override $true

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{}' https://nsxmanager.your.domain/policy/api/v1/infra/context-profiles/{context-profile-id}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create-update-policy-context-profile
x-vmw-nsx-module: PolicyContextProfile


Feedback

Was this page helpful?