Skip to content

Commit 49f37eb

Browse files
Nadia-JSchNadia-JSch
authored
Merge pull request #832 from ritza-co/979-987-devices
979-987: Update device documentation pages
2 parents 8ddbf6d + c315966 commit 49f37eb

File tree

124 files changed

+376
-158
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

124 files changed

+376
-158
lines changed

‎docs/infrastructure-management/devices/archiving-devices-and-resources.mdx‎

Lines changed: 103 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -2,97 +2,150 @@
22
title: "Archiving Devices and Resources"
33
---
44

5+
import ThemedImage from '@theme/ThemedImage'
6+
import useBaseUrl from '@docusaurus/useBaseUrl'
7+
58
## Overview
69

710
You can archive devices and other resources to retire them or to take them out of service but still keep a record of the archived object. Device42 displays a list view of archived objects, and you can view and edit individual archived objects. The instructions below show how to archive a device and archive a resource.
811

912
## Archive a Device
1013

11-
- Go to _Resources > Compute > All Devices_ to display the device list page.
12-
- Click the name of the device you want archive to display its view page, then click the ellipse menu and then _Archive_.
13-
14-
![](/assets/images/D42-22895_Archive-1-viewbutton-1-1-250x107.png)
14+
- Go to **Resources > Compute > All Devices** to display the Devices list page.
15+
- Click the name of the device you want to archive to display its view page, then click **Archive**.
1516

17+
<ThemedImage
18+
alt="Archive device button"
19+
sources={{
20+
light: useBaseUrl('/assets/images/archiving-devices-and-resources/archive-button-light.png'),
21+
dark: useBaseUrl('/assets/images/archiving-devices-and-resources/archive-button-dark.png'),
22+
}}
23+
/>
1624

1725

18-
- Device42 displays a archive device prompt page. Click _Yes, I’m sure_ to archive the device. Click your browser’s Back button to return to the device view page.
26+
- Device42 displays an archive device prompt page. Click **Yes, I'm sure** to archive the device. Click your browser's **Back** button to return to the device's view page.
1927

20-
![](/assets/images/D42-22895_Archive-1-device-archive-prompt-page-250x148.png)
28+
<ThemedImage
29+
alt="Archive confirmation prompt"
30+
sources={{
31+
light: useBaseUrl('/assets/images/archiving-devices-and-resources/confirm-archive-1-light.png'),
32+
dark: useBaseUrl('/assets/images/archiving-devices-and-resources/confirm-archive-1-dark.png'),
33+
}}
34+
/>
2135

22-
 
36+
<ThemedImage
37+
alt="Archive device details"
38+
sources={{
39+
light: useBaseUrl('/assets/images/archiving-devices-and-resources/confirm-archive-2-light.png'),
40+
dark: useBaseUrl('/assets/images/archiving-devices-and-resources/confirm-archive-2-dark.png'),
41+
}}
42+
/>
2343

24-
- Device42 adds the device to the Archived Objects list page.
44+
Device42 adds the device to the Archived Objects list page.
2545

2646
### Bulk Device Archive Option
2747

28-
You can archive multiple devices simultaneously using the _Fast Background Archive_ command in the Actions menu on the Devices list page rather than having to archive the devices individually. Select the devices you want to archive, and then select the command. Note that this command does not display a confirmation prompt.
48+
You can archive multiple devices simultaneously using the **Fast Background Archive** command in the **Actions** menu on the Devices list page, rather than having to archive the devices individually. Select the devices you want to archive, and then select the command. Note that this command does not display a confirmation prompt.
2949

30-
![](/assets/images/18.05.00_device-list-fast-background-archive-action.PNG.jpg)
50+
<ThemedImage
51+
alt="Bulk archive option"
52+
sources={{
53+
light: useBaseUrl('/assets/images/archiving-devices-and-resources/fast-background-archive-light.png'),
54+
dark: useBaseUrl('/assets/images/archiving-devices-and-resources/fast-background-archive-dark.png'),
55+
}}
56+
/>
3157

3258
## Archive a Resource
3359

34-
- Go to _Resources > Resources > All Resources_ to display the Resources list page.
60+
- Go to **Resources > Resources > All Resources** to display the Resources list page.
3561
- Click the name of the resource you want to archive to display the resource view page.
3662

37-
![](/assets/images/D42-22895_Archive-1-resource-archive-button-250x107.png)
63+
<ThemedImage
64+
alt="Resource archive button"
65+
sources={{
66+
light: useBaseUrl('/assets/images/archiving-devices-and-resources/archive-resources-button-light.png'),
67+
dark: useBaseUrl('/assets/images/archiving-devices-and-resources/archive-resources-button-dark.png'),
68+
}}
69+
/>
3870

39-
 
4071

41-
- Click _Archive_ at the top right of the view page.
42-
- Device42 displays an Archive Object pop-up with information about the resource. Click _Show_ to see additional information; you can also add optional notes.
72+
- Click **Archive** at the top right of the view page.
73+
- Device42 displays an **Archive Object** pop-up with information about the resource. Click **Show** to see additional information; you can also add optional notes.
4374

44-
![](/assets/images/D42-22895_Archive-2-resource-show-250x105.png)
45-
46-
![](/assets/images/D42-22895_Archive-3-resource-expanded-250x105.png)
47-
48-
 
75+
<ThemedImage
76+
alt="Archive resource popup"
77+
sources={{
78+
light: useBaseUrl('/assets/images/archiving-devices-and-resources/archive-resources-popup-light.png'),
79+
dark: useBaseUrl('/assets/images/archiving-devices-and-resources/archive-resources-popup-dark.png'),
80+
}}
81+
/>
4982

50-
 
51-
52-
- Click _Archive_ to archive the resource.
83+
- Click **Archive** to archive the resource.
5384
- Device42 adds the resource to the Archived Objects list page.
5485

5586
## View and Edit Archived Objects
5687

57-
- Go to _Analytics > Audit Logs > Archived Objects_ to display the list page.
58-
59-
![](/assets/images/D42-22895_Archive-6-archive-object-menu-2-250x108.png)
88+
- Go to **Analytics > Audit Logs > Archived Objects** to display the list page.
6089

61-
![](/assets/images/D42-22895_Archive-2-archive-list-1-250x71.png)
90+
<ThemedImage
91+
alt="Archived objects list"
92+
sources={{
93+
light: useBaseUrl('/assets/images/archiving-devices-and-resources/archive-objects-list-light.png'),
94+
dark: useBaseUrl('/assets/images/archiving-devices-and-resources/archive-objects-list-dark.png'),
95+
}}
96+
/>
6297

63-
 
64-
65-
 
98+
- You can sort the objects list by **Object Type** or by **Archive Date**.
6699

67-
- You can sort the objects list by _Object Type_ or by _Archive Date_.
68-
69-
![](/assets/images/D42-22895_Archive-2-archive-list-1-250x71.png)
70-
71-
 
100+
<ThemedImage
101+
alt="Archive filter options"
102+
sources={{
103+
light: useBaseUrl('/assets/images/archiving-devices-and-resources/filter-archive-light.png'),
104+
dark: useBaseUrl('/assets/images/archiving-devices-and-resources/filter-archive-dark.png'),
105+
}}
106+
/>
72107

73108
- Click on the name of an archived object to view it.
74109

75-
![](/assets/images/D42-22895_Archive-3-archive-object-view-1-1-250x112.png)
76-
77-
 
78-
79-
 
110+
<ThemedImage
111+
alt="Archived object view"
112+
sources={{
113+
light: useBaseUrl('/assets/images/archiving-devices-and-resources/view-archived-object-light.png'),
114+
dark: useBaseUrl('/assets/images/archiving-devices-and-resources/view-archived-object-dark.png'),
115+
}}
116+
/>
117+
 
80118

81119
- Information about the archived object’s child elements appears on the right of the page. Hover over the links next to the child elements to display pop-ups with additional information about the element.
82120

83-
![](/assets/images/D42-22895_Archive-5-view-object-popups-250x114.png)
84-
121+
<ThemedImage
122+
alt="Hover details popup"
123+
sources={{
124+
light: useBaseUrl('/assets/images/archiving-devices-and-resources/hover-details-light.png'),
125+
dark: useBaseUrl('/assets/images/archiving-devices-and-resources/hover-details-dark.png'),
126+
}}
127+
/>
85128

86-
87-
- Click _Edit_ at the top right to add or edit notes about the archived object. (Note that all the other information on the page is read-only.) Click _Save_ when done.
88-
89-
![](/assets/images/D42-22895_Archive-4-archive-object-edit-1-1-250x105.png)
90-
129+
- Click **Edit** at the top right to add or edit notes about the archived object. (Note that all the other information on the page is read-only.) Click **Save** when done.
130+
131+
<ThemedImage
132+
alt="Edit note interface"
133+
sources={{
134+
light: useBaseUrl('/assets/images/archiving-devices-and-resources/edit-note-light.png'),
135+
dark: useBaseUrl('/assets/images/archiving-devices-and-resources/edit-note-dark.png'),
136+
}}
137+
/>
91138

92139

93140
## Delete an Archived Object
94141

95142
- On the Archived Objects list page, click the check box next to the object you want to delete.
96-
- Select either _Delete with Detailed Confirmation_ or _Fast Background Delete_ from the Actions menu, and then click the blue hammer icon.
97-
98-
![](/assets/images/D42-22895_Archive-7-archive-object-delete-1-1-250x78.png)
143+
- Select either **Delete with Detailed Confirmation** or **Fast Background Delete** from the **Actions** menu.
144+
145+
<ThemedImage
146+
alt="Delete archived object"
147+
sources={{
148+
light: useBaseUrl('/assets/images/archiving-devices-and-resources/delete-archived-object-light.png'),
149+
dark: useBaseUrl('/assets/images/archiving-devices-and-resources/delete-archived-object-dark.png'),
150+
}}
151+
/>

‎docs/infrastructure-management/devices/device-custom-fields.mdx‎

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,27 @@ title: "Device Custom Fields"
33
sidebar_position: 16
44
---
55

6+
import ThemedImage from '@theme/ThemedImage'
7+
import useBaseUrl from '@docusaurus/useBaseUrl'
8+
69
Many customers create custom fields for their devices to organize them and add additional information according to their specific situations. Now custom fields can be even more useful – you can now choose to display those custom fields conveniently in device pop-up panels and on layout pages.
710

8-
When you add a device custom field, simply check _Include in Context Pop-ups_ to include the custom field in panels and on layout pages.
11+
When you add a device custom field, check **Include in Context Pop-ups** to include the custom field in panels and on layout pages.
912

10-
![](/assets/images/17.07.00_device-custom-fields-700x248.png)
13+
<ThemedImage
14+
alt="Include in Context Pop-ups"
15+
sources={{
16+
light: useBaseUrl('/assets/images/device-custom-fields/context-pop-ups-light.png'),
17+
dark: useBaseUrl('/assets/images/device-custom-fields/context-pop-ups-dark.png'),
18+
}}
19+
/>
1120

12-
The custom field is then included in device pop-up panels and pages. The image below shows an example with two custom fields defined for Context Pop-ups: _Console Port_ and _Application_.
21+
The custom field is then included in device pop-up panels and pages. The image below shows an example with two custom fields defined for Context Pop-ups: `Demo custom field` and `gci-update-strategy`.
1322

14-
![](/assets/images/17.07.00_device-cfconsole-port.png)
23+
<ThemedImage
24+
alt="Pop-up example"
25+
sources={{
26+
light: useBaseUrl('/assets/images/device-custom-fields/pop-up-example-light.png'),
27+
dark: useBaseUrl('/assets/images/device-custom-fields/pop-up-example-dark.png'),
28+
}}
29+
/>

‎docs/infrastructure-management/devices/device-ignore-rules.mdx‎

Lines changed: 53 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -3,70 +3,88 @@ title: "Device Ignore Rules"
33
sidebar_position: 17
44
---
55

6-
You can exclude devices from discovery jobs by applying Device Ignore Rules to them. You may want to apply Device Ignore Rules to devices such as network printers, fax machines, IP phone systems, etc.
6+
import ThemedImage from '@theme/ThemedImage'
7+
import useBaseUrl from '@docusaurus/useBaseUrl'
8+
9+
You can exclude devices from discovery jobs by applying Device Ignore Rules to them. You may want to apply Device Ignore Rules to devices such as network printers, fax machines, and IP phone systems.
710

811
Note that using Device Ignore Rules does not affect device data that has already been discovered by previous discovery jobs. Any Device Ignore Rules you apply affect only discovery jobs you run _after_ you have applied the rules. Device Ignore Rules work for all discovery jobs, including cloud discovery.
912

10-
You can see Device Ignore Rule discovery results and details in the [Discovery Scores](reports/reports/discovery-quality-scores.mdx) page (select _Reports > Discovery Scores_ to view the page).
13+
You can see Device Ignore Rule discovery results and details in the [Discovery Scores](reports/reports/discovery-quality-scores.mdx) page (select **Reports > Discovery Scores** to view the page).
1114

1215
:::info
13-
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.
16+
Ignore rules will **skip** the discovery of devices completely. An alternative option is available if you want to discover devices, but exclude specific IPs, MACs, 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.
1417
:::
1518

1619
### Add a Device Ignore Rule
1720

18-
Select _Tools > Settings > Device Ignore Rules_ and then click _Add Device Ignore Rule_ to apply an ignore rule to a device.
21+
Select **Tools > Settings > Device Ignore Rules** and then click **Create** to apply a Device Ignore Rule to a device.
1922

20-
![](/assets/images/D42-23003_device-ignore-1-based-on-dropdown.png)
23+
<ThemedImage
24+
alt=""
25+
sources={{
26+
light: useBaseUrl('/assets/images/device-ignore-rules/device-ignore-dropdown-light.png'),
27+
dark: useBaseUrl('/assets/images/device-ignore-rules/device-ignore-dropdown-dark.png'),
28+
}}
29+
/>
2130

2231
Select an **Ignore device based on** option:
2332

24-
- Device name
25-
- Device Type
26-
- OS name
27-
- Mac address prefix
28-
- Hardware model
29-
- Tag (device tag)
33+
- **Device name**
34+
- **Device type**
35+
- **OS name**
36+
- **Mac address prefix**
37+
- **Hardware model**
38+
- **Tag** (device tag)
3039

3140
Enter any characters in **Ignored text** field for the ignore option you selected. If the character string you enter matches any portion of the corresponding attribute of a device, that device is ignored. If multiple devices have matching attributes, they are all ignored.
3241

33-
You can also select **Text length match type** (_Partial match_ or _Exact match_) and **Text case match type** (_Case insensitive_ or _Case sensitive_) to further define the text to ignore.
42+
You can also select **Text length match type** (**Partial match** or **Exact match**) and **Text case match type** (**Case insensitive** or **Case sensitive**) to further define the text to ignore.
3443

3544
Note that the page also displays a **Last time** time stamp if the Device Ignore Rule has already been used during a discovery.
3645

3746
If you select **Device type** for the **Ignore device based on:** option, Device42 displays additional fields you use to select the **Device Type** and **Subtype**.
3847

39-
![](/assets/images/D42-23003_device-ignore-4-type-physical-drop-down.png)
40-
41-
![](/assets/images/D42-23003_device-ignore-5-type-virtual-drop-down.png)
42-
43-
If you use the **Device type** option, select the **Type** and **Subtype** for the rule.
44-
45-
Click **Save** to save the Ignore Rule.
46-
47-
![](/assets/images/D42-23003_device-ignore-2-list-page.png)
48+
<ThemedImage
49+
alt="Ignore device based on: Device type"
50+
sources={{
51+
light: useBaseUrl('/assets/images/device-ignore-rules/ignore-physical-subtype-light.png'),
52+
dark: useBaseUrl('/assets/images/device-ignore-rules/ignore-physical-subtype-dark.png'),
53+
}}
54+
/>
4855

4956
### Add Device Ignore Rules from a Device List
5057

51-
You can a Device Ignore Rules to one or more devices from one of the D42 device lists. Select one of the options from the _Devices_ menu – this example uses _Devices > Virtual Devices_ – and select the devices you want to apply a rule to.
52-
53-
Select **Ignore devices from autodiscovery** from the Action menu and then click the lighting button.
58+
You can add Device Ignore Rules to one or more devices from one of the Device42 device lists. Select one of the options from the **Devices** menu – this example uses **Devices > Virtual Devices** – and select the devices you want to apply the rule to.
5459

55-
![](/assets/images/D42-23003_device-ignore-6-from-devices-list-page.png)
60+
Select **Ignore devices from autodiscovery** from the **Actions** menu.
5661

57-
Device42 displays the _Ignore devices from autodiscovery_ page listing the devices you selected. Use the **Choose device attribute** drop-down to select the  attribute on which to base the rules:
62+
<ThemedImage
63+
alt="Ignore devices action"
64+
sources={{
65+
light: useBaseUrl('/assets/images/device-ignore-rules/ignore-devices-light.png'),
66+
dark: useBaseUrl('/assets/images/device-ignore-rules/ignore-devices-dark.png'),
67+
}}
68+
/>
5869

59-
- Device name
60-
- Device Type
61-
- OS name
62-
- Mac address prefix
63-
- Hardware model
64-
- Tag
70+
Device42 displays the **Ignore devices from autodiscovery** page listing the devices you selected. Use the **Choose device attribute** dropdown to select the attribute on which to base the rules:
6571

66-
![](/assets/images/Device-Ignore-from-Devices-List.png)
72+
<ThemedImage
73+
alt="Configure rule"
74+
sources={{
75+
light: useBaseUrl('/assets/images/device-ignore-rules/ignore-devices-options-light.png'),
76+
dark: useBaseUrl('/assets/images/device-ignore-rules/ignore-devices-options-dark.png'),
77+
}}
78+
/>
6779

68-
Select the **Choose case match type attribute** drop-down (_Case insensitive_ or _Case sensitive_) and the **Choose length match type attribute** drop-down (_Partial match_ or _Exact match_) to refine the ignore rule.
80+
Select the **Choose case match type attribute** dropdown (**Case insensitive** or **Case sensitive**) and the **Choose length match type attribute** dropdown (**Partial match** or **Exact match**) to refine the Device Ignore Rule.
6981

7082
Click **Create new device ignore rules** to add the rules. Device42 adds the new rules to the Device Ignore Rule list.
7183

72-
![](/assets/images/D42-23003_device-ignore-7-list-page-w-new-rules.png)
84+
<ThemedImage
85+
alt="Ignore Rules list page"
86+
sources={{
87+
light: useBaseUrl('/assets/images/device-ignore-rules/ignore-list-light.png'),
88+
dark: useBaseUrl('/assets/images/device-ignore-rules/ignore-list-dark.png'),
89+
}}
90+
/>

0 commit comments

Comments
 (0)