[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Update Segment Ports
DescriptionCreate an infra segment port if it does not exist based on the IDs, or update existing port information by replacing the port object fields which presents in the request body.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/segments/{segment-id}/ports/{port-id}
Path Parameters
Path Parameters
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
This operation uses the following authentication methods.
Errors
Errors
ApiError
400
Bad Request
ApiError
403
Forbidden
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
$PortAddressBindingEntry = Initialize-nullPortAddressBindingEntry -IpAddress "MyIpAddress" -MacAddress "MyMacAddress" -VlanId 0
$AttachedInterfaceEntry = Initialize-nullAttachedInterfaceEntry -AppIntfName "MyAppIntfName" -DefaultGateway "MyDefaultGateway" -MigrateIntf "MyMigrateIntf" -RoutingTable "MyRoutingTable"
$PortAttachment = Initialize-nullPortAttachment -AllocateAddresses "IP_POOL" -AppId "MyAppId" -BmsInterfaceConfig $AttachedInterfaceEntry -ContextId "MyContextId" -ContextType "PARENT" -EvpnVlans "MyEvpnVlans" -HyperbusMode "ENABLE" -Id "MyId" -TrafficTag 0 -Type "PARENT"
$UnboundedKeyValuePair = Initialize-nullUnboundedKeyValuePair -Key "MyKey" -Value "MyValue"
$SegmentExtraConfig = Initialize-nullSegmentExtraConfig -ConfigPair $UnboundedKeyValuePair
$SegmentPort = Initialize-nullSegmentPort -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 -AddressBindings $PortAddressBindingEntry -AdminState "UP" -Attachment $PortAttachment -ExtraConfigs $SegmentExtraConfig -IgnoredAddressBindings $PortAddressBindingEntry -InitState "UNBLOCKED_VLAN" -OriginId "MyOriginId" -SourceSiteId "MySourceSiteId"
Invoke-PatchInfraSegmentPort -segmentId "MysegmentId" -portId "MyportId" -segmentPort $segmentPort
cURL Command
curl -X PATCH -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,"address_bindings":[{"ip_address":"string","mac_address":"string","vlan_id":0}],"attachment":{"allocate_addresses":"IP_POOL","app_id":"string","context_id":"string","id":"string","traffic_tag":0,"type":"PARENT"},"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/segments/{segment-id}/ports/{port-id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: update-segment-ports
x-vmw-nsx-module: PolicyConnectivity
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
On This Page
Infrastructure Operations
put
delete
delete
delete
delete
delete
get
get
get
patch
patch
patch
