Asset Sonar - Delete or Retire Asset
Asset Sonar - Delete or Retire Asset deletes or retires assets in AssetSonar, for:
- Assets returned by the selected query or assets selected on the relevant asset page.
This enforcement action requires that assets have been discovered by the AssetSonar adapter and have a valid sequence_num field. Assets without this field will fail with the message "Asset does not have sequence number from AssetSonar adapter."
See Creating Enforcement Sets to learn more about adding Enforcement Actions to Enforcement Sets.
Note
- Not all asset types are supported for all Enforcement Actions.
- See Actions supported for Activity Logs, Adapters Fetch History, and Asset Investigation modules.
- See Actions supported for Aggregated Security Findings.
- See Actions supported for Software.
Required Fields
These fields must be configured to run the Enforcement Action.
- Action name - The name of this Enforcement Action. The system sets a default name. You can change the name.
- Configure Dynamic Values (optional) - Toggle on to enter a Dynamic Value statement. See Creating Enforcement Action Dynamic Value Statements to learn more about Dynamic Value statement syntax.
-
Use stored credentials from the Asset Sonar adapter - Select this option to use credentials from the adapter connection. By default, the first connection is selected.
-
When you select this option, the Select Adapter Connection drop-down becomes available. Select the adapter connection to use for this Enforcement Action.
Note
To use this option, you must successfully configure a Asset Sonar adapter connection.
-
-
Action - Select the action to perform on the asset:
-
Delete Asset - Permanently deletes an asset from the system, including checkout history, service details, comments, and all associated records.
-
Retire Asset - Deactivates an asset from the system. Retired assets do not count towards the subscription package limit and cannot be used actively, but their records are still preserved in the system (requires additional fields below).
-
-
Compute Node - The Axonius node to use when connecting to the specified host. For more details, see Working with Axonius Compute Nodes.
Additional Fields
These fields are optional.
Connection and CredentialsWhen Use stored credentials from the adapter is toggled off, some of the connection fields below are required to create the connection, while other fields are optional.
If you choose not to use stored credentials from the adapter, you must provide the following connection parameters:
Host Name or IP Address - The hostname or IP address of your AssetSonar instance (e.g.,
yourcompany.assetsonar.com).API Key - The API key for authentication with AssetSonar.
Verify SSL (optional) - Select whether to verify the SSL certificate of the server against the CA database inside of Axonius. For more details, see SSL Trust & CA Settings.
HTTPS Proxy (optional) - Connect the adapter to a proxy instead of directly connecting it to the domain.
HTTPS Proxy User Name (optional) - The user name to use when connecting to the server using the HTTPS Proxy.
HTTPS Proxy Password (optional) - The password to use when connecting to the server using the HTTPS Proxy.
Gateway Name - Select the Gateway through which to connect to perform the action.
- Retired On - Date when the asset was retired (mm/dd/yyyy format). Defaults to current date if not specified. The date will be automatically converted to mm/dd/yyyy format if provided in ISO or other common formats.
- Retire Reason - Select the reason for retiring this asset from the available options.
APIs
Axonius uses the AssetSonar API:
- Delete Asset - DELETE
/assets/{seq_num}.api - Retire Asset - PUT
/assets/{seq_num}/retire.api - Retrieve Retire Reasons - GET
/retire_reasons.api(used to populate the Retire Reason dropdown)
Required Ports
Axonius must be able to communicate via the following ports:
- TCP port 80/443 (HTTPS)
Required Permissions
The stored credentials, or those provided in Connection and Credentials, must have the following permission(s) to perform this Enforcement Action:
- API Key Authentication - A valid AssetSonar API key with appropriate permissions
- Asset Management Permissions - The API key must have permissions to:
- Delete assets (for Delete Asset action)
- Retire assets (for Retire Asset action)
- Read retire reasons (for populating the Retire Reason dropdown)
Authentication Method:
- AssetSonar uses API key authentication passed in the
tokenheader
Recommended Access Level:
- Administrator or Asset Manager role with full asset management permissions
Updated about 17 hours ago
