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

fortios.switchcontroller.Customcommand

Explore with Pulumi AI

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

    Configure the FortiGate switch controller to send custom commands to managed FortiSwitch devices.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as fortios from "@pulumiverse/fortios";
    
    const trname = new fortios.switchcontroller.Customcommand("trname", {
        command: "ls",
        commandName: "1",
    });
    
    import pulumi
    import pulumiverse_fortios as fortios
    
    trname = fortios.switchcontroller.Customcommand("trname",
        command="ls",
        command_name="1")
    
    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.NewCustomcommand(ctx, "trname", &switchcontroller.CustomcommandArgs{
    			Command:     pulumi.String("ls"),
    			CommandName: pulumi.String("1"),
    		})
    		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.Switchcontroller.Customcommand("trname", new()
        {
            Command = "ls",
            CommandName = "1",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.fortios.switchcontroller.Customcommand;
    import com.pulumi.fortios.switchcontroller.CustomcommandArgs;
    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 Customcommand("trname", CustomcommandArgs.builder()        
                .command("ls")
                .commandName("1")
                .build());
    
        }
    }
    
    resources:
      trname:
        type: fortios:switchcontroller:Customcommand
        properties:
          command: ls
          commandName: '1'
    

    Create Customcommand Resource

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

    Constructor syntax

    new Customcommand(name: string, args: CustomcommandArgs, opts?: CustomResourceOptions);
    @overload
    def Customcommand(resource_name: str,
                      args: CustomcommandArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def Customcommand(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      command: Optional[str] = None,
                      command_name: Optional[str] = None,
                      description: Optional[str] = None,
                      vdomparam: Optional[str] = None)
    func NewCustomcommand(ctx *Context, name string, args CustomcommandArgs, opts ...ResourceOption) (*Customcommand, error)
    public Customcommand(string name, CustomcommandArgs args, CustomResourceOptions? opts = null)
    public Customcommand(String name, CustomcommandArgs args)
    public Customcommand(String name, CustomcommandArgs args, CustomResourceOptions options)
    
    type: fortios:switchcontroller:Customcommand
    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 CustomcommandArgs
    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 CustomcommandArgs
    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 CustomcommandArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomcommandArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomcommandArgs
    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 customcommandResource = new Fortios.Switchcontroller.Customcommand("customcommandResource", new()
    {
        Command = "string",
        CommandName = "string",
        Description = "string",
        Vdomparam = "string",
    });
    
    example, err := switchcontroller.NewCustomcommand(ctx, "customcommandResource", &switchcontroller.CustomcommandArgs{
    	Command:     pulumi.String("string"),
    	CommandName: pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Vdomparam:   pulumi.String("string"),
    })
    
    var customcommandResource = new Customcommand("customcommandResource", CustomcommandArgs.builder()        
        .command("string")
        .commandName("string")
        .description("string")
        .vdomparam("string")
        .build());
    
    customcommand_resource = fortios.switchcontroller.Customcommand("customcommandResource",
        command="string",
        command_name="string",
        description="string",
        vdomparam="string")
    
    const customcommandResource = new fortios.switchcontroller.Customcommand("customcommandResource", {
        command: "string",
        commandName: "string",
        description: "string",
        vdomparam: "string",
    });
    
    type: fortios:switchcontroller:Customcommand
    properties:
        command: string
        commandName: string
        description: string
        vdomparam: string
    

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

    Command string
    String of commands to send to FortiSwitch devices (For example (%!a(MISSING) = return key): config switch trunk %!a(MISSING) edit myTrunk %!a(MISSING) set members port1 port2 %!a(MISSING) end %!a(MISSING)).
    CommandName string
    Command name called by the FortiGate switch controller in the execute command.
    Description string
    Description.
    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.
    Command string
    String of commands to send to FortiSwitch devices (For example (%!a(MISSING) = return key): config switch trunk %!a(MISSING) edit myTrunk %!a(MISSING) set members port1 port2 %!a(MISSING) end %!a(MISSING)).
    CommandName string
    Command name called by the FortiGate switch controller in the execute command.
    Description string
    Description.
    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.
    command String
    String of commands to send to FortiSwitch devices (For example (%!a(MISSING) = return key): config switch trunk %!a(MISSING) edit myTrunk %!a(MISSING) set members port1 port2 %!a(MISSING) end %!a(MISSING)).
    commandName String
    Command name called by the FortiGate switch controller in the execute command.
    description String
    Description.
    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.
    command string
    String of commands to send to FortiSwitch devices (For example (%!a(MISSING) = return key): config switch trunk %!a(MISSING) edit myTrunk %!a(MISSING) set members port1 port2 %!a(MISSING) end %!a(MISSING)).
    commandName string
    Command name called by the FortiGate switch controller in the execute command.
    description string
    Description.
    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.
    command str
    String of commands to send to FortiSwitch devices (For example (%!a(MISSING) = return key): config switch trunk %!a(MISSING) edit myTrunk %!a(MISSING) set members port1 port2 %!a(MISSING) end %!a(MISSING)).
    command_name str
    Command name called by the FortiGate switch controller in the execute command.
    description str
    Description.
    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.
    command String
    String of commands to send to FortiSwitch devices (For example (%!a(MISSING) = return key): config switch trunk %!a(MISSING) edit myTrunk %!a(MISSING) set members port1 port2 %!a(MISSING) end %!a(MISSING)).
    commandName String
    Command name called by the FortiGate switch controller in the execute command.
    description String
    Description.
    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 Customcommand 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 Customcommand Resource

    Get an existing Customcommand 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?: CustomcommandState, opts?: CustomResourceOptions): Customcommand
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            command: Optional[str] = None,
            command_name: Optional[str] = None,
            description: Optional[str] = None,
            vdomparam: Optional[str] = None) -> Customcommand
    func GetCustomcommand(ctx *Context, name string, id IDInput, state *CustomcommandState, opts ...ResourceOption) (*Customcommand, error)
    public static Customcommand Get(string name, Input<string> id, CustomcommandState? state, CustomResourceOptions? opts = null)
    public static Customcommand get(String name, Output<String> id, CustomcommandState 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:
    Command string
    String of commands to send to FortiSwitch devices (For example (%!a(MISSING) = return key): config switch trunk %!a(MISSING) edit myTrunk %!a(MISSING) set members port1 port2 %!a(MISSING) end %!a(MISSING)).
    CommandName string
    Command name called by the FortiGate switch controller in the execute command.
    Description string
    Description.
    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.
    Command string
    String of commands to send to FortiSwitch devices (For example (%!a(MISSING) = return key): config switch trunk %!a(MISSING) edit myTrunk %!a(MISSING) set members port1 port2 %!a(MISSING) end %!a(MISSING)).
    CommandName string
    Command name called by the FortiGate switch controller in the execute command.
    Description string
    Description.
    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.
    command String
    String of commands to send to FortiSwitch devices (For example (%!a(MISSING) = return key): config switch trunk %!a(MISSING) edit myTrunk %!a(MISSING) set members port1 port2 %!a(MISSING) end %!a(MISSING)).
    commandName String
    Command name called by the FortiGate switch controller in the execute command.
    description String
    Description.
    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.
    command string
    String of commands to send to FortiSwitch devices (For example (%!a(MISSING) = return key): config switch trunk %!a(MISSING) edit myTrunk %!a(MISSING) set members port1 port2 %!a(MISSING) end %!a(MISSING)).
    commandName string
    Command name called by the FortiGate switch controller in the execute command.
    description string
    Description.
    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.
    command str
    String of commands to send to FortiSwitch devices (For example (%!a(MISSING) = return key): config switch trunk %!a(MISSING) edit myTrunk %!a(MISSING) set members port1 port2 %!a(MISSING) end %!a(MISSING)).
    command_name str
    Command name called by the FortiGate switch controller in the execute command.
    description str
    Description.
    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.
    command String
    String of commands to send to FortiSwitch devices (For example (%!a(MISSING) = return key): config switch trunk %!a(MISSING) edit myTrunk %!a(MISSING) set members port1 port2 %!a(MISSING) end %!a(MISSING)).
    commandName String
    Command name called by the FortiGate switch controller in the execute command.
    description String
    Description.
    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

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

    $ pulumi import fortios:switchcontroller/customcommand:Customcommand labelname {{command_name}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:switchcontroller/customcommand:Customcommand labelname {{command_name}}
    

    $ 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