From d1e3943e4fad190ce805d5a46d045fb80813ed12 Mon Sep 17 00:00:00 2001 From: Mike Chuang Date: Thu, 23 Feb 2023 22:49:25 -0600 Subject: [PATCH] Add "External" network purpose tag (#69) * Add "External" network purpose. * [auto generated] Checking in generated offline HTML doc --- v1/api/swagger/components/schemas/NetworkPurpose.yaml | 1 + v1/html/index.html | 6 +++--- v1/pkg/client/api/openapi.yaml | 1 + v1/pkg/client/model_network_purpose.go | 1 + 4 files changed, 6 insertions(+), 3 deletions(-) diff --git a/v1/api/swagger/components/schemas/NetworkPurpose.yaml b/v1/api/swagger/components/schemas/NetworkPurpose.yaml index 11b79568..7f9df89e 100644 --- a/v1/api/swagger/components/schemas/NetworkPurpose.yaml +++ b/v1/api/swagger/components/schemas/NetworkPurpose.yaml @@ -10,6 +10,7 @@ enum: - iSCSI-A - iSCSI-B - Telemetry + - External example: Storage description: > Indicates the purpose of the network. diff --git a/v1/html/index.html b/v1/html/index.html index b267a3f5..fd450ce2 100644 --- a/v1/html/index.html +++ b/v1/html/index.html @@ -2736,7 +2736,7 @@

Option 2: Getting the token directly from UI

Name
required
string

Name of the network

LocationID
required
string <uuid> (LocationID)

The location ID is the data center location of the resource. The LocationID must be one of those provided by the LocationInfo array returned as part of the get /available-resources call. The locations are typically described by country, region, and data center.

Description
string
HostUse
string (NetworkHostUse)
Enum: "Required" "Default" "Optional"

Indicates whether use of the network is required, default, or optional. If the network is required, any new create host request for that location must include this network among the requested networks. Default and Optional are both optional networks, but imply whether they should show up initially in pre-populated fields in a graphical user interface.

-
Purpose
string (NetworkPurpose)
Enum: "Backup" "Storage" "vmKernel" "vmNSX-T" "vMotion" "vCHA" "vmFT" "iSCSI-A" "iSCSI-B" "Telemetry"

Indicates the purpose of the network.

+
Purpose
string (NetworkPurpose)
Enum: "Backup" "Storage" "vmKernel" "vmNSX-T" "vMotion" "vCHA" "vmFT" "iSCSI-A" "iSCSI-B" "Telemetry" "External"

Indicates the purpose of the network.

object or null (NewIPPool)

Responses

Modified
string <date-time>

Time when the resource was last modified in the database

LocationID
string <uuid> (LocationID)

The location ID is the data center location of the resource. The LocationID must be one of those provided by the LocationInfo array returned as part of the get /available-resources call. The locations are typically described by country, region, and data center.

Description
string
HostUse
string (NetworkHostUse)
Enum: "Required" "Default" "Optional"

Indicates whether use of the network is required, default, or optional. If the network is required, any new create host request for that location must include this network among the requested networks. Default and Optional are both optional networks, but imply whether they should show up initially in pre-populated fields in a graphical user interface.

-
Purpose
string (NetworkPurpose)
Enum: "Backup" "Storage" "vmKernel" "vmNSX-T" "vMotion" "vCHA" "vmFT" "iSCSI-A" "iSCSI-B" "Telemetry"

Indicates the purpose of the network.

+
Purpose
string (NetworkPurpose)
Enum: "Backup" "Storage" "vmKernel" "vmNSX-T" "vMotion" "vCHA" "vmFT" "iSCSI-A" "iSCSI-B" "Telemetry" "External"

Indicates the purpose of the network.

IPPoolID
string
VLAN
integer

VLAN ID of the network

VNI
integer

VNI ID of the network

Responses

Response samples

Content type
application/json
[
  • {
    }
]