Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortios
  3. API Docs
  4. extensioncontroller
  5. Fortigateprofile
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.extensioncontroller.Fortigateprofile

Explore with Pulumi AI

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

    FortiGate connector profile configuration. Applies to FortiOS Version >= 7.2.1.

    Create Fortigateprofile Resource

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

    Constructor syntax

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

@overload
def Fortigateprofile(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     extension: Optional[str] = None,
                     fosid: Optional[int] = None,
                     get_all_tables: Optional[str] = None,
                     lan_extension: Optional[FortigateprofileLanExtensionArgs] = None,
                     name: Optional[str] = None,
                     vdomparam: Optional[str] = None)
    func NewFortigateprofile(ctx *Context, name string, args *FortigateprofileArgs, opts ...ResourceOption) (*Fortigateprofile, error)
    public Fortigateprofile(string name, FortigateprofileArgs? args = null, CustomResourceOptions? opts = null)
    public Fortigateprofile(String name, FortigateprofileArgs args)
public Fortigateprofile(String name, FortigateprofileArgs args, CustomResourceOptions options)

    type: fortios:extensioncontroller:Fortigateprofile
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 FortigateprofileArgs
    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 FortigateprofileArgs
    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 FortigateprofileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FortigateprofileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FortigateprofileArgs
    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 fortigateprofileResource = new Fortios.Extensioncontroller.Fortigateprofile("fortigateprofileResource", new()
{
    Extension = "string",
    Fosid = 0,
    GetAllTables = "string",
    LanExtension = new Fortios.Extensioncontroller.Inputs.FortigateprofileLanExtensionArgs
    {
        BackhaulInterface = "string",
        BackhaulIp = "string",
        IpsecTunnel = "string",
    },
    Name = "string",
    Vdomparam = "string",
});

    example, err := extensioncontroller.NewFortigateprofile(ctx, "fortigateprofileResource", &extensioncontroller.FortigateprofileArgs{
	Extension:    pulumi.String("string"),
	Fosid:        pulumi.Int(0),
	GetAllTables: pulumi.String("string"),
	LanExtension: &extensioncontroller.FortigateprofileLanExtensionArgs{
		BackhaulInterface: pulumi.String("string"),
		BackhaulIp:        pulumi.String("string"),
		IpsecTunnel:       pulumi.String("string"),
	},
	Name:      pulumi.String("string"),
	Vdomparam: pulumi.String("string"),
})

    var fortigateprofileResource = new Fortigateprofile("fortigateprofileResource", FortigateprofileArgs.builder()
    .extension("string")
    .fosid(0)
    .getAllTables("string")
    .lanExtension(FortigateprofileLanExtensionArgs.builder()
        .backhaulInterface("string")
        .backhaulIp("string")
        .ipsecTunnel("string")
        .build())
    .name("string")
    .vdomparam("string")
    .build());

    fortigateprofile_resource = fortios.extensioncontroller.Fortigateprofile("fortigateprofileResource",
    extension="string",
    fosid=0,
    get_all_tables="string",
    lan_extension={
        "backhaul_interface": "string",
        "backhaul_ip": "string",
        "ipsec_tunnel": "string",
    },
    name="string",
    vdomparam="string")

    const fortigateprofileResource = new fortios.extensioncontroller.Fortigateprofile("fortigateprofileResource", {
    extension: "string",
    fosid: 0,
    getAllTables: "string",
    lanExtension: {
        backhaulInterface: "string",
        backhaulIp: "string",
        ipsecTunnel: "string",
    },
    name: "string",
    vdomparam: "string",
});

    type: fortios:extensioncontroller:Fortigateprofile
properties:
    extension: string
    fosid: 0
    getAllTables: string
    lanExtension:
        backhaulInterface: string
        backhaulIp: string
        ipsecTunnel: string
    name: string
    vdomparam: string

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

    Extension string
    Extension option. Valid values: lan-extension.
    Fosid int
    ID.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    LanExtension Pulumiverse.Fortios.Extensioncontroller.Inputs.FortigateprofileLanExtension
    FortiGate connector LAN extension configuration. The structure of lan_extension block is documented below.
    Name string
    FortiGate connector profile name.
    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.
    Extension string
    Extension option. Valid values: lan-extension.
    Fosid int
    ID.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    LanExtension FortigateprofileLanExtensionArgs
    FortiGate connector LAN extension configuration. The structure of lan_extension block is documented below.
    Name string
    FortiGate connector profile name.
    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.
    extension String
    Extension option. Valid values: lan-extension.
    fosid Integer
    ID.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    lanExtension FortigateprofileLanExtension
    FortiGate connector LAN extension configuration. The structure of lan_extension block is documented below.
    name String
    FortiGate connector profile name.
    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.
    extension string
    Extension option. Valid values: lan-extension.
    fosid number
    ID.
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    lanExtension FortigateprofileLanExtension
    FortiGate connector LAN extension configuration. The structure of lan_extension block is documented below.
    name string
    FortiGate connector profile name.
    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.
    extension str
    Extension option. Valid values: lan-extension.
    fosid int
    ID.
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    lan_extension FortigateprofileLanExtensionArgs
    FortiGate connector LAN extension configuration. The structure of lan_extension block is documented below.
    name str
    FortiGate connector profile name.
    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.
    extension String
    Extension option. Valid values: lan-extension.
    fosid Number
    ID.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    lanExtension Property Map
    FortiGate connector LAN extension configuration. The structure of lan_extension block is documented below.
    name String
    FortiGate connector profile name.
    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 Fortigateprofile 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 Fortigateprofile Resource

    Get an existing Fortigateprofile 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?: FortigateprofileState, opts?: CustomResourceOptions): Fortigateprofile
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        extension: Optional[str] = None,
        fosid: Optional[int] = None,
        get_all_tables: Optional[str] = None,
        lan_extension: Optional[FortigateprofileLanExtensionArgs] = None,
        name: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Fortigateprofile
    func GetFortigateprofile(ctx *Context, name string, id IDInput, state *FortigateprofileState, opts ...ResourceOption) (*Fortigateprofile, error)
    public static Fortigateprofile Get(string name, Input<string> id, FortigateprofileState? state, CustomResourceOptions? opts = null)
    public static Fortigateprofile get(String name, Output<String> id, FortigateprofileState 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:
    Extension string
    Extension option. Valid values: lan-extension.
    Fosid int
    ID.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    LanExtension Pulumiverse.Fortios.Extensioncontroller.Inputs.FortigateprofileLanExtension
    FortiGate connector LAN extension configuration. The structure of lan_extension block is documented below.
    Name string
    FortiGate connector profile name.
    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.
    Extension string
    Extension option. Valid values: lan-extension.
    Fosid int
    ID.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    LanExtension FortigateprofileLanExtensionArgs
    FortiGate connector LAN extension configuration. The structure of lan_extension block is documented below.
    Name string
    FortiGate connector profile name.
    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.
    extension String
    Extension option. Valid values: lan-extension.
    fosid Integer
    ID.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    lanExtension FortigateprofileLanExtension
    FortiGate connector LAN extension configuration. The structure of lan_extension block is documented below.
    name String
    FortiGate connector profile name.
    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.
    extension string
    Extension option. Valid values: lan-extension.
    fosid number
    ID.
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    lanExtension FortigateprofileLanExtension
    FortiGate connector LAN extension configuration. The structure of lan_extension block is documented below.
    name string
    FortiGate connector profile name.
    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.
    extension str
    Extension option. Valid values: lan-extension.
    fosid int
    ID.
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    lan_extension FortigateprofileLanExtensionArgs
    FortiGate connector LAN extension configuration. The structure of lan_extension block is documented below.
    name str
    FortiGate connector profile name.
    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.
    extension String
    Extension option. Valid values: lan-extension.
    fosid Number
    ID.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    lanExtension Property Map
    FortiGate connector LAN extension configuration. The structure of lan_extension block is documented below.
    name String
    FortiGate connector profile name.
    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.

    Supporting Types

    FortigateprofileLanExtension, FortigateprofileLanExtensionArgs

    BackhaulInterface string
    IPsec phase1 interface.
    BackhaulIp string
    IPsec phase1 IPv4/FQDN. Used to specify the external IP/FQDN when the FortiGate unit is behind a NAT device.
    IpsecTunnel string
    IPsec tunnel name.
    BackhaulInterface string
    IPsec phase1 interface.
    BackhaulIp string
    IPsec phase1 IPv4/FQDN. Used to specify the external IP/FQDN when the FortiGate unit is behind a NAT device.
    IpsecTunnel string
    IPsec tunnel name.
    backhaulInterface String
    IPsec phase1 interface.
    backhaulIp String
    IPsec phase1 IPv4/FQDN. Used to specify the external IP/FQDN when the FortiGate unit is behind a NAT device.
    ipsecTunnel String
    IPsec tunnel name.
    backhaulInterface string
    IPsec phase1 interface.
    backhaulIp string
    IPsec phase1 IPv4/FQDN. Used to specify the external IP/FQDN when the FortiGate unit is behind a NAT device.
    ipsecTunnel string
    IPsec tunnel name.
    backhaul_interface str
    IPsec phase1 interface.
    backhaul_ip str
    IPsec phase1 IPv4/FQDN. Used to specify the external IP/FQDN when the FortiGate unit is behind a NAT device.
    ipsec_tunnel str
    IPsec tunnel name.
    backhaulInterface String
    IPsec phase1 interface.
    backhaulIp String
    IPsec phase1 IPv4/FQDN. Used to specify the external IP/FQDN when the FortiGate unit is behind a NAT device.
    ipsecTunnel String
    IPsec tunnel name.

    Import

    ExtensionController FortigateProfile can be imported using any of these accepted formats:

    $ pulumi import fortios:extensioncontroller/fortigateprofile:Fortigateprofile labelname {{name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:extensioncontroller/fortigateprofile:Fortigateprofile labelname {{name}}

    $ 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.6 published on Tuesday, Jul 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios