1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. SystemBackupAllsettings
fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev

fortimanager.SystemBackupAllsettings

Explore with Pulumi AI

Scheduled backup settings.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as fortimanager from "@pulumi/fortimanager";

const trname = new fortimanager.SystemBackupAllsettings("trname", {
    crptpasswds: ["fortinet"],
    directory: "terraform",
    passwds: ["fortinet"],
    protocol: "ftp",
    server: "192.168.1.1",
    status: "enable",
    time: "1:00:00",
    user: "admin",
    weekDays: ["monday"],
});
Copy
import pulumi
import pulumi_fortimanager as fortimanager

trname = fortimanager.SystemBackupAllsettings("trname",
    crptpasswds=["fortinet"],
    directory="terraform",
    passwds=["fortinet"],
    protocol="ftp",
    server="192.168.1.1",
    status="enable",
    time="1:00:00",
    user="admin",
    week_days=["monday"])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fortimanager/fortimanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fortimanager.NewSystemBackupAllsettings(ctx, "trname", &fortimanager.SystemBackupAllsettingsArgs{
			Crptpasswds: pulumi.StringArray{
				pulumi.String("fortinet"),
			},
			Directory: pulumi.String("terraform"),
			Passwds: pulumi.StringArray{
				pulumi.String("fortinet"),
			},
			Protocol: pulumi.String("ftp"),
			Server:   pulumi.String("192.168.1.1"),
			Status:   pulumi.String("enable"),
			Time:     pulumi.String("1:00:00"),
			User:     pulumi.String("admin"),
			WeekDays: pulumi.StringArray{
				pulumi.String("monday"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortimanager = Pulumi.Fortimanager;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortimanager.SystemBackupAllsettings("trname", new()
    {
        Crptpasswds = new[]
        {
            "fortinet",
        },
        Directory = "terraform",
        Passwds = new[]
        {
            "fortinet",
        },
        Protocol = "ftp",
        Server = "192.168.1.1",
        Status = "enable",
        Time = "1:00:00",
        User = "admin",
        WeekDays = new[]
        {
            "monday",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortimanager.SystemBackupAllsettings;
import com.pulumi.fortimanager.SystemBackupAllsettingsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var trname = new SystemBackupAllsettings("trname", SystemBackupAllsettingsArgs.builder()
            .crptpasswds("fortinet")
            .directory("terraform")
            .passwds("fortinet")
            .protocol("ftp")
            .server("192.168.1.1")
            .status("enable")
            .time("1:00:00")
            .user("admin")
            .weekDays("monday")
            .build());

    }
}
Copy
resources:
  trname:
    type: fortimanager:SystemBackupAllsettings
    properties:
      crptpasswds:
        - fortinet
      directory: terraform
      passwds:
        - fortinet
      protocol: ftp
      server: 192.168.1.1
      status: enable
      time: 1:00:00
      user: admin
      weekDays:
        - monday
Copy

Create SystemBackupAllsettings Resource

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

Constructor syntax

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

@overload
def SystemBackupAllsettings(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            cert: Optional[str] = None,
                            crptpasswds: Optional[Sequence[str]] = None,
                            directory: Optional[str] = None,
                            passwds: Optional[Sequence[str]] = None,
                            protocol: Optional[str] = None,
                            server: Optional[str] = None,
                            status: Optional[str] = None,
                            system_backup_allsettings_id: Optional[str] = None,
                            time: Optional[str] = None,
                            user: Optional[str] = None,
                            week_days: Optional[Sequence[str]] = None)
func NewSystemBackupAllsettings(ctx *Context, name string, args *SystemBackupAllsettingsArgs, opts ...ResourceOption) (*SystemBackupAllsettings, error)
public SystemBackupAllsettings(string name, SystemBackupAllsettingsArgs? args = null, CustomResourceOptions? opts = null)
public SystemBackupAllsettings(String name, SystemBackupAllsettingsArgs args)
public SystemBackupAllsettings(String name, SystemBackupAllsettingsArgs args, CustomResourceOptions options)
type: fortimanager:SystemBackupAllsettings
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 SystemBackupAllsettingsArgs
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 SystemBackupAllsettingsArgs
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 SystemBackupAllsettingsArgs
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 SystemBackupAllsettingsArgs
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. SystemBackupAllsettingsArgs
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 systemBackupAllsettingsResource = new Fortimanager.SystemBackupAllsettings("systemBackupAllsettingsResource", new()
{
    Cert = "string",
    Crptpasswds = new[]
    {
        "string",
    },
    Directory = "string",
    Passwds = new[]
    {
        "string",
    },
    Protocol = "string",
    Server = "string",
    Status = "string",
    SystemBackupAllsettingsId = "string",
    Time = "string",
    User = "string",
    WeekDays = new[]
    {
        "string",
    },
});
Copy
example, err := fortimanager.NewSystemBackupAllsettings(ctx, "systemBackupAllsettingsResource", &fortimanager.SystemBackupAllsettingsArgs{
	Cert: pulumi.String("string"),
	Crptpasswds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Directory: pulumi.String("string"),
	Passwds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Protocol:                  pulumi.String("string"),
	Server:                    pulumi.String("string"),
	Status:                    pulumi.String("string"),
	SystemBackupAllsettingsId: pulumi.String("string"),
	Time:                      pulumi.String("string"),
	User:                      pulumi.String("string"),
	WeekDays: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var systemBackupAllsettingsResource = new SystemBackupAllsettings("systemBackupAllsettingsResource", SystemBackupAllsettingsArgs.builder()
    .cert("string")
    .crptpasswds("string")
    .directory("string")
    .passwds("string")
    .protocol("string")
    .server("string")
    .status("string")
    .systemBackupAllsettingsId("string")
    .time("string")
    .user("string")
    .weekDays("string")
    .build());
Copy
system_backup_allsettings_resource = fortimanager.SystemBackupAllsettings("systemBackupAllsettingsResource",
    cert="string",
    crptpasswds=["string"],
    directory="string",
    passwds=["string"],
    protocol="string",
    server="string",
    status="string",
    system_backup_allsettings_id="string",
    time="string",
    user="string",
    week_days=["string"])
Copy
const systemBackupAllsettingsResource = new fortimanager.SystemBackupAllsettings("systemBackupAllsettingsResource", {
    cert: "string",
    crptpasswds: ["string"],
    directory: "string",
    passwds: ["string"],
    protocol: "string",
    server: "string",
    status: "string",
    systemBackupAllsettingsId: "string",
    time: "string",
    user: "string",
    weekDays: ["string"],
});
Copy
type: fortimanager:SystemBackupAllsettings
properties:
    cert: string
    crptpasswds:
        - string
    directory: string
    passwds:
        - string
    protocol: string
    server: string
    status: string
    systemBackupAllsettingsId: string
    time: string
    user: string
    weekDays:
        - string
Copy

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

Cert string
SSH certificate for authentication.
Crptpasswds List<string>
Optional password to protect backup content.
Directory string
Directory in which file will be stored on backup server.
Passwds List<string>
Backup server login user password.
Protocol string
Protocol used to backup. sftp - SFTP. ftp - FTP. scp - SCP. Valid values: sftp, ftp, scp.
Server string
Backup server name/IP and port.
Status string
Enable/disable schedule backup. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
SystemBackupAllsettingsId string
an identifier for the resource.
Time string
Time to backup.
User string
Backup server login user.
WeekDays List<string>
Week days to backup. monday - Monday. tuesday - Tuesday. wednesday - Wednesday. thursday - Thursday. friday - Friday. saturday - Saturday. sunday - Sunday. Valid values: monday, tuesday, wednesday, thursday, friday, saturday, sunday.
Cert string
SSH certificate for authentication.
Crptpasswds []string
Optional password to protect backup content.
Directory string
Directory in which file will be stored on backup server.
Passwds []string
Backup server login user password.
Protocol string
Protocol used to backup. sftp - SFTP. ftp - FTP. scp - SCP. Valid values: sftp, ftp, scp.
Server string
Backup server name/IP and port.
Status string
Enable/disable schedule backup. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
SystemBackupAllsettingsId string
an identifier for the resource.
Time string
Time to backup.
User string
Backup server login user.
WeekDays []string
Week days to backup. monday - Monday. tuesday - Tuesday. wednesday - Wednesday. thursday - Thursday. friday - Friday. saturday - Saturday. sunday - Sunday. Valid values: monday, tuesday, wednesday, thursday, friday, saturday, sunday.
cert String
SSH certificate for authentication.
crptpasswds List<String>
Optional password to protect backup content.
directory String
Directory in which file will be stored on backup server.
passwds List<String>
Backup server login user password.
protocol String
Protocol used to backup. sftp - SFTP. ftp - FTP. scp - SCP. Valid values: sftp, ftp, scp.
server String
Backup server name/IP and port.
status String
Enable/disable schedule backup. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
systemBackupAllsettingsId String
an identifier for the resource.
time String
Time to backup.
user String
Backup server login user.
weekDays List<String>
Week days to backup. monday - Monday. tuesday - Tuesday. wednesday - Wednesday. thursday - Thursday. friday - Friday. saturday - Saturday. sunday - Sunday. Valid values: monday, tuesday, wednesday, thursday, friday, saturday, sunday.
cert string
SSH certificate for authentication.
crptpasswds string[]
Optional password to protect backup content.
directory string
Directory in which file will be stored on backup server.
passwds string[]
Backup server login user password.
protocol string
Protocol used to backup. sftp - SFTP. ftp - FTP. scp - SCP. Valid values: sftp, ftp, scp.
server string
Backup server name/IP and port.
status string
Enable/disable schedule backup. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
systemBackupAllsettingsId string
an identifier for the resource.
time string
Time to backup.
user string
Backup server login user.
weekDays string[]
Week days to backup. monday - Monday. tuesday - Tuesday. wednesday - Wednesday. thursday - Thursday. friday - Friday. saturday - Saturday. sunday - Sunday. Valid values: monday, tuesday, wednesday, thursday, friday, saturday, sunday.
cert str
SSH certificate for authentication.
crptpasswds Sequence[str]
Optional password to protect backup content.
directory str
Directory in which file will be stored on backup server.
passwds Sequence[str]
Backup server login user password.
protocol str
Protocol used to backup. sftp - SFTP. ftp - FTP. scp - SCP. Valid values: sftp, ftp, scp.
server str
Backup server name/IP and port.
status str
Enable/disable schedule backup. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
system_backup_allsettings_id str
an identifier for the resource.
time str
Time to backup.
user str
Backup server login user.
week_days Sequence[str]
Week days to backup. monday - Monday. tuesday - Tuesday. wednesday - Wednesday. thursday - Thursday. friday - Friday. saturday - Saturday. sunday - Sunday. Valid values: monday, tuesday, wednesday, thursday, friday, saturday, sunday.
cert String
SSH certificate for authentication.
crptpasswds List<String>
Optional password to protect backup content.
directory String
Directory in which file will be stored on backup server.
passwds List<String>
Backup server login user password.
protocol String
Protocol used to backup. sftp - SFTP. ftp - FTP. scp - SCP. Valid values: sftp, ftp, scp.
server String
Backup server name/IP and port.
status String
Enable/disable schedule backup. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
systemBackupAllsettingsId String
an identifier for the resource.
time String
Time to backup.
user String
Backup server login user.
weekDays List<String>
Week days to backup. monday - Monday. tuesday - Tuesday. wednesday - Wednesday. thursday - Thursday. friday - Friday. saturday - Saturday. sunday - Sunday. Valid values: monday, tuesday, wednesday, thursday, friday, saturday, sunday.

Outputs

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

Get an existing SystemBackupAllsettings 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?: SystemBackupAllsettingsState, opts?: CustomResourceOptions): SystemBackupAllsettings
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cert: Optional[str] = None,
        crptpasswds: Optional[Sequence[str]] = None,
        directory: Optional[str] = None,
        passwds: Optional[Sequence[str]] = None,
        protocol: Optional[str] = None,
        server: Optional[str] = None,
        status: Optional[str] = None,
        system_backup_allsettings_id: Optional[str] = None,
        time: Optional[str] = None,
        user: Optional[str] = None,
        week_days: Optional[Sequence[str]] = None) -> SystemBackupAllsettings
func GetSystemBackupAllsettings(ctx *Context, name string, id IDInput, state *SystemBackupAllsettingsState, opts ...ResourceOption) (*SystemBackupAllsettings, error)
public static SystemBackupAllsettings Get(string name, Input<string> id, SystemBackupAllsettingsState? state, CustomResourceOptions? opts = null)
public static SystemBackupAllsettings get(String name, Output<String> id, SystemBackupAllsettingsState state, CustomResourceOptions options)
resources:  _:    type: fortimanager:SystemBackupAllsettings    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:
Cert string
SSH certificate for authentication.
Crptpasswds List<string>
Optional password to protect backup content.
Directory string
Directory in which file will be stored on backup server.
Passwds List<string>
Backup server login user password.
Protocol string
Protocol used to backup. sftp - SFTP. ftp - FTP. scp - SCP. Valid values: sftp, ftp, scp.
Server string
Backup server name/IP and port.
Status string
Enable/disable schedule backup. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
SystemBackupAllsettingsId string
an identifier for the resource.
Time string
Time to backup.
User string
Backup server login user.
WeekDays List<string>
Week days to backup. monday - Monday. tuesday - Tuesday. wednesday - Wednesday. thursday - Thursday. friday - Friday. saturday - Saturday. sunday - Sunday. Valid values: monday, tuesday, wednesday, thursday, friday, saturday, sunday.
Cert string
SSH certificate for authentication.
Crptpasswds []string
Optional password to protect backup content.
Directory string
Directory in which file will be stored on backup server.
Passwds []string
Backup server login user password.
Protocol string
Protocol used to backup. sftp - SFTP. ftp - FTP. scp - SCP. Valid values: sftp, ftp, scp.
Server string
Backup server name/IP and port.
Status string
Enable/disable schedule backup. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
SystemBackupAllsettingsId string
an identifier for the resource.
Time string
Time to backup.
User string
Backup server login user.
WeekDays []string
Week days to backup. monday - Monday. tuesday - Tuesday. wednesday - Wednesday. thursday - Thursday. friday - Friday. saturday - Saturday. sunday - Sunday. Valid values: monday, tuesday, wednesday, thursday, friday, saturday, sunday.
cert String
SSH certificate for authentication.
crptpasswds List<String>
Optional password to protect backup content.
directory String
Directory in which file will be stored on backup server.
passwds List<String>
Backup server login user password.
protocol String
Protocol used to backup. sftp - SFTP. ftp - FTP. scp - SCP. Valid values: sftp, ftp, scp.
server String
Backup server name/IP and port.
status String
Enable/disable schedule backup. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
systemBackupAllsettingsId String
an identifier for the resource.
time String
Time to backup.
user String
Backup server login user.
weekDays List<String>
Week days to backup. monday - Monday. tuesday - Tuesday. wednesday - Wednesday. thursday - Thursday. friday - Friday. saturday - Saturday. sunday - Sunday. Valid values: monday, tuesday, wednesday, thursday, friday, saturday, sunday.
cert string
SSH certificate for authentication.
crptpasswds string[]
Optional password to protect backup content.
directory string
Directory in which file will be stored on backup server.
passwds string[]
Backup server login user password.
protocol string
Protocol used to backup. sftp - SFTP. ftp - FTP. scp - SCP. Valid values: sftp, ftp, scp.
server string
Backup server name/IP and port.
status string
Enable/disable schedule backup. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
systemBackupAllsettingsId string
an identifier for the resource.
time string
Time to backup.
user string
Backup server login user.
weekDays string[]
Week days to backup. monday - Monday. tuesday - Tuesday. wednesday - Wednesday. thursday - Thursday. friday - Friday. saturday - Saturday. sunday - Sunday. Valid values: monday, tuesday, wednesday, thursday, friday, saturday, sunday.
cert str
SSH certificate for authentication.
crptpasswds Sequence[str]
Optional password to protect backup content.
directory str
Directory in which file will be stored on backup server.
passwds Sequence[str]
Backup server login user password.
protocol str
Protocol used to backup. sftp - SFTP. ftp - FTP. scp - SCP. Valid values: sftp, ftp, scp.
server str
Backup server name/IP and port.
status str
Enable/disable schedule backup. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
system_backup_allsettings_id str
an identifier for the resource.
time str
Time to backup.
user str
Backup server login user.
week_days Sequence[str]
Week days to backup. monday - Monday. tuesday - Tuesday. wednesday - Wednesday. thursday - Thursday. friday - Friday. saturday - Saturday. sunday - Sunday. Valid values: monday, tuesday, wednesday, thursday, friday, saturday, sunday.
cert String
SSH certificate for authentication.
crptpasswds List<String>
Optional password to protect backup content.
directory String
Directory in which file will be stored on backup server.
passwds List<String>
Backup server login user password.
protocol String
Protocol used to backup. sftp - SFTP. ftp - FTP. scp - SCP. Valid values: sftp, ftp, scp.
server String
Backup server name/IP and port.
status String
Enable/disable schedule backup. disable - Disable setting. enable - Enable setting. Valid values: disable, enable.
systemBackupAllsettingsId String
an identifier for the resource.
time String
Time to backup.
user String
Backup server login user.
weekDays List<String>
Week days to backup. monday - Monday. tuesday - Tuesday. wednesday - Wednesday. thursday - Thursday. friday - Friday. saturday - Saturday. sunday - Sunday. Valid values: monday, tuesday, wednesday, thursday, friday, saturday, sunday.

Import

System BackupAllSettings can be imported using any of these accepted formats:

$ export “FORTIMANAGER_IMPORT_TABLE”=“true”

$ pulumi import fortimanager:index/systemBackupAllsettings:SystemBackupAllsettings labelname SystemBackupAllSettings
Copy

$ unset “FORTIMANAGER_IMPORT_TABLE”

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
fortimanager fortinetdev/terraform-provider-fortimanager
License
Notes
This Pulumi package is based on the fortimanager Terraform Provider.