1. Packages
  2. Packages
  3. Megaport Provider
  4. API Docs
  5. getMves
Viewing docs for megaport 1.9.1
published on Friday, May 22, 2026 by megaport
Viewing docs for megaport 1.9.1
published on Friday, May 22, 2026 by megaport

    Looks up MVEs in the Megaport API. Optionally filter by product_uid to retrieve a specific MVE.

    Using getMves

    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 getMves(args: GetMvesArgs, opts?: InvokeOptions): Promise<GetMvesResult>
    function getMvesOutput(args: GetMvesOutputArgs, opts?: InvokeOptions): Output<GetMvesResult>
    def get_mves(include_resource_tags: Optional[bool] = None,
                 product_uid: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetMvesResult
    def get_mves_output(include_resource_tags: pulumi.Input[Optional[bool]] = None,
                 product_uid: pulumi.Input[Optional[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetMvesResult]
    func GetMves(ctx *Context, args *GetMvesArgs, opts ...InvokeOption) (*GetMvesResult, error)
    func GetMvesOutput(ctx *Context, args *GetMvesOutputArgs, opts ...InvokeOption) GetMvesResultOutput

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

    public static class GetMves 
    {
        public static Task<GetMvesResult> InvokeAsync(GetMvesArgs args, InvokeOptions? opts = null)
        public static Output<GetMvesResult> Invoke(GetMvesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetMvesResult> getMves(GetMvesArgs args, InvokeOptions options)
    public static Output<GetMvesResult> getMves(GetMvesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: megaport:index/getMves:getMves
      arguments:
        # arguments dictionary
    data "megaport_getmves" "name" {
        # arguments
    }

    The following arguments are supported:

    IncludeResourceTags bool
    Whether to fetch resource tags for each MVE. Enabling this causes an additional API call per MVE, which may be slow for accounts with many MVEs.
    ProductUid string
    The unique identifier of a specific MVE to look up. If not provided, all active MVEs are returned.
    IncludeResourceTags bool
    Whether to fetch resource tags for each MVE. Enabling this causes an additional API call per MVE, which may be slow for accounts with many MVEs.
    ProductUid string
    The unique identifier of a specific MVE to look up. If not provided, all active MVEs are returned.
    include_resource_tags bool
    Whether to fetch resource tags for each MVE. Enabling this causes an additional API call per MVE, which may be slow for accounts with many MVEs.
    product_uid string
    The unique identifier of a specific MVE to look up. If not provided, all active MVEs are returned.
    includeResourceTags Boolean
    Whether to fetch resource tags for each MVE. Enabling this causes an additional API call per MVE, which may be slow for accounts with many MVEs.
    productUid String
    The unique identifier of a specific MVE to look up. If not provided, all active MVEs are returned.
    includeResourceTags boolean
    Whether to fetch resource tags for each MVE. Enabling this causes an additional API call per MVE, which may be slow for accounts with many MVEs.
    productUid string
    The unique identifier of a specific MVE to look up. If not provided, all active MVEs are returned.
    include_resource_tags bool
    Whether to fetch resource tags for each MVE. Enabling this causes an additional API call per MVE, which may be slow for accounts with many MVEs.
    product_uid str
    The unique identifier of a specific MVE to look up. If not provided, all active MVEs are returned.
    includeResourceTags Boolean
    Whether to fetch resource tags for each MVE. Enabling this causes an additional API call per MVE, which may be slow for accounts with many MVEs.
    productUid String
    The unique identifier of a specific MVE to look up. If not provided, all active MVEs are returned.

    getMves Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Mves List<GetMvesMfe>
    List of MVEs with detailed information.
    IncludeResourceTags bool
    Whether to fetch resource tags for each MVE. Enabling this causes an additional API call per MVE, which may be slow for accounts with many MVEs.
    ProductUid string
    The unique identifier of a specific MVE to look up. If not provided, all active MVEs are returned.
    Id string
    The provider-assigned unique ID for this managed resource.
    Mves []GetMvesMfe
    List of MVEs with detailed information.
    IncludeResourceTags bool
    Whether to fetch resource tags for each MVE. Enabling this causes an additional API call per MVE, which may be slow for accounts with many MVEs.
    ProductUid string
    The unique identifier of a specific MVE to look up. If not provided, all active MVEs are returned.
    id string
    The provider-assigned unique ID for this managed resource.
    mves list(object)
    List of MVEs with detailed information.
    include_resource_tags bool
    Whether to fetch resource tags for each MVE. Enabling this causes an additional API call per MVE, which may be slow for accounts with many MVEs.
    product_uid string
    The unique identifier of a specific MVE to look up. If not provided, all active MVEs are returned.
    id String
    The provider-assigned unique ID for this managed resource.
    mves List<GetMvesMfe>
    List of MVEs with detailed information.
    includeResourceTags Boolean
    Whether to fetch resource tags for each MVE. Enabling this causes an additional API call per MVE, which may be slow for accounts with many MVEs.
    productUid String
    The unique identifier of a specific MVE to look up. If not provided, all active MVEs are returned.
    id string
    The provider-assigned unique ID for this managed resource.
    mves GetMvesMfe[]
    List of MVEs with detailed information.
    includeResourceTags boolean
    Whether to fetch resource tags for each MVE. Enabling this causes an additional API call per MVE, which may be slow for accounts with many MVEs.
    productUid string
    The unique identifier of a specific MVE to look up. If not provided, all active MVEs are returned.
    id str
    The provider-assigned unique ID for this managed resource.
    mves Sequence[GetMvesMfe]
    List of MVEs with detailed information.
    include_resource_tags bool
    Whether to fetch resource tags for each MVE. Enabling this causes an additional API call per MVE, which may be slow for accounts with many MVEs.
    product_uid str
    The unique identifier of a specific MVE to look up. If not provided, all active MVEs are returned.
    id String
    The provider-assigned unique ID for this managed resource.
    mves List<Property Map>
    List of MVEs with detailed information.
    includeResourceTags Boolean
    Whether to fetch resource tags for each MVE. Enabling this causes an additional API call per MVE, which may be slow for accounts with many MVEs.
    productUid String
    The unique identifier of a specific MVE to look up. If not provided, all active MVEs are returned.

    Supporting Types

    GetMvesMfe

    AdminLocked bool
    Whether the MVE is admin locked.
    AttributeTags Dictionary<string, string>
    The attribute tags of the MVE.
    Cancelable bool
    Whether the MVE can be cancelled.
    CompanyName string
    The name of the company that owns the MVE.
    CompanyUid string
    The Megaport Company UID of the MVE owner.
    ContractEndDate string
    The contract end date of the MVE.
    ContractStartDate string
    The contract start date of the MVE.
    ContractTermMonths double
    The contract term of the MVE in months.
    CostCentre string
    The cost centre of the MVE for billing purposes.
    CreateDate string
    The date the MVE was created.
    CreatedBy string
    The user who created the MVE.
    DiversityZone string
    The diversity zone of the MVE.
    LiveDate string
    The date the MVE went live.
    LocationId double
    The numeric location ID of the MVE.
    Locked bool
    Whether the MVE is locked.
    Market string
    The market the MVE is in.
    MarketplaceVisibility bool
    Whether the MVE is visible in the Marketplace.
    ProductName string
    The name of the MVE.
    ProductUid string
    The unique identifier of the MVE.
    ProvisioningStatus string
    The provisioning status of the MVE.
    ResourceTags Dictionary<string, string>
    The resource tags associated with the MVE. Only populated when includeresourcetags is enabled.
    SecondaryName string
    The secondary name of the MVE.
    Size string
    The size of the MVE.
    TerminateDate string
    The date the MVE will be terminated.
    Vendor string
    The vendor of the MVE.
    VxcAutoApproval bool
    Whether VXC connections are auto-approved on this MVE.
    VxcPermitted bool
    Whether VXC connections are permitted on this MVE.
    AdminLocked bool
    Whether the MVE is admin locked.
    AttributeTags map[string]string
    The attribute tags of the MVE.
    Cancelable bool
    Whether the MVE can be cancelled.
    CompanyName string
    The name of the company that owns the MVE.
    CompanyUid string
    The Megaport Company UID of the MVE owner.
    ContractEndDate string
    The contract end date of the MVE.
    ContractStartDate string
    The contract start date of the MVE.
    ContractTermMonths float64
    The contract term of the MVE in months.
    CostCentre string
    The cost centre of the MVE for billing purposes.
    CreateDate string
    The date the MVE was created.
    CreatedBy string
    The user who created the MVE.
    DiversityZone string
    The diversity zone of the MVE.
    LiveDate string
    The date the MVE went live.
    LocationId float64
    The numeric location ID of the MVE.
    Locked bool
    Whether the MVE is locked.
    Market string
    The market the MVE is in.
    MarketplaceVisibility bool
    Whether the MVE is visible in the Marketplace.
    ProductName string
    The name of the MVE.
    ProductUid string
    The unique identifier of the MVE.
    ProvisioningStatus string
    The provisioning status of the MVE.
    ResourceTags map[string]string
    The resource tags associated with the MVE. Only populated when includeresourcetags is enabled.
    SecondaryName string
    The secondary name of the MVE.
    Size string
    The size of the MVE.
    TerminateDate string
    The date the MVE will be terminated.
    Vendor string
    The vendor of the MVE.
    VxcAutoApproval bool
    Whether VXC connections are auto-approved on this MVE.
    VxcPermitted bool
    Whether VXC connections are permitted on this MVE.
    admin_locked bool
    Whether the MVE is admin locked.
    attribute_tags map(string)
    The attribute tags of the MVE.
    cancelable bool
    Whether the MVE can be cancelled.
    company_name string
    The name of the company that owns the MVE.
    company_uid string
    The Megaport Company UID of the MVE owner.
    contract_end_date string
    The contract end date of the MVE.
    contract_start_date string
    The contract start date of the MVE.
    contract_term_months number
    The contract term of the MVE in months.
    cost_centre string
    The cost centre of the MVE for billing purposes.
    create_date string
    The date the MVE was created.
    created_by string
    The user who created the MVE.
    diversity_zone string
    The diversity zone of the MVE.
    live_date string
    The date the MVE went live.
    location_id number
    The numeric location ID of the MVE.
    locked bool
    Whether the MVE is locked.
    market string
    The market the MVE is in.
    marketplace_visibility bool
    Whether the MVE is visible in the Marketplace.
    product_name string
    The name of the MVE.
    product_uid string
    The unique identifier of the MVE.
    provisioning_status string
    The provisioning status of the MVE.
    resource_tags map(string)
    The resource tags associated with the MVE. Only populated when includeresourcetags is enabled.
    secondary_name string
    The secondary name of the MVE.
    size string
    The size of the MVE.
    terminate_date string
    The date the MVE will be terminated.
    vendor string
    The vendor of the MVE.
    vxc_auto_approval bool
    Whether VXC connections are auto-approved on this MVE.
    vxc_permitted bool
    Whether VXC connections are permitted on this MVE.
    adminLocked Boolean
    Whether the MVE is admin locked.
    attributeTags Map<String,String>
    The attribute tags of the MVE.
    cancelable Boolean
    Whether the MVE can be cancelled.
    companyName String
    The name of the company that owns the MVE.
    companyUid String
    The Megaport Company UID of the MVE owner.
    contractEndDate String
    The contract end date of the MVE.
    contractStartDate String
    The contract start date of the MVE.
    contractTermMonths Double
    The contract term of the MVE in months.
    costCentre String
    The cost centre of the MVE for billing purposes.
    createDate String
    The date the MVE was created.
    createdBy String
    The user who created the MVE.
    diversityZone String
    The diversity zone of the MVE.
    liveDate String
    The date the MVE went live.
    locationId Double
    The numeric location ID of the MVE.
    locked Boolean
    Whether the MVE is locked.
    market String
    The market the MVE is in.
    marketplaceVisibility Boolean
    Whether the MVE is visible in the Marketplace.
    productName String
    The name of the MVE.
    productUid String
    The unique identifier of the MVE.
    provisioningStatus String
    The provisioning status of the MVE.
    resourceTags Map<String,String>
    The resource tags associated with the MVE. Only populated when includeresourcetags is enabled.
    secondaryName String
    The secondary name of the MVE.
    size String
    The size of the MVE.
    terminateDate String
    The date the MVE will be terminated.
    vendor String
    The vendor of the MVE.
    vxcAutoApproval Boolean
    Whether VXC connections are auto-approved on this MVE.
    vxcPermitted Boolean
    Whether VXC connections are permitted on this MVE.
    adminLocked boolean
    Whether the MVE is admin locked.
    attributeTags {[key: string]: string}
    The attribute tags of the MVE.
    cancelable boolean
    Whether the MVE can be cancelled.
    companyName string
    The name of the company that owns the MVE.
    companyUid string
    The Megaport Company UID of the MVE owner.
    contractEndDate string
    The contract end date of the MVE.
    contractStartDate string
    The contract start date of the MVE.
    contractTermMonths number
    The contract term of the MVE in months.
    costCentre string
    The cost centre of the MVE for billing purposes.
    createDate string
    The date the MVE was created.
    createdBy string
    The user who created the MVE.
    diversityZone string
    The diversity zone of the MVE.
    liveDate string
    The date the MVE went live.
    locationId number
    The numeric location ID of the MVE.
    locked boolean
    Whether the MVE is locked.
    market string
    The market the MVE is in.
    marketplaceVisibility boolean
    Whether the MVE is visible in the Marketplace.
    productName string
    The name of the MVE.
    productUid string
    The unique identifier of the MVE.
    provisioningStatus string
    The provisioning status of the MVE.
    resourceTags {[key: string]: string}
    The resource tags associated with the MVE. Only populated when includeresourcetags is enabled.
    secondaryName string
    The secondary name of the MVE.
    size string
    The size of the MVE.
    terminateDate string
    The date the MVE will be terminated.
    vendor string
    The vendor of the MVE.
    vxcAutoApproval boolean
    Whether VXC connections are auto-approved on this MVE.
    vxcPermitted boolean
    Whether VXC connections are permitted on this MVE.
    admin_locked bool
    Whether the MVE is admin locked.
    attribute_tags Mapping[str, str]
    The attribute tags of the MVE.
    cancelable bool
    Whether the MVE can be cancelled.
    company_name str
    The name of the company that owns the MVE.
    company_uid str
    The Megaport Company UID of the MVE owner.
    contract_end_date str
    The contract end date of the MVE.
    contract_start_date str
    The contract start date of the MVE.
    contract_term_months float
    The contract term of the MVE in months.
    cost_centre str
    The cost centre of the MVE for billing purposes.
    create_date str
    The date the MVE was created.
    created_by str
    The user who created the MVE.
    diversity_zone str
    The diversity zone of the MVE.
    live_date str
    The date the MVE went live.
    location_id float
    The numeric location ID of the MVE.
    locked bool
    Whether the MVE is locked.
    market str
    The market the MVE is in.
    marketplace_visibility bool
    Whether the MVE is visible in the Marketplace.
    product_name str
    The name of the MVE.
    product_uid str
    The unique identifier of the MVE.
    provisioning_status str
    The provisioning status of the MVE.
    resource_tags Mapping[str, str]
    The resource tags associated with the MVE. Only populated when includeresourcetags is enabled.
    secondary_name str
    The secondary name of the MVE.
    size str
    The size of the MVE.
    terminate_date str
    The date the MVE will be terminated.
    vendor str
    The vendor of the MVE.
    vxc_auto_approval bool
    Whether VXC connections are auto-approved on this MVE.
    vxc_permitted bool
    Whether VXC connections are permitted on this MVE.
    adminLocked Boolean
    Whether the MVE is admin locked.
    attributeTags Map<String>
    The attribute tags of the MVE.
    cancelable Boolean
    Whether the MVE can be cancelled.
    companyName String
    The name of the company that owns the MVE.
    companyUid String
    The Megaport Company UID of the MVE owner.
    contractEndDate String
    The contract end date of the MVE.
    contractStartDate String
    The contract start date of the MVE.
    contractTermMonths Number
    The contract term of the MVE in months.
    costCentre String
    The cost centre of the MVE for billing purposes.
    createDate String
    The date the MVE was created.
    createdBy String
    The user who created the MVE.
    diversityZone String
    The diversity zone of the MVE.
    liveDate String
    The date the MVE went live.
    locationId Number
    The numeric location ID of the MVE.
    locked Boolean
    Whether the MVE is locked.
    market String
    The market the MVE is in.
    marketplaceVisibility Boolean
    Whether the MVE is visible in the Marketplace.
    productName String
    The name of the MVE.
    productUid String
    The unique identifier of the MVE.
    provisioningStatus String
    The provisioning status of the MVE.
    resourceTags Map<String>
    The resource tags associated with the MVE. Only populated when includeresourcetags is enabled.
    secondaryName String
    The secondary name of the MVE.
    size String
    The size of the MVE.
    terminateDate String
    The date the MVE will be terminated.
    vendor String
    The vendor of the MVE.
    vxcAutoApproval Boolean
    Whether VXC connections are auto-approved on this MVE.
    vxcPermitted Boolean
    Whether VXC connections are permitted on this MVE.

    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.9.1
    published on Friday, May 22, 2026 by megaport

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial