[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Update Segment
DescriptionIf segment with the segment-id is not already present, create a new segment. If it already exists, update the segment with specified attributes.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}
Path Parameters
Path Parameters
string
tier-1-id
Required
string
segment-id
Required
Request Body
Request Body
Segment
of type(s) application/json
Required
This request body class requires all of the following:
PolicyConfigResource, InlineSegment1
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
$LocalEgressRoutingEntry = Initialize-nullLocalEgressRoutingEntry -NexthopAddress "MyNexthopAddress" -PrefixListPaths "MyPrefixListPaths"
$SegmentAdvancedConfig = Initialize-nullSegmentAdvancedConfig -Connectivity "ON" -AddressPoolPaths "MyAddressPoolPaths" -Hybrid $false -InterRouter $false -LocalEgress $false -LocalEgressRoutingPolicies $LocalEgressRoutingEntry -Multicast $false -NdraProfilePath "MyNdraProfilePath" -NodeLocalSwitch $false -OriginId "MyOriginId" -OriginType "VCENTER" -UplinkTeamingPolicyName "MyUplinkTeamingPolicyName" -UrpfMode "NONE"
$BridgeProfileConfig = Initialize-nullBridgeProfileConfig -BridgeProfilePath "MyBridgeProfilePath" -UplinkTeamingPolicyName "MyUplinkTeamingPolicyName" -VlanIds "MyVlanIds" -VlanTransportZonePath "MyVlanTransportZonePath"
$UnboundedKeyValuePair = Initialize-nullUnboundedKeyValuePair -Key "MyKey" -Value "MyValue"
$SegmentExtraConfig = Initialize-nullSegmentExtraConfig -ConfigPair $UnboundedKeyValuePair
$FederationConnectivityConfig = Initialize-nullFederationConnectivityConfig -GlobalOverlayId 0
$LocalEgress = Initialize-nullLocalEgress -OptimizedIps "MyOptimizedIps"
$L2Extension = Initialize-nullL2Extension -L2vpnPath "MyL2vpnPath" -L2vpnPaths "MyL2vpnPaths" -LocalEgress $LocalEgress -TunnelId 0
$SegmentDhcpConfig = Initialize-nullSegmentDhcpConfig -DnsServers "MyDnsServers" -LeaseTime 0 -ResourceType "SegmentDhcpV4Config" -ServerAddress "MyServerAddress"
$SegmentSubnet = Initialize-nullSegmentSubnet -DhcpConfig $SegmentDhcpConfig -DhcpRanges "MyDhcpRanges" -GatewayAddress "MyGatewayAddress" -Network "MyNetwork"
$Segment = Initialize-nullSegment -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" -AdvancedConfig $SegmentAdvancedConfig -BridgeProfiles $BridgeProfileConfig -ConnectivityPath "MyConnectivityPath" -DhcpConfigPath "MyDhcpConfigPath" -DomainName "MyDomainName" -EvpnSegment $false -EvpnTenantConfigPath "MyEvpnTenantConfigPath" -ExtraConfigs $SegmentExtraConfig -FederationConfig $FederationConnectivityConfig -L2Extension $L2Extension -LsId "MyLsId" -MacPoolId "MyMacPoolId" -MetadataProxyPaths "MyMetadataProxyPaths" -OverlayId 0 -ReplicationMode "MTEP" -Subnets $SegmentSubnet -TransportZonePath "MyTransportZonePath" -Type "ROUTED" -VlanIds "MyVlanIds"
Invoke-PatchSegment -tier1Id "Mytier1Id" -segmentId "MysegmentId" -segment $segment
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,"advanced_config":{"address_pool_paths":["string"],"connectivity":"ON","hybrid":false,"local_egress":false},"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"}]}],"connectivity_path":"string","description":"string","display_name":"string","domain_name":"string","id":"string","l2_extension":{"l2vpn_path":"string","l2vpn_paths":["string"],"tunnel_id":0},"ls_id":"string","marked_for_delete":false,"overlay_id":0,"parent_path":"string","path":"string","relative_path":"string","resource_type":"string","subnets":[{"dhcp_ranges":["string"],"gateway_address":"string","network":"string"}],"tags":[{"scope":"string","tag":"string"}],"transport_zone_path":"string","type":"ROUTED","vlan_ids":["string"]}' https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: update-segment
x-vmw-nsx-module: PolicyConnectivity
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
On This Page
Tier 1s Operations
put
delete
delete
delete
delete
delete
get
get
get
patch
patch
patch
