Create Or Update Forwarding Rule
DescriptionCreate a rule with the rule-id is not already present, otherwise update the rule.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules/{rule-id}
Path Parameters
Path Parameters
string
domain-id
Required
Domain id
string
forwarding-policy-id
Required
Forwarding map id
string
rule-id
Required
Rule id
Request Body
Request Body
ForwardingRule of type(s) application/json
Required
Forwarding rule that determine how to forward traffic from a VM. Traffic from VM can either be routed via Overlay or Underlay when VM is on hybrid port. Additionally NAT can be performed for VM or container on overlay to route traffic to/from underlay ROUTE_TO_UNDERLAY - Access a service on underlay space from a VM connected to hybrid port. Eg access to AWS S3 on AWS underlay ROUTE_TO_OVERLAY - Access a service on overlay space from a VM connected to hybrid port. ROUTE_FROM_UNDERLAY - Access a service hosted on a VM (that is connected to hybrid port) from underlay space. Eg access from AWS ELB to VM ROUTE_FROM_OVERLAY - Access a service hosted on a VM (that is connected to hybrid port) from overlay space NAT_FROM_UNDERLAY - Access a service on overlay VM/container from underlay space using DNAT from underlay IP to overlay IP NAT_TO_UNDERLAY - Access an underlay service from a VM/container on overlay space using SNAT from overlay IP to underlay IP
(The request body parameter is missing description)
This request body class requires all of the following: BaseRule, InlineForwardingRule
Authentication
This operation uses the following authentication methods.
Errors
Errors
Code Samples
Code Samples
cURL Command
curl -X PATCH -H "Content-Type: application/json" -d '{}' https://nsxmanager.your.domain/policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules/{rule-id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create-or-update-forwarding-rule
x-vmw-nsx-module: PolicyForwarding
On This Page
Forwarding Policies Operations
delete
delete
