Set-FilesRemoteMountBackend
Update Remote Mount Backend.
Syntax
Id (Default)
InputObject
Description
Update Remote Mount Backend.
The command accepts remote mount backends from the pipeline as -InputObject, and uses each one's Id and the connection that fetched it.
When given -InputObject, the command updates that object with the values Files.com returns and writes it.
The command supports -WhatIf, which describes the change without sending it to Files.com, and -Confirm, which asks before sending it.
Examples
Example 1: Update Remote Mount Backend
Writes the remote mount backend as Files.com returns it.
Example 2: Act on remote mount backends from the pipeline
Takes the remote mount backend from the pipeline and uses its Id and connection.
Example 3: Preview the change
Describes the change without sending anything to Files.com.
Parameters
-Id
Remote Mount Backend ID.
- Type:
System.Int64 - Parameter sets:
Id(required, position 0)
-Enabled
True if this backend is enabled.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-Fall
Number of consecutive failures before considering the backend unhealthy.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-HealthCheckEnabled
True if health checks are enabled for this backend.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-HealthCheckType
Type of health check to perform.
- Type:
System.String - Parameter sets:
Id,InputObject
-Interval
Interval in seconds between health checks.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-MinFreeCpu
Minimum free CPU percentage required for this backend to be considered healthy.
- Type:
System.Decimal - Parameter sets:
Id,InputObject
-MinFreeMem
Minimum free memory percentage required for this backend to be considered healthy.
- Type:
System.Decimal - Parameter sets:
Id,InputObject
-Priority
Priority of this backend.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-RemotePath
Path on the remote server to treat as the root of this mount.
- Type:
System.String - Parameter sets:
Id,InputObject
-Rise
Number of consecutive successes before considering the backend healthy.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-CanaryFilePath
Path to the canary file used for health checks.
- Type:
System.String - Parameter sets:
Id,InputObject
-RemoteServerId
The remote server that this backend is associated with.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-InputObject
The remote mount backend to act on, such as one written by another command of the module, from the pipeline. The command uses its Id and the connection that fetched it.
- Type:
FilesCom.PowerShell.Models.RemoteMountBackend - Parameter sets:
InputObject(required)
-Connection
The connection to use, from Connect-FilesAccount. Defaults to the connection of the -InputObject or -Continuation given, and otherwise to the current runspace's default connection.
- Type:
FilesCom.PowerShell.FilesConnection - Parameter sets:
(All)
-WorkspaceScope
Runs this command's requests in this workspace, including workspace 0, instead of the connection's or, for an -InputObject, instead of the workspace the object was read in. The connection and the object are unchanged.
- Type:
System.Int64 - Parameter sets:
(All)
-NoWorkspaceScope
Runs this command's requests in no workspace, even if the connection has one. The connection itself is unchanged.
- Type:
System.Management.Automation.SwitchParameter - Parameter sets:
(All)
-Confirm
Prompts you for confirmation before running the cmdlet.
- Type:
System.Management.Automation.SwitchParameter - Confirm impact: Medium. At the default
$ConfirmPreferenceofHigh, the command runs without asking;-Confirmmakes it ask before each change.
-WhatIf
Shows what the cmdlet would change without sending anything to Files.com.
- Type:
System.Management.Automation.SwitchParameter
Common Parameters
This cmdlet supports the PowerShell common parameters, such as -Verbose and -ErrorAction.
Inputs
FilesCom.PowerShell.Models.RemoteMountBackend: a remote mount backend from another command of the module, as-InputObject.
Outputs
FilesCom.PowerShell.Models.RemoteMountBackend: the remote mount backend as Files.com returned it.
Notes
Failures are written as error records with IDs such as Files.NotFound or Files.Authentication. Run Get-Help about_FilesCom for connections, paging, errors and previewing changes.