Set-FilesAs2Partner
Update AS2 Partner.
Syntax
Id (Default)
InputObject
Description
Update AS2 Partner.
The command accepts as2 partners 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 Partner
Writes the as2 partner as Files.com returns it.
Example 2: Act on as2 partners from the pipeline
Takes the as2 partner 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 Partner ID.
- Type:
System.Int64 - Parameter sets:
Id(required, position 0)
-EnableDedicatedIps
If true, we will use your site's dedicated IPs for all outbound connections to this AS2 Partner.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-HttpAuthUsername
Username to send to server for HTTP Authentication.
- Type:
System.String - Parameter sets:
Id,InputObject
-HttpAuthPassword
Password to send to server for HTTP Authentication. 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
-MdnValidationLevel
How should Files.com evaluate message transfer success based on a partner's MDN response? This setting does not affect MDN storage; all MDNs received from a partner are always stored. none: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. weak: Inspect the MDN for MIC and Disposition only. normal: weak plus validate MDN signature matches body, strict: normal but do not allow signatures from self-signed or incorrectly purposed certificates. auto: Automatically set the correct value for this setting based on next mdn received.
- Type:
System.String - Parameter sets:
Id,InputObject
-SignatureValidationLevel
Should Files.com require signatures on incoming AS2 messages? normal: require that incoming messages are signed with a valid matching signature. none: Unsigned incoming messages are allowed. auto: A one-time starting state. The next message received is always accepted and switches this to normal if it carries a valid signature, or none if it does not.
- Type:
System.String - Parameter sets:
Id,InputObject
-ServerCertificate
Should we require that the remote HTTP server have a valid SSL Certificate for HTTPS? (This only applies to Outgoing AS2 message from Files.com to a Partner.)
- Type:
System.String - Parameter sets:
Id,InputObject
-DefaultMimeType
Default mime type of the file attached to the encrypted message
- Type:
System.String - Parameter sets:
Id,InputObject
-AdditionalHttpHeaders
Additional HTTP Headers for outgoing message sent to this partner. Give a hashtable or PSCustomObject; keys keep their case and values their types.
- Type:
System.Collections.IDictionary - Parameter sets:
Id,InputObject
-Name
The partner's formal AS2 name.
- Type:
System.String - Parameter sets:
Id,InputObject
-Uri
Public URI where we will send the AS2 messages (via HTTP/HTTPS).
- Type:
System.String - Parameter sets:
Id,InputObject
-PublicCertificate
Public certificate for AS2 Partner. Note: This is the certificate for AS2 message security, not a certificate used for HTTPS authentication.
- Type:
System.String - Parameter sets:
Id,InputObject
-Pkcs12
Base64-encoded PKCS#12 (.pfx or .p12) file containing the partner's public certificate. Provide this instead of public_certificate. Any private key in the file is discarded. A public-only file must contain exactly one 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
-Pkcs12Password
Password for pkcs12. The file and password are used only for import; the extracted public certificate is 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 partner 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.As2Partner - 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.As2Partner: a as2 partner from another command of the module, as-InputObject.
Outputs
FilesCom.PowerShell.Models.As2Partner: the as2 partner 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.