Docs Packages
  1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. Vnetunnel
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.system.Vnetunnel

Explore with Pulumi AI

fortios logo
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

    Configure virtual network enabler tunnel. Applies to FortiOS Version >= 6.4.1.

    Create Vnetunnel Resource

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

    Constructor syntax

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

@overload
def Vnetunnel(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              auto_asic_offload: Optional[str] = None,
              bmr_hostname: Optional[str] = None,
              br: Optional[str] = None,
              http_password: Optional[str] = None,
              http_username: Optional[str] = None,
              interface: Optional[str] = None,
              ipv4_address: Optional[str] = None,
              mode: Optional[str] = None,
              ssl_certificate: Optional[str] = None,
              status: Optional[str] = None,
              update_url: Optional[str] = None,
              vdomparam: Optional[str] = None)
    func NewVnetunnel(ctx *Context, name string, args *VnetunnelArgs, opts ...ResourceOption) (*Vnetunnel, error)
    public Vnetunnel(string name, VnetunnelArgs? args = null, CustomResourceOptions? opts = null)
    public Vnetunnel(String name, VnetunnelArgs args)
public Vnetunnel(String name, VnetunnelArgs args, CustomResourceOptions options)

    type: fortios:system:Vnetunnel
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 VnetunnelArgs
    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 VnetunnelArgs
    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 VnetunnelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VnetunnelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VnetunnelArgs
    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 vnetunnelResource = new Fortios.System.Vnetunnel("vnetunnelResource", new()
{
    AutoAsicOffload = "string",
    BmrHostname = "string",
    Br = "string",
    HttpPassword = "string",
    HttpUsername = "string",
    Interface = "string",
    Ipv4Address = "string",
    Mode = "string",
    SslCertificate = "string",
    Status = "string",
    UpdateUrl = "string",
    Vdomparam = "string",
});

    example, err := system.NewVnetunnel(ctx, "vnetunnelResource", &system.VnetunnelArgs{
	AutoAsicOffload: pulumi.String("string"),
	BmrHostname:     pulumi.String("string"),
	Br:              pulumi.String("string"),
	HttpPassword:    pulumi.String("string"),
	HttpUsername:    pulumi.String("string"),
	Interface:       pulumi.String("string"),
	Ipv4Address:     pulumi.String("string"),
	Mode:            pulumi.String("string"),
	SslCertificate:  pulumi.String("string"),
	Status:          pulumi.String("string"),
	UpdateUrl:       pulumi.String("string"),
	Vdomparam:       pulumi.String("string"),
})

    var vnetunnelResource = new Vnetunnel("vnetunnelResource", VnetunnelArgs.builder()
    .autoAsicOffload("string")
    .bmrHostname("string")
    .br("string")
    .httpPassword("string")
    .httpUsername("string")
    .interface_("string")
    .ipv4Address("string")
    .mode("string")
    .sslCertificate("string")
    .status("string")
    .updateUrl("string")
    .vdomparam("string")
    .build());

    vnetunnel_resource = fortios.system.Vnetunnel("vnetunnelResource",
    auto_asic_offload="string",
    bmr_hostname="string",
    br="string",
    http_password="string",
    http_username="string",
    interface="string",
    ipv4_address="string",
    mode="string",
    ssl_certificate="string",
    status="string",
    update_url="string",
    vdomparam="string")

    const vnetunnelResource = new fortios.system.Vnetunnel("vnetunnelResource", {
    autoAsicOffload: "string",
    bmrHostname: "string",
    br: "string",
    httpPassword: "string",
    httpUsername: "string",
    "interface": "string",
    ipv4Address: "string",
    mode: "string",
    sslCertificate: "string",
    status: "string",
    updateUrl: "string",
    vdomparam: "string",
});

    type: fortios:system:Vnetunnel
properties:
    autoAsicOffload: string
    bmrHostname: string
    br: string
    httpPassword: string
    httpUsername: string
    interface: string
    ipv4Address: string
    mode: string
    sslCertificate: string
    status: string
    updateUrl: string
    vdomparam: string

    Vnetunnel Resource Properties

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

    Inputs

    The Vnetunnel resource accepts the following input properties:

    AutoAsicOffload string
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    BmrHostname string
    BMR hostname.
    Br string
    Border relay IPv6 address.
    HttpPassword string
    HTTP authentication password.
    HttpUsername string
    HTTP authentication user name.
    Interface string
    Interface name.
    Ipv4Address string
    Tunnel IPv4 address and netmask.
    Mode string
    VNE tunnel mode.
    SslCertificate string
    Name of local certificate for SSL connections.
    Status string
    Enable/disable VNE tunnel. Valid values: enable, disable.
    UpdateUrl string
    URL of provisioning server.
    Vdomparam 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.
    AutoAsicOffload string
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    BmrHostname string
    BMR hostname.
    Br string
    Border relay IPv6 address.
    HttpPassword string
    HTTP authentication password.
    HttpUsername string
    HTTP authentication user name.
    Interface string
    Interface name.
    Ipv4Address string
    Tunnel IPv4 address and netmask.
    Mode string
    VNE tunnel mode.
    SslCertificate string
    Name of local certificate for SSL connections.
    Status string
    Enable/disable VNE tunnel. Valid values: enable, disable.
    UpdateUrl string
    URL of provisioning server.
    Vdomparam 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.
    autoAsicOffload String
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    bmrHostname String
    BMR hostname.
    br String
    Border relay IPv6 address.
    httpPassword String
    HTTP authentication password.
    httpUsername String
    HTTP authentication user name.
    interface_ String
    Interface name.
    ipv4Address String
    Tunnel IPv4 address and netmask.
    mode String
    VNE tunnel mode.
    sslCertificate String
    Name of local certificate for SSL connections.
    status String
    Enable/disable VNE tunnel. Valid values: enable, disable.
    updateUrl String
    URL of provisioning server.
    vdomparam 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.
    autoAsicOffload string
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    bmrHostname string
    BMR hostname.
    br string
    Border relay IPv6 address.
    httpPassword string
    HTTP authentication password.
    httpUsername string
    HTTP authentication user name.
    interface string
    Interface name.
    ipv4Address string
    Tunnel IPv4 address and netmask.
    mode string
    VNE tunnel mode.
    sslCertificate string
    Name of local certificate for SSL connections.
    status string
    Enable/disable VNE tunnel. Valid values: enable, disable.
    updateUrl string
    URL of provisioning server.
    vdomparam 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.
    auto_asic_offload str
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    bmr_hostname str
    BMR hostname.
    br str
    Border relay IPv6 address.
    http_password str
    HTTP authentication password.
    http_username str
    HTTP authentication user name.
    interface str
    Interface name.
    ipv4_address str
    Tunnel IPv4 address and netmask.
    mode str
    VNE tunnel mode.
    ssl_certificate str
    Name of local certificate for SSL connections.
    status str
    Enable/disable VNE tunnel. Valid values: enable, disable.
    update_url str
    URL of provisioning server.
    vdomparam 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.
    autoAsicOffload String
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    bmrHostname String
    BMR hostname.
    br String
    Border relay IPv6 address.
    httpPassword String
    HTTP authentication password.
    httpUsername String
    HTTP authentication user name.
    interface String
    Interface name.
    ipv4Address String
    Tunnel IPv4 address and netmask.
    mode String
    VNE tunnel mode.
    sslCertificate String
    Name of local certificate for SSL connections.
    status String
    Enable/disable VNE tunnel. Valid values: enable, disable.
    updateUrl String
    URL of provisioning server.
    vdomparam 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 Vnetunnel 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 Vnetunnel Resource

    Get an existing Vnetunnel 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?: VnetunnelState, opts?: CustomResourceOptions): Vnetunnel
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_asic_offload: Optional[str] = None,
        bmr_hostname: Optional[str] = None,
        br: Optional[str] = None,
        http_password: Optional[str] = None,
        http_username: Optional[str] = None,
        interface: Optional[str] = None,
        ipv4_address: Optional[str] = None,
        mode: Optional[str] = None,
        ssl_certificate: Optional[str] = None,
        status: Optional[str] = None,
        update_url: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Vnetunnel
    func GetVnetunnel(ctx *Context, name string, id IDInput, state *VnetunnelState, opts ...ResourceOption) (*Vnetunnel, error)
    public static Vnetunnel Get(string name, Input<string> id, VnetunnelState? state, CustomResourceOptions? opts = null)
    public static Vnetunnel get(String name, Output<String> id, VnetunnelState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AutoAsicOffload string
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    BmrHostname string
    BMR hostname.
    Br string
    Border relay IPv6 address.
    HttpPassword string
    HTTP authentication password.
    HttpUsername string
    HTTP authentication user name.
    Interface string
    Interface name.
    Ipv4Address string
    Tunnel IPv4 address and netmask.
    Mode string
    VNE tunnel mode.
    SslCertificate string
    Name of local certificate for SSL connections.
    Status string
    Enable/disable VNE tunnel. Valid values: enable, disable.
    UpdateUrl string
    URL of provisioning server.
    Vdomparam 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.
    AutoAsicOffload string
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    BmrHostname string
    BMR hostname.
    Br string
    Border relay IPv6 address.
    HttpPassword string
    HTTP authentication password.
    HttpUsername string
    HTTP authentication user name.
    Interface string
    Interface name.
    Ipv4Address string
    Tunnel IPv4 address and netmask.
    Mode string
    VNE tunnel mode.
    SslCertificate string
    Name of local certificate for SSL connections.
    Status string
    Enable/disable VNE tunnel. Valid values: enable, disable.
    UpdateUrl string
    URL of provisioning server.
    Vdomparam 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.
    autoAsicOffload String
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    bmrHostname String
    BMR hostname.
    br String
    Border relay IPv6 address.
    httpPassword String
    HTTP authentication password.
    httpUsername String
    HTTP authentication user name.
    interface_ String
    Interface name.
    ipv4Address String
    Tunnel IPv4 address and netmask.
    mode String
    VNE tunnel mode.
    sslCertificate String
    Name of local certificate for SSL connections.
    status String
    Enable/disable VNE tunnel. Valid values: enable, disable.
    updateUrl String
    URL of provisioning server.
    vdomparam 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.
    autoAsicOffload string
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    bmrHostname string
    BMR hostname.
    br string
    Border relay IPv6 address.
    httpPassword string
    HTTP authentication password.
    httpUsername string
    HTTP authentication user name.
    interface string
    Interface name.
    ipv4Address string
    Tunnel IPv4 address and netmask.
    mode string
    VNE tunnel mode.
    sslCertificate string
    Name of local certificate for SSL connections.
    status string
    Enable/disable VNE tunnel. Valid values: enable, disable.
    updateUrl string
    URL of provisioning server.
    vdomparam 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.
    auto_asic_offload str
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    bmr_hostname str
    BMR hostname.
    br str
    Border relay IPv6 address.
    http_password str
    HTTP authentication password.
    http_username str
    HTTP authentication user name.
    interface str
    Interface name.
    ipv4_address str
    Tunnel IPv4 address and netmask.
    mode str
    VNE tunnel mode.
    ssl_certificate str
    Name of local certificate for SSL connections.
    status str
    Enable/disable VNE tunnel. Valid values: enable, disable.
    update_url str
    URL of provisioning server.
    vdomparam 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.
    autoAsicOffload String
    Enable/disable tunnel ASIC offloading. Valid values: enable, disable.
    bmrHostname String
    BMR hostname.
    br String
    Border relay IPv6 address.
    httpPassword String
    HTTP authentication password.
    httpUsername String
    HTTP authentication user name.
    interface String
    Interface name.
    ipv4Address String
    Tunnel IPv4 address and netmask.
    mode String
    VNE tunnel mode.
    sslCertificate String
    Name of local certificate for SSL connections.
    status String
    Enable/disable VNE tunnel. Valid values: enable, disable.
    updateUrl String
    URL of provisioning server.
    vdomparam 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

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

    $ pulumi import fortios:system/vnetunnel:Vnetunnel labelname SystemVneTunnel

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/vnetunnel:Vnetunnel labelname SystemVneTunnel

    $ 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.
    fortios logo
    Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios