Set-FilesAs2Station
Update AS2 Station.
Syntax
Id (Default)
InputObject
Description
Update AS2 Station.
The command accepts as2 stations 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. It asks for confirmation by default; use -Confirm:$false in scripts that have already decided.
Examples
Example 1: Update AS2 Station
Writes the as2 station as Files.com returns it.
Example 2: Act on as2 stations from the pipeline
Takes the as2 station 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
As2 Station ID.
- Type:
System.Int64 - Parameter sets:
Id(required, position 0)
-Name
The station's formal AS2 name.
- Type:
System.String - Parameter sets:
Id,InputObject
-PublicCertificate
Public certificate used for message security.
- Type:
System.String - Parameter sets:
Id,InputObject
-PrivateKey
PEM-encoded private key matching public_certificate. Give a SecureString, such as one from Read-Host -AsSecureString or Get-Secret; text typed on the command line, even inside ConvertTo-SecureString, stays in command history.
- Type:
System.Security.SecureString - Parameter sets:
Id,InputObject
-PrivateKeyPassword
Password for the PEM-encoded private key. Give a SecureString, such as one from Read-Host -AsSecureString or Get-Secret; text typed on the command line, even inside ConvertTo-SecureString, stays in command history.
- Type:
System.Security.SecureString - Parameter sets:
Id,InputObject
-Pkcs12
Base64-encoded PKCS#12 (.pfx or .p12) file containing the identity's replacement certificate and private key. Provide this instead of public_certificate and private_key. Give a SecureString, such as one from Read-Host -AsSecureString or Get-Secret; text typed on the command line, even inside ConvertTo-SecureString, stays in command history.
- Type:
System.Security.SecureString - Parameter sets:
Id,InputObject
-Pkcs12Password
Password for pkcs12. The file and password are used only for import; the extracted certificate and private key are stored as PEM. Give a SecureString, such as one from Read-Host -AsSecureString or Get-Secret; text typed on the command line, even inside ConvertTo-SecureString, stays in command history.
- Type:
System.Security.SecureString - Parameter sets:
Id,InputObject
-InputObject
The as2 station 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.As2Station - 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: High. At the default
$ConfirmPreferenceofHigh, the command asks before each change;-Confirm:$falseruns it without asking.
-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.As2Station: a as2 station from another command of the module, as-InputObject.
Outputs
FilesCom.PowerShell.Models.As2Station: the as2 station 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.