1. Packages
  2. Packages
  3. OVH
  4. API Docs
  5. getCloudGateways
Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud
ovh logo
Viewing docs for OVHCloud v2.17.0
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 dictionary
    data "ovh_get_cloud_gateways" "name" {
        # arguments
    }

    The following arguments are supported:

    ServiceName string
    Service name of the resource representing the id of the cloud project.
    ServiceName 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.
    serviceName String
    Service name of the resource representing the id of the cloud project.
    serviceName 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.
    serviceName String
    Service name of the resource representing the id of the cloud project.

    getCloudGateways Result

    The following output properties are available:

    Gateways List<GetCloudGatewaysGateway>
    List of gateways. Each element exports:
    Id string
    The provider-assigned unique ID for this managed resource.
    ServiceName string
    Gateways []GetCloudGatewaysGateway
    List of gateways. Each element exports:
    Id string
    The provider-assigned unique ID for this managed resource.
    ServiceName 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<GetCloudGatewaysGateway>
    List of gateways. Each element exports:
    id String
    The provider-assigned unique ID for this managed resource.
    serviceName String
    gateways GetCloudGatewaysGateway[]
    List of gateways. Each element exports:
    id string
    The provider-assigned unique ID for this managed resource.
    serviceName string
    gateways Sequence[GetCloudGatewaysGateway]
    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.
    serviceName String

    Supporting Types

    GetCloudGatewaysGateway

    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the gateway.
    CurrentState GetCloudGatewaysGatewayCurrentState
    Current state of the gateway:
    Description string
    Gateway description.
    ExternalGateway GetCloudGatewaysGatewayExternalGateway
    External gateway configuration:
    Id string
    Subnet ID.
    Location GetCloudGatewaysGatewayLocation
    Location details:
    Name string
    Gateway name.
    ResourceStatus string
    Gateway readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    UpdatedAt string
    Last update date of the gateway.
    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the gateway.
    CurrentState GetCloudGatewaysGatewayCurrentState
    Current state of the gateway:
    Description string
    Gateway description.
    ExternalGateway GetCloudGatewaysGatewayExternalGateway
    External gateway configuration:
    Id string
    Subnet ID.
    Location GetCloudGatewaysGatewayLocation
    Location details:
    Name string
    Gateway name.
    ResourceStatus string
    Gateway readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    UpdatedAt 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.
    createdAt String
    Creation date of the gateway.
    currentState GetCloudGatewaysGatewayCurrentState
    Current state of the gateway:
    description String
    Gateway description.
    externalGateway GetCloudGatewaysGatewayExternalGateway
    External gateway configuration:
    id String
    Subnet ID.
    location GetCloudGatewaysGatewayLocation
    Location details:
    name String
    Gateway name.
    resourceStatus String
    Gateway readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    updatedAt String
    Last update date of the gateway.
    checksum string
    Computed hash representing the current target specification value.
    createdAt string
    Creation date of the gateway.
    currentState GetCloudGatewaysGatewayCurrentState
    Current state of the gateway:
    description string
    Gateway description.
    externalGateway GetCloudGatewaysGatewayExternalGateway
    External gateway configuration:
    id string
    Subnet ID.
    location GetCloudGatewaysGatewayLocation
    Location details:
    name string
    Gateway name.
    resourceStatus string
    Gateway readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    updatedAt 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 GetCloudGatewaysGatewayCurrentState
    Current state of the gateway:
    description str
    Gateway description.
    external_gateway GetCloudGatewaysGatewayExternalGateway
    External gateway configuration:
    id str
    Subnet ID.
    location GetCloudGatewaysGatewayLocation
    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.
    createdAt String
    Creation date of the gateway.
    currentState Property Map
    Current state of the gateway:
    description String
    Gateway description.
    externalGateway Property Map
    External gateway configuration:
    id String
    Subnet ID.
    location Property Map
    Location details:
    name String
    Gateway name.
    resourceStatus String
    Gateway readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    updatedAt String
    Last update date of the gateway.

    GetCloudGatewaysGatewayCurrentState

    Description string
    Gateway description.
    ExternalGateway GetCloudGatewaysGatewayCurrentStateExternalGateway
    External gateway configuration:
    ExternalIp string
    External IP address assigned to the gateway.
    Location GetCloudGatewaysGatewayCurrentStateLocation
    Location details:
    Name string
    Gateway name.
    Status string
    OpenStack router status (ACTIVE, BUILD, DOWN, ERROR).
    Subnets List<GetCloudGatewaysGatewayCurrentStateSubnet>
    Currently attached subnets:
    Description string
    Gateway description.
    ExternalGateway GetCloudGatewaysGatewayCurrentStateExternalGateway
    External gateway configuration:
    ExternalIp string
    External IP address assigned to the gateway.
    Location GetCloudGatewaysGatewayCurrentStateLocation
    Location details:
    Name string
    Gateway name.
    Status string
    OpenStack router status (ACTIVE, BUILD, DOWN, ERROR).
    Subnets []GetCloudGatewaysGatewayCurrentStateSubnet
    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.
    externalGateway GetCloudGatewaysGatewayCurrentStateExternalGateway
    External gateway configuration:
    externalIp String
    External IP address assigned to the gateway.
    location GetCloudGatewaysGatewayCurrentStateLocation
    Location details:
    name String
    Gateway name.
    status String
    OpenStack router status (ACTIVE, BUILD, DOWN, ERROR).
    subnets List<GetCloudGatewaysGatewayCurrentStateSubnet>
    Currently attached subnets:
    description string
    Gateway description.
    externalGateway GetCloudGatewaysGatewayCurrentStateExternalGateway
    External gateway configuration:
    externalIp string
    External IP address assigned to the gateway.
    location GetCloudGatewaysGatewayCurrentStateLocation
    Location details:
    name string
    Gateway name.
    status string
    OpenStack router status (ACTIVE, BUILD, DOWN, ERROR).
    subnets GetCloudGatewaysGatewayCurrentStateSubnet[]
    Currently attached subnets:
    description str
    Gateway description.
    external_gateway GetCloudGatewaysGatewayCurrentStateExternalGateway
    External gateway configuration:
    external_ip str
    External IP address assigned to the gateway.
    location GetCloudGatewaysGatewayCurrentStateLocation
    Location details:
    name str
    Gateway name.
    status str
    OpenStack router status (ACTIVE, BUILD, DOWN, ERROR).
    subnets Sequence[GetCloudGatewaysGatewayCurrentStateSubnet]
    Currently attached subnets:
    description String
    Gateway description.
    externalGateway Property Map
    External gateway configuration:
    externalIp 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

    Enabled bool
    Whether the external gateway is enabled.
    Model string
    External gateway sizing model.
    Enabled bool
    Whether the external gateway is enabled.
    Model string
    External gateway sizing model.
    enabled bool
    Whether the external gateway is enabled.
    model string
    External gateway sizing model.
    enabled Boolean
    Whether the external gateway is enabled.
    model String
    External gateway sizing model.
    enabled boolean
    Whether the external gateway is enabled.
    model string
    External gateway sizing model.
    enabled bool
    Whether the external gateway is enabled.
    model str
    External gateway sizing model.
    enabled Boolean
    Whether the external gateway is enabled.
    model String
    External gateway sizing model.

    GetCloudGatewaysGatewayCurrentStateLocation

    AvailabilityZone string
    Availability zone.
    Region string
    Region.
    AvailabilityZone string
    Availability zone.
    Region string
    Region.
    availability_zone string
    Availability zone.
    region string
    Region.
    availabilityZone String
    Availability zone.
    region String
    Region.
    availabilityZone string
    Availability zone.
    region string
    Region.
    availability_zone str
    Availability zone.
    region str
    Region.
    availabilityZone 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

    Enabled bool
    Whether the external gateway is enabled.
    Model string
    External gateway sizing model.
    Enabled bool
    Whether the external gateway is enabled.
    Model string
    External gateway sizing model.
    enabled bool
    Whether the external gateway is enabled.
    model string
    External gateway sizing model.
    enabled Boolean
    Whether the external gateway is enabled.
    model String
    External gateway sizing model.
    enabled boolean
    Whether the external gateway is enabled.
    model string
    External gateway sizing model.
    enabled bool
    Whether the external gateway is enabled.
    model str
    External gateway sizing model.
    enabled Boolean
    Whether the external gateway is enabled.
    model String
    External gateway sizing model.

    GetCloudGatewaysGatewayLocation

    AvailabilityZone string
    Availability zone.
    Region string
    Region.
    AvailabilityZone string
    Availability zone.
    Region string
    Region.
    availability_zone string
    Availability zone.
    region string
    Region.
    availabilityZone String
    Availability zone.
    region String
    Region.
    availabilityZone string
    Availability zone.
    region string
    Region.
    availability_zone str
    Availability zone.
    region str
    Region.
    availabilityZone 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 ovh Terraform Provider.
    ovh logo
    Viewing docs for OVHCloud v2.17.0
    published on Friday, Jul 17, 2026 by OVHcloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial