Skip to main content
Sign in

Creating an extended integration for AWS EBS volume assets

  • November 10, 2024 13:07
  • Updated

Let Oomnitza be your single source of truth!

You'll get complete visibility of your assets and users as data from AWS EBS Volumes is automatically transformed into consumable information and actionable insights.

This integration allows you to load the list of AWS EBS Volumes into Oomnitza. The number of EBS volumes can be returned is 200. For further information, see AWS API Documentation: DescribeVolumes.

Tip
This integration only provides you with a list of in-use or available volumes, not volumes that have already been deleted. If you want to reduce the list to only show volumes that are recently active or in use, you can create a workflow to archive items that have not been updated in a while.

Connect Oomnitza and AWS EBS Volumes in minutes

Get the information and insights that you need to reduce costs and the time that you spend on administration tasks such as:

  • Configurable dashboards and list views of key asset information
  • Configurable reports to share information about your assets with your colleagues and management

Before you start

When you create the integration, you can specify the following:

1. Multiple AWS Regions

Enter a space-separated list of AWS Regions, such as us-east-1 us-west-2. The data received from each region appears as a separate sync session in the Sync Sessions table.

AWS_integration_sync_sessions.PNG

To find your AWS region, refer to Regions, Availability Zones, and Local Zones.

2. Enable Cross-Account access

Select the IAM Roles checkbox to iterate over all AWS accounts with IAM roles. The data received from all iterated roles will be added as one sync session for each region in the Sync Sessions table.

Before you select this option, you must enable cross-account access in your AWS accounts. For further information see Create an IAM user to easily access all your accounts using the AWS console.

Adding the credentials

When you create the integration, you need to add your AWS Access keys to Oomnitza. See Adding your AWS credentials to Oomnitza.

Creating the asset integration

To configure the integration for the AWS EBS Volume Load, complete the following steps:

  1. In Oomnitza, click Configuration> Integrations> Overview.
  2. Click Block view block_view.PNG
  3. Scroll down to the Extended section for asset integrations.
  4. Click NEW INTEGRATION.
  5. Select the integration in the sidebar.
  6. Click ADD.

Integration details overview

More information is provided about the following fields to help you complete the integration:

Installation type

Select Cloud if you want to store credentials in the Oomnitza cloud.

Select Local if you want to store credentials locally. Local extended integrations do not support AWS and OAuth authentication. If you want to sync Oomnitza with vendor applications that require AWS or OAUTH authentication, select Cloud.

Integration preferences

By default, the option Create & Update option is selected. Select this option  when you want to edit records and add new records. If you want to edit records and not add new records, select Update Only. If you only want to add new records, select Create Only.

Integration details

To review or update the integrations details, click Edit edit_black_pencil_icon.svg.

  1. Update the integration name if necessary. 
  2. Select an installation type.
  3. For integration preferences, select an option.
  4. Enter the name of the integration user.

Credential details

If you selected Cloud as the installation type, choose one of the following options:

  • Select the credentials that were created for the integration.
  • Edit the credentials that were created for the integration.
  • Create new credentials

Schedule

By default, data is streamed to Oomnitza once every day.

You can configure the schedule to meet your needs such as changing the interval or changing the time so that the data is streamed when your system isn't busy.

  1. Click the Edit edit_black_pencil_icon.svg.
  2. Configure your schedule.
  3. Click Update.

Mappings

To map the fields to Oomnitza, click Edit edit_black_pencil_icon.svg.

TipBulb_Icon_small.svgYou can define rules for your integration by selecting Edit integration edit_integration.svg on the mapping page. For example, you may only want to run the integration if a certain contact or region exists. See Filtering integration results.  
You can add new fields to your integration by selecting Add new field  add_grey_rectangel_icon.svg on the mapping page. All you need to do is specify the property name. See Creating custom API fields. 

Creating custom mappings

Map AWS EBS fields to Oomnitza fields to get the user information you need.

If you want to map the AWS Status field to Oomnitza, complete these steps first:

  1. Click Configuration > Data Model > Field Configuration. By default a list of the asset fields are displayed.
  2. Click Add field.
  3. Name the field AWS Status. 
  4. Click the Dropdown checkbox.
  5. In the Dropdown tab, enter the following options as separate entries: creating | available | in-use | deleting | deleted | error
  6. Click CREATE. 
  7. Return to your integration in the Configuration > Integrations menu.

For the field mapping, it is recommended to follow these steps:

  1. Create custom mappings for the Region field. 
    1. Click the down arrow on the Region field.
    2. Select Add new Oomnitza assets field.
    3. Change the name of the field to AWS Region.
    4. Click CREATE. 
  2. Map the Status field to the AWS Status field you created. You can map the fields by:
    • Dragging the source field to the target field on the Oomnitza side 
    • Selecting the dropdown arrow on the source field and choosing an appropriate target field from the list.
  3. Map the Volume ID to the Oomnitza Serial Number field, or a similar field. Assign a sync key to the Serial Number field.
  4. Click UPDATE. 

Tracking information for asset loads 

When the integration is run, you can track the name of the credentials that were used and the source of the data. To do this, you map the following fields to Oomnitza:   

  • Connect: Credentials
  • Connect: Enable Cross-Account
  • Connect: Region

Custom mappings

Attach status
Attached since
Availability Zone
Connector Sync Time
Creation Time
Delete on Termination?
Encrypted?
Mapped device/path
Multi attach enabled?
Primary Instance*
Region
Size (in GB)
Status
Volume ID 
Volume Name
Volume Type

* The first instance that this volume is mapped to. In the case of multiple instances, we only show the first one.

Launching the integration

Your integration is in Draft mode until the required mandatory fields are added. When added, click Launch to activate your integration. 

small_blue_link.svg If you selected Cloud as the installation type when creating the integration, see Running an extended integration

small_blue_link.svg If you selected Local as the installation type when creating the integration, see Running an extended integration locally.

Viewing data ingested by Oomnitza

Viewing ingested asset data

For asset integrations, click Hardware. If the asset integration also ingests software data, click Software.

Viewing ingested user data

For user integrations, click People. If you chose the option to ingest User and SaaS user data, click Software > SaaS, click the SaaS app, and then click the Users tab. 

Related Links

Unleash the power of Oomnitza

To get valuable actionable insights that help you manage your assets, learn how to:

      • Configure dashboards for your users and software
      • Configure custom reports about your users and software
      • Create workflows to automate tasks

See small_blue_link.svg Getting started for more information.

Related articles

Comments

0 comments

Please sign in to leave a comment.