[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Create Update Policy Context Profile
DescriptionCreates/Updates a PolicyContextProfile, which encapsulates attribute and sub-attributes of network services. Rules for using attributes and sub-attributes in single PolicyContextProfile
- One type of attribute can’t have multiple occurrences. ( Eg. - Attribute type APP_ID can be used only once per PolicyContextProfile.)
- For specifying multiple values for an attribute, provide them in an array.
- If sub-attribtes are mentioned for an attribute, then only single value is allowed for that attribute.
- 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
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/context-profiles/{context-profile-id}
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
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
PolicyContextProfile
of type(s) application/json
This response body class contains all of the following:
PolicyConfigResource, InlinePolicyContextProfile1
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
$ResourceLink = Initialize-nullResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$SelfResourceLink = Initialize-nullSelfResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$Tag = Initialize-nullTag -Scope "MyScope" -_Tag "My_Tag"
$PolicyRequestParameter = Initialize-nullPolicyRequestParameter -ResourceType "MyResourceType"
$ChildPolicyConfigResource = Initialize-nullChildPolicyConfigResource -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-nullContextProfileAttributesMetadata -Key "MyKey" -Value "MyValue"
$PolicySubAttributes = Initialize-nullPolicySubAttributes -Datatype "STRING" -Key "TLS_CIPHER_SUITE" -Value "MyValue"
$PolicyAttributes = Initialize-nullPolicyAttributes -AttributeSource "SYSTEM" -CustomUrlPartialMatch $false -Datatype "STRING" -Description "MyDescription" -IsALGType $false -Key "APP_ID" -Metadata $ContextProfileAttributesMetadata -SubAttributes $PolicySubAttributes -Value "MyValue"
$PolicyContextProfile = Initialize-nullPolicyContextProfile -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 -OriginSiteId "MyOriginSiteId" -OwnerId "MyOwnerId" -ParentPath "MyParentPath" -Path "MyPath" -RealizationId "MyRealizationId" -RelativePath "MyRelativePath" -RemotePath "MyRemotePath" -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 '{"_create_time":0,"_create_user":"string","_last_modified_time":0,"_last_modified_user":"string","_links":[{"action":"string","href":"string","rel":"string"}],"_protection":"string","_revision":0,"_schema":"string","_self":{"action":"string","href":"string","rel":"string"},"_system_owned":false,"attributes":[{"datatype":"STRING","description":"string","isALGType":false,"key":"APP_ID","sub_attributes":[{"datatype":"STRING","key":"TLS_CIPHER_SUITE","value":["string"]}],"value":["string"]}],"children":[{"_create_time":0,"_create_user":"string","_last_modified_time":0,"_last_modified_user":"string","_links":[{"action":"string","href":"string","rel":"string"}],"_protection":"string","_revision":0,"_schema":"string","_self":{"action":"string","href":"string","rel":"string"},"_system_owned":false,"description":"string","display_name":"string","id":"string","marked_for_delete":false,"resource_type":"string","tags":[{"scope":"string","tag":"string"}]}],"description":"string","display_name":"string","id":"string","marked_for_delete":false,"parent_path":"string","path":"string","relative_path":"string","resource_type":"string","tags":[{"scope":"string","tag":"string"}]}' https://nsxmanager.your.domain/policy/api/v1/infra/context-profiles/{context-profile-id}
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
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
