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

fortios.ips.Custom

Explore with Pulumi AI

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

    Configure IPS custom signature.

    Create Custom Resource

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

    Constructor syntax

    new Custom(name: string, args?: CustomArgs, opts?: CustomResourceOptions);
    @overload
    def Custom(resource_name: str,
               args: Optional[CustomArgs] = None,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Custom(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               action: Optional[str] = None,
               application: Optional[str] = None,
               comment: Optional[str] = None,
               location: Optional[str] = None,
               log: Optional[str] = None,
               log_packet: Optional[str] = None,
               os: Optional[str] = None,
               protocol: Optional[str] = None,
               rule_id: Optional[int] = None,
               severity: Optional[str] = None,
               sig_name: Optional[str] = None,
               signature: Optional[str] = None,
               status: Optional[str] = None,
               tag: Optional[str] = None,
               vdomparam: Optional[str] = None)
    func NewCustom(ctx *Context, name string, args *CustomArgs, opts ...ResourceOption) (*Custom, error)
    public Custom(string name, CustomArgs? args = null, CustomResourceOptions? opts = null)
    public Custom(String name, CustomArgs args)
    public Custom(String name, CustomArgs args, CustomResourceOptions options)
    
    type: fortios:ips:Custom
    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 CustomArgs
    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 CustomArgs
    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 CustomArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomArgs
    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 examplecustomResourceResourceFromIpscustom = new Fortios.Ips.Custom("examplecustomResourceResourceFromIpscustom", new()
    {
        Action = "string",
        Application = "string",
        Comment = "string",
        Location = "string",
        Log = "string",
        LogPacket = "string",
        Os = "string",
        Protocol = "string",
        RuleId = 0,
        Severity = "string",
        SigName = "string",
        Signature = "string",
        Status = "string",
        Tag = "string",
        Vdomparam = "string",
    });
    
    example, err := ips.NewCustom(ctx, "examplecustomResourceResourceFromIpscustom", &ips.CustomArgs{
    	Action:      pulumi.String("string"),
    	Application: pulumi.String("string"),
    	Comment:     pulumi.String("string"),
    	Location:    pulumi.String("string"),
    	Log:         pulumi.String("string"),
    	LogPacket:   pulumi.String("string"),
    	Os:          pulumi.String("string"),
    	Protocol:    pulumi.String("string"),
    	RuleId:      pulumi.Int(0),
    	Severity:    pulumi.String("string"),
    	SigName:     pulumi.String("string"),
    	Signature:   pulumi.String("string"),
    	Status:      pulumi.String("string"),
    	Tag:         pulumi.String("string"),
    	Vdomparam:   pulumi.String("string"),
    })
    
    var examplecustomResourceResourceFromIpscustom = new Custom("examplecustomResourceResourceFromIpscustom", CustomArgs.builder()        
        .action("string")
        .application("string")
        .comment("string")
        .location("string")
        .log("string")
        .logPacket("string")
        .os("string")
        .protocol("string")
        .ruleId(0)
        .severity("string")
        .sigName("string")
        .signature("string")
        .status("string")
        .tag("string")
        .vdomparam("string")
        .build());
    
    examplecustom_resource_resource_from_ipscustom = fortios.ips.Custom("examplecustomResourceResourceFromIpscustom",
        action="string",
        application="string",
        comment="string",
        location="string",
        log="string",
        log_packet="string",
        os="string",
        protocol="string",
        rule_id=0,
        severity="string",
        sig_name="string",
        signature="string",
        status="string",
        tag="string",
        vdomparam="string")
    
    const examplecustomResourceResourceFromIpscustom = new fortios.ips.Custom("examplecustomResourceResourceFromIpscustom", {
        action: "string",
        application: "string",
        comment: "string",
        location: "string",
        log: "string",
        logPacket: "string",
        os: "string",
        protocol: "string",
        ruleId: 0,
        severity: "string",
        sigName: "string",
        signature: "string",
        status: "string",
        tag: "string",
        vdomparam: "string",
    });
    
    type: fortios:ips:Custom
    properties:
        action: string
        application: string
        comment: string
        location: string
        log: string
        logPacket: string
        os: string
        protocol: string
        ruleId: 0
        severity: string
        sigName: string
        signature: string
        status: string
        tag: string
        vdomparam: string
    

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

    Action string
    Default action (pass or block) for this signature. Valid values: pass, block.
    Application string
    Applications to be protected. Blank for all applications.
    Comment string
    Comment.
    Location string
    Protect client or server traffic.
    Log string
    Enable/disable logging. Valid values: disable, enable.
    LogPacket string
    Enable/disable packet logging. Valid values: disable, enable.
    Os string
    Operating system(s) that the signature protects. Blank for all operating systems.
    Protocol string
    Protocol(s) that the signature scans. Blank for all protocols.
    RuleId int
    Signature ID.
    Severity string
    Relative severity of the signature, from info to critical. Log messages generated by the signature include the severity.
    SigName string
    Signature name.
    Signature string
    Custom signature enclosed in single quotes.
    Status string
    Enable/disable this signature. Valid values: disable, enable.
    Tag string
    Signature tag.
    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 string
    Default action (pass or block) for this signature. Valid values: pass, block.
    Application string
    Applications to be protected. Blank for all applications.
    Comment string
    Comment.
    Location string
    Protect client or server traffic.
    Log string
    Enable/disable logging. Valid values: disable, enable.
    LogPacket string
    Enable/disable packet logging. Valid values: disable, enable.
    Os string
    Operating system(s) that the signature protects. Blank for all operating systems.
    Protocol string
    Protocol(s) that the signature scans. Blank for all protocols.
    RuleId int
    Signature ID.
    Severity string
    Relative severity of the signature, from info to critical. Log messages generated by the signature include the severity.
    SigName string
    Signature name.
    Signature string
    Custom signature enclosed in single quotes.
    Status string
    Enable/disable this signature. Valid values: disable, enable.
    Tag string
    Signature tag.
    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 String
    Default action (pass or block) for this signature. Valid values: pass, block.
    application String
    Applications to be protected. Blank for all applications.
    comment String
    Comment.
    location String
    Protect client or server traffic.
    log String
    Enable/disable logging. Valid values: disable, enable.
    logPacket String
    Enable/disable packet logging. Valid values: disable, enable.
    os String
    Operating system(s) that the signature protects. Blank for all operating systems.
    protocol String
    Protocol(s) that the signature scans. Blank for all protocols.
    ruleId Integer
    Signature ID.
    severity String
    Relative severity of the signature, from info to critical. Log messages generated by the signature include the severity.
    sigName String
    Signature name.
    signature String
    Custom signature enclosed in single quotes.
    status String
    Enable/disable this signature. Valid values: disable, enable.
    tag String
    Signature tag.
    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 string
    Default action (pass or block) for this signature. Valid values: pass, block.
    application string
    Applications to be protected. Blank for all applications.
    comment string
    Comment.
    location string
    Protect client or server traffic.
    log string
    Enable/disable logging. Valid values: disable, enable.
    logPacket string
    Enable/disable packet logging. Valid values: disable, enable.
    os string
    Operating system(s) that the signature protects. Blank for all operating systems.
    protocol string
    Protocol(s) that the signature scans. Blank for all protocols.
    ruleId number
    Signature ID.
    severity string
    Relative severity of the signature, from info to critical. Log messages generated by the signature include the severity.
    sigName string
    Signature name.
    signature string
    Custom signature enclosed in single quotes.
    status string
    Enable/disable this signature. Valid values: disable, enable.
    tag string
    Signature tag.
    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 str
    Default action (pass or block) for this signature. Valid values: pass, block.
    application str
    Applications to be protected. Blank for all applications.
    comment str
    Comment.
    location str
    Protect client or server traffic.
    log str
    Enable/disable logging. Valid values: disable, enable.
    log_packet str
    Enable/disable packet logging. Valid values: disable, enable.
    os str
    Operating system(s) that the signature protects. Blank for all operating systems.
    protocol str
    Protocol(s) that the signature scans. Blank for all protocols.
    rule_id int
    Signature ID.
    severity str
    Relative severity of the signature, from info to critical. Log messages generated by the signature include the severity.
    sig_name str
    Signature name.
    signature str
    Custom signature enclosed in single quotes.
    status str
    Enable/disable this signature. Valid values: disable, enable.
    tag str
    Signature tag.
    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 String
    Default action (pass or block) for this signature. Valid values: pass, block.
    application String
    Applications to be protected. Blank for all applications.
    comment String
    Comment.
    location String
    Protect client or server traffic.
    log String
    Enable/disable logging. Valid values: disable, enable.
    logPacket String
    Enable/disable packet logging. Valid values: disable, enable.
    os String
    Operating system(s) that the signature protects. Blank for all operating systems.
    protocol String
    Protocol(s) that the signature scans. Blank for all protocols.
    ruleId Number
    Signature ID.
    severity String
    Relative severity of the signature, from info to critical. Log messages generated by the signature include the severity.
    sigName String
    Signature name.
    signature String
    Custom signature enclosed in single quotes.
    status String
    Enable/disable this signature. Valid values: disable, enable.
    tag String
    Signature tag.
    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 Custom 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 Custom Resource

    Get an existing Custom 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?: CustomState, opts?: CustomResourceOptions): Custom
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            action: Optional[str] = None,
            application: Optional[str] = None,
            comment: Optional[str] = None,
            location: Optional[str] = None,
            log: Optional[str] = None,
            log_packet: Optional[str] = None,
            os: Optional[str] = None,
            protocol: Optional[str] = None,
            rule_id: Optional[int] = None,
            severity: Optional[str] = None,
            sig_name: Optional[str] = None,
            signature: Optional[str] = None,
            status: Optional[str] = None,
            tag: Optional[str] = None,
            vdomparam: Optional[str] = None) -> Custom
    func GetCustom(ctx *Context, name string, id IDInput, state *CustomState, opts ...ResourceOption) (*Custom, error)
    public static Custom Get(string name, Input<string> id, CustomState? state, CustomResourceOptions? opts = null)
    public static Custom get(String name, Output<String> id, CustomState 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 string
    Default action (pass or block) for this signature. Valid values: pass, block.
    Application string
    Applications to be protected. Blank for all applications.
    Comment string
    Comment.
    Location string
    Protect client or server traffic.
    Log string
    Enable/disable logging. Valid values: disable, enable.
    LogPacket string
    Enable/disable packet logging. Valid values: disable, enable.
    Os string
    Operating system(s) that the signature protects. Blank for all operating systems.
    Protocol string
    Protocol(s) that the signature scans. Blank for all protocols.
    RuleId int
    Signature ID.
    Severity string
    Relative severity of the signature, from info to critical. Log messages generated by the signature include the severity.
    SigName string
    Signature name.
    Signature string
    Custom signature enclosed in single quotes.
    Status string
    Enable/disable this signature. Valid values: disable, enable.
    Tag string
    Signature tag.
    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 string
    Default action (pass or block) for this signature. Valid values: pass, block.
    Application string
    Applications to be protected. Blank for all applications.
    Comment string
    Comment.
    Location string
    Protect client or server traffic.
    Log string
    Enable/disable logging. Valid values: disable, enable.
    LogPacket string
    Enable/disable packet logging. Valid values: disable, enable.
    Os string
    Operating system(s) that the signature protects. Blank for all operating systems.
    Protocol string
    Protocol(s) that the signature scans. Blank for all protocols.
    RuleId int
    Signature ID.
    Severity string
    Relative severity of the signature, from info to critical. Log messages generated by the signature include the severity.
    SigName string
    Signature name.
    Signature string
    Custom signature enclosed in single quotes.
    Status string
    Enable/disable this signature. Valid values: disable, enable.
    Tag string
    Signature tag.
    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 String
    Default action (pass or block) for this signature. Valid values: pass, block.
    application String
    Applications to be protected. Blank for all applications.
    comment String
    Comment.
    location String
    Protect client or server traffic.
    log String
    Enable/disable logging. Valid values: disable, enable.
    logPacket String
    Enable/disable packet logging. Valid values: disable, enable.
    os String
    Operating system(s) that the signature protects. Blank for all operating systems.
    protocol String
    Protocol(s) that the signature scans. Blank for all protocols.
    ruleId Integer
    Signature ID.
    severity String
    Relative severity of the signature, from info to critical. Log messages generated by the signature include the severity.
    sigName String
    Signature name.
    signature String
    Custom signature enclosed in single quotes.
    status String
    Enable/disable this signature. Valid values: disable, enable.
    tag String
    Signature tag.
    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 string
    Default action (pass or block) for this signature. Valid values: pass, block.
    application string
    Applications to be protected. Blank for all applications.
    comment string
    Comment.
    location string
    Protect client or server traffic.
    log string
    Enable/disable logging. Valid values: disable, enable.
    logPacket string
    Enable/disable packet logging. Valid values: disable, enable.
    os string
    Operating system(s) that the signature protects. Blank for all operating systems.
    protocol string
    Protocol(s) that the signature scans. Blank for all protocols.
    ruleId number
    Signature ID.
    severity string
    Relative severity of the signature, from info to critical. Log messages generated by the signature include the severity.
    sigName string
    Signature name.
    signature string
    Custom signature enclosed in single quotes.
    status string
    Enable/disable this signature. Valid values: disable, enable.
    tag string
    Signature tag.
    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 str
    Default action (pass or block) for this signature. Valid values: pass, block.
    application str
    Applications to be protected. Blank for all applications.
    comment str
    Comment.
    location str
    Protect client or server traffic.
    log str
    Enable/disable logging. Valid values: disable, enable.
    log_packet str
    Enable/disable packet logging. Valid values: disable, enable.
    os str
    Operating system(s) that the signature protects. Blank for all operating systems.
    protocol str
    Protocol(s) that the signature scans. Blank for all protocols.
    rule_id int
    Signature ID.
    severity str
    Relative severity of the signature, from info to critical. Log messages generated by the signature include the severity.
    sig_name str
    Signature name.
    signature str
    Custom signature enclosed in single quotes.
    status str
    Enable/disable this signature. Valid values: disable, enable.
    tag str
    Signature tag.
    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 String
    Default action (pass or block) for this signature. Valid values: pass, block.
    application String
    Applications to be protected. Blank for all applications.
    comment String
    Comment.
    location String
    Protect client or server traffic.
    log String
    Enable/disable logging. Valid values: disable, enable.
    logPacket String
    Enable/disable packet logging. Valid values: disable, enable.
    os String
    Operating system(s) that the signature protects. Blank for all operating systems.
    protocol String
    Protocol(s) that the signature scans. Blank for all protocols.
    ruleId Number
    Signature ID.
    severity String
    Relative severity of the signature, from info to critical. Log messages generated by the signature include the severity.
    sigName String
    Signature name.
    signature String
    Custom signature enclosed in single quotes.
    status String
    Enable/disable this signature. Valid values: disable, enable.
    tag String
    Signature tag.
    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

    Ips Custom can be imported using any of these accepted formats:

    $ pulumi import fortios:ips/custom:Custom labelname {{tag}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:ips/custom:Custom labelname {{tag}}
    

    $ 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