CSV - Send to SCP
- 16 Mar 2023
- 3 Minutes to read
-
Print
-
DarkLight
-
PDF
CSV - Send to SCP
- Updated on 16 Mar 2023
- 3 Minutes to read
-
Print
-
DarkLight
-
PDF
CSV - Send to SCP creates a CSV file with the results of the saved query supplied as a trigger (or assets that were selected in the asset table), and sends it to a specific path on an SSH server using SCP.
See Creating Enforcement Sets to learn more about adding Enforcement Actions to Enforcement Sets.
General Settings
- Enforcement Set name (required) - The name of the Enforcement Set. A default value is added by Axonious. You can change the name according to your needs.
- Add description (optional) - Click to add a description of the Enforcement Set. It is recommended to describe what the Enforcement Set does.
- Run action on assets matching following query (required) - Select an asset category and a query. The Enforcement Action will be run on the assets that match the query parameters.
- A query only returns results for the asset type it was created for.
- Not all asset categories are supported for all Enforcement Actions.
- See Actions supported for Activity Logs and Adapter Fetch History Modules
- Action name - The name of the Main action. A default value is added by Axonious. You can change the name according to your needs.
- Configure Action Conditions - Toggle on to enter a condition statement. See Configuring Enforcement Action Conditions to learn more about condition statement syntax.
Connection Settings
Click to view Connection Settings
- Hostname (required) - DNS Address or IP of the SSH server.
- User name (required) - The SSH user name to connect with.
- Password (required) - A password for the SSH user, if it exists. If specified, the password is used for authentication.NOTE
For authentication, you must specify at least password or private key, but you can also specify both.
- Private key (optional) - A private key for the SSH user.
- If supplied, the private key is used for authentication.
- If not supplied, Axonius will not use the Private Key for authentication.
NOTEFor authentication, you must specify at least password or private key, but you can also specify both.
- Private key passphrase (optional, default: empty) - Specify a private key passphrase if the private key is protected by a passphrase.
- SSH port (required, default: 22) - The SSH port.
- CSV target path (required) - Specify the full path on the SSH server, including the file name. For example: /tmp/example_csv.csv.
- Tunnel Name - For Axonius-hosted (SaaS) deployments. Select the tunnel through which to connect to perform the action.
Actions Settings
Click to view Action Settings
Additional CSV Settings
- Split by asset entities - Select to create a CSV file where each asset on a device is shown as a separate row. This separates each asset as the 'expand' option in the application. It separates each asset by its entity. For example, you will be able to know which values were fetched from each adapter connection.
a. If supplied, each value on a device or user is shown as a separate row.
b. If not supplied all values on a device are in the same cell on the CSV file. - Split by field values - Choose field value - For complex fields and lists you can create a CSV file where the values of complex fields and lists are represented as separate rows in the file. From the drop-down box select the value that you want to display in the file, 'Tags' for instance. Only fields that have been discovered are available. For example, if you export by Installed Software, you will be able to see each installed Software name and its version.
- Don't split complex objects into columns - When selected, complex objects appear in a single column in JSON format. By default, each field in a complex object is split into a separate column in the CSV file.
- Export CSV delimiter to use for multi-value fields (default: Export CSV delimiter to use for multi-value fields field under the System Settings section in the GUI Settings) - Specify a delimiter to separate between values within the same field of an exported CSV file, otherwise the delimiter defined in Export CSV delimiter to use for multi-value fields is used.
- Maximum rows (default: 1048500) - Specify the maximum number of rows to be included in the CSV file. When you set a value here the generated CSV file will include the top x rows, based on the specified values. Otherwise, the generated CSV file will include the default maximum rows, set as 1048500.
For more details about other Enforcement Actions available, see Action Library.