Skip to content

Commit

Permalink
Merge pull request #275 from device42/18.13-release
Browse files Browse the repository at this point in the history
18.13 release
  • Loading branch information
sixhobbits authored Jan 31, 2024
2 parents 0fd9438 + 4e38d6e commit c5ba58d
Show file tree
Hide file tree
Showing 37 changed files with 243 additions and 45 deletions.
4 changes: 4 additions & 0 deletions docs/administration/main-appliance-remote-collector-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,7 @@ If you’re less than three versions behind, downloading the new MA file will br
## If I am on the latest MA release, how do I update my Remote Collectors?

This update will need to be pushed via the Appliance Manager once you have the upgrade file. Step by step instructions can be found here: [https://docs.device42.com/getstarted/faqs/](getstarted/faqs/index.md).

## How is the Remote Collector proxy configured?

The proxy that you set up in the MA will be used for remote collector too. You can view and edit the inherited proxy settings from the [RC view and edit page](auto-discovery/remote-collector-rc.md/#viewedit-remote-collector).
10 changes: 8 additions & 2 deletions docs/auto-discovery/agent-based-discovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,22 @@ There exist special situations in which an agent simply makes more sense, and fo

Some situations simply cannot be discovered agentlessly either because they are unreachable from the network, or because certain rules don't permit traffic flow. These special cases, and other security-hardened uses that may prove difficult otherwise are cases for which we recommend customers utilize agents. Note you are free to deploy and use agents as you see fit, as agents provide equivalent functionality vs. Device42's agent-less discovery, but we do recommend the majority of users stick with agent-less.

**Discovery Account _WARNING:_ Please do _not_ set up an auto-discovery / scan using critical \[production\] account credentials! Please create a separate, dedicated account to use _only_ for discovery**
:::warning
**Discovery Account warning: Please do _not_ set up an autodiscovery scan using critical or production account credentials! Please create a separate, dedicated account to use _only_ for discovery**

Doing so, depending on permissions granted & configured password policies could result in account lock-out, therefore causing an otherwise completely avoidable outage.
Doing so, depending on permissions granted and configured password policies could result in account lock-out, therefore causing an otherwise completely avoidable outage.
:::

## Supported Platforms

**Device42 Autodiscovery agents are available for deployment on the following platforms:**

<table><tbody><tr><td><ul><li>Windows (32) NT 4.0</li><li>Windows (32) Win 7+</li><li>Linux (32-bit)</li><li>FreeBSD v10+ (32)</li><li>FreeBSD v1-9 (32)</li><li>OpenBSD v6+ (32)</li><li>OpenBSD pre v6 (32)</li><li>Solaris Sparc (64)</li></ul></td><td><ul><li>Windows (64) NT 4.0</li><li>Windows (64) Win 7+</li><li>Linux (64-bit)</li><li>FreeBSD v10+ (64)</li><li>FreeBSD v1-9 (64)</li><li>OpenBSD v6+ (64)</li><li>OpenBSD pre v6 (64)</li><li>Mac</li></ul></td></tr></tbody></table>

:::info
See **[Windows Discovery Agent Service Wrapper](getstarted/installation/windows-service-installation.mdx)** and **[Mac Agent Service Launcher](mac-agent-service-launcher.mdx)** for information on installing versions of the Windows and Mac discovery agent as a service.
:::

## Installation

The client can be downloaded by going to _Discovery > Agent Based Scans_. Enter the URL as it will be accessed by the agent from the remote machine, and choose your platform: Windows, Mac, Linux, FreeBSD, etc.
Expand Down
1 change: 1 addition & 0 deletions docs/auto-discovery/auto-discovery-system-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ The following are pre-requisites and other general requirements and guidelines f
- Minimum system resource configuration for the Device42 appliance: 4 vCPUs and 8GB memory. Ensure that a _minimum_ 1GBPS network connection is present, that there is a dedicated resource pool for the Device42 VM, and that there are no resource contention issues. Placing the Device42 Appliance's (Virtual Machine) VHD on SSD is ideal, but is not required.
- WinRM Windows discovery can be run from the main appliance or a Remote Collector. Deploy remote collector(s) to desired network segments and select them when configuring your discovery jobs where appropriate, if desired.
- To _(optionally)_ exclude known service port ranges from discovery, proceed to **Tools > Settings > Global Settings > Win/*nix Exclusions** and add your desired exclusions to the Autodiscovery application. This will limit the scope and volume of data that is discovered, helping to reduce noise and overhead while shortening the overall discovery time.
- Ignore certain IP and MAC addresses for all jobs by creating an exclusion for it in **Tools > Settings > Global Settings > Win/*nix Exclusions**. The device(s) will still be discovered, but its are details dropped from ingestion.

Detailed permission info:

Expand Down
14 changes: 13 additions & 1 deletion docs/auto-discovery/cloud-auto-discovery/aws-autodiscovery.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,6 @@ Note that some Discovery items require enabling the feature and cannot be discov
| Subnets | Network --> Subnets | | Subnets |
| VPCs | Resources --> VPC | vpc.aws-region.amazonaws.com | Attributes, AZs, Auth rules, etc. |


**Additional Endpoint Information**

_**Regular Discovery**_
Expand Down Expand Up @@ -190,6 +189,14 @@ _**Example of minimum policy**_ _(except for K8s cluster endpoints, since it is
]
}
```

### AWS Tags

Organizations that use AWS tags can retrieve tags associated
with each cloud account within AWS. Discovered tags are located under the **Vendor Custom Fields** field.

![Vendor Custom Fields with AWS tag](/assets/images/cloud-discovery-aws/vendor-custom-fields.png)

* * *

### Amazon S3 Fields and Access Control
Expand Down Expand Up @@ -335,3 +342,8 @@ When discovering your Amazon Cloud via the Amazon API, Device42 authenticates ag
- **Strip Domain Name:** Strips the domain name (everything after the first period) from the name as discovered before storing in Device42
- **Object category for discovered devices:** Choose a category to assign to discovered devices
- **Overwrite existing object categories:** Select this option to overwrite any previously assigned categories with the current selection

## Using AWS Roles To Discover Accounts Within Discovery Jobs

AWS Cloud Discovery Jobs can use AWS roles to discover accounts. When the job includes the AWS role, the discovery job will dynamically grab multiple accounts from AWS. We previously (before v18.13) aimed to maintain a 1:1 relationship between roles and accounts. Now, a single role can discover multiple accounts. This enables AWS users to set up discovery and specify the precise account to create, or leave the account empty to have the discovery job create Cloud accounts as a result of the discovery.

Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,7 @@ Device42's Cisco ASA/NX OS autodiscovery augments firewall/ASA discoveries with
### Notes on Nutanix Autodiscovery

If you have previously ran a D42 discovery job, and are discovering new resources, then in some cases, you will need to delete and re-run to have a complete view. Note that this is a discovery workaround for the time being.

### Ignore IP/MAC Addresses From Autodiscovery

You have the option to ignore specific IP and MAC addresses globally and for specific jobs. See [Windows and Hyper-V Autodiscovery](windows-and-hyper-v-auto-discovery.md/#option-to-ignore-ipsmac-addresses) for more details.
39 changes: 39 additions & 0 deletions docs/auto-discovery/linux-unix-server-auto-discovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,35 @@ sidebar_position: 16

Device42 supports SSH-based Linux and UNIX discovery from within the main appliance (v13.2+). For a full list of supported Linux/UNIX operating systems, please visit [Device42 Supported Operating Systems.](auto-discovery/operating-systems-supported-in-auto-discovery.md)

## Information Discovered

## Discovered Information

Provided with a successful configuration of the discovery account, and given the data's availability, Device42 will gather the following information:

<table>
<tbody>
<tr>
<td width="20%">
<ul>
<li>Device host information</li>
<li>Parts</li>
<li>Operating System</li>
</ul>
</td>
<td width="25%">
<ul>
<li>Service processes</li>
<li>Software installed</li>
<li>Installed common applications and configuration files</li>
</ul>
</td>
</tr>
</tbody>
</table>

Within the **Parts** section of device details, the CPU, RAM, and storage entries for the device will be displayed. You may also see additional information such as model number, slot, and location.

## Setting up Linux/Unix Autodiscovery

Before configuring an ssh-based discovery job, please be sure you have your SSH port (standard TCP port 22, or a custom port) open between your Device42 Main Appliance or Remote Collector and the targeted Unix/Linux servers. Select _Discovery > Hypervisors / *nix / Windows_ from the main menu to add a Linux/UNIX discovery job to connect and gather host and VM details. On the Add Hypervisors/*nix/win for Autodiscovery page, choose *nix as the platform, and enter your discovery target (hostnames, IPs or IP range, or CIDR), credentials, and job options. 
Expand All @@ -31,6 +60,16 @@ Before configuring an ssh-based discovery job, please be sure you have your SSH

Depending on permissions granted and your configured password policies, account lock-out could result in an otherwise completely avoidable outage. You, the customer, are responsible for any such behavior that might result if you choose to ignore this requirement.

## Option To Ignore IPs/MAC Addresses

You can ignore IP and MAC addresses from being included in our database during autodiscovery. Devices with these addresses will still be discovered but the detailed information that would typically be collected and stored is ignored.

Configure rules to ignore IP and MAC addresses for a specific job when creating or editing the job.

![Ignore IPs and MACs](/assets/images/ip-mac-ignore.png)

Globally, you can add an **Exclusion** to ignore IP and MAC addresses for all jobs by navigating to **Tools > Settings > Global Settings** on the Main Appliance.

* * *

### Naming Options
Expand Down
4 changes: 4 additions & 0 deletions docs/auto-discovery/remote-collector-rc.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,10 @@ The Remote Collector list page Actions Menu contains commands you can use for se

![](/assets/images/D42-23170_RC-list-page-set-log-level-2.png)

## Remote Controller Proxy Settings

The proxy settings within the Main Appliance and RC are set independently but are often identical. To reduce the potential for error, the RC can pick up proxy settings that have been configured. You can view and edit the RC proxy settings within the RC view of the Main Appliance.

## Scalability

Device42 remote collectors provide robust scalability by offloading discovery workloads from you main appliance(s). You can deploy multiple remote collectors for each main appliance. Device42 recommends one remote collector with one WDS (Windows Discovery Service) for each 1,000 workloads.
Expand Down
61 changes: 38 additions & 23 deletions docs/auto-discovery/windows-and-hyper-v-auto-discovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,42 @@ Network Issues

Our support team can provide best effort assistance in trying to resolve issues. However, for both protocols, it is best to reach out to your network or system admin, in order to resolve connection issues.

## Discovered Information

Provided with a successful configuration of the discovery account, and given the data's availability, Device42 will gather the following information:

<table>
<tbody>
<tr>
<td width="20%">
<ul>
<li>Device host information</li>
<li>Parts</li>
<li>Operating System</li>
</ul>
</td>
<td width="25%">
<ul>
<li>Service processes</li>
<li>Software installed</li>
<li>Installed common applications and configuration files</li>
</ul>
</td>
</tr>
</tbody>
</table>

Within the **Parts** section of device details, the CPU, RAM, and storage entries for the device will be displayed. You may also see additional information such as model number, slot, and location.

## Option To Ignore IPs/MAC Addresses

You can ignore IP and MAC addresses from being included in our database during autodiscovery. Devices with these addresses will still be discovered but the detailed information that would typically be collected and stored is ignored.

Configure rules to ignore IP and MAC addresses for a specific job when creating or editing the job.

![Ignore IPs and MACs](/assets/images/ip-mac-ignore.png)

Globally, you can add an **Exclusion** to ignore IP and MAC addresses for all jobs by navigating to **Tools > Settings > Global Settings** on the Main Appliance.

## Creating & running Windows discovery jobs

Expand Down Expand Up @@ -214,29 +249,9 @@ The following requirements represent the **minimum necessary user account permis

**4)** The discovery user account must be a member of the **Performance Monitor Users Group** and **Distributed COM Users Group** on the machines being targeted for discovery.

Provided the above is successfully configured for the discovery account (& the data is available), Device42 will successfully gather the following info:

<table>
<tbody>
<tr>
<td width="20%">
<ul>
<li>Device Host information</li>
<li>Operating System</li>
<li>Service Process</li>
</ul>
</td>
<td width="25%">
<ul>
<li>Software Installed</li>
<li>Installed common Applications and Configuration Files</li>
</ul>
</td>
</tr>
</tbody>
</table>

Note: If you are discovering servers that do not belong to a domain, there may be issues due to UAC settings. Please refer to this [MSDN article](https://learn.microsoft.com/en-us/windows/win32/wmisdk/user-account-control-and-wmi?redirectedfrom=MSDN) for information regarding UAC's effects on WMI.
:::info
If you are discovering servers that do not belong to a domain, there may be issues due to UAC settings. Please refer to this [MSDN article](https://learn.microsoft.com/en-us/windows/win32/wmisdk/user-account-control-and-wmi?redirectedfrom=MSDN) for information regarding UAC's effects on WMI.
:::

* * *

Expand Down
18 changes: 18 additions & 0 deletions docs/getstarted/advanced-search-feature.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,24 @@ Advanced search lets you enter search criteria based on the columns on the list

When you first click in the Advanced Search Query bar, Device42 displays a list of the **column names** you can use to create your search. Click or enter a column name to begin building your search. To copy an executed advanced search, copy the URL in your browser address bar and paste the URL into a new browser tab or window. You can also bookmark the page containing the executed search.

### Column Operator and Syntax Suggestions

After selecting a column, a list of available operators for that column type will be suggested.

![Operator suggestions](/assets/images/advanced-search/operator-suggestions.png)

As a reminder to enclose values within parentheses for [`in`, `not in`](#in-and-not-in), [`contains`](#contains), and [`not contains`](#not-contains) operators, an open parenthesis `(` will be suggested.

![Parenthesis syntax](/assets/images/advanced-search/parenthesis-suggestion.png)

In the case of the [`=` operator](#equals), put values in double quotation marks and use the special `EMPTY` keyword to represent a ‘null’ or ‘blank’ value.

![Values syntax](/assets/images/advanced-search/value-syntax.png)

When using [comparator operators](#comparators), like `<` or `>`, numbers are entered without any enclosing quotation marks.

![Integer suggestion](/assets/images/advanced-search/number-syntax.png)

## Search Value Formatting:

### Text
Expand Down
4 changes: 4 additions & 0 deletions docs/infrastructure-management/devices/device-ignore-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ Note that using Device Ignore Rules does not affect device data that has already

You can see Device Ignore Rule discovery results and details in the [Discovery Scores](reports/reports/discovery-quality-scores.md) page (select _Reports > Discovery Scores_ to view the page).

:::info
Ignore rules will **skip** the discovery of devices completely. An alternative option is available if you want to discover devices, but exclude specific IPs, MACSs, or Network Interfaces from the dataset. See **[Windows and Hyper-V Autodiscovery](/auto-discovery/windows-and-hyper-v-auto-discovery/#option-to-ignore-ipsmac-addresses)** for more details.
:::

### Add a Device Ignore Rule

Select _Tools > Settings > Device Ignore Rules_ and then click _Add Device Ignore Rule_ to apply an ignore rule to a device.
Expand Down
34 changes: 24 additions & 10 deletions docs/infrastructure-management/devices/device-list-view-2.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,35 @@ The device list view offers an at-a-glance view of all your devices:
<ThemedImage
alt="Device list UI"
sources={{
light: useBaseUrl('/assets/images/device-list-view-light.png'),
dark: useBaseUrl('/assets/images/device-list-view-dark.png'),
light: useBaseUrl('/assets/images/device-list/device-list-view-light.png'),
dark: useBaseUrl('/assets/images/device-list/device-list-view-dark.png'),
}}
/>

#### **List view functions**
#### List View Functions

1. Search for devices via a text string
1. Search for devices via a text string.

2. Clone or add a device
2. Clone or add a device.

3. Filter the devices by a number of different criteria

4. Sort by any of the column headers
3. Filter the devices by a number of different criteria.

4. Sort by any of the column headers.


### Custom Filters

The system default list view has dropdown menus you can use to filter your device list page. Click **+ More** to add dropdown menus and refine your list view.

To save you from repeatedly selecting the same combination of filters each time you visit the page, you can customize the default view with a custom set of dropdown filters. Enter edit mode by clicking on the **gear icon** next to the default **System Column List** dropdown menu. The custom filter will be saved if the **Custom Filters** checkbox is selected when saving.

![Custom filters checkbox](/assets/images/device-list/custom-filters-checkbox.png)

When you apply a saved custom filter, you'll see the "filters have been replaced in order to apply saved filters on the custom view" notification.

If you've made changes to the filter you don't want to keep, click the **Reset** button to revert to the original saved filter.

![Applied filter notification](/assets/images/device-list/filter-reset-and-notification.png)

## List View Bulk Actions

Expand All @@ -36,7 +50,7 @@ From the list view, you can also select multiple devices and apply bulk actions
<ThemedImage
alt="Bulk device actions dropdown menu"
sources={{
light: useBaseUrl('/assets/images/device-list-action-menu-light.png'),
dark: useBaseUrl('/assets/images/device-list-action-menu-dark.png'),
light: useBaseUrl('/assets/images/device-list/device-list-action-menu-light.png'),
dark: useBaseUrl('/assets/images/device-list/device-list-action-menu-dark.png'),
}}
/>
4 changes: 4 additions & 0 deletions docs/infrastructure-management/ipam/subnet-tree-view.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ Also, next to each IP, you will see an _Edit_ button that will enable you to edi

You can also nest subnets right from the tree view using the _+ New Subnet_ button after each subnet. If you click this button, you get a tree like view of available subnets within that subnet that you can click on and choose. You can also drag and drop subnets into another subnet or another VRF group.

:::info
Please note that the drag and drop functionality is disabled for trees with over 2000 subnets.
:::

## View Available Subnets

When adding subnets, you can view used and available subnets at a glance by clicking the _Subnet Usage Tree_ button...
Expand Down
4 changes: 3 additions & 1 deletion docs/integration/api-overview/device42-api-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@ title: "Device42 API Documentation"
sidebar_position: 2
---

[Device42 API Documentation](https://api.device42.com/)
:::info
Please visit our **[API documentation](https://api.device42.com/)** for information on using Device42 APIs.
:::
Loading

0 comments on commit c5ba58d

Please sign in to comment.