Get Switches
Gets virtual switches from one or more virtual Hyper-V hosts.
Input Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | Yes | Specifies the type of the virtual switches to be retrieved. Allowed values are External, Internal, and Private. |
| Name | String | No | Specifies the name of the virtual switch to be retrieved. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| Switches | Array | Array containing switch information. |
| Computer Name | String | Host Name. |
| Name | String | Switch Name. |
| ID | String | Switch ID (GUID). |
| Switch Type | String | Type of switch (external, internal). |
| Net Adapter Interface Description | String | Name of the local NIC. |
| Result | Number | Returns a success value of zero or any value other than zero to indicate failure. |
Example Input Parameters
| Name | Type | Required | Example |
|---|---|---|---|
| Type | String | Yes |
Optionally, you can get all virtual switches that connect to the external network. Optionally, you can get all virtual switches that connect to the internal network. Optionally, you can get all virtual switches that connect to the internal and external networks. |
| Name | String | No | VMSwitch001 |