1. Packages
  2. Ibm Provider
  3. API Docs
  4. NetworkVlanSpanning
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.NetworkVlanSpanning

Explore with Pulumi AI

This resource configures the VLAN spanning attribute for an IaaS account. By default VLAN spanning on the private network is disabled (off) and servers provisioned on separate private VLANs will not be able to communicate with each other over the private network. When enabled, the private network VLAN spanning service allows all private network VLANs to communicate with one another and hence all servers in the account to communicate with each other. Future servers will be added as they are provisioned. VLAN spanning enables servers to communicate across VLANs in the same data center and across data centers.

VLAN Spanning must be enabled to use Security Groups containing servers provisioned over multiple VLANs or across multiple data centers and regions. Note VLAN Spanning does not implement network security or firewalls and must be used with Security Groups or Virtual Router Appliances (Vyatta or Juniper) to provide network isolation.

VRF at an IaaS account level can be used as an alternative to VLAN Spanning and is required if DirectLink is used. For more information, see VLAN spanning.

Create NetworkVlanSpanning Resource

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

Constructor syntax

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

@overload
def NetworkVlanSpanning(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        vlan_spanning: Optional[str] = None,
                        network_vlan_spanning_id: Optional[str] = None)
func NewNetworkVlanSpanning(ctx *Context, name string, args NetworkVlanSpanningArgs, opts ...ResourceOption) (*NetworkVlanSpanning, error)
public NetworkVlanSpanning(string name, NetworkVlanSpanningArgs args, CustomResourceOptions? opts = null)
public NetworkVlanSpanning(String name, NetworkVlanSpanningArgs args)
public NetworkVlanSpanning(String name, NetworkVlanSpanningArgs args, CustomResourceOptions options)
type: ibm:NetworkVlanSpanning
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 This property is required. NetworkVlanSpanningArgs
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 This property is required. NetworkVlanSpanningArgs
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 This property is required. NetworkVlanSpanningArgs
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 This property is required. NetworkVlanSpanningArgs
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. NetworkVlanSpanningArgs
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 networkVlanSpanningResource = new Ibm.NetworkVlanSpanning("networkVlanSpanningResource", new()
{
    VlanSpanning = "string",
    NetworkVlanSpanningId = "string",
});
Copy
example, err := ibm.NewNetworkVlanSpanning(ctx, "networkVlanSpanningResource", &ibm.NetworkVlanSpanningArgs{
VlanSpanning: pulumi.String("string"),
NetworkVlanSpanningId: pulumi.String("string"),
})
Copy
var networkVlanSpanningResource = new NetworkVlanSpanning("networkVlanSpanningResource", NetworkVlanSpanningArgs.builder()
    .vlanSpanning("string")
    .networkVlanSpanningId("string")
    .build());
Copy
network_vlan_spanning_resource = ibm.NetworkVlanSpanning("networkVlanSpanningResource",
    vlan_spanning="string",
    network_vlan_spanning_id="string")
Copy
const networkVlanSpanningResource = new ibm.NetworkVlanSpanning("networkVlanSpanningResource", {
    vlanSpanning: "string",
    networkVlanSpanningId: "string",
});
Copy
type: ibm:NetworkVlanSpanning
properties:
    networkVlanSpanningId: string
    vlanSpanning: string
Copy

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

VlanSpanning This property is required. string
VLAN Spanning set to On or Off
NetworkVlanSpanningId string
(String) The unique identifier of the VLAN spanning resource.
VlanSpanning This property is required. string
VLAN Spanning set to On or Off
NetworkVlanSpanningId string
(String) The unique identifier of the VLAN spanning resource.
vlanSpanning This property is required. String
VLAN Spanning set to On or Off
networkVlanSpanningId String
(String) The unique identifier of the VLAN spanning resource.
vlanSpanning This property is required. string
VLAN Spanning set to On or Off
networkVlanSpanningId string
(String) The unique identifier of the VLAN spanning resource.
vlan_spanning This property is required. str
VLAN Spanning set to On or Off
network_vlan_spanning_id str
(String) The unique identifier of the VLAN spanning resource.
vlanSpanning This property is required. String
VLAN Spanning set to On or Off
networkVlanSpanningId String
(String) The unique identifier of the VLAN spanning resource.

Outputs

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

Get an existing NetworkVlanSpanning 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?: NetworkVlanSpanningState, opts?: CustomResourceOptions): NetworkVlanSpanning
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        network_vlan_spanning_id: Optional[str] = None,
        vlan_spanning: Optional[str] = None) -> NetworkVlanSpanning
func GetNetworkVlanSpanning(ctx *Context, name string, id IDInput, state *NetworkVlanSpanningState, opts ...ResourceOption) (*NetworkVlanSpanning, error)
public static NetworkVlanSpanning Get(string name, Input<string> id, NetworkVlanSpanningState? state, CustomResourceOptions? opts = null)
public static NetworkVlanSpanning get(String name, Output<String> id, NetworkVlanSpanningState state, CustomResourceOptions options)
resources:  _:    type: ibm:NetworkVlanSpanning    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:
NetworkVlanSpanningId string
(String) The unique identifier of the VLAN spanning resource.
VlanSpanning string
VLAN Spanning set to On or Off
NetworkVlanSpanningId string
(String) The unique identifier of the VLAN spanning resource.
VlanSpanning string
VLAN Spanning set to On or Off
networkVlanSpanningId String
(String) The unique identifier of the VLAN spanning resource.
vlanSpanning String
VLAN Spanning set to On or Off
networkVlanSpanningId string
(String) The unique identifier of the VLAN spanning resource.
vlanSpanning string
VLAN Spanning set to On or Off
network_vlan_spanning_id str
(String) The unique identifier of the VLAN spanning resource.
vlan_spanning str
VLAN Spanning set to On or Off
networkVlanSpanningId String
(String) The unique identifier of the VLAN spanning resource.
vlanSpanning String
VLAN Spanning set to On or Off

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.