1. Packages
  2. Fortios
  3. API Docs
  4. switchcontroller
  5. Switchprofile
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.switchcontroller.Switchprofile

Explore with Pulumi AI

Configure FortiSwitch switch profile.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as fortios from "@pulumiverse/fortios";

const trname = new fortios.switchcontroller.Switchprofile("trname", {loginPasswdOverride: "enable"});
Copy
import pulumi
import pulumiverse_fortios as fortios

trname = fortios.switchcontroller.Switchprofile("trname", login_passwd_override="enable")
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/switchcontroller"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := switchcontroller.NewSwitchprofile(ctx, "trname", &switchcontroller.SwitchprofileArgs{
			LoginPasswdOverride: pulumi.String("enable"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.Switchcontroller.Switchprofile("trname", new()
    {
        LoginPasswdOverride = "enable",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.switchcontroller.Switchprofile;
import com.pulumi.fortios.switchcontroller.SwitchprofileArgs;
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 Switchprofile("trname", SwitchprofileArgs.builder()
            .loginPasswdOverride("enable")
            .build());

    }
}
Copy
resources:
  trname:
    type: fortios:switchcontroller:Switchprofile
    properties:
      loginPasswdOverride: enable
Copy

Create Switchprofile Resource

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

Constructor syntax

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

@overload
def Switchprofile(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  login: Optional[str] = None,
                  login_passwd: Optional[str] = None,
                  login_passwd_override: Optional[str] = None,
                  name: Optional[str] = None,
                  revision_backup_on_logout: Optional[str] = None,
                  revision_backup_on_upgrade: Optional[str] = None,
                  vdomparam: Optional[str] = None)
func NewSwitchprofile(ctx *Context, name string, args *SwitchprofileArgs, opts ...ResourceOption) (*Switchprofile, error)
public Switchprofile(string name, SwitchprofileArgs? args = null, CustomResourceOptions? opts = null)
public Switchprofile(String name, SwitchprofileArgs args)
public Switchprofile(String name, SwitchprofileArgs args, CustomResourceOptions options)
type: fortios:switchcontroller:Switchprofile
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 SwitchprofileArgs
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 SwitchprofileArgs
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 SwitchprofileArgs
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 SwitchprofileArgs
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. SwitchprofileArgs
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 switchprofileResource = new Fortios.Switchcontroller.Switchprofile("switchprofileResource", new()
{
    Login = "string",
    LoginPasswd = "string",
    LoginPasswdOverride = "string",
    Name = "string",
    RevisionBackupOnLogout = "string",
    RevisionBackupOnUpgrade = "string",
    Vdomparam = "string",
});
Copy
example, err := switchcontroller.NewSwitchprofile(ctx, "switchprofileResource", &switchcontroller.SwitchprofileArgs{
	Login:                   pulumi.String("string"),
	LoginPasswd:             pulumi.String("string"),
	LoginPasswdOverride:     pulumi.String("string"),
	Name:                    pulumi.String("string"),
	RevisionBackupOnLogout:  pulumi.String("string"),
	RevisionBackupOnUpgrade: pulumi.String("string"),
	Vdomparam:               pulumi.String("string"),
})
Copy
var switchprofileResource = new Switchprofile("switchprofileResource", SwitchprofileArgs.builder()
    .login("string")
    .loginPasswd("string")
    .loginPasswdOverride("string")
    .name("string")
    .revisionBackupOnLogout("string")
    .revisionBackupOnUpgrade("string")
    .vdomparam("string")
    .build());
Copy
switchprofile_resource = fortios.switchcontroller.Switchprofile("switchprofileResource",
    login="string",
    login_passwd="string",
    login_passwd_override="string",
    name="string",
    revision_backup_on_logout="string",
    revision_backup_on_upgrade="string",
    vdomparam="string")
Copy
const switchprofileResource = new fortios.switchcontroller.Switchprofile("switchprofileResource", {
    login: "string",
    loginPasswd: "string",
    loginPasswdOverride: "string",
    name: "string",
    revisionBackupOnLogout: "string",
    revisionBackupOnUpgrade: "string",
    vdomparam: "string",
});
Copy
type: fortios:switchcontroller:Switchprofile
properties:
    login: string
    loginPasswd: string
    loginPasswdOverride: string
    name: string
    revisionBackupOnLogout: string
    revisionBackupOnUpgrade: string
    vdomparam: string
Copy

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

Login string
Enable/disable FortiSwitch serial console. Valid values: enable, disable.
LoginPasswd string
Login password of managed FortiSwitch.
LoginPasswdOverride string
Enable/disable overriding the admin administrator password for a managed FortiSwitch with the FortiGate admin administrator account password. Valid values: enable, disable.
Name Changes to this property will trigger replacement. string
FortiSwitch Profile name.
RevisionBackupOnLogout string
Enable/disable automatic revision backup upon logout from FortiSwitch. Valid values: enable, disable.
RevisionBackupOnUpgrade string
Enable/disable automatic revision backup upon FortiSwitch image upgrade. Valid values: enable, disable.
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.
Login string
Enable/disable FortiSwitch serial console. Valid values: enable, disable.
LoginPasswd string
Login password of managed FortiSwitch.
LoginPasswdOverride string
Enable/disable overriding the admin administrator password for a managed FortiSwitch with the FortiGate admin administrator account password. Valid values: enable, disable.
Name Changes to this property will trigger replacement. string
FortiSwitch Profile name.
RevisionBackupOnLogout string
Enable/disable automatic revision backup upon logout from FortiSwitch. Valid values: enable, disable.
RevisionBackupOnUpgrade string
Enable/disable automatic revision backup upon FortiSwitch image upgrade. Valid values: enable, disable.
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.
login String
Enable/disable FortiSwitch serial console. Valid values: enable, disable.
loginPasswd String
Login password of managed FortiSwitch.
loginPasswdOverride String
Enable/disable overriding the admin administrator password for a managed FortiSwitch with the FortiGate admin administrator account password. Valid values: enable, disable.
name Changes to this property will trigger replacement. String
FortiSwitch Profile name.
revisionBackupOnLogout String
Enable/disable automatic revision backup upon logout from FortiSwitch. Valid values: enable, disable.
revisionBackupOnUpgrade String
Enable/disable automatic revision backup upon FortiSwitch image upgrade. Valid values: enable, disable.
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.
login string
Enable/disable FortiSwitch serial console. Valid values: enable, disable.
loginPasswd string
Login password of managed FortiSwitch.
loginPasswdOverride string
Enable/disable overriding the admin administrator password for a managed FortiSwitch with the FortiGate admin administrator account password. Valid values: enable, disable.
name Changes to this property will trigger replacement. string
FortiSwitch Profile name.
revisionBackupOnLogout string
Enable/disable automatic revision backup upon logout from FortiSwitch. Valid values: enable, disable.
revisionBackupOnUpgrade string
Enable/disable automatic revision backup upon FortiSwitch image upgrade. Valid values: enable, disable.
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.
login str
Enable/disable FortiSwitch serial console. Valid values: enable, disable.
login_passwd str
Login password of managed FortiSwitch.
login_passwd_override str
Enable/disable overriding the admin administrator password for a managed FortiSwitch with the FortiGate admin administrator account password. Valid values: enable, disable.
name Changes to this property will trigger replacement. str
FortiSwitch Profile name.
revision_backup_on_logout str
Enable/disable automatic revision backup upon logout from FortiSwitch. Valid values: enable, disable.
revision_backup_on_upgrade str
Enable/disable automatic revision backup upon FortiSwitch image upgrade. Valid values: enable, disable.
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.
login String
Enable/disable FortiSwitch serial console. Valid values: enable, disable.
loginPasswd String
Login password of managed FortiSwitch.
loginPasswdOverride String
Enable/disable overriding the admin administrator password for a managed FortiSwitch with the FortiGate admin administrator account password. Valid values: enable, disable.
name Changes to this property will trigger replacement. String
FortiSwitch Profile name.
revisionBackupOnLogout String
Enable/disable automatic revision backup upon logout from FortiSwitch. Valid values: enable, disable.
revisionBackupOnUpgrade String
Enable/disable automatic revision backup upon FortiSwitch image upgrade. Valid values: enable, disable.
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 Switchprofile 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 Switchprofile Resource

Get an existing Switchprofile 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?: SwitchprofileState, opts?: CustomResourceOptions): Switchprofile
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        login: Optional[str] = None,
        login_passwd: Optional[str] = None,
        login_passwd_override: Optional[str] = None,
        name: Optional[str] = None,
        revision_backup_on_logout: Optional[str] = None,
        revision_backup_on_upgrade: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Switchprofile
func GetSwitchprofile(ctx *Context, name string, id IDInput, state *SwitchprofileState, opts ...ResourceOption) (*Switchprofile, error)
public static Switchprofile Get(string name, Input<string> id, SwitchprofileState? state, CustomResourceOptions? opts = null)
public static Switchprofile get(String name, Output<String> id, SwitchprofileState state, CustomResourceOptions options)
resources:  _:    type: fortios:switchcontroller:Switchprofile    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:
Login string
Enable/disable FortiSwitch serial console. Valid values: enable, disable.
LoginPasswd string
Login password of managed FortiSwitch.
LoginPasswdOverride string
Enable/disable overriding the admin administrator password for a managed FortiSwitch with the FortiGate admin administrator account password. Valid values: enable, disable.
Name Changes to this property will trigger replacement. string
FortiSwitch Profile name.
RevisionBackupOnLogout string
Enable/disable automatic revision backup upon logout from FortiSwitch. Valid values: enable, disable.
RevisionBackupOnUpgrade string
Enable/disable automatic revision backup upon FortiSwitch image upgrade. Valid values: enable, disable.
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.
Login string
Enable/disable FortiSwitch serial console. Valid values: enable, disable.
LoginPasswd string
Login password of managed FortiSwitch.
LoginPasswdOverride string
Enable/disable overriding the admin administrator password for a managed FortiSwitch with the FortiGate admin administrator account password. Valid values: enable, disable.
Name Changes to this property will trigger replacement. string
FortiSwitch Profile name.
RevisionBackupOnLogout string
Enable/disable automatic revision backup upon logout from FortiSwitch. Valid values: enable, disable.
RevisionBackupOnUpgrade string
Enable/disable automatic revision backup upon FortiSwitch image upgrade. Valid values: enable, disable.
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.
login String
Enable/disable FortiSwitch serial console. Valid values: enable, disable.
loginPasswd String
Login password of managed FortiSwitch.
loginPasswdOverride String
Enable/disable overriding the admin administrator password for a managed FortiSwitch with the FortiGate admin administrator account password. Valid values: enable, disable.
name Changes to this property will trigger replacement. String
FortiSwitch Profile name.
revisionBackupOnLogout String
Enable/disable automatic revision backup upon logout from FortiSwitch. Valid values: enable, disable.
revisionBackupOnUpgrade String
Enable/disable automatic revision backup upon FortiSwitch image upgrade. Valid values: enable, disable.
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.
login string
Enable/disable FortiSwitch serial console. Valid values: enable, disable.
loginPasswd string
Login password of managed FortiSwitch.
loginPasswdOverride string
Enable/disable overriding the admin administrator password for a managed FortiSwitch with the FortiGate admin administrator account password. Valid values: enable, disable.
name Changes to this property will trigger replacement. string
FortiSwitch Profile name.
revisionBackupOnLogout string
Enable/disable automatic revision backup upon logout from FortiSwitch. Valid values: enable, disable.
revisionBackupOnUpgrade string
Enable/disable automatic revision backup upon FortiSwitch image upgrade. Valid values: enable, disable.
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.
login str
Enable/disable FortiSwitch serial console. Valid values: enable, disable.
login_passwd str
Login password of managed FortiSwitch.
login_passwd_override str
Enable/disable overriding the admin administrator password for a managed FortiSwitch with the FortiGate admin administrator account password. Valid values: enable, disable.
name Changes to this property will trigger replacement. str
FortiSwitch Profile name.
revision_backup_on_logout str
Enable/disable automatic revision backup upon logout from FortiSwitch. Valid values: enable, disable.
revision_backup_on_upgrade str
Enable/disable automatic revision backup upon FortiSwitch image upgrade. Valid values: enable, disable.
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.
login String
Enable/disable FortiSwitch serial console. Valid values: enable, disable.
loginPasswd String
Login password of managed FortiSwitch.
loginPasswdOverride String
Enable/disable overriding the admin administrator password for a managed FortiSwitch with the FortiGate admin administrator account password. Valid values: enable, disable.
name Changes to this property will trigger replacement. String
FortiSwitch Profile name.
revisionBackupOnLogout String
Enable/disable automatic revision backup upon logout from FortiSwitch. Valid values: enable, disable.
revisionBackupOnUpgrade String
Enable/disable automatic revision backup upon FortiSwitch image upgrade. Valid values: enable, disable.
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

SwitchController SwitchProfile can be imported using any of these accepted formats:

$ pulumi import fortios:switchcontroller/switchprofile:Switchprofile labelname {{name}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:switchcontroller/switchprofile:Switchprofile labelname {{name}}
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.