Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Fortimanager Provider
  4. API Docs
  5. SysBackup
Viewing docs for fortimanager 1.18.0
published on Friday, Jul 31, 2026 by fortinetdev
Schema (JSON)
fortinetdev/terraform-provider-fortimanager

fortimanager.SysBackup

Viewing docs for fortimanager 1.18.0
published on Friday, Jul 31, 2026 by fortinetdev
Schema (JSON)
fortinetdev/terraform-provider-fortimanager

    Import

    Sys Backup can be imported using any of these accepted formats:

    $ export “FORTIMANAGER_IMPORT_TABLE”=“true”

    $ pulumi import fortimanager:index/sysBackup:SysBackup labelname SysBackup

    $ unset “FORTIMANAGER_IMPORT_TABLE”

    Create SysBackup Resource

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

    Constructor syntax

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

@overload
def SysBackup(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              filename: Optional[str] = None,
              force_recreate: Optional[str] = None,
              passwd: Optional[str] = None,
              port: Optional[float] = None,
              server: Optional[str] = None,
              service: Optional[str] = None,
              sys_backup_id: Optional[str] = None,
              username: Optional[str] = None,
              userpasswds: Optional[Sequence[str]] = None)
    func NewSysBackup(ctx *Context, name string, args *SysBackupArgs, opts ...ResourceOption) (*SysBackup, error)
    public SysBackup(string name, SysBackupArgs? args = null, CustomResourceOptions? opts = null)
    public SysBackup(String name, SysBackupArgs args)
public SysBackup(String name, SysBackupArgs args, CustomResourceOptions options)

    type: fortimanager:SysBackup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "fortimanager_sys_backup" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args SysBackupArgs
    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 SysBackupArgs
    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 SysBackupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SysBackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SysBackupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var sysBackupResource = new Fortimanager.SysBackup("sysBackupResource", new()
{
    Filename = "string",
    ForceRecreate = "string",
    Passwd = "string",
    Port = 0,
    Server = "string",
    Service = "string",
    SysBackupId = "string",
    Username = "string",
    Userpasswds = new[]
    {
        "string",
    },
});

    example, err := fortimanager.NewSysBackup(ctx, "sysBackupResource", &fortimanager.SysBackupArgs{
	Filename:      pulumi.String("string"),
	ForceRecreate: pulumi.String("string"),
	Passwd:        pulumi.String("string"),
	Port:          pulumi.Float64(0),
	Server:        pulumi.String("string"),
	Service:       pulumi.String("string"),
	SysBackupId:   pulumi.String("string"),
	Username:      pulumi.String("string"),
	Userpasswds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    resource "fortimanager_sys_backup" "sysBackupResource" {
  lifecycle {
    create_before_destroy = true
  }
  filename       = "string"
  force_recreate = "string"
  passwd         = "string"
  port           = 0
  server         = "string"
  service        = "string"
  sys_backup_id  = "string"
  username       = "string"
  userpasswds    = ["string"]
}

    var sysBackupResource = new SysBackup("sysBackupResource", SysBackupArgs.builder()
    .filename("string")
    .forceRecreate("string")
    .passwd("string")
    .port(0.0)
    .server("string")
    .service("string")
    .sysBackupId("string")
    .username("string")
    .userpasswds("string")
    .build());

    sys_backup_resource = fortimanager.SysBackup("sysBackupResource",
    filename="string",
    force_recreate="string",
    passwd="string",
    port=float(0),
    server="string",
    service="string",
    sys_backup_id="string",
    username="string",
    userpasswds=["string"])

    const sysBackupResource = new fortimanager.SysBackup("sysBackupResource", {
    filename: "string",
    forceRecreate: "string",
    passwd: "string",
    port: 0,
    server: "string",
    service: "string",
    sysBackupId: "string",
    username: "string",
    userpasswds: ["string"],
});

    type: fortimanager:SysBackup
properties:
    filename: string
    forceRecreate: string
    passwd: string
    port: 0
    server: string
    service: string
    sysBackupId: string
    username: string
    userpasswds:
        - string

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

    Filename string
    Destination path and file name on remote server.
    ForceRecreate string
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    Passwd string
    Password for password-protected configuration backup file.
    Port double
    Remote server port. Default port is used if not specified.
    Server string
    Remote server address.
    Service string
    Protocol to backup configuration. Valid values: ftp, scp, sftp, tftp.
    SysBackupId string
    an identifier for the resource.
    Username string
    User name to log in to the remote server.
    Userpasswds List<string>
    Password to log in to the remote server.
    Filename string
    Destination path and file name on remote server.
    ForceRecreate string
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    Passwd string
    Password for password-protected configuration backup file.
    Port float64
    Remote server port. Default port is used if not specified.
    Server string
    Remote server address.
    Service string
    Protocol to backup configuration. Valid values: ftp, scp, sftp, tftp.
    SysBackupId string
    an identifier for the resource.
    Username string
    User name to log in to the remote server.
    Userpasswds []string
    Password to log in to the remote server.
    filename string
    Destination path and file name on remote server.
    force_recreate string
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    passwd string
    Password for password-protected configuration backup file.
    port number
    Remote server port. Default port is used if not specified.
    server string
    Remote server address.
    service string
    Protocol to backup configuration. Valid values: ftp, scp, sftp, tftp.
    sys_backup_id string
    an identifier for the resource.
    username string
    User name to log in to the remote server.
    userpasswds list(string)
    Password to log in to the remote server.
    filename String
    Destination path and file name on remote server.
    forceRecreate String
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    passwd String
    Password for password-protected configuration backup file.
    port Double
    Remote server port. Default port is used if not specified.
    server String
    Remote server address.
    service String
    Protocol to backup configuration. Valid values: ftp, scp, sftp, tftp.
    sysBackupId String
    an identifier for the resource.
    username String
    User name to log in to the remote server.
    userpasswds List<String>
    Password to log in to the remote server.
    filename string
    Destination path and file name on remote server.
    forceRecreate string
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    passwd string
    Password for password-protected configuration backup file.
    port number
    Remote server port. Default port is used if not specified.
    server string
    Remote server address.
    service string
    Protocol to backup configuration. Valid values: ftp, scp, sftp, tftp.
    sysBackupId string
    an identifier for the resource.
    username string
    User name to log in to the remote server.
    userpasswds string[]
    Password to log in to the remote server.
    filename str
    Destination path and file name on remote server.
    force_recreate str
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    passwd str
    Password for password-protected configuration backup file.
    port float
    Remote server port. Default port is used if not specified.
    server str
    Remote server address.
    service str
    Protocol to backup configuration. Valid values: ftp, scp, sftp, tftp.
    sys_backup_id str
    an identifier for the resource.
    username str
    User name to log in to the remote server.
    userpasswds Sequence[str]
    Password to log in to the remote server.
    filename String
    Destination path and file name on remote server.
    forceRecreate String
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    passwd String
    Password for password-protected configuration backup file.
    port Number
    Remote server port. Default port is used if not specified.
    server String
    Remote server address.
    service String
    Protocol to backup configuration. Valid values: ftp, scp, sftp, tftp.
    sysBackupId String
    an identifier for the resource.
    username String
    User name to log in to the remote server.
    userpasswds List<String>
    Password to log in to the remote server.

    Outputs

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

    Get an existing SysBackup 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?: SysBackupState, opts?: CustomResourceOptions): SysBackup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        filename: Optional[str] = None,
        force_recreate: Optional[str] = None,
        passwd: Optional[str] = None,
        port: Optional[float] = None,
        server: Optional[str] = None,
        service: Optional[str] = None,
        sys_backup_id: Optional[str] = None,
        username: Optional[str] = None,
        userpasswds: Optional[Sequence[str]] = None) -> SysBackup
    func GetSysBackup(ctx *Context, name string, id IDInput, state *SysBackupState, opts ...ResourceOption) (*SysBackup, error)
    public static SysBackup Get(string name, Input<string> id, SysBackupState? state, CustomResourceOptions? opts = null)
    public static SysBackup get(String name, Output<String> id, SysBackupState state, CustomResourceOptions options)
    resources:  _:    type: fortimanager:SysBackup    get:      id: ${id}
    import {
  to = fortimanager_sys_backup.example
  id = "${id}"
}
    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:
    Filename string
    Destination path and file name on remote server.
    ForceRecreate string
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    Passwd string
    Password for password-protected configuration backup file.
    Port double
    Remote server port. Default port is used if not specified.
    Server string
    Remote server address.
    Service string
    Protocol to backup configuration. Valid values: ftp, scp, sftp, tftp.
    SysBackupId string
    an identifier for the resource.
    Username string
    User name to log in to the remote server.
    Userpasswds List<string>
    Password to log in to the remote server.
    Filename string
    Destination path and file name on remote server.
    ForceRecreate string
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    Passwd string
    Password for password-protected configuration backup file.
    Port float64
    Remote server port. Default port is used if not specified.
    Server string
    Remote server address.
    Service string
    Protocol to backup configuration. Valid values: ftp, scp, sftp, tftp.
    SysBackupId string
    an identifier for the resource.
    Username string
    User name to log in to the remote server.
    Userpasswds []string
    Password to log in to the remote server.
    filename string
    Destination path and file name on remote server.
    force_recreate string
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    passwd string
    Password for password-protected configuration backup file.
    port number
    Remote server port. Default port is used if not specified.
    server string
    Remote server address.
    service string
    Protocol to backup configuration. Valid values: ftp, scp, sftp, tftp.
    sys_backup_id string
    an identifier for the resource.
    username string
    User name to log in to the remote server.
    userpasswds list(string)
    Password to log in to the remote server.
    filename String
    Destination path and file name on remote server.
    forceRecreate String
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    passwd String
    Password for password-protected configuration backup file.
    port Double
    Remote server port. Default port is used if not specified.
    server String
    Remote server address.
    service String
    Protocol to backup configuration. Valid values: ftp, scp, sftp, tftp.
    sysBackupId String
    an identifier for the resource.
    username String
    User name to log in to the remote server.
    userpasswds List<String>
    Password to log in to the remote server.
    filename string
    Destination path and file name on remote server.
    forceRecreate string
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    passwd string
    Password for password-protected configuration backup file.
    port number
    Remote server port. Default port is used if not specified.
    server string
    Remote server address.
    service string
    Protocol to backup configuration. Valid values: ftp, scp, sftp, tftp.
    sysBackupId string
    an identifier for the resource.
    username string
    User name to log in to the remote server.
    userpasswds string[]
    Password to log in to the remote server.
    filename str
    Destination path and file name on remote server.
    force_recreate str
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    passwd str
    Password for password-protected configuration backup file.
    port float
    Remote server port. Default port is used if not specified.
    server str
    Remote server address.
    service str
    Protocol to backup configuration. Valid values: ftp, scp, sftp, tftp.
    sys_backup_id str
    an identifier for the resource.
    username str
    User name to log in to the remote server.
    userpasswds Sequence[str]
    Password to log in to the remote server.
    filename String
    Destination path and file name on remote server.
    forceRecreate String
    The argument is optional, if it is set, when the value changes, the resource will be re-created.
    passwd String
    Password for password-protected configuration backup file.
    port Number
    Remote server port. Default port is used if not specified.
    server String
    Remote server address.
    service String
    Protocol to backup configuration. Valid values: ftp, scp, sftp, tftp.
    sysBackupId String
    an identifier for the resource.
    username String
    User name to log in to the remote server.
    userpasswds List<String>
    Password to log in to the remote server.

    Package Details

    Repository
    fortimanager fortinetdev/terraform-provider-fortimanager
    License
    Notes
    This Pulumi package is based on the fortimanager Terraform Provider.
    Viewing docs for fortimanager 1.18.0
    published on Friday, Jul 31, 2026 by fortinetdev
    Schema (JSON)
    fortinetdev/terraform-provider-fortimanager

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial