Set-FilesSiemHttpDestination
Update SIEM HTTP Destination.
Syntax
Id (Default)
InputObject
Description
Update SIEM HTTP Destination.
The command accepts siem http destinations 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 SIEM HTTP Destination
Writes the siem http destination as Files.com returns it.
Example 2: Act on siem http destinations from the pipeline
Takes the siem http destination 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
Siem Http Destination ID.
- Type:
System.Int64 - Parameter sets:
Id(required, position 0)
-Name
Name for this Destination
- Type:
System.String - Parameter sets:
Id,InputObject
-AdditionalHeaders
Additional HTTP Headers included in calls to the destination URL Give a hashtable or PSCustomObject; keys keep their case and values their types.
- Type:
System.Collections.IDictionary - Parameter sets:
Id,InputObject
-SendingActive
Whether this SIEM HTTP Destination is currently being sent to or not
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-GenericPayloadType
Applicable only for destination type: generic. Indicates the type of HTTP body. Can be json_newline or json_array. json_newline is multiple log entries as JSON separated by newlines. json_array is a single JSON array containing multiple log entries as JSON.
- Type:
System.String - Parameter sets:
Id,InputObject
-FileDestinationPath
Applicable only for destination type: file. Destination folder path on Files.com.
- Type:
System.String - Parameter sets:
Id,InputObject
-FileFormat
Applicable only for destination type: file. Generated file format.
- Type:
System.String - Parameter sets:
Id,InputObject
-FileIntervalMinutes
Applicable only for destination type: file. Interval, in minutes, between file deliveries. Valid values are 5, 10, 15, 20, 30, 60, 90, 180, 240, 360.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-SplunkToken
Applicable only for destination types: splunk, splunk_compatible. Authentication token for the destination. 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
-CrowdstrikeToken
Applicable only for destination type: crowdstrike. Authentication token provided by Crowdstrike. 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
-AzureDcrImmutableId
Applicable only for destination types: azure, azure_legacy. Immutable ID of the Data Collection Rule.
- Type:
System.String - Parameter sets:
Id,InputObject
-AzureStreamName
Applicable only for destination type: azure. Name of the stream in the DCR that represents the destination table.
- Type:
System.String - Parameter sets:
Id,InputObject
-AzureOauthClientCredentialsTenantId
Applicable only for destination types: azure, azure_legacy. Client Credentials OAuth Tenant ID.
- Type:
System.String - Parameter sets:
Id,InputObject
-AzureOauthClientCredentialsClientId
Applicable only for destination types: azure, azure_legacy. Client Credentials OAuth Client ID.
- Type:
System.String - Parameter sets:
Id,InputObject
-AzureOauthClientCredentialsClientSecret
Applicable only for destination type: azure. Client Credentials OAuth Client Secret. 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
-QradarUsername
Applicable only for destination type: qradar. Basic auth username provided by QRadar.
- Type:
System.String - Parameter sets:
Id,InputObject
-QradarPassword
Applicable only for destination type: qradar. Basic auth password provided by QRadar. 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
-SolarWindsToken
Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds. 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
-NewRelicApiKey
Applicable only for destination type: new_relic. API key provided by New Relic. 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
-DatadogApiKey
Applicable only for destination type: datadog. API key provided by Datadog. 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
-ActionSendEnabled
Whether or not sending is enabled for action logs.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-SftpActionSendEnabled
Whether or not sending is enabled for sftp_action logs.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-FtpActionSendEnabled
Whether or not sending is enabled for ftp_action logs.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-WebDavActionSendEnabled
Whether or not sending is enabled for web_dav_action logs.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-SyncSendEnabled
Whether or not sending is enabled for sync logs.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-OutboundConnectionSendEnabled
Whether or not sending is enabled for outbound_connection logs.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-AutomationSendEnabled
Whether or not sending is enabled for automation logs.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-ApiRequestSendEnabled
Whether or not sending is enabled for api_request logs.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-PublicHostingRequestSendEnabled
Whether or not sending is enabled for public_hosting_request logs.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-EmailSendEnabled
Whether or not sending is enabled for email logs.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-ExavaultApiRequestSendEnabled
Whether or not sending is enabled for exavault_api_request logs.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-SettingsChangeSendEnabled
Whether or not sending is enabled for settings_change logs.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-DestinationType
Destination Type
- Type:
System.String - Parameter sets:
Id,InputObject
-DestinationUrl
Destination Url
- Type:
System.String - Parameter sets:
Id,InputObject
-InputObject
The siem http destination 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.SiemHttpDestination - 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.SiemHttpDestination: a siem http destination from another command of the module, as-InputObject.
Outputs
FilesCom.PowerShell.Models.SiemHttpDestination: the siem http destination 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.