Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Megaport Provider
  4. API Docs
  5. getIxs
Viewing docs for megaport 1.19.1
published on Monday, Sep 28, 2026 by megaport
Schema (JSON)
megaport/terraform-provider-megaport

megaport.getIxs

Viewing docs for megaport 1.19.1
published on Monday, Sep 28, 2026 by megaport
Schema (JSON)
megaport/terraform-provider-megaport

    Looks up IXs in the Megaport API. Optionally filter by product_uid to retrieve a specific IX.

    Using getIxs

    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 getIxs(args: GetIxsArgs, opts?: InvokeOptions): Promise<GetIxsResult>
function getIxsOutput(args: GetIxsOutputArgs, opts?: InvokeOutputOptions): Output<GetIxsResult>
    def get_ixs(product_uid: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetIxsResult
def get_ixs_output(product_uid: pulumi.Input[Optional[str]] = None,
            opts: Optional[InvokeOutputOptions] = None) -> Output[GetIxsResult]
    func GetIxs(ctx *Context, args *GetIxsArgs, opts ...InvokeOption) (*GetIxsResult, error)
func GetIxsOutput(ctx *Context, args *GetIxsOutputArgs, opts ...InvokeOption) GetIxsResultOutput

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

    public static class GetIxs 
{
    public static Task<GetIxsResult> InvokeAsync(GetIxsArgs args, InvokeOptions? opts = null)
    public static Output<GetIxsResult> Invoke(GetIxsInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetIxsResult> Invoke(GetIxsInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetIxsResult> getIxs(GetIxsArgs args, InvokeOptions options)
public static Output<GetIxsResult> getIxs(GetIxsArgs args, InvokeOptions options)
public static Output<GetIxsResult> getIxs(GetIxsArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: megaport:index/getIxs:getIxs
  arguments:
    # arguments dictionary
    data "megaport_get_ixs" "name" {
    # arguments
}

    The following arguments are supported:

    ProductUid string
    The unique identifier of a specific IX to look up. Must be the UID of an IX: the API has no product-type check on this lookup, so passing the UID of another product (port, MCR, MVE, etc.) returns undefined field values instead of an error. If not provided, all active IXs are returned; a product_uid lookup can also return an inactive IX.
    ProductUid string
    The unique identifier of a specific IX to look up. Must be the UID of an IX: the API has no product-type check on this lookup, so passing the UID of another product (port, MCR, MVE, etc.) returns undefined field values instead of an error. If not provided, all active IXs are returned; a product_uid lookup can also return an inactive IX.
    product_uid string
    The unique identifier of a specific IX to look up. Must be the UID of an IX: the API has no product-type check on this lookup, so passing the UID of another product (port, MCR, MVE, etc.) returns undefined field values instead of an error. If not provided, all active IXs are returned; a product_uid lookup can also return an inactive IX.
    productUid String
    The unique identifier of a specific IX to look up. Must be the UID of an IX: the API has no product-type check on this lookup, so passing the UID of another product (port, MCR, MVE, etc.) returns undefined field values instead of an error. If not provided, all active IXs are returned; a product_uid lookup can also return an inactive IX.
    productUid string
    The unique identifier of a specific IX to look up. Must be the UID of an IX: the API has no product-type check on this lookup, so passing the UID of another product (port, MCR, MVE, etc.) returns undefined field values instead of an error. If not provided, all active IXs are returned; a product_uid lookup can also return an inactive IX.
    product_uid str
    The unique identifier of a specific IX to look up. Must be the UID of an IX: the API has no product-type check on this lookup, so passing the UID of another product (port, MCR, MVE, etc.) returns undefined field values instead of an error. If not provided, all active IXs are returned; a product_uid lookup can also return an inactive IX.
    productUid String
    The unique identifier of a specific IX to look up. Must be the UID of an IX: the API has no product-type check on this lookup, so passing the UID of another product (port, MCR, MVE, etc.) returns undefined field values instead of an error. If not provided, all active IXs are returned; a product_uid lookup can also return an inactive IX.

    getIxs Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Ixs List<GetIxsIx>
    List of IXs with detailed information.
    ProductUid string
    The unique identifier of a specific IX to look up. Must be the UID of an IX: the API has no product-type check on this lookup, so passing the UID of another product (port, MCR, MVE, etc.) returns undefined field values instead of an error. If not provided, all active IXs are returned; a product_uid lookup can also return an inactive IX.
    Id string
    The provider-assigned unique ID for this managed resource.
    Ixs []GetIxsIx
    List of IXs with detailed information.
    ProductUid string
    The unique identifier of a specific IX to look up. Must be the UID of an IX: the API has no product-type check on this lookup, so passing the UID of another product (port, MCR, MVE, etc.) returns undefined field values instead of an error. If not provided, all active IXs are returned; a product_uid lookup can also return an inactive IX.
    id string
    The provider-assigned unique ID for this managed resource.
    ixs list(object)
    List of IXs with detailed information.
    product_uid string
    The unique identifier of a specific IX to look up. Must be the UID of an IX: the API has no product-type check on this lookup, so passing the UID of another product (port, MCR, MVE, etc.) returns undefined field values instead of an error. If not provided, all active IXs are returned; a product_uid lookup can also return an inactive IX.
    id String
    The provider-assigned unique ID for this managed resource.
    ixs List<GetIxsIx>
    List of IXs with detailed information.
    productUid String
    The unique identifier of a specific IX to look up. Must be the UID of an IX: the API has no product-type check on this lookup, so passing the UID of another product (port, MCR, MVE, etc.) returns undefined field values instead of an error. If not provided, all active IXs are returned; a product_uid lookup can also return an inactive IX.
    id string
    The provider-assigned unique ID for this managed resource.
    ixs GetIxsIx[]
    List of IXs with detailed information.
    productUid string
    The unique identifier of a specific IX to look up. Must be the UID of an IX: the API has no product-type check on this lookup, so passing the UID of another product (port, MCR, MVE, etc.) returns undefined field values instead of an error. If not provided, all active IXs are returned; a product_uid lookup can also return an inactive IX.
    id str
    The provider-assigned unique ID for this managed resource.
    ixs Sequence[GetIxsIx]
    List of IXs with detailed information.
    product_uid str
    The unique identifier of a specific IX to look up. Must be the UID of an IX: the API has no product-type check on this lookup, so passing the UID of another product (port, MCR, MVE, etc.) returns undefined field values instead of an error. If not provided, all active IXs are returned; a product_uid lookup can also return an inactive IX.
    id String
    The provider-assigned unique ID for this managed resource.
    ixs List<Property Map>
    List of IXs with detailed information.
    productUid String
    The unique identifier of a specific IX to look up. Must be the UID of an IX: the API has no product-type check on this lookup, so passing the UID of another product (port, MCR, MVE, etc.) returns undefined field values instead of an error. If not provided, all active IXs are returned; a product_uid lookup can also return an inactive IX.

    Supporting Types

    GetIxsIx

    Asn double
    The Autonomous System Number (ASN) of the IX.
    AttributeTags Dictionary<string, string>
    The attribute tags of the IX.
    CreateDate string
    The date the IX was created.
    DeployDate string
    The date the IX was deployed.
    LocationId double
    The numeric location ID of the IX.
    MacAddress string
    The MAC address of the IX.
    NetworkServiceType string
    The network service type of the IX.
    ProductName string
    The name of the IX.
    ProductUid string
    The unique identifier of the IX.
    ProvisioningStatus string
    The provisioning status of the IX.
    RateLimit double
    The rate limit of the IX in Mbps.
    SecondaryName string
    The secondary name of the IX.
    Term double
    The contract term of the IX in months.
    Vlan double
    The VLAN of the IX.
    Asn float64
    The Autonomous System Number (ASN) of the IX.
    AttributeTags map[string]string
    The attribute tags of the IX.
    CreateDate string
    The date the IX was created.
    DeployDate string
    The date the IX was deployed.
    LocationId float64
    The numeric location ID of the IX.
    MacAddress string
    The MAC address of the IX.
    NetworkServiceType string
    The network service type of the IX.
    ProductName string
    The name of the IX.
    ProductUid string
    The unique identifier of the IX.
    ProvisioningStatus string
    The provisioning status of the IX.
    RateLimit float64
    The rate limit of the IX in Mbps.
    SecondaryName string
    The secondary name of the IX.
    Term float64
    The contract term of the IX in months.
    Vlan float64
    The VLAN of the IX.
    asn number
    The Autonomous System Number (ASN) of the IX.
    attribute_tags map(string)
    The attribute tags of the IX.
    create_date string
    The date the IX was created.
    deploy_date string
    The date the IX was deployed.
    location_id number
    The numeric location ID of the IX.
    mac_address string
    The MAC address of the IX.
    network_service_type string
    The network service type of the IX.
    product_name string
    The name of the IX.
    product_uid string
    The unique identifier of the IX.
    provisioning_status string
    The provisioning status of the IX.
    rate_limit number
    The rate limit of the IX in Mbps.
    secondary_name string
    The secondary name of the IX.
    term number
    The contract term of the IX in months.
    vlan number
    The VLAN of the IX.
    asn Double
    The Autonomous System Number (ASN) of the IX.
    attributeTags Map<String,String>
    The attribute tags of the IX.
    createDate String
    The date the IX was created.
    deployDate String
    The date the IX was deployed.
    locationId Double
    The numeric location ID of the IX.
    macAddress String
    The MAC address of the IX.
    networkServiceType String
    The network service type of the IX.
    productName String
    The name of the IX.
    productUid String
    The unique identifier of the IX.
    provisioningStatus String
    The provisioning status of the IX.
    rateLimit Double
    The rate limit of the IX in Mbps.
    secondaryName String
    The secondary name of the IX.
    term Double
    The contract term of the IX in months.
    vlan Double
    The VLAN of the IX.
    asn number
    The Autonomous System Number (ASN) of the IX.
    attributeTags {[key: string]: string}
    The attribute tags of the IX.
    createDate string
    The date the IX was created.
    deployDate string
    The date the IX was deployed.
    locationId number
    The numeric location ID of the IX.
    macAddress string
    The MAC address of the IX.
    networkServiceType string
    The network service type of the IX.
    productName string
    The name of the IX.
    productUid string
    The unique identifier of the IX.
    provisioningStatus string
    The provisioning status of the IX.
    rateLimit number
    The rate limit of the IX in Mbps.
    secondaryName string
    The secondary name of the IX.
    term number
    The contract term of the IX in months.
    vlan number
    The VLAN of the IX.
    asn float
    The Autonomous System Number (ASN) of the IX.
    attribute_tags Mapping[str, str]
    The attribute tags of the IX.
    create_date str
    The date the IX was created.
    deploy_date str
    The date the IX was deployed.
    location_id float
    The numeric location ID of the IX.
    mac_address str
    The MAC address of the IX.
    network_service_type str
    The network service type of the IX.
    product_name str
    The name of the IX.
    product_uid str
    The unique identifier of the IX.
    provisioning_status str
    The provisioning status of the IX.
    rate_limit float
    The rate limit of the IX in Mbps.
    secondary_name str
    The secondary name of the IX.
    term float
    The contract term of the IX in months.
    vlan float
    The VLAN of the IX.
    asn Number
    The Autonomous System Number (ASN) of the IX.
    attributeTags Map<String>
    The attribute tags of the IX.
    createDate String
    The date the IX was created.
    deployDate String
    The date the IX was deployed.
    locationId Number
    The numeric location ID of the IX.
    macAddress String
    The MAC address of the IX.
    networkServiceType String
    The network service type of the IX.
    productName String
    The name of the IX.
    productUid String
    The unique identifier of the IX.
    provisioningStatus String
    The provisioning status of the IX.
    rateLimit Number
    The rate limit of the IX in Mbps.
    secondaryName String
    The secondary name of the IX.
    term Number
    The contract term of the IX in months.
    vlan Number
    The VLAN of the IX.

    Package Details

    Repository
    megaport megaport/terraform-provider-megaport
    License
    Notes
    This Pulumi package is based on the megaport Terraform Provider.
    Viewing docs for megaport 1.19.1
    published on Monday, Sep 28, 2026 by megaport
    Schema (JSON)
    megaport/terraform-provider-megaport

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial