Docs Packages
  1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. Vdomlink
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.system.Vdomlink

Explore with Pulumi AI

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

    Configure VDOM links.

    Create Vdomlink Resource

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

    Constructor syntax

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

@overload
def Vdomlink(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             name: Optional[str] = None,
             type: Optional[str] = None,
             vcluster: Optional[str] = None,
             vdomparam: Optional[str] = None)
    func NewVdomlink(ctx *Context, name string, args *VdomlinkArgs, opts ...ResourceOption) (*Vdomlink, error)
    public Vdomlink(string name, VdomlinkArgs? args = null, CustomResourceOptions? opts = null)
    public Vdomlink(String name, VdomlinkArgs args)
public Vdomlink(String name, VdomlinkArgs args, CustomResourceOptions options)

    type: fortios:system:Vdomlink
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 VdomlinkArgs
    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 VdomlinkArgs
    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 VdomlinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VdomlinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VdomlinkArgs
    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 vdomlinkResource = new Fortios.System.Vdomlink("vdomlinkResource", new()
{
    Name = "string",
    Type = "string",
    Vcluster = "string",
    Vdomparam = "string",
});

    example, err := system.NewVdomlink(ctx, "vdomlinkResource", &system.VdomlinkArgs{
	Name:      pulumi.String("string"),
	Type:      pulumi.String("string"),
	Vcluster:  pulumi.String("string"),
	Vdomparam: pulumi.String("string"),
})

    var vdomlinkResource = new Vdomlink("vdomlinkResource", VdomlinkArgs.builder()
    .name("string")
    .type("string")
    .vcluster("string")
    .vdomparam("string")
    .build());

    vdomlink_resource = fortios.system.Vdomlink("vdomlinkResource",
    name="string",
    type="string",
    vcluster="string",
    vdomparam="string")

    const vdomlinkResource = new fortios.system.Vdomlink("vdomlinkResource", {
    name: "string",
    type: "string",
    vcluster: "string",
    vdomparam: "string",
});

    type: fortios:system:Vdomlink
properties:
    name: string
    type: string
    vcluster: string
    vdomparam: string

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

    Name string
    VDOM link name (maximum = 8 characters).
    Type string
    VDOM link type: PPP or Ethernet.
    Vcluster string
    Virtual cluster. Valid values: vcluster1, vcluster2.
    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.
    Name string
    VDOM link name (maximum = 8 characters).
    Type string
    VDOM link type: PPP or Ethernet.
    Vcluster string
    Virtual cluster. Valid values: vcluster1, vcluster2.
    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.
    name String
    VDOM link name (maximum = 8 characters).
    type String
    VDOM link type: PPP or Ethernet.
    vcluster String
    Virtual cluster. Valid values: vcluster1, vcluster2.
    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.
    name string
    VDOM link name (maximum = 8 characters).
    type string
    VDOM link type: PPP or Ethernet.
    vcluster string
    Virtual cluster. Valid values: vcluster1, vcluster2.
    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.
    name str
    VDOM link name (maximum = 8 characters).
    type str
    VDOM link type: PPP or Ethernet.
    vcluster str
    Virtual cluster. Valid values: vcluster1, vcluster2.
    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.
    name String
    VDOM link name (maximum = 8 characters).
    type String
    VDOM link type: PPP or Ethernet.
    vcluster String
    Virtual cluster. Valid values: vcluster1, vcluster2.
    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 Vdomlink 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 Vdomlink Resource

    Get an existing Vdomlink 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?: VdomlinkState, opts?: CustomResourceOptions): Vdomlink
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        type: Optional[str] = None,
        vcluster: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Vdomlink
    func GetVdomlink(ctx *Context, name string, id IDInput, state *VdomlinkState, opts ...ResourceOption) (*Vdomlink, error)
    public static Vdomlink Get(string name, Input<string> id, VdomlinkState? state, CustomResourceOptions? opts = null)
    public static Vdomlink get(String name, Output<String> id, VdomlinkState 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:
    Name string
    VDOM link name (maximum = 8 characters).
    Type string
    VDOM link type: PPP or Ethernet.
    Vcluster string
    Virtual cluster. Valid values: vcluster1, vcluster2.
    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.
    Name string
    VDOM link name (maximum = 8 characters).
    Type string
    VDOM link type: PPP or Ethernet.
    Vcluster string
    Virtual cluster. Valid values: vcluster1, vcluster2.
    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.
    name String
    VDOM link name (maximum = 8 characters).
    type String
    VDOM link type: PPP or Ethernet.
    vcluster String
    Virtual cluster. Valid values: vcluster1, vcluster2.
    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.
    name string
    VDOM link name (maximum = 8 characters).
    type string
    VDOM link type: PPP or Ethernet.
    vcluster string
    Virtual cluster. Valid values: vcluster1, vcluster2.
    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.
    name str
    VDOM link name (maximum = 8 characters).
    type str
    VDOM link type: PPP or Ethernet.
    vcluster str
    Virtual cluster. Valid values: vcluster1, vcluster2.
    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.
    name String
    VDOM link name (maximum = 8 characters).
    type String
    VDOM link type: PPP or Ethernet.
    vcluster String
    Virtual cluster. Valid values: vcluster1, vcluster2.
    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 VdomLink can be imported using any of these accepted formats:

    $ pulumi import fortios:system/vdomlink:Vdomlink labelname {{name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/vdomlink:Vdomlink 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.5 published on Tuesday, Apr 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios