1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. SystemRoute
fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev

fortimanager.SystemRoute

Explore with Pulumi AI

Routing table configuration.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as fortimanager from "@pulumi/fortimanager";

const trname = new fortimanager.SystemRoute("trname", {
    device: "port1",
    dsts: [
        "222.222.22.0",
        "255.255.255.0",
    ],
    gateway: "222.222.222.1",
    seqNum: 7,
});
Copy
import pulumi
import pulumi_fortimanager as fortimanager

trname = fortimanager.SystemRoute("trname",
    device="port1",
    dsts=[
        "222.222.22.0",
        "255.255.255.0",
    ],
    gateway="222.222.222.1",
    seq_num=7)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fortimanager/fortimanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fortimanager.NewSystemRoute(ctx, "trname", &fortimanager.SystemRouteArgs{
			Device: pulumi.String("port1"),
			Dsts: pulumi.StringArray{
				pulumi.String("222.222.22.0"),
				pulumi.String("255.255.255.0"),
			},
			Gateway: pulumi.String("222.222.222.1"),
			SeqNum:  pulumi.Float64(7),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortimanager = Pulumi.Fortimanager;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortimanager.SystemRoute("trname", new()
    {
        Device = "port1",
        Dsts = new[]
        {
            "222.222.22.0",
            "255.255.255.0",
        },
        Gateway = "222.222.222.1",
        SeqNum = 7,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortimanager.SystemRoute;
import com.pulumi.fortimanager.SystemRouteArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var trname = new SystemRoute("trname", SystemRouteArgs.builder()
            .device("port1")
            .dsts(            
                "222.222.22.0",
                "255.255.255.0")
            .gateway("222.222.222.1")
            .seqNum(7)
            .build());

    }
}
Copy
resources:
  trname:
    type: fortimanager:SystemRoute
    properties:
      device: port1
      dsts:
        - 222.222.22.0
        - 255.255.255.0
      gateway: 222.222.222.1
      seqNum: 7
Copy

Create SystemRoute Resource

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

Constructor syntax

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

@overload
def SystemRoute(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                device: Optional[str] = None,
                dsts: Optional[Sequence[str]] = None,
                gateway: Optional[str] = None,
                seq_num: Optional[float] = None,
                system_route_id: Optional[str] = None)
func NewSystemRoute(ctx *Context, name string, args *SystemRouteArgs, opts ...ResourceOption) (*SystemRoute, error)
public SystemRoute(string name, SystemRouteArgs? args = null, CustomResourceOptions? opts = null)
public SystemRoute(String name, SystemRouteArgs args)
public SystemRoute(String name, SystemRouteArgs args, CustomResourceOptions options)
type: fortimanager:SystemRoute
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args SystemRouteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args SystemRouteArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args SystemRouteArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args SystemRouteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SystemRouteArgs
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 systemRouteResource = new Fortimanager.SystemRoute("systemRouteResource", new()
{
    Device = "string",
    Dsts = new[]
    {
        "string",
    },
    Gateway = "string",
    SeqNum = 0,
    SystemRouteId = "string",
});
Copy
example, err := fortimanager.NewSystemRoute(ctx, "systemRouteResource", &fortimanager.SystemRouteArgs{
Device: pulumi.String("string"),
Dsts: pulumi.StringArray{
pulumi.String("string"),
},
Gateway: pulumi.String("string"),
SeqNum: pulumi.Float64(0),
SystemRouteId: pulumi.String("string"),
})
Copy
var systemRouteResource = new SystemRoute("systemRouteResource", SystemRouteArgs.builder()
    .device("string")
    .dsts("string")
    .gateway("string")
    .seqNum(0)
    .systemRouteId("string")
    .build());
Copy
system_route_resource = fortimanager.SystemRoute("systemRouteResource",
    device="string",
    dsts=["string"],
    gateway="string",
    seq_num=0,
    system_route_id="string")
Copy
const systemRouteResource = new fortimanager.SystemRoute("systemRouteResource", {
    device: "string",
    dsts: ["string"],
    gateway: "string",
    seqNum: 0,
    systemRouteId: "string",
});
Copy
type: fortimanager:SystemRoute
properties:
    device: string
    dsts:
        - string
    gateway: string
    seqNum: 0
    systemRouteId: string
Copy

SystemRoute 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 SystemRoute resource accepts the following input properties:

Device string
Gateway out interface.
Dsts List<string>
Destination IP and mask for this route.
Gateway string
Gateway IP for this route.
SeqNum double
Entry number.
SystemRouteId string
an identifier for the resource with format {{seq_num}}.
Device string
Gateway out interface.
Dsts []string
Destination IP and mask for this route.
Gateway string
Gateway IP for this route.
SeqNum float64
Entry number.
SystemRouteId string
an identifier for the resource with format {{seq_num}}.
device String
Gateway out interface.
dsts List<String>
Destination IP and mask for this route.
gateway String
Gateway IP for this route.
seqNum Double
Entry number.
systemRouteId String
an identifier for the resource with format {{seq_num}}.
device string
Gateway out interface.
dsts string[]
Destination IP and mask for this route.
gateway string
Gateway IP for this route.
seqNum number
Entry number.
systemRouteId string
an identifier for the resource with format {{seq_num}}.
device str
Gateway out interface.
dsts Sequence[str]
Destination IP and mask for this route.
gateway str
Gateway IP for this route.
seq_num float
Entry number.
system_route_id str
an identifier for the resource with format {{seq_num}}.
device String
Gateway out interface.
dsts List<String>
Destination IP and mask for this route.
gateway String
Gateway IP for this route.
seqNum Number
Entry number.
systemRouteId String
an identifier for the resource with format {{seq_num}}.

Outputs

All input properties are implicitly available as output properties. Additionally, the SystemRoute 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 SystemRoute Resource

Get an existing SystemRoute 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?: SystemRouteState, opts?: CustomResourceOptions): SystemRoute
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device: Optional[str] = None,
        dsts: Optional[Sequence[str]] = None,
        gateway: Optional[str] = None,
        seq_num: Optional[float] = None,
        system_route_id: Optional[str] = None) -> SystemRoute
func GetSystemRoute(ctx *Context, name string, id IDInput, state *SystemRouteState, opts ...ResourceOption) (*SystemRoute, error)
public static SystemRoute Get(string name, Input<string> id, SystemRouteState? state, CustomResourceOptions? opts = null)
public static SystemRoute get(String name, Output<String> id, SystemRouteState state, CustomResourceOptions options)
resources:  _:    type: fortimanager:SystemRoute    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Device string
Gateway out interface.
Dsts List<string>
Destination IP and mask for this route.
Gateway string
Gateway IP for this route.
SeqNum double
Entry number.
SystemRouteId string
an identifier for the resource with format {{seq_num}}.
Device string
Gateway out interface.
Dsts []string
Destination IP and mask for this route.
Gateway string
Gateway IP for this route.
SeqNum float64
Entry number.
SystemRouteId string
an identifier for the resource with format {{seq_num}}.
device String
Gateway out interface.
dsts List<String>
Destination IP and mask for this route.
gateway String
Gateway IP for this route.
seqNum Double
Entry number.
systemRouteId String
an identifier for the resource with format {{seq_num}}.
device string
Gateway out interface.
dsts string[]
Destination IP and mask for this route.
gateway string
Gateway IP for this route.
seqNum number
Entry number.
systemRouteId string
an identifier for the resource with format {{seq_num}}.
device str
Gateway out interface.
dsts Sequence[str]
Destination IP and mask for this route.
gateway str
Gateway IP for this route.
seq_num float
Entry number.
system_route_id str
an identifier for the resource with format {{seq_num}}.
device String
Gateway out interface.
dsts List<String>
Destination IP and mask for this route.
gateway String
Gateway IP for this route.
seqNum Number
Entry number.
systemRouteId String
an identifier for the resource with format {{seq_num}}.

Import

System Route can be imported using any of these accepted formats:

$ export “FORTIMANAGER_IMPORT_TABLE”=“true”

$ pulumi import fortimanager:index/systemRoute:SystemRoute labelname {{seq_num}}
Copy

$ unset “FORTIMANAGER_IMPORT_TABLE”

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
fortimanager fortinetdev/terraform-provider-fortimanager
License
Notes
This Pulumi package is based on the fortimanager Terraform Provider.