Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. Automationdestination
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.system.Automationdestination

Explore with Pulumi AI

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

Automation destinations.

Example Usage

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

const trname = new fortios.system.Automationdestination("trname", {
    haGroupId: 0,
    type: "fortigate",
});
Copy
import pulumi
import pulumiverse_fortios as fortios

trname = fortios.system.Automationdestination("trname",
    ha_group_id=0,
    type="fortigate")
Copy
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.NewAutomationdestination(ctx, "trname", &system.AutomationdestinationArgs{
			HaGroupId: pulumi.Int(0),
			Type:      pulumi.String("fortigate"),
		})
		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.System.Automationdestination("trname", new()
    {
        HaGroupId = 0,
        Type = "fortigate",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.system.Automationdestination;
import com.pulumi.fortios.system.AutomationdestinationArgs;
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 Automationdestination("trname", AutomationdestinationArgs.builder()
            .haGroupId(0)
            .type("fortigate")
            .build());

    }
}
Copy
resources:
  trname:
    type: fortios:system:Automationdestination
    properties:
      haGroupId: 0
      type: fortigate
Copy

Create Automationdestination Resource

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

Constructor syntax

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

@overload
def Automationdestination(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          destinations: Optional[Sequence[AutomationdestinationDestinationArgs]] = None,
                          dynamic_sort_subtable: Optional[str] = None,
                          get_all_tables: Optional[str] = None,
                          ha_group_id: Optional[int] = None,
                          name: Optional[str] = None,
                          type: Optional[str] = None,
                          vdomparam: Optional[str] = None)
func NewAutomationdestination(ctx *Context, name string, args *AutomationdestinationArgs, opts ...ResourceOption) (*Automationdestination, error)
public Automationdestination(string name, AutomationdestinationArgs? args = null, CustomResourceOptions? opts = null)
public Automationdestination(String name, AutomationdestinationArgs args)
public Automationdestination(String name, AutomationdestinationArgs args, CustomResourceOptions options)

type: fortios:system:Automationdestination
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 AutomationdestinationArgs
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 AutomationdestinationArgs
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 AutomationdestinationArgs
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 AutomationdestinationArgs
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. AutomationdestinationArgs
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 automationdestinationResource = new Fortios.System.Automationdestination("automationdestinationResource", new()
{
    Destinations = new[]
    {
        new Fortios.System.Inputs.AutomationdestinationDestinationArgs
        {
            Name = "string",
        },
    },
    DynamicSortSubtable = "string",
    GetAllTables = "string",
    HaGroupId = 0,
    Name = "string",
    Type = "string",
    Vdomparam = "string",
});
Copy
example, err := system.NewAutomationdestination(ctx, "automationdestinationResource", &system.AutomationdestinationArgs{
	Destinations: system.AutomationdestinationDestinationArray{
		&system.AutomationdestinationDestinationArgs{
			Name: pulumi.String("string"),
		},
	},
	DynamicSortSubtable: pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	HaGroupId:           pulumi.Int(0),
	Name:                pulumi.String("string"),
	Type:                pulumi.String("string"),
	Vdomparam:           pulumi.String("string"),
})
Copy
var automationdestinationResource = new Automationdestination("automationdestinationResource", AutomationdestinationArgs.builder()
    .destinations(AutomationdestinationDestinationArgs.builder()
        .name("string")
        .build())
    .dynamicSortSubtable("string")
    .getAllTables("string")
    .haGroupId(0)
    .name("string")
    .type("string")
    .vdomparam("string")
    .build());
Copy
automationdestination_resource = fortios.system.Automationdestination("automationdestinationResource",
    destinations=[{
        "name": "string",
    }],
    dynamic_sort_subtable="string",
    get_all_tables="string",
    ha_group_id=0,
    name="string",
    type="string",
    vdomparam="string")
Copy
const automationdestinationResource = new fortios.system.Automationdestination("automationdestinationResource", {
    destinations: [{
        name: "string",
    }],
    dynamicSortSubtable: "string",
    getAllTables: "string",
    haGroupId: 0,
    name: "string",
    type: "string",
    vdomparam: "string",
});
Copy
type: fortios:system:Automationdestination
properties:
    destinations:
        - name: string
    dynamicSortSubtable: string
    getAllTables: string
    haGroupId: 0
    name: string
    type: string
    vdomparam: string
Copy

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

Destinations List<Pulumiverse.Fortios.System.Inputs.AutomationdestinationDestination>
Destinations. The structure of destination block is documented below.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
HaGroupId int
Cluster group ID set for this destination (default = 0).
Name Changes to this property will trigger replacement. string
Name.
Type string
Destination type. Valid values: fortigate, ha-cluster.
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.
Destinations []AutomationdestinationDestinationArgs
Destinations. The structure of destination block is documented below.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
HaGroupId int
Cluster group ID set for this destination (default = 0).
Name Changes to this property will trigger replacement. string
Name.
Type string
Destination type. Valid values: fortigate, ha-cluster.
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.
destinations List<AutomationdestinationDestination>
Destinations. The structure of destination block is documented below.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
haGroupId Integer
Cluster group ID set for this destination (default = 0).
name Changes to this property will trigger replacement. String
Name.
type String
Destination type. Valid values: fortigate, ha-cluster.
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.
destinations AutomationdestinationDestination[]
Destinations. The structure of destination block is documented below.
dynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
getAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
haGroupId number
Cluster group ID set for this destination (default = 0).
name Changes to this property will trigger replacement. string
Name.
type string
Destination type. Valid values: fortigate, ha-cluster.
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.
destinations Sequence[AutomationdestinationDestinationArgs]
Destinations. The structure of destination block is documented below.
dynamic_sort_subtable str
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
get_all_tables str
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
ha_group_id int
Cluster group ID set for this destination (default = 0).
name Changes to this property will trigger replacement. str
Name.
type str
Destination type. Valid values: fortigate, ha-cluster.
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.
destinations List<Property Map>
Destinations. The structure of destination block is documented below.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
haGroupId Number
Cluster group ID set for this destination (default = 0).
name Changes to this property will trigger replacement. String
Name.
type String
Destination type. Valid values: fortigate, ha-cluster.
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 Automationdestination 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 Automationdestination Resource

Get an existing Automationdestination 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?: AutomationdestinationState, opts?: CustomResourceOptions): Automationdestination
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        destinations: Optional[Sequence[AutomationdestinationDestinationArgs]] = None,
        dynamic_sort_subtable: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        ha_group_id: Optional[int] = None,
        name: Optional[str] = None,
        type: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Automationdestination
func GetAutomationdestination(ctx *Context, name string, id IDInput, state *AutomationdestinationState, opts ...ResourceOption) (*Automationdestination, error)
public static Automationdestination Get(string name, Input<string> id, AutomationdestinationState? state, CustomResourceOptions? opts = null)
public static Automationdestination get(String name, Output<String> id, AutomationdestinationState state, CustomResourceOptions options)
resources:  _:    type: fortios:system:Automationdestination    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:
Destinations List<Pulumiverse.Fortios.System.Inputs.AutomationdestinationDestination>
Destinations. The structure of destination block is documented below.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
HaGroupId int
Cluster group ID set for this destination (default = 0).
Name Changes to this property will trigger replacement. string
Name.
Type string
Destination type. Valid values: fortigate, ha-cluster.
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.
Destinations []AutomationdestinationDestinationArgs
Destinations. The structure of destination block is documented below.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
HaGroupId int
Cluster group ID set for this destination (default = 0).
Name Changes to this property will trigger replacement. string
Name.
Type string
Destination type. Valid values: fortigate, ha-cluster.
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.
destinations List<AutomationdestinationDestination>
Destinations. The structure of destination block is documented below.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
haGroupId Integer
Cluster group ID set for this destination (default = 0).
name Changes to this property will trigger replacement. String
Name.
type String
Destination type. Valid values: fortigate, ha-cluster.
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.
destinations AutomationdestinationDestination[]
Destinations. The structure of destination block is documented below.
dynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
getAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
haGroupId number
Cluster group ID set for this destination (default = 0).
name Changes to this property will trigger replacement. string
Name.
type string
Destination type. Valid values: fortigate, ha-cluster.
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.
destinations Sequence[AutomationdestinationDestinationArgs]
Destinations. The structure of destination block is documented below.
dynamic_sort_subtable str
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
get_all_tables str
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
ha_group_id int
Cluster group ID set for this destination (default = 0).
name Changes to this property will trigger replacement. str
Name.
type str
Destination type. Valid values: fortigate, ha-cluster.
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.
destinations List<Property Map>
Destinations. The structure of destination block is documented below.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
haGroupId Number
Cluster group ID set for this destination (default = 0).
name Changes to this property will trigger replacement. String
Name.
type String
Destination type. Valid values: fortigate, ha-cluster.
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.

Supporting Types

AutomationdestinationDestination
, AutomationdestinationDestinationArgs

Name string
Destination.
Name string
Destination.
name String
Destination.
name string
Destination.
name str
Destination.
name String
Destination.

Import

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

$ pulumi import fortios:system/automationdestination:Automationdestination labelname {{name}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:system/automationdestination:Automationdestination 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.
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios