From 26e7405357f82890050c2f34bb8e219287c88012 Mon Sep 17 00:00:00 2001 From: Marques Johansson <317653+displague@users.noreply.github.com> Date: Thu, 20 Aug 2026 10:10:10 -0400 Subject: [PATCH 1/3] fix: keep known initialisms together when generating kebab-case names The camelToKebab conversion used for CLI command/flag names inserted a dash before every uppercase letter, splitting initialisms like BGP, SSH, IP, VLAN, and API into commands such as b-g-p, s-s-h-key, and i-p-address. Add a shared internal/casing package that recognizes a list of known initialisms and keeps them as a single word, fixing commands like bgp, ssh-key, ip-address, and oauth. --- internal/casing/casing.go | 108 +++++++++++++++++++++++++++++++++ internal/casing/casing_test.go | 52 ++++++++++++++++ internal/parser/extractor.go | 16 +---- internal/register/register.go | 66 +++----------------- 4 files changed, 173 insertions(+), 69 deletions(-) create mode 100644 internal/casing/casing.go create mode 100644 internal/casing/casing_test.go diff --git a/internal/casing/casing.go b/internal/casing/casing.go new file mode 100644 index 0000000..3b14abf --- /dev/null +++ b/internal/casing/casing.go @@ -0,0 +1,108 @@ +// Package casing provides identifier case conversion helpers shared by the +// SDK parser and command registration code. +package casing + +import "strings" + +// irregularCasing maps identifier substrings with non-standard capitalization +// to a form that CamelToKebab can split correctly. +var irregularCasing = map[string]string{ + "OAuth": "Oauth", +} + +// acronyms are known multi-letter initialisms that should be kept together as +// a single word instead of being split letter-by-letter, ordered so that +// longer acronyms are matched before any of their shorter prefixes. +var acronyms = []string{ + "HTTPS", "OPTIONS", "DELETE", "PATCH", "HTTP", "UUID", "VLAN", "EVPL", + "VRF", "BGP", "CSP", "EIA", "API", "SSH", "URL", "POST", "GET", "PUT", + "VC", "IP", "ID", "FG", +} + +func isUpper(r rune) bool { return r >= 'A' && r <= 'Z' } +func isLower(r rune) bool { return r >= 'a' && r <= 'z' } + +// CamelToKebab converts a CamelCase or camelCase identifier to kebab-case, +// keeping known initialisms (e.g. "BGP", "SSH", "IP") together as a single +// word instead of splitting them letter by letter (e.g. "BGPSession" +// becomes "bgp-session", not "b-g-p-session"). +func CamelToKebab(s string) string { + for from, to := range irregularCasing { + s = strings.ReplaceAll(s, from, to) + } + + runes := []rune(s) + n := len(runes) + var words []string + + i := 0 + for i < n { + if !isUpper(runes[i]) { + j := i + for j < n && !isUpper(runes[j]) { + j++ + } + words = append(words, string(runes[i:j])) + i = j + continue + } + + j := i + for j < n && isUpper(runes[j]) { + j++ + } + + if j-i == 1 { + // A single leading capital starts an ordinary word; absorb any + // lowercase letters that follow it (e.g. "Get" or "Aside"). + k := j + for k < n && isLower(runes[k]) { + k++ + } + words = append(words, string(runes[i:k])) + i = k + continue + } + + run := string(runes[i:j]) + upperRun := strings.ToUpper(run) + matchLen := 0 + for _, a := range acronyms { + if len(a) <= len(upperRun) && strings.HasPrefix(upperRun, a) { + matchLen = len(a) + break + } + } + + if matchLen > 0 { + word := run[:matchLen] + pos := i + matchLen + if pos == j { + // The acronym consumed the whole capital run; any lowercase + // letters immediately after it are a suffix (e.g. the "s" + // in "VLANs"), not the start of a new word. + k := pos + for k < n && isLower(runes[k]) { + k++ + } + word += string(runes[pos:k]) + pos = k + } + words = append(words, word) + i = pos + continue + } + + // Unrecognized run of capitals: the last capital starts the next + // word if one follows (e.g. "ASide" -> "A", "Side"). + if j < n && isLower(runes[j]) { + words = append(words, string(runes[i:j-1])) + i = j - 1 + } else { + words = append(words, run) + i = j + } + } + + return strings.ToLower(strings.Join(words, "-")) +} diff --git a/internal/casing/casing_test.go b/internal/casing/casing_test.go new file mode 100644 index 0000000..7758c0f --- /dev/null +++ b/internal/casing/casing_test.go @@ -0,0 +1,52 @@ +package casing + +import "testing" + +func TestCamelToKebab(t *testing.T) { + cases := map[string]string{ + "BGP": "bgp", + "BGPAction": "bgp-action", + "BGPSession": "bgp-session", + "ByID": "by-id", + "CreateAPIKey": "create-api-key", + "CreateIPAssignment": "create-ip-assignment", + "CreateSSHKey": "create-ssh-key", + "DeviceSSHKeys": "device-ssh-keys", + "EIAService": "eia-service", + "EvplVCCount": "evpl-vc-count", + "FGVCCount": "fg-vc-count", + "FindAPIKeys": "find-api-keys", + "FindIPAddress": "find-ip-address", + "GETOrder": "get-order", + "GETRetrieve": "get-retrieve", + "GetOAuth": "get-oauth", + "RefreshOAuth": "refresh-oauth", + "IPAddresses": "ip-addresses", + "POSTOrders": "post-orders", + "PortVCVlan": "port-vc-vlan", + "ProjectAPIKey": "project-api-key", + "ProtocolBGPType": "protocol-bgp-type", + "RequestASide": "request-a-side", + "RequestZSide": "request-z-side", + "ConnectionASide": "connection-a-side", + "DataZSide": "data-z-side", + "SSHKey": "ssh-key", + "SSHKeys": "ssh-keys", + "UpdateIPAddress": "update-ip-address", + "UserAPIKey": "user-api-key", + "VLANs": "vlans", + "VRFs": "vrfs", + "VlanCSPConnection": "vlan-csp-connection", + "VrfBGPNeighbors": "vrf-bgp-neighbors", + "AccessVCCount": "access-vc-count", + "GetConnectionByUuid": "get-connection-by-uuid", + "ServiceProfilesApi": "service-profiles-api", + "ConnectionsApi": "connections-api", + } + + for input, want := range cases { + if got := CamelToKebab(input); got != want { + t.Errorf("CamelToKebab(%q) = %q, want %q", input, got, want) + } + } +} diff --git a/internal/parser/extractor.go b/internal/parser/extractor.go index 1515c4e..6932a86 100644 --- a/internal/parser/extractor.go +++ b/internal/parser/extractor.go @@ -11,6 +11,8 @@ import ( "os" "path/filepath" "strings" + + "github.com/equinix/cli/internal/casing" ) // ParameterDescription holds documentation for a parameter @@ -214,7 +216,7 @@ func parseFile(filePath string, descriptions *SDKDescriptions) error { // Extract service name from receiver type if not already set if serviceName == "" && strings.HasSuffix(receiverType, "ApiService") { serviceName = strings.TrimSuffix(receiverType, "ApiService") - serviceName = camelToKebab(serviceName) + serviceName = casing.CamelToKebab(serviceName) } // Ensure service exists in map @@ -304,18 +306,6 @@ func parseFile(filePath string, descriptions *SDKDescriptions) error { return nil } -// camelToKebab converts CamelCase to kebab-case -func camelToKebab(s string) string { - var result strings.Builder - for i, r := range s { - if i > 0 && r >= 'A' && r <= 'Z' { - result.WriteRune('-') - } - result.WriteRune(r) - } - return strings.ToLower(result.String()) -} - // SaveToFile saves descriptions to a JSON file func (d *SDKDescriptions) SaveToFile(filePath string) error { data, err := json.MarshalIndent(d, "", " ") diff --git a/internal/register/register.go b/internal/register/register.go index 6da67d1..77063f5 100644 --- a/internal/register/register.go +++ b/internal/register/register.go @@ -11,6 +11,7 @@ import ( "strconv" "strings" + "github.com/equinix/cli/internal/casing" "github.com/equinix/cli/internal/parser" "github.com/spf13/cobra" "github.com/spf13/pflag" @@ -96,16 +97,7 @@ func extractServiceName(fieldName string) string { name := strings.TrimSuffix(fieldName, "ApiService") name = strings.TrimSuffix(name, "Api") - // Convert camelCase to kebab-case - var result strings.Builder - for i, r := range name { - if i > 0 && r >= 'A' && r <= 'Z' { - result.WriteRune('-') - } - result.WriteRune(r) - } - - return strings.ToLower(result.String()) + return casing.CamelToKebab(name) } // createServiceCommand creates a Cobra command for a specific API service @@ -163,15 +155,7 @@ func extractMethodName(methodName string) string { methodName = strings.TrimSuffix(methodName, "Execute") // Convert the whole method name to kebab-case for uniqueness - var result strings.Builder - for i, r := range methodName { - if i > 0 && r >= 'A' && r <= 'Z' { - result.WriteRune('-') - } - result.WriteRune(r) - } - - return strings.ToLower(result.String()) + return casing.CamelToKebab(methodName) } // createMethodCommand creates a Cobra command for a specific API method @@ -270,16 +254,7 @@ func getServiceNameFromType(service interface{}) string { // Remove "ApiService" suffix typeName = strings.TrimSuffix(typeName, "ApiService") - // Convert to kebab-case - var result strings.Builder - for i, r := range typeName { - if i > 0 && r >= 'A' && r <= 'Z' { - result.WriteRune('-') - } - result.WriteRune(r) - } - - return strings.ToLower(result.String()) + return casing.CamelToKebab(typeName) } // getServiceFromClient extracts a service field from the client by service name @@ -525,16 +500,7 @@ func getParamNameFromPosition(method reflect.Method, position int, paramDescript // Remove pointer indicators typeName = strings.TrimPrefix(typeName, "*") - // Convert to kebab-case - var result strings.Builder - for i, r := range typeName { - if i > 0 && r >= 'A' && r <= 'Z' { - result.WriteRune('-') - } - result.WriteRune(r) - } - - name := strings.ToLower(result.String()) + name := casing.CamelToKebab(typeName) // First, try to get parameter name from SDK descriptions // The descriptions are now in order, so we can match by position @@ -550,7 +516,7 @@ func getParamNameFromPosition(method reflect.Method, position int, paramDescript } if actualParamIndex == paramIndex { // Found the matching parameter - return camelToKebab(param.Name) + return casing.CamelToKebab(param.Name) } actualParamIndex++ } @@ -615,18 +581,6 @@ func getParamNameFromPosition(method reflect.Method, position int, paramDescript return name } -// camelToKebab converts camelCase to kebab-case -func camelToKebab(s string) string { - var result strings.Builder - for i, r := range s { - if i > 0 && r >= 'A' && r <= 'Z' { - result.WriteRune('-') - } - result.WriteRune(r) - } - return strings.ToLower(result.String()) -} - // getValueFromFlag retrieves a flag value and converts it to the target type func getValueFromFlag(cmd *cobra.Command, flagName string, targetType reflect.Type) reflect.Value { // Handle pointer types @@ -692,7 +646,7 @@ func buildStructFromFlags(cmd *cobra.Command, prefix string, structType reflect. } // Convert to kebab-case for CLI flag name - flagName := camelToKebab(fieldName) + flagName := casing.CamelToKebab(fieldName) if prefix != "" { flagName = prefix + "-" + flagName } @@ -819,7 +773,7 @@ func applyFlagsToRequestBuilder(cmd *cobra.Command, requestBuilder reflect.Value } // Get the flag name for this setter - flagName := camelToKebab(method.Name) + flagName := casing.CamelToKebab(method.Name) // Get the parameter type for this setter paramType := method.Type.In(1) @@ -976,7 +930,7 @@ func registerBuilderMethodFlags(cmd *cobra.Command, builderMethod reflect.Method if method.Type.NumIn() == 2 && method.Type.NumOut() == 1 && method.Name != "Execute" { // This looks like a setter paramType := method.Type.In(1) - paramName := camelToKebab(method.Name) + paramName := casing.CamelToKebab(method.Name) // Expand this setter parameter into flags // All setter parameters are optional - they're optional fields on the request builder @@ -1172,7 +1126,7 @@ func expandStructFieldsWithDepth(cmd *cobra.Command, prefix string, structType r } // Convert to kebab-case for CLI - flagName := camelToKebab(fieldName) + flagName := casing.CamelToKebab(fieldName) if prefix != "" { flagName = prefix + "-" + flagName } From 6d501435db83f466488caf9e7f24bd96eca73f6a Mon Sep 17 00:00:00 2001 From: Marques Johansson <317653+displague@users.noreply.github.com> Date: Thu, 20 Aug 2026 10:13:05 -0400 Subject: [PATCH 2/3] fix: keep version-style digit suffixes attached to their word Digits like the "2" in OAuth2 or the "4"/"6" in IPv4/IPv6 were treated as a new word boundary, producing oauth-2-token instead of the well-known spec name oauth2-token. Trailing digits now attach to the preceding word like other suffixes. --- internal/casing/casing.go | 17 ++++++++++++----- internal/casing/casing_test.go | 4 ++++ 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/internal/casing/casing.go b/internal/casing/casing.go index 3b14abf..18f0beb 100644 --- a/internal/casing/casing.go +++ b/internal/casing/casing.go @@ -21,6 +21,11 @@ var acronyms = []string{ func isUpper(r rune) bool { return r >= 'A' && r <= 'Z' } func isLower(r rune) bool { return r >= 'a' && r <= 'z' } +func isDigit(r rune) bool { return r >= '0' && r <= '9' } + +// isWordContinuation reports whether r continues the current word rather +// than starting a new one, e.g. the "2" in "OAuth2" or "IPv4". +func isWordContinuation(r rune) bool { return isLower(r) || isDigit(r) } // CamelToKebab converts a CamelCase or camelCase identifier to kebab-case, // keeping known initialisms (e.g. "BGP", "SSH", "IP") together as a single @@ -54,9 +59,10 @@ func CamelToKebab(s string) string { if j-i == 1 { // A single leading capital starts an ordinary word; absorb any - // lowercase letters that follow it (e.g. "Get" or "Aside"). + // lowercase letters or digits that follow it (e.g. "Get", + // "Aside", or the "4" in "Ipv4"). k := j - for k < n && isLower(runes[k]) { + for k < n && isWordContinuation(runes[k]) { k++ } words = append(words, string(runes[i:k])) @@ -79,10 +85,11 @@ func CamelToKebab(s string) string { pos := i + matchLen if pos == j { // The acronym consumed the whole capital run; any lowercase - // letters immediately after it are a suffix (e.g. the "s" - // in "VLANs"), not the start of a new word. + // letters or digits immediately after it are a suffix (e.g. + // the "s" in "VLANs", or the "2" in "OAuth2"), not the start + // of a new word. k := pos - for k < n && isLower(runes[k]) { + for k < n && isWordContinuation(runes[k]) { k++ } word += string(runes[pos:k]) diff --git a/internal/casing/casing_test.go b/internal/casing/casing_test.go index 7758c0f..35e3cdd 100644 --- a/internal/casing/casing_test.go +++ b/internal/casing/casing_test.go @@ -42,6 +42,10 @@ func TestCamelToKebab(t *testing.T) { "GetConnectionByUuid": "get-connection-by-uuid", "ServiceProfilesApi": "service-profiles-api", "ConnectionsApi": "connections-api", + "OAuth2TokenApi": "oauth2-token-api", + "GetOAuth2Token": "get-oauth2-token", + "IPv4Address": "ipv4-address", + "IPv6Address": "ipv6-address", } for input, want := range cases { From f97adb283cfa24badd53c64dd478cbba0b7c4025 Mon Sep 17 00:00:00 2001 From: Marques Johansson <317653+displague@users.noreply.github.com> Date: Thu, 20 Aug 2026 10:16:07 -0400 Subject: [PATCH 3/3] docs: regenerate docs with fixed initialism command names Run 'make docs' to pick up the renamed commands (e.g. b-g-p -> bgp, create-a-p-i-key -> create-api-key, o-auth2-token -> oauth2-token) from the camelToKebab fix. --- docs/equinix_accesstokenv1.md | 2 +- docs/equinix_accesstokenv1_o-auth2-token.md | 28 ---- docs/equinix_accesstokenv1_oauth2-token.md | 28 ++++ ...1_oauth2-token_get-oauth2-access-token.md} | 17 ++- ...uth2-token_refresh-oauth2-access-token.md} | 17 ++- docs/equinix_eiav2.md | 2 +- ...ervice.md => equinix_eiav2_eia-service.md} | 10 +- ...rvice_create-equinix-internet-accessv2.md} | 15 +- docs/equinix_fabricv4_ports_create-port.md | 6 +- ...cols_create-connection-routing-protocol.md | 18 +-- ...ion-routing-protocol-bgp-action-by-uuid.md | 12 +- ...ace-connection-routing-protocol-by-uuid.md | 18 +-- docs/equinix_metalv1.md | 10 +- docs/equinix_metalv1_authentication.md | 12 +- ..._metalv1_authentication_create-api-key.md} | 6 +- ..._authentication_create-project-api-key.md} | 6 +- ..._metalv1_authentication_delete-api-key.md} | 6 +- ...lv1_authentication_delete-user-api-key.md} | 6 +- ...x_metalv1_authentication_find-api-keys.md} | 6 +- ...1_authentication_find-project-api-keys.md} | 6 +- docs/equinix_metalv1_b-g-p.md | 33 ----- ...quinix_metalv1_b-g-p_delete-bgp-session.md | 37 ----- ...ix_metalv1_b-g-p_find-global-bgp-ranges.md | 37 ----- ...metalv1_b-g-p_find-project-bgp-sessions.md | 37 ----- docs/equinix_metalv1_bgp.md | 33 +++++ .../equinix_metalv1_bgp_delete-bgp-session.md | 34 +++++ ...metalv1_bgp_find-bgp-config-by-project.md} | 17 +-- ...nix_metalv1_bgp_find-bgp-session-by-id.md} | 17 +-- ...inix_metalv1_bgp_find-global-bgp-ranges.md | 34 +++++ ...x_metalv1_bgp_find-project-bgp-sessions.md | 34 +++++ ...equinix_metalv1_bgp_request-bgp-config.md} | 17 +-- ...equinix_metalv1_bgp_update-bgp-session.md} | 17 +-- docs/equinix_metalv1_devices.md | 10 +- ...inix_metalv1_devices_create-bgp-session.md | 14 +- ...x_metalv1_devices_create-i-p-assignment.md | 39 ------ ...ix_metalv1_devices_create-ip-assignment.md | 39 ++++++ ...lv1_devices_find-device-metadata-by-id.md} | 6 +- ...lv1_devices_find-device-userdata-by-id.md} | 6 +- ..._devices_find-ip-assignment-customdata.md} | 6 +- ...ix_metalv1_devices_find-ip-assignments.md} | 6 +- ...talv1_devices_find-organization-devices.md | 2 +- ...ix_metalv1_devices_find-project-devices.md | 2 +- docs/equinix_metalv1_i-p-addresses.md | 33 ----- ...etalv1_i-p-addresses_delete-i-p-address.md | 37 ----- ...v1_i-p-addresses_find-i-p-address-by-id.md | 39 ------ ...p-addresses_find-i-p-address-customdata.md | 37 ----- ...1_i-p-addresses_find-i-p-availabilities.md | 38 ----- ...1_i-p-addresses_request-i-p-reservation.md | 57 -------- ...etalv1_i-p-addresses_update-i-p-address.md | 43 ------ ...ons_create-organization-interconnection.md | 132 +++++++++--------- ...nections_create-project-interconnection.md | 132 +++++++++--------- docs/equinix_metalv1_ip-addresses.md | 33 +++++ ..._metalv1_ip-addresses_delete-ip-address.md | 34 +++++ ...alv1_ip-addresses_find-ip-address-by-id.md | 36 +++++ ...ip-addresses_find-ip-address-customdata.md | 34 +++++ ...lv1_ip-addresses_find-ip-availabilities.md | 35 +++++ ...alv1_ip-addresses_find-ip-reservations.md} | 19 ++- ...lv1_ip-addresses_request-ip-reservation.md | 54 +++++++ ..._metalv1_ip-addresses_update-ip-address.md | 40 ++++++ docs/equinix_metalv1_plans_find-plans.md | 2 +- docs/equinix_metalv1_projects.md | 2 +- ...rojects_find-ip-reservation-customdata.md} | 6 +- docs/equinix_metalv1_s-s-h-keys.md | 34 ----- ...lv1_s-s-h-keys_create-project-s-s-h-key.md | 43 ------ ...nix_metalv1_s-s-h-keys_create-s-s-h-key.md | 42 ------ ...nix_metalv1_s-s-h-keys_delete-s-s-h-key.md | 37 ----- ...talv1_s-s-h-keys_find-device-s-s-h-keys.md | 39 ------ ...alv1_s-s-h-keys_find-project-s-s-h-keys.md | 39 ------ ...metalv1_s-s-h-keys_find-s-s-h-key-by-id.md | 38 ----- ...nix_metalv1_s-s-h-keys_update-s-s-h-key.md | 42 ------ docs/equinix_metalv1_ssh-keys.md | 34 +++++ ...metalv1_ssh-keys_create-project-ssh-key.md | 40 ++++++ ...equinix_metalv1_ssh-keys_create-ssh-key.md | 39 ++++++ ...equinix_metalv1_ssh-keys_delete-ssh-key.md | 34 +++++ ...x_metalv1_ssh-keys_find-device-ssh-keys.md | 36 +++++ ..._metalv1_ssh-keys_find-project-ssh-keys.md | 36 +++++ ...nix_metalv1_ssh-keys_find-ssh-key-by-id.md | 35 +++++ ...equinix_metalv1_ssh-keys_find-ssh-keys.md} | 17 +-- ...equinix_metalv1_ssh-keys_update-ssh-key.md | 39 ++++++ docs/equinix_metalv1_v-l-a-ns.md | 31 ---- ...metalv1_v-l-a-ns_delete-virtual-network.md | 39 ------ ..._metalv1_v-l-a-ns_find-virtual-networks.md | 41 ------ ...ix_metalv1_v-l-a-ns_get-virtual-network.md | 39 ------ docs/equinix_metalv1_v-r-fs.md | 42 ------ docs/equinix_metalv1_v-r-fs_delete-vrf.md | 37 ----- ..._metalv1_v-r-fs_get-vrf-b-g-p-neighbors.md | 37 ----- ...x_metalv1_v-r-fs_get-vrf-learned-routes.md | 37 ----- docs/equinix_metalv1_vlans.md | 31 ++++ ...x_metalv1_vlans_create-virtual-network.md} | 17 +-- ...ix_metalv1_vlans_delete-virtual-network.md | 36 +++++ ...nix_metalv1_vlans_find-virtual-networks.md | 38 +++++ ...uinix_metalv1_vlans_get-virtual-network.md | 36 +++++ ...x_metalv1_vlans_update-virtual-network.md} | 17 +-- docs/equinix_metalv1_vrfs.md | 42 ++++++ ...alv1_vrfs_bgp-dynamic-neighbors-id-get.md} | 17 +-- ... equinix_metalv1_vrfs_create-vrf-route.md} | 17 +-- ....md => equinix_metalv1_vrfs_create-vrf.md} | 17 +-- ...vrfs_delete-bgp-dynamic-neighbor-by-id.md} | 17 +-- ...ix_metalv1_vrfs_delete-vrf-route-by-id.md} | 17 +-- docs/equinix_metalv1_vrfs_delete-vrf.md | 34 +++++ ...=> equinix_metalv1_vrfs_find-vrf-by-id.md} | 17 +-- ...x_metalv1_vrfs_find-vrf-ip-reservation.md} | 19 ++- ..._metalv1_vrfs_find-vrf-ip-reservations.md} | 17 +-- ...inix_metalv1_vrfs_find-vrf-route-by-id.md} | 17 +-- ...s.md => equinix_metalv1_vrfs_find-vrfs.md} | 17 +-- ...inix_metalv1_vrfs_get-vrf-bgp-neighbors.md | 34 +++++ ...nix_metalv1_vrfs_get-vrf-learned-routes.md | 34 +++++ ...=> equinix_metalv1_vrfs_get-vrf-routes.md} | 17 +-- ...ix_metalv1_vrfs_update-vrf-route-by-id.md} | 17 +-- ....md => equinix_metalv1_vrfs_update-vrf.md} | 17 +-- .../equinix_orderhistoryv1_retrieve-orders.md | 4 +- ...e-orders_get-retrieve-orders-locations.md} | 6 +- ...v1_retrieve-orders_post-orders-history.md} | 6 +- docs/equinix_ordersv2_orders.md | 2 +- ...inix_ordersv2_orders_get-order-details.md} | 6 +- 115 files changed, 1459 insertions(+), 1585 deletions(-) delete mode 100644 docs/equinix_accesstokenv1_o-auth2-token.md create mode 100644 docs/equinix_accesstokenv1_oauth2-token.md rename docs/{equinix_accesstokenv1_o-auth2-token_get-o-auth2-access-token.md => equinix_accesstokenv1_oauth2-token_get-oauth2-access-token.md} (73%) rename docs/{equinix_accesstokenv1_o-auth2-token_refresh-o-auth2-access-token.md => equinix_accesstokenv1_oauth2-token_refresh-oauth2-access-token.md} (63%) rename docs/{equinix_eiav2_e-i-a-service.md => equinix_eiav2_eia-service.md} (54%) rename docs/{equinix_eiav2_e-i-a-service_create-equinix-internet-accessv2.md => equinix_eiav2_eia-service_create-equinix-internet-accessv2.md} (81%) rename docs/{equinix_metalv1_authentication_create-a-p-i-key.md => equinix_metalv1_authentication_create-api-key.md} (89%) rename docs/{equinix_metalv1_authentication_create-project-a-p-i-key.md => equinix_metalv1_authentication_create-project-api-key.md} (88%) rename docs/{equinix_metalv1_authentication_delete-a-p-i-key.md => equinix_metalv1_authentication_delete-api-key.md} (80%) rename docs/{equinix_metalv1_authentication_delete-user-a-p-i-key.md => equinix_metalv1_authentication_delete-user-api-key.md} (79%) rename docs/{equinix_metalv1_authentication_find-a-p-i-keys.md => equinix_metalv1_authentication_find-api-keys.md} (83%) rename docs/{equinix_metalv1_authentication_find-project-a-p-i-keys.md => equinix_metalv1_authentication_find-project-api-keys.md} (81%) delete mode 100644 docs/equinix_metalv1_b-g-p.md delete mode 100644 docs/equinix_metalv1_b-g-p_delete-bgp-session.md delete mode 100644 docs/equinix_metalv1_b-g-p_find-global-bgp-ranges.md delete mode 100644 docs/equinix_metalv1_b-g-p_find-project-bgp-sessions.md create mode 100644 docs/equinix_metalv1_bgp.md create mode 100644 docs/equinix_metalv1_bgp_delete-bgp-session.md rename docs/{equinix_metalv1_b-g-p_find-bgp-config-by-project.md => equinix_metalv1_bgp_find-bgp-config-by-project.md} (51%) rename docs/{equinix_metalv1_b-g-p_find-bgp-session-by-id.md => equinix_metalv1_bgp_find-bgp-session-by-id.md} (52%) create mode 100644 docs/equinix_metalv1_bgp_find-global-bgp-ranges.md create mode 100644 docs/equinix_metalv1_bgp_find-project-bgp-sessions.md rename docs/{equinix_metalv1_b-g-p_request-bgp-config.md => equinix_metalv1_bgp_request-bgp-config.md} (73%) rename docs/{equinix_metalv1_b-g-p_update-bgp-session.md => equinix_metalv1_bgp_update-bgp-session.md} (52%) delete mode 100644 docs/equinix_metalv1_devices_create-i-p-assignment.md create mode 100644 docs/equinix_metalv1_devices_create-ip-assignment.md rename docs/{equinix_metalv1_devices_find-device-metadata-by-i-d.md => equinix_metalv1_devices_find-device-metadata-by-id.md} (78%) rename docs/{equinix_metalv1_devices_find-device-userdata-by-i-d.md => equinix_metalv1_devices_find-device-userdata-by-id.md} (78%) rename docs/{equinix_metalv1_devices_find-i-p-assignment-customdata.md => equinix_metalv1_devices_find-ip-assignment-customdata.md} (80%) rename docs/{equinix_metalv1_devices_find-i-p-assignments.md => equinix_metalv1_devices_find-ip-assignments.md} (83%) delete mode 100644 docs/equinix_metalv1_i-p-addresses.md delete mode 100644 docs/equinix_metalv1_i-p-addresses_delete-i-p-address.md delete mode 100644 docs/equinix_metalv1_i-p-addresses_find-i-p-address-by-id.md delete mode 100644 docs/equinix_metalv1_i-p-addresses_find-i-p-address-customdata.md delete mode 100644 docs/equinix_metalv1_i-p-addresses_find-i-p-availabilities.md delete mode 100644 docs/equinix_metalv1_i-p-addresses_request-i-p-reservation.md delete mode 100644 docs/equinix_metalv1_i-p-addresses_update-i-p-address.md create mode 100644 docs/equinix_metalv1_ip-addresses.md create mode 100644 docs/equinix_metalv1_ip-addresses_delete-ip-address.md create mode 100644 docs/equinix_metalv1_ip-addresses_find-ip-address-by-id.md create mode 100644 docs/equinix_metalv1_ip-addresses_find-ip-address-customdata.md create mode 100644 docs/equinix_metalv1_ip-addresses_find-ip-availabilities.md rename docs/{equinix_metalv1_i-p-addresses_find-i-p-reservations.md => equinix_metalv1_ip-addresses_find-ip-reservations.md} (53%) create mode 100644 docs/equinix_metalv1_ip-addresses_request-ip-reservation.md create mode 100644 docs/equinix_metalv1_ip-addresses_update-ip-address.md rename docs/{equinix_metalv1_projects_find-i-p-reservation-customdata.md => equinix_metalv1_projects_find-ip-reservation-customdata.md} (80%) delete mode 100644 docs/equinix_metalv1_s-s-h-keys.md delete mode 100644 docs/equinix_metalv1_s-s-h-keys_create-project-s-s-h-key.md delete mode 100644 docs/equinix_metalv1_s-s-h-keys_create-s-s-h-key.md delete mode 100644 docs/equinix_metalv1_s-s-h-keys_delete-s-s-h-key.md delete mode 100644 docs/equinix_metalv1_s-s-h-keys_find-device-s-s-h-keys.md delete mode 100644 docs/equinix_metalv1_s-s-h-keys_find-project-s-s-h-keys.md delete mode 100644 docs/equinix_metalv1_s-s-h-keys_find-s-s-h-key-by-id.md delete mode 100644 docs/equinix_metalv1_s-s-h-keys_update-s-s-h-key.md create mode 100644 docs/equinix_metalv1_ssh-keys.md create mode 100644 docs/equinix_metalv1_ssh-keys_create-project-ssh-key.md create mode 100644 docs/equinix_metalv1_ssh-keys_create-ssh-key.md create mode 100644 docs/equinix_metalv1_ssh-keys_delete-ssh-key.md create mode 100644 docs/equinix_metalv1_ssh-keys_find-device-ssh-keys.md create mode 100644 docs/equinix_metalv1_ssh-keys_find-project-ssh-keys.md create mode 100644 docs/equinix_metalv1_ssh-keys_find-ssh-key-by-id.md rename docs/{equinix_metalv1_s-s-h-keys_find-s-s-h-keys.md => equinix_metalv1_ssh-keys_find-ssh-keys.md} (51%) create mode 100644 docs/equinix_metalv1_ssh-keys_update-ssh-key.md delete mode 100644 docs/equinix_metalv1_v-l-a-ns.md delete mode 100644 docs/equinix_metalv1_v-l-a-ns_delete-virtual-network.md delete mode 100644 docs/equinix_metalv1_v-l-a-ns_find-virtual-networks.md delete mode 100644 docs/equinix_metalv1_v-l-a-ns_get-virtual-network.md delete mode 100644 docs/equinix_metalv1_v-r-fs.md delete mode 100644 docs/equinix_metalv1_v-r-fs_delete-vrf.md delete mode 100644 docs/equinix_metalv1_v-r-fs_get-vrf-b-g-p-neighbors.md delete mode 100644 docs/equinix_metalv1_v-r-fs_get-vrf-learned-routes.md create mode 100644 docs/equinix_metalv1_vlans.md rename docs/{equinix_metalv1_v-l-a-ns_create-virtual-network.md => equinix_metalv1_vlans_create-virtual-network.md} (76%) create mode 100644 docs/equinix_metalv1_vlans_delete-virtual-network.md create mode 100644 docs/equinix_metalv1_vlans_find-virtual-networks.md create mode 100644 docs/equinix_metalv1_vlans_get-virtual-network.md rename docs/{equinix_metalv1_v-l-a-ns_update-virtual-network.md => equinix_metalv1_vlans_update-virtual-network.md} (66%) create mode 100644 docs/equinix_metalv1_vrfs.md rename docs/{equinix_metalv1_v-r-fs_bgp-dynamic-neighbors-id-get.md => equinix_metalv1_vrfs_bgp-dynamic-neighbors-id-get.md} (53%) rename docs/{equinix_metalv1_v-r-fs_create-vrf-route.md => equinix_metalv1_vrfs_create-vrf-route.md} (71%) rename docs/{equinix_metalv1_v-r-fs_create-vrf.md => equinix_metalv1_vrfs_create-vrf.md} (81%) rename docs/{equinix_metalv1_v-r-fs_delete-bgp-dynamic-neighbor-by-id.md => equinix_metalv1_vrfs_delete-bgp-dynamic-neighbor-by-id.md} (53%) rename docs/{equinix_metalv1_v-r-fs_delete-vrf-route-by-id.md => equinix_metalv1_vrfs_delete-vrf-route-by-id.md} (50%) create mode 100644 docs/equinix_metalv1_vrfs_delete-vrf.md rename docs/{equinix_metalv1_v-r-fs_find-vrf-by-id.md => equinix_metalv1_vrfs_find-vrf-by-id.md} (56%) rename docs/{equinix_metalv1_v-r-fs_find-vrf-ip-reservation.md => equinix_metalv1_vrfs_find-vrf-ip-reservation.md} (52%) rename docs/{equinix_metalv1_v-r-fs_find-vrf-ip-reservations.md => equinix_metalv1_vrfs_find-vrf-ip-reservations.md} (54%) rename docs/{equinix_metalv1_v-r-fs_find-vrf-route-by-id.md => equinix_metalv1_vrfs_find-vrf-route-by-id.md} (55%) rename docs/{equinix_metalv1_v-r-fs_find-vrfs.md => equinix_metalv1_vrfs_find-vrfs.md} (58%) create mode 100644 docs/equinix_metalv1_vrfs_get-vrf-bgp-neighbors.md create mode 100644 docs/equinix_metalv1_vrfs_get-vrf-learned-routes.md rename docs/{equinix_metalv1_v-r-fs_get-vrf-routes.md => equinix_metalv1_vrfs_get-vrf-routes.md} (55%) rename docs/{equinix_metalv1_v-r-fs_update-vrf-route-by-id.md => equinix_metalv1_vrfs_update-vrf-route-by-id.md} (70%) rename docs/{equinix_metalv1_v-r-fs_update-vrf.md => equinix_metalv1_vrfs_update-vrf.md} (85%) rename docs/{equinix_orderhistoryv1_retrieve-orders_g-e-t-retrieve-orders-locations.md => equinix_orderhistoryv1_retrieve-orders_get-retrieve-orders-locations.md} (80%) rename docs/{equinix_orderhistoryv1_retrieve-orders_p-o-s-t-orders-history.md => equinix_orderhistoryv1_retrieve-orders_post-orders-history.md} (92%) rename docs/{equinix_ordersv2_orders_g-e-t-order-details.md => equinix_ordersv2_orders_get-order-details.md} (83%) diff --git a/docs/equinix_accesstokenv1.md b/docs/equinix_accesstokenv1.md index c37a824..5ac25d3 100644 --- a/docs/equinix_accesstokenv1.md +++ b/docs/equinix_accesstokenv1.md @@ -26,5 +26,5 @@ providing access to all available API services. ### SEE ALSO * [equinix](equinix.md) - Equinix CLI -* [equinix accesstokenv1 o-auth2-token](equinix_accesstokenv1_o-auth2-token.md) - Manage o-auth2-token resources +* [equinix accesstokenv1 oauth2-token](equinix_accesstokenv1_oauth2-token.md) - Manage oauth2-token resources diff --git a/docs/equinix_accesstokenv1_o-auth2-token.md b/docs/equinix_accesstokenv1_o-auth2-token.md deleted file mode 100644 index 4734017..0000000 --- a/docs/equinix_accesstokenv1_o-auth2-token.md +++ /dev/null @@ -1,28 +0,0 @@ -## equinix accesstokenv1 o-auth2-token - -Manage o-auth2-token resources - -### Synopsis - -Commands for managing o-auth2-token resources in the API - -### Options - -``` - -h, --help help for o-auth2-token -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix accesstokenv1](equinix_accesstokenv1.md) - Manage Equinix accesstokenv1 resources -* [equinix accesstokenv1 o-auth2-token get-o-auth2-access-token](equinix_accesstokenv1_o-auth2-token_get-o-auth2-access-token.md) - Generate New Access Token -* [equinix accesstokenv1 o-auth2-token refresh-o-auth2-access-token](equinix_accesstokenv1_o-auth2-token_refresh-o-auth2-access-token.md) - Renew Access Tokens - diff --git a/docs/equinix_accesstokenv1_oauth2-token.md b/docs/equinix_accesstokenv1_oauth2-token.md new file mode 100644 index 0000000..fb829f7 --- /dev/null +++ b/docs/equinix_accesstokenv1_oauth2-token.md @@ -0,0 +1,28 @@ +## equinix accesstokenv1 oauth2-token + +Manage oauth2-token resources + +### Synopsis + +Commands for managing oauth2-token resources in the API + +### Options + +``` + -h, --help help for oauth2-token +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix accesstokenv1](equinix_accesstokenv1.md) - Manage Equinix accesstokenv1 resources +* [equinix accesstokenv1 oauth2-token get-oauth2-access-token](equinix_accesstokenv1_oauth2-token_get-oauth2-access-token.md) - Execute get-oauth2-access-token operation +* [equinix accesstokenv1 oauth2-token refresh-oauth2-access-token](equinix_accesstokenv1_oauth2-token_refresh-oauth2-access-token.md) - Execute refresh-oauth2-access-token operation + diff --git a/docs/equinix_accesstokenv1_o-auth2-token_get-o-auth2-access-token.md b/docs/equinix_accesstokenv1_oauth2-token_get-oauth2-access-token.md similarity index 73% rename from docs/equinix_accesstokenv1_o-auth2-token_get-o-auth2-access-token.md rename to docs/equinix_accesstokenv1_oauth2-token_get-oauth2-access-token.md index 740cd61..9b51a1a 100644 --- a/docs/equinix_accesstokenv1_o-auth2-token_get-o-auth2-access-token.md +++ b/docs/equinix_accesstokenv1_oauth2-token_get-oauth2-access-token.md @@ -1,21 +1,24 @@ -## equinix accesstokenv1 o-auth2-token get-o-auth2-access-token +## equinix accesstokenv1 oauth2-token get-oauth2-access-token -Generate New Access Token +Execute get-oauth2-access-token operation ### Synopsis -This API handles authentication and authorization of the API developer. It returns an access_token which would be valid for 60 minutes. The user account will get locked after 5 successive invalid attempts. +Execute the get-oauth2-access-token operation on this service. -Use --request flag to provide optional JSON payload fields. +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. ``` -equinix accesstokenv1 o-auth2-token get-o-auth2-access-token [flags] +equinix accesstokenv1 oauth2-token get-oauth2-access-token [flags] ``` ### Options ``` - -h, --help help for get-o-auth2-access-token + -h, --help help for get-oauth2-access-token --payload-additional-properties string payload-additional-properties (JSON) --payload-client_id string API Consumer Key available under \"My Apps\" in developer portal --payload-client_secret string API Consumer secret available under \"My Apps\" in developer portal @@ -36,5 +39,5 @@ equinix accesstokenv1 o-auth2-token get-o-auth2-access-token [flags] ### SEE ALSO -* [equinix accesstokenv1 o-auth2-token](equinix_accesstokenv1_o-auth2-token.md) - Manage o-auth2-token resources +* [equinix accesstokenv1 oauth2-token](equinix_accesstokenv1_oauth2-token.md) - Manage oauth2-token resources diff --git a/docs/equinix_accesstokenv1_o-auth2-token_refresh-o-auth2-access-token.md b/docs/equinix_accesstokenv1_oauth2-token_refresh-oauth2-access-token.md similarity index 63% rename from docs/equinix_accesstokenv1_o-auth2-token_refresh-o-auth2-access-token.md rename to docs/equinix_accesstokenv1_oauth2-token_refresh-oauth2-access-token.md index 5b9940d..4337234 100644 --- a/docs/equinix_accesstokenv1_o-auth2-token_refresh-o-auth2-access-token.md +++ b/docs/equinix_accesstokenv1_oauth2-token_refresh-oauth2-access-token.md @@ -1,21 +1,24 @@ -## equinix accesstokenv1 o-auth2-token refresh-o-auth2-access-token +## equinix accesstokenv1 oauth2-token refresh-oauth2-access-token -Renew Access Tokens +Execute refresh-oauth2-access-token operation ### Synopsis -Use this API to refresh an access token using its refresh token. A valid refresh token is needed to retrieve a new access_token. +Execute the refresh-oauth2-access-token operation on this service. -Use --request flag to provide optional JSON payload fields. +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. ``` -equinix accesstokenv1 o-auth2-token refresh-o-auth2-access-token [flags] +equinix accesstokenv1 oauth2-token refresh-oauth2-access-token [flags] ``` ### Options ``` - -h, --help help for refresh-o-auth2-access-token + -h, --help help for refresh-oauth2-access-token --payload-additional-properties string payload-additional-properties (JSON) --payload-client_id string API Consumer Key available under \"My Apps\" in developer portal --payload-client_secret string API Consumer secret available under \"My Apps\" in developer portal @@ -33,5 +36,5 @@ equinix accesstokenv1 o-auth2-token refresh-o-auth2-access-token [flags] ### SEE ALSO -* [equinix accesstokenv1 o-auth2-token](equinix_accesstokenv1_o-auth2-token.md) - Manage o-auth2-token resources +* [equinix accesstokenv1 oauth2-token](equinix_accesstokenv1_oauth2-token.md) - Manage oauth2-token resources diff --git a/docs/equinix_eiav2.md b/docs/equinix_eiav2.md index 5bee68c..b28090e 100644 --- a/docs/equinix_eiav2.md +++ b/docs/equinix_eiav2.md @@ -26,5 +26,5 @@ providing access to all available API services. ### SEE ALSO * [equinix](equinix.md) - Equinix CLI -* [equinix eiav2 e-i-a-service](equinix_eiav2_e-i-a-service.md) - Manage e-i-a-service resources +* [equinix eiav2 eia-service](equinix_eiav2_eia-service.md) - Manage eia-service resources diff --git a/docs/equinix_eiav2_e-i-a-service.md b/docs/equinix_eiav2_eia-service.md similarity index 54% rename from docs/equinix_eiav2_e-i-a-service.md rename to docs/equinix_eiav2_eia-service.md index b609263..26a0af1 100644 --- a/docs/equinix_eiav2_e-i-a-service.md +++ b/docs/equinix_eiav2_eia-service.md @@ -1,15 +1,15 @@ -## equinix eiav2 e-i-a-service +## equinix eiav2 eia-service -Manage e-i-a-service resources +Manage eia-service resources ### Synopsis -Commands for managing e-i-a-service resources in the API +Commands for managing eia-service resources in the API ### Options ``` - -h, --help help for e-i-a-service + -h, --help help for eia-service ``` ### Options inherited from parent commands @@ -23,5 +23,5 @@ Commands for managing e-i-a-service resources in the API ### SEE ALSO * [equinix eiav2](equinix_eiav2.md) - Manage Equinix eiav2 resources -* [equinix eiav2 e-i-a-service create-equinix-internet-accessv2](equinix_eiav2_e-i-a-service_create-equinix-internet-accessv2.md) - Execute create-equinix-internet-accessv2 operation +* [equinix eiav2 eia-service create-equinix-internet-accessv2](equinix_eiav2_eia-service_create-equinix-internet-accessv2.md) - Creates Equinix Internet Access Service diff --git a/docs/equinix_eiav2_e-i-a-service_create-equinix-internet-accessv2.md b/docs/equinix_eiav2_eia-service_create-equinix-internet-accessv2.md similarity index 81% rename from docs/equinix_eiav2_e-i-a-service_create-equinix-internet-accessv2.md rename to docs/equinix_eiav2_eia-service_create-equinix-internet-accessv2.md index 50ac59b..b13431c 100644 --- a/docs/equinix_eiav2_e-i-a-service_create-equinix-internet-accessv2.md +++ b/docs/equinix_eiav2_eia-service_create-equinix-internet-accessv2.md @@ -1,18 +1,15 @@ -## equinix eiav2 e-i-a-service create-equinix-internet-accessv2 +## equinix eiav2 eia-service create-equinix-internet-accessv2 -Execute create-equinix-internet-accessv2 operation +Creates Equinix Internet Access Service ### Synopsis -Execute the create-equinix-internet-accessv2 operation on this service. +By passing in the appropriate options, you can create Equinix Internet Access Service product. The entire request either succeeds or fails. In case of failure all the changes in the system are rolled back, so the system gets back to its stated before submitting the request -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. +Use --request flag to provide optional JSON payload fields. ``` -equinix eiav2 e-i-a-service create-equinix-internet-accessv2 [flags] +equinix eiav2 eia-service create-equinix-internet-accessv2 [flags] ``` ### Options @@ -48,5 +45,5 @@ equinix eiav2 e-i-a-service create-equinix-internet-accessv2 [flags] ### SEE ALSO -* [equinix eiav2 e-i-a-service](equinix_eiav2_e-i-a-service.md) - Manage e-i-a-service resources +* [equinix eiav2 eia-service](equinix_eiav2_eia-service.md) - Manage eia-service resources diff --git a/docs/equinix_fabricv4_ports_create-port.md b/docs/equinix_fabricv4_ports_create-port.md index 6948777..92db78e 100644 --- a/docs/equinix_fabricv4_ports_create-port.md +++ b/docs/equinix_fabricv4_ports_create-port.md @@ -101,11 +101,11 @@ equinix fabricv4 ports create-port [flags] --port-request-location-region string port-request-location-region --port-request-name string Equinix assigned response attribute for Port name --port-request-notifications string Notification preferences (JSON array) - --port-request-operation-access-v-c-count int Total number of connections. + --port-request-operation-access-vc-count int Total number of connections. --port-request-operation-additional-properties string port-request-operation-additional-properties (JSON) --port-request-operation-connection-count int Total number of connections. - --port-request-operation-evpl-v-c-count int Total number of connections. - --port-request-operation-fg-v-c-count int Total number of connections. + --port-request-operation-evpl-vc-count int Total number of connections. + --port-request-operation-fg-vc-count int Total number of connections. --port-request-operation-op-status-changed-at string port-request-operation-op-status-changed-at (JSON) --port-request-operation-operational-status string port-request-operation-operational-status --port-request-order-additional-properties string port-request-order-additional-properties (JSON) diff --git a/docs/equinix_fabricv4_routing-protocols_create-connection-routing-protocol.md b/docs/equinix_fabricv4_routing-protocols_create-connection-routing-protocol.md index cf419c6..65adcc2 100644 --- a/docs/equinix_fabricv4_routing-protocols_create-connection-routing-protocol.md +++ b/docs/equinix_fabricv4_routing-protocols_create-connection-routing-protocol.md @@ -18,15 +18,15 @@ equinix fabricv4 routing-protocols create-connection-routing-protocol [flags] --connection-id string Connection Id (required) -h, --help help for create-connection-routing-protocol --request string JSON payload for additional optional fields not exposed as flags - --routing-protocol-base-routing-protocol-b-g-p-type-additional-properties string routing-protocol-base-routing-protocol-b-g-p-type-additional-properties (JSON) - --routing-protocol-base-routing-protocol-b-g-p-type-as-override-enabled Enable AS number override - --routing-protocol-base-routing-protocol-b-g-p-type-bfd string routing-protocol-base-routing-protocol-b-g-p-type-bfd (JSON) - --routing-protocol-base-routing-protocol-b-g-p-type-bgp-auth-key string BGP authorization key - --routing-protocol-base-routing-protocol-b-g-p-type-bgp-ipv4 string routing-protocol-base-routing-protocol-b-g-p-type-bgp-ipv4 (JSON) - --routing-protocol-base-routing-protocol-b-g-p-type-bgp-ipv6 string routing-protocol-base-routing-protocol-b-g-p-type-bgp-ipv6 (JSON) - --routing-protocol-base-routing-protocol-b-g-p-type-customer-asn int Customer asn - --routing-protocol-base-routing-protocol-b-g-p-type-name string routing-protocol-base-routing-protocol-b-g-p-type-name - --routing-protocol-base-routing-protocol-b-g-p-type-type string routing-protocol-base-routing-protocol-b-g-p-type-type + --routing-protocol-base-routing-protocol-bgp-type-additional-properties string routing-protocol-base-routing-protocol-bgp-type-additional-properties (JSON) + --routing-protocol-base-routing-protocol-bgp-type-as-override-enabled Enable AS number override + --routing-protocol-base-routing-protocol-bgp-type-bfd string routing-protocol-base-routing-protocol-bgp-type-bfd (JSON) + --routing-protocol-base-routing-protocol-bgp-type-bgp-auth-key string BGP authorization key + --routing-protocol-base-routing-protocol-bgp-type-bgp-ipv4 string routing-protocol-base-routing-protocol-bgp-type-bgp-ipv4 (JSON) + --routing-protocol-base-routing-protocol-bgp-type-bgp-ipv6 string routing-protocol-base-routing-protocol-bgp-type-bgp-ipv6 (JSON) + --routing-protocol-base-routing-protocol-bgp-type-customer-asn int Customer asn + --routing-protocol-base-routing-protocol-bgp-type-name string routing-protocol-base-routing-protocol-bgp-type-name + --routing-protocol-base-routing-protocol-bgp-type-type string routing-protocol-base-routing-protocol-bgp-type-type --routing-protocol-base-routing-protocol-direct-type-additional-properties string routing-protocol-base-routing-protocol-direct-type-additional-properties (JSON) --routing-protocol-base-routing-protocol-direct-type-direct-ipv4 string routing-protocol-base-routing-protocol-direct-type-direct-ipv4 (JSON) --routing-protocol-base-routing-protocol-direct-type-direct-ipv6 string routing-protocol-base-routing-protocol-direct-type-direct-ipv6 (JSON) diff --git a/docs/equinix_fabricv4_routing-protocols_post-connection-routing-protocol-bgp-action-by-uuid.md b/docs/equinix_fabricv4_routing-protocols_post-connection-routing-protocol-bgp-action-by-uuid.md index c939ea8..e237687 100644 --- a/docs/equinix_fabricv4_routing-protocols_post-connection-routing-protocol-bgp-action-by-uuid.md +++ b/docs/equinix_fabricv4_routing-protocols_post-connection-routing-protocol-bgp-action-by-uuid.md @@ -15,12 +15,12 @@ equinix fabricv4 routing-protocols post-connection-routing-protocol-bgp-action-b ### Options ``` - --b-g-p-action-request-additional-properties string b-g-p-action-request-additional-properties (JSON) - --b-g-p-action-request-type string b-g-p-action-request-type - --connection-id string Connection Id (required) - -h, --help help for post-connection-routing-protocol-bgp-action-by-uuid - --request string JSON payload for additional optional fields not exposed as flags - --routing-protocol-id string Routing Protocol Id (required) + --bgp-action-request-additional-properties string bgp-action-request-additional-properties (JSON) + --bgp-action-request-type string bgp-action-request-type + --connection-id string Connection Id (required) + -h, --help help for post-connection-routing-protocol-bgp-action-by-uuid + --request string JSON payload for additional optional fields not exposed as flags + --routing-protocol-id string Routing Protocol Id (required) ``` ### Options inherited from parent commands diff --git a/docs/equinix_fabricv4_routing-protocols_replace-connection-routing-protocol-by-uuid.md b/docs/equinix_fabricv4_routing-protocols_replace-connection-routing-protocol-by-uuid.md index fceda81..aa2f265 100644 --- a/docs/equinix_fabricv4_routing-protocols_replace-connection-routing-protocol-by-uuid.md +++ b/docs/equinix_fabricv4_routing-protocols_replace-connection-routing-protocol-by-uuid.md @@ -18,15 +18,15 @@ equinix fabricv4 routing-protocols replace-connection-routing-protocol-by-uuid [ --connection-id string Connection Id (required) -h, --help help for replace-connection-routing-protocol-by-uuid --request string JSON payload for additional optional fields not exposed as flags - --routing-protocol-base-routing-protocol-b-g-p-type-additional-properties string routing-protocol-base-routing-protocol-b-g-p-type-additional-properties (JSON) - --routing-protocol-base-routing-protocol-b-g-p-type-as-override-enabled Enable AS number override - --routing-protocol-base-routing-protocol-b-g-p-type-bfd string routing-protocol-base-routing-protocol-b-g-p-type-bfd (JSON) - --routing-protocol-base-routing-protocol-b-g-p-type-bgp-auth-key string BGP authorization key - --routing-protocol-base-routing-protocol-b-g-p-type-bgp-ipv4 string routing-protocol-base-routing-protocol-b-g-p-type-bgp-ipv4 (JSON) - --routing-protocol-base-routing-protocol-b-g-p-type-bgp-ipv6 string routing-protocol-base-routing-protocol-b-g-p-type-bgp-ipv6 (JSON) - --routing-protocol-base-routing-protocol-b-g-p-type-customer-asn int Customer asn - --routing-protocol-base-routing-protocol-b-g-p-type-name string routing-protocol-base-routing-protocol-b-g-p-type-name - --routing-protocol-base-routing-protocol-b-g-p-type-type string routing-protocol-base-routing-protocol-b-g-p-type-type + --routing-protocol-base-routing-protocol-bgp-type-additional-properties string routing-protocol-base-routing-protocol-bgp-type-additional-properties (JSON) + --routing-protocol-base-routing-protocol-bgp-type-as-override-enabled Enable AS number override + --routing-protocol-base-routing-protocol-bgp-type-bfd string routing-protocol-base-routing-protocol-bgp-type-bfd (JSON) + --routing-protocol-base-routing-protocol-bgp-type-bgp-auth-key string BGP authorization key + --routing-protocol-base-routing-protocol-bgp-type-bgp-ipv4 string routing-protocol-base-routing-protocol-bgp-type-bgp-ipv4 (JSON) + --routing-protocol-base-routing-protocol-bgp-type-bgp-ipv6 string routing-protocol-base-routing-protocol-bgp-type-bgp-ipv6 (JSON) + --routing-protocol-base-routing-protocol-bgp-type-customer-asn int Customer asn + --routing-protocol-base-routing-protocol-bgp-type-name string routing-protocol-base-routing-protocol-bgp-type-name + --routing-protocol-base-routing-protocol-bgp-type-type string routing-protocol-base-routing-protocol-bgp-type-type --routing-protocol-base-routing-protocol-direct-type-additional-properties string routing-protocol-base-routing-protocol-direct-type-additional-properties (JSON) --routing-protocol-base-routing-protocol-direct-type-direct-ipv4 string routing-protocol-base-routing-protocol-direct-type-direct-ipv4 (JSON) --routing-protocol-base-routing-protocol-direct-type-direct-ipv6 string routing-protocol-base-routing-protocol-direct-type-direct-ipv6 (JSON) diff --git a/docs/equinix_metalv1.md b/docs/equinix_metalv1.md index f70658b..cb8f2b0 100644 --- a/docs/equinix_metalv1.md +++ b/docs/equinix_metalv1.md @@ -27,8 +27,8 @@ providing access to all available API services. * [equinix](equinix.md) - Equinix CLI * [equinix metalv1 authentication](equinix_metalv1_authentication.md) - Manage authentication resources -* [equinix metalv1 b-g-p](equinix_metalv1_b-g-p.md) - Manage b-g-p resources * [equinix metalv1 batches](equinix_metalv1_batches.md) - Manage batches resources +* [equinix metalv1 bgp](equinix_metalv1_bgp.md) - Manage bgp resources * [equinix metalv1 capacity](equinix_metalv1_capacity.md) - Manage capacity resources * [equinix metalv1 console-log-details](equinix_metalv1_console-log-details.md) - Manage console-log-details resources * [equinix metalv1 devices](equinix_metalv1_devices.md) - Manage devices resources @@ -37,11 +37,11 @@ providing access to all available API services. * [equinix metalv1 facilities](equinix_metalv1_facilities.md) - Manage facilities resources * [equinix metalv1 firmware-sets](equinix_metalv1_firmware-sets.md) - Manage firmware-sets resources * [equinix metalv1 hardware-reservations](equinix_metalv1_hardware-reservations.md) - Manage hardware-reservations resources -* [equinix metalv1 i-p-addresses](equinix_metalv1_i-p-addresses.md) - Manage i-p-addresses resources * [equinix metalv1 incidents](equinix_metalv1_incidents.md) - Manage incidents resources * [equinix metalv1 interconnections](equinix_metalv1_interconnections.md) - Manage interconnections resources * [equinix metalv1 invitations](equinix_metalv1_invitations.md) - Manage invitations resources * [equinix metalv1 invoices](equinix_metalv1_invoices.md) - Manage invoices resources +* [equinix metalv1 ip-addresses](equinix_metalv1_ip-addresses.md) - Manage ip-addresses resources * [equinix metalv1 licenses](equinix_metalv1_licenses.md) - Manage licenses resources * [equinix metalv1 memberships](equinix_metalv1_memberships.md) - Manage memberships resources * [equinix metalv1 metal-gateways](equinix_metalv1_metal-gateways.md) - Manage metal-gateways resources @@ -53,9 +53,9 @@ providing access to all available API services. * [equinix metalv1 plans](equinix_metalv1_plans.md) - Manage plans resources * [equinix metalv1 ports](equinix_metalv1_ports.md) - Manage ports resources * [equinix metalv1 projects](equinix_metalv1_projects.md) - Manage projects resources -* [equinix metalv1 s-s-h-keys](equinix_metalv1_s-s-h-keys.md) - Manage s-s-h-keys resources * [equinix metalv1 self-service-reservations](equinix_metalv1_self-service-reservations.md) - Manage self-service-reservations resources * [equinix metalv1 spot-market](equinix_metalv1_spot-market.md) - Manage spot-market resources +* [equinix metalv1 ssh-keys](equinix_metalv1_ssh-keys.md) - Manage ssh-keys resources * [equinix metalv1 support-request](equinix_metalv1_support-request.md) - Manage support-request resources * [equinix metalv1 transfer-requests](equinix_metalv1_transfer-requests.md) - Manage transfer-requests resources * [equinix metalv1 two-factor-auth](equinix_metalv1_two-factor-auth.md) - Manage two-factor-auth resources @@ -63,6 +63,6 @@ providing access to all available API services. * [equinix metalv1 user-verification-tokens](equinix_metalv1_user-verification-tokens.md) - Manage user-verification-tokens resources * [equinix metalv1 userdata](equinix_metalv1_userdata.md) - Manage userdata resources * [equinix metalv1 users](equinix_metalv1_users.md) - Manage users resources -* [equinix metalv1 v-l-a-ns](equinix_metalv1_v-l-a-ns.md) - Manage v-l-a-ns resources -* [equinix metalv1 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources +* [equinix metalv1 vlans](equinix_metalv1_vlans.md) - Manage vlans resources +* [equinix metalv1 vrfs](equinix_metalv1_vrfs.md) - Manage vrfs resources diff --git a/docs/equinix_metalv1_authentication.md b/docs/equinix_metalv1_authentication.md index 147d441..7d37fcd 100644 --- a/docs/equinix_metalv1_authentication.md +++ b/docs/equinix_metalv1_authentication.md @@ -23,10 +23,10 @@ Commands for managing authentication resources in the API ### SEE ALSO * [equinix metalv1](equinix_metalv1.md) - Manage Equinix metalv1 resources -* [equinix metalv1 authentication create-a-p-i-key](equinix_metalv1_authentication_create-a-p-i-key.md) - Create an API key -* [equinix metalv1 authentication create-project-a-p-i-key](equinix_metalv1_authentication_create-project-a-p-i-key.md) - Create an API key for a project. -* [equinix metalv1 authentication delete-a-p-i-key](equinix_metalv1_authentication_delete-a-p-i-key.md) - Delete the API key -* [equinix metalv1 authentication delete-user-a-p-i-key](equinix_metalv1_authentication_delete-user-a-p-i-key.md) - Delete the API key -* [equinix metalv1 authentication find-a-p-i-keys](equinix_metalv1_authentication_find-a-p-i-keys.md) - Retrieve all user API keys -* [equinix metalv1 authentication find-project-a-p-i-keys](equinix_metalv1_authentication_find-project-a-p-i-keys.md) - Retrieve all API keys for the project. +* [equinix metalv1 authentication create-api-key](equinix_metalv1_authentication_create-api-key.md) - Create an API key +* [equinix metalv1 authentication create-project-api-key](equinix_metalv1_authentication_create-project-api-key.md) - Create an API key for a project. +* [equinix metalv1 authentication delete-api-key](equinix_metalv1_authentication_delete-api-key.md) - Delete the API key +* [equinix metalv1 authentication delete-user-api-key](equinix_metalv1_authentication_delete-user-api-key.md) - Delete the API key +* [equinix metalv1 authentication find-api-keys](equinix_metalv1_authentication_find-api-keys.md) - Retrieve all user API keys +* [equinix metalv1 authentication find-project-api-keys](equinix_metalv1_authentication_find-project-api-keys.md) - Retrieve all API keys for the project. diff --git a/docs/equinix_metalv1_authentication_create-a-p-i-key.md b/docs/equinix_metalv1_authentication_create-api-key.md similarity index 89% rename from docs/equinix_metalv1_authentication_create-a-p-i-key.md rename to docs/equinix_metalv1_authentication_create-api-key.md index 6fba5c5..3d9e9c4 100644 --- a/docs/equinix_metalv1_authentication_create-a-p-i-key.md +++ b/docs/equinix_metalv1_authentication_create-api-key.md @@ -1,4 +1,4 @@ -## equinix metalv1 authentication create-a-p-i-key +## equinix metalv1 authentication create-api-key Create an API key @@ -9,7 +9,7 @@ Creates a API key for the current user. Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 authentication create-a-p-i-key [flags] +equinix metalv1 authentication create-api-key [flags] ``` ### Options @@ -18,7 +18,7 @@ equinix metalv1 authentication create-a-p-i-key [flags] --auth-token-input-additional-properties string auth-token-input-additional-properties (JSON) --auth-token-input-description string auth-token-input-description --auth-token-input-read_only auth-token-input-read_only - -h, --help help for create-a-p-i-key + -h, --help help for create-api-key --include string include field (JSON or string) --request string JSON payload for additional optional fields not exposed as flags ``` diff --git a/docs/equinix_metalv1_authentication_create-project-a-p-i-key.md b/docs/equinix_metalv1_authentication_create-project-api-key.md similarity index 88% rename from docs/equinix_metalv1_authentication_create-project-a-p-i-key.md rename to docs/equinix_metalv1_authentication_create-project-api-key.md index 00f7c12..313581b 100644 --- a/docs/equinix_metalv1_authentication_create-project-a-p-i-key.md +++ b/docs/equinix_metalv1_authentication_create-project-api-key.md @@ -1,4 +1,4 @@ -## equinix metalv1 authentication create-project-a-p-i-key +## equinix metalv1 authentication create-project-api-key Create an API key for a project. @@ -9,7 +9,7 @@ Creates an API key for a project. Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 authentication create-project-a-p-i-key [flags] +equinix metalv1 authentication create-project-api-key [flags] ``` ### Options @@ -18,7 +18,7 @@ equinix metalv1 authentication create-project-a-p-i-key [flags] --auth-token-input-additional-properties string auth-token-input-additional-properties (JSON) --auth-token-input-description string auth-token-input-description --auth-token-input-read_only auth-token-input-read_only - -h, --help help for create-project-a-p-i-key + -h, --help help for create-project-api-key --id string Project UUID (required) --include string include field (JSON or string) --request string JSON payload for additional optional fields not exposed as flags diff --git a/docs/equinix_metalv1_authentication_delete-a-p-i-key.md b/docs/equinix_metalv1_authentication_delete-api-key.md similarity index 80% rename from docs/equinix_metalv1_authentication_delete-a-p-i-key.md rename to docs/equinix_metalv1_authentication_delete-api-key.md index 5e098ac..46dbca4 100644 --- a/docs/equinix_metalv1_authentication_delete-a-p-i-key.md +++ b/docs/equinix_metalv1_authentication_delete-api-key.md @@ -1,4 +1,4 @@ -## equinix metalv1 authentication delete-a-p-i-key +## equinix metalv1 authentication delete-api-key Delete the API key @@ -9,13 +9,13 @@ Deletes the API key. Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 authentication delete-a-p-i-key [flags] +equinix metalv1 authentication delete-api-key [flags] ``` ### Options ``` - -h, --help help for delete-a-p-i-key + -h, --help help for delete-api-key --id string API Key UUID (required) --request string JSON payload for request body fields ``` diff --git a/docs/equinix_metalv1_authentication_delete-user-a-p-i-key.md b/docs/equinix_metalv1_authentication_delete-user-api-key.md similarity index 79% rename from docs/equinix_metalv1_authentication_delete-user-a-p-i-key.md rename to docs/equinix_metalv1_authentication_delete-user-api-key.md index e4e89e1..d1807a3 100644 --- a/docs/equinix_metalv1_authentication_delete-user-a-p-i-key.md +++ b/docs/equinix_metalv1_authentication_delete-user-api-key.md @@ -1,4 +1,4 @@ -## equinix metalv1 authentication delete-user-a-p-i-key +## equinix metalv1 authentication delete-user-api-key Delete the API key @@ -9,13 +9,13 @@ Deletes the current user API key. Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 authentication delete-user-a-p-i-key [flags] +equinix metalv1 authentication delete-user-api-key [flags] ``` ### Options ``` - -h, --help help for delete-user-a-p-i-key + -h, --help help for delete-user-api-key --id string API Key UUID (required) --request string JSON payload for request body fields ``` diff --git a/docs/equinix_metalv1_authentication_find-a-p-i-keys.md b/docs/equinix_metalv1_authentication_find-api-keys.md similarity index 83% rename from docs/equinix_metalv1_authentication_find-a-p-i-keys.md rename to docs/equinix_metalv1_authentication_find-api-keys.md index 8a5b2b0..2f12705 100644 --- a/docs/equinix_metalv1_authentication_find-a-p-i-keys.md +++ b/docs/equinix_metalv1_authentication_find-api-keys.md @@ -1,4 +1,4 @@ -## equinix metalv1 authentication find-a-p-i-keys +## equinix metalv1 authentication find-api-keys Retrieve all user API keys @@ -9,13 +9,13 @@ Returns all API keys for the current user. Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 authentication find-a-p-i-keys [flags] +equinix metalv1 authentication find-api-keys [flags] ``` ### Options ``` - -h, --help help for find-a-p-i-keys + -h, --help help for find-api-keys --include string include field (JSON or string) --request string JSON payload for additional optional fields not exposed as flags --search string search field diff --git a/docs/equinix_metalv1_authentication_find-project-a-p-i-keys.md b/docs/equinix_metalv1_authentication_find-project-api-keys.md similarity index 81% rename from docs/equinix_metalv1_authentication_find-project-a-p-i-keys.md rename to docs/equinix_metalv1_authentication_find-project-api-keys.md index fdcb589..e41ad2f 100644 --- a/docs/equinix_metalv1_authentication_find-project-a-p-i-keys.md +++ b/docs/equinix_metalv1_authentication_find-project-api-keys.md @@ -1,4 +1,4 @@ -## equinix metalv1 authentication find-project-a-p-i-keys +## equinix metalv1 authentication find-project-api-keys Retrieve all API keys for the project. @@ -9,13 +9,13 @@ Returns all API keys for a specific project. Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 authentication find-project-a-p-i-keys [flags] +equinix metalv1 authentication find-project-api-keys [flags] ``` ### Options ``` - -h, --help help for find-project-a-p-i-keys + -h, --help help for find-project-api-keys --id string Project UUID (required) --include string include field (JSON or string) --request string JSON payload for additional optional fields not exposed as flags diff --git a/docs/equinix_metalv1_b-g-p.md b/docs/equinix_metalv1_b-g-p.md deleted file mode 100644 index a412aed..0000000 --- a/docs/equinix_metalv1_b-g-p.md +++ /dev/null @@ -1,33 +0,0 @@ -## equinix metalv1 b-g-p - -Manage b-g-p resources - -### Synopsis - -Commands for managing b-g-p resources in the API - -### Options - -``` - -h, --help help for b-g-p -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1](equinix_metalv1.md) - Manage Equinix metalv1 resources -* [equinix metalv1 b-g-p delete-bgp-session](equinix_metalv1_b-g-p_delete-bgp-session.md) - Execute delete-bgp-session operation -* [equinix metalv1 b-g-p find-bgp-config-by-project](equinix_metalv1_b-g-p_find-bgp-config-by-project.md) - Execute find-bgp-config-by-project operation -* [equinix metalv1 b-g-p find-bgp-session-by-id](equinix_metalv1_b-g-p_find-bgp-session-by-id.md) - Execute find-bgp-session-by-id operation -* [equinix metalv1 b-g-p find-global-bgp-ranges](equinix_metalv1_b-g-p_find-global-bgp-ranges.md) - Execute find-global-bgp-ranges operation -* [equinix metalv1 b-g-p find-project-bgp-sessions](equinix_metalv1_b-g-p_find-project-bgp-sessions.md) - Execute find-project-bgp-sessions operation -* [equinix metalv1 b-g-p request-bgp-config](equinix_metalv1_b-g-p_request-bgp-config.md) - Execute request-bgp-config operation -* [equinix metalv1 b-g-p update-bgp-session](equinix_metalv1_b-g-p_update-bgp-session.md) - Execute update-bgp-session operation - diff --git a/docs/equinix_metalv1_b-g-p_delete-bgp-session.md b/docs/equinix_metalv1_b-g-p_delete-bgp-session.md deleted file mode 100644 index 1d83e14..0000000 --- a/docs/equinix_metalv1_b-g-p_delete-bgp-session.md +++ /dev/null @@ -1,37 +0,0 @@ -## equinix metalv1 b-g-p delete-bgp-session - -Execute delete-bgp-session operation - -### Synopsis - -Execute the delete-bgp-session operation on this service. - -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. - -``` -equinix metalv1 b-g-p delete-bgp-session [flags] -``` - -### Options - -``` - -h, --help help for delete-bgp-session - --param-1 string param-1 (required) - --request string JSON payload for request body fields -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 b-g-p](equinix_metalv1_b-g-p.md) - Manage b-g-p resources - diff --git a/docs/equinix_metalv1_b-g-p_find-global-bgp-ranges.md b/docs/equinix_metalv1_b-g-p_find-global-bgp-ranges.md deleted file mode 100644 index fa0c729..0000000 --- a/docs/equinix_metalv1_b-g-p_find-global-bgp-ranges.md +++ /dev/null @@ -1,37 +0,0 @@ -## equinix metalv1 b-g-p find-global-bgp-ranges - -Execute find-global-bgp-ranges operation - -### Synopsis - -Execute the find-global-bgp-ranges operation on this service. - -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. - -``` -equinix metalv1 b-g-p find-global-bgp-ranges [flags] -``` - -### Options - -``` - -h, --help help for find-global-bgp-ranges - --param-1 string param-1 (required) - --request string JSON payload for request body fields -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 b-g-p](equinix_metalv1_b-g-p.md) - Manage b-g-p resources - diff --git a/docs/equinix_metalv1_b-g-p_find-project-bgp-sessions.md b/docs/equinix_metalv1_b-g-p_find-project-bgp-sessions.md deleted file mode 100644 index feeb958..0000000 --- a/docs/equinix_metalv1_b-g-p_find-project-bgp-sessions.md +++ /dev/null @@ -1,37 +0,0 @@ -## equinix metalv1 b-g-p find-project-bgp-sessions - -Execute find-project-bgp-sessions operation - -### Synopsis - -Execute the find-project-bgp-sessions operation on this service. - -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. - -``` -equinix metalv1 b-g-p find-project-bgp-sessions [flags] -``` - -### Options - -``` - -h, --help help for find-project-bgp-sessions - --param-1 string param-1 (required) - --request string JSON payload for request body fields -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 b-g-p](equinix_metalv1_b-g-p.md) - Manage b-g-p resources - diff --git a/docs/equinix_metalv1_bgp.md b/docs/equinix_metalv1_bgp.md new file mode 100644 index 0000000..8ca63cd --- /dev/null +++ b/docs/equinix_metalv1_bgp.md @@ -0,0 +1,33 @@ +## equinix metalv1 bgp + +Manage bgp resources + +### Synopsis + +Commands for managing bgp resources in the API + +### Options + +``` + -h, --help help for bgp +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1](equinix_metalv1.md) - Manage Equinix metalv1 resources +* [equinix metalv1 bgp delete-bgp-session](equinix_metalv1_bgp_delete-bgp-session.md) - Delete the BGP session +* [equinix metalv1 bgp find-bgp-config-by-project](equinix_metalv1_bgp_find-bgp-config-by-project.md) - Retrieve a bgp config +* [equinix metalv1 bgp find-bgp-session-by-id](equinix_metalv1_bgp_find-bgp-session-by-id.md) - Retrieve a BGP session +* [equinix metalv1 bgp find-global-bgp-ranges](equinix_metalv1_bgp_find-global-bgp-ranges.md) - Retrieve all global bgp ranges +* [equinix metalv1 bgp find-project-bgp-sessions](equinix_metalv1_bgp_find-project-bgp-sessions.md) - Retrieve all BGP sessions for project +* [equinix metalv1 bgp request-bgp-config](equinix_metalv1_bgp_request-bgp-config.md) - Requesting bgp config +* [equinix metalv1 bgp update-bgp-session](equinix_metalv1_bgp_update-bgp-session.md) - Update the BGP session + diff --git a/docs/equinix_metalv1_bgp_delete-bgp-session.md b/docs/equinix_metalv1_bgp_delete-bgp-session.md new file mode 100644 index 0000000..f97be23 --- /dev/null +++ b/docs/equinix_metalv1_bgp_delete-bgp-session.md @@ -0,0 +1,34 @@ +## equinix metalv1 bgp delete-bgp-session + +Delete the BGP session + +### Synopsis + +Deletes the BGP session. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 bgp delete-bgp-session [flags] +``` + +### Options + +``` + -h, --help help for delete-bgp-session + --id string BGP session UUID (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 bgp](equinix_metalv1_bgp.md) - Manage bgp resources + diff --git a/docs/equinix_metalv1_b-g-p_find-bgp-config-by-project.md b/docs/equinix_metalv1_bgp_find-bgp-config-by-project.md similarity index 51% rename from docs/equinix_metalv1_b-g-p_find-bgp-config-by-project.md rename to docs/equinix_metalv1_bgp_find-bgp-config-by-project.md index 7e0cb35..5a2b674 100644 --- a/docs/equinix_metalv1_b-g-p_find-bgp-config-by-project.md +++ b/docs/equinix_metalv1_bgp_find-bgp-config-by-project.md @@ -1,26 +1,23 @@ -## equinix metalv1 b-g-p find-bgp-config-by-project +## equinix metalv1 bgp find-bgp-config-by-project -Execute find-bgp-config-by-project operation +Retrieve a bgp config ### Synopsis -Execute the find-bgp-config-by-project operation on this service. +Returns a bgp config -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. +Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 b-g-p find-bgp-config-by-project [flags] +equinix metalv1 bgp find-bgp-config-by-project [flags] ``` ### Options ``` -h, --help help for find-bgp-config-by-project + --id string Project UUID (required) --include string include field (JSON or string) - --param-1 string param-1 (required) --request string JSON payload for additional optional fields not exposed as flags ``` @@ -34,5 +31,5 @@ equinix metalv1 b-g-p find-bgp-config-by-project [flags] ### SEE ALSO -* [equinix metalv1 b-g-p](equinix_metalv1_b-g-p.md) - Manage b-g-p resources +* [equinix metalv1 bgp](equinix_metalv1_bgp.md) - Manage bgp resources diff --git a/docs/equinix_metalv1_b-g-p_find-bgp-session-by-id.md b/docs/equinix_metalv1_bgp_find-bgp-session-by-id.md similarity index 52% rename from docs/equinix_metalv1_b-g-p_find-bgp-session-by-id.md rename to docs/equinix_metalv1_bgp_find-bgp-session-by-id.md index 60024de..929a5ec 100644 --- a/docs/equinix_metalv1_b-g-p_find-bgp-session-by-id.md +++ b/docs/equinix_metalv1_bgp_find-bgp-session-by-id.md @@ -1,25 +1,22 @@ -## equinix metalv1 b-g-p find-bgp-session-by-id +## equinix metalv1 bgp find-bgp-session-by-id -Execute find-bgp-session-by-id operation +Retrieve a BGP session ### Synopsis -Execute the find-bgp-session-by-id operation on this service. +Returns a BGP session -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. +Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 b-g-p find-bgp-session-by-id [flags] +equinix metalv1 bgp find-bgp-session-by-id [flags] ``` ### Options ``` -h, --help help for find-bgp-session-by-id - --id string id (required) + --id string BGP session UUID (required) --include string include field (JSON or string) --request string JSON payload for additional optional fields not exposed as flags ``` @@ -34,5 +31,5 @@ equinix metalv1 b-g-p find-bgp-session-by-id [flags] ### SEE ALSO -* [equinix metalv1 b-g-p](equinix_metalv1_b-g-p.md) - Manage b-g-p resources +* [equinix metalv1 bgp](equinix_metalv1_bgp.md) - Manage bgp resources diff --git a/docs/equinix_metalv1_bgp_find-global-bgp-ranges.md b/docs/equinix_metalv1_bgp_find-global-bgp-ranges.md new file mode 100644 index 0000000..0ebedb6 --- /dev/null +++ b/docs/equinix_metalv1_bgp_find-global-bgp-ranges.md @@ -0,0 +1,34 @@ +## equinix metalv1 bgp find-global-bgp-ranges + +Retrieve all global bgp ranges + +### Synopsis + +Returns all global bgp ranges for a project + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 bgp find-global-bgp-ranges [flags] +``` + +### Options + +``` + -h, --help help for find-global-bgp-ranges + --id string Project UUID (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 bgp](equinix_metalv1_bgp.md) - Manage bgp resources + diff --git a/docs/equinix_metalv1_bgp_find-project-bgp-sessions.md b/docs/equinix_metalv1_bgp_find-project-bgp-sessions.md new file mode 100644 index 0000000..b6db218 --- /dev/null +++ b/docs/equinix_metalv1_bgp_find-project-bgp-sessions.md @@ -0,0 +1,34 @@ +## equinix metalv1 bgp find-project-bgp-sessions + +Retrieve all BGP sessions for project + +### Synopsis + +Provides a listing of available BGP sessions for the project. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 bgp find-project-bgp-sessions [flags] +``` + +### Options + +``` + -h, --help help for find-project-bgp-sessions + --id string Project UUID (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 bgp](equinix_metalv1_bgp.md) - Manage bgp resources + diff --git a/docs/equinix_metalv1_b-g-p_request-bgp-config.md b/docs/equinix_metalv1_bgp_request-bgp-config.md similarity index 73% rename from docs/equinix_metalv1_b-g-p_request-bgp-config.md rename to docs/equinix_metalv1_bgp_request-bgp-config.md index 27b898e..b72e8a6 100644 --- a/docs/equinix_metalv1_b-g-p_request-bgp-config.md +++ b/docs/equinix_metalv1_bgp_request-bgp-config.md @@ -1,18 +1,15 @@ -## equinix metalv1 b-g-p request-bgp-config +## equinix metalv1 bgp request-bgp-config -Execute request-bgp-config operation +Requesting bgp config ### Synopsis -Execute the request-bgp-config operation on this service. +Requests to enable bgp configuration for a project. -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. +Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 b-g-p request-bgp-config [flags] +equinix metalv1 bgp request-bgp-config [flags] ``` ### Options @@ -24,8 +21,8 @@ equinix metalv1 b-g-p request-bgp-config [flags] --bgp-config-request-input-md5 string The plaintext password to share between BGP neighbors as an MD5 checksum: * must be 10-20 characters long * may not include punctuation * must be a combination of numbers and letters * must contain at least one lowercase, uppercase, and digit character --bgp-config-request-input-use_case string A use case explanation (necessary for global BGP request review). -h, --help help for request-bgp-config + --id string Project UUID (required) --include string include field (JSON or string) - --param-1 string param-1 (required) --request string JSON payload for additional optional fields not exposed as flags ``` @@ -39,5 +36,5 @@ equinix metalv1 b-g-p request-bgp-config [flags] ### SEE ALSO -* [equinix metalv1 b-g-p](equinix_metalv1_b-g-p.md) - Manage b-g-p resources +* [equinix metalv1 bgp](equinix_metalv1_bgp.md) - Manage bgp resources diff --git a/docs/equinix_metalv1_b-g-p_update-bgp-session.md b/docs/equinix_metalv1_bgp_update-bgp-session.md similarity index 52% rename from docs/equinix_metalv1_b-g-p_update-bgp-session.md rename to docs/equinix_metalv1_bgp_update-bgp-session.md index 22b51f1..c8836bd 100644 --- a/docs/equinix_metalv1_b-g-p_update-bgp-session.md +++ b/docs/equinix_metalv1_bgp_update-bgp-session.md @@ -1,18 +1,15 @@ -## equinix metalv1 b-g-p update-bgp-session +## equinix metalv1 bgp update-bgp-session -Execute update-bgp-session operation +Update the BGP session ### Synopsis -Execute the update-bgp-session operation on this service. +Updates the BGP session by either enabling or disabling the default route functionality. -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. +Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 b-g-p update-bgp-session [flags] +equinix metalv1 bgp update-bgp-session [flags] ``` ### Options @@ -20,7 +17,7 @@ equinix metalv1 b-g-p update-bgp-session [flags] ``` --body body field -h, --help help for update-bgp-session - --param-1 string param-1 (required) + --id string BGP session UUID (required) --request string JSON payload for additional optional fields not exposed as flags ``` @@ -34,5 +31,5 @@ equinix metalv1 b-g-p update-bgp-session [flags] ### SEE ALSO -* [equinix metalv1 b-g-p](equinix_metalv1_b-g-p.md) - Manage b-g-p resources +* [equinix metalv1 bgp](equinix_metalv1_bgp.md) - Manage bgp resources diff --git a/docs/equinix_metalv1_devices.md b/docs/equinix_metalv1_devices.md index d243f17..789c669 100644 --- a/docs/equinix_metalv1_devices.md +++ b/docs/equinix_metalv1_devices.md @@ -25,16 +25,16 @@ Commands for managing devices resources in the API * [equinix metalv1](equinix_metalv1.md) - Manage Equinix metalv1 resources * [equinix metalv1 devices create-bgp-session](equinix_metalv1_devices_create-bgp-session.md) - Create a BGP session * [equinix metalv1 devices create-device](equinix_metalv1_devices_create-device.md) - Create a device -* [equinix metalv1 devices create-i-p-assignment](equinix_metalv1_devices_create-i-p-assignment.md) - Create an ip assignment +* [equinix metalv1 devices create-ip-assignment](equinix_metalv1_devices_create-ip-assignment.md) - Create an ip assignment * [equinix metalv1 devices delete-device](equinix_metalv1_devices_delete-device.md) - Delete the device * [equinix metalv1 devices find-bgp-sessions](equinix_metalv1_devices_find-bgp-sessions.md) - Retrieve all BGP sessions * [equinix metalv1 devices find-device-by-id](equinix_metalv1_devices_find-device-by-id.md) - Retrieve a device * [equinix metalv1 devices find-device-customdata](equinix_metalv1_devices_find-device-customdata.md) - Retrieve the custom metadata of an instance -* [equinix metalv1 devices find-device-metadata-by-i-d](equinix_metalv1_devices_find-device-metadata-by-i-d.md) - Retrieve metadata -* [equinix metalv1 devices find-device-userdata-by-i-d](equinix_metalv1_devices_find-device-userdata-by-i-d.md) - Retrieve userdata -* [equinix metalv1 devices find-i-p-assignment-customdata](equinix_metalv1_devices_find-i-p-assignment-customdata.md) - Retrieve the custom metadata of an IP Assignment -* [equinix metalv1 devices find-i-p-assignments](equinix_metalv1_devices_find-i-p-assignments.md) - Retrieve all ip assignments +* [equinix metalv1 devices find-device-metadata-by-id](equinix_metalv1_devices_find-device-metadata-by-id.md) - Retrieve metadata +* [equinix metalv1 devices find-device-userdata-by-id](equinix_metalv1_devices_find-device-userdata-by-id.md) - Retrieve userdata * [equinix metalv1 devices find-instance-bandwidth](equinix_metalv1_devices_find-instance-bandwidth.md) - Retrieve an instance bandwidth +* [equinix metalv1 devices find-ip-assignment-customdata](equinix_metalv1_devices_find-ip-assignment-customdata.md) - Retrieve the custom metadata of an IP Assignment +* [equinix metalv1 devices find-ip-assignments](equinix_metalv1_devices_find-ip-assignments.md) - Retrieve all ip assignments * [equinix metalv1 devices find-organization-devices](equinix_metalv1_devices_find-organization-devices.md) - Retrieve all devices of an organization * [equinix metalv1 devices find-project-devices](equinix_metalv1_devices_find-project-devices.md) - Retrieve all devices of a project * [equinix metalv1 devices find-traffic](equinix_metalv1_devices_find-traffic.md) - Retrieve device traffic diff --git a/docs/equinix_metalv1_devices_create-bgp-session.md b/docs/equinix_metalv1_devices_create-bgp-session.md index 627161e..4977dd5 100644 --- a/docs/equinix_metalv1_devices_create-bgp-session.md +++ b/docs/equinix_metalv1_devices_create-bgp-session.md @@ -15,13 +15,13 @@ equinix metalv1 devices create-bgp-session [flags] ### Options ``` - --b-g-p-session-input-additional-properties string b-g-p-session-input-additional-properties (JSON) - --b-g-p-session-input-address_family string b-g-p-session-input-address_family - --b-g-p-session-input-default_route Set the default route policy. - -h, --help help for create-bgp-session - --id string Device UUID (required) - --include string include field (JSON or string) - --request string JSON payload for additional optional fields not exposed as flags + --bgp-session-input-additional-properties string bgp-session-input-additional-properties (JSON) + --bgp-session-input-address_family string bgp-session-input-address_family + --bgp-session-input-default_route Set the default route policy. + -h, --help help for create-bgp-session + --id string Device UUID (required) + --include string include field (JSON or string) + --request string JSON payload for additional optional fields not exposed as flags ``` ### Options inherited from parent commands diff --git a/docs/equinix_metalv1_devices_create-i-p-assignment.md b/docs/equinix_metalv1_devices_create-i-p-assignment.md deleted file mode 100644 index 08c3108..0000000 --- a/docs/equinix_metalv1_devices_create-i-p-assignment.md +++ /dev/null @@ -1,39 +0,0 @@ -## equinix metalv1 devices create-i-p-assignment - -Create an ip assignment - -### Synopsis - -Creates an ip assignment for a device. - -Use --request flag to provide optional JSON payload fields. - -``` -equinix metalv1 devices create-i-p-assignment [flags] -``` - -### Options - -``` - --exclude string exclude field (JSON or string) - -h, --help help for create-i-p-assignment - --i-p-assignment-input-additional-properties string i-p-assignment-input-additional-properties (JSON) - --i-p-assignment-input-address string i-p-assignment-input-address - --i-p-assignment-input-customdata string i-p-assignment-input-customdata (JSON) - --id string Device UUID (required) - --include string include field (JSON or string) - --request string JSON payload for additional optional fields not exposed as flags -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 devices](equinix_metalv1_devices.md) - Manage devices resources - diff --git a/docs/equinix_metalv1_devices_create-ip-assignment.md b/docs/equinix_metalv1_devices_create-ip-assignment.md new file mode 100644 index 0000000..509b7b9 --- /dev/null +++ b/docs/equinix_metalv1_devices_create-ip-assignment.md @@ -0,0 +1,39 @@ +## equinix metalv1 devices create-ip-assignment + +Create an ip assignment + +### Synopsis + +Creates an ip assignment for a device. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 devices create-ip-assignment [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for create-ip-assignment + --id string Device UUID (required) + --include string include field (JSON or string) + --ip-assignment-input-additional-properties string ip-assignment-input-additional-properties (JSON) + --ip-assignment-input-address string ip-assignment-input-address + --ip-assignment-input-customdata string ip-assignment-input-customdata (JSON) + --request string JSON payload for additional optional fields not exposed as flags +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 devices](equinix_metalv1_devices.md) - Manage devices resources + diff --git a/docs/equinix_metalv1_devices_find-device-metadata-by-i-d.md b/docs/equinix_metalv1_devices_find-device-metadata-by-id.md similarity index 78% rename from docs/equinix_metalv1_devices_find-device-metadata-by-i-d.md rename to docs/equinix_metalv1_devices_find-device-metadata-by-id.md index ffec732..7a2259e 100644 --- a/docs/equinix_metalv1_devices_find-device-metadata-by-i-d.md +++ b/docs/equinix_metalv1_devices_find-device-metadata-by-id.md @@ -1,4 +1,4 @@ -## equinix metalv1 devices find-device-metadata-by-i-d +## equinix metalv1 devices find-device-metadata-by-id Retrieve metadata @@ -9,13 +9,13 @@ Retrieve device metadata Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 devices find-device-metadata-by-i-d [flags] +equinix metalv1 devices find-device-metadata-by-id [flags] ``` ### Options ``` - -h, --help help for find-device-metadata-by-i-d + -h, --help help for find-device-metadata-by-id --id string Device UUID (required) --request string JSON payload for request body fields ``` diff --git a/docs/equinix_metalv1_devices_find-device-userdata-by-i-d.md b/docs/equinix_metalv1_devices_find-device-userdata-by-id.md similarity index 78% rename from docs/equinix_metalv1_devices_find-device-userdata-by-i-d.md rename to docs/equinix_metalv1_devices_find-device-userdata-by-id.md index 48c1281..b7237d3 100644 --- a/docs/equinix_metalv1_devices_find-device-userdata-by-i-d.md +++ b/docs/equinix_metalv1_devices_find-device-userdata-by-id.md @@ -1,4 +1,4 @@ -## equinix metalv1 devices find-device-userdata-by-i-d +## equinix metalv1 devices find-device-userdata-by-id Retrieve userdata @@ -9,13 +9,13 @@ Retrieve device userdata Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 devices find-device-userdata-by-i-d [flags] +equinix metalv1 devices find-device-userdata-by-id [flags] ``` ### Options ``` - -h, --help help for find-device-userdata-by-i-d + -h, --help help for find-device-userdata-by-id --id string Device UUID (required) --request string JSON payload for request body fields ``` diff --git a/docs/equinix_metalv1_devices_find-i-p-assignment-customdata.md b/docs/equinix_metalv1_devices_find-ip-assignment-customdata.md similarity index 80% rename from docs/equinix_metalv1_devices_find-i-p-assignment-customdata.md rename to docs/equinix_metalv1_devices_find-ip-assignment-customdata.md index b03467f..cd5f935 100644 --- a/docs/equinix_metalv1_devices_find-i-p-assignment-customdata.md +++ b/docs/equinix_metalv1_devices_find-ip-assignment-customdata.md @@ -1,4 +1,4 @@ -## equinix metalv1 devices find-i-p-assignment-customdata +## equinix metalv1 devices find-ip-assignment-customdata Retrieve the custom metadata of an IP Assignment @@ -9,13 +9,13 @@ Provides the custom metadata stored for this IP Assignment in json format Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 devices find-i-p-assignment-customdata [flags] +equinix metalv1 devices find-ip-assignment-customdata [flags] ``` ### Options ``` - -h, --help help for find-i-p-assignment-customdata + -h, --help help for find-ip-assignment-customdata --id string Ip Assignment UUID (required) --instance-id string Instance UUID (required) --request string JSON payload for request body fields diff --git a/docs/equinix_metalv1_devices_find-i-p-assignments.md b/docs/equinix_metalv1_devices_find-ip-assignments.md similarity index 83% rename from docs/equinix_metalv1_devices_find-i-p-assignments.md rename to docs/equinix_metalv1_devices_find-ip-assignments.md index 3286559..5f32132 100644 --- a/docs/equinix_metalv1_devices_find-i-p-assignments.md +++ b/docs/equinix_metalv1_devices_find-ip-assignments.md @@ -1,4 +1,4 @@ -## equinix metalv1 devices find-i-p-assignments +## equinix metalv1 devices find-ip-assignments Retrieve all ip assignments @@ -9,14 +9,14 @@ Returns all ip assignments for a device. Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 devices find-i-p-assignments [flags] +equinix metalv1 devices find-ip-assignments [flags] ``` ### Options ``` --exclude string exclude field (JSON or string) - -h, --help help for find-i-p-assignments + -h, --help help for find-ip-assignments --id string Device UUID (required) --include string include field (JSON or string) --request string JSON payload for additional optional fields not exposed as flags diff --git a/docs/equinix_metalv1_devices_find-organization-devices.md b/docs/equinix_metalv1_devices_find-organization-devices.md index ee8c5d8..c6eb9b4 100644 --- a/docs/equinix_metalv1_devices_find-organization-devices.md +++ b/docs/equinix_metalv1_devices_find-organization-devices.md @@ -30,7 +30,7 @@ equinix metalv1 devices find-organization-devices [flags] --reserved reserved field --search string search field --tag string tag field - --type_ string type_ field + --type-_ string type-_ field ``` ### Options inherited from parent commands diff --git a/docs/equinix_metalv1_devices_find-project-devices.md b/docs/equinix_metalv1_devices_find-project-devices.md index 06df6da..ac06771 100644 --- a/docs/equinix_metalv1_devices_find-project-devices.md +++ b/docs/equinix_metalv1_devices_find-project-devices.md @@ -31,7 +31,7 @@ equinix metalv1 devices find-project-devices [flags] --reserved reserved field --search string search field --tag string tag field - --type_ string type_ field + --type-_ string type-_ field ``` ### Options inherited from parent commands diff --git a/docs/equinix_metalv1_i-p-addresses.md b/docs/equinix_metalv1_i-p-addresses.md deleted file mode 100644 index ca38594..0000000 --- a/docs/equinix_metalv1_i-p-addresses.md +++ /dev/null @@ -1,33 +0,0 @@ -## equinix metalv1 i-p-addresses - -Manage i-p-addresses resources - -### Synopsis - -Commands for managing i-p-addresses resources in the API - -### Options - -``` - -h, --help help for i-p-addresses -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1](equinix_metalv1.md) - Manage Equinix metalv1 resources -* [equinix metalv1 i-p-addresses delete-i-p-address](equinix_metalv1_i-p-addresses_delete-i-p-address.md) - Execute delete-i-p-address operation -* [equinix metalv1 i-p-addresses find-i-p-address-by-id](equinix_metalv1_i-p-addresses_find-i-p-address-by-id.md) - Execute find-i-p-address-by-id operation -* [equinix metalv1 i-p-addresses find-i-p-address-customdata](equinix_metalv1_i-p-addresses_find-i-p-address-customdata.md) - Execute find-i-p-address-customdata operation -* [equinix metalv1 i-p-addresses find-i-p-availabilities](equinix_metalv1_i-p-addresses_find-i-p-availabilities.md) - Execute find-i-p-availabilities operation -* [equinix metalv1 i-p-addresses find-i-p-reservations](equinix_metalv1_i-p-addresses_find-i-p-reservations.md) - Execute find-i-p-reservations operation -* [equinix metalv1 i-p-addresses request-i-p-reservation](equinix_metalv1_i-p-addresses_request-i-p-reservation.md) - Execute request-i-p-reservation operation -* [equinix metalv1 i-p-addresses update-i-p-address](equinix_metalv1_i-p-addresses_update-i-p-address.md) - Execute update-i-p-address operation - diff --git a/docs/equinix_metalv1_i-p-addresses_delete-i-p-address.md b/docs/equinix_metalv1_i-p-addresses_delete-i-p-address.md deleted file mode 100644 index 3c16fb2..0000000 --- a/docs/equinix_metalv1_i-p-addresses_delete-i-p-address.md +++ /dev/null @@ -1,37 +0,0 @@ -## equinix metalv1 i-p-addresses delete-i-p-address - -Execute delete-i-p-address operation - -### Synopsis - -Execute the delete-i-p-address operation on this service. - -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. - -``` -equinix metalv1 i-p-addresses delete-i-p-address [flags] -``` - -### Options - -``` - -h, --help help for delete-i-p-address - --param-1 string param-1 (required) - --request string JSON payload for request body fields -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 i-p-addresses](equinix_metalv1_i-p-addresses.md) - Manage i-p-addresses resources - diff --git a/docs/equinix_metalv1_i-p-addresses_find-i-p-address-by-id.md b/docs/equinix_metalv1_i-p-addresses_find-i-p-address-by-id.md deleted file mode 100644 index 47c0d26..0000000 --- a/docs/equinix_metalv1_i-p-addresses_find-i-p-address-by-id.md +++ /dev/null @@ -1,39 +0,0 @@ -## equinix metalv1 i-p-addresses find-i-p-address-by-id - -Execute find-i-p-address-by-id operation - -### Synopsis - -Execute the find-i-p-address-by-id operation on this service. - -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. - -``` -equinix metalv1 i-p-addresses find-i-p-address-by-id [flags] -``` - -### Options - -``` - --exclude string exclude field (JSON or string) - -h, --help help for find-i-p-address-by-id - --id string id (required) - --include string include field (JSON or string) - --request string JSON payload for additional optional fields not exposed as flags -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 i-p-addresses](equinix_metalv1_i-p-addresses.md) - Manage i-p-addresses resources - diff --git a/docs/equinix_metalv1_i-p-addresses_find-i-p-address-customdata.md b/docs/equinix_metalv1_i-p-addresses_find-i-p-address-customdata.md deleted file mode 100644 index 432eff3..0000000 --- a/docs/equinix_metalv1_i-p-addresses_find-i-p-address-customdata.md +++ /dev/null @@ -1,37 +0,0 @@ -## equinix metalv1 i-p-addresses find-i-p-address-customdata - -Execute find-i-p-address-customdata operation - -### Synopsis - -Execute the find-i-p-address-customdata operation on this service. - -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. - -``` -equinix metalv1 i-p-addresses find-i-p-address-customdata [flags] -``` - -### Options - -``` - -h, --help help for find-i-p-address-customdata - --param-1 string param-1 (required) - --request string JSON payload for request body fields -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 i-p-addresses](equinix_metalv1_i-p-addresses.md) - Manage i-p-addresses resources - diff --git a/docs/equinix_metalv1_i-p-addresses_find-i-p-availabilities.md b/docs/equinix_metalv1_i-p-addresses_find-i-p-availabilities.md deleted file mode 100644 index 620fac6..0000000 --- a/docs/equinix_metalv1_i-p-addresses_find-i-p-availabilities.md +++ /dev/null @@ -1,38 +0,0 @@ -## equinix metalv1 i-p-addresses find-i-p-availabilities - -Execute find-i-p-availabilities operation - -### Synopsis - -Execute the find-i-p-availabilities operation on this service. - -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. - -``` -equinix metalv1 i-p-addresses find-i-p-availabilities [flags] -``` - -### Options - -``` - --cidr string cidr field - -h, --help help for find-i-p-availabilities - --param-1 string param-1 (required) - --request string JSON payload for additional optional fields not exposed as flags -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 i-p-addresses](equinix_metalv1_i-p-addresses.md) - Manage i-p-addresses resources - diff --git a/docs/equinix_metalv1_i-p-addresses_request-i-p-reservation.md b/docs/equinix_metalv1_i-p-addresses_request-i-p-reservation.md deleted file mode 100644 index 6d48a0c..0000000 --- a/docs/equinix_metalv1_i-p-addresses_request-i-p-reservation.md +++ /dev/null @@ -1,57 +0,0 @@ -## equinix metalv1 i-p-addresses request-i-p-reservation - -Execute request-i-p-reservation operation - -### Synopsis - -Execute the request-i-p-reservation operation on this service. - -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. - -``` -equinix metalv1 i-p-addresses request-i-p-reservation [flags] -``` - -### Options - -``` - --exclude string exclude field (JSON or string) - -h, --help help for request-i-p-reservation - --include string include field (JSON or string) - --param-1 string param-1 (required) - --request string JSON payload for additional optional fields not exposed as flags - --request-i-p-reservation-request-i-p-reservation-request-input-additional-properties string request-i-p-reservation-request-i-p-reservation-request-input-additional-properties (JSON) - --request-i-p-reservation-request-i-p-reservation-request-input-comments string request-i-p-reservation-request-i-p-reservation-request-input-comments - --request-i-p-reservation-request-i-p-reservation-request-input-customdata string request-i-p-reservation-request-i-p-reservation-request-input-customdata (JSON) - --request-i-p-reservation-request-i-p-reservation-request-input-details string request-i-p-reservation-request-i-p-reservation-request-input-details - --request-i-p-reservation-request-i-p-reservation-request-input-facility string request-i-p-reservation-request-i-p-reservation-request-input-facility - --request-i-p-reservation-request-i-p-reservation-request-input-fail_on_approval_required request-i-p-reservation-request-i-p-reservation-request-input-fail_on_approval_required - --request-i-p-reservation-request-i-p-reservation-request-input-metro string The code of the metro you are requesting the IP reservation in. - --request-i-p-reservation-request-i-p-reservation-request-input-quantity int request-i-p-reservation-request-i-p-reservation-request-input-quantity - --request-i-p-reservation-request-i-p-reservation-request-input-tags string request-i-p-reservation-request-i-p-reservation-request-input-tags (JSON array) - --request-i-p-reservation-request-i-p-reservation-request-input-type string request-i-p-reservation-request-i-p-reservation-request-input-type - --request-i-p-reservation-request-vrf-ip-reservation-create-input-additional-properties string request-i-p-reservation-request-vrf-ip-reservation-create-input-additional-properties (JSON) - --request-i-p-reservation-request-vrf-ip-reservation-create-input-cidr int The size of the VRF IP Reservation's subnet. The following subnet sizes are supported: - IPv4: between 22 - 29 inclusive - IPv6: exactly 64 - --request-i-p-reservation-request-vrf-ip-reservation-create-input-customdata string request-i-p-reservation-request-vrf-ip-reservation-create-input-customdata (JSON) - --request-i-p-reservation-request-vrf-ip-reservation-create-input-details string request-i-p-reservation-request-vrf-ip-reservation-create-input-details - --request-i-p-reservation-request-vrf-ip-reservation-create-input-network string The starting address for this VRF IP Reservation's subnet. Both IPv4 and IPv6 are supported. - --request-i-p-reservation-request-vrf-ip-reservation-create-input-tags string request-i-p-reservation-request-vrf-ip-reservation-create-input-tags (JSON array) - --request-i-p-reservation-request-vrf-ip-reservation-create-input-type string Must be set to 'vrf' - --request-i-p-reservation-request-vrf-ip-reservation-create-input-vrf_id string The ID of the VRF in which this VRF IP Reservation is created. The VRF must have an existing IP Range that contains the requested subnet. This field may be aliased as just 'vrf'. -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 i-p-addresses](equinix_metalv1_i-p-addresses.md) - Manage i-p-addresses resources - diff --git a/docs/equinix_metalv1_i-p-addresses_update-i-p-address.md b/docs/equinix_metalv1_i-p-addresses_update-i-p-address.md deleted file mode 100644 index d22f0af..0000000 --- a/docs/equinix_metalv1_i-p-addresses_update-i-p-address.md +++ /dev/null @@ -1,43 +0,0 @@ -## equinix metalv1 i-p-addresses update-i-p-address - -Execute update-i-p-address operation - -### Synopsis - -Execute the update-i-p-address operation on this service. - -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. - -``` -equinix metalv1 i-p-addresses update-i-p-address [flags] -``` - -### Options - -``` - --exclude string exclude field (JSON or string) - -h, --help help for update-i-p-address - --i-p-assignment-update-input-additional-properties string i-p-assignment-update-input-additional-properties (JSON) - --i-p-assignment-update-input-customdata string i-p-assignment-update-input-customdata (JSON) - --i-p-assignment-update-input-details string i-p-assignment-update-input-details - --i-p-assignment-update-input-tags string i-p-assignment-update-input-tags (JSON array) - --include string include field (JSON or string) - --param-1 string param-1 (required) - --request string JSON payload for additional optional fields not exposed as flags -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 i-p-addresses](equinix_metalv1_i-p-addresses.md) - Manage i-p-addresses resources - diff --git a/docs/equinix_metalv1_interconnections_create-organization-interconnection.md b/docs/equinix_metalv1_interconnections_create-organization-interconnection.md index 8d5ef92..f35e751 100644 --- a/docs/equinix_metalv1_interconnections_create-organization-interconnection.md +++ b/docs/equinix_metalv1_interconnections_create-organization-interconnection.md @@ -15,72 +15,72 @@ equinix metalv1 interconnections create-organization-interconnection [flags] ### Options ``` - --create-organization-interconnection-request-dedicated-port-create-input-additional-properties string create-organization-interconnection-request-dedicated-port-create-input-additional-properties (JSON) - --create-organization-interconnection-request-dedicated-port-create-input-billing_account_name string The billing account name of the Equinix Fabric account. - --create-organization-interconnection-request-dedicated-port-create-input-contact_email string The preferred email used for communication and notifications about the Equinix Fabric interconnection. Optional and defaults to the primary user email address when using a User API key or the organization owner email address when using a Project API key. - --create-organization-interconnection-request-dedicated-port-create-input-description string create-organization-interconnection-request-dedicated-port-create-input-description - --create-organization-interconnection-request-dedicated-port-create-input-facility_id string create-organization-interconnection-request-dedicated-port-create-input-facility_id - --create-organization-interconnection-request-dedicated-port-create-input-metro string A Metro ID or code. For interconnections with Dedicated Ports, this will be the location of the issued Dedicated Ports. - --create-organization-interconnection-request-dedicated-port-create-input-mode string create-organization-interconnection-request-dedicated-port-create-input-mode - --create-organization-interconnection-request-dedicated-port-create-input-name string create-organization-interconnection-request-dedicated-port-create-input-name - --create-organization-interconnection-request-dedicated-port-create-input-project string create-organization-interconnection-request-dedicated-port-create-input-project - --create-organization-interconnection-request-dedicated-port-create-input-redundancy string Either 'primary' or 'redundant'. - --create-organization-interconnection-request-dedicated-port-create-input-speed string A interconnection speed, in bps, mbps, or gbps. For Dedicated Ports, this can be 10Gbps or 100Gbps. - --create-organization-interconnection-request-dedicated-port-create-input-tags string create-organization-interconnection-request-dedicated-port-create-input-tags (JSON array) - --create-organization-interconnection-request-dedicated-port-create-input-type string create-organization-interconnection-request-dedicated-port-create-input-type - --create-organization-interconnection-request-dedicated-port-create-input-use_case string The intended use case of the dedicated port. - --create-organization-interconnection-request-shared-port-v-c-vlan-create-input-additional-properties string create-organization-interconnection-request-shared-port-v-c-vlan-create-input-additional-properties (JSON) - --create-organization-interconnection-request-shared-port-v-c-vlan-create-input-contact_email string The preferred email used for communication and notifications about the Equinix Fabric interconnection. Optional and defaults to the primary user email address when using a User API key or the organization owner email address when using a Project API key. - --create-organization-interconnection-request-shared-port-v-c-vlan-create-input-description string create-organization-interconnection-request-shared-port-v-c-vlan-create-input-description - --create-organization-interconnection-request-shared-port-v-c-vlan-create-input-metro string A Metro ID or code. When creating Fabric VCs (Metal Billed), this is where interconnection will be originating from, as we pre-authorize the use of one of our shared ports as the origin of the interconnection using A-Side service tokens. We only allow local connections for Fabric VCs (Metal Billed), so the destination location must be the same as the origin. For Fabric VCs (Fabric Billed), or shared connections, this will be the destination of the interconnection. We allow remote connections for Fabric VCs (Fabric Billed), so the origin of the interconnection can be a different metro set here. - --create-organization-interconnection-request-shared-port-v-c-vlan-create-input-name string create-organization-interconnection-request-shared-port-v-c-vlan-create-input-name - --create-organization-interconnection-request-shared-port-v-c-vlan-create-input-project string create-organization-interconnection-request-shared-port-v-c-vlan-create-input-project - --create-organization-interconnection-request-shared-port-v-c-vlan-create-input-speed string A interconnection speed, in bps, mbps, or gbps. For Fabric VCs, this represents the maximum speed of the interconnection. For Fabric VCs (Metal Billed), this can only be one of the following: ''50mbps'', ''200mbps'', ''500mbps'', ''1gbps'', ''2gbps'', ''5gbps'' or ''10gbps'', and is required for creation. For Fabric VCs (Fabric Billed), this field will always default to ''10gbps'' even if it is not provided. For example, ''500000000'', ''50m'', or' ''500mbps'' will all work as valid inputs. - --create-organization-interconnection-request-shared-port-v-c-vlan-create-input-tags string create-organization-interconnection-request-shared-port-v-c-vlan-create-input-tags (JSON array) - --create-organization-interconnection-request-shared-port-v-c-vlan-create-input-type string create-organization-interconnection-request-shared-port-v-c-vlan-create-input-type - --create-organization-interconnection-request-shared-port-v-c-vlan-create-input-vlans string A list of one or two metro-based VLANs that will be set on the virtual circuits of primary and/or secondary interconnections respectively when creating Fabric VCs. VLANs can also be set after the interconnection is created, but are required to fully activate the virtual circuits. (JSON array) - --create-organization-interconnection-request-vlan-c-s-p-connection-create-input-additional-properties string create-organization-interconnection-request-vlan-c-s-p-connection-create-input-additional-properties (JSON) - --create-organization-interconnection-request-vlan-c-s-p-connection-create-input-contact_email string The preferred email used for communication and notifications about the Equinix Fabric interconnection. Optional and defaults to the primary user email address when using a User API key or the organization owner email address when using a Project API key. - --create-organization-interconnection-request-vlan-c-s-p-connection-create-input-description string create-organization-interconnection-request-vlan-c-s-p-connection-create-input-description - --create-organization-interconnection-request-vlan-c-s-p-connection-create-input-fabric_provider string create-organization-interconnection-request-vlan-c-s-p-connection-create-input-fabric_provider (JSON) - --create-organization-interconnection-request-vlan-c-s-p-connection-create-input-metro string A Metro ID or code. When creating Fabric VCs (Metal Billed), this is where interconnection will be originating from, as we pre-authorize the use of one of our shared ports as the origin of the interconnection using A-Side service tokens. We only allow local connections for Fabric VCs (Metal Billed), so the destination location must be the same as the origin. For Fabric VCs (Fabric Billed), or shared connections, this will be the destination of the interconnection. We allow remote connections for Fabric VCs (Fabric Billed), so the origin of the interconnection can be a different metro set here. - --create-organization-interconnection-request-vlan-c-s-p-connection-create-input-name string create-organization-interconnection-request-vlan-c-s-p-connection-create-input-name - --create-organization-interconnection-request-vlan-c-s-p-connection-create-input-project string create-organization-interconnection-request-vlan-c-s-p-connection-create-input-project - --create-organization-interconnection-request-vlan-c-s-p-connection-create-input-speed string A interconnection speed, in bps, mbps, or gbps. For Fabric VCs, this represents the maximum speed of the interconnection. For Fabric VCs (Metal Billed), this can only be one of the following: ''50mbps'', ''200mbps'', ''500mbps'', ''1gbps'', ''2gbps'', ''5gbps'' or ''10gbps'', and is required for creation. For Fabric VCs (Fabric Billed), this field will always default to ''10gbps'' even if it is not provided. For example, ''500000000'', ''50m'', or' ''500mbps'' will all work as valid inputs. - --create-organization-interconnection-request-vlan-c-s-p-connection-create-input-tags string create-organization-interconnection-request-vlan-c-s-p-connection-create-input-tags (JSON array) - --create-organization-interconnection-request-vlan-c-s-p-connection-create-input-type string create-organization-interconnection-request-vlan-c-s-p-connection-create-input-type - --create-organization-interconnection-request-vlan-c-s-p-connection-create-input-vlans string A list of one or two metro-based VLANs that will be set on the virtual circuits of primary and/or secondary interconnections respectively when creating Fabric VCs. VLANs can also be set after the interconnection is created, but are required to fully activate the virtual circuits. (JSON array) - --create-organization-interconnection-request-vlan-fabric-vc-create-input-additional-properties string create-organization-interconnection-request-vlan-fabric-vc-create-input-additional-properties (JSON) - --create-organization-interconnection-request-vlan-fabric-vc-create-input-contact_email string The preferred email used for communication and notifications about the Equinix Fabric interconnection. Optional and defaults to the primary user email address when using a User API key or the organization owner email address when using a Project API key. - --create-organization-interconnection-request-vlan-fabric-vc-create-input-description string create-organization-interconnection-request-vlan-fabric-vc-create-input-description - --create-organization-interconnection-request-vlan-fabric-vc-create-input-facility_id string create-organization-interconnection-request-vlan-fabric-vc-create-input-facility_id - --create-organization-interconnection-request-vlan-fabric-vc-create-input-metro string A Metro ID or code. When creating Fabric VCs (Metal Billed), this is where interconnection will be originating from, as we pre-authorize the use of one of our shared ports as the origin of the interconnection using A-Side service tokens. We only allow local connections for Fabric VCs (Metal Billed), so the destination location must be the same as the origin. For Fabric VCs (Fabric Billed), or shared connections, this will be the destination of the interconnection. We allow remote connections for Fabric VCs (Fabric Billed), so the origin of the interconnection can be a different metro set here. - --create-organization-interconnection-request-vlan-fabric-vc-create-input-name string create-organization-interconnection-request-vlan-fabric-vc-create-input-name - --create-organization-interconnection-request-vlan-fabric-vc-create-input-project string create-organization-interconnection-request-vlan-fabric-vc-create-input-project - --create-organization-interconnection-request-vlan-fabric-vc-create-input-redundancy string Either 'primary' or 'redundant'. - --create-organization-interconnection-request-vlan-fabric-vc-create-input-service_token_type string create-organization-interconnection-request-vlan-fabric-vc-create-input-service_token_type - --create-organization-interconnection-request-vlan-fabric-vc-create-input-speed string A interconnection speed, in bps, mbps, or gbps. For Fabric VCs, this represents the maximum speed of the interconnection. For Fabric VCs (Metal Billed), this can only be one of the following: ''50mbps'', ''200mbps'', ''500mbps'', ''1gbps'', ''2gbps'', ''5gbps'' or ''10gbps'', and is required for creation. For Fabric VCs (Fabric Billed), this field will always default to ''10gbps'' even if it is not provided. For example, ''500000000'', ''50m'', or' ''500mbps'' will all work as valid inputs. - --create-organization-interconnection-request-vlan-fabric-vc-create-input-tags string create-organization-interconnection-request-vlan-fabric-vc-create-input-tags (JSON array) - --create-organization-interconnection-request-vlan-fabric-vc-create-input-type string create-organization-interconnection-request-vlan-fabric-vc-create-input-type - --create-organization-interconnection-request-vlan-fabric-vc-create-input-vlans string A list of one or two metro-based VLANs that will be set on the virtual circuits of primary and/or secondary (if redundant) interconnections respectively when creating Fabric VCs. VLANs can also be set after the interconnection is created, but are required to fully activate the virtual circuits. (JSON array) - --create-organization-interconnection-request-vrf-fabric-vc-create-input-additional-properties string create-organization-interconnection-request-vrf-fabric-vc-create-input-additional-properties (JSON) - --create-organization-interconnection-request-vrf-fabric-vc-create-input-contact_email string The preferred email used for communication and notifications about the Equinix Fabric interconnection. Optional and defaults to the primary user email address when using a User API key or the organization owner email address when using a Project API key. - --create-organization-interconnection-request-vrf-fabric-vc-create-input-description string create-organization-interconnection-request-vrf-fabric-vc-create-input-description - --create-organization-interconnection-request-vrf-fabric-vc-create-input-facility_id string create-organization-interconnection-request-vrf-fabric-vc-create-input-facility_id - --create-organization-interconnection-request-vrf-fabric-vc-create-input-metro string A Metro ID or code. When creating Fabric VCs (Metal Billed), this is where interconnection will be originating from, as we pre-authorize the use of one of our shared ports as the origin of the interconnection using A-Side service tokens. We only allow local connections for Fabric VCs (Metal Billed), so the destination location must be the same as the origin. For Fabric VCs (Fabric Billed), or shared connections, this will be the destination of the interconnection. We allow remote connections for Fabric VCs (Fabric Billed), so the origin of the interconnection can be a different metro set here. - --create-organization-interconnection-request-vrf-fabric-vc-create-input-name string create-organization-interconnection-request-vrf-fabric-vc-create-input-name - --create-organization-interconnection-request-vrf-fabric-vc-create-input-project string create-organization-interconnection-request-vrf-fabric-vc-create-input-project - --create-organization-interconnection-request-vrf-fabric-vc-create-input-redundancy string Either 'primary' or 'redundant'. - --create-organization-interconnection-request-vrf-fabric-vc-create-input-service_token_type string create-organization-interconnection-request-vrf-fabric-vc-create-input-service_token_type - --create-organization-interconnection-request-vrf-fabric-vc-create-input-speed string A interconnection speed, in bps, mbps, or gbps. For Fabric VCs, this represents the maximum speed of the interconnection. For Fabric VCs (Metal Billed), this can only be one of the following: ''50mbps'', ''200mbps'', ''500mbps'', ''1gbps'', ''2gbps'', ''5gbps'' or ''10gbps'', and is required for creation. For Fabric VCs (Fabric Billed), this field will always default to ''10gbps'' even if it is not provided. For example, ''500000000'', ''50m'', or' ''500mbps'' will all work as valid inputs. - --create-organization-interconnection-request-vrf-fabric-vc-create-input-tags string create-organization-interconnection-request-vrf-fabric-vc-create-input-tags (JSON array) - --create-organization-interconnection-request-vrf-fabric-vc-create-input-type string create-organization-interconnection-request-vrf-fabric-vc-create-input-type - --create-organization-interconnection-request-vrf-fabric-vc-create-input-vrfs string This field holds a list of VRF UUIDs that will be set automatically on the virtual circuits of Fabric VCs on creation, and can hold up to two UUIDs. Two UUIDs are required when requesting redundant Fabric VCs. The first UUID will be set on the primary virtual circuit, while the second UUID will be set on the secondary. The two UUIDs can be the same if both the primary and secondary virtual circuits will be in the same VRF. This parameter is included in the specification as a developer preview and is generally unavailable. Please contact our Support team for more details. (JSON array) - --exclude string exclude field (JSON or string) - -h, --help help for create-organization-interconnection - --include string include field (JSON or string) - --organization-id string UUID of the organization (required) - --request string JSON payload for additional optional fields not exposed as flags + --create-organization-interconnection-request-dedicated-port-create-input-additional-properties string create-organization-interconnection-request-dedicated-port-create-input-additional-properties (JSON) + --create-organization-interconnection-request-dedicated-port-create-input-billing_account_name string The billing account name of the Equinix Fabric account. + --create-organization-interconnection-request-dedicated-port-create-input-contact_email string The preferred email used for communication and notifications about the Equinix Fabric interconnection. Optional and defaults to the primary user email address when using a User API key or the organization owner email address when using a Project API key. + --create-organization-interconnection-request-dedicated-port-create-input-description string create-organization-interconnection-request-dedicated-port-create-input-description + --create-organization-interconnection-request-dedicated-port-create-input-facility_id string create-organization-interconnection-request-dedicated-port-create-input-facility_id + --create-organization-interconnection-request-dedicated-port-create-input-metro string A Metro ID or code. For interconnections with Dedicated Ports, this will be the location of the issued Dedicated Ports. + --create-organization-interconnection-request-dedicated-port-create-input-mode string create-organization-interconnection-request-dedicated-port-create-input-mode + --create-organization-interconnection-request-dedicated-port-create-input-name string create-organization-interconnection-request-dedicated-port-create-input-name + --create-organization-interconnection-request-dedicated-port-create-input-project string create-organization-interconnection-request-dedicated-port-create-input-project + --create-organization-interconnection-request-dedicated-port-create-input-redundancy string Either 'primary' or 'redundant'. + --create-organization-interconnection-request-dedicated-port-create-input-speed string A interconnection speed, in bps, mbps, or gbps. For Dedicated Ports, this can be 10Gbps or 100Gbps. + --create-organization-interconnection-request-dedicated-port-create-input-tags string create-organization-interconnection-request-dedicated-port-create-input-tags (JSON array) + --create-organization-interconnection-request-dedicated-port-create-input-type string create-organization-interconnection-request-dedicated-port-create-input-type + --create-organization-interconnection-request-dedicated-port-create-input-use_case string The intended use case of the dedicated port. + --create-organization-interconnection-request-shared-port-vc-vlan-create-input-additional-properties string create-organization-interconnection-request-shared-port-vc-vlan-create-input-additional-properties (JSON) + --create-organization-interconnection-request-shared-port-vc-vlan-create-input-contact_email string The preferred email used for communication and notifications about the Equinix Fabric interconnection. Optional and defaults to the primary user email address when using a User API key or the organization owner email address when using a Project API key. + --create-organization-interconnection-request-shared-port-vc-vlan-create-input-description string create-organization-interconnection-request-shared-port-vc-vlan-create-input-description + --create-organization-interconnection-request-shared-port-vc-vlan-create-input-metro string A Metro ID or code. When creating Fabric VCs (Metal Billed), this is where interconnection will be originating from, as we pre-authorize the use of one of our shared ports as the origin of the interconnection using A-Side service tokens. We only allow local connections for Fabric VCs (Metal Billed), so the destination location must be the same as the origin. For Fabric VCs (Fabric Billed), or shared connections, this will be the destination of the interconnection. We allow remote connections for Fabric VCs (Fabric Billed), so the origin of the interconnection can be a different metro set here. + --create-organization-interconnection-request-shared-port-vc-vlan-create-input-name string create-organization-interconnection-request-shared-port-vc-vlan-create-input-name + --create-organization-interconnection-request-shared-port-vc-vlan-create-input-project string create-organization-interconnection-request-shared-port-vc-vlan-create-input-project + --create-organization-interconnection-request-shared-port-vc-vlan-create-input-speed string A interconnection speed, in bps, mbps, or gbps. For Fabric VCs, this represents the maximum speed of the interconnection. For Fabric VCs (Metal Billed), this can only be one of the following: ''50mbps'', ''200mbps'', ''500mbps'', ''1gbps'', ''2gbps'', ''5gbps'' or ''10gbps'', and is required for creation. For Fabric VCs (Fabric Billed), this field will always default to ''10gbps'' even if it is not provided. For example, ''500000000'', ''50m'', or' ''500mbps'' will all work as valid inputs. + --create-organization-interconnection-request-shared-port-vc-vlan-create-input-tags string create-organization-interconnection-request-shared-port-vc-vlan-create-input-tags (JSON array) + --create-organization-interconnection-request-shared-port-vc-vlan-create-input-type string create-organization-interconnection-request-shared-port-vc-vlan-create-input-type + --create-organization-interconnection-request-shared-port-vc-vlan-create-input-vlans string A list of one or two metro-based VLANs that will be set on the virtual circuits of primary and/or secondary interconnections respectively when creating Fabric VCs. VLANs can also be set after the interconnection is created, but are required to fully activate the virtual circuits. (JSON array) + --create-organization-interconnection-request-vlan-csp-connection-create-input-additional-properties string create-organization-interconnection-request-vlan-csp-connection-create-input-additional-properties (JSON) + --create-organization-interconnection-request-vlan-csp-connection-create-input-contact_email string The preferred email used for communication and notifications about the Equinix Fabric interconnection. Optional and defaults to the primary user email address when using a User API key or the organization owner email address when using a Project API key. + --create-organization-interconnection-request-vlan-csp-connection-create-input-description string create-organization-interconnection-request-vlan-csp-connection-create-input-description + --create-organization-interconnection-request-vlan-csp-connection-create-input-fabric_provider string create-organization-interconnection-request-vlan-csp-connection-create-input-fabric_provider (JSON) + --create-organization-interconnection-request-vlan-csp-connection-create-input-metro string A Metro ID or code. When creating Fabric VCs (Metal Billed), this is where interconnection will be originating from, as we pre-authorize the use of one of our shared ports as the origin of the interconnection using A-Side service tokens. We only allow local connections for Fabric VCs (Metal Billed), so the destination location must be the same as the origin. For Fabric VCs (Fabric Billed), or shared connections, this will be the destination of the interconnection. We allow remote connections for Fabric VCs (Fabric Billed), so the origin of the interconnection can be a different metro set here. + --create-organization-interconnection-request-vlan-csp-connection-create-input-name string create-organization-interconnection-request-vlan-csp-connection-create-input-name + --create-organization-interconnection-request-vlan-csp-connection-create-input-project string create-organization-interconnection-request-vlan-csp-connection-create-input-project + --create-organization-interconnection-request-vlan-csp-connection-create-input-speed string A interconnection speed, in bps, mbps, or gbps. For Fabric VCs, this represents the maximum speed of the interconnection. For Fabric VCs (Metal Billed), this can only be one of the following: ''50mbps'', ''200mbps'', ''500mbps'', ''1gbps'', ''2gbps'', ''5gbps'' or ''10gbps'', and is required for creation. For Fabric VCs (Fabric Billed), this field will always default to ''10gbps'' even if it is not provided. For example, ''500000000'', ''50m'', or' ''500mbps'' will all work as valid inputs. + --create-organization-interconnection-request-vlan-csp-connection-create-input-tags string create-organization-interconnection-request-vlan-csp-connection-create-input-tags (JSON array) + --create-organization-interconnection-request-vlan-csp-connection-create-input-type string create-organization-interconnection-request-vlan-csp-connection-create-input-type + --create-organization-interconnection-request-vlan-csp-connection-create-input-vlans string A list of one or two metro-based VLANs that will be set on the virtual circuits of primary and/or secondary interconnections respectively when creating Fabric VCs. VLANs can also be set after the interconnection is created, but are required to fully activate the virtual circuits. (JSON array) + --create-organization-interconnection-request-vlan-fabric-vc-create-input-additional-properties string create-organization-interconnection-request-vlan-fabric-vc-create-input-additional-properties (JSON) + --create-organization-interconnection-request-vlan-fabric-vc-create-input-contact_email string The preferred email used for communication and notifications about the Equinix Fabric interconnection. Optional and defaults to the primary user email address when using a User API key or the organization owner email address when using a Project API key. + --create-organization-interconnection-request-vlan-fabric-vc-create-input-description string create-organization-interconnection-request-vlan-fabric-vc-create-input-description + --create-organization-interconnection-request-vlan-fabric-vc-create-input-facility_id string create-organization-interconnection-request-vlan-fabric-vc-create-input-facility_id + --create-organization-interconnection-request-vlan-fabric-vc-create-input-metro string A Metro ID or code. When creating Fabric VCs (Metal Billed), this is where interconnection will be originating from, as we pre-authorize the use of one of our shared ports as the origin of the interconnection using A-Side service tokens. We only allow local connections for Fabric VCs (Metal Billed), so the destination location must be the same as the origin. For Fabric VCs (Fabric Billed), or shared connections, this will be the destination of the interconnection. We allow remote connections for Fabric VCs (Fabric Billed), so the origin of the interconnection can be a different metro set here. + --create-organization-interconnection-request-vlan-fabric-vc-create-input-name string create-organization-interconnection-request-vlan-fabric-vc-create-input-name + --create-organization-interconnection-request-vlan-fabric-vc-create-input-project string create-organization-interconnection-request-vlan-fabric-vc-create-input-project + --create-organization-interconnection-request-vlan-fabric-vc-create-input-redundancy string Either 'primary' or 'redundant'. + --create-organization-interconnection-request-vlan-fabric-vc-create-input-service_token_type string create-organization-interconnection-request-vlan-fabric-vc-create-input-service_token_type + --create-organization-interconnection-request-vlan-fabric-vc-create-input-speed string A interconnection speed, in bps, mbps, or gbps. For Fabric VCs, this represents the maximum speed of the interconnection. For Fabric VCs (Metal Billed), this can only be one of the following: ''50mbps'', ''200mbps'', ''500mbps'', ''1gbps'', ''2gbps'', ''5gbps'' or ''10gbps'', and is required for creation. For Fabric VCs (Fabric Billed), this field will always default to ''10gbps'' even if it is not provided. For example, ''500000000'', ''50m'', or' ''500mbps'' will all work as valid inputs. + --create-organization-interconnection-request-vlan-fabric-vc-create-input-tags string create-organization-interconnection-request-vlan-fabric-vc-create-input-tags (JSON array) + --create-organization-interconnection-request-vlan-fabric-vc-create-input-type string create-organization-interconnection-request-vlan-fabric-vc-create-input-type + --create-organization-interconnection-request-vlan-fabric-vc-create-input-vlans string A list of one or two metro-based VLANs that will be set on the virtual circuits of primary and/or secondary (if redundant) interconnections respectively when creating Fabric VCs. VLANs can also be set after the interconnection is created, but are required to fully activate the virtual circuits. (JSON array) + --create-organization-interconnection-request-vrf-fabric-vc-create-input-additional-properties string create-organization-interconnection-request-vrf-fabric-vc-create-input-additional-properties (JSON) + --create-organization-interconnection-request-vrf-fabric-vc-create-input-contact_email string The preferred email used for communication and notifications about the Equinix Fabric interconnection. Optional and defaults to the primary user email address when using a User API key or the organization owner email address when using a Project API key. + --create-organization-interconnection-request-vrf-fabric-vc-create-input-description string create-organization-interconnection-request-vrf-fabric-vc-create-input-description + --create-organization-interconnection-request-vrf-fabric-vc-create-input-facility_id string create-organization-interconnection-request-vrf-fabric-vc-create-input-facility_id + --create-organization-interconnection-request-vrf-fabric-vc-create-input-metro string A Metro ID or code. When creating Fabric VCs (Metal Billed), this is where interconnection will be originating from, as we pre-authorize the use of one of our shared ports as the origin of the interconnection using A-Side service tokens. We only allow local connections for Fabric VCs (Metal Billed), so the destination location must be the same as the origin. For Fabric VCs (Fabric Billed), or shared connections, this will be the destination of the interconnection. We allow remote connections for Fabric VCs (Fabric Billed), so the origin of the interconnection can be a different metro set here. + --create-organization-interconnection-request-vrf-fabric-vc-create-input-name string create-organization-interconnection-request-vrf-fabric-vc-create-input-name + --create-organization-interconnection-request-vrf-fabric-vc-create-input-project string create-organization-interconnection-request-vrf-fabric-vc-create-input-project + --create-organization-interconnection-request-vrf-fabric-vc-create-input-redundancy string Either 'primary' or 'redundant'. + --create-organization-interconnection-request-vrf-fabric-vc-create-input-service_token_type string create-organization-interconnection-request-vrf-fabric-vc-create-input-service_token_type + --create-organization-interconnection-request-vrf-fabric-vc-create-input-speed string A interconnection speed, in bps, mbps, or gbps. For Fabric VCs, this represents the maximum speed of the interconnection. For Fabric VCs (Metal Billed), this can only be one of the following: ''50mbps'', ''200mbps'', ''500mbps'', ''1gbps'', ''2gbps'', ''5gbps'' or ''10gbps'', and is required for creation. For Fabric VCs (Fabric Billed), this field will always default to ''10gbps'' even if it is not provided. For example, ''500000000'', ''50m'', or' ''500mbps'' will all work as valid inputs. + --create-organization-interconnection-request-vrf-fabric-vc-create-input-tags string create-organization-interconnection-request-vrf-fabric-vc-create-input-tags (JSON array) + --create-organization-interconnection-request-vrf-fabric-vc-create-input-type string create-organization-interconnection-request-vrf-fabric-vc-create-input-type + --create-organization-interconnection-request-vrf-fabric-vc-create-input-vrfs string This field holds a list of VRF UUIDs that will be set automatically on the virtual circuits of Fabric VCs on creation, and can hold up to two UUIDs. Two UUIDs are required when requesting redundant Fabric VCs. The first UUID will be set on the primary virtual circuit, while the second UUID will be set on the secondary. The two UUIDs can be the same if both the primary and secondary virtual circuits will be in the same VRF. This parameter is included in the specification as a developer preview and is generally unavailable. Please contact our Support team for more details. (JSON array) + --exclude string exclude field (JSON or string) + -h, --help help for create-organization-interconnection + --include string include field (JSON or string) + --organization-id string UUID of the organization (required) + --request string JSON payload for additional optional fields not exposed as flags ``` ### Options inherited from parent commands diff --git a/docs/equinix_metalv1_interconnections_create-project-interconnection.md b/docs/equinix_metalv1_interconnections_create-project-interconnection.md index 91ca47b..82db22d 100644 --- a/docs/equinix_metalv1_interconnections_create-project-interconnection.md +++ b/docs/equinix_metalv1_interconnections_create-project-interconnection.md @@ -15,72 +15,72 @@ equinix metalv1 interconnections create-project-interconnection [flags] ### Options ``` - --create-organization-interconnection-request-dedicated-port-create-input-additional-properties string create-organization-interconnection-request-dedicated-port-create-input-additional-properties (JSON) - --create-organization-interconnection-request-dedicated-port-create-input-billing_account_name string The billing account name of the Equinix Fabric account. - --create-organization-interconnection-request-dedicated-port-create-input-contact_email string The preferred email used for communication and notifications about the Equinix Fabric interconnection. Optional and defaults to the primary user email address when using a User API key or the organization owner email address when using a Project API key. - --create-organization-interconnection-request-dedicated-port-create-input-description string create-organization-interconnection-request-dedicated-port-create-input-description - --create-organization-interconnection-request-dedicated-port-create-input-facility_id string create-organization-interconnection-request-dedicated-port-create-input-facility_id - --create-organization-interconnection-request-dedicated-port-create-input-metro string A Metro ID or code. For interconnections with Dedicated Ports, this will be the location of the issued Dedicated Ports. - --create-organization-interconnection-request-dedicated-port-create-input-mode string create-organization-interconnection-request-dedicated-port-create-input-mode - --create-organization-interconnection-request-dedicated-port-create-input-name string create-organization-interconnection-request-dedicated-port-create-input-name - --create-organization-interconnection-request-dedicated-port-create-input-project string create-organization-interconnection-request-dedicated-port-create-input-project - --create-organization-interconnection-request-dedicated-port-create-input-redundancy string Either 'primary' or 'redundant'. - --create-organization-interconnection-request-dedicated-port-create-input-speed string A interconnection speed, in bps, mbps, or gbps. For Dedicated Ports, this can be 10Gbps or 100Gbps. - --create-organization-interconnection-request-dedicated-port-create-input-tags string create-organization-interconnection-request-dedicated-port-create-input-tags (JSON array) - --create-organization-interconnection-request-dedicated-port-create-input-type string create-organization-interconnection-request-dedicated-port-create-input-type - --create-organization-interconnection-request-dedicated-port-create-input-use_case string The intended use case of the dedicated port. - --create-organization-interconnection-request-shared-port-v-c-vlan-create-input-additional-properties string create-organization-interconnection-request-shared-port-v-c-vlan-create-input-additional-properties (JSON) - --create-organization-interconnection-request-shared-port-v-c-vlan-create-input-contact_email string The preferred email used for communication and notifications about the Equinix Fabric interconnection. Optional and defaults to the primary user email address when using a User API key or the organization owner email address when using a Project API key. - --create-organization-interconnection-request-shared-port-v-c-vlan-create-input-description string create-organization-interconnection-request-shared-port-v-c-vlan-create-input-description - --create-organization-interconnection-request-shared-port-v-c-vlan-create-input-metro string A Metro ID or code. When creating Fabric VCs (Metal Billed), this is where interconnection will be originating from, as we pre-authorize the use of one of our shared ports as the origin of the interconnection using A-Side service tokens. We only allow local connections for Fabric VCs (Metal Billed), so the destination location must be the same as the origin. For Fabric VCs (Fabric Billed), or shared connections, this will be the destination of the interconnection. We allow remote connections for Fabric VCs (Fabric Billed), so the origin of the interconnection can be a different metro set here. - --create-organization-interconnection-request-shared-port-v-c-vlan-create-input-name string create-organization-interconnection-request-shared-port-v-c-vlan-create-input-name - --create-organization-interconnection-request-shared-port-v-c-vlan-create-input-project string create-organization-interconnection-request-shared-port-v-c-vlan-create-input-project - --create-organization-interconnection-request-shared-port-v-c-vlan-create-input-speed string A interconnection speed, in bps, mbps, or gbps. For Fabric VCs, this represents the maximum speed of the interconnection. For Fabric VCs (Metal Billed), this can only be one of the following: ''50mbps'', ''200mbps'', ''500mbps'', ''1gbps'', ''2gbps'', ''5gbps'' or ''10gbps'', and is required for creation. For Fabric VCs (Fabric Billed), this field will always default to ''10gbps'' even if it is not provided. For example, ''500000000'', ''50m'', or' ''500mbps'' will all work as valid inputs. - --create-organization-interconnection-request-shared-port-v-c-vlan-create-input-tags string create-organization-interconnection-request-shared-port-v-c-vlan-create-input-tags (JSON array) - --create-organization-interconnection-request-shared-port-v-c-vlan-create-input-type string create-organization-interconnection-request-shared-port-v-c-vlan-create-input-type - --create-organization-interconnection-request-shared-port-v-c-vlan-create-input-vlans string A list of one or two metro-based VLANs that will be set on the virtual circuits of primary and/or secondary interconnections respectively when creating Fabric VCs. VLANs can also be set after the interconnection is created, but are required to fully activate the virtual circuits. (JSON array) - --create-organization-interconnection-request-vlan-c-s-p-connection-create-input-additional-properties string create-organization-interconnection-request-vlan-c-s-p-connection-create-input-additional-properties (JSON) - --create-organization-interconnection-request-vlan-c-s-p-connection-create-input-contact_email string The preferred email used for communication and notifications about the Equinix Fabric interconnection. Optional and defaults to the primary user email address when using a User API key or the organization owner email address when using a Project API key. - --create-organization-interconnection-request-vlan-c-s-p-connection-create-input-description string create-organization-interconnection-request-vlan-c-s-p-connection-create-input-description - --create-organization-interconnection-request-vlan-c-s-p-connection-create-input-fabric_provider string create-organization-interconnection-request-vlan-c-s-p-connection-create-input-fabric_provider (JSON) - --create-organization-interconnection-request-vlan-c-s-p-connection-create-input-metro string A Metro ID or code. When creating Fabric VCs (Metal Billed), this is where interconnection will be originating from, as we pre-authorize the use of one of our shared ports as the origin of the interconnection using A-Side service tokens. We only allow local connections for Fabric VCs (Metal Billed), so the destination location must be the same as the origin. For Fabric VCs (Fabric Billed), or shared connections, this will be the destination of the interconnection. We allow remote connections for Fabric VCs (Fabric Billed), so the origin of the interconnection can be a different metro set here. - --create-organization-interconnection-request-vlan-c-s-p-connection-create-input-name string create-organization-interconnection-request-vlan-c-s-p-connection-create-input-name - --create-organization-interconnection-request-vlan-c-s-p-connection-create-input-project string create-organization-interconnection-request-vlan-c-s-p-connection-create-input-project - --create-organization-interconnection-request-vlan-c-s-p-connection-create-input-speed string A interconnection speed, in bps, mbps, or gbps. For Fabric VCs, this represents the maximum speed of the interconnection. For Fabric VCs (Metal Billed), this can only be one of the following: ''50mbps'', ''200mbps'', ''500mbps'', ''1gbps'', ''2gbps'', ''5gbps'' or ''10gbps'', and is required for creation. For Fabric VCs (Fabric Billed), this field will always default to ''10gbps'' even if it is not provided. For example, ''500000000'', ''50m'', or' ''500mbps'' will all work as valid inputs. - --create-organization-interconnection-request-vlan-c-s-p-connection-create-input-tags string create-organization-interconnection-request-vlan-c-s-p-connection-create-input-tags (JSON array) - --create-organization-interconnection-request-vlan-c-s-p-connection-create-input-type string create-organization-interconnection-request-vlan-c-s-p-connection-create-input-type - --create-organization-interconnection-request-vlan-c-s-p-connection-create-input-vlans string A list of one or two metro-based VLANs that will be set on the virtual circuits of primary and/or secondary interconnections respectively when creating Fabric VCs. VLANs can also be set after the interconnection is created, but are required to fully activate the virtual circuits. (JSON array) - --create-organization-interconnection-request-vlan-fabric-vc-create-input-additional-properties string create-organization-interconnection-request-vlan-fabric-vc-create-input-additional-properties (JSON) - --create-organization-interconnection-request-vlan-fabric-vc-create-input-contact_email string The preferred email used for communication and notifications about the Equinix Fabric interconnection. Optional and defaults to the primary user email address when using a User API key or the organization owner email address when using a Project API key. - --create-organization-interconnection-request-vlan-fabric-vc-create-input-description string create-organization-interconnection-request-vlan-fabric-vc-create-input-description - --create-organization-interconnection-request-vlan-fabric-vc-create-input-facility_id string create-organization-interconnection-request-vlan-fabric-vc-create-input-facility_id - --create-organization-interconnection-request-vlan-fabric-vc-create-input-metro string A Metro ID or code. When creating Fabric VCs (Metal Billed), this is where interconnection will be originating from, as we pre-authorize the use of one of our shared ports as the origin of the interconnection using A-Side service tokens. We only allow local connections for Fabric VCs (Metal Billed), so the destination location must be the same as the origin. For Fabric VCs (Fabric Billed), or shared connections, this will be the destination of the interconnection. We allow remote connections for Fabric VCs (Fabric Billed), so the origin of the interconnection can be a different metro set here. - --create-organization-interconnection-request-vlan-fabric-vc-create-input-name string create-organization-interconnection-request-vlan-fabric-vc-create-input-name - --create-organization-interconnection-request-vlan-fabric-vc-create-input-project string create-organization-interconnection-request-vlan-fabric-vc-create-input-project - --create-organization-interconnection-request-vlan-fabric-vc-create-input-redundancy string Either 'primary' or 'redundant'. - --create-organization-interconnection-request-vlan-fabric-vc-create-input-service_token_type string create-organization-interconnection-request-vlan-fabric-vc-create-input-service_token_type - --create-organization-interconnection-request-vlan-fabric-vc-create-input-speed string A interconnection speed, in bps, mbps, or gbps. For Fabric VCs, this represents the maximum speed of the interconnection. For Fabric VCs (Metal Billed), this can only be one of the following: ''50mbps'', ''200mbps'', ''500mbps'', ''1gbps'', ''2gbps'', ''5gbps'' or ''10gbps'', and is required for creation. For Fabric VCs (Fabric Billed), this field will always default to ''10gbps'' even if it is not provided. For example, ''500000000'', ''50m'', or' ''500mbps'' will all work as valid inputs. - --create-organization-interconnection-request-vlan-fabric-vc-create-input-tags string create-organization-interconnection-request-vlan-fabric-vc-create-input-tags (JSON array) - --create-organization-interconnection-request-vlan-fabric-vc-create-input-type string create-organization-interconnection-request-vlan-fabric-vc-create-input-type - --create-organization-interconnection-request-vlan-fabric-vc-create-input-vlans string A list of one or two metro-based VLANs that will be set on the virtual circuits of primary and/or secondary (if redundant) interconnections respectively when creating Fabric VCs. VLANs can also be set after the interconnection is created, but are required to fully activate the virtual circuits. (JSON array) - --create-organization-interconnection-request-vrf-fabric-vc-create-input-additional-properties string create-organization-interconnection-request-vrf-fabric-vc-create-input-additional-properties (JSON) - --create-organization-interconnection-request-vrf-fabric-vc-create-input-contact_email string The preferred email used for communication and notifications about the Equinix Fabric interconnection. Optional and defaults to the primary user email address when using a User API key or the organization owner email address when using a Project API key. - --create-organization-interconnection-request-vrf-fabric-vc-create-input-description string create-organization-interconnection-request-vrf-fabric-vc-create-input-description - --create-organization-interconnection-request-vrf-fabric-vc-create-input-facility_id string create-organization-interconnection-request-vrf-fabric-vc-create-input-facility_id - --create-organization-interconnection-request-vrf-fabric-vc-create-input-metro string A Metro ID or code. When creating Fabric VCs (Metal Billed), this is where interconnection will be originating from, as we pre-authorize the use of one of our shared ports as the origin of the interconnection using A-Side service tokens. We only allow local connections for Fabric VCs (Metal Billed), so the destination location must be the same as the origin. For Fabric VCs (Fabric Billed), or shared connections, this will be the destination of the interconnection. We allow remote connections for Fabric VCs (Fabric Billed), so the origin of the interconnection can be a different metro set here. - --create-organization-interconnection-request-vrf-fabric-vc-create-input-name string create-organization-interconnection-request-vrf-fabric-vc-create-input-name - --create-organization-interconnection-request-vrf-fabric-vc-create-input-project string create-organization-interconnection-request-vrf-fabric-vc-create-input-project - --create-organization-interconnection-request-vrf-fabric-vc-create-input-redundancy string Either 'primary' or 'redundant'. - --create-organization-interconnection-request-vrf-fabric-vc-create-input-service_token_type string create-organization-interconnection-request-vrf-fabric-vc-create-input-service_token_type - --create-organization-interconnection-request-vrf-fabric-vc-create-input-speed string A interconnection speed, in bps, mbps, or gbps. For Fabric VCs, this represents the maximum speed of the interconnection. For Fabric VCs (Metal Billed), this can only be one of the following: ''50mbps'', ''200mbps'', ''500mbps'', ''1gbps'', ''2gbps'', ''5gbps'' or ''10gbps'', and is required for creation. For Fabric VCs (Fabric Billed), this field will always default to ''10gbps'' even if it is not provided. For example, ''500000000'', ''50m'', or' ''500mbps'' will all work as valid inputs. - --create-organization-interconnection-request-vrf-fabric-vc-create-input-tags string create-organization-interconnection-request-vrf-fabric-vc-create-input-tags (JSON array) - --create-organization-interconnection-request-vrf-fabric-vc-create-input-type string create-organization-interconnection-request-vrf-fabric-vc-create-input-type - --create-organization-interconnection-request-vrf-fabric-vc-create-input-vrfs string This field holds a list of VRF UUIDs that will be set automatically on the virtual circuits of Fabric VCs on creation, and can hold up to two UUIDs. Two UUIDs are required when requesting redundant Fabric VCs. The first UUID will be set on the primary virtual circuit, while the second UUID will be set on the secondary. The two UUIDs can be the same if both the primary and secondary virtual circuits will be in the same VRF. This parameter is included in the specification as a developer preview and is generally unavailable. Please contact our Support team for more details. (JSON array) - --exclude string exclude field (JSON or string) - -h, --help help for create-project-interconnection - --include string include field (JSON or string) - --project-id string UUID of the project (required) - --request string JSON payload for additional optional fields not exposed as flags + --create-organization-interconnection-request-dedicated-port-create-input-additional-properties string create-organization-interconnection-request-dedicated-port-create-input-additional-properties (JSON) + --create-organization-interconnection-request-dedicated-port-create-input-billing_account_name string The billing account name of the Equinix Fabric account. + --create-organization-interconnection-request-dedicated-port-create-input-contact_email string The preferred email used for communication and notifications about the Equinix Fabric interconnection. Optional and defaults to the primary user email address when using a User API key or the organization owner email address when using a Project API key. + --create-organization-interconnection-request-dedicated-port-create-input-description string create-organization-interconnection-request-dedicated-port-create-input-description + --create-organization-interconnection-request-dedicated-port-create-input-facility_id string create-organization-interconnection-request-dedicated-port-create-input-facility_id + --create-organization-interconnection-request-dedicated-port-create-input-metro string A Metro ID or code. For interconnections with Dedicated Ports, this will be the location of the issued Dedicated Ports. + --create-organization-interconnection-request-dedicated-port-create-input-mode string create-organization-interconnection-request-dedicated-port-create-input-mode + --create-organization-interconnection-request-dedicated-port-create-input-name string create-organization-interconnection-request-dedicated-port-create-input-name + --create-organization-interconnection-request-dedicated-port-create-input-project string create-organization-interconnection-request-dedicated-port-create-input-project + --create-organization-interconnection-request-dedicated-port-create-input-redundancy string Either 'primary' or 'redundant'. + --create-organization-interconnection-request-dedicated-port-create-input-speed string A interconnection speed, in bps, mbps, or gbps. For Dedicated Ports, this can be 10Gbps or 100Gbps. + --create-organization-interconnection-request-dedicated-port-create-input-tags string create-organization-interconnection-request-dedicated-port-create-input-tags (JSON array) + --create-organization-interconnection-request-dedicated-port-create-input-type string create-organization-interconnection-request-dedicated-port-create-input-type + --create-organization-interconnection-request-dedicated-port-create-input-use_case string The intended use case of the dedicated port. + --create-organization-interconnection-request-shared-port-vc-vlan-create-input-additional-properties string create-organization-interconnection-request-shared-port-vc-vlan-create-input-additional-properties (JSON) + --create-organization-interconnection-request-shared-port-vc-vlan-create-input-contact_email string The preferred email used for communication and notifications about the Equinix Fabric interconnection. Optional and defaults to the primary user email address when using a User API key or the organization owner email address when using a Project API key. + --create-organization-interconnection-request-shared-port-vc-vlan-create-input-description string create-organization-interconnection-request-shared-port-vc-vlan-create-input-description + --create-organization-interconnection-request-shared-port-vc-vlan-create-input-metro string A Metro ID or code. When creating Fabric VCs (Metal Billed), this is where interconnection will be originating from, as we pre-authorize the use of one of our shared ports as the origin of the interconnection using A-Side service tokens. We only allow local connections for Fabric VCs (Metal Billed), so the destination location must be the same as the origin. For Fabric VCs (Fabric Billed), or shared connections, this will be the destination of the interconnection. We allow remote connections for Fabric VCs (Fabric Billed), so the origin of the interconnection can be a different metro set here. + --create-organization-interconnection-request-shared-port-vc-vlan-create-input-name string create-organization-interconnection-request-shared-port-vc-vlan-create-input-name + --create-organization-interconnection-request-shared-port-vc-vlan-create-input-project string create-organization-interconnection-request-shared-port-vc-vlan-create-input-project + --create-organization-interconnection-request-shared-port-vc-vlan-create-input-speed string A interconnection speed, in bps, mbps, or gbps. For Fabric VCs, this represents the maximum speed of the interconnection. For Fabric VCs (Metal Billed), this can only be one of the following: ''50mbps'', ''200mbps'', ''500mbps'', ''1gbps'', ''2gbps'', ''5gbps'' or ''10gbps'', and is required for creation. For Fabric VCs (Fabric Billed), this field will always default to ''10gbps'' even if it is not provided. For example, ''500000000'', ''50m'', or' ''500mbps'' will all work as valid inputs. + --create-organization-interconnection-request-shared-port-vc-vlan-create-input-tags string create-organization-interconnection-request-shared-port-vc-vlan-create-input-tags (JSON array) + --create-organization-interconnection-request-shared-port-vc-vlan-create-input-type string create-organization-interconnection-request-shared-port-vc-vlan-create-input-type + --create-organization-interconnection-request-shared-port-vc-vlan-create-input-vlans string A list of one or two metro-based VLANs that will be set on the virtual circuits of primary and/or secondary interconnections respectively when creating Fabric VCs. VLANs can also be set after the interconnection is created, but are required to fully activate the virtual circuits. (JSON array) + --create-organization-interconnection-request-vlan-csp-connection-create-input-additional-properties string create-organization-interconnection-request-vlan-csp-connection-create-input-additional-properties (JSON) + --create-organization-interconnection-request-vlan-csp-connection-create-input-contact_email string The preferred email used for communication and notifications about the Equinix Fabric interconnection. Optional and defaults to the primary user email address when using a User API key or the organization owner email address when using a Project API key. + --create-organization-interconnection-request-vlan-csp-connection-create-input-description string create-organization-interconnection-request-vlan-csp-connection-create-input-description + --create-organization-interconnection-request-vlan-csp-connection-create-input-fabric_provider string create-organization-interconnection-request-vlan-csp-connection-create-input-fabric_provider (JSON) + --create-organization-interconnection-request-vlan-csp-connection-create-input-metro string A Metro ID or code. When creating Fabric VCs (Metal Billed), this is where interconnection will be originating from, as we pre-authorize the use of one of our shared ports as the origin of the interconnection using A-Side service tokens. We only allow local connections for Fabric VCs (Metal Billed), so the destination location must be the same as the origin. For Fabric VCs (Fabric Billed), or shared connections, this will be the destination of the interconnection. We allow remote connections for Fabric VCs (Fabric Billed), so the origin of the interconnection can be a different metro set here. + --create-organization-interconnection-request-vlan-csp-connection-create-input-name string create-organization-interconnection-request-vlan-csp-connection-create-input-name + --create-organization-interconnection-request-vlan-csp-connection-create-input-project string create-organization-interconnection-request-vlan-csp-connection-create-input-project + --create-organization-interconnection-request-vlan-csp-connection-create-input-speed string A interconnection speed, in bps, mbps, or gbps. For Fabric VCs, this represents the maximum speed of the interconnection. For Fabric VCs (Metal Billed), this can only be one of the following: ''50mbps'', ''200mbps'', ''500mbps'', ''1gbps'', ''2gbps'', ''5gbps'' or ''10gbps'', and is required for creation. For Fabric VCs (Fabric Billed), this field will always default to ''10gbps'' even if it is not provided. For example, ''500000000'', ''50m'', or' ''500mbps'' will all work as valid inputs. + --create-organization-interconnection-request-vlan-csp-connection-create-input-tags string create-organization-interconnection-request-vlan-csp-connection-create-input-tags (JSON array) + --create-organization-interconnection-request-vlan-csp-connection-create-input-type string create-organization-interconnection-request-vlan-csp-connection-create-input-type + --create-organization-interconnection-request-vlan-csp-connection-create-input-vlans string A list of one or two metro-based VLANs that will be set on the virtual circuits of primary and/or secondary interconnections respectively when creating Fabric VCs. VLANs can also be set after the interconnection is created, but are required to fully activate the virtual circuits. (JSON array) + --create-organization-interconnection-request-vlan-fabric-vc-create-input-additional-properties string create-organization-interconnection-request-vlan-fabric-vc-create-input-additional-properties (JSON) + --create-organization-interconnection-request-vlan-fabric-vc-create-input-contact_email string The preferred email used for communication and notifications about the Equinix Fabric interconnection. Optional and defaults to the primary user email address when using a User API key or the organization owner email address when using a Project API key. + --create-organization-interconnection-request-vlan-fabric-vc-create-input-description string create-organization-interconnection-request-vlan-fabric-vc-create-input-description + --create-organization-interconnection-request-vlan-fabric-vc-create-input-facility_id string create-organization-interconnection-request-vlan-fabric-vc-create-input-facility_id + --create-organization-interconnection-request-vlan-fabric-vc-create-input-metro string A Metro ID or code. When creating Fabric VCs (Metal Billed), this is where interconnection will be originating from, as we pre-authorize the use of one of our shared ports as the origin of the interconnection using A-Side service tokens. We only allow local connections for Fabric VCs (Metal Billed), so the destination location must be the same as the origin. For Fabric VCs (Fabric Billed), or shared connections, this will be the destination of the interconnection. We allow remote connections for Fabric VCs (Fabric Billed), so the origin of the interconnection can be a different metro set here. + --create-organization-interconnection-request-vlan-fabric-vc-create-input-name string create-organization-interconnection-request-vlan-fabric-vc-create-input-name + --create-organization-interconnection-request-vlan-fabric-vc-create-input-project string create-organization-interconnection-request-vlan-fabric-vc-create-input-project + --create-organization-interconnection-request-vlan-fabric-vc-create-input-redundancy string Either 'primary' or 'redundant'. + --create-organization-interconnection-request-vlan-fabric-vc-create-input-service_token_type string create-organization-interconnection-request-vlan-fabric-vc-create-input-service_token_type + --create-organization-interconnection-request-vlan-fabric-vc-create-input-speed string A interconnection speed, in bps, mbps, or gbps. For Fabric VCs, this represents the maximum speed of the interconnection. For Fabric VCs (Metal Billed), this can only be one of the following: ''50mbps'', ''200mbps'', ''500mbps'', ''1gbps'', ''2gbps'', ''5gbps'' or ''10gbps'', and is required for creation. For Fabric VCs (Fabric Billed), this field will always default to ''10gbps'' even if it is not provided. For example, ''500000000'', ''50m'', or' ''500mbps'' will all work as valid inputs. + --create-organization-interconnection-request-vlan-fabric-vc-create-input-tags string create-organization-interconnection-request-vlan-fabric-vc-create-input-tags (JSON array) + --create-organization-interconnection-request-vlan-fabric-vc-create-input-type string create-organization-interconnection-request-vlan-fabric-vc-create-input-type + --create-organization-interconnection-request-vlan-fabric-vc-create-input-vlans string A list of one or two metro-based VLANs that will be set on the virtual circuits of primary and/or secondary (if redundant) interconnections respectively when creating Fabric VCs. VLANs can also be set after the interconnection is created, but are required to fully activate the virtual circuits. (JSON array) + --create-organization-interconnection-request-vrf-fabric-vc-create-input-additional-properties string create-organization-interconnection-request-vrf-fabric-vc-create-input-additional-properties (JSON) + --create-organization-interconnection-request-vrf-fabric-vc-create-input-contact_email string The preferred email used for communication and notifications about the Equinix Fabric interconnection. Optional and defaults to the primary user email address when using a User API key or the organization owner email address when using a Project API key. + --create-organization-interconnection-request-vrf-fabric-vc-create-input-description string create-organization-interconnection-request-vrf-fabric-vc-create-input-description + --create-organization-interconnection-request-vrf-fabric-vc-create-input-facility_id string create-organization-interconnection-request-vrf-fabric-vc-create-input-facility_id + --create-organization-interconnection-request-vrf-fabric-vc-create-input-metro string A Metro ID or code. When creating Fabric VCs (Metal Billed), this is where interconnection will be originating from, as we pre-authorize the use of one of our shared ports as the origin of the interconnection using A-Side service tokens. We only allow local connections for Fabric VCs (Metal Billed), so the destination location must be the same as the origin. For Fabric VCs (Fabric Billed), or shared connections, this will be the destination of the interconnection. We allow remote connections for Fabric VCs (Fabric Billed), so the origin of the interconnection can be a different metro set here. + --create-organization-interconnection-request-vrf-fabric-vc-create-input-name string create-organization-interconnection-request-vrf-fabric-vc-create-input-name + --create-organization-interconnection-request-vrf-fabric-vc-create-input-project string create-organization-interconnection-request-vrf-fabric-vc-create-input-project + --create-organization-interconnection-request-vrf-fabric-vc-create-input-redundancy string Either 'primary' or 'redundant'. + --create-organization-interconnection-request-vrf-fabric-vc-create-input-service_token_type string create-organization-interconnection-request-vrf-fabric-vc-create-input-service_token_type + --create-organization-interconnection-request-vrf-fabric-vc-create-input-speed string A interconnection speed, in bps, mbps, or gbps. For Fabric VCs, this represents the maximum speed of the interconnection. For Fabric VCs (Metal Billed), this can only be one of the following: ''50mbps'', ''200mbps'', ''500mbps'', ''1gbps'', ''2gbps'', ''5gbps'' or ''10gbps'', and is required for creation. For Fabric VCs (Fabric Billed), this field will always default to ''10gbps'' even if it is not provided. For example, ''500000000'', ''50m'', or' ''500mbps'' will all work as valid inputs. + --create-organization-interconnection-request-vrf-fabric-vc-create-input-tags string create-organization-interconnection-request-vrf-fabric-vc-create-input-tags (JSON array) + --create-organization-interconnection-request-vrf-fabric-vc-create-input-type string create-organization-interconnection-request-vrf-fabric-vc-create-input-type + --create-organization-interconnection-request-vrf-fabric-vc-create-input-vrfs string This field holds a list of VRF UUIDs that will be set automatically on the virtual circuits of Fabric VCs on creation, and can hold up to two UUIDs. Two UUIDs are required when requesting redundant Fabric VCs. The first UUID will be set on the primary virtual circuit, while the second UUID will be set on the secondary. The two UUIDs can be the same if both the primary and secondary virtual circuits will be in the same VRF. This parameter is included in the specification as a developer preview and is generally unavailable. Please contact our Support team for more details. (JSON array) + --exclude string exclude field (JSON or string) + -h, --help help for create-project-interconnection + --include string include field (JSON or string) + --project-id string UUID of the project (required) + --request string JSON payload for additional optional fields not exposed as flags ``` ### Options inherited from parent commands diff --git a/docs/equinix_metalv1_ip-addresses.md b/docs/equinix_metalv1_ip-addresses.md new file mode 100644 index 0000000..a1c97a0 --- /dev/null +++ b/docs/equinix_metalv1_ip-addresses.md @@ -0,0 +1,33 @@ +## equinix metalv1 ip-addresses + +Manage ip-addresses resources + +### Synopsis + +Commands for managing ip-addresses resources in the API + +### Options + +``` + -h, --help help for ip-addresses +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1](equinix_metalv1.md) - Manage Equinix metalv1 resources +* [equinix metalv1 ip-addresses delete-ip-address](equinix_metalv1_ip-addresses_delete-ip-address.md) - Unassign an ip address +* [equinix metalv1 ip-addresses find-ip-address-by-id](equinix_metalv1_ip-addresses_find-ip-address-by-id.md) - Retrieve an ip address +* [equinix metalv1 ip-addresses find-ip-address-customdata](equinix_metalv1_ip-addresses_find-ip-address-customdata.md) - Retrieve the custom metadata of an IP Reservation or IP Assignment +* [equinix metalv1 ip-addresses find-ip-availabilities](equinix_metalv1_ip-addresses_find-ip-availabilities.md) - Retrieve all available subnets of a particular reservation +* [equinix metalv1 ip-addresses find-ip-reservations](equinix_metalv1_ip-addresses_find-ip-reservations.md) - Retrieve all ip reservations +* [equinix metalv1 ip-addresses request-ip-reservation](equinix_metalv1_ip-addresses_request-ip-reservation.md) - Requesting IP reservations +* [equinix metalv1 ip-addresses update-ip-address](equinix_metalv1_ip-addresses_update-ip-address.md) - Update an ip address + diff --git a/docs/equinix_metalv1_ip-addresses_delete-ip-address.md b/docs/equinix_metalv1_ip-addresses_delete-ip-address.md new file mode 100644 index 0000000..5823789 --- /dev/null +++ b/docs/equinix_metalv1_ip-addresses_delete-ip-address.md @@ -0,0 +1,34 @@ +## equinix metalv1 ip-addresses delete-ip-address + +Unassign an ip address + +### Synopsis + +This call can be used to un-assign an IP assignment or delete an IP reservation. Un-assign an IP address record. Use the assignment UUID you get after attaching the IP. This will remove the relationship between an IP and the device or metal gateway and will make the IP address available to be assigned to another device, once the IP has been un-configured from the network. Delete an IP reservation. Use the reservation UUID you get after adding the IP to the project. This will permanently delete the IP block reservation from the project. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ip-addresses delete-ip-address [flags] +``` + +### Options + +``` + -h, --help help for delete-ip-address + --id string IP Address UUID (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 ip-addresses](equinix_metalv1_ip-addresses.md) - Manage ip-addresses resources + diff --git a/docs/equinix_metalv1_ip-addresses_find-ip-address-by-id.md b/docs/equinix_metalv1_ip-addresses_find-ip-address-by-id.md new file mode 100644 index 0000000..a240cda --- /dev/null +++ b/docs/equinix_metalv1_ip-addresses_find-ip-address-by-id.md @@ -0,0 +1,36 @@ +## equinix metalv1 ip-addresses find-ip-address-by-id + +Retrieve an ip address + +### Synopsis + +Returns a single ip address if the user has access. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ip-addresses find-ip-address-by-id [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-ip-address-by-id + --id string IP Address UUID (required) + --include string include field (JSON or string) + --request string JSON payload for additional optional fields not exposed as flags +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 ip-addresses](equinix_metalv1_ip-addresses.md) - Manage ip-addresses resources + diff --git a/docs/equinix_metalv1_ip-addresses_find-ip-address-customdata.md b/docs/equinix_metalv1_ip-addresses_find-ip-address-customdata.md new file mode 100644 index 0000000..42a47d8 --- /dev/null +++ b/docs/equinix_metalv1_ip-addresses_find-ip-address-customdata.md @@ -0,0 +1,34 @@ +## equinix metalv1 ip-addresses find-ip-address-customdata + +Retrieve the custom metadata of an IP Reservation or IP Assignment + +### Synopsis + +Provides the custom metadata stored for this IP Reservation or IP Assignment in json format + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ip-addresses find-ip-address-customdata [flags] +``` + +### Options + +``` + -h, --help help for find-ip-address-customdata + --id string Ip Reservation UUID (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 ip-addresses](equinix_metalv1_ip-addresses.md) - Manage ip-addresses resources + diff --git a/docs/equinix_metalv1_ip-addresses_find-ip-availabilities.md b/docs/equinix_metalv1_ip-addresses_find-ip-availabilities.md new file mode 100644 index 0000000..5f644dd --- /dev/null +++ b/docs/equinix_metalv1_ip-addresses_find-ip-availabilities.md @@ -0,0 +1,35 @@ +## equinix metalv1 ip-addresses find-ip-availabilities + +Retrieve all available subnets of a particular reservation + +### Synopsis + +Provides a list of IP resevations for a single project. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ip-addresses find-ip-availabilities [flags] +``` + +### Options + +``` + --cidr string cidr field + -h, --help help for find-ip-availabilities + --id string IP Reservation UUID (required) + --request string JSON payload for additional optional fields not exposed as flags +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 ip-addresses](equinix_metalv1_ip-addresses.md) - Manage ip-addresses resources + diff --git a/docs/equinix_metalv1_i-p-addresses_find-i-p-reservations.md b/docs/equinix_metalv1_ip-addresses_find-ip-reservations.md similarity index 53% rename from docs/equinix_metalv1_i-p-addresses_find-i-p-reservations.md rename to docs/equinix_metalv1_ip-addresses_find-ip-reservations.md index 1b75bd8..39d75ae 100644 --- a/docs/equinix_metalv1_i-p-addresses_find-i-p-reservations.md +++ b/docs/equinix_metalv1_ip-addresses_find-ip-reservations.md @@ -1,28 +1,25 @@ -## equinix metalv1 i-p-addresses find-i-p-reservations +## equinix metalv1 ip-addresses find-ip-reservations -Execute find-i-p-reservations operation +Retrieve all ip reservations ### Synopsis -Execute the find-i-p-reservations operation on this service. +Provides a paginated list of IP reservations for a single project. -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. +Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 i-p-addresses find-i-p-reservations [flags] +equinix metalv1 ip-addresses find-ip-reservations [flags] ``` ### Options ``` --exclude string exclude field (JSON or string) - -h, --help help for find-i-p-reservations + -h, --help help for find-ip-reservations + --id string Project UUID (required) --include string include field (JSON or string) --page int page field - --param-1 string param-1 (required) --per-page int per-page field --request string JSON payload for additional optional fields not exposed as flags --types string types field (JSON or string) @@ -38,5 +35,5 @@ equinix metalv1 i-p-addresses find-i-p-reservations [flags] ### SEE ALSO -* [equinix metalv1 i-p-addresses](equinix_metalv1_i-p-addresses.md) - Manage i-p-addresses resources +* [equinix metalv1 ip-addresses](equinix_metalv1_ip-addresses.md) - Manage ip-addresses resources diff --git a/docs/equinix_metalv1_ip-addresses_request-ip-reservation.md b/docs/equinix_metalv1_ip-addresses_request-ip-reservation.md new file mode 100644 index 0000000..c5b83a3 --- /dev/null +++ b/docs/equinix_metalv1_ip-addresses_request-ip-reservation.md @@ -0,0 +1,54 @@ +## equinix metalv1 ip-addresses request-ip-reservation + +Requesting IP reservations + +### Synopsis + +Request more IP space for a project in order to have additional IP addresses to assign to devices. If the request is within the max quota, an IP reservation will be created. If the project will exceed its IP quota, a request will be submitted for review, and will return an IP Reservation with a `state` of `pending`. You can automatically have the request fail with HTTP status 422 instead of triggering the review process by providing the `fail_on_approval_required` parameter set to `true` in the request. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ip-addresses request-ip-reservation [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for request-ip-reservation + --id string Project UUID (required) + --include string include field (JSON or string) + --request string JSON payload for additional optional fields not exposed as flags + --request-ip-reservation-request-ip-reservation-request-input-additional-properties string request-ip-reservation-request-ip-reservation-request-input-additional-properties (JSON) + --request-ip-reservation-request-ip-reservation-request-input-comments string request-ip-reservation-request-ip-reservation-request-input-comments + --request-ip-reservation-request-ip-reservation-request-input-customdata string request-ip-reservation-request-ip-reservation-request-input-customdata (JSON) + --request-ip-reservation-request-ip-reservation-request-input-details string request-ip-reservation-request-ip-reservation-request-input-details + --request-ip-reservation-request-ip-reservation-request-input-facility string request-ip-reservation-request-ip-reservation-request-input-facility + --request-ip-reservation-request-ip-reservation-request-input-fail_on_approval_required request-ip-reservation-request-ip-reservation-request-input-fail_on_approval_required + --request-ip-reservation-request-ip-reservation-request-input-metro string The code of the metro you are requesting the IP reservation in. + --request-ip-reservation-request-ip-reservation-request-input-quantity int request-ip-reservation-request-ip-reservation-request-input-quantity + --request-ip-reservation-request-ip-reservation-request-input-tags string request-ip-reservation-request-ip-reservation-request-input-tags (JSON array) + --request-ip-reservation-request-ip-reservation-request-input-type string request-ip-reservation-request-ip-reservation-request-input-type + --request-ip-reservation-request-vrf-ip-reservation-create-input-additional-properties string request-ip-reservation-request-vrf-ip-reservation-create-input-additional-properties (JSON) + --request-ip-reservation-request-vrf-ip-reservation-create-input-cidr int The size of the VRF IP Reservation's subnet. The following subnet sizes are supported: - IPv4: between 22 - 29 inclusive - IPv6: exactly 64 + --request-ip-reservation-request-vrf-ip-reservation-create-input-customdata string request-ip-reservation-request-vrf-ip-reservation-create-input-customdata (JSON) + --request-ip-reservation-request-vrf-ip-reservation-create-input-details string request-ip-reservation-request-vrf-ip-reservation-create-input-details + --request-ip-reservation-request-vrf-ip-reservation-create-input-network string The starting address for this VRF IP Reservation's subnet. Both IPv4 and IPv6 are supported. + --request-ip-reservation-request-vrf-ip-reservation-create-input-tags string request-ip-reservation-request-vrf-ip-reservation-create-input-tags (JSON array) + --request-ip-reservation-request-vrf-ip-reservation-create-input-type string Must be set to 'vrf' + --request-ip-reservation-request-vrf-ip-reservation-create-input-vrf_id string The ID of the VRF in which this VRF IP Reservation is created. The VRF must have an existing IP Range that contains the requested subnet. This field may be aliased as just 'vrf'. +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 ip-addresses](equinix_metalv1_ip-addresses.md) - Manage ip-addresses resources + diff --git a/docs/equinix_metalv1_ip-addresses_update-ip-address.md b/docs/equinix_metalv1_ip-addresses_update-ip-address.md new file mode 100644 index 0000000..368c1e8 --- /dev/null +++ b/docs/equinix_metalv1_ip-addresses_update-ip-address.md @@ -0,0 +1,40 @@ +## equinix metalv1 ip-addresses update-ip-address + +Update an ip address + +### Synopsis + +Update details about an ip address + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ip-addresses update-ip-address [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for update-ip-address + --id string IP Address UUID (required) + --include string include field (JSON or string) + --ip-assignment-update-input-additional-properties string ip-assignment-update-input-additional-properties (JSON) + --ip-assignment-update-input-customdata string ip-assignment-update-input-customdata (JSON) + --ip-assignment-update-input-details string ip-assignment-update-input-details + --ip-assignment-update-input-tags string ip-assignment-update-input-tags (JSON array) + --request string JSON payload for additional optional fields not exposed as flags +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 ip-addresses](equinix_metalv1_ip-addresses.md) - Manage ip-addresses resources + diff --git a/docs/equinix_metalv1_plans_find-plans.md b/docs/equinix_metalv1_plans_find-plans.md index 292d0c5..3119eec 100644 --- a/docs/equinix_metalv1_plans_find-plans.md +++ b/docs/equinix_metalv1_plans_find-plans.md @@ -21,7 +21,7 @@ equinix metalv1 plans find-plans [flags] --include string include field (JSON or string) --request string JSON payload for additional optional fields not exposed as flags --slug string slug field - --type_ string type_ field + --type-_ string type-_ field ``` ### Options inherited from parent commands diff --git a/docs/equinix_metalv1_projects.md b/docs/equinix_metalv1_projects.md index bc82016..fea3cd5 100644 --- a/docs/equinix_metalv1_projects.md +++ b/docs/equinix_metalv1_projects.md @@ -27,7 +27,7 @@ Commands for managing projects resources in the API * [equinix metalv1 projects create-project-invitation](equinix_metalv1_projects_create-project-invitation.md) - Create an invitation for a project * [equinix metalv1 projects create-transfer-request](equinix_metalv1_projects_create-transfer-request.md) - Create a transfer request * [equinix metalv1 projects delete-project](equinix_metalv1_projects_delete-project.md) - Delete the project -* [equinix metalv1 projects find-i-p-reservation-customdata](equinix_metalv1_projects_find-i-p-reservation-customdata.md) - Retrieve the custom metadata of an IP Reservation +* [equinix metalv1 projects find-ip-reservation-customdata](equinix_metalv1_projects_find-ip-reservation-customdata.md) - Retrieve the custom metadata of an IP Reservation * [equinix metalv1 projects find-project-by-id](equinix_metalv1_projects_find-project-by-id.md) - Retrieve a project * [equinix metalv1 projects find-project-customdata](equinix_metalv1_projects_find-project-customdata.md) - Retrieve the custom metadata of a project * [equinix metalv1 projects find-project-invitations](equinix_metalv1_projects_find-project-invitations.md) - Retrieve project invitations diff --git a/docs/equinix_metalv1_projects_find-i-p-reservation-customdata.md b/docs/equinix_metalv1_projects_find-ip-reservation-customdata.md similarity index 80% rename from docs/equinix_metalv1_projects_find-i-p-reservation-customdata.md rename to docs/equinix_metalv1_projects_find-ip-reservation-customdata.md index 05a85ef..b8ef5ae 100644 --- a/docs/equinix_metalv1_projects_find-i-p-reservation-customdata.md +++ b/docs/equinix_metalv1_projects_find-ip-reservation-customdata.md @@ -1,4 +1,4 @@ -## equinix metalv1 projects find-i-p-reservation-customdata +## equinix metalv1 projects find-ip-reservation-customdata Retrieve the custom metadata of an IP Reservation @@ -9,13 +9,13 @@ Provides the custom metadata stored for this IP Reservation in json format Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 projects find-i-p-reservation-customdata [flags] +equinix metalv1 projects find-ip-reservation-customdata [flags] ``` ### Options ``` - -h, --help help for find-i-p-reservation-customdata + -h, --help help for find-ip-reservation-customdata --id string Ip Reservation UUID (required) --project-id string Project UUID (required) --request string JSON payload for request body fields diff --git a/docs/equinix_metalv1_s-s-h-keys.md b/docs/equinix_metalv1_s-s-h-keys.md deleted file mode 100644 index f766d6b..0000000 --- a/docs/equinix_metalv1_s-s-h-keys.md +++ /dev/null @@ -1,34 +0,0 @@ -## equinix metalv1 s-s-h-keys - -Manage s-s-h-keys resources - -### Synopsis - -Commands for managing s-s-h-keys resources in the API - -### Options - -``` - -h, --help help for s-s-h-keys -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1](equinix_metalv1.md) - Manage Equinix metalv1 resources -* [equinix metalv1 s-s-h-keys create-project-s-s-h-key](equinix_metalv1_s-s-h-keys_create-project-s-s-h-key.md) - Execute create-project-s-s-h-key operation -* [equinix metalv1 s-s-h-keys create-s-s-h-key](equinix_metalv1_s-s-h-keys_create-s-s-h-key.md) - Execute create-s-s-h-key operation -* [equinix metalv1 s-s-h-keys delete-s-s-h-key](equinix_metalv1_s-s-h-keys_delete-s-s-h-key.md) - Execute delete-s-s-h-key operation -* [equinix metalv1 s-s-h-keys find-device-s-s-h-keys](equinix_metalv1_s-s-h-keys_find-device-s-s-h-keys.md) - Execute find-device-s-s-h-keys operation -* [equinix metalv1 s-s-h-keys find-project-s-s-h-keys](equinix_metalv1_s-s-h-keys_find-project-s-s-h-keys.md) - Execute find-project-s-s-h-keys operation -* [equinix metalv1 s-s-h-keys find-s-s-h-key-by-id](equinix_metalv1_s-s-h-keys_find-s-s-h-key-by-id.md) - Execute find-s-s-h-key-by-id operation -* [equinix metalv1 s-s-h-keys find-s-s-h-keys](equinix_metalv1_s-s-h-keys_find-s-s-h-keys.md) - Execute find-s-s-h-keys operation -* [equinix metalv1 s-s-h-keys update-s-s-h-key](equinix_metalv1_s-s-h-keys_update-s-s-h-key.md) - Execute update-s-s-h-key operation - diff --git a/docs/equinix_metalv1_s-s-h-keys_create-project-s-s-h-key.md b/docs/equinix_metalv1_s-s-h-keys_create-project-s-s-h-key.md deleted file mode 100644 index 7ebafdd..0000000 --- a/docs/equinix_metalv1_s-s-h-keys_create-project-s-s-h-key.md +++ /dev/null @@ -1,43 +0,0 @@ -## equinix metalv1 s-s-h-keys create-project-s-s-h-key - -Execute create-project-s-s-h-key operation - -### Synopsis - -Execute the create-project-s-s-h-key operation on this service. - -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. - -``` -equinix metalv1 s-s-h-keys create-project-s-s-h-key [flags] -``` - -### Options - -``` - -h, --help help for create-project-s-s-h-key - --include string include field (JSON or string) - --param-1 string param-1 (required) - --request string JSON payload for additional optional fields not exposed as flags - --s-s-h-key-create-input-additional-properties string s-s-h-key-create-input-additional-properties (JSON) - --s-s-h-key-create-input-instances_ids string List of instance UUIDs to associate SSH key with, when empty array is sent all instances belonging to entity will be included (JSON array) - --s-s-h-key-create-input-key string s-s-h-key-create-input-key - --s-s-h-key-create-input-label string s-s-h-key-create-input-label - --s-s-h-key-create-input-tags string s-s-h-key-create-input-tags (JSON array) -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 s-s-h-keys](equinix_metalv1_s-s-h-keys.md) - Manage s-s-h-keys resources - diff --git a/docs/equinix_metalv1_s-s-h-keys_create-s-s-h-key.md b/docs/equinix_metalv1_s-s-h-keys_create-s-s-h-key.md deleted file mode 100644 index 2b47df4..0000000 --- a/docs/equinix_metalv1_s-s-h-keys_create-s-s-h-key.md +++ /dev/null @@ -1,42 +0,0 @@ -## equinix metalv1 s-s-h-keys create-s-s-h-key - -Execute create-s-s-h-key operation - -### Synopsis - -Execute the create-s-s-h-key operation on this service. - -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. - -``` -equinix metalv1 s-s-h-keys create-s-s-h-key [flags] -``` - -### Options - -``` - -h, --help help for create-s-s-h-key - --include string include field (JSON or string) - --request string JSON payload for additional optional fields not exposed as flags - --s-s-h-key-create-input-additional-properties string s-s-h-key-create-input-additional-properties (JSON) - --s-s-h-key-create-input-instances_ids string List of instance UUIDs to associate SSH key with, when empty array is sent all instances belonging to entity will be included (JSON array) - --s-s-h-key-create-input-key string s-s-h-key-create-input-key - --s-s-h-key-create-input-label string s-s-h-key-create-input-label - --s-s-h-key-create-input-tags string s-s-h-key-create-input-tags (JSON array) -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 s-s-h-keys](equinix_metalv1_s-s-h-keys.md) - Manage s-s-h-keys resources - diff --git a/docs/equinix_metalv1_s-s-h-keys_delete-s-s-h-key.md b/docs/equinix_metalv1_s-s-h-keys_delete-s-s-h-key.md deleted file mode 100644 index dabdbb7..0000000 --- a/docs/equinix_metalv1_s-s-h-keys_delete-s-s-h-key.md +++ /dev/null @@ -1,37 +0,0 @@ -## equinix metalv1 s-s-h-keys delete-s-s-h-key - -Execute delete-s-s-h-key operation - -### Synopsis - -Execute the delete-s-s-h-key operation on this service. - -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. - -``` -equinix metalv1 s-s-h-keys delete-s-s-h-key [flags] -``` - -### Options - -``` - -h, --help help for delete-s-s-h-key - --param-1 string param-1 (required) - --request string JSON payload for request body fields -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 s-s-h-keys](equinix_metalv1_s-s-h-keys.md) - Manage s-s-h-keys resources - diff --git a/docs/equinix_metalv1_s-s-h-keys_find-device-s-s-h-keys.md b/docs/equinix_metalv1_s-s-h-keys_find-device-s-s-h-keys.md deleted file mode 100644 index 2093000..0000000 --- a/docs/equinix_metalv1_s-s-h-keys_find-device-s-s-h-keys.md +++ /dev/null @@ -1,39 +0,0 @@ -## equinix metalv1 s-s-h-keys find-device-s-s-h-keys - -Execute find-device-s-s-h-keys operation - -### Synopsis - -Execute the find-device-s-s-h-keys operation on this service. - -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. - -``` -equinix metalv1 s-s-h-keys find-device-s-s-h-keys [flags] -``` - -### Options - -``` - -h, --help help for find-device-s-s-h-keys - --include string include field (JSON or string) - --param-1 string param-1 (required) - --request string JSON payload for additional optional fields not exposed as flags - --search-string string search-string field -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 s-s-h-keys](equinix_metalv1_s-s-h-keys.md) - Manage s-s-h-keys resources - diff --git a/docs/equinix_metalv1_s-s-h-keys_find-project-s-s-h-keys.md b/docs/equinix_metalv1_s-s-h-keys_find-project-s-s-h-keys.md deleted file mode 100644 index 354d9b0..0000000 --- a/docs/equinix_metalv1_s-s-h-keys_find-project-s-s-h-keys.md +++ /dev/null @@ -1,39 +0,0 @@ -## equinix metalv1 s-s-h-keys find-project-s-s-h-keys - -Execute find-project-s-s-h-keys operation - -### Synopsis - -Execute the find-project-s-s-h-keys operation on this service. - -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. - -``` -equinix metalv1 s-s-h-keys find-project-s-s-h-keys [flags] -``` - -### Options - -``` - -h, --help help for find-project-s-s-h-keys - --include string include field (JSON or string) - --param-1 string param-1 (required) - --query string query field - --request string JSON payload for additional optional fields not exposed as flags -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 s-s-h-keys](equinix_metalv1_s-s-h-keys.md) - Manage s-s-h-keys resources - diff --git a/docs/equinix_metalv1_s-s-h-keys_find-s-s-h-key-by-id.md b/docs/equinix_metalv1_s-s-h-keys_find-s-s-h-key-by-id.md deleted file mode 100644 index 4911ffc..0000000 --- a/docs/equinix_metalv1_s-s-h-keys_find-s-s-h-key-by-id.md +++ /dev/null @@ -1,38 +0,0 @@ -## equinix metalv1 s-s-h-keys find-s-s-h-key-by-id - -Execute find-s-s-h-key-by-id operation - -### Synopsis - -Execute the find-s-s-h-key-by-id operation on this service. - -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. - -``` -equinix metalv1 s-s-h-keys find-s-s-h-key-by-id [flags] -``` - -### Options - -``` - -h, --help help for find-s-s-h-key-by-id - --id string id (required) - --include string include field (JSON or string) - --request string JSON payload for additional optional fields not exposed as flags -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 s-s-h-keys](equinix_metalv1_s-s-h-keys.md) - Manage s-s-h-keys resources - diff --git a/docs/equinix_metalv1_s-s-h-keys_update-s-s-h-key.md b/docs/equinix_metalv1_s-s-h-keys_update-s-s-h-key.md deleted file mode 100644 index 2df6a23..0000000 --- a/docs/equinix_metalv1_s-s-h-keys_update-s-s-h-key.md +++ /dev/null @@ -1,42 +0,0 @@ -## equinix metalv1 s-s-h-keys update-s-s-h-key - -Execute update-s-s-h-key operation - -### Synopsis - -Execute the update-s-s-h-key operation on this service. - -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. - -``` -equinix metalv1 s-s-h-keys update-s-s-h-key [flags] -``` - -### Options - -``` - -h, --help help for update-s-s-h-key - --include string include field (JSON or string) - --param-1 string param-1 (required) - --request string JSON payload for additional optional fields not exposed as flags - --s-s-h-key-input-additional-properties string s-s-h-key-input-additional-properties (JSON) - --s-s-h-key-input-key string s-s-h-key-input-key - --s-s-h-key-input-label string s-s-h-key-input-label - --s-s-h-key-input-tags string s-s-h-key-input-tags (JSON array) -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 s-s-h-keys](equinix_metalv1_s-s-h-keys.md) - Manage s-s-h-keys resources - diff --git a/docs/equinix_metalv1_ssh-keys.md b/docs/equinix_metalv1_ssh-keys.md new file mode 100644 index 0000000..824486b --- /dev/null +++ b/docs/equinix_metalv1_ssh-keys.md @@ -0,0 +1,34 @@ +## equinix metalv1 ssh-keys + +Manage ssh-keys resources + +### Synopsis + +Commands for managing ssh-keys resources in the API + +### Options + +``` + -h, --help help for ssh-keys +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1](equinix_metalv1.md) - Manage Equinix metalv1 resources +* [equinix metalv1 ssh-keys create-project-ssh-key](equinix_metalv1_ssh-keys_create-project-ssh-key.md) - Create a ssh key for the given project +* [equinix metalv1 ssh-keys create-ssh-key](equinix_metalv1_ssh-keys_create-ssh-key.md) - Create a ssh key for the current user +* [equinix metalv1 ssh-keys delete-ssh-key](equinix_metalv1_ssh-keys_delete-ssh-key.md) - Delete the ssh key +* [equinix metalv1 ssh-keys find-device-ssh-keys](equinix_metalv1_ssh-keys_find-device-ssh-keys.md) - Retrieve a device's ssh keys +* [equinix metalv1 ssh-keys find-project-ssh-keys](equinix_metalv1_ssh-keys_find-project-ssh-keys.md) - Retrieve a project's ssh keys +* [equinix metalv1 ssh-keys find-ssh-key-by-id](equinix_metalv1_ssh-keys_find-ssh-key-by-id.md) - Retrieve a ssh key +* [equinix metalv1 ssh-keys find-ssh-keys](equinix_metalv1_ssh-keys_find-ssh-keys.md) - Retrieve all ssh keys +* [equinix metalv1 ssh-keys update-ssh-key](equinix_metalv1_ssh-keys_update-ssh-key.md) - Update the ssh key + diff --git a/docs/equinix_metalv1_ssh-keys_create-project-ssh-key.md b/docs/equinix_metalv1_ssh-keys_create-project-ssh-key.md new file mode 100644 index 0000000..66266ee --- /dev/null +++ b/docs/equinix_metalv1_ssh-keys_create-project-ssh-key.md @@ -0,0 +1,40 @@ +## equinix metalv1 ssh-keys create-project-ssh-key + +Create a ssh key for the given project + +### Synopsis + +Creates a ssh key. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ssh-keys create-project-ssh-key [flags] +``` + +### Options + +``` + -h, --help help for create-project-ssh-key + --id string Project UUID (required) + --include string include field (JSON or string) + --request string JSON payload for additional optional fields not exposed as flags + --ssh-key-create-input-additional-properties string ssh-key-create-input-additional-properties (JSON) + --ssh-key-create-input-instances_ids string List of instance UUIDs to associate SSH key with, when empty array is sent all instances belonging to entity will be included (JSON array) + --ssh-key-create-input-key string ssh-key-create-input-key + --ssh-key-create-input-label string ssh-key-create-input-label + --ssh-key-create-input-tags string ssh-key-create-input-tags (JSON array) +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 ssh-keys](equinix_metalv1_ssh-keys.md) - Manage ssh-keys resources + diff --git a/docs/equinix_metalv1_ssh-keys_create-ssh-key.md b/docs/equinix_metalv1_ssh-keys_create-ssh-key.md new file mode 100644 index 0000000..870616a --- /dev/null +++ b/docs/equinix_metalv1_ssh-keys_create-ssh-key.md @@ -0,0 +1,39 @@ +## equinix metalv1 ssh-keys create-ssh-key + +Create a ssh key for the current user + +### Synopsis + +Creates a ssh key. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ssh-keys create-ssh-key [flags] +``` + +### Options + +``` + -h, --help help for create-ssh-key + --include string include field (JSON or string) + --request string JSON payload for additional optional fields not exposed as flags + --ssh-key-create-input-additional-properties string ssh-key-create-input-additional-properties (JSON) + --ssh-key-create-input-instances_ids string List of instance UUIDs to associate SSH key with, when empty array is sent all instances belonging to entity will be included (JSON array) + --ssh-key-create-input-key string ssh-key-create-input-key + --ssh-key-create-input-label string ssh-key-create-input-label + --ssh-key-create-input-tags string ssh-key-create-input-tags (JSON array) +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 ssh-keys](equinix_metalv1_ssh-keys.md) - Manage ssh-keys resources + diff --git a/docs/equinix_metalv1_ssh-keys_delete-ssh-key.md b/docs/equinix_metalv1_ssh-keys_delete-ssh-key.md new file mode 100644 index 0000000..a53ef3f --- /dev/null +++ b/docs/equinix_metalv1_ssh-keys_delete-ssh-key.md @@ -0,0 +1,34 @@ +## equinix metalv1 ssh-keys delete-ssh-key + +Delete the ssh key + +### Synopsis + +Deletes the ssh key. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ssh-keys delete-ssh-key [flags] +``` + +### Options + +``` + -h, --help help for delete-ssh-key + --id string ssh key UUID (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 ssh-keys](equinix_metalv1_ssh-keys.md) - Manage ssh-keys resources + diff --git a/docs/equinix_metalv1_ssh-keys_find-device-ssh-keys.md b/docs/equinix_metalv1_ssh-keys_find-device-ssh-keys.md new file mode 100644 index 0000000..c4cd8a5 --- /dev/null +++ b/docs/equinix_metalv1_ssh-keys_find-device-ssh-keys.md @@ -0,0 +1,36 @@ +## equinix metalv1 ssh-keys find-device-ssh-keys + +Retrieve a device's ssh keys + +### Synopsis + +Returns a collection of the device's ssh keys. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ssh-keys find-device-ssh-keys [flags] +``` + +### Options + +``` + -h, --help help for find-device-ssh-keys + --id string Project UUID (required) + --include string include field (JSON or string) + --request string JSON payload for additional optional fields not exposed as flags + --search-string string search-string field +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 ssh-keys](equinix_metalv1_ssh-keys.md) - Manage ssh-keys resources + diff --git a/docs/equinix_metalv1_ssh-keys_find-project-ssh-keys.md b/docs/equinix_metalv1_ssh-keys_find-project-ssh-keys.md new file mode 100644 index 0000000..ac87d60 --- /dev/null +++ b/docs/equinix_metalv1_ssh-keys_find-project-ssh-keys.md @@ -0,0 +1,36 @@ +## equinix metalv1 ssh-keys find-project-ssh-keys + +Retrieve a project's ssh keys + +### Synopsis + +Returns a collection of the project's ssh keys. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ssh-keys find-project-ssh-keys [flags] +``` + +### Options + +``` + -h, --help help for find-project-ssh-keys + --id string Project UUID (required) + --include string include field (JSON or string) + --query string query field + --request string JSON payload for additional optional fields not exposed as flags +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 ssh-keys](equinix_metalv1_ssh-keys.md) - Manage ssh-keys resources + diff --git a/docs/equinix_metalv1_ssh-keys_find-ssh-key-by-id.md b/docs/equinix_metalv1_ssh-keys_find-ssh-key-by-id.md new file mode 100644 index 0000000..ca2d27b --- /dev/null +++ b/docs/equinix_metalv1_ssh-keys_find-ssh-key-by-id.md @@ -0,0 +1,35 @@ +## equinix metalv1 ssh-keys find-ssh-key-by-id + +Retrieve a ssh key + +### Synopsis + +Returns a single ssh key if the user has access + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ssh-keys find-ssh-key-by-id [flags] +``` + +### Options + +``` + -h, --help help for find-ssh-key-by-id + --id string SSH Key UUID (required) + --include string include field (JSON or string) + --request string JSON payload for additional optional fields not exposed as flags +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 ssh-keys](equinix_metalv1_ssh-keys.md) - Manage ssh-keys resources + diff --git a/docs/equinix_metalv1_s-s-h-keys_find-s-s-h-keys.md b/docs/equinix_metalv1_ssh-keys_find-ssh-keys.md similarity index 51% rename from docs/equinix_metalv1_s-s-h-keys_find-s-s-h-keys.md rename to docs/equinix_metalv1_ssh-keys_find-ssh-keys.md index f216ded..39ac2e8 100644 --- a/docs/equinix_metalv1_s-s-h-keys_find-s-s-h-keys.md +++ b/docs/equinix_metalv1_ssh-keys_find-ssh-keys.md @@ -1,24 +1,21 @@ -## equinix metalv1 s-s-h-keys find-s-s-h-keys +## equinix metalv1 ssh-keys find-ssh-keys -Execute find-s-s-h-keys operation +Retrieve all ssh keys ### Synopsis -Execute the find-s-s-h-keys operation on this service. +Returns a collection of the user’s ssh keys. -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. +Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 s-s-h-keys find-s-s-h-keys [flags] +equinix metalv1 ssh-keys find-ssh-keys [flags] ``` ### Options ``` - -h, --help help for find-s-s-h-keys + -h, --help help for find-ssh-keys --include string include field (JSON or string) --request string JSON payload for additional optional fields not exposed as flags --search string search field @@ -34,5 +31,5 @@ equinix metalv1 s-s-h-keys find-s-s-h-keys [flags] ### SEE ALSO -* [equinix metalv1 s-s-h-keys](equinix_metalv1_s-s-h-keys.md) - Manage s-s-h-keys resources +* [equinix metalv1 ssh-keys](equinix_metalv1_ssh-keys.md) - Manage ssh-keys resources diff --git a/docs/equinix_metalv1_ssh-keys_update-ssh-key.md b/docs/equinix_metalv1_ssh-keys_update-ssh-key.md new file mode 100644 index 0000000..23d401a --- /dev/null +++ b/docs/equinix_metalv1_ssh-keys_update-ssh-key.md @@ -0,0 +1,39 @@ +## equinix metalv1 ssh-keys update-ssh-key + +Update the ssh key + +### Synopsis + +Updates the ssh key. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ssh-keys update-ssh-key [flags] +``` + +### Options + +``` + -h, --help help for update-ssh-key + --id string SSH Key UUID (required) + --include string include field (JSON or string) + --request string JSON payload for additional optional fields not exposed as flags + --ssh-key-input-additional-properties string ssh-key-input-additional-properties (JSON) + --ssh-key-input-key string ssh-key-input-key + --ssh-key-input-label string ssh-key-input-label + --ssh-key-input-tags string ssh-key-input-tags (JSON array) +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 ssh-keys](equinix_metalv1_ssh-keys.md) - Manage ssh-keys resources + diff --git a/docs/equinix_metalv1_v-l-a-ns.md b/docs/equinix_metalv1_v-l-a-ns.md deleted file mode 100644 index 155d6e3..0000000 --- a/docs/equinix_metalv1_v-l-a-ns.md +++ /dev/null @@ -1,31 +0,0 @@ -## equinix metalv1 v-l-a-ns - -Manage v-l-a-ns resources - -### Synopsis - -Commands for managing v-l-a-ns resources in the API - -### Options - -``` - -h, --help help for v-l-a-ns -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1](equinix_metalv1.md) - Manage Equinix metalv1 resources -* [equinix metalv1 v-l-a-ns create-virtual-network](equinix_metalv1_v-l-a-ns_create-virtual-network.md) - Execute create-virtual-network operation -* [equinix metalv1 v-l-a-ns delete-virtual-network](equinix_metalv1_v-l-a-ns_delete-virtual-network.md) - Execute delete-virtual-network operation -* [equinix metalv1 v-l-a-ns find-virtual-networks](equinix_metalv1_v-l-a-ns_find-virtual-networks.md) - Execute find-virtual-networks operation -* [equinix metalv1 v-l-a-ns get-virtual-network](equinix_metalv1_v-l-a-ns_get-virtual-network.md) - Execute get-virtual-network operation -* [equinix metalv1 v-l-a-ns update-virtual-network](equinix_metalv1_v-l-a-ns_update-virtual-network.md) - Execute update-virtual-network operation - diff --git a/docs/equinix_metalv1_v-l-a-ns_delete-virtual-network.md b/docs/equinix_metalv1_v-l-a-ns_delete-virtual-network.md deleted file mode 100644 index 4df7ca6..0000000 --- a/docs/equinix_metalv1_v-l-a-ns_delete-virtual-network.md +++ /dev/null @@ -1,39 +0,0 @@ -## equinix metalv1 v-l-a-ns delete-virtual-network - -Execute delete-virtual-network operation - -### Synopsis - -Execute the delete-virtual-network operation on this service. - -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. - -``` -equinix metalv1 v-l-a-ns delete-virtual-network [flags] -``` - -### Options - -``` - --exclude string exclude field (JSON or string) - -h, --help help for delete-virtual-network - --include string include field (JSON or string) - --network-id string network-id (required) - --request string JSON payload for additional optional fields not exposed as flags -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 v-l-a-ns](equinix_metalv1_v-l-a-ns.md) - Manage v-l-a-ns resources - diff --git a/docs/equinix_metalv1_v-l-a-ns_find-virtual-networks.md b/docs/equinix_metalv1_v-l-a-ns_find-virtual-networks.md deleted file mode 100644 index 6a31379..0000000 --- a/docs/equinix_metalv1_v-l-a-ns_find-virtual-networks.md +++ /dev/null @@ -1,41 +0,0 @@ -## equinix metalv1 v-l-a-ns find-virtual-networks - -Execute find-virtual-networks operation - -### Synopsis - -Execute the find-virtual-networks operation on this service. - -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. - -``` -equinix metalv1 v-l-a-ns find-virtual-networks [flags] -``` - -### Options - -``` - --exclude string exclude field (JSON or string) - --facility string facility field - -h, --help help for find-virtual-networks - --include string include field (JSON or string) - --metro string metro field - --network-id string network-id (required) - --request string JSON payload for additional optional fields not exposed as flags -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 v-l-a-ns](equinix_metalv1_v-l-a-ns.md) - Manage v-l-a-ns resources - diff --git a/docs/equinix_metalv1_v-l-a-ns_get-virtual-network.md b/docs/equinix_metalv1_v-l-a-ns_get-virtual-network.md deleted file mode 100644 index 73ef0de..0000000 --- a/docs/equinix_metalv1_v-l-a-ns_get-virtual-network.md +++ /dev/null @@ -1,39 +0,0 @@ -## equinix metalv1 v-l-a-ns get-virtual-network - -Execute get-virtual-network operation - -### Synopsis - -Execute the get-virtual-network operation on this service. - -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. - -``` -equinix metalv1 v-l-a-ns get-virtual-network [flags] -``` - -### Options - -``` - --exclude string exclude field (JSON or string) - -h, --help help for get-virtual-network - --include string include field (JSON or string) - --network-id string network-id (required) - --request string JSON payload for additional optional fields not exposed as flags -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 v-l-a-ns](equinix_metalv1_v-l-a-ns.md) - Manage v-l-a-ns resources - diff --git a/docs/equinix_metalv1_v-r-fs.md b/docs/equinix_metalv1_v-r-fs.md deleted file mode 100644 index bb7a968..0000000 --- a/docs/equinix_metalv1_v-r-fs.md +++ /dev/null @@ -1,42 +0,0 @@ -## equinix metalv1 v-r-fs - -Manage v-r-fs resources - -### Synopsis - -Commands for managing v-r-fs resources in the API - -### Options - -``` - -h, --help help for v-r-fs -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1](equinix_metalv1.md) - Manage Equinix metalv1 resources -* [equinix metalv1 v-r-fs bgp-dynamic-neighbors-id-get](equinix_metalv1_v-r-fs_bgp-dynamic-neighbors-id-get.md) - Execute bgp-dynamic-neighbors-id-get operation -* [equinix metalv1 v-r-fs create-vrf](equinix_metalv1_v-r-fs_create-vrf.md) - Execute create-vrf operation -* [equinix metalv1 v-r-fs create-vrf-route](equinix_metalv1_v-r-fs_create-vrf-route.md) - Execute create-vrf-route operation -* [equinix metalv1 v-r-fs delete-bgp-dynamic-neighbor-by-id](equinix_metalv1_v-r-fs_delete-bgp-dynamic-neighbor-by-id.md) - Execute delete-bgp-dynamic-neighbor-by-id operation -* [equinix metalv1 v-r-fs delete-vrf](equinix_metalv1_v-r-fs_delete-vrf.md) - Execute delete-vrf operation -* [equinix metalv1 v-r-fs delete-vrf-route-by-id](equinix_metalv1_v-r-fs_delete-vrf-route-by-id.md) - Execute delete-vrf-route-by-id operation -* [equinix metalv1 v-r-fs find-vrf-by-id](equinix_metalv1_v-r-fs_find-vrf-by-id.md) - Execute find-vrf-by-id operation -* [equinix metalv1 v-r-fs find-vrf-ip-reservation](equinix_metalv1_v-r-fs_find-vrf-ip-reservation.md) - Execute find-vrf-ip-reservation operation -* [equinix metalv1 v-r-fs find-vrf-ip-reservations](equinix_metalv1_v-r-fs_find-vrf-ip-reservations.md) - Execute find-vrf-ip-reservations operation -* [equinix metalv1 v-r-fs find-vrf-route-by-id](equinix_metalv1_v-r-fs_find-vrf-route-by-id.md) - Execute find-vrf-route-by-id operation -* [equinix metalv1 v-r-fs find-vrfs](equinix_metalv1_v-r-fs_find-vrfs.md) - Execute find-vrfs operation -* [equinix metalv1 v-r-fs get-vrf-b-g-p-neighbors](equinix_metalv1_v-r-fs_get-vrf-b-g-p-neighbors.md) - Execute get-vrf-b-g-p-neighbors operation -* [equinix metalv1 v-r-fs get-vrf-learned-routes](equinix_metalv1_v-r-fs_get-vrf-learned-routes.md) - Execute get-vrf-learned-routes operation -* [equinix metalv1 v-r-fs get-vrf-routes](equinix_metalv1_v-r-fs_get-vrf-routes.md) - Execute get-vrf-routes operation -* [equinix metalv1 v-r-fs update-vrf](equinix_metalv1_v-r-fs_update-vrf.md) - Execute update-vrf operation -* [equinix metalv1 v-r-fs update-vrf-route-by-id](equinix_metalv1_v-r-fs_update-vrf-route-by-id.md) - Execute update-vrf-route-by-id operation - diff --git a/docs/equinix_metalv1_v-r-fs_delete-vrf.md b/docs/equinix_metalv1_v-r-fs_delete-vrf.md deleted file mode 100644 index a52057b..0000000 --- a/docs/equinix_metalv1_v-r-fs_delete-vrf.md +++ /dev/null @@ -1,37 +0,0 @@ -## equinix metalv1 v-r-fs delete-vrf - -Execute delete-vrf operation - -### Synopsis - -Execute the delete-vrf operation on this service. - -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. - -``` -equinix metalv1 v-r-fs delete-vrf [flags] -``` - -### Options - -``` - -h, --help help for delete-vrf - --param-1 string param-1 (required) - --request string JSON payload for request body fields -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources - diff --git a/docs/equinix_metalv1_v-r-fs_get-vrf-b-g-p-neighbors.md b/docs/equinix_metalv1_v-r-fs_get-vrf-b-g-p-neighbors.md deleted file mode 100644 index 1a21a3c..0000000 --- a/docs/equinix_metalv1_v-r-fs_get-vrf-b-g-p-neighbors.md +++ /dev/null @@ -1,37 +0,0 @@ -## equinix metalv1 v-r-fs get-vrf-b-g-p-neighbors - -Execute get-vrf-b-g-p-neighbors operation - -### Synopsis - -Execute the get-vrf-b-g-p-neighbors operation on this service. - -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. - -``` -equinix metalv1 v-r-fs get-vrf-b-g-p-neighbors [flags] -``` - -### Options - -``` - -h, --help help for get-vrf-b-g-p-neighbors - --param-1 string param-1 (required) - --request string JSON payload for request body fields -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources - diff --git a/docs/equinix_metalv1_v-r-fs_get-vrf-learned-routes.md b/docs/equinix_metalv1_v-r-fs_get-vrf-learned-routes.md deleted file mode 100644 index 8305488..0000000 --- a/docs/equinix_metalv1_v-r-fs_get-vrf-learned-routes.md +++ /dev/null @@ -1,37 +0,0 @@ -## equinix metalv1 v-r-fs get-vrf-learned-routes - -Execute get-vrf-learned-routes operation - -### Synopsis - -Execute the get-vrf-learned-routes operation on this service. - -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. - -``` -equinix metalv1 v-r-fs get-vrf-learned-routes [flags] -``` - -### Options - -``` - -h, --help help for get-vrf-learned-routes - --param-1 string param-1 (required) - --request string JSON payload for request body fields -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix metalv1 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources - diff --git a/docs/equinix_metalv1_vlans.md b/docs/equinix_metalv1_vlans.md new file mode 100644 index 0000000..ef28df5 --- /dev/null +++ b/docs/equinix_metalv1_vlans.md @@ -0,0 +1,31 @@ +## equinix metalv1 vlans + +Manage vlans resources + +### Synopsis + +Commands for managing vlans resources in the API + +### Options + +``` + -h, --help help for vlans +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1](equinix_metalv1.md) - Manage Equinix metalv1 resources +* [equinix metalv1 vlans create-virtual-network](equinix_metalv1_vlans_create-virtual-network.md) - Create a virtual network +* [equinix metalv1 vlans delete-virtual-network](equinix_metalv1_vlans_delete-virtual-network.md) - Delete a virtual network +* [equinix metalv1 vlans find-virtual-networks](equinix_metalv1_vlans_find-virtual-networks.md) - Retrieve all virtual networks +* [equinix metalv1 vlans get-virtual-network](equinix_metalv1_vlans_get-virtual-network.md) - Get a virtual network +* [equinix metalv1 vlans update-virtual-network](equinix_metalv1_vlans_update-virtual-network.md) - Updates the virtual network + diff --git a/docs/equinix_metalv1_v-l-a-ns_create-virtual-network.md b/docs/equinix_metalv1_vlans_create-virtual-network.md similarity index 76% rename from docs/equinix_metalv1_v-l-a-ns_create-virtual-network.md rename to docs/equinix_metalv1_vlans_create-virtual-network.md index 4666e86..2670fb5 100644 --- a/docs/equinix_metalv1_v-l-a-ns_create-virtual-network.md +++ b/docs/equinix_metalv1_vlans_create-virtual-network.md @@ -1,18 +1,15 @@ -## equinix metalv1 v-l-a-ns create-virtual-network +## equinix metalv1 vlans create-virtual-network -Execute create-virtual-network operation +Create a virtual network ### Synopsis -Execute the create-virtual-network operation on this service. +Creates an virtual network. -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. +Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 v-l-a-ns create-virtual-network [flags] +equinix metalv1 vlans create-virtual-network [flags] ``` ### Options @@ -20,8 +17,8 @@ equinix metalv1 v-l-a-ns create-virtual-network [flags] ``` --exclude string exclude field (JSON or string) -h, --help help for create-virtual-network + --id string Project UUID (required) --include string include field (JSON or string) - --network-id string network-id (required) --request string JSON payload for additional optional fields not exposed as flags --virtual-network-create-input-additional-properties string virtual-network-create-input-additional-properties (JSON) --virtual-network-create-input-description string virtual-network-create-input-description @@ -42,5 +39,5 @@ equinix metalv1 v-l-a-ns create-virtual-network [flags] ### SEE ALSO -* [equinix metalv1 v-l-a-ns](equinix_metalv1_v-l-a-ns.md) - Manage v-l-a-ns resources +* [equinix metalv1 vlans](equinix_metalv1_vlans.md) - Manage vlans resources diff --git a/docs/equinix_metalv1_vlans_delete-virtual-network.md b/docs/equinix_metalv1_vlans_delete-virtual-network.md new file mode 100644 index 0000000..a9d5a4b --- /dev/null +++ b/docs/equinix_metalv1_vlans_delete-virtual-network.md @@ -0,0 +1,36 @@ +## equinix metalv1 vlans delete-virtual-network + +Delete a virtual network + +### Synopsis + +Deletes a virtual network. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 vlans delete-virtual-network [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for delete-virtual-network + --id string Virtual Network UUID (required) + --include string include field (JSON or string) + --request string JSON payload for additional optional fields not exposed as flags +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 vlans](equinix_metalv1_vlans.md) - Manage vlans resources + diff --git a/docs/equinix_metalv1_vlans_find-virtual-networks.md b/docs/equinix_metalv1_vlans_find-virtual-networks.md new file mode 100644 index 0000000..b9bd005 --- /dev/null +++ b/docs/equinix_metalv1_vlans_find-virtual-networks.md @@ -0,0 +1,38 @@ +## equinix metalv1 vlans find-virtual-networks + +Retrieve all virtual networks + +### Synopsis + +Provides a list of virtual networks for a single project. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 vlans find-virtual-networks [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + --facility string facility field + -h, --help help for find-virtual-networks + --id string Project UUID (required) + --include string include field (JSON or string) + --metro string metro field + --request string JSON payload for additional optional fields not exposed as flags +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 vlans](equinix_metalv1_vlans.md) - Manage vlans resources + diff --git a/docs/equinix_metalv1_vlans_get-virtual-network.md b/docs/equinix_metalv1_vlans_get-virtual-network.md new file mode 100644 index 0000000..9046a83 --- /dev/null +++ b/docs/equinix_metalv1_vlans_get-virtual-network.md @@ -0,0 +1,36 @@ +## equinix metalv1 vlans get-virtual-network + +Get a virtual network + +### Synopsis + +Get a virtual network. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 vlans get-virtual-network [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for get-virtual-network + --id string Virtual Network UUID (required) + --include string include field (JSON or string) + --request string JSON payload for additional optional fields not exposed as flags +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 vlans](equinix_metalv1_vlans.md) - Manage vlans resources + diff --git a/docs/equinix_metalv1_v-l-a-ns_update-virtual-network.md b/docs/equinix_metalv1_vlans_update-virtual-network.md similarity index 66% rename from docs/equinix_metalv1_v-l-a-ns_update-virtual-network.md rename to docs/equinix_metalv1_vlans_update-virtual-network.md index df48c1e..233affd 100644 --- a/docs/equinix_metalv1_v-l-a-ns_update-virtual-network.md +++ b/docs/equinix_metalv1_vlans_update-virtual-network.md @@ -1,18 +1,15 @@ -## equinix metalv1 v-l-a-ns update-virtual-network +## equinix metalv1 vlans update-virtual-network -Execute update-virtual-network operation +Updates the virtual network ### Synopsis -Execute the update-virtual-network operation on this service. +Updates the virtual network. -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. +Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 v-l-a-ns update-virtual-network [flags] +equinix metalv1 vlans update-virtual-network [flags] ``` ### Options @@ -20,8 +17,8 @@ equinix metalv1 v-l-a-ns update-virtual-network [flags] ``` --exclude string exclude field (JSON or string) -h, --help help for update-virtual-network + --id string Virtual Network UUID (required) --include string include field (JSON or string) - --network-id string network-id (required) --request string JSON payload for additional optional fields not exposed as flags --virtual-network-update-input-additional-properties string virtual-network-update-input-additional-properties (JSON) --virtual-network-update-input-description string virtual-network-update-input-description @@ -38,5 +35,5 @@ equinix metalv1 v-l-a-ns update-virtual-network [flags] ### SEE ALSO -* [equinix metalv1 v-l-a-ns](equinix_metalv1_v-l-a-ns.md) - Manage v-l-a-ns resources +* [equinix metalv1 vlans](equinix_metalv1_vlans.md) - Manage vlans resources diff --git a/docs/equinix_metalv1_vrfs.md b/docs/equinix_metalv1_vrfs.md new file mode 100644 index 0000000..d0dcba9 --- /dev/null +++ b/docs/equinix_metalv1_vrfs.md @@ -0,0 +1,42 @@ +## equinix metalv1 vrfs + +Manage vrfs resources + +### Synopsis + +Commands for managing vrfs resources in the API + +### Options + +``` + -h, --help help for vrfs +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1](equinix_metalv1.md) - Manage Equinix metalv1 resources +* [equinix metalv1 vrfs bgp-dynamic-neighbors-id-get](equinix_metalv1_vrfs_bgp-dynamic-neighbors-id-get.md) - Retrieve a BGP Dynamic Neighbor +* [equinix metalv1 vrfs create-vrf](equinix_metalv1_vrfs_create-vrf.md) - Create a new VRF in the specified project +* [equinix metalv1 vrfs create-vrf-route](equinix_metalv1_vrfs_create-vrf-route.md) - Create a VRF route +* [equinix metalv1 vrfs delete-bgp-dynamic-neighbor-by-id](equinix_metalv1_vrfs_delete-bgp-dynamic-neighbor-by-id.md) - Delete a VRF BGP Dynamic Neighbor +* [equinix metalv1 vrfs delete-vrf](equinix_metalv1_vrfs_delete-vrf.md) - Delete the VRF +* [equinix metalv1 vrfs delete-vrf-route-by-id](equinix_metalv1_vrfs_delete-vrf-route-by-id.md) - Delete a VRF Route +* [equinix metalv1 vrfs find-vrf-by-id](equinix_metalv1_vrfs_find-vrf-by-id.md) - Retrieve a VRF +* [equinix metalv1 vrfs find-vrf-ip-reservation](equinix_metalv1_vrfs_find-vrf-ip-reservation.md) - Retrieve the Specified VRF IP Reservation +* [equinix metalv1 vrfs find-vrf-ip-reservations](equinix_metalv1_vrfs_find-vrf-ip-reservations.md) - Retrieve all VRF IP Reservations in the VRF +* [equinix metalv1 vrfs find-vrf-route-by-id](equinix_metalv1_vrfs_find-vrf-route-by-id.md) - Retrieve a VRF Route +* [equinix metalv1 vrfs find-vrfs](equinix_metalv1_vrfs_find-vrfs.md) - Retrieve all VRFs in the project +* [equinix metalv1 vrfs get-vrf-bgp-neighbors](equinix_metalv1_vrfs_get-vrf-bgp-neighbors.md) - Retrieve BGP neighbor states for the VRF +* [equinix metalv1 vrfs get-vrf-learned-routes](equinix_metalv1_vrfs_get-vrf-learned-routes.md) - Retrieve learned L3 routes within the VRF +* [equinix metalv1 vrfs get-vrf-routes](equinix_metalv1_vrfs_get-vrf-routes.md) - Retrieve all routes in the VRF +* [equinix metalv1 vrfs update-vrf](equinix_metalv1_vrfs_update-vrf.md) - Update the VRF +* [equinix metalv1 vrfs update-vrf-route-by-id](equinix_metalv1_vrfs_update-vrf-route-by-id.md) - Update a VRF Route + diff --git a/docs/equinix_metalv1_v-r-fs_bgp-dynamic-neighbors-id-get.md b/docs/equinix_metalv1_vrfs_bgp-dynamic-neighbors-id-get.md similarity index 53% rename from docs/equinix_metalv1_v-r-fs_bgp-dynamic-neighbors-id-get.md rename to docs/equinix_metalv1_vrfs_bgp-dynamic-neighbors-id-get.md index 81d21d5..b6a17c6 100644 --- a/docs/equinix_metalv1_v-r-fs_bgp-dynamic-neighbors-id-get.md +++ b/docs/equinix_metalv1_vrfs_bgp-dynamic-neighbors-id-get.md @@ -1,18 +1,15 @@ -## equinix metalv1 v-r-fs bgp-dynamic-neighbors-id-get +## equinix metalv1 vrfs bgp-dynamic-neighbors-id-get -Execute bgp-dynamic-neighbors-id-get operation +Retrieve a BGP Dynamic Neighbor ### Synopsis -Execute the bgp-dynamic-neighbors-id-get operation on this service. +Return a single BGP Dynamic Neighbor resource -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. +Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 v-r-fs bgp-dynamic-neighbors-id-get [flags] +equinix metalv1 vrfs bgp-dynamic-neighbors-id-get [flags] ``` ### Options @@ -20,8 +17,8 @@ equinix metalv1 v-r-fs bgp-dynamic-neighbors-id-get [flags] ``` --exclude string exclude field (JSON or string) -h, --help help for bgp-dynamic-neighbors-id-get + --id string BGP Dynamic Neighbor UUID (required) --include string include field (JSON or string) - --param-1 string param-1 (required) --request string JSON payload for additional optional fields not exposed as flags ``` @@ -35,5 +32,5 @@ equinix metalv1 v-r-fs bgp-dynamic-neighbors-id-get [flags] ### SEE ALSO -* [equinix metalv1 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources +* [equinix metalv1 vrfs](equinix_metalv1_vrfs.md) - Manage vrfs resources diff --git a/docs/equinix_metalv1_v-r-fs_create-vrf-route.md b/docs/equinix_metalv1_vrfs_create-vrf-route.md similarity index 71% rename from docs/equinix_metalv1_v-r-fs_create-vrf-route.md rename to docs/equinix_metalv1_vrfs_create-vrf-route.md index c2fb268..1c86ec6 100644 --- a/docs/equinix_metalv1_v-r-fs_create-vrf-route.md +++ b/docs/equinix_metalv1_vrfs_create-vrf-route.md @@ -1,18 +1,15 @@ -## equinix metalv1 v-r-fs create-vrf-route +## equinix metalv1 vrfs create-vrf-route -Execute create-vrf-route operation +Create a VRF route ### Synopsis -Execute the create-vrf-route operation on this service. +Create a route in a VRF. Currently only static default routes are supported. -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. +Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 v-r-fs create-vrf-route [flags] +equinix metalv1 vrfs create-vrf-route [flags] ``` ### Options @@ -20,8 +17,8 @@ equinix metalv1 v-r-fs create-vrf-route [flags] ``` --exclude string exclude field (JSON or string) -h, --help help for create-vrf-route + --id string VRF UUID (required) --include string include field (JSON or string) - --param-1 string param-1 (required) --request string JSON payload for additional optional fields not exposed as flags --vrf-route-create-input-additional-properties string vrf-route-create-input-additional-properties (JSON) --vrf-route-create-input-next_hop string The IPv4 address within the VRF of the host that will handle this route @@ -39,5 +36,5 @@ equinix metalv1 v-r-fs create-vrf-route [flags] ### SEE ALSO -* [equinix metalv1 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources +* [equinix metalv1 vrfs](equinix_metalv1_vrfs.md) - Manage vrfs resources diff --git a/docs/equinix_metalv1_v-r-fs_create-vrf.md b/docs/equinix_metalv1_vrfs_create-vrf.md similarity index 81% rename from docs/equinix_metalv1_v-r-fs_create-vrf.md rename to docs/equinix_metalv1_vrfs_create-vrf.md index de7cfca..1d2b1fd 100644 --- a/docs/equinix_metalv1_v-r-fs_create-vrf.md +++ b/docs/equinix_metalv1_vrfs_create-vrf.md @@ -1,18 +1,15 @@ -## equinix metalv1 v-r-fs create-vrf +## equinix metalv1 vrfs create-vrf -Execute create-vrf operation +Create a new VRF in the specified project ### Synopsis -Execute the create-vrf operation on this service. +Creates a new VRF in the specified project -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. +Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 v-r-fs create-vrf [flags] +equinix metalv1 vrfs create-vrf [flags] ``` ### Options @@ -20,8 +17,8 @@ equinix metalv1 v-r-fs create-vrf [flags] ``` --exclude string exclude field (JSON or string) -h, --help help for create-vrf + --id string Project UUID (required) --include string include field (JSON or string) - --param-1 string param-1 (required) --request string JSON payload for additional optional fields not exposed as flags --vrf-create-input-additional-properties string vrf-create-input-additional-properties (JSON) --vrf-create-input-bgp_dynamic_neighbors_bfd_enabled Toggle BFD on dynamic bgp neighbors sessions @@ -45,5 +42,5 @@ equinix metalv1 v-r-fs create-vrf [flags] ### SEE ALSO -* [equinix metalv1 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources +* [equinix metalv1 vrfs](equinix_metalv1_vrfs.md) - Manage vrfs resources diff --git a/docs/equinix_metalv1_v-r-fs_delete-bgp-dynamic-neighbor-by-id.md b/docs/equinix_metalv1_vrfs_delete-bgp-dynamic-neighbor-by-id.md similarity index 53% rename from docs/equinix_metalv1_v-r-fs_delete-bgp-dynamic-neighbor-by-id.md rename to docs/equinix_metalv1_vrfs_delete-bgp-dynamic-neighbor-by-id.md index f11e088..1ab5762 100644 --- a/docs/equinix_metalv1_v-r-fs_delete-bgp-dynamic-neighbor-by-id.md +++ b/docs/equinix_metalv1_vrfs_delete-bgp-dynamic-neighbor-by-id.md @@ -1,18 +1,15 @@ -## equinix metalv1 v-r-fs delete-bgp-dynamic-neighbor-by-id +## equinix metalv1 vrfs delete-bgp-dynamic-neighbor-by-id -Execute delete-bgp-dynamic-neighbor-by-id operation +Delete a VRF BGP Dynamic Neighbor ### Synopsis -Execute the delete-bgp-dynamic-neighbor-by-id operation on this service. +Trigger the removal of a BGP Neighbor range from a VRF -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. +Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 v-r-fs delete-bgp-dynamic-neighbor-by-id [flags] +equinix metalv1 vrfs delete-bgp-dynamic-neighbor-by-id [flags] ``` ### Options @@ -20,7 +17,7 @@ equinix metalv1 v-r-fs delete-bgp-dynamic-neighbor-by-id [flags] ``` --exclude string exclude field (JSON or string) -h, --help help for delete-bgp-dynamic-neighbor-by-id - --id string id (required) + --id string BGP Dynamic Neighbor UUID (required) --include string include field (JSON or string) --request string JSON payload for additional optional fields not exposed as flags ``` @@ -35,5 +32,5 @@ equinix metalv1 v-r-fs delete-bgp-dynamic-neighbor-by-id [flags] ### SEE ALSO -* [equinix metalv1 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources +* [equinix metalv1 vrfs](equinix_metalv1_vrfs.md) - Manage vrfs resources diff --git a/docs/equinix_metalv1_v-r-fs_delete-vrf-route-by-id.md b/docs/equinix_metalv1_vrfs_delete-vrf-route-by-id.md similarity index 50% rename from docs/equinix_metalv1_v-r-fs_delete-vrf-route-by-id.md rename to docs/equinix_metalv1_vrfs_delete-vrf-route-by-id.md index 1c3b14c..7f73cf6 100644 --- a/docs/equinix_metalv1_v-r-fs_delete-vrf-route-by-id.md +++ b/docs/equinix_metalv1_vrfs_delete-vrf-route-by-id.md @@ -1,18 +1,15 @@ -## equinix metalv1 v-r-fs delete-vrf-route-by-id +## equinix metalv1 vrfs delete-vrf-route-by-id -Execute delete-vrf-route-by-id operation +Delete a VRF Route ### Synopsis -Execute the delete-vrf-route-by-id operation on this service. +Trigger the deletion of a VRF Route resource. The status of the route will update to 'deleting', and the route resource will remain accessible while background operations remove the route from the network. Once the route has been removed from the network, the resource will be fully deleted. -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. +Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 v-r-fs delete-vrf-route-by-id [flags] +equinix metalv1 vrfs delete-vrf-route-by-id [flags] ``` ### Options @@ -20,7 +17,7 @@ equinix metalv1 v-r-fs delete-vrf-route-by-id [flags] ``` --exclude string exclude field (JSON or string) -h, --help help for delete-vrf-route-by-id - --id string id (required) + --id string VRF Route UUID (required) --include string include field (JSON or string) --request string JSON payload for additional optional fields not exposed as flags ``` @@ -35,5 +32,5 @@ equinix metalv1 v-r-fs delete-vrf-route-by-id [flags] ### SEE ALSO -* [equinix metalv1 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources +* [equinix metalv1 vrfs](equinix_metalv1_vrfs.md) - Manage vrfs resources diff --git a/docs/equinix_metalv1_vrfs_delete-vrf.md b/docs/equinix_metalv1_vrfs_delete-vrf.md new file mode 100644 index 0000000..275ef72 --- /dev/null +++ b/docs/equinix_metalv1_vrfs_delete-vrf.md @@ -0,0 +1,34 @@ +## equinix metalv1 vrfs delete-vrf + +Delete the VRF + +### Synopsis + +Deletes the VRF + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 vrfs delete-vrf [flags] +``` + +### Options + +``` + -h, --help help for delete-vrf + --id string VRF UUID (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 vrfs](equinix_metalv1_vrfs.md) - Manage vrfs resources + diff --git a/docs/equinix_metalv1_v-r-fs_find-vrf-by-id.md b/docs/equinix_metalv1_vrfs_find-vrf-by-id.md similarity index 56% rename from docs/equinix_metalv1_v-r-fs_find-vrf-by-id.md rename to docs/equinix_metalv1_vrfs_find-vrf-by-id.md index 7eae843..36600bc 100644 --- a/docs/equinix_metalv1_v-r-fs_find-vrf-by-id.md +++ b/docs/equinix_metalv1_vrfs_find-vrf-by-id.md @@ -1,18 +1,15 @@ -## equinix metalv1 v-r-fs find-vrf-by-id +## equinix metalv1 vrfs find-vrf-by-id -Execute find-vrf-by-id operation +Retrieve a VRF ### Synopsis -Execute the find-vrf-by-id operation on this service. +Returns a single VRF resource -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. +Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 v-r-fs find-vrf-by-id [flags] +equinix metalv1 vrfs find-vrf-by-id [flags] ``` ### Options @@ -20,7 +17,7 @@ equinix metalv1 v-r-fs find-vrf-by-id [flags] ``` --exclude string exclude field (JSON or string) -h, --help help for find-vrf-by-id - --id string id (required) + --id string VRF UUID (required) --include string include field (JSON or string) --request string JSON payload for additional optional fields not exposed as flags ``` @@ -35,5 +32,5 @@ equinix metalv1 v-r-fs find-vrf-by-id [flags] ### SEE ALSO -* [equinix metalv1 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources +* [equinix metalv1 vrfs](equinix_metalv1_vrfs.md) - Manage vrfs resources diff --git a/docs/equinix_metalv1_v-r-fs_find-vrf-ip-reservation.md b/docs/equinix_metalv1_vrfs_find-vrf-ip-reservation.md similarity index 52% rename from docs/equinix_metalv1_v-r-fs_find-vrf-ip-reservation.md rename to docs/equinix_metalv1_vrfs_find-vrf-ip-reservation.md index 876535f..d5aafe2 100644 --- a/docs/equinix_metalv1_v-r-fs_find-vrf-ip-reservation.md +++ b/docs/equinix_metalv1_vrfs_find-vrf-ip-reservation.md @@ -1,18 +1,15 @@ -## equinix metalv1 v-r-fs find-vrf-ip-reservation +## equinix metalv1 vrfs find-vrf-ip-reservation -Execute find-vrf-ip-reservation operation +Retrieve the Specified VRF IP Reservation ### Synopsis -Execute the find-vrf-ip-reservation operation on this service. +Returns the specified IP Reservation for the VRF. -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. +Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 v-r-fs find-vrf-ip-reservation [flags] +equinix metalv1 vrfs find-vrf-ip-reservation [flags] ``` ### Options @@ -20,10 +17,10 @@ equinix metalv1 v-r-fs find-vrf-ip-reservation [flags] ``` --exclude string exclude field (JSON or string) -h, --help help for find-vrf-ip-reservation + --id string IP UUID (required) --include string include field (JSON or string) - --param-1 string param-1 (required) - --param-2 string param-2 (required) --request string JSON payload for additional optional fields not exposed as flags + --vrf-id string VRF UUID (required) ``` ### Options inherited from parent commands @@ -36,5 +33,5 @@ equinix metalv1 v-r-fs find-vrf-ip-reservation [flags] ### SEE ALSO -* [equinix metalv1 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources +* [equinix metalv1 vrfs](equinix_metalv1_vrfs.md) - Manage vrfs resources diff --git a/docs/equinix_metalv1_v-r-fs_find-vrf-ip-reservations.md b/docs/equinix_metalv1_vrfs_find-vrf-ip-reservations.md similarity index 54% rename from docs/equinix_metalv1_v-r-fs_find-vrf-ip-reservations.md rename to docs/equinix_metalv1_vrfs_find-vrf-ip-reservations.md index f8dc741..71c251c 100644 --- a/docs/equinix_metalv1_v-r-fs_find-vrf-ip-reservations.md +++ b/docs/equinix_metalv1_vrfs_find-vrf-ip-reservations.md @@ -1,18 +1,15 @@ -## equinix metalv1 v-r-fs find-vrf-ip-reservations +## equinix metalv1 vrfs find-vrf-ip-reservations -Execute find-vrf-ip-reservations operation +Retrieve all VRF IP Reservations in the VRF ### Synopsis -Execute the find-vrf-ip-reservations operation on this service. +Returns the list of VRF IP Reservations for the VRF. -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. +Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 v-r-fs find-vrf-ip-reservations [flags] +equinix metalv1 vrfs find-vrf-ip-reservations [flags] ``` ### Options @@ -20,8 +17,8 @@ equinix metalv1 v-r-fs find-vrf-ip-reservations [flags] ``` --exclude string exclude field (JSON or string) -h, --help help for find-vrf-ip-reservations + --id string VRF UUID (required) --include string include field (JSON or string) - --param-1 string param-1 (required) --request string JSON payload for additional optional fields not exposed as flags ``` @@ -35,5 +32,5 @@ equinix metalv1 v-r-fs find-vrf-ip-reservations [flags] ### SEE ALSO -* [equinix metalv1 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources +* [equinix metalv1 vrfs](equinix_metalv1_vrfs.md) - Manage vrfs resources diff --git a/docs/equinix_metalv1_v-r-fs_find-vrf-route-by-id.md b/docs/equinix_metalv1_vrfs_find-vrf-route-by-id.md similarity index 55% rename from docs/equinix_metalv1_v-r-fs_find-vrf-route-by-id.md rename to docs/equinix_metalv1_vrfs_find-vrf-route-by-id.md index 6cbc968..212f09a 100644 --- a/docs/equinix_metalv1_v-r-fs_find-vrf-route-by-id.md +++ b/docs/equinix_metalv1_vrfs_find-vrf-route-by-id.md @@ -1,18 +1,15 @@ -## equinix metalv1 v-r-fs find-vrf-route-by-id +## equinix metalv1 vrfs find-vrf-route-by-id -Execute find-vrf-route-by-id operation +Retrieve a VRF Route ### Synopsis -Execute the find-vrf-route-by-id operation on this service. +Returns a single VRF Route resource -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. +Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 v-r-fs find-vrf-route-by-id [flags] +equinix metalv1 vrfs find-vrf-route-by-id [flags] ``` ### Options @@ -20,7 +17,7 @@ equinix metalv1 v-r-fs find-vrf-route-by-id [flags] ``` --exclude string exclude field (JSON or string) -h, --help help for find-vrf-route-by-id - --id string id (required) + --id string VRF Route UUID (required) --include string include field (JSON or string) --request string JSON payload for additional optional fields not exposed as flags ``` @@ -35,5 +32,5 @@ equinix metalv1 v-r-fs find-vrf-route-by-id [flags] ### SEE ALSO -* [equinix metalv1 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources +* [equinix metalv1 vrfs](equinix_metalv1_vrfs.md) - Manage vrfs resources diff --git a/docs/equinix_metalv1_v-r-fs_find-vrfs.md b/docs/equinix_metalv1_vrfs_find-vrfs.md similarity index 58% rename from docs/equinix_metalv1_v-r-fs_find-vrfs.md rename to docs/equinix_metalv1_vrfs_find-vrfs.md index 4f4d9ca..a747228 100644 --- a/docs/equinix_metalv1_v-r-fs_find-vrfs.md +++ b/docs/equinix_metalv1_vrfs_find-vrfs.md @@ -1,18 +1,15 @@ -## equinix metalv1 v-r-fs find-vrfs +## equinix metalv1 vrfs find-vrfs -Execute find-vrfs operation +Retrieve all VRFs in the project ### Synopsis -Execute the find-vrfs operation on this service. +Returns the list of VRFs for a single project. -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. +Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 v-r-fs find-vrfs [flags] +equinix metalv1 vrfs find-vrfs [flags] ``` ### Options @@ -20,9 +17,9 @@ equinix metalv1 v-r-fs find-vrfs [flags] ``` --exclude string exclude field (JSON or string) -h, --help help for find-vrfs + --id string Project UUID (required) --include string include field (JSON or string) --metro string metro field - --param-1 string param-1 (required) --request string JSON payload for additional optional fields not exposed as flags ``` @@ -36,5 +33,5 @@ equinix metalv1 v-r-fs find-vrfs [flags] ### SEE ALSO -* [equinix metalv1 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources +* [equinix metalv1 vrfs](equinix_metalv1_vrfs.md) - Manage vrfs resources diff --git a/docs/equinix_metalv1_vrfs_get-vrf-bgp-neighbors.md b/docs/equinix_metalv1_vrfs_get-vrf-bgp-neighbors.md new file mode 100644 index 0000000..0643d10 --- /dev/null +++ b/docs/equinix_metalv1_vrfs_get-vrf-bgp-neighbors.md @@ -0,0 +1,34 @@ +## equinix metalv1 vrfs get-vrf-bgp-neighbors + +Retrieve BGP neighbor states for the VRF + +### Synopsis + +Provides BGP peering information such as the IP and state of the neighbor. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 vrfs get-vrf-bgp-neighbors [flags] +``` + +### Options + +``` + -h, --help help for get-vrf-bgp-neighbors + --id string VRF UUID (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 vrfs](equinix_metalv1_vrfs.md) - Manage vrfs resources + diff --git a/docs/equinix_metalv1_vrfs_get-vrf-learned-routes.md b/docs/equinix_metalv1_vrfs_get-vrf-learned-routes.md new file mode 100644 index 0000000..7924be8 --- /dev/null +++ b/docs/equinix_metalv1_vrfs_get-vrf-learned-routes.md @@ -0,0 +1,34 @@ +## equinix metalv1 vrfs get-vrf-learned-routes + +Retrieve learned L3 routes within the VRF + +### Synopsis + +Provides information about learned routes for the VRF. The VRF builds this information dynamically though BGP from other routers in the network. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 vrfs get-vrf-learned-routes [flags] +``` + +### Options + +``` + -h, --help help for get-vrf-learned-routes + --id string VRF UUID (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix metalv1 vrfs](equinix_metalv1_vrfs.md) - Manage vrfs resources + diff --git a/docs/equinix_metalv1_v-r-fs_get-vrf-routes.md b/docs/equinix_metalv1_vrfs_get-vrf-routes.md similarity index 55% rename from docs/equinix_metalv1_v-r-fs_get-vrf-routes.md rename to docs/equinix_metalv1_vrfs_get-vrf-routes.md index 610a58c..dfd2e14 100644 --- a/docs/equinix_metalv1_v-r-fs_get-vrf-routes.md +++ b/docs/equinix_metalv1_vrfs_get-vrf-routes.md @@ -1,18 +1,15 @@ -## equinix metalv1 v-r-fs get-vrf-routes +## equinix metalv1 vrfs get-vrf-routes -Execute get-vrf-routes operation +Retrieve all routes in the VRF ### Synopsis -Execute the get-vrf-routes operation on this service. +Returns the list of routes for the VRF -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. +Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 v-r-fs get-vrf-routes [flags] +equinix metalv1 vrfs get-vrf-routes [flags] ``` ### Options @@ -20,8 +17,8 @@ equinix metalv1 v-r-fs get-vrf-routes [flags] ``` --exclude string exclude field (JSON or string) -h, --help help for get-vrf-routes + --id string VRF UUID (required) --include string include field (JSON or string) - --param-1 string param-1 (required) --request string JSON payload for additional optional fields not exposed as flags ``` @@ -35,5 +32,5 @@ equinix metalv1 v-r-fs get-vrf-routes [flags] ### SEE ALSO -* [equinix metalv1 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources +* [equinix metalv1 vrfs](equinix_metalv1_vrfs.md) - Manage vrfs resources diff --git a/docs/equinix_metalv1_v-r-fs_update-vrf-route-by-id.md b/docs/equinix_metalv1_vrfs_update-vrf-route-by-id.md similarity index 70% rename from docs/equinix_metalv1_v-r-fs_update-vrf-route-by-id.md rename to docs/equinix_metalv1_vrfs_update-vrf-route-by-id.md index 3a2401d..f604eed 100644 --- a/docs/equinix_metalv1_v-r-fs_update-vrf-route-by-id.md +++ b/docs/equinix_metalv1_vrfs_update-vrf-route-by-id.md @@ -1,18 +1,15 @@ -## equinix metalv1 v-r-fs update-vrf-route-by-id +## equinix metalv1 vrfs update-vrf-route-by-id -Execute update-vrf-route-by-id operation +Update a VRF Route ### Synopsis -Execute the update-vrf-route-by-id operation on this service. +Requests a VRF Route be redeployed across the network. Updating the prefix or next-hop address on a route is not currently supported. -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. +Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 v-r-fs update-vrf-route-by-id [flags] +equinix metalv1 vrfs update-vrf-route-by-id [flags] ``` ### Options @@ -20,7 +17,7 @@ equinix metalv1 v-r-fs update-vrf-route-by-id [flags] ``` --exclude string exclude field (JSON or string) -h, --help help for update-vrf-route-by-id - --id string id (required) + --id string VRF Route UUID (required) --include string include field (JSON or string) --request string JSON payload for additional optional fields not exposed as flags --vrf-route-update-input-additional-properties string vrf-route-update-input-additional-properties (JSON) @@ -39,5 +36,5 @@ equinix metalv1 v-r-fs update-vrf-route-by-id [flags] ### SEE ALSO -* [equinix metalv1 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources +* [equinix metalv1 vrfs](equinix_metalv1_vrfs.md) - Manage vrfs resources diff --git a/docs/equinix_metalv1_v-r-fs_update-vrf.md b/docs/equinix_metalv1_vrfs_update-vrf.md similarity index 85% rename from docs/equinix_metalv1_v-r-fs_update-vrf.md rename to docs/equinix_metalv1_vrfs_update-vrf.md index e888cd1..9bf1c3d 100644 --- a/docs/equinix_metalv1_v-r-fs_update-vrf.md +++ b/docs/equinix_metalv1_vrfs_update-vrf.md @@ -1,18 +1,15 @@ -## equinix metalv1 v-r-fs update-vrf +## equinix metalv1 vrfs update-vrf -Execute update-vrf operation +Update the VRF ### Synopsis -Execute the update-vrf operation on this service. +Updates the VRF. -Use --request flag to provide a JSON payload for the request body. -Example: --request '{"field":"value"}' - -The command accepts parameters based on the SDK method signature. +Use --request flag to provide optional JSON payload fields. ``` -equinix metalv1 v-r-fs update-vrf [flags] +equinix metalv1 vrfs update-vrf [flags] ``` ### Options @@ -20,8 +17,8 @@ equinix metalv1 v-r-fs update-vrf [flags] ``` --exclude string exclude field (JSON or string) -h, --help help for update-vrf + --id string VRF UUID (required) --include string include field (JSON or string) - --param-1 string param-1 (required) --request string JSON payload for additional optional fields not exposed as flags --vrf-update-input-additional-properties string vrf-update-input-additional-properties (JSON) --vrf-update-input-bgp_dynamic_neighbors_bfd_enabled Toggle BFD on dynamic bgp neighbors sessions @@ -44,5 +41,5 @@ equinix metalv1 v-r-fs update-vrf [flags] ### SEE ALSO -* [equinix metalv1 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources +* [equinix metalv1 vrfs](equinix_metalv1_vrfs.md) - Manage vrfs resources diff --git a/docs/equinix_orderhistoryv1_retrieve-orders.md b/docs/equinix_orderhistoryv1_retrieve-orders.md index 51a3102..202f32c 100644 --- a/docs/equinix_orderhistoryv1_retrieve-orders.md +++ b/docs/equinix_orderhistoryv1_retrieve-orders.md @@ -23,6 +23,6 @@ Commands for managing retrieve-orders resources in the API ### SEE ALSO * [equinix orderhistoryv1](equinix_orderhistoryv1.md) - Manage Equinix orderhistoryv1 resources -* [equinix orderhistoryv1 retrieve-orders g-e-t-retrieve-orders-locations](equinix_orderhistoryv1_retrieve-orders_g-e-t-retrieve-orders-locations.md) - Retrieve order permissible IBX locations -* [equinix orderhistoryv1 retrieve-orders p-o-s-t-orders-history](equinix_orderhistoryv1_retrieve-orders_p-o-s-t-orders-history.md) - Search Orders History +* [equinix orderhistoryv1 retrieve-orders get-retrieve-orders-locations](equinix_orderhistoryv1_retrieve-orders_get-retrieve-orders-locations.md) - Retrieve order permissible IBX locations +* [equinix orderhistoryv1 retrieve-orders post-orders-history](equinix_orderhistoryv1_retrieve-orders_post-orders-history.md) - Search Orders History diff --git a/docs/equinix_orderhistoryv1_retrieve-orders_g-e-t-retrieve-orders-locations.md b/docs/equinix_orderhistoryv1_retrieve-orders_get-retrieve-orders-locations.md similarity index 80% rename from docs/equinix_orderhistoryv1_retrieve-orders_g-e-t-retrieve-orders-locations.md rename to docs/equinix_orderhistoryv1_retrieve-orders_get-retrieve-orders-locations.md index 52739ee..0f67b02 100644 --- a/docs/equinix_orderhistoryv1_retrieve-orders_g-e-t-retrieve-orders-locations.md +++ b/docs/equinix_orderhistoryv1_retrieve-orders_get-retrieve-orders-locations.md @@ -1,4 +1,4 @@ -## equinix orderhistoryv1 retrieve-orders g-e-t-retrieve-orders-locations +## equinix orderhistoryv1 retrieve-orders get-retrieve-orders-locations Retrieve order permissible IBX locations @@ -9,14 +9,14 @@ The API returns locations (IBXs and Cages) where the user's organization has a p Use --request flag to provide optional JSON payload fields. ``` -equinix orderhistoryv1 retrieve-orders g-e-t-retrieve-orders-locations [flags] +equinix orderhistoryv1 retrieve-orders get-retrieve-orders-locations [flags] ``` ### Options ``` --authorization string authorization field - -h, --help help for g-e-t-retrieve-orders-locations + -h, --help help for get-retrieve-orders-locations --request string JSON payload for additional optional fields not exposed as flags ``` diff --git a/docs/equinix_orderhistoryv1_retrieve-orders_p-o-s-t-orders-history.md b/docs/equinix_orderhistoryv1_retrieve-orders_post-orders-history.md similarity index 92% rename from docs/equinix_orderhistoryv1_retrieve-orders_p-o-s-t-orders-history.md rename to docs/equinix_orderhistoryv1_retrieve-orders_post-orders-history.md index 7cfb84a..341ff0d 100644 --- a/docs/equinix_orderhistoryv1_retrieve-orders_p-o-s-t-orders-history.md +++ b/docs/equinix_orderhistoryv1_retrieve-orders_post-orders-history.md @@ -1,4 +1,4 @@ -## equinix orderhistoryv1 retrieve-orders p-o-s-t-orders-history +## equinix orderhistoryv1 retrieve-orders post-orders-history Search Orders History @@ -9,7 +9,7 @@ Based on filtering criteria, this method returns a list of orders from the last Use --request flag to provide optional JSON payload fields. ``` -equinix orderhistoryv1 retrieve-orders p-o-s-t-orders-history [flags] +equinix orderhistoryv1 retrieve-orders post-orders-history [flags] ``` ### Options @@ -30,7 +30,7 @@ equinix orderhistoryv1 retrieve-orders p-o-s-t-orders-history [flags] --body-q string Query value to be queried against source values(Or operation against all sources).
Supports partial text search --body-sorts string body-sorts (JSON array) --body-source string ORDER_NUMBER: Search by order number(1-123456789).
CUSTOMER_REFERENCE_NUMBER: Search by customer reference number which was entered as part place order.
TROUBLE_TICKET_NUMBER: Search by trouble ticket numnber(5-123456).
WORK_ACTIVITY_NUMBER: Search by work order activity number(3-123456). (JSON array) - -h, --help help for p-o-s-t-orders-history + -h, --help help for post-orders-history --request string JSON payload for additional optional fields not exposed as flags ``` diff --git a/docs/equinix_ordersv2_orders.md b/docs/equinix_ordersv2_orders.md index 8cd8a10..37becda 100644 --- a/docs/equinix_ordersv2_orders.md +++ b/docs/equinix_ordersv2_orders.md @@ -25,7 +25,7 @@ Commands for managing orders resources in the API * [equinix ordersv2](equinix_ordersv2.md) - Manage Equinix ordersv2 resources * [equinix ordersv2 orders add-notes-to-an-order](equinix_ordersv2_orders_add-notes-to-an-order.md) - Add notes to an order * [equinix ordersv2 orders cancel-an-order](equinix_ordersv2_orders_cancel-an-order.md) - Cancel an order -* [equinix ordersv2 orders g-e-t-order-details](equinix_ordersv2_orders_g-e-t-order-details.md) - Retrieve an order +* [equinix ordersv2 orders get-order-details](equinix_ordersv2_orders_get-order-details.md) - Retrieve an order * [equinix ordersv2 orders reply-to-an-order-negotiation](equinix_ordersv2_orders_reply-to-an-order-negotiation.md) - Reply to an order negotiation * [equinix ordersv2 orders retrieve-order-negotiations](equinix_ordersv2_orders_retrieve-order-negotiations.md) - Retrieve order negotiations diff --git a/docs/equinix_ordersv2_orders_g-e-t-order-details.md b/docs/equinix_ordersv2_orders_get-order-details.md similarity index 83% rename from docs/equinix_ordersv2_orders_g-e-t-order-details.md rename to docs/equinix_ordersv2_orders_get-order-details.md index e58d058..9899191 100644 --- a/docs/equinix_ordersv2_orders_g-e-t-order-details.md +++ b/docs/equinix_ordersv2_orders_get-order-details.md @@ -1,4 +1,4 @@ -## equinix ordersv2 orders g-e-t-order-details +## equinix ordersv2 orders get-order-details Retrieve an order @@ -9,13 +9,13 @@ This method retrieves an order by its ID for a user with permission to view this Use --request flag to provide optional JSON payload fields. ``` -equinix ordersv2 orders g-e-t-order-details [flags] +equinix ordersv2 orders get-order-details [flags] ``` ### Options ``` - -h, --help help for g-e-t-order-details + -h, --help help for get-order-details --ibxs string ibxs field (JSON or string) --order-id string Identifier of the Order (required) --request string JSON payload for additional optional fields not exposed as flags