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

Update Tier1

Description

If Tier-1 with the tier-1-id is not already present, create a new Tier-1 instance. If it already exists, update the tier-1 instance with specified attributes.

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
tier-1-id Required

Request Body

Request Body

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

Authentication

This operation uses the following authentication methods.

Response

Response

200 OK

OK

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
$SiteAllocationIndexForEdge = Initialize-SiteAllocationIndexForEdge -Index 0 -TargetResourcePath "MyTargetResourcePath"
$FederationGatewayConfig = Initialize-FederationGatewayConfig -GlobalOverlayId 0 -SiteAllocationIndices $SiteAllocationIndexForEdge -TransitSegmentId "MyTransitSegmentId"
$IntersiteGatewayConfig = Initialize-IntersiteGatewayConfig -FallbackSites "MyFallbackSites" -IntersiteTransitSubnet "MyIntersiteTransitSubnet" -LastAdminActiveEpoch 0 -PrimarySitePath "MyPrimarySitePath"
$GatewayQosProfileConfig = Initialize-GatewayQosProfileConfig -EgressQosProfilePath "MyEgressQosProfilePath" -IngressQosProfilePath "MyIngressQosProfilePath"
"TIER1_STATIC_ROUTES"$RouteAdvertisementRule = Initialize-RouteAdvertisementRule -Action "PERMIT" -Name "MyName" -PrefixOperator "GE" -RouteAdvertisementTypes "TIER1_STATIC_ROUTES" -Subnets "MySubnets"
"TIER1_STATIC_ROUTES"$Tier1 = Initialize-Tier1 -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 -ArpLimit 0 -DefaultRuleLogging $false -DhcpConfigPaths "MyDhcpConfigPaths" -DisableFirewall $false -EnableStandbyRelocation $false -FailoverMode "PREEMPTIVE" -FederationConfig $FederationGatewayConfig -ForceWhitelisting $false -HaMode "ACTIVE_STANDBY" -IntersiteConfig $IntersiteGatewayConfig -Ipv6ProfilePaths "MyIpv6ProfilePaths" -PoolAllocation "ROUTING" -QosProfile $GatewayQosProfileConfig -RouteAdvertisementRules $RouteAdvertisementRule -RouteAdvertisementTypes
$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
$SiteAllocationIndexForEdge = Initialize-SiteAllocationIndexForEdge -Index 0 -TargetResourcePath "MyTargetResourcePath"
$FederationGatewayConfig = Initialize-FederationGatewayConfig -GlobalOverlayId 0 -SiteAllocationIndices $SiteAllocationIndexForEdge -TransitSegmentId "MyTransitSegmentId"
$IntersiteGatewayConfig = Initialize-IntersiteGatewayConfig -FallbackSites "MyFallbackSites" -IntersiteTransitSubnet "MyIntersiteTransitSubnet" -LastAdminActiveEpoch 0 -PrimarySitePath "MyPrimarySitePath"
$GatewayQosProfileConfig = Initialize-GatewayQosProfileConfig -EgressQosProfilePath "MyEgressQosProfilePath" -IngressQosProfilePath "MyIngressQosProfilePath"
"TIER1_STATIC_ROUTES"$RouteAdvertisementRule = Initialize-RouteAdvertisementRule -Action "PERMIT" -Name "MyName" -PrefixOperator "GE" -RouteAdvertisementTypes "TIER1_STATIC_ROUTES" -Subnets "MySubnets"
"TIER1_STATIC_ROUTES" -Tier0Path "MyTier0Path" -Type "ROUTED"
Invoke-PatchTier1 -tier1Id "Mytier1Id" -tier1 $tier1

cURL Command

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

Vendor Extensions

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


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

Was this page helpful?