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

Create Segment

Description

If segment with the segment-id is not already present, create a new segment. If it already exists, replace the segment with this object.

Request

Request

URL

URL


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

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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns Segment of type(s) application/json
This response body class contains all of the following: PolicyConfigResource, InlineSegment1
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
$LocalEgressRoutingEntry = Initialize-LocalEgressRoutingEntry -NexthopAddress "MyNexthopAddress" -PrefixListPaths "MyPrefixListPaths"
$SegmentAdvancedConfig = Initialize-SegmentAdvancedConfig -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-BridgeProfileConfig -BridgeProfilePath "MyBridgeProfilePath" -UplinkTeamingPolicyName "MyUplinkTeamingPolicyName" -VlanIds "MyVlanIds" -VlanTransportZonePath "MyVlanTransportZonePath"
$UnboundedKeyValuePair = Initialize-UnboundedKeyValuePair -Key "MyKey" -Value "MyValue"
$SegmentExtraConfig = Initialize-SegmentExtraConfig -ConfigPair $UnboundedKeyValuePair
$FederationConnectivityConfig = Initialize-FederationConnectivityConfig -GlobalOverlayId 0
$LocalEgress = Initialize-LocalEgress -OptimizedIps "MyOptimizedIps"
$L2Extension = Initialize-L2Extension -L2vpnPath "MyL2vpnPath" -L2vpnPaths "MyL2vpnPaths" -LocalEgress $LocalEgress -TunnelId 0
$SegmentDhcpConfig = Initialize-SegmentDhcpConfig -DnsServers "MyDnsServers" -LeaseTime 0 -ResourceType "SegmentDhcpV4Config" -ServerAddress "MyServerAddress"
$SegmentSubnet = Initialize-SegmentSubnet -DhcpConfig $SegmentDhcpConfig -DhcpRanges "MyDhcpRanges" -GatewayAddress "MyGatewayAddress" -Network "MyNetwork"
$Segment = Initialize-Segment -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" -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-CreateOrReplaceSegment -tier1Id "Mytier1Id" -segmentId "MysegmentId" -segment $segment

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}
Vendor Extensions

Vendor Extensions

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


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

Was this page helpful?