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

Create BYOD Service Instance Endpoint

Description

Create service instance endpoint with given request if not exist. Modification of service instance endpoint is not allowed.

Request

Request

URL

URL


put
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/byod-service-instances/{service-instance-id}/service-instance-endpoints/{service-instance-endpoint-id}
Copy

Path Parameters

Path Parameters

string
tier-0-id Required

Tier-0 id


string
locale-service-id Required

Locale service id


string
service-instance-id Required

Service instance id


string
service-instance-endpoint-id Required

Service instance endpoint id


Request Body

Request Body

ServiceInstanceEndpoint of type(s) application/json Required
This request body class requires all of the following: BaseEndpoint, InlineServiceInstanceEndpoint1
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns ServiceInstanceEndpoint of type(s) application/json
This response body class contains all of the following: BaseEndpoint, InlineServiceInstanceEndpoint1
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
$IPInfo = Initialize-IPInfo -IpAddresses "MyIpAddresses" -PrefixLength 0
$ServiceInstanceEndpoint = Initialize-ServiceInstanceEndpoint -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 "VirtualEndpoint" -Tags $Tag -ParentPath "MyParentPath" -Path "MyPath" -RealizationId "MyRealizationId" -RelativePath "MyRelativePath" -UniqueId "MyUniqueId" -Children $ChildPolicyConfigResource -MarkedForDelete $false -Overridden $false -TargetIps $IPInfo -ServiceInterfacePath "MyServiceInterfacePath"
Invoke-CreateServiceInstanceEndpoint -tier0Id "Mytier0Id" -localeServiceId "MylocaleServiceId" -serviceInstanceId "MyserviceInstanceId" -serviceInstanceEndpointId "MyserviceInstanceEndpointId" -serviceInstanceEndpoint $serviceInstanceEndpoint

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{}' https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/byod-service-instances/{service-instance-id}/service-instance-endpoints/{service-instance-endpoint-id}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create-byod-service-instance-endpoint
x-vmw-nsx-module: PolicyServiceInsertion


Feedback

Was this page helpful?