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

Create Segment Port

Description

Create a Tier-1 segment port if it does not exist based on the IDs, or update existing port information by replacing the port object already exists.

Request

Request

URL

URL


put
https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}
Copy

Path Parameters

Path Parameters

string
tier-1-id Required

string
segment-id Required

string
port-id Required

Request Body

Request Body

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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns SegmentPort of type(s) application/json
This response body class contains all of the following: PolicyConfigResource, InlineSegmentPort1
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
$PortAddressBindingEntry = Initialize-PortAddressBindingEntry -IpAddress "MyIpAddress" -MacAddress "MyMacAddress" -VlanId 0
$AttachedInterfaceEntry = Initialize-AttachedInterfaceEntry -AppIntfName "MyAppIntfName" -DefaultGateway "MyDefaultGateway" -MigrateIntf "MyMigrateIntf" -RoutingTable "MyRoutingTable"
$PortAttachment = Initialize-PortAttachment -AllocateAddresses "IP_POOL" -AppId "MyAppId" -BmsInterfaceConfig $AttachedInterfaceEntry -ContextId "MyContextId" -ContextType "PARENT" -EvpnVlans "MyEvpnVlans" -HyperbusMode "ENABLE" -Id "MyId" -TrafficTag 0 -Type "PARENT"
$UnboundedKeyValuePair = Initialize-UnboundedKeyValuePair -Key "MyKey" -Value "MyValue"
$SegmentExtraConfig = Initialize-SegmentExtraConfig -ConfigPair $UnboundedKeyValuePair
$SegmentPort = Initialize-SegmentPort -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 -AddressBindings $PortAddressBindingEntry -AdminState "UP" -Attachment $PortAttachment -ExtraConfigs $SegmentExtraConfig -IgnoredAddressBindings $PortAddressBindingEntry -InitState "UNBLOCKED_VLAN" -OriginId "MyOriginId" -SourceSiteId "MySourceSiteId"
Invoke-CreateOrReplaceTier1SegmentPort -tier1Id "Mytier1Id" -segmentId "MysegmentId" -portId "MyportId" -segmentPort $segmentPort

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{}' https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create-segment-port
x-vmw-nsx-module: PolicyConnectivity


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

Was this page helpful?