Skip to content

Commit 8f17ea4

Browse files
committed
1237: grammar cleanup; switch-ports
1 parent b989c91 commit 8f17ea4

1 file changed

Lines changed: 40 additions & 44 deletions

File tree

docs/infrastructure-management/ipam/switch-ports.mdx

Lines changed: 40 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,13 @@ sidebar_position: 10
66
import ThemedImage from '@theme/ThemedImage'
77
import useBaseUrl from '@docusaurus/useBaseUrl'
88

9-
Switch ports can be autodiscovered using SNMP network discovery.
10-
11-
You can bulk add switch ports via [switch templates](switch-templates.mdx), or use the [Device42 RESTful APIs](https://api.device42.com/#/IPAM) for an easy way to programmatically add or edit many switch ports at once.
9+
Switch ports can be discovered automatically using SNMP network discovery. You can also bulk add switch ports via [switch templates](switch-templates.mdx), or use the [Device42 RESTful APIs](https://api.device42.com/#/IPAM) to programmatically add or edit switch ports.
1210

1311
## Ports List Page
1412

15-
From the main menu, navigate to **Resources > Network Devices > Ports**.
13+
Navigate to **Resources > Network Devices > Ports** to view the ports list page.
1614

17-
From the Ports list page, you can view and edit existing switch ports by clicking on any port ID. Add one or more new ports by clicking the **+ Create** button on the upper right:
15+
Click on any port ID to view and edit an existing switch port, or click **+ Create** to add a new port.
1816

1917
<ThemedImage
2018
alt="Ports list page"
@@ -24,10 +22,10 @@ From the Ports list page, you can view and edit existing switch ports by clickin
2422
}}
2523
/>
2624

27-
You can also see a list of associated Ports via the **Ports** section on the device page:
25+
You can also see associated ports via the **Ports** section on a device page.
2826

2927
<ThemedImage
30-
alt="Switch Ports button on device page"
28+
alt="Switch ports on device page"
3129
sources={{
3230
light: useBaseUrl('/assets/images/switch-ports/switch-ports-button-light.png'),
3331
dark: useBaseUrl('/assets/images/switch-ports/switch-ports-button-dark.png'),
@@ -48,30 +46,30 @@ Discovered ports use the **Is Default** property to indicate whether a port is t
4846

4947
Switch ports include the following properties:
5048

51-
**Port:** Name of the switch port as found during autodiscovery, or user-generated.
52-
**Name:** As found in autodiscovery or user-generated.
53-
**Description:** As found in autodiscovery or user-generated.
54-
**Type:** Add the type of port. Use the **+ button** to add a new type.
55-
**Network Device:** A device with network switch value as checked.
56-
**VLANs:** All the VLANs this port belongs to.
57-
**Module:** If this port is part of a module in a chassis-based switch, the module association can be made here.
58-
**Asset:** If the port is part of FEX or a similar asset connected to the switch, that association can be made here. You can either assign it to a module or asset.
59-
**Network Switch 2nd:** For stacked switches, this is the clustered switch. For paired switches, this is the second switch through which port can be managed.
60-
61-
The associations for the Module, Asset, and the Network Switch 2nd fields can be done efficiently using [switch templates](switch-templates.mdx).
62-
63-
**Up:** Whether the port is up or not.
64-
**Up admin:** Whether the port is administratively up or not.
65-
**Count:** Count in the number of ports.
66-
**Discovered type:** The port type as discovered during autodiscovery. This field is read-only. The discovered type value can be used to mark certain ports as uncounted, delete ports, or ignore certain port types in autodiscovery.
67-
**Remote Port:** If the port is connected to another switch port, you can make that association here. This can be autodiscovered as well.
68-
**Don't change via API:** If you override remote port connectivity manually, check this so autodiscovery or an API doesn't make this change automatically.
69-
**Tags:** A comma-separated list of tags you would like attributed to the switch port.
70-
**HW Address:** Any MAC addresses and devices connected to the switch port and the VLAN associated with the MAC address.
49+
- **Port:** Name of the switch port as found during discovery, or user-generated.
50+
- **Name:** As found during discovery or user-generated.
51+
- **Description:** As found during discovery or user-generated.
52+
- **Type:** The type of port. Use the **+ button** to add a new type.
53+
- **Network Device:** A device with the network switch value checked.
54+
- **VLANs:** All the VLANs this port belongs to.
55+
- **Module:** If this port is part of a module in a chassis-based switch, the module association can be made here.
56+
- **Asset:** If the port is part of a FEX or similar asset connected to the switch, that association can be made here. You can assign a port to either a module or an asset.
57+
- **Network Switch 2nd:** For stacked switches, this is the clustered switch. For paired switches, this is the second switch through which the port can be managed.
58+
59+
The **Module**, **Asset**, and **Network Switch 2nd** associations can be configured efficiently using [switch templates](switch-templates.mdx).
60+
61+
- **Up:** Whether the port is up.
62+
- **Up Admin:** Whether the port is administratively up.
63+
- **Count:** Whether to count this port in the total.
64+
- **Discovered Type:** The port type as found during discovery. This field is read-only. The discovered type value can be used to mark certain ports as uncounted, delete ports, or ignore certain port types during discovery.
65+
- **Remote Port:** If the port is connected to another switch port, that association can be made here. This can also be discovered automatically.
66+
- **Don't Change Via API:** Check this if you override remote port connectivity manually, to prevent discovery or API calls from overwriting the change.
67+
- **Tags:** A comma-separated list of tags for the switch port.
68+
- **HW Address:** MAC addresses and devices connected to the switch port, and the VLAN associated with each MAC address.
7169

7270
## Add a New Switch Port
7371

74-
Click the **+ Add Port** button on the upper right of the Ports list page and fill in the details of the port:
72+
Click **+ Add Port** on the ports list page and fill in the port details.
7573

7674
<ThemedImage
7775
alt="Add new switch port"
@@ -81,20 +79,18 @@ Click the **+ Add Port** button on the upper right of the Ports list page and fi
8179
}}
8280
/>
8381

84-
Add more port details:
85-
8682
<ThemedImage
87-
alt="Add new switch port"
83+
alt="Switch port additional details"
8884
sources={{
8985
light: useBaseUrl('/assets/images/switch-ports/add-port-2-light.png'),
9086
dark: useBaseUrl('/assets/images/switch-ports/add-port-2-dark.png'),
9187
}}
9288
/>
9389

94-
Scroll down to add **Port Aliases**, **Parts**, and see **Custom Fields**:
90+
Scroll down to add **Port Aliases**, **Parts**, and view **Custom Fields**.
9591

9692
<ThemedImage
97-
alt="Add new switch port"
93+
alt="Port aliases and custom fields"
9894
sources={{
9995
light: useBaseUrl('/assets/images/switch-ports/add-port-3-light.png'),
10096
dark: useBaseUrl('/assets/images/switch-ports/add-port-3-dark.png'),
@@ -103,9 +99,9 @@ Scroll down to add **Port Aliases**, **Parts**, and see **Custom Fields**:
10399

104100
## Switch Port Bulk Operations
105101

106-
Perform bulk operations by selecting ports from the table and choosing an action in the dropdown menu. Click the **icon hammer** to execute the action.
102+
Select ports from the table, choose an action from the dropdown menu, and click the **hammer icon** to execute it.
107103

108-
For example, you can filter ports by up/down status, network switch, or discovered type, and select the ports to be not be counted in the total:
104+
For example, you can filter ports by up/down status, network switch, or discovered type, then select the ports to exclude from the count.
109105

110106
<ThemedImage
111107
alt="Switch port action menu"
@@ -117,9 +113,9 @@ For example, you can filter ports by up/down status, network switch, or discover
117113

118114
## Switch Port Count
119115

120-
In the rack layout view, the hover-over popup shows the total "counted" ports and up ports for that switch.
116+
In the rack layout view, the hover-over popup shows the total counted ports and up ports for that switch.
121117

122-
Also, from the switch port list page, you can filter by switch and up/down status to show the count of filtered ports.
118+
From the switch port list page, you can filter by switch and up/down status to show the count of filtered ports.
123119

124120
<ThemedImage
125121
alt="Switch port count"
@@ -131,21 +127,21 @@ Also, from the switch port list page, you can filter by switch and up/down statu
131127

132128
## Switch Port Visualization
133129

134-
For physical switches, click **Impact Chart** to see all the ports with connectivity, including each MAC-to-device relationship. Virtual devices are shown as 2nd layer devices that are connected to their vHost or marked with a '?' character if the vHost is unknown.
130+
For physical switches, click **Impact Chart** to see all ports with connectivity, including each MAC-to-device relationship. Virtual devices are shown as second-layer devices connected to their vHost, or marked with `?` if the vHost is unknown.
135131

136132
<ThemedImage
137-
alt="Switch port impact chart example"
133+
alt="Switch port impact chart"
138134
sources={{
139135
light: useBaseUrl('/assets/images/switch-ports/impact-chart-light.png'),
140136
dark: useBaseUrl('/assets/images/switch-ports/impact-chart-dark.png'),
141137
}}
142138
/>
143139

144-
## How Do I Represent a Stacked Switch?
140+
## Represent a Stacked Switch
145141

146-
All switches, stacked or not, are represented according to their underlying hardware model. Stacked switches are represented by configuring their hardware model. To add an instance of a stacked switch, select the underlying hardware model that you created previously.
142+
All switches, stacked or not, are represented according to their underlying hardware model. To add an instance of a stacked switch, select the hardware model that you created previously.
147143

148-
To add a new stacked switch, head to **Infrastructure > Hardware Models** and click **+ Create **. Create a new device hardware model by supplying a **Name**, **Physical Subtype**, and other basic information, and checking the **Network Device** checkbox.
144+
To add a new stacked switch hardware model, navigate to **Infrastructure > Hardware Models** and click **+ Create**. Enter a **Name**, **Physical Subtype**, and other basic information, and check the **Network Device** checkbox.
149145

150146
<ThemedImage
151147
alt="Add new hardware model"
@@ -157,9 +153,9 @@ To add a new stacked switch, head to **Infrastructure > Hardware Models** and cl
157153

158154
## Represent FEX Modules
159155

160-
FEX modules can be added as an asset and then associated with the switch using asset device relations. This is easier to add using [switch templates](switch-templates.mdx).
156+
FEX modules can be added as an asset and then associated with a switch using asset device relations. This is easier to configure using [switch templates](switch-templates.mdx).
161157

162-
To add a new asset, navigate to **Resources > All Assets** and click **+ Create**. Name the asset and under **Type** select **Fabric Extender**.
158+
To add a new asset, navigate to **Resources > All Assets** and click **+ Create**. Name the asset and set **Type** to **Fabric Extender**.
163159

164160
<ThemedImage
165161
alt="Add asset with Fabric Extender type"

0 commit comments

Comments
 (0)