Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. DvmdbDeviceVdom
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

fortimanager.DvmdbDeviceVdom

Explore with Pulumi AI

fortimanager logo
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

    Device VDOM table.

    This resource is a sub resource for variable vdom of resource fortimanager_dvmdb_device. Conflict and overwrite may occur if use both of them.

    Create DvmdbDeviceVdom Resource

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

    Constructor syntax

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

@overload
def DvmdbDeviceVdom(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    device_name: Optional[str] = None,
                    adom: Optional[str] = None,
                    comments: Optional[str] = None,
                    dvmdb_device_vdom_id: Optional[str] = None,
                    metafields: Optional[str] = None,
                    name: Optional[str] = None,
                    opmode: Optional[str] = None,
                    rtm_prof_id: Optional[float] = None,
                    scopetype: Optional[str] = None,
                    status: Optional[str] = None,
                    vdom_type: Optional[str] = None,
                    vpn_id: Optional[float] = None)
    func NewDvmdbDeviceVdom(ctx *Context, name string, args DvmdbDeviceVdomArgs, opts ...ResourceOption) (*DvmdbDeviceVdom, error)
    public DvmdbDeviceVdom(string name, DvmdbDeviceVdomArgs args, CustomResourceOptions? opts = null)
    public DvmdbDeviceVdom(String name, DvmdbDeviceVdomArgs args)
public DvmdbDeviceVdom(String name, DvmdbDeviceVdomArgs args, CustomResourceOptions options)

    type: fortimanager:DvmdbDeviceVdom
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 DvmdbDeviceVdomArgs
    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 DvmdbDeviceVdomArgs
    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 DvmdbDeviceVdomArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DvmdbDeviceVdomArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DvmdbDeviceVdomArgs
    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 dvmdbDeviceVdomResource = new Fortimanager.DvmdbDeviceVdom("dvmdbDeviceVdomResource", new()
{
    DeviceName = "string",
    Adom = "string",
    Comments = "string",
    DvmdbDeviceVdomId = "string",
    Metafields = "string",
    Name = "string",
    Opmode = "string",
    RtmProfId = 0,
    Scopetype = "string",
    Status = "string",
    VdomType = "string",
    VpnId = 0,
});

    example, err := fortimanager.NewDvmdbDeviceVdom(ctx, "dvmdbDeviceVdomResource", &fortimanager.DvmdbDeviceVdomArgs{
DeviceName: pulumi.String("string"),
Adom: pulumi.String("string"),
Comments: pulumi.String("string"),
DvmdbDeviceVdomId: pulumi.String("string"),
Metafields: pulumi.String("string"),
Name: pulumi.String("string"),
Opmode: pulumi.String("string"),
RtmProfId: pulumi.Float64(0),
Scopetype: pulumi.String("string"),
Status: pulumi.String("string"),
VdomType: pulumi.String("string"),
VpnId: pulumi.Float64(0),
})

    var dvmdbDeviceVdomResource = new DvmdbDeviceVdom("dvmdbDeviceVdomResource", DvmdbDeviceVdomArgs.builder()
    .deviceName("string")
    .adom("string")
    .comments("string")
    .dvmdbDeviceVdomId("string")
    .metafields("string")
    .name("string")
    .opmode("string")
    .rtmProfId(0)
    .scopetype("string")
    .status("string")
    .vdomType("string")
    .vpnId(0)
    .build());

    dvmdb_device_vdom_resource = fortimanager.DvmdbDeviceVdom("dvmdbDeviceVdomResource",
    device_name="string",
    adom="string",
    comments="string",
    dvmdb_device_vdom_id="string",
    metafields="string",
    name="string",
    opmode="string",
    rtm_prof_id=0,
    scopetype="string",
    status="string",
    vdom_type="string",
    vpn_id=0)

    const dvmdbDeviceVdomResource = new fortimanager.DvmdbDeviceVdom("dvmdbDeviceVdomResource", {
    deviceName: "string",
    adom: "string",
    comments: "string",
    dvmdbDeviceVdomId: "string",
    metafields: "string",
    name: "string",
    opmode: "string",
    rtmProfId: 0,
    scopetype: "string",
    status: "string",
    vdomType: "string",
    vpnId: 0,
});

    type: fortimanager:DvmdbDeviceVdom
properties:
    adom: string
    comments: string
    deviceName: string
    dvmdbDeviceVdomId: string
    metafields: string
    name: string
    opmode: string
    rtmProfId: 0
    scopetype: string
    status: string
    vdomType: string
    vpnId: 0

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

    DeviceName string
    FortiManager managed device name. This variable is used in the request URL. If not specified, it will inherit the variable device_name of the provider.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Comments string
    Comments.
    DvmdbDeviceVdomId string
    an identifier for the resource with format {{name}}.
    Metafields string
    Meta Fields.
    Name string
    Name.
    Opmode string
    Opmode. Valid values: nat, transparent.
    RtmProfId double
    Rtm_Prof_Id.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Status string
    Status.
    VdomType string
    Vdom_Type. Valid values: traffic, admin.
    VpnId double
    Vpn_Id.
    DeviceName string
    FortiManager managed device name. This variable is used in the request URL. If not specified, it will inherit the variable device_name of the provider.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Comments string
    Comments.
    DvmdbDeviceVdomId string
    an identifier for the resource with format {{name}}.
    Metafields string
    Meta Fields.
    Name string
    Name.
    Opmode string
    Opmode. Valid values: nat, transparent.
    RtmProfId float64
    Rtm_Prof_Id.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Status string
    Status.
    VdomType string
    Vdom_Type. Valid values: traffic, admin.
    VpnId float64
    Vpn_Id.
    deviceName String
    FortiManager managed device name. This variable is used in the request URL. If not specified, it will inherit the variable device_name of the provider.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comments String
    Comments.
    dvmdbDeviceVdomId String
    an identifier for the resource with format {{name}}.
    metafields String
    Meta Fields.
    name String
    Name.
    opmode String
    Opmode. Valid values: nat, transparent.
    rtmProfId Double
    Rtm_Prof_Id.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    status String
    Status.
    vdomType String
    Vdom_Type. Valid values: traffic, admin.
    vpnId Double
    Vpn_Id.
    deviceName string
    FortiManager managed device name. This variable is used in the request URL. If not specified, it will inherit the variable device_name of the provider.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comments string
    Comments.
    dvmdbDeviceVdomId string
    an identifier for the resource with format {{name}}.
    metafields string
    Meta Fields.
    name string
    Name.
    opmode string
    Opmode. Valid values: nat, transparent.
    rtmProfId number
    Rtm_Prof_Id.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    status string
    Status.
    vdomType string
    Vdom_Type. Valid values: traffic, admin.
    vpnId number
    Vpn_Id.
    device_name str
    FortiManager managed device name. This variable is used in the request URL. If not specified, it will inherit the variable device_name of the provider.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comments str
    Comments.
    dvmdb_device_vdom_id str
    an identifier for the resource with format {{name}}.
    metafields str
    Meta Fields.
    name str
    Name.
    opmode str
    Opmode. Valid values: nat, transparent.
    rtm_prof_id float
    Rtm_Prof_Id.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    status str
    Status.
    vdom_type str
    Vdom_Type. Valid values: traffic, admin.
    vpn_id float
    Vpn_Id.
    deviceName String
    FortiManager managed device name. This variable is used in the request URL. If not specified, it will inherit the variable device_name of the provider.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comments String
    Comments.
    dvmdbDeviceVdomId String
    an identifier for the resource with format {{name}}.
    metafields String
    Meta Fields.
    name String
    Name.
    opmode String
    Opmode. Valid values: nat, transparent.
    rtmProfId Number
    Rtm_Prof_Id.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    status String
    Status.
    vdomType String
    Vdom_Type. Valid values: traffic, admin.
    vpnId Number
    Vpn_Id.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DvmdbDeviceVdom 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 DvmdbDeviceVdom Resource

    Get an existing DvmdbDeviceVdom 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?: DvmdbDeviceVdomState, opts?: CustomResourceOptions): DvmdbDeviceVdom
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adom: Optional[str] = None,
        comments: Optional[str] = None,
        device_name: Optional[str] = None,
        dvmdb_device_vdom_id: Optional[str] = None,
        metafields: Optional[str] = None,
        name: Optional[str] = None,
        opmode: Optional[str] = None,
        rtm_prof_id: Optional[float] = None,
        scopetype: Optional[str] = None,
        status: Optional[str] = None,
        vdom_type: Optional[str] = None,
        vpn_id: Optional[float] = None) -> DvmdbDeviceVdom
    func GetDvmdbDeviceVdom(ctx *Context, name string, id IDInput, state *DvmdbDeviceVdomState, opts ...ResourceOption) (*DvmdbDeviceVdom, error)
    public static DvmdbDeviceVdom Get(string name, Input<string> id, DvmdbDeviceVdomState? state, CustomResourceOptions? opts = null)
    public static DvmdbDeviceVdom get(String name, Output<String> id, DvmdbDeviceVdomState state, CustomResourceOptions options)
    resources:  _:    type: fortimanager:DvmdbDeviceVdom    get:      id: ${id}
    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:
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Comments string
    Comments.
    DeviceName string
    FortiManager managed device name. This variable is used in the request URL. If not specified, it will inherit the variable device_name of the provider.
    DvmdbDeviceVdomId string
    an identifier for the resource with format {{name}}.
    Metafields string
    Meta Fields.
    Name string
    Name.
    Opmode string
    Opmode. Valid values: nat, transparent.
    RtmProfId double
    Rtm_Prof_Id.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Status string
    Status.
    VdomType string
    Vdom_Type. Valid values: traffic, admin.
    VpnId double
    Vpn_Id.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Comments string
    Comments.
    DeviceName string
    FortiManager managed device name. This variable is used in the request URL. If not specified, it will inherit the variable device_name of the provider.
    DvmdbDeviceVdomId string
    an identifier for the resource with format {{name}}.
    Metafields string
    Meta Fields.
    Name string
    Name.
    Opmode string
    Opmode. Valid values: nat, transparent.
    RtmProfId float64
    Rtm_Prof_Id.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Status string
    Status.
    VdomType string
    Vdom_Type. Valid values: traffic, admin.
    VpnId float64
    Vpn_Id.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comments String
    Comments.
    deviceName String
    FortiManager managed device name. This variable is used in the request URL. If not specified, it will inherit the variable device_name of the provider.
    dvmdbDeviceVdomId String
    an identifier for the resource with format {{name}}.
    metafields String
    Meta Fields.
    name String
    Name.
    opmode String
    Opmode. Valid values: nat, transparent.
    rtmProfId Double
    Rtm_Prof_Id.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    status String
    Status.
    vdomType String
    Vdom_Type. Valid values: traffic, admin.
    vpnId Double
    Vpn_Id.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comments string
    Comments.
    deviceName string
    FortiManager managed device name. This variable is used in the request URL. If not specified, it will inherit the variable device_name of the provider.
    dvmdbDeviceVdomId string
    an identifier for the resource with format {{name}}.
    metafields string
    Meta Fields.
    name string
    Name.
    opmode string
    Opmode. Valid values: nat, transparent.
    rtmProfId number
    Rtm_Prof_Id.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    status string
    Status.
    vdomType string
    Vdom_Type. Valid values: traffic, admin.
    vpnId number
    Vpn_Id.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comments str
    Comments.
    device_name str
    FortiManager managed device name. This variable is used in the request URL. If not specified, it will inherit the variable device_name of the provider.
    dvmdb_device_vdom_id str
    an identifier for the resource with format {{name}}.
    metafields str
    Meta Fields.
    name str
    Name.
    opmode str
    Opmode. Valid values: nat, transparent.
    rtm_prof_id float
    Rtm_Prof_Id.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    status str
    Status.
    vdom_type str
    Vdom_Type. Valid values: traffic, admin.
    vpn_id float
    Vpn_Id.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comments String
    Comments.
    deviceName String
    FortiManager managed device name. This variable is used in the request URL. If not specified, it will inherit the variable device_name of the provider.
    dvmdbDeviceVdomId String
    an identifier for the resource with format {{name}}.
    metafields String
    Meta Fields.
    name String
    Name.
    opmode String
    Opmode. Valid values: nat, transparent.
    rtmProfId Number
    Rtm_Prof_Id.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    status String
    Status.
    vdomType String
    Vdom_Type. Valid values: traffic, admin.
    vpnId Number
    Vpn_Id.

    Import

    Dvmdb DeviceVdom can be imported using any of these accepted formats:

    Set import_options = [“device=YOUR_VALUE”] in the provider section.

    $ export “FORTIMANAGER_IMPORT_TABLE”=“true”

    $ pulumi import fortimanager:index/dvmdbDeviceVdom:DvmdbDeviceVdom labelname {{name}}

    $ unset “FORTIMANAGER_IMPORT_TABLE”

    -> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    fortimanager fortinetdev/terraform-provider-fortimanager
    License
    Notes
    This Pulumi package is based on the fortimanager Terraform Provider.
    fortimanager logo
    fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
    fortinetdev/terraform-provider-fortimanager