» nsxt_policy_static_route

This resource provides a method for the management of a Static Route.

» Example Usage

resource "nsxt_policy_static_route" "route1" {
  display_name = "sroute"
  gateway_path = nsxt_policy_tier0_gateway.tier0_gw.path
  network      = ""

  next_hop {
    admin_distance = "2"
    ip_address     = ""

  next_hop {
    admin_distance = "4"
    ip_address = ""

  tag {
    scope = "color"
    tag   = "blue"

» Argument Reference

The following arguments are supported:

  • display_name - (Required) Display name of the resource.
  • description - (Optional) Description of the resource.
  • tag - (Optional) A list of scope + tag pairs to associate with this Tier-0 gateway.
  • nsx_id - (Optional) The NSX ID of this resource. If set, this ID will be used to create the policy resource.
  • network - (Required) The network address in CIDR format for the route.
  • gateway_path (Required) The NSX Policy path to the Tier0 or Tier1 Gateway for this Static Route.
  • next_hop - (Required) One or more next hops for the static route.
    • admin_distance - (Optional) The cost associated with the next hop. Valid values are 1 - 255 and the default is 1.
    • ip_address - (Required) The gateway address of the next hop.
    • interface - (Optional) The policy path to the interface associated with the static route.

» Attributes Reference

In addition to arguments listed above, the following attributes are exported:

  • revision - Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
  • path - The NSX path of the policy resource.

» Importing

An existing policy Static Route can be imported into this resource, via the following command:

terraform import nsxt_policy_static_route.route1 GWID/ID

The above command imports the policy Static Route named route1 for the NSX Tier0 or Tier1 Gateway GWID with the NSX Policy ID ID.