You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/infrastructure-management/ipam/switch-ports.mdx
+40-44Lines changed: 40 additions & 44 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,15 +6,13 @@ sidebar_position: 10
6
6
importThemedImagefrom'@theme/ThemedImage'
7
7
importuseBaseUrlfrom'@docusaurus/useBaseUrl'
8
8
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.
12
10
13
11
## Ports List Page
14
12
15
-
From the main menu, navigate to **Resources > Network Devices > Ports**.
13
+
Navigate to **Resources > Network Devices > Ports** to view the ports list page.
16
14
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.
18
16
19
17
<ThemedImage
20
18
alt="Ports list page"
@@ -24,10 +22,10 @@ From the Ports list page, you can view and edit existing switch ports by clickin
24
22
}}
25
23
/>
26
24
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.
@@ -48,30 +46,30 @@ Discovered ports use the **Is Default** property to indicate whether a port is t
48
46
49
47
Switch ports include the following properties:
50
48
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.
71
69
72
70
## Add a New Switch Port
73
71
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.
75
73
76
74
<ThemedImage
77
75
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
@@ -103,9 +99,9 @@ Scroll down to add **Port Aliases**, **Parts**, and see **Custom Fields**:
103
99
104
100
## Switch Port Bulk Operations
105
101
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.
107
103
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.
109
105
110
106
<ThemedImage
111
107
alt="Switch port action menu"
@@ -117,9 +113,9 @@ For example, you can filter ports by up/down status, network switch, or discover
117
113
118
114
## Switch Port Count
119
115
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.
121
117
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.
123
119
124
120
<ThemedImage
125
121
alt="Switch port count"
@@ -131,21 +127,21 @@ Also, from the switch port list page, you can filter by switch and up/down statu
131
127
132
128
## Switch Port Visualization
133
129
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.
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.
147
143
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.
149
145
150
146
<ThemedImage
151
147
alt="Add new hardware model"
@@ -157,9 +153,9 @@ To add a new stacked switch, head to **Infrastructure > Hardware Models** and cl
157
153
158
154
## Represent FEX Modules
159
155
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).
161
157
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**.
0 commit comments