1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. Console
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

fortios.system.Console

Explore with Pulumi AI

fortios logo
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

    Configure console.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as fortios from "@pulumiverse/fortios";
    
    const trname = new fortios.system.Console("trname", {
        baudrate: "9600",
        login: "enable",
        mode: "line",
        output: "more",
    });
    
    import pulumi
    import pulumiverse_fortios as fortios
    
    trname = fortios.system.Console("trname",
        baudrate="9600",
        login="enable",
        mode="line",
        output="more")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/system"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := system.NewConsole(ctx, "trname", &system.ConsoleArgs{
    			Baudrate: pulumi.String("9600"),
    			Login:    pulumi.String("enable"),
    			Mode:     pulumi.String("line"),
    			Output:   pulumi.String("more"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Fortios = Pulumiverse.Fortios;
    
    return await Deployment.RunAsync(() => 
    {
        var trname = new Fortios.System.Console("trname", new()
        {
            Baudrate = "9600",
            Login = "enable",
            Mode = "line",
            Output = "more",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.fortios.system.Console;
    import com.pulumi.fortios.system.ConsoleArgs;
    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 Console("trname", ConsoleArgs.builder()        
                .baudrate("9600")
                .login("enable")
                .mode("line")
                .output("more")
                .build());
    
        }
    }
    
    resources:
      trname:
        type: fortios:system:Console
        properties:
          baudrate: '9600'
          login: enable
          mode: line
          output: more
    

    Create Console Resource

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

    Constructor syntax

    new Console(name: string, args?: ConsoleArgs, opts?: CustomResourceOptions);
    @overload
    def Console(resource_name: str,
                args: Optional[ConsoleArgs] = None,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Console(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                baudrate: Optional[str] = None,
                fortiexplorer: Optional[str] = None,
                login: Optional[str] = None,
                mode: Optional[str] = None,
                output: Optional[str] = None,
                vdomparam: Optional[str] = None)
    func NewConsole(ctx *Context, name string, args *ConsoleArgs, opts ...ResourceOption) (*Console, error)
    public Console(string name, ConsoleArgs? args = null, CustomResourceOptions? opts = null)
    public Console(String name, ConsoleArgs args)
    public Console(String name, ConsoleArgs args, CustomResourceOptions options)
    
    type: fortios:system:Console
    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 ConsoleArgs
    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 ConsoleArgs
    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 ConsoleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConsoleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConsoleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var consoleResource = new Fortios.System.Console("consoleResource", new()
    {
        Baudrate = "string",
        Fortiexplorer = "string",
        Login = "string",
        Mode = "string",
        Output = "string",
        Vdomparam = "string",
    });
    
    example, err := system.NewConsole(ctx, "consoleResource", &system.ConsoleArgs{
    	Baudrate:      pulumi.String("string"),
    	Fortiexplorer: pulumi.String("string"),
    	Login:         pulumi.String("string"),
    	Mode:          pulumi.String("string"),
    	Output:        pulumi.String("string"),
    	Vdomparam:     pulumi.String("string"),
    })
    
    var consoleResource = new Console("consoleResource", ConsoleArgs.builder()        
        .baudrate("string")
        .fortiexplorer("string")
        .login("string")
        .mode("string")
        .output("string")
        .vdomparam("string")
        .build());
    
    console_resource = fortios.system.Console("consoleResource",
        baudrate="string",
        fortiexplorer="string",
        login="string",
        mode="string",
        output="string",
        vdomparam="string")
    
    const consoleResource = new fortios.system.Console("consoleResource", {
        baudrate: "string",
        fortiexplorer: "string",
        login: "string",
        mode: "string",
        output: "string",
        vdomparam: "string",
    });
    
    type: fortios:system:Console
    properties:
        baudrate: string
        fortiexplorer: string
        login: string
        mode: string
        output: string
        vdomparam: string
    

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

    Baudrate string
    Console baud rate. Valid values: 9600, 19200, 38400, 57600, 115200.
    Fortiexplorer string
    Enable/disable access for FortiExplorer. Valid values: enable, disable.
    Login string
    Enable/disable serial console and FortiExplorer. Valid values: enable, disable.
    Mode string
    Console mode. Valid values: batch, line.
    Output string
    Console output mode. Valid values: standard, more.
    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.
    Baudrate string
    Console baud rate. Valid values: 9600, 19200, 38400, 57600, 115200.
    Fortiexplorer string
    Enable/disable access for FortiExplorer. Valid values: enable, disable.
    Login string
    Enable/disable serial console and FortiExplorer. Valid values: enable, disable.
    Mode string
    Console mode. Valid values: batch, line.
    Output string
    Console output mode. Valid values: standard, more.
    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.
    baudrate String
    Console baud rate. Valid values: 9600, 19200, 38400, 57600, 115200.
    fortiexplorer String
    Enable/disable access for FortiExplorer. Valid values: enable, disable.
    login String
    Enable/disable serial console and FortiExplorer. Valid values: enable, disable.
    mode String
    Console mode. Valid values: batch, line.
    output String
    Console output mode. Valid values: standard, more.
    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.
    baudrate string
    Console baud rate. Valid values: 9600, 19200, 38400, 57600, 115200.
    fortiexplorer string
    Enable/disable access for FortiExplorer. Valid values: enable, disable.
    login string
    Enable/disable serial console and FortiExplorer. Valid values: enable, disable.
    mode string
    Console mode. Valid values: batch, line.
    output string
    Console output mode. Valid values: standard, more.
    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.
    baudrate str
    Console baud rate. Valid values: 9600, 19200, 38400, 57600, 115200.
    fortiexplorer str
    Enable/disable access for FortiExplorer. Valid values: enable, disable.
    login str
    Enable/disable serial console and FortiExplorer. Valid values: enable, disable.
    mode str
    Console mode. Valid values: batch, line.
    output str
    Console output mode. Valid values: standard, more.
    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.
    baudrate String
    Console baud rate. Valid values: 9600, 19200, 38400, 57600, 115200.
    fortiexplorer String
    Enable/disable access for FortiExplorer. Valid values: enable, disable.
    login String
    Enable/disable serial console and FortiExplorer. Valid values: enable, disable.
    mode String
    Console mode. Valid values: batch, line.
    output String
    Console output mode. Valid values: standard, more.
    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 Console 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 Console Resource

    Get an existing Console 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?: ConsoleState, opts?: CustomResourceOptions): Console
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            baudrate: Optional[str] = None,
            fortiexplorer: Optional[str] = None,
            login: Optional[str] = None,
            mode: Optional[str] = None,
            output: Optional[str] = None,
            vdomparam: Optional[str] = None) -> Console
    func GetConsole(ctx *Context, name string, id IDInput, state *ConsoleState, opts ...ResourceOption) (*Console, error)
    public static Console Get(string name, Input<string> id, ConsoleState? state, CustomResourceOptions? opts = null)
    public static Console get(String name, Output<String> id, ConsoleState 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:
    Baudrate string
    Console baud rate. Valid values: 9600, 19200, 38400, 57600, 115200.
    Fortiexplorer string
    Enable/disable access for FortiExplorer. Valid values: enable, disable.
    Login string
    Enable/disable serial console and FortiExplorer. Valid values: enable, disable.
    Mode string
    Console mode. Valid values: batch, line.
    Output string
    Console output mode. Valid values: standard, more.
    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.
    Baudrate string
    Console baud rate. Valid values: 9600, 19200, 38400, 57600, 115200.
    Fortiexplorer string
    Enable/disable access for FortiExplorer. Valid values: enable, disable.
    Login string
    Enable/disable serial console and FortiExplorer. Valid values: enable, disable.
    Mode string
    Console mode. Valid values: batch, line.
    Output string
    Console output mode. Valid values: standard, more.
    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.
    baudrate String
    Console baud rate. Valid values: 9600, 19200, 38400, 57600, 115200.
    fortiexplorer String
    Enable/disable access for FortiExplorer. Valid values: enable, disable.
    login String
    Enable/disable serial console and FortiExplorer. Valid values: enable, disable.
    mode String
    Console mode. Valid values: batch, line.
    output String
    Console output mode. Valid values: standard, more.
    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.
    baudrate string
    Console baud rate. Valid values: 9600, 19200, 38400, 57600, 115200.
    fortiexplorer string
    Enable/disable access for FortiExplorer. Valid values: enable, disable.
    login string
    Enable/disable serial console and FortiExplorer. Valid values: enable, disable.
    mode string
    Console mode. Valid values: batch, line.
    output string
    Console output mode. Valid values: standard, more.
    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.
    baudrate str
    Console baud rate. Valid values: 9600, 19200, 38400, 57600, 115200.
    fortiexplorer str
    Enable/disable access for FortiExplorer. Valid values: enable, disable.
    login str
    Enable/disable serial console and FortiExplorer. Valid values: enable, disable.
    mode str
    Console mode. Valid values: batch, line.
    output str
    Console output mode. Valid values: standard, more.
    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.
    baudrate String
    Console baud rate. Valid values: 9600, 19200, 38400, 57600, 115200.
    fortiexplorer String
    Enable/disable access for FortiExplorer. Valid values: enable, disable.
    login String
    Enable/disable serial console and FortiExplorer. Valid values: enable, disable.
    mode String
    Console mode. Valid values: batch, line.
    output String
    Console output mode. Valid values: standard, more.
    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

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

    $ pulumi import fortios:system/console:Console labelname SystemConsole
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/console:Console labelname SystemConsole
    

    $ 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.5 published on Tuesday, Apr 9, 2024 by pulumiverse