1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. getRemoteMountBackend
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady

    A Remote Mount Backend is used to provide high availability for a Remote Server Mount Folder Behavior.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as filescom from "pulumi-filescom";
    
    const exampleRemoteMountBackend = filescom.getRemoteMountBackend({
        id: 1,
    });
    
    import pulumi
    import pulumi_filescom as filescom
    
    example_remote_mount_backend = filescom.get_remote_mount_backend(id=1)
    
    package main
    
    import (
    	"github.com/jschady/pulumi-filescom/sdk/go/filescom"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := filescom.GetRemoteMountBackend(ctx, &filescom.LookupRemoteMountBackendArgs{
    			Id: 1,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Filescom = Jschady.Filescom;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleRemoteMountBackend = Filescom.GetRemoteMountBackend.Invoke(new()
        {
            Id = 1,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.filescom.FilescomFunctions;
    import com.pulumi.filescom.inputs.GetRemoteMountBackendArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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) {
            final var exampleRemoteMountBackend = FilescomFunctions.getRemoteMountBackend(GetRemoteMountBackendArgs.builder()
                .id(1)
                .build());
    
        }
    }
    
    variables:
      exampleRemoteMountBackend:
        fn::invoke:
          function: filescom:getRemoteMountBackend
          arguments:
            id: 1
    
    pulumi {
      required_providers {
        filescom = {
          source = "pulumi/filescom"
        }
      }
    }
    
    data "filescom_getremotemountbackend" "exampleRemoteMountBackend" {
      id = 1
    }
    

    Using getRemoteMountBackend

    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 getRemoteMountBackend(args: GetRemoteMountBackendArgs, opts?: InvokeOptions): Promise<GetRemoteMountBackendResult>
    function getRemoteMountBackendOutput(args: GetRemoteMountBackendOutputArgs, opts?: InvokeOutputOptions): Output<GetRemoteMountBackendResult>
    def get_remote_mount_backend(id: Optional[int] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetRemoteMountBackendResult
    def get_remote_mount_backend_output(id: pulumi.Input[Optional[int]] = None,
                                 opts: Optional[InvokeOutputOptions] = None) -> Output[GetRemoteMountBackendResult]
    func LookupRemoteMountBackend(ctx *Context, args *LookupRemoteMountBackendArgs, opts ...InvokeOption) (*LookupRemoteMountBackendResult, error)
    func LookupRemoteMountBackendOutput(ctx *Context, args *LookupRemoteMountBackendOutputArgs, opts ...InvokeOption) LookupRemoteMountBackendResultOutput

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

    public static class GetRemoteMountBackend 
    {
        public static Task<GetRemoteMountBackendResult> InvokeAsync(GetRemoteMountBackendArgs args, InvokeOptions? opts = null)
        public static Output<GetRemoteMountBackendResult> Invoke(GetRemoteMountBackendInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetRemoteMountBackendResult> Invoke(GetRemoteMountBackendInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetRemoteMountBackendResult> getRemoteMountBackend(GetRemoteMountBackendArgs args, InvokeOptions options)
    public static Output<GetRemoteMountBackendResult> getRemoteMountBackend(GetRemoteMountBackendArgs args, InvokeOptions options)
    public static Output<GetRemoteMountBackendResult> getRemoteMountBackend(GetRemoteMountBackendArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: filescom:index/getRemoteMountBackend:getRemoteMountBackend
      arguments:
        # arguments dictionary
    data "filescom_get_remote_mount_backend" "name" {
        # arguments
    }

    The following arguments are supported:

    Id int
    Unique identifier for this backend.
    Id int
    Unique identifier for this backend.
    id number
    Unique identifier for this backend.
    id Integer
    Unique identifier for this backend.
    id number
    Unique identifier for this backend.
    id int
    Unique identifier for this backend.
    id Number
    Unique identifier for this backend.

    getRemoteMountBackend Result

    The following output properties are available:

    CanaryFilePath string
    Path to the canary file used for health checks.
    Enabled bool
    True if this backend is enabled.
    Fall int
    Number of consecutive failures before considering the backend unhealthy.
    HealthCheckEnabled bool
    True if health checks are enabled for this backend.
    HealthCheckResults object
    Array of recent health check results.
    HealthCheckType string
    Type of health check to perform.
    Id int
    Unique identifier for this backend.
    Interval int
    Interval in seconds between health checks.
    MinFreeCpu string
    Minimum free CPU percentage required for this backend to be considered healthy.
    MinFreeMem string
    Minimum free memory percentage required for this backend to be considered healthy.
    Priority int
    Priority of this backend.
    RemotePath string
    Path on the remote server to treat as the root of this mount.
    RemoteServerId int
    The remote server that this backend is associated with.
    RemoteServerMountId int
    The mount ID of the Remote Server Mount that this backend is associated with.
    Rise int
    Number of consecutive successes before considering the backend healthy.
    Status string
    Status of this backend.
    UndergoingMaintenance bool
    True if this backend is undergoing maintenance.
    CanaryFilePath string
    Path to the canary file used for health checks.
    Enabled bool
    True if this backend is enabled.
    Fall int
    Number of consecutive failures before considering the backend unhealthy.
    HealthCheckEnabled bool
    True if health checks are enabled for this backend.
    HealthCheckResults interface{}
    Array of recent health check results.
    HealthCheckType string
    Type of health check to perform.
    Id int
    Unique identifier for this backend.
    Interval int
    Interval in seconds between health checks.
    MinFreeCpu string
    Minimum free CPU percentage required for this backend to be considered healthy.
    MinFreeMem string
    Minimum free memory percentage required for this backend to be considered healthy.
    Priority int
    Priority of this backend.
    RemotePath string
    Path on the remote server to treat as the root of this mount.
    RemoteServerId int
    The remote server that this backend is associated with.
    RemoteServerMountId int
    The mount ID of the Remote Server Mount that this backend is associated with.
    Rise int
    Number of consecutive successes before considering the backend healthy.
    Status string
    Status of this backend.
    UndergoingMaintenance bool
    True if this backend is undergoing maintenance.
    canary_file_path string
    Path to the canary file used for health checks.
    enabled bool
    True if this backend is enabled.
    fall number
    Number of consecutive failures before considering the backend unhealthy.
    health_check_enabled bool
    True if health checks are enabled for this backend.
    health_check_results any
    Array of recent health check results.
    health_check_type string
    Type of health check to perform.
    id number
    Unique identifier for this backend.
    interval number
    Interval in seconds between health checks.
    min_free_cpu string
    Minimum free CPU percentage required for this backend to be considered healthy.
    min_free_mem string
    Minimum free memory percentage required for this backend to be considered healthy.
    priority number
    Priority of this backend.
    remote_path string
    Path on the remote server to treat as the root of this mount.
    remote_server_id number
    The remote server that this backend is associated with.
    remote_server_mount_id number
    The mount ID of the Remote Server Mount that this backend is associated with.
    rise number
    Number of consecutive successes before considering the backend healthy.
    status string
    Status of this backend.
    undergoing_maintenance bool
    True if this backend is undergoing maintenance.
    canaryFilePath String
    Path to the canary file used for health checks.
    enabled Boolean
    True if this backend is enabled.
    fall Integer
    Number of consecutive failures before considering the backend unhealthy.
    healthCheckEnabled Boolean
    True if health checks are enabled for this backend.
    healthCheckResults Object
    Array of recent health check results.
    healthCheckType String
    Type of health check to perform.
    id Integer
    Unique identifier for this backend.
    interval Integer
    Interval in seconds between health checks.
    minFreeCpu String
    Minimum free CPU percentage required for this backend to be considered healthy.
    minFreeMem String
    Minimum free memory percentage required for this backend to be considered healthy.
    priority Integer
    Priority of this backend.
    remotePath String
    Path on the remote server to treat as the root of this mount.
    remoteServerId Integer
    The remote server that this backend is associated with.
    remoteServerMountId Integer
    The mount ID of the Remote Server Mount that this backend is associated with.
    rise Integer
    Number of consecutive successes before considering the backend healthy.
    status String
    Status of this backend.
    undergoingMaintenance Boolean
    True if this backend is undergoing maintenance.
    canaryFilePath string
    Path to the canary file used for health checks.
    enabled boolean
    True if this backend is enabled.
    fall number
    Number of consecutive failures before considering the backend unhealthy.
    healthCheckEnabled boolean
    True if health checks are enabled for this backend.
    healthCheckResults any
    Array of recent health check results.
    healthCheckType string
    Type of health check to perform.
    id number
    Unique identifier for this backend.
    interval number
    Interval in seconds between health checks.
    minFreeCpu string
    Minimum free CPU percentage required for this backend to be considered healthy.
    minFreeMem string
    Minimum free memory percentage required for this backend to be considered healthy.
    priority number
    Priority of this backend.
    remotePath string
    Path on the remote server to treat as the root of this mount.
    remoteServerId number
    The remote server that this backend is associated with.
    remoteServerMountId number
    The mount ID of the Remote Server Mount that this backend is associated with.
    rise number
    Number of consecutive successes before considering the backend healthy.
    status string
    Status of this backend.
    undergoingMaintenance boolean
    True if this backend is undergoing maintenance.
    canary_file_path str
    Path to the canary file used for health checks.
    enabled bool
    True if this backend is enabled.
    fall int
    Number of consecutive failures before considering the backend unhealthy.
    health_check_enabled bool
    True if health checks are enabled for this backend.
    health_check_results Any
    Array of recent health check results.
    health_check_type str
    Type of health check to perform.
    id int
    Unique identifier for this backend.
    interval int
    Interval in seconds between health checks.
    min_free_cpu str
    Minimum free CPU percentage required for this backend to be considered healthy.
    min_free_mem str
    Minimum free memory percentage required for this backend to be considered healthy.
    priority int
    Priority of this backend.
    remote_path str
    Path on the remote server to treat as the root of this mount.
    remote_server_id int
    The remote server that this backend is associated with.
    remote_server_mount_id int
    The mount ID of the Remote Server Mount that this backend is associated with.
    rise int
    Number of consecutive successes before considering the backend healthy.
    status str
    Status of this backend.
    undergoing_maintenance bool
    True if this backend is undergoing maintenance.
    canaryFilePath String
    Path to the canary file used for health checks.
    enabled Boolean
    True if this backend is enabled.
    fall Number
    Number of consecutive failures before considering the backend unhealthy.
    healthCheckEnabled Boolean
    True if health checks are enabled for this backend.
    healthCheckResults Any
    Array of recent health check results.
    healthCheckType String
    Type of health check to perform.
    id Number
    Unique identifier for this backend.
    interval Number
    Interval in seconds between health checks.
    minFreeCpu String
    Minimum free CPU percentage required for this backend to be considered healthy.
    minFreeMem String
    Minimum free memory percentage required for this backend to be considered healthy.
    priority Number
    Priority of this backend.
    remotePath String
    Path on the remote server to treat as the root of this mount.
    remoteServerId Number
    The remote server that this backend is associated with.
    remoteServerMountId Number
    The mount ID of the Remote Server Mount that this backend is associated with.
    rise Number
    Number of consecutive successes before considering the backend healthy.
    status String
    Status of this backend.
    undergoingMaintenance Boolean
    True if this backend is undergoing maintenance.

    Package Details

    Repository
    filescom jschady/pulumi-filescom
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the filescom Terraform Provider.
    filescom logo
    Viewing docs for Files.com v0.1.1
    published on Thursday, Aug 20, 2026 by jschady

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial