1. Packages
  2. Fortios
  3. API Docs
  4. extensioncontroller
  5. Fortigate
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

fortios.extensioncontroller.Fortigate

Explore with Pulumi AI

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

    FortiGate controller configuration. Applies to FortiOS Version >= 7.2.1.

    Create Fortigate Resource

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

    Constructor syntax

    new Fortigate(name: string, args?: FortigateArgs, opts?: CustomResourceOptions);
    @overload
    def Fortigate(resource_name: str,
                  args: Optional[FortigateArgs] = None,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def Fortigate(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  authorized: Optional[str] = None,
                  description: Optional[str] = None,
                  device_id: Optional[int] = None,
                  fosid: Optional[str] = None,
                  hostname: Optional[str] = None,
                  name: Optional[str] = None,
                  profile: Optional[str] = None,
                  vdom: Optional[int] = None,
                  vdomparam: Optional[str] = None)
    func NewFortigate(ctx *Context, name string, args *FortigateArgs, opts ...ResourceOption) (*Fortigate, error)
    public Fortigate(string name, FortigateArgs? args = null, CustomResourceOptions? opts = null)
    public Fortigate(String name, FortigateArgs args)
    public Fortigate(String name, FortigateArgs args, CustomResourceOptions options)
    
    type: fortios:extensioncontroller:Fortigate
    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 FortigateArgs
    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 FortigateArgs
    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 FortigateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FortigateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FortigateArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var fortigateResource = new Fortios.Extensioncontroller.Fortigate("fortigateResource", new()
    {
        Authorized = "string",
        Description = "string",
        DeviceId = 0,
        Fosid = "string",
        Hostname = "string",
        Name = "string",
        Profile = "string",
        Vdom = 0,
        Vdomparam = "string",
    });
    
    example, err := extensioncontroller.NewFortigate(ctx, "fortigateResource", &extensioncontroller.FortigateArgs{
    	Authorized:  pulumi.String("string"),
    	Description: pulumi.String("string"),
    	DeviceId:    pulumi.Int(0),
    	Fosid:       pulumi.String("string"),
    	Hostname:    pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	Profile:     pulumi.String("string"),
    	Vdom:        pulumi.Int(0),
    	Vdomparam:   pulumi.String("string"),
    })
    
    var fortigateResource = new Fortigate("fortigateResource", FortigateArgs.builder()        
        .authorized("string")
        .description("string")
        .deviceId(0)
        .fosid("string")
        .hostname("string")
        .name("string")
        .profile("string")
        .vdom(0)
        .vdomparam("string")
        .build());
    
    fortigate_resource = fortios.extensioncontroller.Fortigate("fortigateResource",
        authorized="string",
        description="string",
        device_id=0,
        fosid="string",
        hostname="string",
        name="string",
        profile="string",
        vdom=0,
        vdomparam="string")
    
    const fortigateResource = new fortios.extensioncontroller.Fortigate("fortigateResource", {
        authorized: "string",
        description: "string",
        deviceId: 0,
        fosid: "string",
        hostname: "string",
        name: "string",
        profile: "string",
        vdom: 0,
        vdomparam: "string",
    });
    
    type: fortios:extensioncontroller:Fortigate
    properties:
        authorized: string
        description: string
        deviceId: 0
        fosid: string
        hostname: string
        name: string
        profile: string
        vdom: 0
        vdomparam: string
    

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

    Authorized string
    Enable/disable FortiGate administration.
    Description string
    Description.
    DeviceId int
    device-id
    Fosid string
    FortiGate serial number.
    Hostname string
    FortiGate hostname.
    Name string
    FortiGate entry name.
    Profile string
    FortiGate profile configuration.
    Vdom int
    VDOM.
    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.
    Authorized string
    Enable/disable FortiGate administration.
    Description string
    Description.
    DeviceId int
    device-id
    Fosid string
    FortiGate serial number.
    Hostname string
    FortiGate hostname.
    Name string
    FortiGate entry name.
    Profile string
    FortiGate profile configuration.
    Vdom int
    VDOM.
    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.
    authorized String
    Enable/disable FortiGate administration.
    description String
    Description.
    deviceId Integer
    device-id
    fosid String
    FortiGate serial number.
    hostname String
    FortiGate hostname.
    name String
    FortiGate entry name.
    profile String
    FortiGate profile configuration.
    vdom Integer
    VDOM.
    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.
    authorized string
    Enable/disable FortiGate administration.
    description string
    Description.
    deviceId number
    device-id
    fosid string
    FortiGate serial number.
    hostname string
    FortiGate hostname.
    name string
    FortiGate entry name.
    profile string
    FortiGate profile configuration.
    vdom number
    VDOM.
    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.
    authorized str
    Enable/disable FortiGate administration.
    description str
    Description.
    device_id int
    device-id
    fosid str
    FortiGate serial number.
    hostname str
    FortiGate hostname.
    name str
    FortiGate entry name.
    profile str
    FortiGate profile configuration.
    vdom int
    VDOM.
    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.
    authorized String
    Enable/disable FortiGate administration.
    description String
    Description.
    deviceId Number
    device-id
    fosid String
    FortiGate serial number.
    hostname String
    FortiGate hostname.
    name String
    FortiGate entry name.
    profile String
    FortiGate profile configuration.
    vdom Number
    VDOM.
    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 Fortigate 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 Fortigate Resource

    Get an existing Fortigate 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?: FortigateState, opts?: CustomResourceOptions): Fortigate
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            authorized: Optional[str] = None,
            description: Optional[str] = None,
            device_id: Optional[int] = None,
            fosid: Optional[str] = None,
            hostname: Optional[str] = None,
            name: Optional[str] = None,
            profile: Optional[str] = None,
            vdom: Optional[int] = None,
            vdomparam: Optional[str] = None) -> Fortigate
    func GetFortigate(ctx *Context, name string, id IDInput, state *FortigateState, opts ...ResourceOption) (*Fortigate, error)
    public static Fortigate Get(string name, Input<string> id, FortigateState? state, CustomResourceOptions? opts = null)
    public static Fortigate get(String name, Output<String> id, FortigateState 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:
    Authorized string
    Enable/disable FortiGate administration.
    Description string
    Description.
    DeviceId int
    device-id
    Fosid string
    FortiGate serial number.
    Hostname string
    FortiGate hostname.
    Name string
    FortiGate entry name.
    Profile string
    FortiGate profile configuration.
    Vdom int
    VDOM.
    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.
    Authorized string
    Enable/disable FortiGate administration.
    Description string
    Description.
    DeviceId int
    device-id
    Fosid string
    FortiGate serial number.
    Hostname string
    FortiGate hostname.
    Name string
    FortiGate entry name.
    Profile string
    FortiGate profile configuration.
    Vdom int
    VDOM.
    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.
    authorized String
    Enable/disable FortiGate administration.
    description String
    Description.
    deviceId Integer
    device-id
    fosid String
    FortiGate serial number.
    hostname String
    FortiGate hostname.
    name String
    FortiGate entry name.
    profile String
    FortiGate profile configuration.
    vdom Integer
    VDOM.
    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.
    authorized string
    Enable/disable FortiGate administration.
    description string
    Description.
    deviceId number
    device-id
    fosid string
    FortiGate serial number.
    hostname string
    FortiGate hostname.
    name string
    FortiGate entry name.
    profile string
    FortiGate profile configuration.
    vdom number
    VDOM.
    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.
    authorized str
    Enable/disable FortiGate administration.
    description str
    Description.
    device_id int
    device-id
    fosid str
    FortiGate serial number.
    hostname str
    FortiGate hostname.
    name str
    FortiGate entry name.
    profile str
    FortiGate profile configuration.
    vdom int
    VDOM.
    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.
    authorized String
    Enable/disable FortiGate administration.
    description String
    Description.
    deviceId Number
    device-id
    fosid String
    FortiGate serial number.
    hostname String
    FortiGate hostname.
    name String
    FortiGate entry name.
    profile String
    FortiGate profile configuration.
    vdom Number
    VDOM.
    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

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

    $ pulumi import fortios:extensioncontroller/fortigate:Fortigate labelname {{name}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:extensioncontroller/fortigate:Fortigate 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.5 published on Tuesday, Apr 9, 2024 by pulumiverse