1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. system/replacemsg
  6. Auth
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.system/replacemsg.Auth

Explore with Pulumi AI

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

    Replacement messages.

    Create Auth Resource

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

    Constructor syntax

    new Auth(name: string, args: AuthArgs, opts?: CustomResourceOptions);
    @overload
    def Auth(resource_name: str,
             args: AuthArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Auth(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             msg_type: Optional[str] = None,
             buffer: Optional[str] = None,
             format: Optional[str] = None,
             header: Optional[str] = None,
             vdomparam: Optional[str] = None)
    func NewAuth(ctx *Context, name string, args AuthArgs, opts ...ResourceOption) (*Auth, error)
    public Auth(string name, AuthArgs args, CustomResourceOptions? opts = null)
    public Auth(String name, AuthArgs args)
    public Auth(String name, AuthArgs args, CustomResourceOptions options)
    
    type: fortios:system/replacemsg/auth:Auth
    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 AuthArgs
    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 AuthArgs
    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 AuthArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    MsgType string
    Message type.
    Buffer string
    Message string.
    Format string
    Format flag.
    Header string
    Header flag. Valid values: none, http, 8bit.
    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.
    MsgType string
    Message type.
    Buffer string
    Message string.
    Format string
    Format flag.
    Header string
    Header flag. Valid values: none, http, 8bit.
    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.
    msgType String
    Message type.
    buffer String
    Message string.
    format String
    Format flag.
    header String
    Header flag. Valid values: none, http, 8bit.
    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.
    msgType string
    Message type.
    buffer string
    Message string.
    format string
    Format flag.
    header string
    Header flag. Valid values: none, http, 8bit.
    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.
    msg_type str
    Message type.
    buffer str
    Message string.
    format str
    Format flag.
    header str
    Header flag. Valid values: none, http, 8bit.
    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.
    msgType String
    Message type.
    buffer String
    Message string.
    format String
    Format flag.
    header String
    Header flag. Valid values: none, http, 8bit.
    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 Auth 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 Auth Resource

    Get an existing Auth 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?: AuthState, opts?: CustomResourceOptions): Auth
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            buffer: Optional[str] = None,
            format: Optional[str] = None,
            header: Optional[str] = None,
            msg_type: Optional[str] = None,
            vdomparam: Optional[str] = None) -> Auth
    func GetAuth(ctx *Context, name string, id IDInput, state *AuthState, opts ...ResourceOption) (*Auth, error)
    public static Auth Get(string name, Input<string> id, AuthState? state, CustomResourceOptions? opts = null)
    public static Auth get(String name, Output<String> id, AuthState 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:
    Buffer string
    Message string.
    Format string
    Format flag.
    Header string
    Header flag. Valid values: none, http, 8bit.
    MsgType string
    Message type.
    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.
    Buffer string
    Message string.
    Format string
    Format flag.
    Header string
    Header flag. Valid values: none, http, 8bit.
    MsgType string
    Message type.
    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.
    buffer String
    Message string.
    format String
    Format flag.
    header String
    Header flag. Valid values: none, http, 8bit.
    msgType String
    Message type.
    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.
    buffer string
    Message string.
    format string
    Format flag.
    header string
    Header flag. Valid values: none, http, 8bit.
    msgType string
    Message type.
    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.
    buffer str
    Message string.
    format str
    Format flag.
    header str
    Header flag. Valid values: none, http, 8bit.
    msg_type str
    Message type.
    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.
    buffer String
    Message string.
    format String
    Format flag.
    header String
    Header flag. Valid values: none, http, 8bit.
    msgType String
    Message type.
    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

    SystemReplacemsg Auth can be imported using any of these accepted formats:

    $ pulumi import fortios:system/replacemsg/auth:Auth labelname {{msg_type}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/replacemsg/auth:Auth labelname {{msg_type}}
    

    $ 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