1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. getVlan
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

oci.Core.getVlan

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

    This data source provides details about a specific Vlan resource in Oracle Cloud Infrastructure Core service.

    Gets the specified VLAN’s information.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testVlan = oci.Core.getVlan({
        vlanId: oci_core_vlan.test_vlan.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_vlan = oci.Core.get_vlan(vlan_id=oci_core_vlan["test_vlan"]["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Core.GetVlan(ctx, &core.GetVlanArgs{
    			VlanId: oci_core_vlan.Test_vlan.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testVlan = Oci.Core.GetVlan.Invoke(new()
        {
            VlanId = oci_core_vlan.Test_vlan.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Core.CoreFunctions;
    import com.pulumi.oci.Core.inputs.GetVlanArgs;
    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) {
            final var testVlan = CoreFunctions.getVlan(GetVlanArgs.builder()
                .vlanId(oci_core_vlan.test_vlan().id())
                .build());
    
        }
    }
    
    variables:
      testVlan:
        fn::invoke:
          Function: oci:Core:getVlan
          Arguments:
            vlanId: ${oci_core_vlan.test_vlan.id}
    

    Using getVlan

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getVlan(args: GetVlanArgs, opts?: InvokeOptions): Promise<GetVlanResult>
    function getVlanOutput(args: GetVlanOutputArgs, opts?: InvokeOptions): Output<GetVlanResult>
    def get_vlan(vlan_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetVlanResult
    def get_vlan_output(vlan_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetVlanResult]
    func GetVlan(ctx *Context, args *GetVlanArgs, opts ...InvokeOption) (*GetVlanResult, error)
    func GetVlanOutput(ctx *Context, args *GetVlanOutputArgs, opts ...InvokeOption) GetVlanResultOutput

    > Note: This function is named GetVlan in the Go SDK.

    public static class GetVlan 
    {
        public static Task<GetVlanResult> InvokeAsync(GetVlanArgs args, InvokeOptions? opts = null)
        public static Output<GetVlanResult> Invoke(GetVlanInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVlanResult> getVlan(GetVlanArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Core/getVlan:getVlan
      arguments:
        # arguments dictionary

    The following arguments are supported:

    VlanId string
    The OCID of the VLAN.
    VlanId string
    The OCID of the VLAN.
    vlanId String
    The OCID of the VLAN.
    vlanId string
    The OCID of the VLAN.
    vlan_id str
    The OCID of the VLAN.
    vlanId String
    The OCID of the VLAN.

    getVlan Result

    The following output properties are available:

    AvailabilityDomain string
    The VLAN's availability domain. This attribute will be null if this is a regional VLAN rather than an AD-specific VLAN. Example: Uocm:PHX-AD-1
    CidrBlock string
    The range of IPv4 addresses that will be used for layer 3 communication with hosts outside the VLAN. Example: 192.168.1.0/24
    CompartmentId string
    The OCID of the compartment containing the VLAN.
    DefinedTags Dictionary<string, object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, object>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The VLAN's Oracle ID (OCID).
    NsgIds List<string>
    A list of the OCIDs of the network security groups (NSGs) to use with this VLAN. All VNICs in the VLAN belong to these NSGs. For more information about NSGs, see NetworkSecurityGroup.
    RouteTableId string
    The OCID of the route table that the VLAN uses.
    State string
    The VLAN's current state.
    TimeCreated string
    The date and time the VLAN was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    VcnId string
    The OCID of the VCN the VLAN is in.
    VlanId string
    VlanTag int
    The IEEE 802.1Q VLAN tag of this VLAN. Example: 100
    AvailabilityDomain string
    The VLAN's availability domain. This attribute will be null if this is a regional VLAN rather than an AD-specific VLAN. Example: Uocm:PHX-AD-1
    CidrBlock string
    The range of IPv4 addresses that will be used for layer 3 communication with hosts outside the VLAN. Example: 192.168.1.0/24
    CompartmentId string
    The OCID of the compartment containing the VLAN.
    DefinedTags map[string]interface{}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]interface{}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The VLAN's Oracle ID (OCID).
    NsgIds []string
    A list of the OCIDs of the network security groups (NSGs) to use with this VLAN. All VNICs in the VLAN belong to these NSGs. For more information about NSGs, see NetworkSecurityGroup.
    RouteTableId string
    The OCID of the route table that the VLAN uses.
    State string
    The VLAN's current state.
    TimeCreated string
    The date and time the VLAN was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    VcnId string
    The OCID of the VCN the VLAN is in.
    VlanId string
    VlanTag int
    The IEEE 802.1Q VLAN tag of this VLAN. Example: 100
    availabilityDomain String
    The VLAN's availability domain. This attribute will be null if this is a regional VLAN rather than an AD-specific VLAN. Example: Uocm:PHX-AD-1
    cidrBlock String
    The range of IPv4 addresses that will be used for layer 3 communication with hosts outside the VLAN. Example: 192.168.1.0/24
    compartmentId String
    The OCID of the compartment containing the VLAN.
    definedTags Map<String,Object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,Object>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The VLAN's Oracle ID (OCID).
    nsgIds List<String>
    A list of the OCIDs of the network security groups (NSGs) to use with this VLAN. All VNICs in the VLAN belong to these NSGs. For more information about NSGs, see NetworkSecurityGroup.
    routeTableId String
    The OCID of the route table that the VLAN uses.
    state String
    The VLAN's current state.
    timeCreated String
    The date and time the VLAN was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    vcnId String
    The OCID of the VCN the VLAN is in.
    vlanId String
    vlanTag Integer
    The IEEE 802.1Q VLAN tag of this VLAN. Example: 100
    availabilityDomain string
    The VLAN's availability domain. This attribute will be null if this is a regional VLAN rather than an AD-specific VLAN. Example: Uocm:PHX-AD-1
    cidrBlock string
    The range of IPv4 addresses that will be used for layer 3 communication with hosts outside the VLAN. Example: 192.168.1.0/24
    compartmentId string
    The OCID of the compartment containing the VLAN.
    definedTags {[key: string]: any}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: any}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    The VLAN's Oracle ID (OCID).
    nsgIds string[]
    A list of the OCIDs of the network security groups (NSGs) to use with this VLAN. All VNICs in the VLAN belong to these NSGs. For more information about NSGs, see NetworkSecurityGroup.
    routeTableId string
    The OCID of the route table that the VLAN uses.
    state string
    The VLAN's current state.
    timeCreated string
    The date and time the VLAN was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    vcnId string
    The OCID of the VCN the VLAN is in.
    vlanId string
    vlanTag number
    The IEEE 802.1Q VLAN tag of this VLAN. Example: 100
    availability_domain str
    The VLAN's availability domain. This attribute will be null if this is a regional VLAN rather than an AD-specific VLAN. Example: Uocm:PHX-AD-1
    cidr_block str
    The range of IPv4 addresses that will be used for layer 3 communication with hosts outside the VLAN. Example: 192.168.1.0/24
    compartment_id str
    The OCID of the compartment containing the VLAN.
    defined_tags Mapping[str, Any]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, Any]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id str
    The VLAN's Oracle ID (OCID).
    nsg_ids Sequence[str]
    A list of the OCIDs of the network security groups (NSGs) to use with this VLAN. All VNICs in the VLAN belong to these NSGs. For more information about NSGs, see NetworkSecurityGroup.
    route_table_id str
    The OCID of the route table that the VLAN uses.
    state str
    The VLAN's current state.
    time_created str
    The date and time the VLAN was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    vcn_id str
    The OCID of the VCN the VLAN is in.
    vlan_id str
    vlan_tag int
    The IEEE 802.1Q VLAN tag of this VLAN. Example: 100
    availabilityDomain String
    The VLAN's availability domain. This attribute will be null if this is a regional VLAN rather than an AD-specific VLAN. Example: Uocm:PHX-AD-1
    cidrBlock String
    The range of IPv4 addresses that will be used for layer 3 communication with hosts outside the VLAN. Example: 192.168.1.0/24
    compartmentId String
    The OCID of the compartment containing the VLAN.
    definedTags Map<Any>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<Any>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The VLAN's Oracle ID (OCID).
    nsgIds List<String>
    A list of the OCIDs of the network security groups (NSGs) to use with this VLAN. All VNICs in the VLAN belong to these NSGs. For more information about NSGs, see NetworkSecurityGroup.
    routeTableId String
    The OCID of the route table that the VLAN uses.
    state String
    The VLAN's current state.
    timeCreated String
    The date and time the VLAN was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    vcnId String
    The OCID of the VCN the VLAN is in.
    vlanId String
    vlanTag Number
    The IEEE 802.1Q VLAN tag of this VLAN. Example: 100

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi