[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Update Tier1
DescriptionIf 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
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}
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
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
$SiteAllocationIndexForEdge = Initialize-nullSiteAllocationIndexForEdge -Index 0 -TargetResourcePath "MyTargetResourcePath"
$FederationGatewayConfig = Initialize-nullFederationGatewayConfig -GlobalOverlayId 0 -SiteAllocationIndices $SiteAllocationIndexForEdge -TransitSegmentId "MyTransitSegmentId"
$IntersiteGatewayConfig = Initialize-nullIntersiteGatewayConfig -FallbackSites "MyFallbackSites" -IntersiteTransitSubnet "MyIntersiteTransitSubnet" -LastAdminActiveEpoch 0 -PrimarySitePath "MyPrimarySitePath"
$GatewayQosProfileConfig = Initialize-nullGatewayQosProfileConfig -EgressQosProfilePath "MyEgressQosProfilePath" -IngressQosProfilePath "MyIngressQosProfilePath"
"TIER1_STATIC_ROUTES"$RouteAdvertisementRule = Initialize-nullRouteAdvertisementRule -Action "PERMIT" -Name "MyName" -PrefixOperator "GE" -RouteAdvertisementTypes "TIER1_STATIC_ROUTES" -Subnets "MySubnets"
"TIER1_STATIC_ROUTES"$Tier1 = Initialize-nullTier1 -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-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
$SiteAllocationIndexForEdge = Initialize-nullSiteAllocationIndexForEdge -Index 0 -TargetResourcePath "MyTargetResourcePath"
$FederationGatewayConfig = Initialize-nullFederationGatewayConfig -GlobalOverlayId 0 -SiteAllocationIndices $SiteAllocationIndexForEdge -TransitSegmentId "MyTransitSegmentId"
$IntersiteGatewayConfig = Initialize-nullIntersiteGatewayConfig -FallbackSites "MyFallbackSites" -IntersiteTransitSubnet "MyIntersiteTransitSubnet" -LastAdminActiveEpoch 0 -PrimarySitePath "MyPrimarySitePath"
$GatewayQosProfileConfig = Initialize-nullGatewayQosProfileConfig -EgressQosProfilePath "MyEgressQosProfilePath" -IngressQosProfilePath "MyIngressQosProfilePath"
"TIER1_STATIC_ROUTES"$RouteAdvertisementRule = Initialize-nullRouteAdvertisementRule -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
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
