Creating an extended integration for Puppet assets and users

Let Oomnitza be your single source of truth!

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

Connect Oomnitza and Puppet 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 and user information
• Configurable reports to share information about assets and users with your colleagues and management
• Configurable asset workflows that you can easily create such as:
  • Workflows for getting information about nodes
  • Workflows for deleting users

Integrate Puppet with Oomnitza

Configure the following extended connectors:

 Extended connector integration for assets

  Extended connector integration for users

Before you start

To stream Puppet data into Oomnitza, you must add your Puppet authentication credentials to the credentials vault in Oomnitza.  The authentication method that you use depends on the API that you use to connect to Puppet.

Puppet Enterprise APIs

Puppet Enterprise Ports 

Puppet Token Based Authentication and Token endpoints

To add credentials to the vault in Oomnitza and integrate Puppet with Oomnitza, you need to know the following information:

• The API key that you generated to authenticate with Puppet
• Your Puppet API domain name and API port number  

Add the Puppet domain and port number to global settings

To save time entering information create workflows, you can add your Puppet domain and port as global variable to Oomnitza.

Procedure

1. In Oomnitza, click Settings > Global Settings.
2. Click Add new variable (+). 
3. Enter Puppet.Puppet Cloud Domain as the variable name.
4. Enter the domain name of your Puppet API.
   Let's say your URL looks like this: https://<puppet_api>:nnnn where nnnn represents the port number.  You enter the part of the URL between  https//: and :nnnn.
5. Click SAVE.
6. Click Add new variable (+).
7. Enter Puppet.Puppet Port as the variable name.
8. Enter the port number.
9. Click SAVE.

Add credentials to the vault in Oomnitza

To authorize connections between Oomnitza and , complete these steps:

1. Log into Oomnitza.
2. Click Settings > Credentials, and then click Add new credential (+).
3. Add the information details.
4. Click the AUTHORIZATION tab.
5. As authorization type select API Key.
6. Enter X-Authentication as the name of the token. 
7. Enter the API Key, which is the key that you got for the Puppet API.
8. Ensure that Add to Header is selected.
9. Click CREATE. 

Tip
You can use the same credentials for the assets integration and the user integration.

Extended connector integration for assets

Info and connect details

1. From the menu, select Settings.
2. On the Integrations page, scroll down to the Extended section for Assets.
3. Click NEW INTEGRATION.
4. In the New Asset Integration sidebar, click Puppet.
5. To integrate Oomnitza with the  Puppet Node Asset Load, click APPLY and then click NEXT twice.

Connect page

1. Enter a descriptive name for the integration such as Puppet Assets. That'll be the name of the integration tile that is shown on the Integrations page.
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.
4. From the Integration Preferences list, select Create & Update. 
5. Enter the name of the user of the integration.
6. Enter the domain name for the Puppet API. 
7. Enter the port number. 
8. Click Next.

Mappings

Map the Puppet fields to Oomnitza fields and create custom mappings to get the information that you need to manage your desktop assets.

 Learn more about mapping

Complete the following actions:

1. Click SMART MAPPING. The Connector Sync Time field is automatically mapped to Oomnitza.
2. Complete the following actions:
   1. On the Certname field , click the down arrow and map it to the Serial Number field.
   2. Select Serial Number as the sync key.
3. On the Catalog Environment filed, click the down arrow and map it to the Puppet Catalog Environment field.
4. To map other Puppet fields to Oomnitza, complete these actions:
   1. Click the down arrow on the field.
   2. Select Add new Oomnitza assets field.
   3. Change the label name to a shorter user friendly name.
   4. Click CREATE.
5. Click NEXT.   

Want to map more Puppet fields to Oomnitza?
Contact Support, or see Mapping extended connectors.

Custom Puppet to Oomnitza field mappings

The following Puppet fields can be mapped to Oomnitza: 

Cached Catalog Status
Catalog Environment
Catalog Timestamp
Certname
Connector Sync Time
Deactivated
Expired
Facts Environment
Facts Timestamp
Is Latest Report Corrective Change
Is Latest Report Noop
Is Latest Report Noop Pending
Latest Report Hash
Latest Report Job Id
Latest Report Status
Report Environment
Report Timestamp

Schedule

By default, Puppet asset 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.

Figure: Mock-up for illustration purposes

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. 

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

Extended connector integration for users 

Info and connect details

1. From the menu, click Settings.
2. On the Integrations page, scroll down to the Extended section for User Integrations.
3. Click NEW INTEGRATION.
4. In the New User Integration sidebar, click Puppet.
5. To integrate Oomnitza with the  Puppet User Load, click APPLY and then click NEXT twice.

Connect page

Best practice
To ensure that only live user records are streamed from Puppet to Oomnitza, choose Update only as your integration preference. When you run the integration, you can check the error logs to see which user records weren't uploaded and why they weren't uploaded. You can then decide whether to upload the user records that were skipped by changing your integration preference to create and upload. See Access error logs.

1. Enter a descriptive name for the integration such as Puppet Users. That'll be the name of the user integration that is shown on the Integrations page.
2. From the User Selection list, select User plus SaaS User. 
3. From the installation type list, select Cloud.
4. From the Credentials list, select the credentials from the Oomnitza vault.
5. From the Integration Preferences list, select Update only.   
6. Enter the name of the user of the integration.
7. Enter your Puppet API domain name.
8. Enter the Puppet port number. 
9. Click Next.

Mappings

Map the Puppet fields to Oomnitza fields and create custom mappings to get the user information that you need.

1. Click SMART MAPPING. The Connector Sync Time and the Email fields are automatically mapped to Oomnitza.
2. Click the down arrow on the Email field and map it to the Oomnitza Email and Username fields. Then, select Username as the sync key.
3. Select Employee from the Role field.

To map the other Puppet fields to Oomnitza, complete these steps:

1. Click the down arrow on the Puppet field and select Add Oomnitza user field.
2. Change the name of the field.
3. Click CREATE. 

Standard Puppet to Oomnitza mappings

The following Puppet fields can be mapped to Oomnitza: 

Connector Sync Time
Display Name
Email
Group Ids List
Id
Inherited Role Ids List
Is Group
Is Remote
Is Revoked
Is Superuser
Last Login
Login
Role Ids List

Ensure that you select one of the fields as the Sync Key such as the email address of the user. 

Want to map more Puppet fields to Oomnitza?
Contact Support, or see Mapping extended connectors.

When you've completed mapping the Puppet fields to Oomnitza fields, click NEXT.

Schedule

By default, Puppet asset and software 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.

Figure: Mock-up for illustration purposes

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. 

Review the errors. You can then decide whether you need to change your integration preference from Update only to Create & Update.

Use presets to create asset workflows

To reduce costs by automating repetitive and  complex tasks, take advantage of the built-in presets that Oomnitza provides.

To choose a preset, complete these steps:  

1. Click Assets > Workflow.
2. Click Add (+) and enter the name and description of the workflow.
3. Click Add new. A Begin and End block are automatically added to the Sandbox.
4. Drag and drop the API block onto the Sandbox.
5. Click Edit on the API block and enter Puppet in the search field. 
6. Select a preset:
   • Puppet Delete User
   • Puppet Get Fact
   • Puppet Get Specific Facts
7. Click >, configure the API Block, and save your changes.
8. To trigger the workflow, edit the Begin Block.
9. Connect the Blocks. 
10. Validate, launch, and save your workflow.

Understanding Workflows

Unleash the power of Oomnitza

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

• Configure dashboards for your assets
• Configure workflows for automating onboading and offboarding employees and tracking lost and stolen assets
• Configure custom reports about your assets 

See Getting started.