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

fortios.system/replacemsg.Ftp

Explore with Pulumi AI

Replacement messages.

Create Ftp Resource

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

Constructor syntax

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

@overload
def Ftp(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 NewFtp(ctx *Context, name string, args FtpArgs, opts ...ResourceOption) (*Ftp, error)
public Ftp(string name, FtpArgs args, CustomResourceOptions? opts = null)
public Ftp(String name, FtpArgs args)
public Ftp(String name, FtpArgs args, CustomResourceOptions options)
type: fortios:system/replacemsg/ftp:Ftp
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 This property is required. FtpArgs
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 This property is required. FtpArgs
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 This property is required. FtpArgs
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 This property is required. FtpArgs
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. FtpArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

MsgType
This property is required.
Changes to this property will trigger replacement.
string
Message type.
Buffer string
Message string.
Format string
Format flag.
Header string
Header flag. Valid values: none, http, 8bit.
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.
MsgType
This property is required.
Changes to this property will trigger replacement.
string
Message type.
Buffer string
Message string.
Format string
Format flag.
Header string
Header flag. Valid values: none, http, 8bit.
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.
msgType
This property is required.
Changes to this property will trigger replacement.
String
Message type.
buffer String
Message string.
format String
Format flag.
header String
Header flag. Valid values: none, http, 8bit.
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.
msgType
This property is required.
Changes to this property will trigger replacement.
string
Message type.
buffer string
Message string.
format string
Format flag.
header string
Header flag. Valid values: none, http, 8bit.
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.
msg_type
This property is required.
Changes to this property will trigger replacement.
str
Message type.
buffer str
Message string.
format str
Format flag.
header str
Header flag. Valid values: none, http, 8bit.
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.
msgType
This property is required.
Changes to this property will trigger replacement.
String
Message type.
buffer String
Message string.
format String
Format flag.
header String
Header flag. Valid values: none, http, 8bit.
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 Ftp 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 Ftp Resource

Get an existing Ftp 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?: FtpState, opts?: CustomResourceOptions): Ftp
@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) -> Ftp
func GetFtp(ctx *Context, name string, id IDInput, state *FtpState, opts ...ResourceOption) (*Ftp, error)
public static Ftp Get(string name, Input<string> id, FtpState? state, CustomResourceOptions? opts = null)
public static Ftp get(String name, Output<String> id, FtpState state, CustomResourceOptions options)
resources:  _:    type: fortios:system/replacemsg/ftp:Ftp    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:
Buffer string
Message string.
Format string
Format flag.
Header string
Header flag. Valid values: none, http, 8bit.
MsgType Changes to this property will trigger replacement. string
Message type.
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.
Buffer string
Message string.
Format string
Format flag.
Header string
Header flag. Valid values: none, http, 8bit.
MsgType Changes to this property will trigger replacement. string
Message type.
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.
buffer String
Message string.
format String
Format flag.
header String
Header flag. Valid values: none, http, 8bit.
msgType Changes to this property will trigger replacement. String
Message type.
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.
buffer string
Message string.
format string
Format flag.
header string
Header flag. Valid values: none, http, 8bit.
msgType Changes to this property will trigger replacement. string
Message type.
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.
buffer str
Message string.
format str
Format flag.
header str
Header flag. Valid values: none, http, 8bit.
msg_type Changes to this property will trigger replacement. str
Message type.
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.
buffer String
Message string.
format String
Format flag.
header String
Header flag. Valid values: none, http, 8bit.
msgType Changes to this property will trigger replacement. String
Message type.
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.

Import

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

$ pulumi import fortios:system/replacemsg/ftp:Ftp labelname {{msg_type}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:system/replacemsg/ftp:Ftp labelname {{msg_type}}
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.