1. Packages
  2. Fortios
  3. API Docs
  4. switchcontroller
  5. switchcontroller/acl
  6. Ingress
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.switchcontroller/acl.Ingress

Explore with Pulumi AI

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

    Configure ingress ACL policies to be applied on managed FortiSwitch ports. Applies to FortiOS Version >= 7.4.0.

    Create Ingress Resource

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

    Constructor syntax

    new Ingress(name: string, args?: IngressArgs, opts?: CustomResourceOptions);
    @overload
    def Ingress(resource_name: str,
                args: Optional[IngressArgs] = None,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Ingress(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                action: Optional[IngressActionArgs] = None,
                classifier: Optional[IngressClassifierArgs] = None,
                description: Optional[str] = None,
                fosid: Optional[int] = None,
                get_all_tables: Optional[str] = None,
                vdomparam: Optional[str] = None)
    func NewIngress(ctx *Context, name string, args *IngressArgs, opts ...ResourceOption) (*Ingress, error)
    public Ingress(string name, IngressArgs? args = null, CustomResourceOptions? opts = null)
    public Ingress(String name, IngressArgs args)
    public Ingress(String name, IngressArgs args, CustomResourceOptions options)
    
    type: fortios:switchcontroller/acl/ingress:Ingress
    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 IngressArgs
    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 IngressArgs
    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 IngressArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IngressArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IngressArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Action Pulumiverse.Fortios.Switchcontroller.Acl.Inputs.IngressAction
    ACL actions. The structure of action block is documented below.
    Classifier Pulumiverse.Fortios.Switchcontroller.Acl.Inputs.IngressClassifier
    ACL classifiers. The structure of classifier block is documented below.
    Description string
    Description for the ACL policy.
    Fosid int
    ACL 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.
    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.
    Action IngressActionArgs
    ACL actions. The structure of action block is documented below.
    Classifier IngressClassifierArgs
    ACL classifiers. The structure of classifier block is documented below.
    Description string
    Description for the ACL policy.
    Fosid int
    ACL 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.
    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.
    action IngressAction
    ACL actions. The structure of action block is documented below.
    classifier IngressClassifier
    ACL classifiers. The structure of classifier block is documented below.
    description String
    Description for the ACL policy.
    fosid Integer
    ACL 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.
    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.
    action IngressAction
    ACL actions. The structure of action block is documented below.
    classifier IngressClassifier
    ACL classifiers. The structure of classifier block is documented below.
    description string
    Description for the ACL policy.
    fosid number
    ACL 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.
    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.
    action IngressActionArgs
    ACL actions. The structure of action block is documented below.
    classifier IngressClassifierArgs
    ACL classifiers. The structure of classifier block is documented below.
    description str
    Description for the ACL policy.
    fosid int
    ACL 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.
    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.
    action Property Map
    ACL actions. The structure of action block is documented below.
    classifier Property Map
    ACL classifiers. The structure of classifier block is documented below.
    description String
    Description for the ACL policy.
    fosid Number
    ACL 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.
    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 Ingress 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 Ingress Resource

    Get an existing Ingress 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?: IngressState, opts?: CustomResourceOptions): Ingress
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            action: Optional[IngressActionArgs] = None,
            classifier: Optional[IngressClassifierArgs] = None,
            description: Optional[str] = None,
            fosid: Optional[int] = None,
            get_all_tables: Optional[str] = None,
            vdomparam: Optional[str] = None) -> Ingress
    func GetIngress(ctx *Context, name string, id IDInput, state *IngressState, opts ...ResourceOption) (*Ingress, error)
    public static Ingress Get(string name, Input<string> id, IngressState? state, CustomResourceOptions? opts = null)
    public static Ingress get(String name, Output<String> id, IngressState 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:
    Action Pulumiverse.Fortios.Switchcontroller.Acl.Inputs.IngressAction
    ACL actions. The structure of action block is documented below.
    Classifier Pulumiverse.Fortios.Switchcontroller.Acl.Inputs.IngressClassifier
    ACL classifiers. The structure of classifier block is documented below.
    Description string
    Description for the ACL policy.
    Fosid int
    ACL 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.
    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.
    Action IngressActionArgs
    ACL actions. The structure of action block is documented below.
    Classifier IngressClassifierArgs
    ACL classifiers. The structure of classifier block is documented below.
    Description string
    Description for the ACL policy.
    Fosid int
    ACL 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.
    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.
    action IngressAction
    ACL actions. The structure of action block is documented below.
    classifier IngressClassifier
    ACL classifiers. The structure of classifier block is documented below.
    description String
    Description for the ACL policy.
    fosid Integer
    ACL 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.
    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.
    action IngressAction
    ACL actions. The structure of action block is documented below.
    classifier IngressClassifier
    ACL classifiers. The structure of classifier block is documented below.
    description string
    Description for the ACL policy.
    fosid number
    ACL 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.
    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.
    action IngressActionArgs
    ACL actions. The structure of action block is documented below.
    classifier IngressClassifierArgs
    ACL classifiers. The structure of classifier block is documented below.
    description str
    Description for the ACL policy.
    fosid int
    ACL 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.
    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.
    action Property Map
    ACL actions. The structure of action block is documented below.
    classifier Property Map
    ACL classifiers. The structure of classifier block is documented below.
    description String
    Description for the ACL policy.
    fosid Number
    ACL 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.
    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

    IngressAction, IngressActionArgs

    Count string
    Enable/disable count. Valid values: enable, disable.
    Drop string
    Enable/disable drop. Valid values: enable, disable.
    Count string
    Enable/disable count. Valid values: enable, disable.
    Drop string
    Enable/disable drop. Valid values: enable, disable.
    count String
    Enable/disable count. Valid values: enable, disable.
    drop String
    Enable/disable drop. Valid values: enable, disable.
    count string
    Enable/disable count. Valid values: enable, disable.
    drop string
    Enable/disable drop. Valid values: enable, disable.
    count str
    Enable/disable count. Valid values: enable, disable.
    drop str
    Enable/disable drop. Valid values: enable, disable.
    count String
    Enable/disable count. Valid values: enable, disable.
    drop String
    Enable/disable drop. Valid values: enable, disable.

    IngressClassifier, IngressClassifierArgs

    DstIpPrefix string
    Destination IP address to be matched.
    DstMac string
    Destination MAC address to be matched.
    SrcIpPrefix string
    Source IP address to be matched.
    SrcMac string
    Source MAC address to be matched.
    Vlan int
    VLAN ID to be matched.
    DstIpPrefix string
    Destination IP address to be matched.
    DstMac string
    Destination MAC address to be matched.
    SrcIpPrefix string
    Source IP address to be matched.
    SrcMac string
    Source MAC address to be matched.
    Vlan int
    VLAN ID to be matched.
    dstIpPrefix String
    Destination IP address to be matched.
    dstMac String
    Destination MAC address to be matched.
    srcIpPrefix String
    Source IP address to be matched.
    srcMac String
    Source MAC address to be matched.
    vlan Integer
    VLAN ID to be matched.
    dstIpPrefix string
    Destination IP address to be matched.
    dstMac string
    Destination MAC address to be matched.
    srcIpPrefix string
    Source IP address to be matched.
    srcMac string
    Source MAC address to be matched.
    vlan number
    VLAN ID to be matched.
    dst_ip_prefix str
    Destination IP address to be matched.
    dst_mac str
    Destination MAC address to be matched.
    src_ip_prefix str
    Source IP address to be matched.
    src_mac str
    Source MAC address to be matched.
    vlan int
    VLAN ID to be matched.
    dstIpPrefix String
    Destination IP address to be matched.
    dstMac String
    Destination MAC address to be matched.
    srcIpPrefix String
    Source IP address to be matched.
    srcMac String
    Source MAC address to be matched.
    vlan Number
    VLAN ID to be matched.

    Import

    SwitchControllerAcl Ingress can be imported using any of these accepted formats:

    $ pulumi import fortios:switchcontroller/acl/ingress:Ingress labelname {{fosid}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:switchcontroller/acl/ingress:Ingress labelname {{fosid}}
    

    $ 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