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

fortios.system.Vdom

Explore with Pulumi AI

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

    Configure virtual domain.

    Example Usage

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

const trname = new fortios.system.Vdom("trname", {
    shortName: "testvdom",
    temporary: 0,
});

    import pulumi
import pulumiverse_fortios as fortios

trname = fortios.system.Vdom("trname",
    short_name="testvdom",
    temporary=0)

    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.NewVdom(ctx, "trname", &system.VdomArgs{
			ShortName: pulumi.String("testvdom"),
			Temporary: pulumi.Int(0),
		})
		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.Vdom("trname", new()
    {
        ShortName = "testvdom",
        Temporary = 0,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.system.Vdom;
import com.pulumi.fortios.system.VdomArgs;
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 Vdom("trname", VdomArgs.builder()
            .shortName("testvdom")
            .temporary(0)
            .build());

    }
}

    resources:
  trname:
    type: fortios:system:Vdom
    properties:
      shortName: testvdom
      temporary: 0

    Create Vdom Resource

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

    Constructor syntax

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

@overload
def Vdom(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         flag: Optional[int] = None,
         name: Optional[str] = None,
         short_name: Optional[str] = None,
         temporary: Optional[int] = None,
         vcluster_id: Optional[int] = None,
         vdomparam: Optional[str] = None)
    func NewVdom(ctx *Context, name string, args *VdomArgs, opts ...ResourceOption) (*Vdom, error)
    public Vdom(string name, VdomArgs? args = null, CustomResourceOptions? opts = null)
    public Vdom(String name, VdomArgs args)
public Vdom(String name, VdomArgs args, CustomResourceOptions options)

    type: fortios:system:Vdom
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 VdomArgs
    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 VdomArgs
    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 VdomArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VdomArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VdomArgs
    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 vdomResource = new Fortios.System.Vdom("vdomResource", new()
{
    Flag = 0,
    Name = "string",
    ShortName = "string",
    Temporary = 0,
    VclusterId = 0,
    Vdomparam = "string",
});

    example, err := system.NewVdom(ctx, "vdomResource", &system.VdomArgs{
	Flag:       pulumi.Int(0),
	Name:       pulumi.String("string"),
	ShortName:  pulumi.String("string"),
	Temporary:  pulumi.Int(0),
	VclusterId: pulumi.Int(0),
	Vdomparam:  pulumi.String("string"),
})

    var vdomResource = new Vdom("vdomResource", VdomArgs.builder()
    .flag(0)
    .name("string")
    .shortName("string")
    .temporary(0)
    .vclusterId(0)
    .vdomparam("string")
    .build());

    vdom_resource = fortios.system.Vdom("vdomResource",
    flag=0,
    name="string",
    short_name="string",
    temporary=0,
    vcluster_id=0,
    vdomparam="string")

    const vdomResource = new fortios.system.Vdom("vdomResource", {
    flag: 0,
    name: "string",
    shortName: "string",
    temporary: 0,
    vclusterId: 0,
    vdomparam: "string",
});

    type: fortios:system:Vdom
properties:
    flag: 0
    name: string
    shortName: string
    temporary: 0
    vclusterId: 0
    vdomparam: string

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

    Flag int
    Flag.
    Name string
    VDOM name.
    ShortName string
    VDOM short name.
    Temporary int
    Temporary.
    VclusterId int
    Virtual cluster ID (0 - 4294967295).
    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.
    Flag int
    Flag.
    Name string
    VDOM name.
    ShortName string
    VDOM short name.
    Temporary int
    Temporary.
    VclusterId int
    Virtual cluster ID (0 - 4294967295).
    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.
    flag Integer
    Flag.
    name String
    VDOM name.
    shortName String
    VDOM short name.
    temporary Integer
    Temporary.
    vclusterId Integer
    Virtual cluster ID (0 - 4294967295).
    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.
    flag number
    Flag.
    name string
    VDOM name.
    shortName string
    VDOM short name.
    temporary number
    Temporary.
    vclusterId number
    Virtual cluster ID (0 - 4294967295).
    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.
    flag int
    Flag.
    name str
    VDOM name.
    short_name str
    VDOM short name.
    temporary int
    Temporary.
    vcluster_id int
    Virtual cluster ID (0 - 4294967295).
    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.
    flag Number
    Flag.
    name String
    VDOM name.
    shortName String
    VDOM short name.
    temporary Number
    Temporary.
    vclusterId Number
    Virtual cluster ID (0 - 4294967295).
    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 Vdom 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 Vdom Resource

    Get an existing Vdom 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?: VdomState, opts?: CustomResourceOptions): Vdom
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        flag: Optional[int] = None,
        name: Optional[str] = None,
        short_name: Optional[str] = None,
        temporary: Optional[int] = None,
        vcluster_id: Optional[int] = None,
        vdomparam: Optional[str] = None) -> Vdom
    func GetVdom(ctx *Context, name string, id IDInput, state *VdomState, opts ...ResourceOption) (*Vdom, error)
    public static Vdom Get(string name, Input<string> id, VdomState? state, CustomResourceOptions? opts = null)
    public static Vdom get(String name, Output<String> id, VdomState 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:
    Flag int
    Flag.
    Name string
    VDOM name.
    ShortName string
    VDOM short name.
    Temporary int
    Temporary.
    VclusterId int
    Virtual cluster ID (0 - 4294967295).
    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.
    Flag int
    Flag.
    Name string
    VDOM name.
    ShortName string
    VDOM short name.
    Temporary int
    Temporary.
    VclusterId int
    Virtual cluster ID (0 - 4294967295).
    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.
    flag Integer
    Flag.
    name String
    VDOM name.
    shortName String
    VDOM short name.
    temporary Integer
    Temporary.
    vclusterId Integer
    Virtual cluster ID (0 - 4294967295).
    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.
    flag number
    Flag.
    name string
    VDOM name.
    shortName string
    VDOM short name.
    temporary number
    Temporary.
    vclusterId number
    Virtual cluster ID (0 - 4294967295).
    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.
    flag int
    Flag.
    name str
    VDOM name.
    short_name str
    VDOM short name.
    temporary int
    Temporary.
    vcluster_id int
    Virtual cluster ID (0 - 4294967295).
    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.
    flag Number
    Flag.
    name String
    VDOM name.
    shortName String
    VDOM short name.
    temporary Number
    Temporary.
    vclusterId Number
    Virtual cluster ID (0 - 4294967295).
    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 Vdom can be imported using any of these accepted formats:

    $ pulumi import fortios:system/vdom:Vdom labelname {{name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/vdom:Vdom labelname {{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.6 published on Tuesday, Jul 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios