Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud
published on Friday, Jul 17, 2026 by OVHcloud
Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud
published on Friday, Jul 17, 2026 by OVHcloud
Use this data source to list the gateways of a public cloud project.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@ovhcloud/pulumi-ovh";
const gateways = ovh.getCloudGateways({
serviceName: "<public cloud project ID>",
});
export const gatewayNames = gateways.then(gateways => .map(g => (g.name)));
import pulumi
import pulumi_ovh as ovh
gateways = ovh.get_cloud_gateways(service_name="<public cloud project ID>")
pulumi.export("gatewayNames", [g.name for g in gateways.gateways])
Example coming soon!
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ovh = Pulumi.Ovh;
return await Deployment.RunAsync(() =>
{
var gateways = Ovh.GetCloudGateways.Invoke(new()
{
ServiceName = "<public cloud project ID>",
});
return new Dictionary<string, object?>
{
["gatewayNames"] = .Select(g =>
{
return g.Name;
}).ToList(),
};
});
Example coming soon!
Example coming soon!
Example coming soon!
Using getCloudGateways
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 getCloudGateways(args: GetCloudGatewaysArgs, opts?: InvokeOptions): Promise<GetCloudGatewaysResult>
function getCloudGatewaysOutput(args: GetCloudGatewaysOutputArgs, opts?: InvokeOptions): Output<GetCloudGatewaysResult>def get_cloud_gateways(service_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCloudGatewaysResult
def get_cloud_gateways_output(service_name: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCloudGatewaysResult]func GetCloudGateways(ctx *Context, args *GetCloudGatewaysArgs, opts ...InvokeOption) (*GetCloudGatewaysResult, error)
func GetCloudGatewaysOutput(ctx *Context, args *GetCloudGatewaysOutputArgs, opts ...InvokeOption) GetCloudGatewaysResultOutput> Note: This function is named GetCloudGateways in the Go SDK.
public static class GetCloudGateways
{
public static Task<GetCloudGatewaysResult> InvokeAsync(GetCloudGatewaysArgs args, InvokeOptions? opts = null)
public static Output<GetCloudGatewaysResult> Invoke(GetCloudGatewaysInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetCloudGatewaysResult> getCloudGateways(GetCloudGatewaysArgs args, InvokeOptions options)
public static Output<GetCloudGatewaysResult> getCloudGateways(GetCloudGatewaysArgs args, InvokeOptions options)
fn::invoke:
function: ovh:index/getCloudGateways:getCloudGateways
arguments:
# arguments dictionarydata "ovh_get_cloud_gateways" "name" {
# arguments
}The following arguments are supported:
- Service
Name string - Service name of the resource representing the id of the cloud project.
- Service
Name string - Service name of the resource representing the id of the cloud project.
- service_
name string - Service name of the resource representing the id of the cloud project.
- service
Name String - Service name of the resource representing the id of the cloud project.
- service
Name string - Service name of the resource representing the id of the cloud project.
- service_
name str - Service name of the resource representing the id of the cloud project.
- service
Name String - Service name of the resource representing the id of the cloud project.
getCloudGateways Result
The following output properties are available:
- Gateways
List<Get
Cloud Gateways Gateway> - List of gateways. Each element exports:
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Name string
- Gateways
[]Get
Cloud Gateways Gateway - List of gateways. Each element exports:
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Name string
- gateways list(object)
- List of gateways. Each element exports:
- id string
- The provider-assigned unique ID for this managed resource.
- service_
name string
- gateways
List<Get
Cloud Gateways Gateway> - List of gateways. Each element exports:
- id String
- The provider-assigned unique ID for this managed resource.
- service
Name String
- gateways
Get
Cloud Gateways Gateway[] - List of gateways. Each element exports:
- id string
- The provider-assigned unique ID for this managed resource.
- service
Name string
- gateways
Sequence[Get
Cloud Gateways Gateway] - List of gateways. Each element exports:
- id str
- The provider-assigned unique ID for this managed resource.
- service_
name str
- gateways List<Property Map>
- List of gateways. Each element exports:
- id String
- The provider-assigned unique ID for this managed resource.
- service
Name String
Supporting Types
GetCloudGatewaysGateway
- Checksum string
- Computed hash representing the current target specification value.
- Created
At string - Creation date of the gateway.
- Current
State GetCloud Gateways Gateway Current State - Current state of the gateway:
- Description string
- Gateway description.
- External
Gateway GetCloud Gateways Gateway External Gateway - External gateway configuration:
- Id string
- Subnet ID.
- Location
Get
Cloud Gateways Gateway Location - Location details:
- Name string
- Gateway name.
- Resource
Status string - Gateway readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - Updated
At string - Last update date of the gateway.
- Checksum string
- Computed hash representing the current target specification value.
- Created
At string - Creation date of the gateway.
- Current
State GetCloud Gateways Gateway Current State - Current state of the gateway:
- Description string
- Gateway description.
- External
Gateway GetCloud Gateways Gateway External Gateway - External gateway configuration:
- Id string
- Subnet ID.
- Location
Get
Cloud Gateways Gateway Location - Location details:
- Name string
- Gateway name.
- Resource
Status string - Gateway readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - Updated
At string - Last update date of the gateway.
- checksum string
- Computed hash representing the current target specification value.
- created_
at string - Creation date of the gateway.
- current_
state object - Current state of the gateway:
- description string
- Gateway description.
- external_
gateway object - External gateway configuration:
- id string
- Subnet ID.
- location object
- Location details:
- name string
- Gateway name.
- resource_
status string - Gateway readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - updated_
at string - Last update date of the gateway.
- checksum String
- Computed hash representing the current target specification value.
- created
At String - Creation date of the gateway.
- current
State GetCloud Gateways Gateway Current State - Current state of the gateway:
- description String
- Gateway description.
- external
Gateway GetCloud Gateways Gateway External Gateway - External gateway configuration:
- id String
- Subnet ID.
- location
Get
Cloud Gateways Gateway Location - Location details:
- name String
- Gateway name.
- resource
Status String - Gateway readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - updated
At String - Last update date of the gateway.
- checksum string
- Computed hash representing the current target specification value.
- created
At string - Creation date of the gateway.
- current
State GetCloud Gateways Gateway Current State - Current state of the gateway:
- description string
- Gateway description.
- external
Gateway GetCloud Gateways Gateway External Gateway - External gateway configuration:
- id string
- Subnet ID.
- location
Get
Cloud Gateways Gateway Location - Location details:
- name string
- Gateway name.
- resource
Status string - Gateway readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - updated
At string - Last update date of the gateway.
- checksum str
- Computed hash representing the current target specification value.
- created_
at str - Creation date of the gateway.
- current_
state GetCloud Gateways Gateway Current State - Current state of the gateway:
- description str
- Gateway description.
- external_
gateway GetCloud Gateways Gateway External Gateway - External gateway configuration:
- id str
- Subnet ID.
- location
Get
Cloud Gateways Gateway Location - Location details:
- name str
- Gateway name.
- resource_
status str - Gateway readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - updated_
at str - Last update date of the gateway.
- checksum String
- Computed hash representing the current target specification value.
- created
At String - Creation date of the gateway.
- current
State Property Map - Current state of the gateway:
- description String
- Gateway description.
- external
Gateway Property Map - External gateway configuration:
- id String
- Subnet ID.
- location Property Map
- Location details:
- name String
- Gateway name.
- resource
Status String - Gateway readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UPDATING). - updated
At String - Last update date of the gateway.
GetCloudGatewaysGatewayCurrentState
- Description string
- Gateway description.
- External
Gateway GetCloud Gateways Gateway Current State External Gateway - External gateway configuration:
- External
Ip string - External IP address assigned to the gateway.
- Location
Get
Cloud Gateways Gateway Current State Location - Location details:
- Name string
- Gateway name.
- Status string
- OpenStack router status (
ACTIVE,BUILD,DOWN,ERROR). - Subnets
List<Get
Cloud Gateways Gateway Current State Subnet> - Currently attached subnets:
- Description string
- Gateway description.
- External
Gateway GetCloud Gateways Gateway Current State External Gateway - External gateway configuration:
- External
Ip string - External IP address assigned to the gateway.
- Location
Get
Cloud Gateways Gateway Current State Location - Location details:
- Name string
- Gateway name.
- Status string
- OpenStack router status (
ACTIVE,BUILD,DOWN,ERROR). - Subnets
[]Get
Cloud Gateways Gateway Current State Subnet - Currently attached subnets:
- description string
- Gateway description.
- external_
gateway object - External gateway configuration:
- external_
ip string - External IP address assigned to the gateway.
- location object
- Location details:
- name string
- Gateway name.
- status string
- OpenStack router status (
ACTIVE,BUILD,DOWN,ERROR). - subnets list(object)
- Currently attached subnets:
- description String
- Gateway description.
- external
Gateway GetCloud Gateways Gateway Current State External Gateway - External gateway configuration:
- external
Ip String - External IP address assigned to the gateway.
- location
Get
Cloud Gateways Gateway Current State Location - Location details:
- name String
- Gateway name.
- status String
- OpenStack router status (
ACTIVE,BUILD,DOWN,ERROR). - subnets
List<Get
Cloud Gateways Gateway Current State Subnet> - Currently attached subnets:
- description string
- Gateway description.
- external
Gateway GetCloud Gateways Gateway Current State External Gateway - External gateway configuration:
- external
Ip string - External IP address assigned to the gateway.
- location
Get
Cloud Gateways Gateway Current State Location - Location details:
- name string
- Gateway name.
- status string
- OpenStack router status (
ACTIVE,BUILD,DOWN,ERROR). - subnets
Get
Cloud Gateways Gateway Current State Subnet[] - Currently attached subnets:
- description str
- Gateway description.
- external_
gateway GetCloud Gateways Gateway Current State External Gateway - External gateway configuration:
- external_
ip str - External IP address assigned to the gateway.
- location
Get
Cloud Gateways Gateway Current State Location - Location details:
- name str
- Gateway name.
- status str
- OpenStack router status (
ACTIVE,BUILD,DOWN,ERROR). - subnets
Sequence[Get
Cloud Gateways Gateway Current State Subnet] - Currently attached subnets:
- description String
- Gateway description.
- external
Gateway Property Map - External gateway configuration:
- external
Ip String - External IP address assigned to the gateway.
- location Property Map
- Location details:
- name String
- Gateway name.
- status String
- OpenStack router status (
ACTIVE,BUILD,DOWN,ERROR). - subnets List<Property Map>
- Currently attached subnets:
GetCloudGatewaysGatewayCurrentStateExternalGateway
GetCloudGatewaysGatewayCurrentStateLocation
- Availability
Zone string - Availability zone.
- Region string
- Region.
- Availability
Zone string - Availability zone.
- Region string
- Region.
- availability_
zone string - Availability zone.
- region string
- Region.
- availability
Zone String - Availability zone.
- region String
- Region.
- availability
Zone string - Availability zone.
- region string
- Region.
- availability_
zone str - Availability zone.
- region str
- Region.
- availability
Zone String - Availability zone.
- region String
- Region.
GetCloudGatewaysGatewayCurrentStateSubnet
- Id string
- Subnet ID.
- Id string
- Subnet ID.
- id string
- Subnet ID.
- id String
- Subnet ID.
- id string
- Subnet ID.
- id str
- Subnet ID.
- id String
- Subnet ID.
GetCloudGatewaysGatewayExternalGateway
GetCloudGatewaysGatewayLocation
- Availability
Zone string - Availability zone.
- Region string
- Region.
- Availability
Zone string - Availability zone.
- Region string
- Region.
- availability_
zone string - Availability zone.
- region string
- Region.
- availability
Zone String - Availability zone.
- region String
- Region.
- availability
Zone string - Availability zone.
- region string
- Region.
- availability_
zone str - Availability zone.
- region str
- Region.
- availability
Zone String - Availability zone.
- region String
- Region.
Package Details
- Repository
- ovh ovh/pulumi-ovh
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ovhTerraform Provider.
Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud
published on Friday, Jul 17, 2026 by OVHcloud