Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vcd Provider
  3. API Docs
  4. NsxtEdgegatewayStaticRoute
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.NsxtEdgegatewayStaticRoute

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

    Create NsxtEdgegatewayStaticRoute Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new NsxtEdgegatewayStaticRoute(name: string, args: NsxtEdgegatewayStaticRouteArgs, opts?: CustomResourceOptions);
    @overload
def NsxtEdgegatewayStaticRoute(resource_name: str,
                               args: NsxtEdgegatewayStaticRouteArgs,
                               opts: Optional[ResourceOptions] = None)

@overload
def NsxtEdgegatewayStaticRoute(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               edge_gateway_id: Optional[str] = None,
                               network_cidr: Optional[str] = None,
                               next_hops: Optional[Sequence[NsxtEdgegatewayStaticRouteNextHopArgs]] = None,
                               description: Optional[str] = None,
                               name: Optional[str] = None,
                               nsxt_edgegateway_static_route_id: Optional[str] = None,
                               org: Optional[str] = None)
    func NewNsxtEdgegatewayStaticRoute(ctx *Context, name string, args NsxtEdgegatewayStaticRouteArgs, opts ...ResourceOption) (*NsxtEdgegatewayStaticRoute, error)
    public NsxtEdgegatewayStaticRoute(string name, NsxtEdgegatewayStaticRouteArgs args, CustomResourceOptions? opts = null)
    public NsxtEdgegatewayStaticRoute(String name, NsxtEdgegatewayStaticRouteArgs args)
public NsxtEdgegatewayStaticRoute(String name, NsxtEdgegatewayStaticRouteArgs args, CustomResourceOptions options)

    type: vcd:NsxtEdgegatewayStaticRoute
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args NsxtEdgegatewayStaticRouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args NsxtEdgegatewayStaticRouteArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args NsxtEdgegatewayStaticRouteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NsxtEdgegatewayStaticRouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NsxtEdgegatewayStaticRouteArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var nsxtEdgegatewayStaticRouteResource = new Vcd.NsxtEdgegatewayStaticRoute("nsxtEdgegatewayStaticRouteResource", new()
{
    EdgeGatewayId = "string",
    NetworkCidr = "string",
    NextHops = new[]
    {
        new Vcd.Inputs.NsxtEdgegatewayStaticRouteNextHopArgs
        {
            AdminDistance = 0,
            IpAddress = "string",
            Scope = new Vcd.Inputs.NsxtEdgegatewayStaticRouteNextHopScopeArgs
            {
                Id = "string",
                Type = "string",
                Name = "string",
            },
        },
    },
    Description = "string",
    Name = "string",
    NsxtEdgegatewayStaticRouteId = "string",
    Org = "string",
});

    example, err := vcd.NewNsxtEdgegatewayStaticRoute(ctx, "nsxtEdgegatewayStaticRouteResource", &vcd.NsxtEdgegatewayStaticRouteArgs{
	EdgeGatewayId: pulumi.String("string"),
	NetworkCidr:   pulumi.String("string"),
	NextHops: vcd.NsxtEdgegatewayStaticRouteNextHopArray{
		&vcd.NsxtEdgegatewayStaticRouteNextHopArgs{
			AdminDistance: pulumi.Float64(0),
			IpAddress:     pulumi.String("string"),
			Scope: &vcd.NsxtEdgegatewayStaticRouteNextHopScopeArgs{
				Id:   pulumi.String("string"),
				Type: pulumi.String("string"),
				Name: pulumi.String("string"),
			},
		},
	},
	Description:                  pulumi.String("string"),
	Name:                         pulumi.String("string"),
	NsxtEdgegatewayStaticRouteId: pulumi.String("string"),
	Org:                          pulumi.String("string"),
})

    var nsxtEdgegatewayStaticRouteResource = new NsxtEdgegatewayStaticRoute("nsxtEdgegatewayStaticRouteResource", NsxtEdgegatewayStaticRouteArgs.builder()
    .edgeGatewayId("string")
    .networkCidr("string")
    .nextHops(NsxtEdgegatewayStaticRouteNextHopArgs.builder()
        .adminDistance(0)
        .ipAddress("string")
        .scope(NsxtEdgegatewayStaticRouteNextHopScopeArgs.builder()
            .id("string")
            .type("string")
            .name("string")
            .build())
        .build())
    .description("string")
    .name("string")
    .nsxtEdgegatewayStaticRouteId("string")
    .org("string")
    .build());

    nsxt_edgegateway_static_route_resource = vcd.NsxtEdgegatewayStaticRoute("nsxtEdgegatewayStaticRouteResource",
    edge_gateway_id="string",
    network_cidr="string",
    next_hops=[{
        "admin_distance": 0,
        "ip_address": "string",
        "scope": {
            "id": "string",
            "type": "string",
            "name": "string",
        },
    }],
    description="string",
    name="string",
    nsxt_edgegateway_static_route_id="string",
    org="string")

    const nsxtEdgegatewayStaticRouteResource = new vcd.NsxtEdgegatewayStaticRoute("nsxtEdgegatewayStaticRouteResource", {
    edgeGatewayId: "string",
    networkCidr: "string",
    nextHops: [{
        adminDistance: 0,
        ipAddress: "string",
        scope: {
            id: "string",
            type: "string",
            name: "string",
        },
    }],
    description: "string",
    name: "string",
    nsxtEdgegatewayStaticRouteId: "string",
    org: "string",
});

    type: vcd:NsxtEdgegatewayStaticRoute
properties:
    description: string
    edgeGatewayId: string
    name: string
    networkCidr: string
    nextHops:
        - adminDistance: 0
          ipAddress: string
          scope:
            id: string
            name: string
            type: string
    nsxtEdgegatewayStaticRouteId: string
    org: string

    NsxtEdgegatewayStaticRoute Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The NsxtEdgegatewayStaticRoute resource accepts the following input properties:

    EdgeGatewayId string
    NSX-T Edge Gateway ID
    NetworkCidr string
    Specifies network prefix in CIDR format. Both IPv4 and IPv6 formats are supported.
    NextHops List<NsxtEdgegatewayStaticRouteNextHop>

    A set of next hops to use within the static route. At least one is required. See Next Hop for definition structure.

    Description string
    Description for NSX-T Edge Gateway Static Route
    Name string
    Name for NSX-T Edge Gateway Static Route
    NsxtEdgegatewayStaticRouteId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations
    EdgeGatewayId string
    NSX-T Edge Gateway ID
    NetworkCidr string
    Specifies network prefix in CIDR format. Both IPv4 and IPv6 formats are supported.
    NextHops []NsxtEdgegatewayStaticRouteNextHopArgs

    A set of next hops to use within the static route. At least one is required. See Next Hop for definition structure.

    Description string
    Description for NSX-T Edge Gateway Static Route
    Name string
    Name for NSX-T Edge Gateway Static Route
    NsxtEdgegatewayStaticRouteId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations
    edgeGatewayId String
    NSX-T Edge Gateway ID
    networkCidr String
    Specifies network prefix in CIDR format. Both IPv4 and IPv6 formats are supported.
    nextHops List<NsxtEdgegatewayStaticRouteNextHop>

    A set of next hops to use within the static route. At least one is required. See Next Hop for definition structure.

    description String
    Description for NSX-T Edge Gateway Static Route
    name String
    Name for NSX-T Edge Gateway Static Route
    nsxtEdgegatewayStaticRouteId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations
    edgeGatewayId string
    NSX-T Edge Gateway ID
    networkCidr string
    Specifies network prefix in CIDR format. Both IPv4 and IPv6 formats are supported.
    nextHops NsxtEdgegatewayStaticRouteNextHop[]

    A set of next hops to use within the static route. At least one is required. See Next Hop for definition structure.

    description string
    Description for NSX-T Edge Gateway Static Route
    name string
    Name for NSX-T Edge Gateway Static Route
    nsxtEdgegatewayStaticRouteId string
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations
    edge_gateway_id str
    NSX-T Edge Gateway ID
    network_cidr str
    Specifies network prefix in CIDR format. Both IPv4 and IPv6 formats are supported.
    next_hops Sequence[NsxtEdgegatewayStaticRouteNextHopArgs]

    A set of next hops to use within the static route. At least one is required. See Next Hop for definition structure.

    description str
    Description for NSX-T Edge Gateway Static Route
    name str
    Name for NSX-T Edge Gateway Static Route
    nsxt_edgegateway_static_route_id str
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations
    edgeGatewayId String
    NSX-T Edge Gateway ID
    networkCidr String
    Specifies network prefix in CIDR format. Both IPv4 and IPv6 formats are supported.
    nextHops List<Property Map>

    A set of next hops to use within the static route. At least one is required. See Next Hop for definition structure.

    description String
    Description for NSX-T Edge Gateway Static Route
    name String
    Name for NSX-T Edge Gateway Static Route
    nsxtEdgegatewayStaticRouteId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NsxtEdgegatewayStaticRoute resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing NsxtEdgegatewayStaticRoute Resource

    Get an existing NsxtEdgegatewayStaticRoute resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: NsxtEdgegatewayStaticRouteState, opts?: CustomResourceOptions): NsxtEdgegatewayStaticRoute
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        edge_gateway_id: Optional[str] = None,
        name: Optional[str] = None,
        network_cidr: Optional[str] = None,
        next_hops: Optional[Sequence[NsxtEdgegatewayStaticRouteNextHopArgs]] = None,
        nsxt_edgegateway_static_route_id: Optional[str] = None,
        org: Optional[str] = None) -> NsxtEdgegatewayStaticRoute
    func GetNsxtEdgegatewayStaticRoute(ctx *Context, name string, id IDInput, state *NsxtEdgegatewayStaticRouteState, opts ...ResourceOption) (*NsxtEdgegatewayStaticRoute, error)
    public static NsxtEdgegatewayStaticRoute Get(string name, Input<string> id, NsxtEdgegatewayStaticRouteState? state, CustomResourceOptions? opts = null)
    public static NsxtEdgegatewayStaticRoute get(String name, Output<String> id, NsxtEdgegatewayStaticRouteState state, CustomResourceOptions options)
    resources:  _:    type: vcd:NsxtEdgegatewayStaticRoute    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    Description for NSX-T Edge Gateway Static Route
    EdgeGatewayId string
    NSX-T Edge Gateway ID
    Name string
    Name for NSX-T Edge Gateway Static Route
    NetworkCidr string
    Specifies network prefix in CIDR format. Both IPv4 and IPv6 formats are supported.
    NextHops List<NsxtEdgegatewayStaticRouteNextHop>

    A set of next hops to use within the static route. At least one is required. See Next Hop for definition structure.

    NsxtEdgegatewayStaticRouteId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations
    Description string
    Description for NSX-T Edge Gateway Static Route
    EdgeGatewayId string
    NSX-T Edge Gateway ID
    Name string
    Name for NSX-T Edge Gateway Static Route
    NetworkCidr string
    Specifies network prefix in CIDR format. Both IPv4 and IPv6 formats are supported.
    NextHops []NsxtEdgegatewayStaticRouteNextHopArgs

    A set of next hops to use within the static route. At least one is required. See Next Hop for definition structure.

    NsxtEdgegatewayStaticRouteId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations
    description String
    Description for NSX-T Edge Gateway Static Route
    edgeGatewayId String
    NSX-T Edge Gateway ID
    name String
    Name for NSX-T Edge Gateway Static Route
    networkCidr String
    Specifies network prefix in CIDR format. Both IPv4 and IPv6 formats are supported.
    nextHops List<NsxtEdgegatewayStaticRouteNextHop>

    A set of next hops to use within the static route. At least one is required. See Next Hop for definition structure.

    nsxtEdgegatewayStaticRouteId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations
    description string
    Description for NSX-T Edge Gateway Static Route
    edgeGatewayId string
    NSX-T Edge Gateway ID
    name string
    Name for NSX-T Edge Gateway Static Route
    networkCidr string
    Specifies network prefix in CIDR format. Both IPv4 and IPv6 formats are supported.
    nextHops NsxtEdgegatewayStaticRouteNextHop[]

    A set of next hops to use within the static route. At least one is required. See Next Hop for definition structure.

    nsxtEdgegatewayStaticRouteId string
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations
    description str
    Description for NSX-T Edge Gateway Static Route
    edge_gateway_id str
    NSX-T Edge Gateway ID
    name str
    Name for NSX-T Edge Gateway Static Route
    network_cidr str
    Specifies network prefix in CIDR format. Both IPv4 and IPv6 formats are supported.
    next_hops Sequence[NsxtEdgegatewayStaticRouteNextHopArgs]

    A set of next hops to use within the static route. At least one is required. See Next Hop for definition structure.

    nsxt_edgegateway_static_route_id str
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations
    description String
    Description for NSX-T Edge Gateway Static Route
    edgeGatewayId String
    NSX-T Edge Gateway ID
    name String
    Name for NSX-T Edge Gateway Static Route
    networkCidr String
    Specifies network prefix in CIDR format. Both IPv4 and IPv6 formats are supported.
    nextHops List<Property Map>

    A set of next hops to use within the static route. At least one is required. See Next Hop for definition structure.

    nsxtEdgegatewayStaticRouteId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations

    Supporting Types

    NsxtEdgegatewayStaticRouteNextHop, NsxtEdgegatewayStaticRouteNextHopArgs

    AdminDistance double
    Admin distance of next hop
    IpAddress string
    IP Address of next hop
    Scope NsxtEdgegatewayStaticRouteNextHopScope
    AdminDistance float64
    Admin distance of next hop
    IpAddress string
    IP Address of next hop
    Scope NsxtEdgegatewayStaticRouteNextHopScope
    adminDistance Double
    Admin distance of next hop
    ipAddress String
    IP Address of next hop
    scope NsxtEdgegatewayStaticRouteNextHopScope
    adminDistance number
    Admin distance of next hop
    ipAddress string
    IP Address of next hop
    scope NsxtEdgegatewayStaticRouteNextHopScope
    admin_distance float
    Admin distance of next hop
    ip_address str
    IP Address of next hop
    scope NsxtEdgegatewayStaticRouteNextHopScope
    adminDistance Number
    Admin distance of next hop
    ipAddress String
    IP Address of next hop
    scope Property Map

    NsxtEdgegatewayStaticRouteNextHopScope, NsxtEdgegatewayStaticRouteNextHopScopeArgs

    Id string
    ID of Scope element
    Type string
    Scope type - One of 'NETWORK', 'SYSTEM_OWNED'
    Name string
    Name for NSX-T Edge Gateway Static Route
    Id string
    ID of Scope element
    Type string
    Scope type - One of 'NETWORK', 'SYSTEM_OWNED'
    Name string
    Name for NSX-T Edge Gateway Static Route
    id String
    ID of Scope element
    type String
    Scope type - One of 'NETWORK', 'SYSTEM_OWNED'
    name String
    Name for NSX-T Edge Gateway Static Route
    id string
    ID of Scope element
    type string
    Scope type - One of 'NETWORK', 'SYSTEM_OWNED'
    name string
    Name for NSX-T Edge Gateway Static Route
    id str
    ID of Scope element
    type str
    Scope type - One of 'NETWORK', 'SYSTEM_OWNED'
    name str
    Name for NSX-T Edge Gateway Static Route
    id String
    ID of Scope element
    type String
    Scope type - One of 'NETWORK', 'SYSTEM_OWNED'
    name String
    Name for NSX-T Edge Gateway Static Route

    Package Details

    Repository
    vcd vmware/terraform-provider-vcd
    License
    Notes
    This Pulumi package is based on the vcd Terraform Provider.
    vcd logo
    vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
    vmware/terraform-provider-vcd