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

Update Interface

Description

If an interface with the interface-id is not already present, create a new interface. If it already exists, update the interface for specified attributes.

Request

Request

URL

URL


patch
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}
Copy

Path Parameters

Path Parameters

string
tier-0-id Required

string
locale-service-id Required

string
interface-id Required

Request Body

Request Body

Tier0Interface of type(s) application/json Required
This request body class requires all of the following: BaseTier0Interface, InlineTier0Interface1
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
$InterfaceSubnet = Initialize-InterfaceSubnet -IpAddresses "MyIpAddresses" -PrefixLen 0
$Tier0InterfacePimConfig = Initialize-Tier0InterfacePimConfig -Enabled $false -HelloInterval 0 -HoldInterval 0
$PolicyInterfaceOspfConfig = Initialize-PolicyInterfaceOspfConfig -BfdPath "MyBfdPath" -DeadInterval 0 -EnableBfd $false -Enabled $false -HelloInterval 0 -NetworkType "BROADCAST" -OspfArea "MyOspfArea"
$Tier0Interface = Initialize-Tier0Interface -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 -DhcpRelayPath "MyDhcpRelayPath" -Subnets $InterfaceSubnet -AccessVlanId 0 -AdminState "UP" -EdgeClusterMemberIndex 0 -EdgePath "MyEdgePath" -IgmpLocalJoinGroups "MyIgmpLocalJoinGroups" -Ipv6ProfilePaths "MyIpv6ProfilePaths" -LsId "MyLsId" -Mtu 0 -Multicast $Tier0InterfacePimConfig -Ospf $PolicyInterfaceOspfConfig -ProxyArpFilters "MyProxyArpFilters" -SegmentPath "MySegmentPath" -Type "EXTERNAL" -UrpfMode "NONE"
Invoke-PatchTier0Interface -tier0Id "Mytier0Id" -localeServiceId "MylocaleServiceId" -interfaceId "MyinterfaceId" -tier0Interface $tier0Interface -_override $true

cURL Command

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

Vendor Extensions

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


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

Was this page helpful?