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

fortios.switchcontroller/initialconfig.Vlans

Explore with Pulumi AI

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

    Configure initial template for auto-generated VLAN interfaces. Applies to FortiOS Version >= 6.4.0.

    Create Vlans Resource

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

    Constructor syntax

    new Vlans(name: string, args?: VlansArgs, opts?: CustomResourceOptions);
    @overload
    def Vlans(resource_name: str,
              args: Optional[VlansArgs] = None,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Vlans(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              default_vlan: Optional[str] = None,
              nac: Optional[str] = None,
              nac_segment: Optional[str] = None,
              quarantine: Optional[str] = None,
              rspan: Optional[str] = None,
              vdomparam: Optional[str] = None,
              video: Optional[str] = None,
              voice: Optional[str] = None)
    func NewVlans(ctx *Context, name string, args *VlansArgs, opts ...ResourceOption) (*Vlans, error)
    public Vlans(string name, VlansArgs? args = null, CustomResourceOptions? opts = null)
    public Vlans(String name, VlansArgs args)
    public Vlans(String name, VlansArgs args, CustomResourceOptions options)
    
    type: fortios:switchcontroller/initialconfig/vlans:Vlans
    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 VlansArgs
    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 VlansArgs
    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 VlansArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VlansArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VlansArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    DefaultVlan string
    Default VLAN (native) assigned to all switch ports upon discovery.
    Nac string
    VLAN for NAC onboarding devices.
    NacSegment string
    VLAN for NAC segemnt primary interface.
    Quarantine string
    VLAN for quarantined traffic.
    Rspan string
    VLAN for RSPAN/ERSPAN mirrored traffic.
    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.
    Video string
    VLAN dedicated for video devices.
    Voice string
    VLAN dedicated for voice devices.
    DefaultVlan string
    Default VLAN (native) assigned to all switch ports upon discovery.
    Nac string
    VLAN for NAC onboarding devices.
    NacSegment string
    VLAN for NAC segemnt primary interface.
    Quarantine string
    VLAN for quarantined traffic.
    Rspan string
    VLAN for RSPAN/ERSPAN mirrored traffic.
    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.
    Video string
    VLAN dedicated for video devices.
    Voice string
    VLAN dedicated for voice devices.
    defaultVlan String
    Default VLAN (native) assigned to all switch ports upon discovery.
    nac String
    VLAN for NAC onboarding devices.
    nacSegment String
    VLAN for NAC segemnt primary interface.
    quarantine String
    VLAN for quarantined traffic.
    rspan String
    VLAN for RSPAN/ERSPAN mirrored traffic.
    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.
    video String
    VLAN dedicated for video devices.
    voice String
    VLAN dedicated for voice devices.
    defaultVlan string
    Default VLAN (native) assigned to all switch ports upon discovery.
    nac string
    VLAN for NAC onboarding devices.
    nacSegment string
    VLAN for NAC segemnt primary interface.
    quarantine string
    VLAN for quarantined traffic.
    rspan string
    VLAN for RSPAN/ERSPAN mirrored traffic.
    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.
    video string
    VLAN dedicated for video devices.
    voice string
    VLAN dedicated for voice devices.
    default_vlan str
    Default VLAN (native) assigned to all switch ports upon discovery.
    nac str
    VLAN for NAC onboarding devices.
    nac_segment str
    VLAN for NAC segemnt primary interface.
    quarantine str
    VLAN for quarantined traffic.
    rspan str
    VLAN for RSPAN/ERSPAN mirrored traffic.
    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.
    video str
    VLAN dedicated for video devices.
    voice str
    VLAN dedicated for voice devices.
    defaultVlan String
    Default VLAN (native) assigned to all switch ports upon discovery.
    nac String
    VLAN for NAC onboarding devices.
    nacSegment String
    VLAN for NAC segemnt primary interface.
    quarantine String
    VLAN for quarantined traffic.
    rspan String
    VLAN for RSPAN/ERSPAN mirrored traffic.
    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.
    video String
    VLAN dedicated for video devices.
    voice String
    VLAN dedicated for voice devices.

    Outputs

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

    Get an existing Vlans 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?: VlansState, opts?: CustomResourceOptions): Vlans
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            default_vlan: Optional[str] = None,
            nac: Optional[str] = None,
            nac_segment: Optional[str] = None,
            quarantine: Optional[str] = None,
            rspan: Optional[str] = None,
            vdomparam: Optional[str] = None,
            video: Optional[str] = None,
            voice: Optional[str] = None) -> Vlans
    func GetVlans(ctx *Context, name string, id IDInput, state *VlansState, opts ...ResourceOption) (*Vlans, error)
    public static Vlans Get(string name, Input<string> id, VlansState? state, CustomResourceOptions? opts = null)
    public static Vlans get(String name, Output<String> id, VlansState 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:
    DefaultVlan string
    Default VLAN (native) assigned to all switch ports upon discovery.
    Nac string
    VLAN for NAC onboarding devices.
    NacSegment string
    VLAN for NAC segemnt primary interface.
    Quarantine string
    VLAN for quarantined traffic.
    Rspan string
    VLAN for RSPAN/ERSPAN mirrored traffic.
    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.
    Video string
    VLAN dedicated for video devices.
    Voice string
    VLAN dedicated for voice devices.
    DefaultVlan string
    Default VLAN (native) assigned to all switch ports upon discovery.
    Nac string
    VLAN for NAC onboarding devices.
    NacSegment string
    VLAN for NAC segemnt primary interface.
    Quarantine string
    VLAN for quarantined traffic.
    Rspan string
    VLAN for RSPAN/ERSPAN mirrored traffic.
    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.
    Video string
    VLAN dedicated for video devices.
    Voice string
    VLAN dedicated for voice devices.
    defaultVlan String
    Default VLAN (native) assigned to all switch ports upon discovery.
    nac String
    VLAN for NAC onboarding devices.
    nacSegment String
    VLAN for NAC segemnt primary interface.
    quarantine String
    VLAN for quarantined traffic.
    rspan String
    VLAN for RSPAN/ERSPAN mirrored traffic.
    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.
    video String
    VLAN dedicated for video devices.
    voice String
    VLAN dedicated for voice devices.
    defaultVlan string
    Default VLAN (native) assigned to all switch ports upon discovery.
    nac string
    VLAN for NAC onboarding devices.
    nacSegment string
    VLAN for NAC segemnt primary interface.
    quarantine string
    VLAN for quarantined traffic.
    rspan string
    VLAN for RSPAN/ERSPAN mirrored traffic.
    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.
    video string
    VLAN dedicated for video devices.
    voice string
    VLAN dedicated for voice devices.
    default_vlan str
    Default VLAN (native) assigned to all switch ports upon discovery.
    nac str
    VLAN for NAC onboarding devices.
    nac_segment str
    VLAN for NAC segemnt primary interface.
    quarantine str
    VLAN for quarantined traffic.
    rspan str
    VLAN for RSPAN/ERSPAN mirrored traffic.
    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.
    video str
    VLAN dedicated for video devices.
    voice str
    VLAN dedicated for voice devices.
    defaultVlan String
    Default VLAN (native) assigned to all switch ports upon discovery.
    nac String
    VLAN for NAC onboarding devices.
    nacSegment String
    VLAN for NAC segemnt primary interface.
    quarantine String
    VLAN for quarantined traffic.
    rspan String
    VLAN for RSPAN/ERSPAN mirrored traffic.
    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.
    video String
    VLAN dedicated for video devices.
    voice String
    VLAN dedicated for voice devices.

    Import

    SwitchControllerInitialConfig Vlans can be imported using any of these accepted formats:

    $ pulumi import fortios:switchcontroller/initialconfig/vlans:Vlans labelname SwitchControllerInitialConfigVlans
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:switchcontroller/initialconfig/vlans:Vlans labelname SwitchControllerInitialConfigVlans
    

    $ 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