1. Packages
  2. Fortios
  3. API Docs
  4. switchcontroller
  5. switchcontroller/securitypolicy
  6. Captiveportal
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

fortios.switchcontroller/securitypolicy.Captiveportal

Explore with Pulumi AI

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

    Names of VLANs that use captive portal authentication. Applies to FortiOS Version <= 6.2.0.

    Create Captiveportal Resource

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

    Constructor syntax

    new Captiveportal(name: string, args?: CaptiveportalArgs, opts?: CustomResourceOptions);
    @overload
    def Captiveportal(resource_name: str,
                      args: Optional[CaptiveportalArgs] = None,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def Captiveportal(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      name: Optional[str] = None,
                      policy_type: Optional[str] = None,
                      vdomparam: Optional[str] = None,
                      vlan: Optional[str] = None)
    func NewCaptiveportal(ctx *Context, name string, args *CaptiveportalArgs, opts ...ResourceOption) (*Captiveportal, error)
    public Captiveportal(string name, CaptiveportalArgs? args = null, CustomResourceOptions? opts = null)
    public Captiveportal(String name, CaptiveportalArgs args)
    public Captiveportal(String name, CaptiveportalArgs args, CustomResourceOptions options)
    
    type: fortios:switchcontroller/securitypolicy/captiveportal:Captiveportal
    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 CaptiveportalArgs
    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 CaptiveportalArgs
    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 CaptiveportalArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CaptiveportalArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CaptiveportalArgs
    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 captiveportalResource = new Fortios.Switchcontroller.Securitypolicy.Captiveportal("captiveportalResource", new()
    {
        Name = "string",
        PolicyType = "string",
        Vdomparam = "string",
        Vlan = "string",
    });
    
    example, err := switchcontroller.NewCaptiveportal(ctx, "captiveportalResource", &switchcontroller.CaptiveportalArgs{
    	Name:       pulumi.String("string"),
    	PolicyType: pulumi.String("string"),
    	Vdomparam:  pulumi.String("string"),
    	Vlan:       pulumi.String("string"),
    })
    
    var captiveportalResource = new Captiveportal("captiveportalResource", CaptiveportalArgs.builder()        
        .name("string")
        .policyType("string")
        .vdomparam("string")
        .vlan("string")
        .build());
    
    captiveportal_resource = fortios.switchcontroller.securitypolicy.Captiveportal("captiveportalResource",
        name="string",
        policy_type="string",
        vdomparam="string",
        vlan="string")
    
    const captiveportalResource = new fortios.switchcontroller.securitypolicy.Captiveportal("captiveportalResource", {
        name: "string",
        policyType: "string",
        vdomparam: "string",
        vlan: "string",
    });
    
    Coming soon!
    

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

    Name string
    Policy name.
    PolicyType string
    Policy type. Valid values: captive-portal.
    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.
    Vlan string
    Names of VLANs that use captive portal authentication.
    Name string
    Policy name.
    PolicyType string
    Policy type. Valid values: captive-portal.
    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.
    Vlan string
    Names of VLANs that use captive portal authentication.
    name String
    Policy name.
    policyType String
    Policy type. Valid values: captive-portal.
    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.
    vlan String
    Names of VLANs that use captive portal authentication.
    name string
    Policy name.
    policyType string
    Policy type. Valid values: captive-portal.
    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.
    vlan string
    Names of VLANs that use captive portal authentication.
    name str
    Policy name.
    policy_type str
    Policy type. Valid values: captive-portal.
    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.
    vlan str
    Names of VLANs that use captive portal authentication.
    name String
    Policy name.
    policyType String
    Policy type. Valid values: captive-portal.
    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.
    vlan String
    Names of VLANs that use captive portal authentication.

    Outputs

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

    Get an existing Captiveportal 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?: CaptiveportalState, opts?: CustomResourceOptions): Captiveportal
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            policy_type: Optional[str] = None,
            vdomparam: Optional[str] = None,
            vlan: Optional[str] = None) -> Captiveportal
    func GetCaptiveportal(ctx *Context, name string, id IDInput, state *CaptiveportalState, opts ...ResourceOption) (*Captiveportal, error)
    public static Captiveportal Get(string name, Input<string> id, CaptiveportalState? state, CustomResourceOptions? opts = null)
    public static Captiveportal get(String name, Output<String> id, CaptiveportalState 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:
    Name string
    Policy name.
    PolicyType string
    Policy type. Valid values: captive-portal.
    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.
    Vlan string
    Names of VLANs that use captive portal authentication.
    Name string
    Policy name.
    PolicyType string
    Policy type. Valid values: captive-portal.
    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.
    Vlan string
    Names of VLANs that use captive portal authentication.
    name String
    Policy name.
    policyType String
    Policy type. Valid values: captive-portal.
    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.
    vlan String
    Names of VLANs that use captive portal authentication.
    name string
    Policy name.
    policyType string
    Policy type. Valid values: captive-portal.
    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.
    vlan string
    Names of VLANs that use captive portal authentication.
    name str
    Policy name.
    policy_type str
    Policy type. Valid values: captive-portal.
    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.
    vlan str
    Names of VLANs that use captive portal authentication.
    name String
    Policy name.
    policyType String
    Policy type. Valid values: captive-portal.
    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.
    vlan String
    Names of VLANs that use captive portal authentication.

    Import

    SwitchControllerSecurityPolicy CaptivePortal can be imported using any of these accepted formats:

    $ pulumi import fortios:switchcontroller/securitypolicy/captiveportal:Captiveportal labelname {{name}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:switchcontroller/securitypolicy/captiveportal:Captiveportal 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