Skip to main content
Sign in

Creating an extended integration for AWS WorkSpaces assets

Caroline Maguire
  • June 07, 2022 07:00
  • Updated

Let Oomnitza be your single source of truth!

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

Connect Oomnitza and AWS Workspaces 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
  • Configurable workflows that you can easily create to automate tasks such as:
    • Workflows for creating, terminating or stopping WorkSpaces
    • Workflows for getting, creating and deleting WorkSpace tags

Navigation

small_blue_link.svgAdding the credentials

small_blue_link.svgCreating the asset integration

small_blue_link.svgCreating custom mappings

small_blue_link.svg Creating workflows

small_blue_link.svgCreating asset workflows with the API block

Amazon AWS Start Workspace

Amazon AWS Reboot Workspace

Amazon AWS Stop Workspace

Amazon AWS Terminate Workspace

Amazon AWS Workspace Add Tags

Amazon AWS Workspace GetTag

Amazon AWS Workspace Delete Tag

Before you start

Best practice
For the integration with Oomnitza, create a dedicated user account.

Oomnitza requires AWS Auth based authentication. For further information on how to obtain these credentials, see AWS Authentication.

Adding the credentials

To add AWS credentials to Oomnitza, see Adding AWS credentials.

Creating the asset integration

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

  1. In Oomnitza, click Configuration > Integrations.
  2. Click Integrations List View small_SettingsListView.svg.
  3. On the Integrations page, scroll down to the Extended section for Assets.
  4. Click NEW INTEGRATION.
  5. In the New Asset Integration sidebar, click Amazon AWS Workspaces Load.
  6. To integrate Oomnitza with the Amazon AWS Workspaces Load, click APPLY and then click NEXT twice.

On the connect page, complete the following steps to connect the integration:

  1. Enter a descriptive name for the integration such as AWS Workspaces Assets. This name will be displayed on the Integrations page once the setup is complete.
  2. Select Cloud as the installation type.
  3. From the Credentials list, select the credentials from the Oomnitza vault that you added for the connection. For further information, refer to Adding AWS credentials.
  4. From the Integration Preferences list, select Create & Update. 
  5. Enter the name of the user of the integration.
  6. Enter the Region. For further information, refer to Regions, Availability Zones, and Local Zones. You can only specify one region per integration. To add another region, see Adding more regions to your integration
  7. Click Next.

Creating custom mappings

Map AWS EC2 fields to Oomnitza fields to get the user information that you need. For the field mapping, it is recommended to follow these steps:

  1. Create a custom mapping for the AWS Connect : Region. To do this, complete the following steps:
    1. Select the down arrow on the ID field that you want to map.
    2. Select Add new Oomnitza assets field.
    3. Change the name of the field to AWS Region.
    4. Click CREATE. 
  2. Create a custom mapping for the AWS Workspace ID. To do this, complete the following steps:
    1. Select the down arrow on the ID field that you want to map.
    2. Select Add new Oomnitza assets field.
    3. Change the name of the field to Serial Number.
    4. Click CREATE. 
  3. Create custom mappings to map any other field that you want to add to Oomnitza:
    1. Click the down arrow on the field that you want to map.
    2. Select Add new Oomnitza assets field.
    3. Change the name of the field.
    4. Click CREATE. 
  4. The Workspace ID should be mapped to the Oomnitza Serial Number field, or a similar field. Assign a sync key to the Workspace ID field.
  5. Click NEXT. 

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: Region

Custom mappings

Bundle ID
Compute Type Name
Computer Name
Connector Sync Time
IP Address
Recycle Mode
Root Volume Size in GB
Running Mode
Running Mode Auto Timeout
Status
Subnet Id
User Name
User Volume size in GB
Workspace ID

blue_link.svg Learn more about mapping

When you've completed mapping AWS WorkSpaces fields to Oomnitza fields, click NEXT.   

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. Configure your schedule.
  2. Click FINISH.

Result

A new tile is created for the integration on the Integrations page. 

What to do next

If you want to see what information is collected now, click the tile on the Integrations page and click RUN NOW.

If you want to change the integration settings, you can click a navigation link on the page, such as 4 Mappings, and edit the settings.

edit-integration.svg 

Adding more regions to your integration

Once the integration is created, you can add more regions to your integration. To add another region, complete the following steps:

In Oomnitza, click Configuration > Integrations.

  1. Click Integrations List View small_SettingsListView.svg.
  2. On the Integrations page, scroll down to the Extended section for Assets and select your integration.
  3. Click the plus sign on the AWS logo and repeat the steps to connect the integration.

Tip
To view the information that is collected about your mobile assets, click Assets. 

Creating workflows

Creating asset workflows with the API block

To reduce your workload and automate complex and repetitive tasks, you can create workflows with the API block by following the steps in Creating asset workflows with the API block. To locate the available presets, enter workspace in the Select Preset search field. Select your preset of choice and for every preset enter the following information in the Configure section:

The AWS WorkSpaces API block workflow comes with the following presets:

Amazon AWS Start Workspace

This Amazon AWS Start Workspace allows you to start an existing workspace.

The AWS fields Connect:Region and Workspace ID are assumed to be stored in the Oomnitza fields that you mapped in Creating custom mappings. If these fields are mapped differently in your implementation, you need to update your API workflow block to the correct Oomnitza fields. To do this, complete the following steps:

  1. In the API block window, click the Advanced Mode button located in the upper right of the window.
  2. Select the Information tab. Update the aws_region field to the field name in Oomnitza. The field name should be in lower case, and spaces replaced with an underscore, example new_aws_region.
  3. Select the Body tab. Update the serial_number field to the field name in Oomnitza. The field name should be in lower case, and spaces replaced with an underscore.

This preset only works on Workspaces that have a running mode of AutoStop and a state of STOPPED.For further information see StartWorkspaces.

Amazon AWS Reboot Workspace

The Amazon AWS Reboot Workspace allows you to reboot an existing Workspace. You cannot reboot a WorkSpace unless the state is AVAILABLE or UNHEALTHY.For further information see RebootWorkspaces.

Amazon AWS Stop Workspace

The Amazon AWS Stop Workspace allows you to stop an existing Workspace. You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of  AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.For further information see StopWorkspaces.

Amazon AWS Terminate Workspace

The Amazon AWS Terminate Workspace terminates the specified WorkSpaces. You can terminate a WorkSpace that is in any state except SUSPENDED. For further see TerminateWorkspaces.

Important
Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact AWS Support before terminating the WorkSpace.

Amazon AWS Workspace Add Tags

This Amazon AWS Workspace Add Tags allows you to add or update a tag for a given workspace. It is recommended that you adhere to the following steps when using this preset:

  1. In the API block window, click the Advanced Mode button located in the upper right of the window.
  2. Select the Body tab.
  3. Replace myTagFieldName with the tag name in AWS you want to create/update and set Oomnitza_field to the Oomnitza field value you want to reference for this tag.

Note: If the Oomnitza field value is an empty string, this preset sets the value in the value of the tag in AWS to "--EMPTY--".

Amazon AWS Workspace GetTag

This Amazon AWS Workspace GetTag preset allows you to read tags from the workspace and map them to fields within Oomnitza. 

Once you have applied the preset, use the response mapping within the Advanced Mode to do the mapping. To set the response mapping, complete the following steps:

  1. In the API block window, click the Advanced Mode button located in the upper right of the window.
  2. Select the Response tab.
  3. In the Response field, use a Jinja statement like the following:
 {% set temp = response['TagList']%}{%if (temp is defined) and temp%}{{ temp | selectattr('Key', 'eq', 'myTagField') | map(attribute='Value') | join('') }}{% endif %}

This will map the tag which is named myTagField in AWS to the field you select in the response mapping screen.

The AWS fields Connect:Region and Workspace ID are assumed to be stored in the Oomnitza fields that you mapped in Creating custom mappings. If these fields are mapped differently in your implementation, you can follow steps 1 to 3 in Amazon AWS Start Workspace to update your API workflow block to the correct Oomnitza fields.

Amazon AWS Workspace Delete Tag

This Amazon AWS Workspace Delete Tag allows you to delete a tag for a given workspace.

It is recommended that you adhere to the following steps when using this preset:

  1. In the API block window, click the Advanced Mode button located in the upper right of the window.
  2. Select the Body tab.
  3. Replace myTagFieldName with the tag name in AWS you want to delete.

For further information see DeleteTags.

For further information on workflows see:
small_blue_link.svg Understanding workflows
small_blue_link.svg Workflow block overview

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.

Powered by Zendesk