Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. NetworkGateway
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.NetworkGateway

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Create, update, and delete an IBM Cloud network gateway appliance. A network gateway can be created in stand-alone mode and HA mode with both members, with either the same or different configurations. For more information, about Network gateway, see viewing gateway appliance details.

Note

For more information, see the IBM Cloud Classic Infrastructure (SoftLayer) API Docs.

For more information, about getting started, see the IBM Virtual Router Appliance Docs.

Example Usage

Standalone configuration

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const gateway = new ibm.NetworkGateway("gateway", {members: [{
    datacenter: "ams01",
    diskKeyNames: ["HARD_DRIVE_2_00TB_SATA_II"],
    domain: "ibm.com",
    hostname: "host-name",
    ipv6Enabled: true,
    memory: 8,
    networkSpeed: 100,
    notes: "gateway notes 1",
    osKeyName: "OS_VYATTA_5600_5_X_UP_TO_1GBPS_SUBSCRIPTION_EDITION_64_BIT",
    privateNetworkOnly: false,
    processKeyName: "INTEL_SINGLE_XEON_1270_3_50",
    publicBandwidth: 20000,
    redundantNetwork: false,
    tags: [
        "gateway tags 1",
        "terraform test tags 1",
    ],
    tcpMonitoring: true,
}]});
Copy
import pulumi
import pulumi_ibm as ibm

gateway = ibm.NetworkGateway("gateway", members=[{
    "datacenter": "ams01",
    "disk_key_names": ["HARD_DRIVE_2_00TB_SATA_II"],
    "domain": "ibm.com",
    "hostname": "host-name",
    "ipv6_enabled": True,
    "memory": 8,
    "network_speed": 100,
    "notes": "gateway notes 1",
    "os_key_name": "OS_VYATTA_5600_5_X_UP_TO_1GBPS_SUBSCRIPTION_EDITION_64_BIT",
    "private_network_only": False,
    "process_key_name": "INTEL_SINGLE_XEON_1270_3_50",
    "public_bandwidth": 20000,
    "redundant_network": False,
    "tags": [
        "gateway tags 1",
        "terraform test tags 1",
    ],
    "tcp_monitoring": True,
}])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewNetworkGateway(ctx, "gateway", &ibm.NetworkGatewayArgs{
			Members: ibm.NetworkGatewayMemberArray{
				&ibm.NetworkGatewayMemberArgs{
					Datacenter: pulumi.String("ams01"),
					DiskKeyNames: pulumi.StringArray{
						pulumi.String("HARD_DRIVE_2_00TB_SATA_II"),
					},
					Domain:             pulumi.String("ibm.com"),
					Hostname:           pulumi.String("host-name"),
					Ipv6Enabled:        pulumi.Bool(true),
					Memory:             pulumi.Float64(8),
					NetworkSpeed:       pulumi.Float64(100),
					Notes:              pulumi.String("gateway notes 1"),
					OsKeyName:          pulumi.String("OS_VYATTA_5600_5_X_UP_TO_1GBPS_SUBSCRIPTION_EDITION_64_BIT"),
					PrivateNetworkOnly: pulumi.Bool(false),
					ProcessKeyName:     pulumi.String("INTEL_SINGLE_XEON_1270_3_50"),
					PublicBandwidth:    pulumi.Float64(20000),
					RedundantNetwork:   pulumi.Bool(false),
					Tags: pulumi.StringArray{
						pulumi.String("gateway tags 1"),
						pulumi.String("terraform test tags 1"),
					},
					TcpMonitoring: pulumi.Bool(true),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var gateway = new Ibm.NetworkGateway("gateway", new()
    {
        Members = new[]
        {
            new Ibm.Inputs.NetworkGatewayMemberArgs
            {
                Datacenter = "ams01",
                DiskKeyNames = new[]
                {
                    "HARD_DRIVE_2_00TB_SATA_II",
                },
                Domain = "ibm.com",
                Hostname = "host-name",
                Ipv6Enabled = true,
                Memory = 8,
                NetworkSpeed = 100,
                Notes = "gateway notes 1",
                OsKeyName = "OS_VYATTA_5600_5_X_UP_TO_1GBPS_SUBSCRIPTION_EDITION_64_BIT",
                PrivateNetworkOnly = false,
                ProcessKeyName = "INTEL_SINGLE_XEON_1270_3_50",
                PublicBandwidth = 20000,
                RedundantNetwork = false,
                Tags = new[]
                {
                    "gateway tags 1",
                    "terraform test tags 1",
                },
                TcpMonitoring = true,
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.NetworkGateway;
import com.pulumi.ibm.NetworkGatewayArgs;
import com.pulumi.ibm.inputs.NetworkGatewayMemberArgs;
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 gateway = new NetworkGateway("gateway", NetworkGatewayArgs.builder()
            .members(NetworkGatewayMemberArgs.builder()
                .datacenter("ams01")
                .diskKeyNames("HARD_DRIVE_2_00TB_SATA_II")
                .domain("ibm.com")
                .hostname("host-name")
                .ipv6Enabled(true)
                .memory(8)
                .networkSpeed(100)
                .notes("gateway notes 1")
                .osKeyName("OS_VYATTA_5600_5_X_UP_TO_1GBPS_SUBSCRIPTION_EDITION_64_BIT")
                .privateNetworkOnly(false)
                .processKeyName("INTEL_SINGLE_XEON_1270_3_50")
                .publicBandwidth(20000)
                .redundantNetwork(false)
                .tags(                
                    "gateway tags 1",
                    "terraform test tags 1")
                .tcpMonitoring(true)
                .build())
            .build());

    }
}
Copy
resources:
  gateway:
    type: ibm:NetworkGateway
    properties:
      members:
        - datacenter: ams01
          diskKeyNames:
            - HARD_DRIVE_2_00TB_SATA_II
          domain: ibm.com
          hostname: host-name
          ipv6Enabled: true
          memory: 8
          networkSpeed: 100
          notes: gateway notes 1
          osKeyName: OS_VYATTA_5600_5_X_UP_TO_1GBPS_SUBSCRIPTION_EDITION_64_BIT
          privateNetworkOnly: false
          processKeyName: INTEL_SINGLE_XEON_1270_3_50
          publicBandwidth: 20000
          redundantNetwork: false
          tags:
            - gateway tags 1
            - terraform test tags 1
          tcpMonitoring: true
Copy

HA configuration

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const gateway = new ibm.NetworkGateway("gateway", {members: [
    {
        datacenter: "ams01",
        diskKeyNames: ["HARD_DRIVE_2_00TB_SATA_II"],
        domain: "ibm.com",
        hostname: "host-name-1",
        ipv6Enabled: true,
        memory: 8,
        networkSpeed: 100,
        notes: "gateway notes",
        osKeyName: "OS_VYATTA_5600_5_X_UP_TO_1GBPS_SUBSCRIPTION_EDITION_64_BIT",
        privateNetworkOnly: false,
        processKeyName: "INTEL_SINGLE_XEON_1270_3_50",
        publicBandwidth: 20000,
        redundantNetwork: false,
        tags: [
            "gateway tags",
            "terraform test tags 1",
        ],
        tcpMonitoring: true,
    },
    {
        datacenter: "ams01",
        diskKeyNames: ["HARD_DRIVE_2_00TB_SATA_II"],
        domain: "ibm.com",
        hostname: "host-name-2",
        ipv6Enabled: true,
        memory: 8,
        networkSpeed: 100,
        notes: "my ha mode gateway",
        osKeyName: "OS_VYATTA_5600_5_X_UP_TO_1GBPS_SUBSCRIPTION_EDITION_64_BIT",
        privateNetworkOnly: false,
        processKeyName: "INTEL_SINGLE_XEON_1270_3_50",
        publicBandwidth: 20000,
        redundantNetwork: false,
        tags: [
            "gateway tags 1",
            "terraform test tags 1",
        ],
        tcpMonitoring: true,
    },
]});
Copy
import pulumi
import pulumi_ibm as ibm

gateway = ibm.NetworkGateway("gateway", members=[
    {
        "datacenter": "ams01",
        "disk_key_names": ["HARD_DRIVE_2_00TB_SATA_II"],
        "domain": "ibm.com",
        "hostname": "host-name-1",
        "ipv6_enabled": True,
        "memory": 8,
        "network_speed": 100,
        "notes": "gateway notes",
        "os_key_name": "OS_VYATTA_5600_5_X_UP_TO_1GBPS_SUBSCRIPTION_EDITION_64_BIT",
        "private_network_only": False,
        "process_key_name": "INTEL_SINGLE_XEON_1270_3_50",
        "public_bandwidth": 20000,
        "redundant_network": False,
        "tags": [
            "gateway tags",
            "terraform test tags 1",
        ],
        "tcp_monitoring": True,
    },
    {
        "datacenter": "ams01",
        "disk_key_names": ["HARD_DRIVE_2_00TB_SATA_II"],
        "domain": "ibm.com",
        "hostname": "host-name-2",
        "ipv6_enabled": True,
        "memory": 8,
        "network_speed": 100,
        "notes": "my ha mode gateway",
        "os_key_name": "OS_VYATTA_5600_5_X_UP_TO_1GBPS_SUBSCRIPTION_EDITION_64_BIT",
        "private_network_only": False,
        "process_key_name": "INTEL_SINGLE_XEON_1270_3_50",
        "public_bandwidth": 20000,
        "redundant_network": False,
        "tags": [
            "gateway tags 1",
            "terraform test tags 1",
        ],
        "tcp_monitoring": True,
    },
])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewNetworkGateway(ctx, "gateway", &ibm.NetworkGatewayArgs{
			Members: ibm.NetworkGatewayMemberArray{
				&ibm.NetworkGatewayMemberArgs{
					Datacenter: pulumi.String("ams01"),
					DiskKeyNames: pulumi.StringArray{
						pulumi.String("HARD_DRIVE_2_00TB_SATA_II"),
					},
					Domain:             pulumi.String("ibm.com"),
					Hostname:           pulumi.String("host-name-1"),
					Ipv6Enabled:        pulumi.Bool(true),
					Memory:             pulumi.Float64(8),
					NetworkSpeed:       pulumi.Float64(100),
					Notes:              pulumi.String("gateway notes"),
					OsKeyName:          pulumi.String("OS_VYATTA_5600_5_X_UP_TO_1GBPS_SUBSCRIPTION_EDITION_64_BIT"),
					PrivateNetworkOnly: pulumi.Bool(false),
					ProcessKeyName:     pulumi.String("INTEL_SINGLE_XEON_1270_3_50"),
					PublicBandwidth:    pulumi.Float64(20000),
					RedundantNetwork:   pulumi.Bool(false),
					Tags: pulumi.StringArray{
						pulumi.String("gateway tags"),
						pulumi.String("terraform test tags 1"),
					},
					TcpMonitoring: pulumi.Bool(true),
				},
				&ibm.NetworkGatewayMemberArgs{
					Datacenter: pulumi.String("ams01"),
					DiskKeyNames: pulumi.StringArray{
						pulumi.String("HARD_DRIVE_2_00TB_SATA_II"),
					},
					Domain:             pulumi.String("ibm.com"),
					Hostname:           pulumi.String("host-name-2"),
					Ipv6Enabled:        pulumi.Bool(true),
					Memory:             pulumi.Float64(8),
					NetworkSpeed:       pulumi.Float64(100),
					Notes:              pulumi.String("my ha mode gateway"),
					OsKeyName:          pulumi.String("OS_VYATTA_5600_5_X_UP_TO_1GBPS_SUBSCRIPTION_EDITION_64_BIT"),
					PrivateNetworkOnly: pulumi.Bool(false),
					ProcessKeyName:     pulumi.String("INTEL_SINGLE_XEON_1270_3_50"),
					PublicBandwidth:    pulumi.Float64(20000),
					RedundantNetwork:   pulumi.Bool(false),
					Tags: pulumi.StringArray{
						pulumi.String("gateway tags 1"),
						pulumi.String("terraform test tags 1"),
					},
					TcpMonitoring: pulumi.Bool(true),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var gateway = new Ibm.NetworkGateway("gateway", new()
    {
        Members = new[]
        {
            new Ibm.Inputs.NetworkGatewayMemberArgs
            {
                Datacenter = "ams01",
                DiskKeyNames = new[]
                {
                    "HARD_DRIVE_2_00TB_SATA_II",
                },
                Domain = "ibm.com",
                Hostname = "host-name-1",
                Ipv6Enabled = true,
                Memory = 8,
                NetworkSpeed = 100,
                Notes = "gateway notes",
                OsKeyName = "OS_VYATTA_5600_5_X_UP_TO_1GBPS_SUBSCRIPTION_EDITION_64_BIT",
                PrivateNetworkOnly = false,
                ProcessKeyName = "INTEL_SINGLE_XEON_1270_3_50",
                PublicBandwidth = 20000,
                RedundantNetwork = false,
                Tags = new[]
                {
                    "gateway tags",
                    "terraform test tags 1",
                },
                TcpMonitoring = true,
            },
            new Ibm.Inputs.NetworkGatewayMemberArgs
            {
                Datacenter = "ams01",
                DiskKeyNames = new[]
                {
                    "HARD_DRIVE_2_00TB_SATA_II",
                },
                Domain = "ibm.com",
                Hostname = "host-name-2",
                Ipv6Enabled = true,
                Memory = 8,
                NetworkSpeed = 100,
                Notes = "my ha mode gateway",
                OsKeyName = "OS_VYATTA_5600_5_X_UP_TO_1GBPS_SUBSCRIPTION_EDITION_64_BIT",
                PrivateNetworkOnly = false,
                ProcessKeyName = "INTEL_SINGLE_XEON_1270_3_50",
                PublicBandwidth = 20000,
                RedundantNetwork = false,
                Tags = new[]
                {
                    "gateway tags 1",
                    "terraform test tags 1",
                },
                TcpMonitoring = true,
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.NetworkGateway;
import com.pulumi.ibm.NetworkGatewayArgs;
import com.pulumi.ibm.inputs.NetworkGatewayMemberArgs;
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 gateway = new NetworkGateway("gateway", NetworkGatewayArgs.builder()
            .members(            
                NetworkGatewayMemberArgs.builder()
                    .datacenter("ams01")
                    .diskKeyNames("HARD_DRIVE_2_00TB_SATA_II")
                    .domain("ibm.com")
                    .hostname("host-name-1")
                    .ipv6Enabled(true)
                    .memory(8)
                    .networkSpeed(100)
                    .notes("gateway notes")
                    .osKeyName("OS_VYATTA_5600_5_X_UP_TO_1GBPS_SUBSCRIPTION_EDITION_64_BIT")
                    .privateNetworkOnly(false)
                    .processKeyName("INTEL_SINGLE_XEON_1270_3_50")
                    .publicBandwidth(20000)
                    .redundantNetwork(false)
                    .tags(                    
                        "gateway tags",
                        "terraform test tags 1")
                    .tcpMonitoring(true)
                    .build(),
                NetworkGatewayMemberArgs.builder()
                    .datacenter("ams01")
                    .diskKeyNames("HARD_DRIVE_2_00TB_SATA_II")
                    .domain("ibm.com")
                    .hostname("host-name-2")
                    .ipv6Enabled(true)
                    .memory(8)
                    .networkSpeed(100)
                    .notes("my ha mode gateway")
                    .osKeyName("OS_VYATTA_5600_5_X_UP_TO_1GBPS_SUBSCRIPTION_EDITION_64_BIT")
                    .privateNetworkOnly(false)
                    .processKeyName("INTEL_SINGLE_XEON_1270_3_50")
                    .publicBandwidth(20000)
                    .redundantNetwork(false)
                    .tags(                    
                        "gateway tags 1",
                        "terraform test tags 1")
                    .tcpMonitoring(true)
                    .build())
            .build());

    }
}
Copy
resources:
  gateway:
    type: ibm:NetworkGateway
    properties:
      members:
        - datacenter: ams01
          diskKeyNames:
            - HARD_DRIVE_2_00TB_SATA_II
          domain: ibm.com
          hostname: host-name-1
          ipv6Enabled: true
          memory: 8
          networkSpeed: 100
          notes: gateway notes
          osKeyName: OS_VYATTA_5600_5_X_UP_TO_1GBPS_SUBSCRIPTION_EDITION_64_BIT
          privateNetworkOnly: false
          processKeyName: INTEL_SINGLE_XEON_1270_3_50
          publicBandwidth: 20000
          redundantNetwork: false
          tags:
            - gateway tags
            - terraform test tags 1
          tcpMonitoring: true
        - datacenter: ams01
          diskKeyNames:
            - HARD_DRIVE_2_00TB_SATA_II
          domain: ibm.com
          hostname: host-name-2
          ipv6Enabled: true
          memory: 8
          networkSpeed: 100
          notes: my ha mode gateway
          osKeyName: OS_VYATTA_5600_5_X_UP_TO_1GBPS_SUBSCRIPTION_EDITION_64_BIT
          privateNetworkOnly: false
          processKeyName: INTEL_SINGLE_XEON_1270_3_50
          publicBandwidth: 20000
          redundantNetwork: false
          tags:
            - gateway tags 1
            - terraform test tags 1
          tcpMonitoring: true
Copy

Argument reference

Review the argument references that you can specify for your resource.

  • members - (Required, List) A nested block describes the hardware members of this network gateway.

    Nested scheme for members:

    • datacenter - (Required, Forces new resource, String) The data center in which you want to provision the member.

    • disk_key_names - (Optional, Forces new resource, List) Provide the disk key name. Refer to the same attribute in the ibm.ComputeBareMetal resource.

    • domain - (Required, Forces new resource, String) The domain of the member.

    • ipv6_enabled - (Optional, Forces new resource, Bool) Whether to enable IPv6. Default value is true.

    • hostname - (Optional, Forces new resource, String) Hostname of the member.

    • memory - (Required, Forces new resource, Integer) The amount of memory, expressed in megabytes, that you want to allocate.

    • network_speed - (Optional, Forces new resource, Integer) The connection speed (in Mbps) for the member network components. Default value is 100.

    • notes - (Optional, Forces new resource, String) Descriptive text of up to 1000 characters about the member.

    • os_key_name - (Optional, Forces new resource, String) The os key name for member. Default value is OS_VYATTA_5600_5_X_UP_TO_1GBPS_SUBSCRIPTION_EDITION_64_BIT. Refer to the same attribute on the ibm.ComputeBareMetal resource.

    • package_key_name - (Optional, Forces new resource, String) The key name for the network gateway package. You can find available package key names in the SoftLayer API URL https://api.softlayer.com/rest/v3/SoftLayer_Product_Package/getAllObjects?objectFilter={"type":{"keyName":{"operation":"BARE_METAL_GATEWAY"}}} that uses your API key as the password. Default value is NETWORK_GATEWAY_APPLIANCE. The default value will allow order Single processor multi-core Servers. Use 2U_NETWORK_GATEWAY_APPLIANCE_1O_GBPS for ordering Dual processor multi-core Servers.

    • process_key_name - (Optional, Forces new resource, String) The process key name for the member. Default value is INTEL_SINGLE_XEON_1270_3_40_2. Refer to the same attribute on the ibm_compute_bare_metal resource.

    • public_bandwidth - (Optional, Forces new resource, Integer) Allowed public network traffic (in GB) per month. Default value is 20000.

    • private_network_only- (Optional, Forces new resource, Bool) Whether to enable a private network only. Default value is false.

    • post_install_script_uri- (Optional, Forces new resource, String) The URI of the script to be downloaded and executed on the member. Default value is nil.

    • public_vlan_id - (Optional, Forces new resource, Integer)ID of the public VLAN.

    • private_vlan_id - (Optional, Forces new resource, Integer) ID of the private VLAN. Note If there are two members in this gateway, then both should have same value for public_vlan_id and private_vlan_id.

    • redundant_power_supply - (Optional, Forces new resource, Bool) When the value is true, more power supply is provided. Default value is false.

    • redundant_network - (Optional, Forces new resource, Bool) When the value is true, two physical network interfaces are provided with a bonding configuration. Default value is false.

    • storage_groups - (Optional, Forces new resource, List) A nested block describes the storage group for the member of the network gateway. Nested storage_groups blocks have the following structure:

      Nested scheme for storage_groups:

      • array_type_id - (Required, Integer) The ID of the array type.
      • array_size - (Optional, Integer)The size of the array.
      • hard_drives- (Required, List) The list of hard disk associated with the gateway member.
      • partition_template_id - (Optional, Integer) The partition template ID for the member.

    • ssh_key_ids - (Optional, Forces new resource, List) The SSH key IDs to install on the member.

    • tags - (Optional, Forces new resource, Set) Tags associated with the VM instance. Permitted characters include: A-Z, 0-9, whitespace, _ (underscore), - (hyphen), . (period), and : (colon). All other characters are removed.

    • tcp_monitoring - (Optional, Forces new resource, Bool) Whether to enable TCP monitoring for the member. Default value is false.

    • unbonded_network - (Optional, Forces new resource, Bool) When the value is true, two physical network interfaces are provided without a bonding configuration. Default value is false.

    • user_metadata - (Optional, Forces new resource, String) Arbitrary data to be made available to the member.

  • name - (Required, String) The name of the gateway.

  • post_install_script_uri - (Optional, Forces new resource, String) The URI of the script to be downloaded and executed after the gateway installation is complete. Default value is nil.

  • ssh_key_ids - (Optional, Forces new resource, List) The SSH key IDs to install on the gateway when the gateway gets created.

Create NetworkGateway Resource

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

Constructor syntax

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

@overload
def NetworkGateway(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   members: Optional[Sequence[NetworkGatewayMemberArgs]] = None,
                   name: Optional[str] = None,
                   network_gateway_id: Optional[str] = None,
                   post_install_script_uri: Optional[str] = None,
                   ssh_key_ids: Optional[Sequence[float]] = None)
func NewNetworkGateway(ctx *Context, name string, args NetworkGatewayArgs, opts ...ResourceOption) (*NetworkGateway, error)
public NetworkGateway(string name, NetworkGatewayArgs args, CustomResourceOptions? opts = null)
public NetworkGateway(String name, NetworkGatewayArgs args)
public NetworkGateway(String name, NetworkGatewayArgs args, CustomResourceOptions options)

type: ibm:NetworkGateway
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. NetworkGatewayArgs
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. NetworkGatewayArgs
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. NetworkGatewayArgs
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. NetworkGatewayArgs
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. NetworkGatewayArgs
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 networkGatewayResource = new Ibm.NetworkGateway("networkGatewayResource", new()
{
    Members = new[]
    {
        new Ibm.Inputs.NetworkGatewayMemberArgs
        {
            Memory = 0,
            Datacenter = "string",
            Domain = "string",
            PrivateNetworkOnly = false,
            ProcessKeyName = "string",
            Ipv6Enabled = false,
            MemberId = 0,
            Hostname = "string",
            NetworkSpeed = 0,
            Notes = "string",
            OsKeyName = "string",
            PackageKeyName = "string",
            PostInstallScriptUri = "string",
            PrivateIpv4Address = "string",
            DiskKeyNames = new[]
            {
                "string",
            },
            PrivateVlanId = 0,
            Ipv6Address = "string",
            PublicBandwidth = 0,
            PublicIpv4Address = "string",
            PublicVlanId = 0,
            RedundantNetwork = false,
            RedundantPowerSupply = false,
            SshKeyIds = new[]
            {
                0,
            },
            StorageGroups = new[]
            {
                new Ibm.Inputs.NetworkGatewayMemberStorageGroupArgs
                {
                    ArrayTypeId = 0,
                    HardDrives = new[]
                    {
                        0,
                    },
                    ArraySize = 0,
                    PartitionTemplateId = 0,
                },
            },
            Tags = new[]
            {
                "string",
            },
            TcpMonitoring = false,
            UnbondedNetwork = false,
            UserMetadata = "string",
        },
    },
    Name = "string",
    NetworkGatewayId = "string",
    PostInstallScriptUri = "string",
    SshKeyIds = new[]
    {
        0,
    },
});
Copy
example, err := ibm.NewNetworkGateway(ctx, "networkGatewayResource", &ibm.NetworkGatewayArgs{
	Members: ibm.NetworkGatewayMemberArray{
		&ibm.NetworkGatewayMemberArgs{
			Memory:               pulumi.Float64(0),
			Datacenter:           pulumi.String("string"),
			Domain:               pulumi.String("string"),
			PrivateNetworkOnly:   pulumi.Bool(false),
			ProcessKeyName:       pulumi.String("string"),
			Ipv6Enabled:          pulumi.Bool(false),
			MemberId:             pulumi.Float64(0),
			Hostname:             pulumi.String("string"),
			NetworkSpeed:         pulumi.Float64(0),
			Notes:                pulumi.String("string"),
			OsKeyName:            pulumi.String("string"),
			PackageKeyName:       pulumi.String("string"),
			PostInstallScriptUri: pulumi.String("string"),
			PrivateIpv4Address:   pulumi.String("string"),
			DiskKeyNames: pulumi.StringArray{
				pulumi.String("string"),
			},
			PrivateVlanId:        pulumi.Float64(0),
			Ipv6Address:          pulumi.String("string"),
			PublicBandwidth:      pulumi.Float64(0),
			PublicIpv4Address:    pulumi.String("string"),
			PublicVlanId:         pulumi.Float64(0),
			RedundantNetwork:     pulumi.Bool(false),
			RedundantPowerSupply: pulumi.Bool(false),
			SshKeyIds: pulumi.Float64Array{
				pulumi.Float64(0),
			},
			StorageGroups: ibm.NetworkGatewayMemberStorageGroupArray{
				&ibm.NetworkGatewayMemberStorageGroupArgs{
					ArrayTypeId: pulumi.Float64(0),
					HardDrives: pulumi.Float64Array{
						pulumi.Float64(0),
					},
					ArraySize:           pulumi.Float64(0),
					PartitionTemplateId: pulumi.Float64(0),
				},
			},
			Tags: pulumi.StringArray{
				pulumi.String("string"),
			},
			TcpMonitoring:   pulumi.Bool(false),
			UnbondedNetwork: pulumi.Bool(false),
			UserMetadata:    pulumi.String("string"),
		},
	},
	Name:                 pulumi.String("string"),
	NetworkGatewayId:     pulumi.String("string"),
	PostInstallScriptUri: pulumi.String("string"),
	SshKeyIds: pulumi.Float64Array{
		pulumi.Float64(0),
	},
})
Copy
var networkGatewayResource = new NetworkGateway("networkGatewayResource", NetworkGatewayArgs.builder()
    .members(NetworkGatewayMemberArgs.builder()
        .memory(0)
        .datacenter("string")
        .domain("string")
        .privateNetworkOnly(false)
        .processKeyName("string")
        .ipv6Enabled(false)
        .memberId(0)
        .hostname("string")
        .networkSpeed(0)
        .notes("string")
        .osKeyName("string")
        .packageKeyName("string")
        .postInstallScriptUri("string")
        .privateIpv4Address("string")
        .diskKeyNames("string")
        .privateVlanId(0)
        .ipv6Address("string")
        .publicBandwidth(0)
        .publicIpv4Address("string")
        .publicVlanId(0)
        .redundantNetwork(false)
        .redundantPowerSupply(false)
        .sshKeyIds(0)
        .storageGroups(NetworkGatewayMemberStorageGroupArgs.builder()
            .arrayTypeId(0)
            .hardDrives(0)
            .arraySize(0)
            .partitionTemplateId(0)
            .build())
        .tags("string")
        .tcpMonitoring(false)
        .unbondedNetwork(false)
        .userMetadata("string")
        .build())
    .name("string")
    .networkGatewayId("string")
    .postInstallScriptUri("string")
    .sshKeyIds(0)
    .build());
Copy
network_gateway_resource = ibm.NetworkGateway("networkGatewayResource",
    members=[{
        "memory": 0,
        "datacenter": "string",
        "domain": "string",
        "private_network_only": False,
        "process_key_name": "string",
        "ipv6_enabled": False,
        "member_id": 0,
        "hostname": "string",
        "network_speed": 0,
        "notes": "string",
        "os_key_name": "string",
        "package_key_name": "string",
        "post_install_script_uri": "string",
        "private_ipv4_address": "string",
        "disk_key_names": ["string"],
        "private_vlan_id": 0,
        "ipv6_address": "string",
        "public_bandwidth": 0,
        "public_ipv4_address": "string",
        "public_vlan_id": 0,
        "redundant_network": False,
        "redundant_power_supply": False,
        "ssh_key_ids": [0],
        "storage_groups": [{
            "array_type_id": 0,
            "hard_drives": [0],
            "array_size": 0,
            "partition_template_id": 0,
        }],
        "tags": ["string"],
        "tcp_monitoring": False,
        "unbonded_network": False,
        "user_metadata": "string",
    }],
    name="string",
    network_gateway_id="string",
    post_install_script_uri="string",
    ssh_key_ids=[0])
Copy
const networkGatewayResource = new ibm.NetworkGateway("networkGatewayResource", {
    members: [{
        memory: 0,
        datacenter: "string",
        domain: "string",
        privateNetworkOnly: false,
        processKeyName: "string",
        ipv6Enabled: false,
        memberId: 0,
        hostname: "string",
        networkSpeed: 0,
        notes: "string",
        osKeyName: "string",
        packageKeyName: "string",
        postInstallScriptUri: "string",
        privateIpv4Address: "string",
        diskKeyNames: ["string"],
        privateVlanId: 0,
        ipv6Address: "string",
        publicBandwidth: 0,
        publicIpv4Address: "string",
        publicVlanId: 0,
        redundantNetwork: false,
        redundantPowerSupply: false,
        sshKeyIds: [0],
        storageGroups: [{
            arrayTypeId: 0,
            hardDrives: [0],
            arraySize: 0,
            partitionTemplateId: 0,
        }],
        tags: ["string"],
        tcpMonitoring: false,
        unbondedNetwork: false,
        userMetadata: "string",
    }],
    name: "string",
    networkGatewayId: "string",
    postInstallScriptUri: "string",
    sshKeyIds: [0],
});
Copy
type: ibm:NetworkGateway
properties:
    members:
        - datacenter: string
          diskKeyNames:
            - string
          domain: string
          hostname: string
          ipv6Address: string
          ipv6Enabled: false
          memberId: 0
          memory: 0
          networkSpeed: 0
          notes: string
          osKeyName: string
          packageKeyName: string
          postInstallScriptUri: string
          privateIpv4Address: string
          privateNetworkOnly: false
          privateVlanId: 0
          processKeyName: string
          publicBandwidth: 0
          publicIpv4Address: string
          publicVlanId: 0
          redundantNetwork: false
          redundantPowerSupply: false
          sshKeyIds:
            - 0
          storageGroups:
            - arraySize: 0
              arrayTypeId: 0
              hardDrives:
                - 0
              partitionTemplateId: 0
          tags:
            - string
          tcpMonitoring: false
          unbondedNetwork: false
          userMetadata: string
    name: string
    networkGatewayId: string
    postInstallScriptUri: string
    sshKeyIds:
        - 0
Copy

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

Members This property is required. List<NetworkGatewayMember>
(List) A nested block describes the hardware members of this network gateway. Nested members blocks export the following attributes.
Name string
The name of the gateway
NetworkGatewayId string
(String) The unique identifier of the network gateway.
PostInstallScriptUri string
SshKeyIds List<double>
Members This property is required. []NetworkGatewayMemberArgs
(List) A nested block describes the hardware members of this network gateway. Nested members blocks export the following attributes.
Name string
The name of the gateway
NetworkGatewayId string
(String) The unique identifier of the network gateway.
PostInstallScriptUri string
SshKeyIds []float64
members This property is required. List<NetworkGatewayMember>
(List) A nested block describes the hardware members of this network gateway. Nested members blocks export the following attributes.
name String
The name of the gateway
networkGatewayId String
(String) The unique identifier of the network gateway.
postInstallScriptUri String
sshKeyIds List<Double>
members This property is required. NetworkGatewayMember[]
(List) A nested block describes the hardware members of this network gateway. Nested members blocks export the following attributes.
name string
The name of the gateway
networkGatewayId string
(String) The unique identifier of the network gateway.
postInstallScriptUri string
sshKeyIds number[]
members This property is required. Sequence[NetworkGatewayMemberArgs]
(List) A nested block describes the hardware members of this network gateway. Nested members blocks export the following attributes.
name str
The name of the gateway
network_gateway_id str
(String) The unique identifier of the network gateway.
post_install_script_uri str
ssh_key_ids Sequence[float]
members This property is required. List<Property Map>
(List) A nested block describes the hardware members of this network gateway. Nested members blocks export the following attributes.
name String
The name of the gateway
networkGatewayId String
(String) The unique identifier of the network gateway.
postInstallScriptUri String
sshKeyIds List<Number>

Outputs

All input properties are implicitly available as output properties. Additionally, the NetworkGateway resource produces the following output properties:

AssociatedVlans List<NetworkGatewayAssociatedVlan>
(List) A nested block describes the associated VLANs for the member of the network gateway. Nested associated_vlans blocks export the following attributes.
Id string
The provider-assigned unique ID for this managed resource.
PrivateIpAddressId double
(String) The private IP address ID of the network gateway.
PrivateIpv4Address string
(String) The private IP address of the network gateway.
PrivateVlanId double
(String) The private VLAN ID of the network gateway.
PublicIpAddressId double
(String) The public IP address ID of the network gateway.
PublicIpv4Address string
(String) The public IP address of the network gateway.
PublicIpv6AddressId double
(String) The public IPv6 address ID for the network gateway.
PublicVlanId double
(String) The public VLAN ID for the network gateway.
Status string
(String) Status of the network gateway.
AssociatedVlans []NetworkGatewayAssociatedVlan
(List) A nested block describes the associated VLANs for the member of the network gateway. Nested associated_vlans blocks export the following attributes.
Id string
The provider-assigned unique ID for this managed resource.
PrivateIpAddressId float64
(String) The private IP address ID of the network gateway.
PrivateIpv4Address string
(String) The private IP address of the network gateway.
PrivateVlanId float64
(String) The private VLAN ID of the network gateway.
PublicIpAddressId float64
(String) The public IP address ID of the network gateway.
PublicIpv4Address string
(String) The public IP address of the network gateway.
PublicIpv6AddressId float64
(String) The public IPv6 address ID for the network gateway.
PublicVlanId float64
(String) The public VLAN ID for the network gateway.
Status string
(String) Status of the network gateway.
associatedVlans List<NetworkGatewayAssociatedVlan>
(List) A nested block describes the associated VLANs for the member of the network gateway. Nested associated_vlans blocks export the following attributes.
id String
The provider-assigned unique ID for this managed resource.
privateIpAddressId Double
(String) The private IP address ID of the network gateway.
privateIpv4Address String
(String) The private IP address of the network gateway.
privateVlanId Double
(String) The private VLAN ID of the network gateway.
publicIpAddressId Double
(String) The public IP address ID of the network gateway.
publicIpv4Address String
(String) The public IP address of the network gateway.
publicIpv6AddressId Double
(String) The public IPv6 address ID for the network gateway.
publicVlanId Double
(String) The public VLAN ID for the network gateway.
status String
(String) Status of the network gateway.
associatedVlans NetworkGatewayAssociatedVlan[]
(List) A nested block describes the associated VLANs for the member of the network gateway. Nested associated_vlans blocks export the following attributes.
id string
The provider-assigned unique ID for this managed resource.
privateIpAddressId number
(String) The private IP address ID of the network gateway.
privateIpv4Address string
(String) The private IP address of the network gateway.
privateVlanId number
(String) The private VLAN ID of the network gateway.
publicIpAddressId number
(String) The public IP address ID of the network gateway.
publicIpv4Address string
(String) The public IP address of the network gateway.
publicIpv6AddressId number
(String) The public IPv6 address ID for the network gateway.
publicVlanId number
(String) The public VLAN ID for the network gateway.
status string
(String) Status of the network gateway.
associated_vlans Sequence[NetworkGatewayAssociatedVlan]
(List) A nested block describes the associated VLANs for the member of the network gateway. Nested associated_vlans blocks export the following attributes.
id str
The provider-assigned unique ID for this managed resource.
private_ip_address_id float
(String) The private IP address ID of the network gateway.
private_ipv4_address str
(String) The private IP address of the network gateway.
private_vlan_id float
(String) The private VLAN ID of the network gateway.
public_ip_address_id float
(String) The public IP address ID of the network gateway.
public_ipv4_address str
(String) The public IP address of the network gateway.
public_ipv6_address_id float
(String) The public IPv6 address ID for the network gateway.
public_vlan_id float
(String) The public VLAN ID for the network gateway.
status str
(String) Status of the network gateway.
associatedVlans List<Property Map>
(List) A nested block describes the associated VLANs for the member of the network gateway. Nested associated_vlans blocks export the following attributes.
id String
The provider-assigned unique ID for this managed resource.
privateIpAddressId Number
(String) The private IP address ID of the network gateway.
privateIpv4Address String
(String) The private IP address of the network gateway.
privateVlanId Number
(String) The private VLAN ID of the network gateway.
publicIpAddressId Number
(String) The public IP address ID of the network gateway.
publicIpv4Address String
(String) The public IP address of the network gateway.
publicIpv6AddressId Number
(String) The public IPv6 address ID for the network gateway.
publicVlanId Number
(String) The public VLAN ID for the network gateway.
status String
(String) Status of the network gateway.

Look up Existing NetworkGateway Resource

Get an existing NetworkGateway 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?: NetworkGatewayState, opts?: CustomResourceOptions): NetworkGateway
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        associated_vlans: Optional[Sequence[NetworkGatewayAssociatedVlanArgs]] = None,
        members: Optional[Sequence[NetworkGatewayMemberArgs]] = None,
        name: Optional[str] = None,
        network_gateway_id: Optional[str] = None,
        post_install_script_uri: Optional[str] = None,
        private_ip_address_id: Optional[float] = None,
        private_ipv4_address: Optional[str] = None,
        private_vlan_id: Optional[float] = None,
        public_ip_address_id: Optional[float] = None,
        public_ipv4_address: Optional[str] = None,
        public_ipv6_address_id: Optional[float] = None,
        public_vlan_id: Optional[float] = None,
        ssh_key_ids: Optional[Sequence[float]] = None,
        status: Optional[str] = None) -> NetworkGateway
func GetNetworkGateway(ctx *Context, name string, id IDInput, state *NetworkGatewayState, opts ...ResourceOption) (*NetworkGateway, error)
public static NetworkGateway Get(string name, Input<string> id, NetworkGatewayState? state, CustomResourceOptions? opts = null)
public static NetworkGateway get(String name, Output<String> id, NetworkGatewayState state, CustomResourceOptions options)
resources:  _:    type: ibm:NetworkGateway    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:
AssociatedVlans List<NetworkGatewayAssociatedVlan>
(List) A nested block describes the associated VLANs for the member of the network gateway. Nested associated_vlans blocks export the following attributes.
Members List<NetworkGatewayMember>
(List) A nested block describes the hardware members of this network gateway. Nested members blocks export the following attributes.
Name string
The name of the gateway
NetworkGatewayId string
(String) The unique identifier of the network gateway.
PostInstallScriptUri string
PrivateIpAddressId double
(String) The private IP address ID of the network gateway.
PrivateIpv4Address string
(String) The private IP address of the network gateway.
PrivateVlanId double
(String) The private VLAN ID of the network gateway.
PublicIpAddressId double
(String) The public IP address ID of the network gateway.
PublicIpv4Address string
(String) The public IP address of the network gateway.
PublicIpv6AddressId double
(String) The public IPv6 address ID for the network gateway.
PublicVlanId double
(String) The public VLAN ID for the network gateway.
SshKeyIds List<double>
Status string
(String) Status of the network gateway.
AssociatedVlans []NetworkGatewayAssociatedVlanArgs
(List) A nested block describes the associated VLANs for the member of the network gateway. Nested associated_vlans blocks export the following attributes.
Members []NetworkGatewayMemberArgs
(List) A nested block describes the hardware members of this network gateway. Nested members blocks export the following attributes.
Name string
The name of the gateway
NetworkGatewayId string
(String) The unique identifier of the network gateway.
PostInstallScriptUri string
PrivateIpAddressId float64
(String) The private IP address ID of the network gateway.
PrivateIpv4Address string
(String) The private IP address of the network gateway.
PrivateVlanId float64
(String) The private VLAN ID of the network gateway.
PublicIpAddressId float64
(String) The public IP address ID of the network gateway.
PublicIpv4Address string
(String) The public IP address of the network gateway.
PublicIpv6AddressId float64
(String) The public IPv6 address ID for the network gateway.
PublicVlanId float64
(String) The public VLAN ID for the network gateway.
SshKeyIds []float64
Status string
(String) Status of the network gateway.
associatedVlans List<NetworkGatewayAssociatedVlan>
(List) A nested block describes the associated VLANs for the member of the network gateway. Nested associated_vlans blocks export the following attributes.
members List<NetworkGatewayMember>
(List) A nested block describes the hardware members of this network gateway. Nested members blocks export the following attributes.
name String
The name of the gateway
networkGatewayId String
(String) The unique identifier of the network gateway.
postInstallScriptUri String
privateIpAddressId Double
(String) The private IP address ID of the network gateway.
privateIpv4Address String
(String) The private IP address of the network gateway.
privateVlanId Double
(String) The private VLAN ID of the network gateway.
publicIpAddressId Double
(String) The public IP address ID of the network gateway.
publicIpv4Address String
(String) The public IP address of the network gateway.
publicIpv6AddressId Double
(String) The public IPv6 address ID for the network gateway.
publicVlanId Double
(String) The public VLAN ID for the network gateway.
sshKeyIds List<Double>
status String
(String) Status of the network gateway.
associatedVlans NetworkGatewayAssociatedVlan[]
(List) A nested block describes the associated VLANs for the member of the network gateway. Nested associated_vlans blocks export the following attributes.
members NetworkGatewayMember[]
(List) A nested block describes the hardware members of this network gateway. Nested members blocks export the following attributes.
name string
The name of the gateway
networkGatewayId string
(String) The unique identifier of the network gateway.
postInstallScriptUri string
privateIpAddressId number
(String) The private IP address ID of the network gateway.
privateIpv4Address string
(String) The private IP address of the network gateway.
privateVlanId number
(String) The private VLAN ID of the network gateway.
publicIpAddressId number
(String) The public IP address ID of the network gateway.
publicIpv4Address string
(String) The public IP address of the network gateway.
publicIpv6AddressId number
(String) The public IPv6 address ID for the network gateway.
publicVlanId number
(String) The public VLAN ID for the network gateway.
sshKeyIds number[]
status string
(String) Status of the network gateway.
associated_vlans Sequence[NetworkGatewayAssociatedVlanArgs]
(List) A nested block describes the associated VLANs for the member of the network gateway. Nested associated_vlans blocks export the following attributes.
members Sequence[NetworkGatewayMemberArgs]
(List) A nested block describes the hardware members of this network gateway. Nested members blocks export the following attributes.
name str
The name of the gateway
network_gateway_id str
(String) The unique identifier of the network gateway.
post_install_script_uri str
private_ip_address_id float
(String) The private IP address ID of the network gateway.
private_ipv4_address str
(String) The private IP address of the network gateway.
private_vlan_id float
(String) The private VLAN ID of the network gateway.
public_ip_address_id float
(String) The public IP address ID of the network gateway.
public_ipv4_address str
(String) The public IP address of the network gateway.
public_ipv6_address_id float
(String) The public IPv6 address ID for the network gateway.
public_vlan_id float
(String) The public VLAN ID for the network gateway.
ssh_key_ids Sequence[float]
status str
(String) Status of the network gateway.
associatedVlans List<Property Map>
(List) A nested block describes the associated VLANs for the member of the network gateway. Nested associated_vlans blocks export the following attributes.
members List<Property Map>
(List) A nested block describes the hardware members of this network gateway. Nested members blocks export the following attributes.
name String
The name of the gateway
networkGatewayId String
(String) The unique identifier of the network gateway.
postInstallScriptUri String
privateIpAddressId Number
(String) The private IP address ID of the network gateway.
privateIpv4Address String
(String) The private IP address of the network gateway.
privateVlanId Number
(String) The private VLAN ID of the network gateway.
publicIpAddressId Number
(String) The public IP address ID of the network gateway.
publicIpv4Address String
(String) The public IP address of the network gateway.
publicIpv6AddressId Number
(String) The public IPv6 address ID for the network gateway.
publicVlanId Number
(String) The public VLAN ID for the network gateway.
sshKeyIds List<Number>
status String
(String) Status of the network gateway.

Supporting Types

NetworkGatewayAssociatedVlan
, NetworkGatewayAssociatedVlanArgs

Bypass This property is required. bool
(String) Indicates if the VLAN is in bypass or routed mode.
NetworkVlanId This property is required. double
(String) The ID of the VLAN that is associated.
VlanId This property is required. double
(String) The VLAN ID.
Bypass This property is required. bool
(String) Indicates if the VLAN is in bypass or routed mode.
NetworkVlanId This property is required. float64
(String) The ID of the VLAN that is associated.
VlanId This property is required. float64
(String) The VLAN ID.
bypass This property is required. Boolean
(String) Indicates if the VLAN is in bypass or routed mode.
networkVlanId This property is required. Double
(String) The ID of the VLAN that is associated.
vlanId This property is required. Double
(String) The VLAN ID.
bypass This property is required. boolean
(String) Indicates if the VLAN is in bypass or routed mode.
networkVlanId This property is required. number
(String) The ID of the VLAN that is associated.
vlanId This property is required. number
(String) The VLAN ID.
bypass This property is required. bool
(String) Indicates if the VLAN is in bypass or routed mode.
network_vlan_id This property is required. float
(String) The ID of the VLAN that is associated.
vlan_id This property is required. float
(String) The VLAN ID.
bypass This property is required. Boolean
(String) Indicates if the VLAN is in bypass or routed mode.
networkVlanId This property is required. Number
(String) The ID of the VLAN that is associated.
vlanId This property is required. Number
(String) The VLAN ID.

NetworkGatewayMember
, NetworkGatewayMemberArgs

Datacenter This property is required. string
Domain This property is required. string
Memory This property is required. double
DiskKeyNames List<string>
Hostname string
Ipv6Address string
(String) IPv6 address associated with the member.
Ipv6Enabled bool
MemberId double
(String) ID of the member.
NetworkSpeed double
Notes string
OsKeyName string
PackageKeyName string
PostInstallScriptUri string
PrivateIpv4Address string
(String) The private IP address of the network gateway.
PrivateNetworkOnly bool
PrivateVlanId double
(String) The private VLAN ID of the network gateway.
ProcessKeyName string
PublicBandwidth double
PublicIpv4Address string
(String) The public IP address of the network gateway.
PublicVlanId double
(String) The public VLAN ID for the network gateway.
RedundantNetwork bool
RedundantPowerSupply bool
SshKeyIds List<double>
StorageGroups List<NetworkGatewayMemberStorageGroup>
Tags List<string>
TcpMonitoring bool
UnbondedNetwork bool
UserMetadata string
Datacenter This property is required. string
Domain This property is required. string
Memory This property is required. float64
DiskKeyNames []string
Hostname string
Ipv6Address string
(String) IPv6 address associated with the member.
Ipv6Enabled bool
MemberId float64
(String) ID of the member.
NetworkSpeed float64
Notes string
OsKeyName string
PackageKeyName string
PostInstallScriptUri string
PrivateIpv4Address string
(String) The private IP address of the network gateway.
PrivateNetworkOnly bool
PrivateVlanId float64
(String) The private VLAN ID of the network gateway.
ProcessKeyName string
PublicBandwidth float64
PublicIpv4Address string
(String) The public IP address of the network gateway.
PublicVlanId float64
(String) The public VLAN ID for the network gateway.
RedundantNetwork bool
RedundantPowerSupply bool
SshKeyIds []float64
StorageGroups []NetworkGatewayMemberStorageGroup
Tags []string
TcpMonitoring bool
UnbondedNetwork bool
UserMetadata string
datacenter This property is required. String
domain This property is required. String
memory This property is required. Double
diskKeyNames List<String>
hostname String
ipv6Address String
(String) IPv6 address associated with the member.
ipv6Enabled Boolean
memberId Double
(String) ID of the member.
networkSpeed Double
notes String
osKeyName String
packageKeyName String
postInstallScriptUri String
privateIpv4Address String
(String) The private IP address of the network gateway.
privateNetworkOnly Boolean
privateVlanId Double
(String) The private VLAN ID of the network gateway.
processKeyName String
publicBandwidth Double
publicIpv4Address String
(String) The public IP address of the network gateway.
publicVlanId Double
(String) The public VLAN ID for the network gateway.
redundantNetwork Boolean
redundantPowerSupply Boolean
sshKeyIds List<Double>
storageGroups List<NetworkGatewayMemberStorageGroup>
tags List<String>
tcpMonitoring Boolean
unbondedNetwork Boolean
userMetadata String
datacenter This property is required. string
domain This property is required. string
memory This property is required. number
diskKeyNames string[]
hostname string
ipv6Address string
(String) IPv6 address associated with the member.
ipv6Enabled boolean
memberId number
(String) ID of the member.
networkSpeed number
notes string
osKeyName string
packageKeyName string
postInstallScriptUri string
privateIpv4Address string
(String) The private IP address of the network gateway.
privateNetworkOnly boolean
privateVlanId number
(String) The private VLAN ID of the network gateway.
processKeyName string
publicBandwidth number
publicIpv4Address string
(String) The public IP address of the network gateway.
publicVlanId number
(String) The public VLAN ID for the network gateway.
redundantNetwork boolean
redundantPowerSupply boolean
sshKeyIds number[]
storageGroups NetworkGatewayMemberStorageGroup[]
tags string[]
tcpMonitoring boolean
unbondedNetwork boolean
userMetadata string
datacenter This property is required. str
domain This property is required. str
memory This property is required. float
disk_key_names Sequence[str]
hostname str
ipv6_address str
(String) IPv6 address associated with the member.
ipv6_enabled bool
member_id float
(String) ID of the member.
network_speed float
notes str
os_key_name str
package_key_name str
post_install_script_uri str
private_ipv4_address str
(String) The private IP address of the network gateway.
private_network_only bool
private_vlan_id float
(String) The private VLAN ID of the network gateway.
process_key_name str
public_bandwidth float
public_ipv4_address str
(String) The public IP address of the network gateway.
public_vlan_id float
(String) The public VLAN ID for the network gateway.
redundant_network bool
redundant_power_supply bool
ssh_key_ids Sequence[float]
storage_groups Sequence[NetworkGatewayMemberStorageGroup]
tags Sequence[str]
tcp_monitoring bool
unbonded_network bool
user_metadata str
datacenter This property is required. String
domain This property is required. String
memory This property is required. Number
diskKeyNames List<String>
hostname String
ipv6Address String
(String) IPv6 address associated with the member.
ipv6Enabled Boolean
memberId Number
(String) ID of the member.
networkSpeed Number
notes String
osKeyName String
packageKeyName String
postInstallScriptUri String
privateIpv4Address String
(String) The private IP address of the network gateway.
privateNetworkOnly Boolean
privateVlanId Number
(String) The private VLAN ID of the network gateway.
processKeyName String
publicBandwidth Number
publicIpv4Address String
(String) The public IP address of the network gateway.
publicVlanId Number
(String) The public VLAN ID for the network gateway.
redundantNetwork Boolean
redundantPowerSupply Boolean
sshKeyIds List<Number>
storageGroups List<Property Map>
tags List<String>
tcpMonitoring Boolean
unbondedNetwork Boolean
userMetadata String

NetworkGatewayMemberStorageGroup
, NetworkGatewayMemberStorageGroupArgs

ArrayTypeId This property is required. double
HardDrives This property is required. List<double>
ArraySize double
PartitionTemplateId double
ArrayTypeId This property is required. float64
HardDrives This property is required. []float64
ArraySize float64
PartitionTemplateId float64
arrayTypeId This property is required. Double
hardDrives This property is required. List<Double>
arraySize Double
partitionTemplateId Double
arrayTypeId This property is required. number
hardDrives This property is required. number[]
arraySize number
partitionTemplateId number
array_type_id This property is required. float
hard_drives This property is required. Sequence[float]
array_size float
partition_template_id float
arrayTypeId This property is required. Number
hardDrives This property is required. List<Number>
arraySize Number
partitionTemplateId Number

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm