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

fortios.switchcontroller.Quarantine

Explore with Pulumi AI

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

Configure FortiSwitch quarantine support.

Create Quarantine Resource

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

Constructor syntax

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

@overload
def Quarantine(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               dynamic_sort_subtable: Optional[str] = None,
               get_all_tables: Optional[str] = None,
               quarantine: Optional[str] = None,
               targets: Optional[Sequence[QuarantineTargetArgs]] = None,
               vdomparam: Optional[str] = None)
func NewQuarantine(ctx *Context, name string, args *QuarantineArgs, opts ...ResourceOption) (*Quarantine, error)
public Quarantine(string name, QuarantineArgs? args = null, CustomResourceOptions? opts = null)
public Quarantine(String name, QuarantineArgs args)
public Quarantine(String name, QuarantineArgs args, CustomResourceOptions options)

type: fortios:switchcontroller:Quarantine
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 QuarantineArgs
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 QuarantineArgs
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 QuarantineArgs
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 QuarantineArgs
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. QuarantineArgs
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 fortiosQuarantineResource = new Fortios.Switchcontroller.Quarantine("fortiosQuarantineResource", new()
{
    DynamicSortSubtable = "string",
    GetAllTables = "string",
    Data = "string",
    Targets = new[]
    {
        new Fortios.Switchcontroller.Inputs.QuarantineTargetArgs
        {
            Description = "string",
            EntryId = 0,
            Mac = "string",
            Tags = new[]
            {
                new Fortios.Switchcontroller.Inputs.QuarantineTargetTagArgs
                {
                    Tags = "string",
                },
            },
        },
    },
    Vdomparam = "string",
});
Copy
example, err := switchcontroller.NewQuarantine(ctx, "fortiosQuarantineResource", &switchcontroller.QuarantineArgs{
	DynamicSortSubtable: pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	Quarantine:          pulumi.String("string"),
	Targets: switchcontroller.QuarantineTargetArray{
		&switchcontroller.QuarantineTargetArgs{
			Description: pulumi.String("string"),
			EntryId:     pulumi.Int(0),
			Mac:         pulumi.String("string"),
			Tags: switchcontroller.QuarantineTargetTagArray{
				&switchcontroller.QuarantineTargetTagArgs{
					Tags: pulumi.String("string"),
				},
			},
		},
	},
	Vdomparam: pulumi.String("string"),
})
Copy
var fortiosQuarantineResource = new com.pulumi.fortios.switchcontroller.Quarantine("fortiosQuarantineResource", com.pulumi.fortios.switchcontroller.QuarantineArgs.builder()
    .dynamicSortSubtable("string")
    .getAllTables("string")
    .quarantine("string")
    .targets(QuarantineTargetArgs.builder()
        .description("string")
        .entryId(0)
        .mac("string")
        .tags(QuarantineTargetTagArgs.builder()
            .tags("string")
            .build())
        .build())
    .vdomparam("string")
    .build());
Copy
fortios_quarantine_resource = fortios.switchcontroller.Quarantine("fortiosQuarantineResource",
    dynamic_sort_subtable="string",
    get_all_tables="string",
    quarantine="string",
    targets=[{
        "description": "string",
        "entry_id": 0,
        "mac": "string",
        "tags": [{
            "tags": "string",
        }],
    }],
    vdomparam="string")
Copy
const fortiosQuarantineResource = new fortios.switchcontroller.Quarantine("fortiosQuarantineResource", {
    dynamicSortSubtable: "string",
    getAllTables: "string",
    quarantine: "string",
    targets: [{
        description: "string",
        entryId: 0,
        mac: "string",
        tags: [{
            tags: "string",
        }],
    }],
    vdomparam: "string",
});
Copy
type: fortios:switchcontroller:Quarantine
properties:
    dynamicSortSubtable: string
    getAllTables: string
    quarantine: string
    targets:
        - description: string
          entryId: 0
          mac: string
          tags:
            - tags: string
    vdomparam: string
Copy

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

Data string
Enable/disable quarantine. Valid values: enable, disable.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
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.
Targets List<Pulumiverse.Fortios.Switchcontroller.Inputs.QuarantineTarget>
Quarantine MACs. The structure of targets block is documented below.
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.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
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.
Quarantine string
Enable/disable quarantine. Valid values: enable, disable.
Targets []QuarantineTargetArgs
Quarantine MACs. The structure of targets block is documented below.
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.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
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.
quarantine String
Enable/disable quarantine. Valid values: enable, disable.
targets List<QuarantineTarget>
Quarantine MACs. The structure of targets block is documented below.
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.
dynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
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.
quarantine string
Enable/disable quarantine. Valid values: enable, disable.
targets QuarantineTarget[]
Quarantine MACs. The structure of targets block is documented below.
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.
dynamic_sort_subtable str
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
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.
quarantine str
Enable/disable quarantine. Valid values: enable, disable.
targets Sequence[QuarantineTargetArgs]
Quarantine MACs. The structure of targets block is documented below.
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.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
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.
quarantine String
Enable/disable quarantine. Valid values: enable, disable.
targets List<Property Map>
Quarantine MACs. The structure of targets block is documented below.
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 Quarantine 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 Quarantine Resource

Get an existing Quarantine 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?: QuarantineState, opts?: CustomResourceOptions): Quarantine
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dynamic_sort_subtable: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        quarantine: Optional[str] = None,
        targets: Optional[Sequence[QuarantineTargetArgs]] = None,
        vdomparam: Optional[str] = None) -> Quarantine
func GetQuarantine(ctx *Context, name string, id IDInput, state *QuarantineState, opts ...ResourceOption) (*Quarantine, error)
public static Quarantine Get(string name, Input<string> id, QuarantineState? state, CustomResourceOptions? opts = null)
public static Quarantine get(String name, Output<String> id, QuarantineState state, CustomResourceOptions options)
resources:  _:    type: fortios:switchcontroller:Quarantine    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:
Data string
Enable/disable quarantine. Valid values: enable, disable.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
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.
Targets List<Pulumiverse.Fortios.Switchcontroller.Inputs.QuarantineTarget>
Quarantine MACs. The structure of targets block is documented below.
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.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
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.
Quarantine string
Enable/disable quarantine. Valid values: enable, disable.
Targets []QuarantineTargetArgs
Quarantine MACs. The structure of targets block is documented below.
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.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
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.
quarantine String
Enable/disable quarantine. Valid values: enable, disable.
targets List<QuarantineTarget>
Quarantine MACs. The structure of targets block is documented below.
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.
dynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
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.
quarantine string
Enable/disable quarantine. Valid values: enable, disable.
targets QuarantineTarget[]
Quarantine MACs. The structure of targets block is documented below.
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.
dynamic_sort_subtable str
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
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.
quarantine str
Enable/disable quarantine. Valid values: enable, disable.
targets Sequence[QuarantineTargetArgs]
Quarantine MACs. The structure of targets block is documented below.
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.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
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.
quarantine String
Enable/disable quarantine. Valid values: enable, disable.
targets List<Property Map>
Quarantine MACs. The structure of targets block is documented below.
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.

Supporting Types

QuarantineTarget
, QuarantineTargetArgs

Description string
Description for the quarantine MAC.
EntryId int
FSW entry id for the quarantine MAC.
Mac string
Quarantine MAC.
Tags List<Pulumiverse.Fortios.Switchcontroller.Inputs.QuarantineTargetTag>
Tags for the quarantine MAC. The structure of tag block is documented below.
Description string
Description for the quarantine MAC.
EntryId int
FSW entry id for the quarantine MAC.
Mac string
Quarantine MAC.
Tags []QuarantineTargetTag
Tags for the quarantine MAC. The structure of tag block is documented below.
description String
Description for the quarantine MAC.
entryId Integer
FSW entry id for the quarantine MAC.
mac String
Quarantine MAC.
tags List<QuarantineTargetTag>
Tags for the quarantine MAC. The structure of tag block is documented below.
description string
Description for the quarantine MAC.
entryId number
FSW entry id for the quarantine MAC.
mac string
Quarantine MAC.
tags QuarantineTargetTag[]
Tags for the quarantine MAC. The structure of tag block is documented below.
description str
Description for the quarantine MAC.
entry_id int
FSW entry id for the quarantine MAC.
mac str
Quarantine MAC.
tags Sequence[QuarantineTargetTag]
Tags for the quarantine MAC. The structure of tag block is documented below.
description String
Description for the quarantine MAC.
entryId Number
FSW entry id for the quarantine MAC.
mac String
Quarantine MAC.
tags List<Property Map>
Tags for the quarantine MAC. The structure of tag block is documented below.

QuarantineTargetTag
, QuarantineTargetTagArgs

Tags string
Tag string. For example, string1 string2 string3.
Tags string
Tag string. For example, string1 string2 string3.
tags String
Tag string. For example, string1 string2 string3.
tags string
Tag string. For example, string1 string2 string3.
tags str
Tag string. For example, string1 string2 string3.
tags String
Tag string. For example, string1 string2 string3.

Import

SwitchController Quarantine can be imported using any of these accepted formats:

$ pulumi import fortios:switchcontroller/quarantine:Quarantine labelname SwitchControllerQuarantine
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:switchcontroller/quarantine:Quarantine labelname SwitchControllerQuarantine
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.
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios