1. Packages
  2. Fortios
  3. API Docs
  4. router
  5. Authpath
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.router.Authpath

Explore with Pulumi AI

Configure authentication based routing.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as fortios from "@pulumiverse/fortios";

const trname = new fortios.router.Authpath("trname", {
    device: "port3",
    gateway: "1.1.1.1",
});
Copy
import pulumi
import pulumiverse_fortios as fortios

trname = fortios.router.Authpath("trname",
    device="port3",
    gateway="1.1.1.1")
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/router"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := router.NewAuthpath(ctx, "trname", &router.AuthpathArgs{
			Device:  pulumi.String("port3"),
			Gateway: pulumi.String("1.1.1.1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.Router.Authpath("trname", new()
    {
        Device = "port3",
        Gateway = "1.1.1.1",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.router.Authpath;
import com.pulumi.fortios.router.AuthpathArgs;
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 Authpath("trname", AuthpathArgs.builder()
            .device("port3")
            .gateway("1.1.1.1")
            .build());

    }
}
Copy
resources:
  trname:
    type: fortios:router:Authpath
    properties:
      device: port3
      gateway: 1.1.1.1
Copy

Create Authpath Resource

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

Constructor syntax

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

@overload
def Authpath(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             device: Optional[str] = None,
             gateway: Optional[str] = None,
             name: Optional[str] = None,
             vdomparam: Optional[str] = None)
func NewAuthpath(ctx *Context, name string, args AuthpathArgs, opts ...ResourceOption) (*Authpath, error)
public Authpath(string name, AuthpathArgs args, CustomResourceOptions? opts = null)
public Authpath(String name, AuthpathArgs args)
public Authpath(String name, AuthpathArgs args, CustomResourceOptions options)
type: fortios:router:Authpath
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 This property is required. AuthpathArgs
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 This property is required. AuthpathArgs
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 This property is required. AuthpathArgs
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 This property is required. AuthpathArgs
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. AuthpathArgs
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 authpathResource = new Fortios.Router.Authpath("authpathResource", new()
{
    Device = "string",
    Gateway = "string",
    Name = "string",
    Vdomparam = "string",
});
Copy
example, err := router.NewAuthpath(ctx, "authpathResource", &router.AuthpathArgs{
	Device:    pulumi.String("string"),
	Gateway:   pulumi.String("string"),
	Name:      pulumi.String("string"),
	Vdomparam: pulumi.String("string"),
})
Copy
var authpathResource = new Authpath("authpathResource", AuthpathArgs.builder()
    .device("string")
    .gateway("string")
    .name("string")
    .vdomparam("string")
    .build());
Copy
authpath_resource = fortios.router.Authpath("authpathResource",
    device="string",
    gateway="string",
    name="string",
    vdomparam="string")
Copy
const authpathResource = new fortios.router.Authpath("authpathResource", {
    device: "string",
    gateway: "string",
    name: "string",
    vdomparam: "string",
});
Copy
type: fortios:router:Authpath
properties:
    device: string
    gateway: string
    name: string
    vdomparam: string
Copy

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

Device This property is required. string
Outgoing interface.
Gateway string
Gateway IP address.
Name Changes to this property will trigger replacement. string
Name of the entry.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
Device This property is required. string
Outgoing interface.
Gateway string
Gateway IP address.
Name Changes to this property will trigger replacement. string
Name of the entry.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
device This property is required. String
Outgoing interface.
gateway String
Gateway IP address.
name Changes to this property will trigger replacement. String
Name of the entry.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
device This property is required. string
Outgoing interface.
gateway string
Gateway IP address.
name Changes to this property will trigger replacement. string
Name of the entry.
vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
device This property is required. str
Outgoing interface.
gateway str
Gateway IP address.
name Changes to this property will trigger replacement. str
Name of the entry.
vdomparam Changes to this property will trigger replacement. str
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
device This property is required. String
Outgoing interface.
gateway String
Gateway IP address.
name Changes to this property will trigger replacement. String
Name of the entry.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

Outputs

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

Get an existing Authpath 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?: AuthpathState, opts?: CustomResourceOptions): Authpath
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device: Optional[str] = None,
        gateway: Optional[str] = None,
        name: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Authpath
func GetAuthpath(ctx *Context, name string, id IDInput, state *AuthpathState, opts ...ResourceOption) (*Authpath, error)
public static Authpath Get(string name, Input<string> id, AuthpathState? state, CustomResourceOptions? opts = null)
public static Authpath get(String name, Output<String> id, AuthpathState state, CustomResourceOptions options)
resources:  _:    type: fortios:router:Authpath    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
Outgoing interface.
Gateway string
Gateway IP address.
Name Changes to this property will trigger replacement. string
Name of the entry.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
Device string
Outgoing interface.
Gateway string
Gateway IP address.
Name Changes to this property will trigger replacement. string
Name of the entry.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
device String
Outgoing interface.
gateway String
Gateway IP address.
name Changes to this property will trigger replacement. String
Name of the entry.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
device string
Outgoing interface.
gateway string
Gateway IP address.
name Changes to this property will trigger replacement. string
Name of the entry.
vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
device str
Outgoing interface.
gateway str
Gateway IP address.
name Changes to this property will trigger replacement. str
Name of the entry.
vdomparam Changes to this property will trigger replacement. str
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
device String
Outgoing interface.
gateway String
Gateway IP address.
name Changes to this property will trigger replacement. String
Name of the entry.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

Import

Router AuthPath can be imported using any of these accepted formats:

$ pulumi import fortios:router/authpath:Authpath labelname {{name}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:router/authpath:Authpath labelname {{name}}
Copy

$ unset “FORTIOS_IMPORT_TABLE”

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

Package Details

Repository
fortios pulumiverse/pulumi-fortios
License
Apache-2.0
Notes
This Pulumi package is based on the fortios Terraform Provider.