Skip to content

Commit

Permalink
Merge pull request #385 from ritza-co/docs-19.03.06
Browse files Browse the repository at this point in the history
Docs 19.03.06 release (Week 45, 2024)
  • Loading branch information
sixhobbits authored Nov 12, 2024
2 parents 379b1e3 + e52a041 commit 48ad487
Show file tree
Hide file tree
Showing 20 changed files with 348 additions and 269 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Note that some Discovery items require enabling the feature and cannot be discov
| ------------------------- | --------------------------------- | ---------------------------------------- | ------------------------------------------------------ | ----------------------------------------------------- |
| API Gateway | Resources --> All Resources | `apigateway._region_.amazonaws.com` | Cloud vendor, cloud account, etc. | `apigateway:GET` |
| CloudFront | Resources --> All Resources | `cloudfront.amazonaws.com` | Cloud vendor, cloud account, status, tags, etc | `cloudfront:ListDistributions`, `cloudfront:ListTagsForResource` | Dynamo DB | Resources --> All Resources | dynamodb._region_.amazonaws.com | Backup details, contributor insights, tables, limits, etc. | `dynamodb:DescribeGlobalTable`, `dynamodb:DescribeLimits`, `dynamodb:DescribeTable`, `dynamodb:ListGlobalTables`, `dynamodb:ListTables` |
| EC2 Instances | Resources --> All Resources | ec2._region_.amazonaws.com | Service name, instance id, status, location, etc. | `ec2:Describe*` |
| EC2 Instances | Resources --> All Devices | ec2._region_.amazonaws.com | Service name, instance id, status, location, etc. | `ec2:Describe*` |
| Elastic Block Storage (EBS) | Resources --> All Resources | ec2._region_.amazonaws.com | Lists, rules, tags, etc. | `ec2:Describe*` (EBS is part of EC2) |
| ElastiCache Nodes | Resources --> All Resources | elasticache._region_.amazonaws.com | Account info, status, location | `elasticache:Describe*` |
| Elastic File System (EFS) | Resources --> All Resources | elasticfilesystem._region_.amazonaws.com | File system, access points, mount targets | `elasticfilesystem:DescribeAccessPoints`, `elasticfilesystem:DescribeAccountPreferences`, `elasticfilesystem:DescribeFileSystems`, `elasticfilesystem:DescribeMountTargets` |
Expand Down
30 changes: 16 additions & 14 deletions docs/auto-discovery/resources/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Resources are items identified and returned by Device42 autodiscovery jobs, and

## View All Resources

Select **Resources > All Resources** from the Device42 menu to display the Resources list page.
Select **Resources > All Resources** from the Device42 menu to display the **Resources** list page.

<ThemedImage
alt="Resources menu location"
Expand All @@ -23,7 +23,7 @@ sources={{

### Find Resources

From the Resources list page, you can **Search by name, identifier** or filter the list by **Cloud Provider** and **Vendor Resource Type**.
From the **Resources** list page, you can **Search by name, identifier** or filter the list by **Cloud Provider** and **Vendor Resource Type**.

<ThemedImage
alt="Resources search and filter options"
Expand All @@ -33,9 +33,10 @@ sources={{
}}
/>

For more filter options, click **+More** and select from a range of resource properties, including:
For more filter options, click **+ More** and select from a range of resource properties, including:

- Vendor Resource Subtype
- Regions
- Region
- Zones
- Tags
- In Service
Expand All @@ -51,13 +52,13 @@ sources={{
}}
/>

Use the **Advanced Search** option on the Resources list page to construct more specific searches. See the [Advanced Search Feature](/getstarted/advanced-search-feature.mdx) documentation for instructions.
Use the **Advanced** search option to construct more specific searches. See the [Advanced Search Feature](/getstarted/advanced-search-feature.mdx) documentation for instructions.

### View Resource Details

Click on a resource **Name** to see details about that resource, including sections for the resource-specific CI types. For example, a NetApp storage array includes sections for **Disks** and **Volumes**.

Click on links in sections to view that item's details.
Click on the links in the sections to view the details of specific items.

<ThemedImage
alt="View resource details"
Expand All @@ -77,7 +78,7 @@ sources={{

### Resource Map

Click **Resource Map** at the top left of the page to see the topography map for the resource. Use the options on the left panel to highlight and search for related CIs to display on the map.
Click **Resource Map** in the top left of a resource page to see the topography map for that resource. Use the options in the left panel to highlight and search for related CIs to display on the map.

<ThemedImage
alt="Resource map"
Expand All @@ -89,7 +90,7 @@ sources={{

### Edit a Resource

Click **Edit** on the Resources view page to edit a resource. You can add or edit **Notes** or **Tags** for the resource, toggle "Yes" on or off for **In Service**, and select or add a **Service Level** value.
Click **Edit** on a resource page to edit that resource. You can add or edit **Notes** or **Tags** for the resource, toggle **Yes** on or off to indicate whether it is **In Service:**, and select or add a **Service Level** value.

<ThemedImage
alt="Resource map"
Expand All @@ -98,15 +99,16 @@ sources={{
dark: useBaseUrl('/assets/images/autodiscovery-resources/edit-resource-dark.png'),
}}
/>
 
Click **Save** to save your edits or **Cancel** to discard them.

**Save** your edits or click **Cancel** to discard them.

## Select Resources Across Multiple Pages

Select resources across multiple list pages to run bulk actions on. Actions include deleting, archiving, or adding the resources to a Business Application.
Select resources across multiple list pages to run bulk actions on them. Actions include deleting, archiving, or adding the resources to a Business Application.

- Select the list page to view and then select resources on that page. The page shows you how many items are selected.
- Go to a different list page to select resources on that page. The page updates the selected items count. You can then apply an Action to all the selected items.
- Select the **Resources** list page to view and select resources. The page shows you how many items are selected.
- Use the numbers and arrows to scroll to different list pages and select more resources on that page. The page updates the selected-items count.
- You can then **Select an action** from the dropdown and click the **hammer icon** to apply it to the selected items.

<ThemedImage
alt="Select from multiple pages"
Expand All @@ -118,7 +120,7 @@ sources={{

## Bulk Resource Actions

To delete resources, select one or more resources from the list and choose **Fast Background Delete** or **Delete with Detailed Confirmation** from the Actions menu. Alternatively, you can run the **Fast Background Archive** action to archive the resources.
To delete resources, select one or more resources from the list and choose **Fast Background Delete** or **Delete with Detailed Confirmation** from the **Select an action** dropdown. Alternatively, you can run the **Fast Background Archive** action to archive the resources.

Click the **hammer icon** to execute the selected action.

Expand Down
54 changes: 27 additions & 27 deletions docs/auto-discovery/using-apis-for-custom-auto-discovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,46 +2,40 @@
title: "Using APIs for Custom Autodiscovery"
sidebar_position: 34
---
If you find that there are autodiscovery methods that you need and that aren't provided by Device42, you can create your own autodiscovery tools that use Device42 APIs to load data into a Device42 instance.
If you need autodiscovery methods that aren't provided by Device42, you can create your own autodiscovery tools that use Device42 APIs to load data into a Device42 instance.

Device42 provides several sample scripts that you can use as a basis for your custom autodiscovery tools. These tools are available at the [Device42 Autodiscovery Tools Site](https://github.com/device42/Device42-AutoDiscovery-Scripts) and include the following scripts:
Device42 provides several [sample scripts](https://github.com/device42/Device42-AutoDiscovery-Scripts) you can use as a basis for custom autodiscovery tools, including the following:

- `api-sample.py`: Runs against a single Windows server and uploads info to the Device42 appliance.
- `api-sample.py`: This script runs against a single Windows server and uploads info to the Device42 appliance.
- `ad-sample.py`: This script runs against Active Directory computers, servers, or a list of IP addresses, and uploads discovered systems info to the Device42 appliance.
- `d42_api_linux_upload_sample_script.py`: This script runs on a single *nix system and uploads info to the Device42 appliance.
- `sample-script-facter-facts-to-d42.py`: This script runs on a Puppet master and uploads nodes info from Facter fact files to the Device42 appliance.
- `d42_api_solaris_sample_script.py`: This script runs on an individual Solaris system and uploads info to the Device42 appliance.
- `linux_auto_dics_multi.py`: This script runs on a *nix system with Paramiko to get inventory using SSH from an IP range, and uploads to the Device42 appliance.
- `winservice.py`: This script runs against Active Directory computers, servers, or a list of IP addresses, and uploads discovered services as application components to the Device42 appliance.

- `ad-sample.py`: Runs against Active Directory computers, servers, or a list of IP addresses, and uploads discovered systems' info to the Device42 appliance.
All these scripts are written in Python, but you can use any programming language that calls RESTful APIs.

- `d42_api_linux_upload_sample_script.py`: Runs on a single *nix-based system and uploads info to the Device42 appliance.

- `sample-script-facter-facts-to-d42.py`: Runs on a Puppet master and uploads nodes info from facter fact files to the Device42 appliance.

- `d42_api_solaris_sample_script.py`: Runs on an individual Solaris system and uploads info to the Device42 appliance.

- `linux_auto_dics_multi.py`: Runs on a *nix system with Paramiko to get inventory using SSH from an IP range and upload to the Device42 appliance.

- `winservice.py`: Can run against Active Directory computers, servers, or a list of IP addresses and upload discovered services as application components to the Device42 appliance.

All these scripts are written in Python, but you can use any programming language that can call RESTful APIs.

The remainder of this document will show an example of how to use one of these scripts. We will use IronPython for this example because it is simple to install. You can drop the executables into a folder, and as long as you have the .NET 4 framework installed, you are good to go.
The remainder of this document demonstrates how to use one of these scripts. We use IronPython for this example because it is simple to install. You can drop the executables into a folder, and as long as you have the .NET 4 framework installed, you are good to go.

* * *

## Install IronPython Binaries

### Requirements:
### Requirements

- IronPython, available [here](https://ironpython.net/download/)
- The .NET Framework 4, available [here](https://www.microsoft.com/en-us/download/details.aspx?id=17851)
- [IronPython](https://ironpython.net/download/)
- The [.NET Framework 4](https://www.microsoft.com/en-us/download/details.aspx?id=17851)
- PowerShell version 1 or 2 (preferred)
- Device42 sample scripts, latest versions available [here (under `src` folder)](https://github.com/device42/Device42-AutoDiscovery-Scripts)
- Device42 [sample scripts](https://github.com/device42/Device42-AutoDiscovery-Scripts) (the latest versions are under the `src` folder)

When you have installed PowerShell and the .NET Framework 4, download the installer or binaries for IronPython. We recommend the binaries because you can unzip the folder and you are ready to go.
When you have installed PowerShell and the .NET Framework 4, download the installer or binaries for IronPython (we recommend the binaries because you can unzip the folder), and you are ready to go.

![1. Install IronPython](/assets/images/install_ironpython.png)

## Download the Sample Script (`api-sample.py`)

Download the latest script [here](https://github.com/device42/Device42-AutoDiscovery-Scripts/tree/master/src).
Download the [latest script](https://github.com/device42/Device42-AutoDiscovery-Scripts/tree/master/src).

![2. Download the sample script (api-sample.py)](/assets/images/autodiscovery-scripts-download-raw.png)

Expand All @@ -51,16 +45,22 @@ Click on the script file to open it, then click the download button and save the

Open the script and locate the following sections:

- `BASE_URL=`
- `API_DEVICE_URL=BASE_URL+`
- `API_IP_URL =BASE_URL+`
- `USER =`
- `PASSWORD=`

![3. Get Sample Script Ready for Your Environment](/assets/images/wpid2788-3.png)

Edit these sections as follows:
Edit the sections as follows:

* Change the value of `BASE_URL:` to the URL for the Device42 appliance. Ensure there is no trailing `/` at the end of the URL. Example: `BASE_URL='https://d42app.device42.pvt'`.
* Change the values for `USER` and `PASSWORD` to the credentials for an administrator user with log-in access to the Device42 appliance.
- Change the value of `BASE_URL` to the URL for the Device42 appliance. Ensure there is no trailing `/` at the end of the URL. Example: `BASE_URL='https://d42app.device42.pvt'`.
- Change the values for `USER` and `PASSWORD` to the credentials for an administrator user with log-in access to the Device42 appliance.

## Run the Script

From the command line, go to the folder containing the binaries for IronPython and run **ipy.exe**. Pass the script name as the argument:
From the command line, go to the folder containing the binaries for IronPython and run `ipy.exe`. Pass the script name as the argument:

![4. Running the Script](/assets/images/wpid2789-4.png)

Expand Down
10 changes: 2 additions & 8 deletions docs/auto-discovery/vendors-supported-in-snmp-auto-discovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,6 @@ Even if the vendor is not listed, discovery will generally still bring in some i

## Adding support for non-verified vendors

Device42 is open to supporting as many vendors as possible for SNMP-based discovery. Should you happen to run across a device that isn't being discovered fully, or if you have hardware you'd like to see supported, simply go ahead and [generate an SNMPwalk of the device](administration/appliance-manager/collecting-snmpwalk-output-for-troubleshooting.md) in question by navigating to **Application > Generate SNMP Template** in your Appliance Manager.

Fill out the form and attach your MIB Files. Once this processes, select the standard data you're looking to have added. After you've completed this form, it will be routed to our engineers for inclusion!





If you come across a device that isn't fully discovered or if you have hardware that you want to see supported, you can [generate an SNMP walk of the device](administration/appliance-manager/collecting-snmpwalk-output-for-troubleshooting.md) by navigating to **Application > Generate SNMP Template** in your Appliance Manager.

Fill out the form, attach your MIB files, and select the standard data you want added. Once you've completed this form, it will be routed to our engineers for inclusion!
Loading

0 comments on commit 48ad487

Please sign in to comment.